feat/refactor: dedicated classes for texts and inline comps (#356)

Co-authored-by: Daniel O'Grady <103028279+daogrady@users.noreply.github.com>
cap-js · Jan 9, 2025 · d32426a · d32426a
1 parent bebe67a
commit d32426a
Show file tree

Hide file tree

Showing 20 changed files with 518 additions and 150 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
-### Added 
+### Added
+- dedicated classes for inline compositions
+- dedicated text-classes for entities with `localized` elements
+
 ### Changed
 - prefixed builtin types like `Promise` and `Record` with `globalThis.`, to allow using names of builtin types for entities without collisions
 ### Deprecated

diff --git a/lib/csn.js b/lib/csn.js
@@ -1,4 +1,5 @@
 const { LOG } = require('./logging')
+const { annotations } = require('./util')
 
 const DRAFT_ENABLED_ANNO = '@odata.draft.enabled'
 /** @type {string[]} */
@@ -292,6 +293,30 @@ function propagateForeignKeys(csn) {
     }
 }
 
+/**
+ * Clears "correct" singular/plural annotations from inferred model
+ * copies the ones from the xtended model.
+ *
+ * This is done to prevent potential duplicate class names because of annotation propagation.
+ * @param {{inferred: CSN, xtended: CSN}} csn - CSN models
+ */
+function propagateInflectionAnnotations(csn) {
+    const singularAnno = annotations.singular[0]
+    const pluralAnno = annotations.plural[0]
+    for (const [name, def] of Object.entries(csn.inferred.definitions)) {
+        const xtendedDef = csn.xtended.definitions[name]
+        // we keep the annotations from definition specific to the inferred model (e.g. inline compositions)
+        if (!xtendedDef) continue
+
+        // clear annotations from inferred definition
+        if (Object.hasOwn(def, singularAnno)) delete def[singularAnno]
+        if (Object.hasOwn(def, pluralAnno)) delete def[pluralAnno]
+        // transfer annotation from xtended if existing
+        if (Object.hasOwn(xtendedDef, singularAnno)) def[singularAnno] = xtendedDef[singularAnno]
+        if (Object.hasOwn(xtendedDef, pluralAnno)) def[pluralAnno] = xtendedDef[pluralAnno]
+    }
+}
+
 /**
  * @param {EntityCSN} entity - the entity
  */
@@ -326,5 +351,6 @@ module.exports = {
     getProjectionAliases,
     getViewTarget,
     propagateForeignKeys,
+    propagateInflectionAnnotations,
     isCsnAny
 }
