@cap-js/cds-typer 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -4,7 +4,7 @@ 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.6.1 - TBD
+## Version 0.7.1 - TBD
 
 ### Changed
 
@@ -12,6 +12,23 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ### Fixed
 
+## Version 0.7.0 - 2023-08-22
+
+### Changed
+
+### Added
+- Support for `[many] $self` syntax in bound action parameters
+- Foreign keys are now present in the generated types in addition to the resolved property
+
+### Fixed
+## Version 0.6.1 - 2023-08-10
+
+### Changed
+
+### Added
+
+### Fixed
+- Removed a warning about circular imports
 
 ## Version 0.6.0 - 2023-08-07
 

package/lib/cli.js

@@ -44,7 +44,7 @@ const flags = {
     }
 }
 
-const hint = () => console.log('Missing or invalid parameter(s). Call with --help for more details.')
+const hint = () => 'Missing or invalid parameter(s). Call with --help for more details.'
 const indent = (s, indentation) => s.split(EOL).map(line => `${indentation}${line}`).join(EOL)
 
 const help = () => `SYNOPSIS${EOL2}` +

package/lib/components/resolver.js

@@ -3,11 +3,11 @@
 const util = require('../util')
 const { Buffer, SourceFile, Path, Library, baseDefinitions } = require("../file")
 const { deepRequire, createToManyAssociation, createToOneAssociation, createArrayOf, createCompositionOfMany, createCompositionOfOne } = require('./wrappers')
-const { Visitor } = require("../visitor")
 const { StructuredInlineDeclarationResolver } = require("./inline")
 
 /** @typedef {{ cardinality?: { max?: '*' | number } }} EntityCSN */
 /** @typedef {{ definitions?: Object<string, EntityCSN> }} CSN */
+/** @typedef {import('../visitor').Visitor} Visitor */
 
 /**
  * When nested inline types require additional imports. E.g.:
@@ -445,6 +445,10 @@ class Resolver {
             result.path = new Path(path) // FIXME: relative to current file
             result.csn = this.csn.definitions[t]
             result.plainName = this.trimNamespace(t)
+        } else if (t === '$self') {
+            result.type = 'this'
+            result.isBuiltin = true
+            result.plainName = 'this'
         } else {
             // type offered by some library
             const lib = this.libraries.find((lib) => lib.offers(t))

package/lib/visitor.js

@@ -59,7 +59,6 @@ class Visitor {
      * @param {VisitorOptions} options
      */
     constructor(csn, options = {}, logger = new Logger()) {
-        util.fixCSN(csn)
         this.options = { ...defaults, ...options }
         this.logger = logger
         this.csn = csn
@@ -130,16 +129,16 @@ class Visitor {
         buffer.indent()
         for (const [ename, element] of Object.entries(entity.elements ?? {})) {
             this.visitElement(ename, element, file, buffer)
+            // make foreign keys explicit
+            for (const [fkname, fkelement] of Object.entries(element.foreignKeys ?? {})) {
+                this.visitElement(`${ename}_${fkname}`, fkelement, file, buffer)
+            }
         }
         for (const [aname, action] of Object.entries(entity.actions ?? {})) {
-            const lambdaString = 
             buffer.add(
                 SourceFile.stringifyLambda({
                     name: aname,
-                    parameters: Object.entries(action.params ?? {}).map(([n, t]) => [
-                        n,
-                        this.resolver.resolveAndRequire(t, file).typeName,
-                    ]),
+                    parameters: this.#stringifyFunctionParams(action.params, file),
                     returns: action.returns ? this.resolver.resolveAndRequire(action.returns, file).typeName : 'any',
                     initialiser: `undefined as unknown as this['${aname}']`
                 })
@@ -226,17 +225,32 @@ class Visitor {
         buffer.add('')
     }
 
+    /**
+     * Stringifies function parameters in preparation of passing them to {@link SourceFile.stringifyLambda}.
+     * Resolves all parameters to a pair of parameter name and name of the resolved type.
+     * Also filters out parameters that indicate a binding parameter ({@link https://cap.cloud.sap/docs/releases/jan23#simplified-syntax-for-binding-parameters}).
+     * @param {[string, object][]} params - parameter list as found in CSN.
+     * @param {File} file - source file relative to which the parameter types should be resolved.
+     * @returns {[string, string][]} pair of names and types.
+     */
+    #stringifyFunctionParams(params, file) {
+        return params
+            ? Object.entries(params)
+                // filter params of type '[many] $self', as they are not to be part of the implementation
+                .filter(([, type]) => type?.type !== '$self' && !(type.items?.type === '$self'))
+                .map(([name, type]) => [
+                    name,
+                    this.resolver.resolveAndRequire(type, file).typeName,
+                ])
+            : []
+    }
+
     #printFunction(name, func) {
         // FIXME: mostly duplicate of printAction -> reuse
         this.logger.debug(`Printing function ${name}:\n${JSON.stringify(func, null, 2)}`)
         const ns = this.resolver.resolveNamespace(name.split('.'))
         const file = this.getNamespaceFile(ns)
-        const params = func.params
-            ? Object.entries(func.params).map(([pname, ptype]) => [
-                  pname,
-                  this.resolver.resolveAndRequire(ptype, file).typeName,
-              ])
-            : []
+        const params = this.#stringifyFunctionParams(func.params, file)
         const returns = this.resolver.resolveAndRequire(func.returns, file).typeName
         file.addFunction(name.split('.').at(-1), params, returns)
     }
@@ -245,12 +259,7 @@ class Visitor {
         this.logger.debug(`Printing action ${name}:\n${JSON.stringify(action, null, 2)}`)
         const ns = this.resolver.resolveNamespace(name.split('.'))
         const file = this.getNamespaceFile(ns)
-        const params = action.params
-            ? Object.entries(action.params).map(([pname, ptype]) => [
-                  pname,
-                  this.resolver.resolveAndRequire(ptype, file).typeName,
-              ])
-            : []
+        const params = this.#stringifyFunctionParams(action.params, file)
         const returns = this.resolver.resolveAndRequire(action.returns, file).typeName
         file.addAction(name.split('.').at(-1), params, returns)
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-typer",
-  "version": "0.6.0",
+  "version": "0.7.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",