feat: enhance .drafts properties with draft table properties (#354)

lib/components/basedefs.js

@@ -42,6 +42,16 @@ export type EntitySet<T> = T[] & {
     data (input:object) : T
 };
 
+export type DraftEntity<T> = T & {
+    IsActiveEntity?: boolean | null
+    HasActiveEntity?: boolean | null
+    HasDraftEntity?: boolean | null
+    DraftAdministrativeData_DraftUUID?: string | null
+}
+
+export type DraftOf<T> = { new(...args: any[]): DraftEntity<T> }
+export type DraftsOf<T> = typeof Array<DraftEntity<T>>
+
 export type DeepRequired<T> = { 
     [K in keyof T]: DeepRequired<T[K]>
 } & Exclude<Required<T>, null>;

lib/components/wrappers.js

@@ -17,6 +17,20 @@ const createKey = t => `${base}.Key<${t}>`
  */
 const createKeysOf = t => `${base}.KeysOf<${t}>`
 
+/**
+ * Wraps type into DraftOf type.
+ * @param {string} t - the type name.
+ * @returns {string}
+ */
+const createDraftOf = t => `${base}.DraftOf<${t}>`
+
+/**
+ * Wraps type into DraftsOf type.
+ * @param {string} t - the type name.
+ * @returns {string}
+ */
+const createDraftsOf = t => `${base}.DraftsOf<${t}>`
+
 /**
  * Wraps type into ElementsOf type.
  * @param {string} t - the type name.
@@ -114,6 +128,8 @@ const stringIdent = s => `'${s}'`
 
 module.exports = {
     createArrayOf,
+    createDraftOf,
+    createDraftsOf,
     createKey,
     createKeysOf,
     createElementsOf,

lib/visitor.js

@@ -8,7 +8,7 @@ const { SourceFile, FileRepository, Buffer, Path } = require('./file')
 const { FlatInlineDeclarationResolver, StructuredInlineDeclarationResolver } = require('./components/inline')
 const { Resolver } = require('./resolution/resolver')
 const { LOG } = require('./logging')
-const { docify, createPromiseOf, createUnionOf, createKeysOf, createElementsOf, stringIdent } = require('./components/wrappers')
+const { docify, createPromiseOf, createUnionOf, createKeysOf, createElementsOf, stringIdent, createDraftsOf, createDraftOf } = require('./components/wrappers')
 const { csnToEnumPairs, propertyToInlineEnumName, isInlineEnumType, stringifyEnumType } = require('./components/enum')
 const { isReferenceType } = require('./components/reference')
 const { empty } = require('./components/typescript')
@@ -336,9 +336,11 @@ class Visitor {
     /**
      * @param {string} fq - fully qualified name of the entity
      * @param {string} clean - the clean name of the entity
+     * @param {boolean} [isPlural] - `true` if passed entity is plural
      */
-    #staticClassContents(fq, clean) {
-        return isDraftEnabled(fq) ? [`static drafts: typeof ${clean}`] : []
+    #staticClassContents(fq, clean, isPlural = false) {
+        if (!isDraftEnabled(fq)) return []
+        return [`static drafts: ${isPlural ? createDraftsOf(clean) : createDraftOf(clean)}`]
     }
 
     /**
@@ -409,7 +411,7 @@ class Visitor {
             }
             // plural can not be a type alias to $singular[] but needs to be a proper class instead,
             // so it can get passed as value to CQL functions.
-            const additionalProperties = this.#staticClassContents(fq, singular)
+            const additionalProperties = this.#staticClassContents(fq, singular, true)
             additionalProperties.push('$count?: number')
             buffer.add(docify(entity.doc))
             buffer.add(`export class ${plural} extends Array<${singular}> {${additionalProperties.join('\n')}}`)

test/unit/files/draft/model.cds

@@ -0,0 +1 @@
+using from './catalog-service';

test/unit/files/draft/model.ts

@@ -0,0 +1,31 @@
+import cds from '@sap/cds'
+import {DraftEntity} from '#cds-models/_'
+import {Books, Publishers} from '#cds-models/bookshop/service/CatalogService'
+
+export class CatalogService extends cds.ApplicationService {
+    async init() {
+
+        this.after("READ", Publishers.drafts, publishers => {
+            if (!publishers?.length) return
+            publishers.forEach(p => {
+                p.name
+                p.HasActiveEntity
+                p.HasDraftEntity
+                p.IsActiveEntity
+                p.DraftAdministrativeData_DraftUUID
+            })
+        })
+
+        this.after("READ", Books.drafts, books => {
+            if (!books?.length) return
+            books.forEach(b => {
+                b.title
+                b.HasActiveEntity
+                b.HasDraftEntity
+                b.IsActiveEntity
+                b.DraftAdministrativeData_DraftUUID
+            })
+        })
+        return super.init()
+    }
+}