@sap/cds-dk 8.4.2 → 8.5.1

package/lib/init/add.js

@@ -15,5 +15,31 @@ module.exports = {
   register: (name, plugin) => {
     registered.set(name, plugin)
   },
+  filterStringAsRegex,
   registered
 }
+
+/**
+ * Turns a filter string with optional meta characters into a regular expression.
+ * If no meta characters are found, the string is treated as an include pattern.
+ *
+ * @param {string} spec the filter string
+ * @returns {RegExp} the regular expression
+ */
+function filterStringAsRegex(spec) {
+  if (typeof spec === 'string') {
+    try {
+      if (spec.match(/[\^$|*]/)) {
+        spec = spec.replace(/^\*/, '.*')  // * at start would be invalid, so make it a .*
+        return new RegExp(spec, 'i')
+      }
+      else { // no meta chars -> include semantics
+        spec = spec.replace(/\./g, '\\.') // escape literal dot
+        return new RegExp(spec, 'i')
+      }
+    } catch (err) {
+      throw err.message // user error, so cut off stack trace
+    }
+  }
+  return /.*/
+}

package/lib/init/constants.js

@@ -5,7 +5,7 @@ module.exports = {
     COMMAND_ADD: 'add',
 
     JAVA_LTS_VERSIONS: [17, 21],
-    MAVEN_ARCHETYPE_VERSION: '3.4.1',
+    MAVEN_ARCHETYPE_VERSION: '3.5.0',
 
     OPTIONS: Object.freeze({
         COMPLETION: 'completion',
@@ -13,9 +13,13 @@ module.exports = {
         JAVA_MVN: 'java:mvn',
         JAVA_PACKAGE: 'java:package',
         NODEJS: 'nodejs',
+        ESM: 'esm',
         SAMPLES: 'samples', // deprecated
         TINY_SAMPLE: 'tiny-sample',
         SAMPLE: 'sample',
+        TYPER: 'typer',
+        TYPESCRIPT: 'typescript',
+        HANDLER: 'handler', // influenced by esm, typer and typescript
         MTA: 'mta',
         CF_MANIFEST: 'cf-manifest',
         HELM: 'helm',
@@ -57,8 +61,6 @@ module.exports = {
         LINT_GLOBAL: 'lint:global',
         LINT_DEV: 'lint:dev',
         PIPELINE: 'pipeline',
-        TYPER: 'typer',
-        TYPESCRIPT: 'typescript'
     }),
 
     REGEX_JAVA_PACKAGE: /^[a-z_][a-z0-9_]*(\.[a-z_][a-z0-9_]*)*$/g,
@@ -71,9 +73,6 @@ module.exports = {
         CAPIRE: 'https://cap.cloud.sap',
         MAVEN_ARCHETYPE_HELP: `https://cap.cloud.sap/docs/java/developing-applications/building#the-maven-archetype`,
         MAVEN_INSTALL_HELP: `https://maven.apache.org/install.html`,
-        CAP_JS_COMMUNITY_ODATA_V2: 'https://github.com/cap-js-community/odata-v2-adapter',
-        CAP_JS_COMMUNITY_EVENT_QUEUE: 'https://github.com/cap-js-community/event-queue',
-        CAP_JS_COMMUNITY_WEBSOCKET: 'https://github.com/cap-js-community/websocket',
         CF_CLI: 'https://github.com/cloudfoundry/cli'
     }),
 

package/lib/init/index.js

@@ -12,17 +12,13 @@ const DEBUG = /\b(y|all|cli)\b/.test(process.env.DEBUG) ? console.debug : undefi
 
 module.exports = class CDSGenerator {
 
-    /** @returns {string[]} */
-    static #findPlugins(excluded) {
-        // actually needs to be sync to be usable in module.exports of dk/bin/init.js
-        const fromDk = readdirSync(join(__dirname, 'template'))
-        const fromPlugins = Object.keys(Object.fromEntries(require('./add').registered))
-        return [...fromDk, ...fromPlugins]
-            .filter(plugin => !excluded?.includes(plugin))
+    constructor() {
+        this.cwd = process.cwd()
+        this.uiConfig = require('./bas') // Used by CAP Generator
     }
 
     static help({ exclude = [] } = {}) {
-        if (!cds.add) return // use case shell completion: cds.add is undefined and not needed
+        if (!cds.add) return // shell completion: cds.add is undefined and not needed
 
         const plugins = this.readPlugins(exclude)
         const nameFixedLength = Math.max(...plugins.map(plugin => plugin.name.length))
@@ -35,10 +31,14 @@ module.exports = class CDSGenerator {
     }
 
     /**
+     * @param excluded {string[]}
      * @returns {{name: string, module: import('module')}[]}
      */
     static readPlugins(excluded = []) {
-        const plugins = this.#findPlugins(excluded)
+        const fromDk = readdirSync(join(__dirname, 'template'))
+        const fromPlugins = Object.keys(Object.fromEntries(require('./add').registered))
+        const all = [...fromDk, ...fromPlugins]
+            .filter(plugin => !excluded?.includes(plugin))
             .map(plugin => ({
                 name: plugin,
                 module: cds.add.registered.get(plugin) ?? require('./template/' + plugin)
@@ -51,12 +51,7 @@ module.exports = class CDSGenerator {
             if (b === -1) return -1
             return a - b
         }
-        return plugins.sort(byPriority)
-    }
-
-    constructor() {
-        this.cwd = process.cwd()
-        this.uiConfig = require('./bas') // Used by CAP Generator
+        return all.sort(byPriority)
     }
 
     /**
@@ -216,15 +211,14 @@ module.exports = class CDSGenerator {
         }
 
         const cmds = Object.values(OPTIONS)
-        this.templateList = Array.from(templates.entries())
-            .sort(([lhs], [rhs]) => {
-                const a = cmds.indexOf(lhs), b = cmds.indexOf(rhs)
-                if (a === -1 && b === -1) return 0
-                if (a === -1) return 1
-                if (b === -1) return -1
+        const priorities = new Map(cmds.map((cmd, i) => [cmd, i]))
+        this.templateList = Array.from(templates.keys())
+            .sort((lhs, rhs) => {
+                const a = priorities.get(lhs) ?? Infinity
+                const b = priorities.get(rhs) ?? Infinity
                 return a - b
             })
-            .map((entry) => entry[1])
+            .map(key => templates.get(key))
 
         DEBUG?.(`Features: ${this.templateList.map(({ name }) => name).join(', ')}`);
     }
@@ -240,11 +234,9 @@ module.exports = class CDSGenerator {
 
         const { options } = cds.cli
         if (typeof options.add === 'string') {
-            tokens = options.add.split(/[,\s+]/g);
-
+            tokens = options.add.split(/[,\s+]/g)
         } else if (Array.isArray(options.add)) {
             tokens = options.add
-
         } else if (options.add instanceof Set) {
             tokens = [...options.add];
         }

package/lib/init/merge.js

@@ -6,11 +6,8 @@ const { readYAML, writeYAML, readJSON } = require('../util/fs')
 const { detectIndent } = require('./indent')
 const { colors } = require('../util/term')
 
-function _isObject(item) {
-  return item && typeof item === 'object' && !Array.isArray(item)
-}
-
 function _mergeObject(target, source) {
+  const _isObject = item => item && typeof item === 'object' && !Array.isArray(item)
   const unique = array => [...new Set(array.map(JSON.stringify))].map(JSON.parse)
   if (_isObject(target) && _isObject(source)) {
       for (const key in source) {
@@ -156,7 +153,7 @@ async function _mergeYAML(into, from, project, semantics = {}) {
     relationships?.forEach(relationship => {
         const [entry] = relationship.into
         const [insertEntry] = relationship.insert
-        const hash = insertEntry + ' -> ' + entry
+        const hash = JSON.stringify(insertEntry) + ' -> ' + JSON.stringify(entry)
         entryMap.set(hash, undefined)
     })
 

package/lib/init/projectReader.js

@@ -1,6 +1,6 @@
 const cds = require('../cds')
 const { join, resolve, basename } = require('path')
-const { fs, exists, isdir, path } = cds.utils
+const { fs, exists, isfile, isdir, path } = cds.utils
 const { parseXml } = require('./xml')
 const { REGEX_JAVA_VERSION, JAVA_LTS_VERSIONS } = require('./constants')
 const TRACE = cds.debug('trace')
@@ -12,13 +12,15 @@ module.exports = new class ProjectReader {
     }
 
     #setPackageInfo() {
+        this.isJava = (exists('pom.xml') || cds.cli.options?.add?.has('java'))
+                        && !cds.env.for('cds').profiles.includes('node') // opt-out for hybrid projects like sflight
+
         // 1. Use project name and static default values
-        this.appVersion = cds.cli.options?.add?.has('java') ? '1.0.0-SNAPSHOT' : '1.0.0'
+        this.appVersion = this.isJava ? '1.0.0-SNAPSHOT' : '1.0.0'
         this.appName = this.appId = basename(cds.root)
         this.appDescription = 'A simple CAP project.'
 
-        const isJava = exists('pom.xml') || cds.cli.options?.add?.has('java')
-        if (isJava) {
+        if (this.isJava) {
             let artifactId, description, version, properties
             try {
                 ({ artifactId, description, version, properties } = parseXml(resolve(cds.root, 'pom.xml')) ?? {})
@@ -74,6 +76,10 @@ module.exports = new class ProjectReader {
      * @property {boolean} isUI5 Indicates if the project is a UI5 project.
      * @property {boolean} isJava Indicates if the project is using Java.
      * @property {boolean} isNodejs Indicates if the project is using Node.js.
+     * @property {boolean} isESM Indicates if the project is an ESM project (type 'module')
+     * @property {boolean} hasEsmStyle Indicates if code supports ESM-style imports and exports. This is true for ESM and Typescript projects.
+     * @property {boolean} isTypescript Indicates if the project is a Typescript project.
+     * @property {boolean} hasTyper Indicates if code supports CDS typer.
      * @property {boolean} hasHelmUnifiedRuntime Indicates if the project uses Unified Runtime Helm deployment.
      * @property {boolean} hasHelm Indicates if the project uses CAP Helm deployment.
      * @property {boolean} hasMta Indicates if the project uses MTA deployment.
@@ -95,7 +101,7 @@ module.exports = new class ProjectReader {
      * @property {boolean} hasMTXRouteJava Indicates if the approuter should have a multitenant subscription route (java).
      * @property {boolean} hasMalwareScanner Indicates if the project uses the SAP Malware Scanning service.
      * @property {boolean} hasDynatrace Indicates if the project uses Dynatrace.
-     *
+     * @property {boolean} hasCloudLogging Indicates if the project uses Cloud Logging.
      */
 
     /**
@@ -110,18 +116,27 @@ module.exports = new class ProjectReader {
         const { appVersion, appName, appId, appDescription, jdkVersion } = this
         TRACE?.({ env })
 
+        const pkgJson = () => exists('package.json') ? JSON.parse(fs.readFileSync(join(cds.root, 'package.json'))) : {}
+        const _isESM        = () => pkgJson().type === 'module'
+        const _isTypescript = () => !!pkgJson().dependencies?.typescript || !!pkgJson().devDependencies?.typescript
+        const _hasTyper     = () => !!pkgJson().dependencies?.['@cap-js/cds-typer'] || !!pkgJson().devDependencies?.['@cap-js/cds-typer']
+
         const _inProd = plugin => require(`./template/${plugin}`).hasInProduction(env)
-        const _ui5 = () => exists('package.json') && !!JSON.parse(fs.readFileSync(path.resolve(cds.root, 'package.json'))).sapux
+        const _ui5 = () => pkgJson().sapux
         const _uiEmbedded = () => exists(join(env.folders.app, 'xs-app.json'))
         const _uiModule = () => !_uiEmbedded() && isdir(env.folders.app) && fs.readdirSync(resolve(cds.root, env.folders.app)).length > 0
-        const _isJava = () => exists('pom.xml') || cds.cli.options?.add?.has('java')
+        const _isJava = () => this.isJava
         const isApp = name => name !== 'appconfig' && !name.startsWith('_') && name !== 'router' && name !== 'portal'
         const reserved = {
             has: x => _inProd(x),
             profile: () => cds.cli.options?.for,
-            language: () => exists('pom.xml') ? 'java' : 'nodejs',
+            language: () => _isJava() ? 'java' : 'nodejs',
             isJava: () => _isJava(),
             isNodejs: () => !_isJava(),
+            isTypescript: () => _isTypescript(),
+            isESM: () => _isESM,
+            hasEsmStyle: () => _isTypescript() || _isESM(),
+            hasTyper: () => _hasTyper(),
             srvPath: () => join(env.build.target, env.folders.srv.replace(/\/$/, '')).replace(/\\/g, '/'),
             archiveName: () => {
                 const pomXmlPath = resolve(cds.root, env.folders.srv, 'pom.xml')
@@ -135,7 +150,7 @@ module.exports = new class ProjectReader {
                 const path = join(env.build.target, name).replace(/\\/g, '/')
                 return { folder, name, path }
             },
-            configFile: () => exists('pom.xml') ? '.cdsrc.json' : 'package.json',
+            configFile: () => _isJava() ? '.cdsrc.json' : 'package.json',
             apps: () => {
                 const apps = fs.readdirSync(path.resolve(cds.root, cds.env.folders.app)).filter(e =>
                     isdir(path.join(cds.root, cds.env.folders.app, e)) && isApp(e)
@@ -152,6 +167,7 @@ module.exports = new class ProjectReader {
             appUIPaths: () => (fs.readdirSync(path.resolve(cds.root, cds.env.folders.app))).filter(e =>
                 isdir(join(cds.root, cds.env.folders.app, e)) && isApp(e)
             ),
+            hasIndexHtml: () => {},
             appPath: () => env.folders.app,
             appVersion: () => appVersion,
             jdkVersion: () => jdkVersion,
@@ -191,3 +207,54 @@ module.exports = new class ProjectReader {
         return project
     }
 }
+
+/**
+ * Finds and reads SpringBoot configuration in `cds.root/srv` dir.
+ * This is done in a best-effort way. In no way can we replciate all of SpringBoot's
+ * config variants.
+ * @param {string[]?} roots array of directories to search for application.yaml, like `srv`
+ * @returns {Promise<object[]>} array of objects with `cds` property
+ */
+module.exports._readSpringBootConfig = async function (roots=[cds.env.folders.srv]) {
+    const configNodes = []
+    const rootDirs = roots.map(d => join(cds.root, d))
+    for (let r of rootDirs) {
+      const file = isfile (join (r,'./src/main/resources/application.yaml'))
+      if (file) {
+        const yaml = cds.load.yaml(file)
+        for (let yamlDoc of Array.isArray(yaml) ? yaml : [yaml]) {
+          let cds = yamlDoc?.cds;
+          if (!cds)   continue
+          cds = _normalizeSpringBootCfg(cds)
+          configNodes.push({cds})
+        }
+      }
+    }
+    return configNodes
+  }
+
+/**
+ * Normalize SpringBoot's dots in keys to express nested objects
+ *
+ * @example: `cds.foo.bar = 1` --> `cds: { foo: { bar: 1 } }`
+ * @param {object} obj
+ * @returns {object}
+ */
+function _normalizeSpringBootCfg(obj) {
+    if (typeof obj !== 'object')  return obj
+    Object.keys(obj).forEach(k => {
+        const prop = k.split('.')
+        const last = prop.pop()
+        // and define the object if not already defined
+        const res = prop.reduce((o, key) => {
+            // define the object if not defined and return
+            return o[key] = o[key] ?? {}
+        }, obj)
+        res[last] = obj[k]
+        // recursively normalize
+        _normalizeSpringBootCfg(obj[k])
+        // delete the original property from object if it was rewritten
+        if (prop.length)  delete obj[k]
+    })
+    return obj
+}

package/lib/init/registries/mta.js

@@ -1,4 +1,3 @@
-// Registry of sequence matchers in mta.yaml files
 const cds = require('../../cds')
 
 const srvNode4 = path => ({ in: 'modules', where: { type: 'nodejs', path } })

package/lib/init/template/approuter/files/package.json

@@ -4,7 +4,7 @@
     "@sap/approuter": "^17.0.0"
   },
   "engines": {
-    "node": "^22.0.0"
+    "node": "^20"
   },
   "scripts": {
     "start": "node node_modules/@sap/approuter/approuter.js"

package/lib/init/template/cloud-logging/files/package.json.hbs

@@ -1,18 +1,7 @@
 {
-  "dependencies": {
-    "@cap-js/telemetry": ">=0",
-    "@grpc/grpc-js": "^1",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0",
-    "@opentelemetry/exporter-metrics-otlp-grpc": "^0",
-    "@opentelemetry/host-metrics": "^0"
-  },
   "cds": {
     "requires": {
-      "[{{profile}}]": {
-        "telemetry": {
-          "kind": "to-cloud-logging"
-        }
-      }
+      "cloud-logging": true
     }
   }
 }

package/lib/init/template/cloud-logging/files/values.yaml.hbs

@@ -0,0 +1,16 @@
+---
+srv:
+  bindings:
+    cloud-logging:
+      serviceInstanceName: cloud-logging
+      credentialsRotationPolicy:
+        enabled: true
+        rotationFrequency: 168h
+cloud-logging:
+  serviceOfferingName: cloud-logging
+  servicePlanName: standard
+  parameters:
+    ingest_otlp:
+        enabled: true
+
+

package/lib/init/template/cloud-logging/index.js

@@ -7,7 +7,7 @@ const { srv4, mtxSidecar4, approuter } = require('../../registries/mta')
 module.exports = class extends require('../../plugin') {
 
   static hasInProduction(env) {
-    return env.requires?.telemetry?.kind === 'to-cloud-logging'
+    return env.requires?.['cloud-logging'];
   }
 
   options() {
@@ -24,23 +24,23 @@ module.exports = class extends require('../../plugin') {
   }
 
   async canRun() {
-    const { hasMta, hasHelm, hasHelmUnifiedRuntime } = readProject()
-    if ((hasHelmUnifiedRuntime || hasHelm) && !hasMta) throw `'cds add cloud-logging' is not available for Kyma yet`
     return true
   }
 
+  requires() {
+    const project = readProject(), { hasTelemetry } = project
+    if ((cds.cli.options['with-telemetry'] || hasTelemetry)) return ['telemetry']
+  }
+
   async run() {
-    const project = readProject(), { hasTelemetry, isNodejs } = project
-    if (isNodejs && (cds.cli.options['with-telemetry'] || hasTelemetry)) {
-      project.profile ??= 'production'
-      await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: project })
-      await sort('package.json', 'dependencies')
-    }
+    const project = readProject();
+    await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: project })
+    await sort('package.json', 'dependencies')
   }
 
   async combine() {
     const project = readProject()
-    const { hasMta, hasApprouter, isJava, hasMultitenancy, srvPath } = project
+    const { hasMta, hasHelm, hasHelmUnifiedRuntime, hasApprouter, isJava, hasMultitenancy, srvPath } = project
 
     if (hasMta) {
       const cloudLogging = {
@@ -77,5 +77,9 @@ module.exports = class extends require('../../plugin') {
         with: project, additions, relationships
       })
     }
+    if (hasHelm || hasHelmUnifiedRuntime) {
+      await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml')
+    }
   }
 }
+

package/lib/init/template/data/as-json.js

@@ -80,7 +80,7 @@ function fillRecord(record, recordID, artifact, csn, data, parent, depth, refere
   Object.defineProperty(record, '$id', {value: recordID, enumerable: false})
   if (data[artifact.name]) data[artifact.name].push(record) // add id to data, to be referenced by associations to prevent circular dependencies
 
-  const elems = Object.values(artifact.elements ?? artifact.params).sort(asJson.elementsSorter(csn))
+  const elems = Object.values(artifact.elements ?? artifact.params ?? {}).sort(asJson.elementsSorter(csn))
   elems.forEach(el => {
     record[el.name] = dataForField(el, artifact, csn, record, data, parent, depth, referenceData)
   })

package/lib/init/template/data/index.js

@@ -6,6 +6,7 @@ const { URLSearchParams } = require('url')
 const { env4 } = require('../../projectReader')
 const asJson = require('./as-json')
 const asCsv = require('./as-csv')
+const { filterStringAsRegex } = require('../../add')
 
 module.exports = class DataTemplate extends require('../../plugin') {
 
@@ -92,32 +93,6 @@ module.exports = class DataTemplate extends require('../../plugin') {
 }
 module.exports.asJson = asJson
 module.exports.asCsv = asCsv
-module.exports.filterStringAsRegex = filterStringAsRegex
-
-/**
- * Turns a filter string with optional meta characters into a regular expression.
- * If no meta characters are found, the string is treated as an include pattern.
- *
- * @param {string} spec the filter string
- * @returns {RegExp} the regular expression
- */
-function filterStringAsRegex(spec) {
-  if (typeof spec === 'string') {
-    try {
-      if (spec.match(/[\^$|*]/)) {
-        spec = spec.replace(/^\*/, '.*')  // * at start would be invalid, so make it a .*
-        return new RegExp(spec, 'i')
-      }
-      else { // no meta chars -> include semantics
-        spec = spec.replace(/\./g, '\\.') // escape literal dot
-        return new RegExp(spec, 'i')
-      }
-    } catch (err) {
-      throw err.message // user error, so cut off stack trace
-    }
-  }
-  return /.*/
-}
 
 function parseQueryStr(queryStr) {
   const params = new URLSearchParams(queryStr) // e.g. key1&key2=false

package/lib/init/template/esm/files/package.json.hbs

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/lib/init/template/esm/index.js

@@ -0,0 +1,16 @@
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+
+module.exports = class EsmTemplate extends require('../../plugin') {
+
+  static help() {
+    return 'ESM-compatible Node.js project'
+  }
+
+  async run() {
+    const project = readProject()
+    const { configFile } = project
+    await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project, forceOverwrite: true })
+  }
+
+}

package/lib/init/template/handler/files/handler.xs.hbs

@@ -0,0 +1,56 @@
+{{! ESM }}
+{{#hasEsmStyle}}
+import cds from '@sap/cds'
+{{#hasTyper}}
+{{#allNames}}
+import { {{allNames}} } from '#cds-models/{{{servicePath}}}'
+{{/allNames}}
+{{/hasTyper}}
+
+{{! class declaration }}
+export class {{serviceClass}} extends cds.ApplicationService { init() {
+{{/hasEsmStyle}}
+{{! CJS }}
+{{^hasEsmStyle}}
+const cds = require('@sap/cds')
+{{#hasTyper}}
+{{#allNames}}
+const { {{allNames}} } = require('#cds-models/{{{servicePath}}}')
+{{/allNames}}
+{{/hasTyper}}
+
+{{! class declaration }}
+module.exports = class {{serviceClass}} extends cds.ApplicationService { init() {
+{{/hasEsmStyle}}
+{{! dynamic model imports }}
+{{^hasTyper}}
+
+{{#entityNames}}
+  const { {{entityNames}} } = cds.entities('{{serviceName}}')
+{{/entityNames}}
+{{/hasTyper}}
+
+{{! entity handlers }}
+{{#entities}}
+  this.before (['CREATE', 'UPDATE'], {{name}}, async (req) => {
+    console.log('Before CREATE/UPDATE {{name}}', req.data)
+  })
+  this.after ('READ', {{name}}, async ({{dataVar}}, req) => {
+    console.log('After READ {{name}}', {{dataVar}})
+  })
+{{/entities}}
+
+{{! action handlers }}
+{{#operations}}
+{{#hasTyper}}
+  this.on ({{name}}, async (req) => {
+{{/hasTyper}}
+{{^hasTyper}}
+  this.on ('{{name}}', async (req) => {
+{{/hasTyper}}
+    console.log('On {{name}}', req.data)
+  })
+{{/operations}}
+
+  return super.init()
+}}