@cap-js/cds-typer 0.18.0 → 0.18.2

package/CHANGELOG.md

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ## Version 0.19.0 - TBD
 
+## Version 0.18.2 - 2024-03-21
+### Fix
+- Resolving `@sap/cds` will now look in the CWD first to ensure a consistent use the same CDS version across different setups
+- Types of function parameters starting with `cds.` are not automatically considered builtin anymore and receive a more thorough check against an allow-list
+
+
+## Version 0.18.1 - 2024-03-13
+### Fix
+- Remove faulty plural for CDS `type` definitions from the generated _index.js_ files
+
 ## Version 0.18.0 - 2024-03-12
 ### Added
 - Improved support for projections, including projections on inline definitions, and on views, as well as support for explicit exclusion and selection of properties

package/lib/compile.js

@@ -2,7 +2,7 @@
 
 const fs = require('fs')
 const { normalize } = require('path')
-const cds = require('@sap/cds')
+const cds = require(require.resolve('@sap/cds', { paths: [process.cwd(), __dirname] }))
 const util = require('./util')
 const { writeout } = require('./file')
 const { Logger } = require('./logging')

package/lib/components/resolver.js

@@ -66,6 +66,19 @@ const Builtins = {
     Association: 'Array'
 }
 
+/**
+ * @param {string | string[]} type name or parts of the type name split on dots
+ * @returns {string | undefined | false} if t refers to a builtin, the name of the corresponding TS type is returned.
+ *   If t _looks like_ a builtin (`cds.X`), undefined is returned.
+ *   If t is obviously not a builtin, false is returned.
+ */
+function resolveBuiltin (t) {
+    const path = Array.isArray(t) ? t : t.split('.')
+    return path.length === 2 && path[0] === 'cds'
+        ? Builtins[path[1]]
+        : false
+}
+
 class Resolver {
 
     #caches = {
@@ -550,13 +563,13 @@ class Resolver {
     #resolveTypeName(t, into) {
         const result = into || {}
         const path = t.split('.')
-        if (path.length === 2 && path[0] === 'cds') {
-            // builtin type
-            const resolvedBuiltin = Builtins[path[1]]
-            if (!resolvedBuiltin) {
-                throw new Error(`Can not resolve apparent builtin type '${t}' to any CDS type.`)
-            }
-            result.type = resolvedBuiltin
+        const builtin = resolveBuiltin(path)
+        if (builtin === undefined) {
+            // looks like builtin, but isn't
+            throw new Error(`Can not resolve apparent builtin type '${t}' to any CDS type.`)
+        } else if (builtin !== false) {
+            // builtin
+            result.type = builtin
             result.isBuiltin = true
         } else if (t in this.csn.definitions) {
             // user-defined type
@@ -607,5 +620,6 @@ class Resolver {
 }
 
 module.exports = {
-    Resolver
+    Resolver,
+    resolveBuiltin
 }

package/lib/file.js

@@ -403,12 +403,12 @@ class SourceFile extends File {
                     //     or when plural4 produced weird inflection.
                     .flatMap(([singular, plural, original]) => Array.from(new Set([
                         `module.exports.${singular} = csn.${original}`,
-                        `module.exports.${plural} = csn.${original}`,
+                        /Array<.*>/.test(plural) ? undefined : `module.exports.${plural} = csn.${original}`,
                         // FIXME: we currently produce at most 3 entries.
                         // This could be an issue when the user re-used the original name in a @singular/@plural annotation.
                         // Seems unlikely, but we have to eliminate the original entry if users start running into this.
                         `module.exports.${original} = csn.${original}`
-                    ])))
+                    ].filter(Boolean))))  // FIXME: this is a hack to support CDS types that will produce "Array<MyType>" as plural, which we do not want as export in the index.js files
             ) // singular -> plural aliases
             .concat(['// events'])
             .concat(this.events.fqs.map(({fq, name}) => `module.exports.${name} = '${fq}'`))

package/lib/visitor.js

@@ -6,7 +6,7 @@ const { amendCSN, isView, isUnresolved, propagateForeignKeys, isDraftEnabled, is
 // eslint-disable-next-line no-unused-vars
 const { SourceFile, FileRepository, baseDefinitions, Buffer } = require('./file')
 const { FlatInlineDeclarationResolver, StructuredInlineDeclarationResolver } = require('./components/inline')
-const { Resolver } = require('./components/resolver')
+const { Resolver, resolveBuiltin } = require('./components/resolver')
 const { Logger } = require('./logging')
 const { docify } = require('./components/wrappers')
 const { csnToEnumPairs, propertyToInlineEnumName, isInlineEnumType, stringifyEnumType } = require('./components/enum')
@@ -338,7 +338,7 @@ class Visitor {
     #stringifyFunctionParamType(type, file) {
         // if type.type is not 'cds.String', 'cds.Integer', ..., then we are actually looking
         // at a named enum type. In that case also resolve that type name
-        return type.enum && type.type.startsWith('cds.')
+        return type.enum && resolveBuiltin(type.type)
             ? stringifyEnumType(csnToEnumPairs(type))
             : this.inlineDeclarationResolver.getPropertyDatatype(this.resolver.resolveAndRequire(type, file))
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-typer",
-  "version": "0.18.0",
+  "version": "0.18.2",
   "description": "Generates .ts files for a CDS model to receive code completion in VS Code",
   "main": "index.js",
   "repository": "github:cap-js/cds-typer",
@@ -37,7 +37,7 @@
     "cds-typer": "./lib/cli.js"
   },
   "dependencies": {
-    "@sap/cds": ">=6"
+    "@sap/cds": ">=7.7"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.23.3",