@cap-js/cds-typer 0.7.0 → 0.8.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.7.1 - TBD
+## Version 0.8.1 - TBD
 
 ### Changed
 
@@ -12,6 +12,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ### Fixed
 
+
+## Version 0.8.0 - 2023-09-05
+
+### Changed
+
+### Added
+
+### Fixed
+- Foreign keys that are inherited via aspects are now also generated in addition to the resolved property (see 0.7.0)
+- Explicitly annotated `@singular` and `@plural` names are now properly used in generated _index.js_ files
+
+
 ## Version 0.7.0 - 2023-08-22
 
 ### Changed

package/lib/file.js

@@ -335,6 +335,9 @@ class SourceFile extends File {
                     .flatMap(([singular, plural, original]) => Array.from(new Set([
                         `module.exports.${singular} = csn.${original}`,
                         `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}`
                     ])))
             ) // singular -> plural aliases

package/lib/util.js

@@ -201,6 +201,24 @@ const parseCommandlineArgs = (argv, validFlags) => {
 * when removing an annotation which we also check.
 */
 function fixCSN(csn) {
+    for (const element of Object.values(csn.definitions)) {
+        Object.defineProperty(element, 'keys', {
+            get: function () {
+                // cached access to all immediately defined _and_ inherited keys.
+                // They need to be explicitly accessible in subclasses to generate
+                // foreign key fields from Associations/ Compositions.
+                if (!Object.hasOwn(this, '__keys')) {
+                    const ownKeys = Object.fromEntries(Object.entries(this.elements ?? {}).filter(([,el]) => el.key === true))
+                    const inheritedKeys = this.includes?.flatMap(parent => csn.definitions[parent].keys) ?? []
+                    this.__keys = inheritedKeys.reduce((ks, ps) => ({...ps, ...ks}), ownKeys)
+                }
+                return this.__keys
+            }
+        })
+    }
+
+    // FIXME: delete after merge with draft-enablement PR
+    return
     const erase = (entity, parent, attr) => {
         if (attr in entity) {
             const ea = entity[attr]

package/lib/visitor.js

@@ -59,6 +59,7 @@ 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,8 +131,13 @@ class Visitor {
         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)
+            if ('target' in element) {
+                // lookup in cds.definitions can fail for inline structs.
+                // 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.definitions[element.target]?.keys ?? {})) {
+                    this.visitElement(`${ename}_${kname}`, kelement, file, buffer)
+                }
             }
         }
         for (const [aname, action] of Object.entries(entity.actions ?? {})) {
@@ -207,7 +213,8 @@ class Visitor {
         // to have Books.texts = Books.text, so we derive the singular once more without cutting off the ns.
         // Directly deriving it from the plural makes sure we retain any parent namespaces of kind "entity",
         // which would not be possible while already in singular form, as "Book.text" could not be resolved in CSN.
-        file.addInflection(util.singular4(plural), plural, clean)
+        // edge case: @singular annotation present. singular4 will take care of that.
+        file.addInflection(util.singular4(entity, true), plural, clean)
         if ('doc' in entity) {
             docify(entity.doc).forEach((d) => buffer.add(d))
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-typer",
-  "version": "0.7.0",
+  "version": "0.8.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",
@@ -43,6 +43,7 @@
     "@sap/cds": ">=6"
   },
   "devDependencies": {
+    "acorn": "^8.10.0",
     "eslint": "^8.15.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",