@cap-js/cds-typer 0.9.0 → 0.10.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.9.1 - TBD
+## Version 0.10.1 - TBD
 
 ### Changed
 
@@ -12,6 +12,15 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ### Fixed
 
+## Version 0.10.0 - 2023-09-21
+
+### Changed
+- Actions and functions are now attached to a static `.actions` property of each generated class. This reflects the runtime behaviour better than the former way of generating instance methods
+
+### Added
+
+### Fixed
+
 ## Version 0.9.0 - 2023-09-08
 
 ### Changed

package/lib/file.js

@@ -127,18 +127,34 @@ class SourceFile extends File {
      * @returns {string} - the stringified lambda
      * @example
      * ```js
-     * stringifyLambda({parameters: [['p','T']]}  // (p: T) => any
-     * stringifyLambda({name: 'f', parameters: [['p','T']]}  // f: (p: T) => any
-     * stringifyLambda({name: 'f', parameters: [['p','T']], returns: 'number'}  // f: (p: T) => number
-     * stringifyLambda({name: 'f', parameters: [['p','T']], returns: 'number', initialiser: '_ => 42'}  // f: (p: T) => string = _ => 42
+     * // note: these samples are actually simplified! See below.
+     * stringifyLambda({parameters: [['p','T']]})  // f: { (p: T): any, ... }
+     * stringifyLambda({name: 'f', parameters: [['p','T']]})  // f: { (p: T) => any, ...  }
+     * stringifyLambda({name: 'f', parameters: [['p','T']], returns: 'number'})  // f: { (p: T) => number, ...  }
+     * stringifyLambda({name: 'f', parameters: [['p','T']], returns: 'number', initialiser: '_ => 42'})  // f: { (p: T): string = _ => 42, ...  }
+     * ```
+     * 
+     * The generated string will not be just the signature of the function. Instead, it will be an object offering a callable signature.
+     * On top of that, it will also expose a property `__parameters`, which is an object reflecting the functions parameters.
+     * The reason for this is that the CDS runtime actually treats the function parameters as a named object. This can not be rectified via
+     * type magic, as parameter names do not exist on type level. So we can not use these names to reuse them as object properties.
+     * Instead, we generate this utility object for the runtime to use:
      * 
+     * @example
+     * ```js
+     * stringifyLambda({name: 'f', parameters: [['p','T']], returns: 'number'})  // { (p: T): number, __parameters: { p: T } }
      * ```
      */
-    static stringifyLambda({name, parameters=[], returns='any', initialiser}) {
-        const signature = `(${parameters.map(([n, t]) => `${n}: ${t}`).join(', ')}) => ${returns}`
-        const prefix = name ? `${name}: `: ''
+    static stringifyLambda({name, parameters=[], returns='any', initialiser, isStatic=false}) {
+        const parameterTypes = parameters.map(([n, t]) => `${n}: ${t}`).join(', ')
+        const callableSignature = `(${parameterTypes}): ${returns}`
+        let prefix = name ? `${name}: `: ''
+        if (prefix && isStatic) {
+            prefix = `static ${prefix}`
+        }
         const suffix = initialiser ? ` = ${initialiser}` : ''
-        return prefix + signature + suffix
+        const lambda = `{ ${callableSignature}, __parameters: {${parameterTypes}}, __returns: ${returns} }`
+        return prefix + lambda + suffix
     }
 
     /**

package/lib/visitor.js

@@ -144,20 +144,25 @@ class Visitor {
             }
         }      
 
+        buffer.add('static actions: {')
+        buffer.indent()
         for (const [aname, action] of Object.entries(entity.actions ?? {})) {
             buffer.add(
                 SourceFile.stringifyLambda({
                     name: aname,
                     parameters: this.#stringifyFunctionParams(action.params, file),
-                    returns: action.returns ? this.resolver.resolveAndRequire(action.returns, file).typeName : 'any',
-                    initialiser: `undefined as unknown as this['${aname}']`
+                    returns: action.returns ? this.resolver.resolveAndRequire(action.returns, file).typeName : 'any'
+                    //initialiser: `undefined as unknown as typeof ${clean}.${aname}`,
                 })
             )
         }
         buffer.outdent()
-        buffer.add('};')
+        buffer.add('}') // end of actions
+
+        buffer.outdent()
+        buffer.add('};') // end of generated class
         buffer.outdent()
-        buffer.add('}')
+        buffer.add('}')  // end of aspect
 
         // CLASS WITH ADDED ASPECTS
         file.addImport(baseDefinitions.path)

package/package.json

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