diff --git a/lib/file.js b/lib/file.js
@@ -257,6 +257,7 @@ class SourceFile extends File {
         if (!(name in this.namespaces)) {
             const buffer = new Buffer()
             buffer.closed = false
+            buffer.namespace = name
             buffer.add(`export namespace ${name} {`)
             buffer.indent()
             this.namespaces[name] = buffer
@@ -286,6 +287,8 @@ class SourceFile extends File {
      * @param {string} entityFqName - name of the entity the enum is attached to with namespace
      * @param {string} propertyName - property to which the enum is attached.
      * @param {[string, string][]} kvs - list of key-value pairs
+     * @param {Buffer} [buffer] - if buffer is of subnamespace the enum will be added there,
+     *                            otherwise to the inline enums of the file
      * @param {string[]} doc - the enum docs
      *  If given, the enum is considered to be an inline definition of an enum.
      *  If not, it is considered to be regular, named enum.
@@ -310,16 +313,32 @@ class SourceFile extends File {
      * }
      * ```
      */
-    addInlineEnum(entityCleanName, entityFqName, propertyName, kvs, doc=[]) {
+    addInlineEnum(entityCleanName, entityFqName, propertyName, kvs, buffer, doc=[]) {
+        const namespacedEntity = [buffer?.namespace, entityCleanName].filter(Boolean).join('.')
         this.enums.data.push({
-            name: `${entityCleanName}.${propertyName}`,
+            name: `${namespacedEntity}.${propertyName}`,
             property: propertyName,
             kvs,
-            fq: `${entityCleanName}.${propertyName}`
+            fq: `${namespacedEntity}.${propertyName}`
         })
-        const entityProxy = this.entityProxies[entityCleanName] ?? (this.entityProxies[entityCleanName] = [])
+        const entityProxy = this.entityProxies[namespacedEntity] ?? (this.entityProxies[namespacedEntity] = [])
         entityProxy.push(propertyName)
-        printEnum(this.inlineEnums.buffer, propertyToInlineEnumName(entityCleanName, propertyName), kvs, {export: false}, doc)
+
+        // REVISIT: find a better way to do this???
+        const printEnumToBuffer = (/** @type {Buffer} */buffer) => printEnum(buffer, propertyToInlineEnumName(entityCleanName, propertyName), kvs, {export: false}, doc)
+
+        if (buffer?.namespace) {
+            const tempBuffer = new Buffer()
+            // we want to put the enums on class level
+            tempBuffer.indent()
+            printEnumToBuffer(tempBuffer)
+
+            // we want to write the enums at the beginning of the namespace
+            const [first,...rest] = buffer.parts
+            buffer.parts = [first, ...tempBuffer.parts, ...rest]
+        } else {
+            printEnumToBuffer(this.inlineEnums.buffer)
+        }
     }
 
     /**
@@ -490,12 +509,15 @@ class SourceFile extends File {
 
             return {
                 singularRhs: `createEntityProxy(['${namespace}', '${original}'], { target: { is_singular: true }${customPropsStr} })`,
-                pluralRhs: `createEntityProxy(['${namespace}', '${original}'])`,
+                pluralRhs: `createEntityProxy(['${namespace}', '${original}'], { target: { is_singular: false }})`,
             }
         } else {
+            // standard entity: csn.Books
+            // inline entity: csn['Books.texts']
+            const csnAccess = original.includes('.') ? `csn['${original}']` : `csn.${original}`
             return {
-                singularRhs: `{ is_singular: true, __proto__: csn.${original} }`,
-                pluralRhs: `csn.${original}`
+                singularRhs: `{ is_singular: true, __proto__: ${csnAccess} }`,
+                pluralRhs: csnAccess
             }
         }
     }
@@ -589,6 +611,11 @@ class Buffer {
          * @type {boolean}
          */
         this.closed = false
+        /**
+         * Required for inline enums of inline compositions or text entities
+         * @type {string | undefined}
+         */
+        this.namespace = undefined
     }
 
     /**

diff --git a/lib/printers/javascript.js b/lib/printers/javascript.js
@@ -84,12 +84,14 @@ class ESMPrinter extends JavaScriptPrinter {
 
     /** @type {JavaScriptPrinter['printDeconstructedImport']} */
     printDeconstructedImport (imports, from) {
-        return `import { ${imports.join(', ')} } from '${from}'`
+        return `import { ${imports.join(', ')} } from '${from}/index.js'`
     }
 
     /** @type {JavaScriptPrinter['printExport']} */
     printExport (name, value) {
-        return `export const ${name} = ${value}`
+        return name.includes('.')
+            ? `${name} = ${value}`
+            : `export const ${name} = ${value}`
     }
 
     /** @type {JavaScriptPrinter['printDefaultExport']} */

diff --git a/lib/resolution/entity.js b/lib/resolution/entity.js
@@ -61,6 +61,22 @@ class EntityInfo {
     /** @type {import('../typedefs').resolver.EntityCSN | undefined} */
     #csn
 
+    /** @type {Set<string> | undefined} */
+    #inheritedElements
+
+    /** @returns set of inherited elements (e.g. ID of aspect cuid) */
+    get inheritedElements() {
+        if (this.#inheritedElements) return this.#inheritedElements
+        this.#inheritedElements = new Set()
+        for (const parentName of this.csn.includes ?? []) {
+            const parent = this.#repository.getByFq(parentName)
+            for (const element of Object.keys(parent?.csn?.elements ?? {})) {
+                this.#inheritedElements.add(element)
+            }
+        }
+        return this.#inheritedElements
+    }
+
     /** @returns the **inferred** csn for this entity. */
     get csn () {
         return this.#csn ??= this.#resolver.csn.definitions[this.fullyQualifiedName]

diff --git a/lib/resolution/resolver.js b/lib/resolution/resolver.js
@@ -24,7 +24,7 @@ const { configuration } = require('../config')
 /** @typedef {{typeName: string, typeInfo: TypeResolveInfo & { inflection: Inflection }}} ResolveAndRequireInfo */
 
 class Resolver {
-    get csn() { return this.visitor.csn.inferred }
+    get csn() { return this.visitor.csn }
 
     /** @param {Visitor} visitor - the visitor */
     constructor(visitor) {
@@ -165,11 +165,13 @@ class Resolver {
          */
         const isPropertyOf = (property, entity) => property && Object.hasOwn(entity?.elements ?? {}, property)
 
-        const defs = this.visitor.csn.inferred.definitions
+        const defs = this.visitor.csn.definitions
+
+        // check if name is already an entity, then we do not have a property access, but a nested entity
+        if (defs[p]?.kind === 'entity') return []
+
         // assume parts to contain [Namespace, Service, Entity1, Entity2, Entity3, property1, property2]
-        /** @type {string} */
-        // @ts-expect-error - nope, we know there is at least one element
-        let qualifier = parts.shift()
+        let qualifier = /** @type {string} */ (parts.shift())
         // find first entity from left (Entity1)
         while ((!defs[qualifier] || !isEntity(defs[qualifier])) && parts.length) {
             qualifier += `.${parts.shift()}`
@@ -240,6 +242,8 @@ class Resolver {
         } else {
             // TODO: make sure the resolution still works. Currently, we only cut off the namespace!
             plural = util.getPluralAnnotation(typeInfo.csn) ?? typeInfo.plainName
+            // remove leading entity name
+            if (plural.includes('.')) plural = last(plural)
             singular = util.getSingularAnnotation(typeInfo.csn) ?? util.singular4(typeInfo.csn, true) // util.singular4(typeInfo.csn, true)  // can not use `plural` to honor possible @singular annotation
 
             // don't slice off namespace if it isn't part of the inflected name.
@@ -311,18 +315,6 @@ class Resolver {
                 } else {
                     let { singular, plural } = targetTypeInfo.typeInfo.inflection
 
-                    // FIXME: super hack!!
-                    // Inflection currently does not retain the scope of the entity.
-                    // But we can't just fix it in inflection(...), as that would break several other things
-                    // So we bandaid-fix it back here, as it is the least intrusive place -- but this should get fixed asap!
-                    if (target.type) {
-                        const untangled = this.visitor.entityRepository.getByFqOrThrow(target.type)
-                        const scope = untangled.scope.join('.')
-                        if (scope && !singular.startsWith(scope)) {
-                            singular = `${scope}.${singular}`
-                        }
-                    }
-
                     typeName = cardinality > 1
                         ? toMany(plural)
                         : toOne(this.visitor.isSelfReference(target) ? 'this' : singular)
@@ -370,8 +362,14 @@ class Resolver {
         // handle typeof (unless it has already been handled above)
         const target = element.target?.name ?? element.type?.ref?.join('.') ?? element.type
         if (target && !typeInfo.isDeepRequire) {
-            const { propertyAccess } =  this.visitor.entityRepository.getByFq(target) ?? {}
-            if (propertyAccess?.length) {
+            const { propertyAccess, scope } =  this.visitor.entityRepository.getByFq(target) ?? {}
+            if (scope?.length) {
+                // update inflections with proper prefix, e.g. Books.text, Books.texts
+                typeInfo.inflection = {
+                    singular: [...scope, typeInfo.inflection?.singular].join('.'),
+                    plural: [...scope, typeInfo.inflection?.plural].join('.')
+                }
+            } else if (propertyAccess?.length) {
                 const element = target.slice(0, -propertyAccess.join('.').length - 1)
                 const access = this.visitor.inlineDeclarationResolver.getTypeLookup(propertyAccess)
                 // singular, as we have to access the property of the entity
@@ -452,6 +450,7 @@ class Resolver {
 
         const cardinality = getMaxCardinality(element)
 
+        /** @type {TypeResolveInfo} */
         const result = {
             isBuiltin: false, // will be rectified in the corresponding handlers, if needed
             isInlineDeclaration: false,
@@ -569,7 +568,7 @@ class Resolver {
      * @returns @see resolveType
      */
     resolveTypeName(t, into) {
-        const result = into ?? {}
+        const result = into ?? /** @type {TypeResolveInfo} */({})
         const path = t.split('.')
         const builtin = this.builtinResolver.resolveBuiltin(path)
         if (builtin === undefined) {

diff --git a/lib/typedefs.d.ts b/lib/typedefs.d.ts
@@ -13,7 +13,7 @@ export module resolver {
         compositions?: { target: string }[]
         doc?: string,
         elements?: { [key: string]: EntityCSN }
-        key?: string // custom!!
+        key?: boolean // custom!!
         keys?: { [key:string]: any }
         kind: string,
         includes?: string[]
@@ -25,6 +25,8 @@ export module resolver {
         target?: string,
         type: string | ref,
         name: string,
+        '@singular'?: string,
+        '@plural'?: string,
         '@odata.draft.enabled'?: boolean // custom!
         _unresolved?: boolean
         isRefNotNull?: boolean // custom!

diff --git a/lib/util.js b/lib/util.js
@@ -15,10 +15,10 @@ if (process.version.startsWith('v14')) {
 
 const last = /\w+$/
 
-const annotations = {
+const annotations = /** @type {const} */ ({
     singular: ['@singular'],
     plural: ['@plural'],
-}
+})
 
 /**
  * Converts a camelCase string to snake_case.