@cap-js/cds-typer 0.29.0 → 0.30.0

package/CHANGELOG.md

@@ -4,7 +4,16 @@ 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.30.0 - TBD
+## Version 0.31.0 - TBD
+
+## Version 0.30.0 - 2024-12-02
+
+### Changed
+- [breaking] when running cds-typer in a CAP project, the default for the `outputDirectory` option will be `./@cds-models` instead of `./`. This default takes the lowest precedence after setting it in the project's `cds.env`, or explicitly as CLI argument.
+
+### Fixed
+- cds-typer no longer ignores the selected `outputDirectory`, which would also cause an issue during build
+
 
 ## Version 0.29.0 - 2024-11-20
 ### Added

package/lib/cli.js

@@ -142,6 +142,7 @@ const addCLIParamsToConfig = params => {
     }
 }
 
+// when changing/ adding anything in here, make sure to adjust scripts/write-cds-typer-schema.js accordingly!
 const flags = enrichFlagSchema({
     outputDirectory: {
         desc: 'Root directory to write the generated files to.',
@@ -258,6 +259,9 @@ const prepareParameters = (/** @type {any[]} */ argv) => {
 }
 
 const main = async (/** @type {any[]} */ argv) => {
+    // when calling from CLI within a CAP project, make sure plugins (this includes cds-typer)
+    // are initialised and have their default values injected into cds.env
+    await cds.plugins
     const { positional } = prepareParameters(argv)
     compileFromFile(positional)
 }

package/lib/config.js

@@ -1,3 +1,5 @@
+const fs = require('node:fs')
+const path = require('node:path')
 const cds = require('@sap/cds')
 const { camelToSnake, getProjectTargetType } = require('./util')
 const { LOG } = require('./logging')
@@ -32,21 +34,30 @@ const camelSnakeHybrid = target => {
     return proxy
 }
 class Config {
-    static #defaults = {
-        propertiesOptional: true,
-        useEntitiesProxy: false,
-        inlineDeclarations: 'flat',
-        outputDirectory: '.',
-        targetModuleType: 'auto'
+    /** @type {Record<string, unknown>} */
+    static #defaults = {}
+    static get defaults () {
+        // these are the exact defaults that are used when cds-typer is loaded as cds plugin
+        // which will shove the values into cds.env. When executed standalone, without cds environment,
+        // we need to load them from package.json ourselves.
+        if (Object.keys(Config.#defaults).length) return Config.#defaults
+        try {
+            const packageJsonPath = path.resolve(__dirname, path.join('..', 'package.json'))
+            const pjson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+            Config.#defaults = pjson.cds.typer
+        } catch (e) {
+            LOG.error(`Failed to load default configuration from package.json: ${e}`)
+        }
+        return Config.#defaults
     }
 
     values = undefined
     proxy = undefined
 
     init () {
-        this.values = {...Config.#defaults, ...(cds.env.typer ?? {})}
+        this.values = {...Config.defaults, ...(cds.env.typer ?? {})}
         this.proxy = camelSnakeHybrid(this.values)
-        if (this.values.targetModuleType === 'auto') {
+        if (this.proxy.targetModuleType === 'auto') {
             const type = getProjectTargetType(cds.root)
             if (type) {
                 LOG.info(`automatically detected module type '${type}' in ${cds.root}`)

package/lib/file.js

@@ -10,7 +10,6 @@ const { proxyAccessFunction } = require('./components/javascript')
 const { createObjectOf, stringIdent } = require('./printers/wrappers')
 const { configuration } = require('./config')
 const { CJSPrinter, ESMPrinter } = require('./printers/javascript')
-const { getProjectTargetType } = require('./util')
 
 const AUTO_GEN_NOTE = '// This is an automatically generated file. Please do not change its contents manually!'
 
@@ -109,6 +108,9 @@ class Library extends File {
  * Source file containing several buffers.
  */
 class SourceFile extends File {
+    /** @type {import('../lib/printers/javascript').Printer | undefined} */
+    #jsPrinter
+
     /**
      * @param {string | Path} path - path to the file
      */
@@ -146,8 +148,10 @@ class SourceFile extends File {
         this.services = { buffer: new Buffer(), names: [] }
         /** @type {Record<string,string[]>} */
         this.entityProxies = {}
-        /** @type {import('../lib/printers/javascript').Printer} */
-        this.jsPrinter = configuration.targetModuleType === 'esm'
+    }
+
+    get jsPrinter () {
+        return this.#jsPrinter ??= configuration.targetModuleType === 'esm'
             ? new ESMPrinter()
             : new CJSPrinter()
     }

package/lib/printers/javascript.js

@@ -17,7 +17,7 @@ class JavaScriptPrinter {
     /**
      * @abstract
      * @param {string} alias - what the import should be known as within the importing file
-     * @param {string} from - the package/ location to import from 
+     * @param {string} from - the package/ location to import from
      * @returns {string}
      */
     // eslint-disable-next-line no-unused-vars

package/lib/visitor.js

@@ -8,7 +8,7 @@ const { SourceFile, FileRepository, Buffer, Path } = require('./file')
 const { FlatInlineDeclarationResolver, StructuredInlineDeclarationResolver } = require('./components/inline')
 const { Resolver } = require('./resolution/resolver')
 const { LOG } = require('./logging')
-const { docify, createPromiseOf, createUnionOf, createKeysOf, createElementsOf, stringIdent, createDraftsOf, createDraftOf, createIntersectionOf, createReturnTypeOf } = require('./printers/wrappers')
+const { docify, createPromiseOf, createUnionOf, createKeysOf, createElementsOf, stringIdent, createDraftsOf, createDraftOf, createIntersectionOf } = require('./printers/wrappers')
 const { csnToEnumPairs, propertyToInlineEnumName, isInlineEnumType, stringifyEnumType } = require('./components/enum')
 const { isReferenceType } = require('./components/reference')
 const { empty } = require('./components/typescript')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-typer",
-  "version": "0.29.0",
+  "version": "0.30.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",
@@ -63,6 +63,13 @@
     ]
   },
   "cds": {
+    "typer": {
+      "output_directory": "@cds-models",
+      "inline_declarations": "flat",
+      "target_module_type": "auto",
+      "properties_optional": true,
+      "use_entities_proxy": false
+    },
     "schema": {
       "buildTaskType": {
         "name": "typescript",