@cap-js/cds-typer 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -4,12 +4,26 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
-## Version 0.12.0 - TBD
+## Version 0.13.0 - TBD
+
+## Version 0.12.0 - 2023-11-23
+
+### Changed
+- Generate `cds.LargeBinary` as string, buffer, _or readable_ in the case of media content
+
+### Added
+- Added support for the `not null` modifier
+
+### Fixed
+- Now using names of enum values in generated _index.js_ files if no explicit value is present
+
+## Version 0.11.1 - 2023-10-12
 
 ### Changed
 
 ### Added
 ### Fixed
+- Fixed how service names are exported as default export
 
 ## Version 0.11.0 - 2023-10-10
 

package/lib/cli.js

@@ -99,8 +99,4 @@ const main = async (args) => {
 
 if (require.main === module) {
     main(parseCommandlineArgs(process.argv.slice(2), flags))
-}
-
-function helpToCapire() {
-
 }

package/lib/components/enum.js

@@ -82,7 +82,7 @@ const propertyToAnonymousEnumName = (entity, property) => `${entity}_${property}
  */
 const isInlineEnumType = (element, csn) => element.enum && !(element.type in csn.definitions)
 
-const stringifyEnumImplementation = (name, enm) => `module.exports.${name} = Object.fromEntries(Object.entries(${enm}).map(([k,v]) => [k,v.val]))`
+const stringifyEnumImplementation = (name, enm) => `module.exports.${name} = Object.fromEntries(Object.entries(${enm}).map(([k,v]) => [k,v.val??k]))`
 
 /**
  * @param {string} name

package/lib/components/inline.js

@@ -17,6 +17,7 @@ class InlineDeclarationResolver {
      * @protected
      * @abstract
      */
+    // eslint-disable-next-line no-unused-vars
     printInlineType(name, type, buffer, statementEnd) { /* abstract */ }
 
     /**
@@ -84,6 +85,17 @@ class InlineDeclarationResolver {
         return this.visitor.options.propertiesOptional ? '?:' : ':'
     }
 
+    /**
+     * It returns TypeScript datatype for provided TS property
+     * @param {{typeName: string, typeInfo: TypeResolveInfo & { inflection: Inflection } }} type
+     * @param {string} typeName name of the TypeScript property
+     * @return {string} the datatype to be presented on TypeScript layer
+     * @public
+     */
+    getPropertyDatatype(type, typeName = type.typeName) {
+        return type.typeInfo.isNotNull ? typeName : `${typeName} | null`
+    }
+
     /** @param {import('../visitor').Visitor} visitor */
     constructor(visitor) {
         this.visitor = visitor
@@ -111,6 +123,7 @@ class InlineDeclarationResolver {
      * @public
      * @abstract
      */
+    // eslint-disable-next-line no-unused-vars
     getTypeLookup(members) { /* abstract */ return '' }
 }
 
@@ -142,7 +155,7 @@ class FlatInlineDeclarationResolver extends InlineDeclarationResolver {
     flatten(prefix, type) {
         return type.typeInfo.structuredType
             ? Object.entries(type.typeInfo.structuredType).map(([k,v]) => this.flatten(`${this.prefix(prefix)}${k}`, v))
-            : [`${prefix}${this.getPropertyTypeSeparator()} ${type.typeName}`]
+            : [`${prefix}${this.getPropertyTypeSeparator()} ${this.getPropertyDatatype(type)}`]
     }
 
     printInlineType(name, type, buffer) {
@@ -192,9 +205,9 @@ class StructuredInlineDeclarationResolver extends InlineDeclarationResolver {
                 this.flatten(n, t, buffer)
             }
             buffer.outdent()
-            buffer.add(`}${lineEnding}`)
+            buffer.add(`}${this.getPropertyDatatype(type, '')}${lineEnding}`)
         } else {
-            buffer.add(`${name}${this.getPropertyTypeSeparator()} ${type.typeName}${lineEnding}`)
+            buffer.add(`${name}${this.getPropertyTypeSeparator()} ${this.getPropertyDatatype(type)}${lineEnding}`)
         }
         this.printDepth--
         return buffer

package/lib/components/resolver.js

@@ -1,10 +1,11 @@
 'use strict'
 
 const util = require('../util')
+// eslint-disable-next-line no-unused-vars
 const { Buffer, SourceFile, Path, Library, baseDefinitions } = require("../file")
 const { deepRequire, createToManyAssociation, createToOneAssociation, createArrayOf, createCompositionOfMany, createCompositionOfOne } = require('./wrappers')
 const { StructuredInlineDeclarationResolver } = require("./inline")
-const { isInlineEnumType, propertyToInlineEnumName, propertyToAnonymousEnumName } = require('./enum')
+const { isInlineEnumType, propertyToAnonymousEnumName } = require('./enum')
 
 /** @typedef {{ cardinality?: { max?: '*' | number } }} EntityCSN */
 /** @typedef {{ definitions?: Object<string, EntityCSN> }} CSN */
@@ -22,6 +23,7 @@ const { isInlineEnumType, propertyToInlineEnumName, propertyToAnonymousEnumName
  * ```
  * @typedef {{
  *    isBuiltin: boolean,
+ *    isNotNull: boolean,
  *    isInlineDeclaration: boolean,
  *    isForeignKeyReference: boolean,
  *    isArray: boolean,
@@ -41,7 +43,7 @@ const Builtins = {
     String: 'string',
     Binary: 'string',
     LargeString: 'string',
-    LargeBinary: 'Buffer | string',
+    LargeBinary: 'Buffer | string | {value: import("stream").Readable, $mediaContentType: string, $mediaContentDispositionFilename?: string, $mediaContentDispositionType?: string}',
     Integer: 'number',
     UInt8: 'number',
     Int16: 'number',
@@ -231,6 +233,8 @@ class Resolver {
 
             if (toOne && toMany) {
                 const target = element.items ?? (typeof element.target === 'string' ? { type: element.target } : element.target)
+                /** set `notNull = true` to avoid repeated `| not null` TS construction */
+                target.notNull = true
                 const { singular, plural } = this.resolveAndRequire(target, file).typeInfo.inflection
                 typeName =
                     cardinality > 1 ? toMany(plural) : toOne(this.visitor.isSelfReference(target) ? 'this' : singular)
@@ -254,7 +258,7 @@ class Resolver {
                 }
 
                 if (element.type.ref?.length > 1) {
-                    const [entity, ...members] = element.type.ref
+                    const [, ...members] = element.type.ref
                     const lookup = this.visitor.inlineDeclarationResolver.getTypeLookup(members)
                     typeName = deepRequire(typeInfo.inflection.singular, lookup)
                     file.addImport(baseDefinitions.path)
@@ -348,11 +352,16 @@ class Resolver {
             return element
         }
 
+        const cardinality = this.getMaxCardinality(element)
+
         const result = {
             isBuiltin: false, // will be rectified in the corresponding handlers, if needed
             isInlineDeclaration: false,
             isForeignKeyReference: false,
             isArray: false,
+            isNotNull: element?.isRefNotNull !== undefined 
+                ? element?.isRefNotNull 
+                : element?.key || element?.notNull || cardinality > 1,
         }
 
         if (element?.type === undefined) {
@@ -377,6 +386,8 @@ class Resolver {
         // objects and arrays
         if (element?.items) {
             result.isArray = true
+            // TODO: re-implement this line once {element.notNull} will be provided for array-like elements
+            result.isNotNull = true
             result.isBuiltin = true
             this.resolveType(element.items, file)
             //delete element.items

package/lib/csn.js

@@ -221,49 +221,6 @@ function propagateForeignKeys(csn) {
     }
 }
 
-/** 
-* Entities inherit their ancestors annotations:
-* https://cap.cloud.sap/docs/cds/cdl#annotation-propagation
-* This is a problem if we annotate @singular/ @plural to an entity A,
-* as we don't want all descendents B, C, ... to share the ancestor's
-* annotated inflexion
-* -> remove all such annotations that appear in a parent as well.
-* BUT: we can't just delete the attributes. Imagine three classes
-* A <- B <- C
-* where A contains a @singular annotation.
-* If we erase the annotation from B, C will still contain it and
-* can not detect that its own annotation was inherited without
-* travelling up the entire inheritance chain up to A.
-* So instead, we monkey patch and maintain a dictionary "erased"
-* when removing an annotation which we also check.
-* @deprecated since we use the xtended flavour for CSN, we don't need to fix this anymore
-*/
-function propagateInflectionAnnotations(csn) {
-    const erase = (entity, parent, attr) => {
-        if (attr in entity) {
-            const ea = entity[attr]
-            if (parent[attr] === ea || (parent.erased && parent.erased[attr] === ea)) {
-                entity.erased ??= {}
-                entity.erased[attr] = ea
-                delete entity[attr]
-                //this.logger.info(`Removing inherited attribute ${attr} from ${entity.name}.`)
-            }
-        }
-    }
-
-    for (const entity of Object.values(csn.definitions)) {
-        let i = 0
-        while (
-            (getSingularAnnotation(entity) || getPluralAnnotation(entity)) &&
-            i < (entity.includes ?? []).length
-        ) {
-            const parent = csn.definitions[entity.includes[i]]
-            Object.values(annotations).flat().forEach(an => erase(entity, parent, an))
-            i++
-        }
-    }
-}
-
 function amendCSN(csn) {
     unrollDraftability(csn)
     propagateForeignKeys(csn)

package/lib/file.js

@@ -335,6 +335,7 @@ class SourceFile extends File {
      * @param {string} fq the fully qualified name of the service
      */
     addService(fq) {
+        // FIXME: warn the user when they're trying to add an entity/ type/ enum called "name", which will override our name export
         if (this.services.names.length) {
             throw new Error(`trying to add more than one service to file ${this.path.asDirectory()}. Existing service is ${this.services.names[0]}, trying to add ${fq}`)
         }
@@ -369,6 +370,7 @@ class SourceFile extends File {
             AUTO_GEN_NOTE,
             this.getImports().join(),
             this.preamble.join(),
+            this.services.buffer.join(), // must be the very first
             this.types.join(),
             this.enums.buffer.join(), 
             this.inlineEnums.buffer.join(), // needs to be before classes
@@ -376,15 +378,16 @@ class SourceFile extends File {
             this.aspects.join(), // needs to be before classes
             this.classes.join(),
             this.events.buffer.join(),
-            this.actions.buffer.join(),
-            this.services.buffer.join() // should be at the end
+            this.actions.buffer.join()            
         ].filter(Boolean).join('\n')
     }
 
     toJSExports() {
         return [AUTO_GEN_NOTE, "const cds = require('@sap/cds')", `const csn = cds.entities('${this.path.asNamespace()}')`] // boilerplate
             .concat(
-                this.inflections
+                // FIXME: move stringification of service into own module
+                this.services.names.map(name => `module.exports = { name: '${name}' }`))  // there should be only one
+                .concat(this.inflections
                     // sorting the entries based on the number of dots in their singular.
                     // that makes sure we have defined all parent namespaces before adding subclasses to them e.g.:
                     // "module.exports.Books" is defined before "module.exports.Books.text"
@@ -410,8 +413,6 @@ class SourceFile extends File {
             .concat(this.enums.fqs.map(({name, fq, property}) => property 
                 ? stringifyAnonymousEnum(name, fq, property)
                 : stringifyNamedEnum(name, fq)))
-            // FIXME: move stringification of service into own module
-            .concat(this.services.names.map(name => `module.exports.default = { name: '${name}' }`))  // there should be only one
             .join('\n') + '\n'
     }
 }

package/lib/visitor.js

@@ -3,6 +3,7 @@
 const util = require('./util')
 
 const { amendCSN } = require('./csn')
+// eslint-disable-next-line no-unused-vars
 const { SourceFile, baseDefinitions, Buffer } = require('./file')
 const { FlatInlineDeclarationResolver, StructuredInlineDeclarationResolver } = require('./components/inline')
 const { Resolver } = require('./components/resolver')
@@ -116,7 +117,11 @@ class Visitor {
             // instead of using the definition from inferred CSN, we refer to the projected entity from xtended CSN instead.
             // The latter contains the CSN fixes (propagated foreign keys, etc) and none of the localised fields we don't handle yet.
             if (entity.projection) {
-                this.visitEntity(name, this.csn.xtended.definitions[entity.projection.from.ref[0]])
+                const targetName = entity.projection.from.ref[0] 
+                // FIXME: references to types of entity properties may be missing from xtendend flavour (see #103)
+                // this should be revisted once we settle on a single flavour.
+                const target = this.csn.xtended.definitions[targetName] ?? this.csn.inferred.definitions[targetName]
+                this.visitEntity(name, target)
             } else {
                 this.logger.error(`Expecting an autoexposed projection within a service. Skipping ${name}`)
             }
@@ -160,7 +165,10 @@ class Visitor {
                 // We don't really have to care for this case, as keys from such structs are _not_ propagated to
                 // the containing entity.
                 for (const [kname, kelement] of Object.entries(this.csn.xtended.definitions[element.target]?.keys ?? {})) {
-                    this.visitElement(`${ename}_${kname}`, kelement, file, buffer)
+                    if (this.resolver.getMaxCardinality(element) === 1) {
+                        kelement.isRefNotNull = !!element.notNull || !!element.key
+                        this.visitElement(`${ename}_${kname}`, kelement, file, buffer)
+                    }
                 }
             }
 
@@ -299,7 +307,7 @@ class Visitor {
                 .filter(([, type]) => type?.type !== '$self' && !(type.items?.type === '$self'))
                 .map(([name, type]) => [
                     name,
-                    this.resolver.resolveAndRequire(type, file).typeName,
+                    this.resolver.visitor.inlineDeclarationResolver.getPropertyDatatype(this.resolver.resolveAndRequire(type, file)),
                 ])
             : []
     }
@@ -310,7 +318,9 @@ class Visitor {
         const ns = this.resolver.resolveNamespace(name.split('.'))
         const file = this.getNamespaceFile(ns)
         const params = this.#stringifyFunctionParams(func.params, file)
-        const returns = this.resolver.resolveAndRequire(func.returns, file).typeName
+        const returns = this.resolver.visitor.inlineDeclarationResolver.getPropertyDatatype(
+            this.resolver.resolveAndRequire(func.returns, file)
+        )
         file.addFunction(name.split('.').at(-1), params, returns)
     }
 
@@ -319,7 +329,9 @@ class Visitor {
         const ns = this.resolver.resolveNamespace(name.split('.'))
         const file = this.getNamespaceFile(ns)
         const params = this.#stringifyFunctionParams(action.params, file)
-        const returns = this.resolver.resolveAndRequire(action.returns, file).typeName
+        const returns = this.resolver.visitor.inlineDeclarationResolver.getPropertyDatatype(
+            this.resolver.resolveAndRequire(action.returns, file)
+        )
         file.addAction(name.split('.').at(-1), params, returns)
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-typer",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Generates .ts files for a CDS model to receive code completion in VS Code",
   "main": "index.js",
   "repository": "github:cap-js/cds-typer",
@@ -17,7 +17,7 @@
     "test:integration": "jest --projects test/int.jest.config.js",
     "test:all": "jest",
     "test": "npm run test:unit",
-    "lint": "eslint",
+    "lint": "npx eslint .",
     "cli": "node lib/cli.js",
     "doc:clean": "rm -rf ./doc",
     "doc:prepare": "npm run doc:clean && mkdir -p doc/types",
@@ -40,10 +40,9 @@
     "@sap/cds": ">=6"
   },
   "devDependencies": {
+    "@babel/eslint-parser": "^7.23.3",
     "acorn": "^8.10.0",
     "eslint": "^8.15.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.0.0",
     "jest": "^29",
     "typescript": ">=4.6.4"
   },