@sap/cds-dk 10.0.6 → 10.1.0

package/lib/init/plugin.js

@@ -45,8 +45,10 @@ module.exports = class Plugin {
 
     /**
      * Runs the combine operations for interoperability with other plugins.
+     * @param {string} [facet] This plugin's facet name, forwarded to `readProject(facet)`
+     *   so `add<Facet>` accessors can tell whether this facet is the one being added.
      */
-    async combine() { }
+    async combine(facet) { } // eslint-disable-line no-unused-vars
 
 
     /* ––––––––––––

package/lib/init/projectReader.js

@@ -65,9 +65,12 @@ module.exports = new class ProjectReader {
      * Reads the project configuration and constructs a project object.
      * This function dynamically resolves project properties and returns an object with these properties.
      *
+     * @param {string} [caller] The facet whose `combine()`/`run()` is requesting the project.
+     *   Used to resolve `add<Facet>` accessors: a template asks "am I being added right now?".
+     *   Omit when no facet context applies; `add<Facet>` then reflects only the CLI add list.
      * @returns {ProjectConfig} An object representing the project configuration.
      */
-    readProject() {
+    readProject(caller) {
         if (!this.appName) this.#setPackageInfo()
         const env = this.env4('production')
         if (this.isJava) env.build.target = '.'
@@ -83,8 +86,17 @@ module.exports = new class ProjectReader {
         const _uiModule = () => !_uiEmbedded() && isdir(env.folders.app) && fs.readdirSync(resolve(cds.root, env.folders.app)).length > 0
         const _isJava = () => this.isJava
         const _extends = () => pkgJson().extends
+        const UI_PACKAGES = ['@ui5/cli', 'react', 'vue', 'svelte', '@angular/core', 'vite']
         const isApp = name => {
-            return name !== 'appconfig' && !name.match(/^[._]/) && name !== 'router' && name !== 'portal' && name !== 'workzone' && name !== 'html5-deployer'
+            if (name.match(/^[._]/)) return false
+            const dir = path.join(cds.root, cds.env.folders.app, name)
+            if (exists(path.join(dir, 'webapp/manifest.json'))) return true
+            if (exists(path.join(dir, 'index.html'))) return true
+            const pJsonPath = path.join(dir, 'package.json')
+            if (!exists(pJsonPath)) return false
+            const { dependencies, devDependencies } = JSON.parse(fs.readFileSync(pJsonPath))
+            const deps = { ...dependencies, ...devDependencies }
+            return UI_PACKAGES.some(p => p in deps)
         }
         const reserved = {
             dependencies: () => pkgJson().dependencies,
@@ -129,6 +141,9 @@ module.exports = new class ProjectReader {
                     const inbounds = manifest?.['sap.app']?.crossNavigation?.inbounds
                     const [firstInbound] = Object.values(inbounds ?? { intent: { semanticObject: 'Books', action: 'display' } })
                     const vizId = firstInbound.semanticObject + '-' + firstInbound.action
+                    const appPkgPath = path.resolve(cds.root, cds.env.folders.app, app, 'package.json')
+                    const appPkg = exists(appPkgPath) ? JSON.parse(fs.readFileSync(appPkgPath, 'utf-8')) : {}
+                    const isStatic = !appPkg.scripts?.build
                     // Try to read archiveName from ui5.yaml if it exists
                     let archiveName = ''
                     const ui5YamlPaths = [
@@ -145,7 +160,7 @@ module.exports = new class ProjectReader {
                             }
                         }
                     }
-                    return { app, strippedApp: app.replace(/-/g, ''), vizId, isNotLast: i < apps.length - 1, manifestAppId: manifest?.['sap.app']?.id ?? app, archiveName }
+                    return { app, strippedApp: app.replace(/-/g, ''), vizId, isNotLast: i < apps.length - 1, manifestAppId: manifest?.['sap.app']?.id ?? app, archiveName, isStatic }
                 })
             },
             appUIPaths: () => {
@@ -159,7 +174,8 @@ module.exports = new class ProjectReader {
             appPath: () => env.folders.app,
             appVersion: () => appVersion,
             jdkVersion: () => jdkVersion,
-            approuterPath: () => (_uiEmbedded() ? join(env.folders.app) : exists('.deploy/app-router') ? join('.deploy', 'app-router') : join(env.folders.app, 'router')).replace(/\\/g, '/'),
+            approuterPath: () => (_uiEmbedded() ? join(env.folders.app) : exists(join(env.folders.app, 'router')) ? join(env.folders.app, 'router') : join('.deploy', 'app-router')).replace(/\\/g, '/'),
+            html5DeployerPath: () => (exists(join(env.folders.app, 'html5-deployer')) ? join(env.folders.app, 'html5-deployer') : join('.deploy', 'html5-deployer')).replace(/\\/g, '/'),
             appName: () => appName,
             cleanedAppName: () => appName.replaceAll('_', '-'),
             strippedAppName: () => appName.replace(/-/g, ''),
@@ -221,8 +237,7 @@ module.exports = new class ProjectReader {
                     const inProd = _inProd(facet)
                     if (prefix === 'add') {
                         const adding = plugin => cds.cli.command === 'add' && cds.cli.argv[0]?.split(',').includes(plugin) || cds.cli.options.add?.has(plugin)
-                        const caller = new Error().stack.split('\n')[3].replace(/\\/g, '/').match(/lib\/init\/template\/([^/]+)\/index\.js/)[1]
-                        return inProd && (adding(facet) || adding(caller))
+                        return inProd && (adding(facet) || (caller && adding(caller)))
                     }
                     return inProd
                 }
@@ -304,6 +319,7 @@ function _normalizeSpringBootCfg(obj) {
  * @property {string} configFile The name of the configuration file. This is typically the `package.json` for Node.js and `.cdsrc.json` for Java.
  * @property {string} appPath The path to the app folder.
  * @property {string} approuterPath The path to the approuter folder.
+ * @property {string} html5DeployerPath The path to the HTML5 application content deployer folder.
  * @property {boolean} hasUIEmbedded Indicates if the project uses an embedded UI.
  * @property {boolean} hasUIModule Indicates if the project is using a modular UI.
  * @property {boolean} hasUI Indicates if the project has a UI.

package/lib/init/registries/xs-app.js

@@ -1,8 +1,6 @@
-
-
-const odataApi = {
+const srvApi = {
   in: 'routes',
-  where: { target: '/odata/$1' }
+  where: { destination: 'srv-api' }
 }
 
 const html5RepoApi = {
@@ -11,6 +9,6 @@ const html5RepoApi = {
 }
 
 module.exports = {
-  odataApi,
+  srvApi,
   html5RepoApi
 }

package/lib/init/template/ai/files/mta.yaml.hbs

@@ -11,4 +11,4 @@ resources:
     type: org.cloudfoundry.managed-service
     parameters:
       service: aicore
-      service-plan: standard
+      service-plan: {{#servicePlan}}{{servicePlan}}{{/servicePlan}}{{^servicePlan}}standard{{/servicePlan}}

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

@@ -1,3 +1,4 @@
+const cds = require('../../../cds')
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
 const { srv4, aicore } = require('../../registries/mta')
@@ -9,6 +10,15 @@ module.exports = class AiTemplate extends require('../../plugin') {
         return 'SAP BTP AI Core'
     }
 
+    options() {
+        return {
+            'plan': {
+                type: 'string',
+                help: 'Specify the service plan.',
+            }
+        }
+    }
+
     static hasInProduction(env) {
         const { dependencies, isJava } = readProject()
         return dependencies?.['@cap-js/ai'] || isJava && env.requires?.AICore
@@ -20,11 +30,13 @@ module.exports = class AiTemplate extends require('../../plugin') {
         await merge(__dirname, 'files/package.json.hbs').into(configFile, { project })
     }
 
-    async combine() {
-        const project = readProject()
+    async combine(facet) {
+        const project = readProject(facet)
         const { addMta, addKyma, addMultitenancy, srv } = project
+        const { plan } = cds.cli.options
 
         if (addMta) {
+            if (plan) project.servicePlan = plan
             const srvModule = srv4(srv.path)
             await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
                 with: project,

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

@@ -26,8 +26,8 @@ module.exports = class AmsTemplate extends require('../../plugin') {
         if (project.isJava) await mvn.add('ams')
     }
 
-    async combine() {
-        const project = readProject()
+    async combine(facet) {
+        const project = readProject(facet)
         const { addMta, addCfManifest, addKyma } = project
 
         if (addMta) {

package/lib/init/template/app-frontend/files/containerize.yaml.hbs

@@ -7,7 +7,7 @@ modules:
         builder: proxy-unified-runtime-dmz.int.repositories.cloud.sap/builder/noble
         {{/hasKymaUnifiedRuntime}}
         {{^hasKymaUnifiedRuntime}}
-        type: sapse/application-content-deployer-buildpack:1.4.0
+        type: sapse/application-content-deployer-buildpack:1.5.0
         builder: builder-jammy-base
         {{/hasKymaUnifiedRuntime}}
-        path: app/html5-deployer
+        path: {{& html5DeployerPath}}

package/lib/init/template/app-frontend/index.js

@@ -1,7 +1,7 @@
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
 const { srv4, appDeployer, appFront, xsuaa } = require('../../registries/mta')
-const { odataApi } = require('../../registries/xs-app')
+const { srvApi } = require('../../registries/xs-app')
 const { renderAndCopy } = require('../../template')
 const { sh:$, path:{join}, fs:{promises:{rename}}, write, read, exists } = require('../../../cds').utils
 
@@ -50,8 +50,8 @@ module.exports = class extends require('../../plugin') {
 
     }
 
-    async combine() {
-        const project = readProject()
+    async combine(facet) {
+        const project = readProject(facet)
         const {
             srv, appPath, apps,
             hasMta, addMta, hasXsuaa, addSample, addApprouter, addWorkzoneStandard, addXsuaa, addIas,
@@ -61,7 +61,7 @@ module.exports = class extends require('../../plugin') {
         await Promise.all(apps.map(async ({ app }) => {
             project.app = app
             project.hasIndexHtml = exists(join(appPath, app, 'webapp/index.html'))
-            const additions = [odataApi]
+            const additions = [srvApi]
             await merge(__dirname, 'files/xs-app.json.hbs').into(join(appPath, app, 'xs-app.json'), { with: project, additions })
         }))
 

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

@@ -26,8 +26,8 @@ module.exports = class ApplicationLoggingTemplate extends require('../../plugin'
         if (isJava) await mvn.add('APPLICATION_LOGGING')
     }
 
-    async combine() {
-        const project = readProject()
+    async combine(facet) {
+        const project = readProject(facet)
         const { addMta, hasMta, hasApprouter, isJava, addMultitenancy, hasMultitenancy, srv } = project
 
         if (addMta || (addMultitenancy && hasMta)) {

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

@@ -1,7 +1,7 @@
 {
   "name": "approuter",
   "dependencies": {
-    "@sap/approuter": "^22.0.0"
+    "@sap/approuter": "^23.0.0"
   },
   "scripts": {
     "start": "node node_modules/@sap/approuter/approuter.js"

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

@@ -31,8 +31,8 @@ module.exports = class ApprouterTemplate extends require('../../plugin') {
         await merge(__dirname, 'files/default-env.json').into(approuterPath + '/default-env.json')
     }
 
-    async combine() {
-        const project = readProject()
+    async combine(facet) {
+        const project = readProject(facet)
         const {
             isNodejs, isJava,
             addIas, addXsuaa, hasXsuaa, hasIas, addMultitenancy, hasMTXRoute, hasMTXRouteJava,
@@ -51,6 +51,7 @@ module.exports = class ApprouterTemplate extends require('../../plugin') {
             if (hasMultitenancy) modules.push(mtxSidecar)
             const additions = [...modules, ...apis]
             const relationships = []
+            const deletions = []
             if (hasXsuaa) {
                 relationships.push({
                     insert: [xsuaa, 'name'],
@@ -62,9 +63,13 @@ module.exports = class ApprouterTemplate extends require('../../plugin') {
                     insert: [ias, 'name'],
                     into: [approuter, 'requires', 'name']
                 })
+                deletions.push({
+                    item: { in: [approuter, 'requires'], where: { 'name': 'srv-api' } },
+                    key: 'properties.name'
+                })
             }
             await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
-                with: project, additions, relationships,
+                with: project, additions, relationships, deletions,
             })
         }
 

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

@@ -1,5 +1,5 @@
 {
   "dependencies": {
-    "@cap-js/attachments": "^3"
+    "@cap-js/attachments": "^4"
   }
 }

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

@@ -25,8 +25,8 @@ module.exports = class AttachmentsTemplate extends require('../../plugin') {
         if (isJava) await mvn.add('attachments')
     }
 
-    async combine() {
-        const project = readProject()
+    async combine(facet) {
+        const project = readProject(facet)
         const { addMta, addKyma, srv } = project
 
         if (addMta) {

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

@@ -32,8 +32,8 @@ module.exports = class AuditLoggingTemplate extends require('../../plugin') {
     if (isJava) await mvn.add('audit_logging')
   }
 
-  async combine() {
-    const project = readProject()
+  async combine(facet) {
+    const project = readProject(facet)
     const { addMta, addKyma, addMultitenancy, srv } = project
     const { plan = 'premium' } = cds.cli.options
     project.servicePlan = plan

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

@@ -1,11 +1,11 @@
 {
   {{#withTelemetry}}
   "dependencies": {
-    "@cap-js/telemetry": ">=0",
+    "@cap-js/telemetry": "^2",
     "@grpc/grpc-js": "^1",
-    "@opentelemetry/exporter-trace-otlp-grpc": "<0.200",
-    "@opentelemetry/exporter-metrics-otlp-grpc": "<0.200",
-    "@opentelemetry/host-metrics": "<0.200"
+    "@opentelemetry/exporter-trace-otlp-grpc": ">=0.200",
+    "@opentelemetry/exporter-metrics-otlp-grpc": ">=0.200",
+    "@opentelemetry/instrumentation-host-metrics": ">=0.2"
   },
   {{/withTelemetry}}
   "cds": {

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

@@ -38,8 +38,8 @@ module.exports = class extends require('../../plugin') {
     }
   }
 
-  async combine() {
-    const project = readProject()
+  async combine(facet) {
+    const project = readProject(facet)
     const { hasMta, addMta, addKyma, addApprouter, isJava, addMultitenancy, srv } = project
 
     if (addMta || (addMultitenancy || addApprouter) && hasMta) {

package/lib/init/template/completion/completionSetup.js

@@ -16,26 +16,33 @@ const SUPPORTED_SHELLS = [...SUPPORTED_LINUX_SHELLS, ...SUPPORTED_WINDOWS_SHELLS
 module.exports = new class CompletionSetup {
     supportedShells = SUPPORTED_SHELLS
 
-    async setup(addEntry, options) {
-        const shell = options.shell
+    resolveShell(options) {
+        return options?.shell
             || (process.env.MSYSTEM?.includes('MINGW64') ? 'gitbash' : process.env.SHELL?.match(/(bash|fish|zsh)/)?.[0])
             || (process.env.PSModulePath ? 'ps' : null);
+    }
+
+    async setup(addEntry, options) {
+        const shell = this.resolveShell(options);
 
         switch (shell) {
             case 'bash':
             case 'fish':
             case 'gitbash':
             case 'zsh':
-                return this.setupLinuxLike(addEntry, shell);
+                await this.setupLinuxLike(addEntry, shell);
+                return shell;
             case 'ps':
-                return this.setupPs(addEntry);
+                await this.setupPs(addEntry);
+                return shell;
             case null:
                 try {
                     const shellType = this.determineShellLinux();
                     if (!shellType) {
                         throw `Unsupported shell.\nSupported shells are: ${SUPPORTED_SHELLS.join(', ')}.`;
                     }
-                    return this.setupLinuxLike(addEntry, shellType);
+                    await this.setupLinuxLike(addEntry, shellType);
+                    return shellType;
                 } catch (err) {
                     throw `Error during completion setup: ${err}`;
                 }
@@ -95,7 +102,7 @@ module.exports = new class CompletionSetup {
 
         profileFile = path.join(os.homedir(), profileFile);
 
-        await this.changeProfile(profileFile, shell, addEntry);
+        await this.changeProfile(profileFile, shell, addEntry, this.resolveScriptPath(shell));
 
         const relProfilePath = path.relative(os.homedir(), profileFile);
         console.log(`\nSource your shell using\n${bold(`source ~/${relProfilePath}`)}\nto activate the changes.\n`);
@@ -113,55 +120,45 @@ module.exports = new class CompletionSetup {
             throw err;
         }
 
-        await this.changeProfile(profilePath, 'ps', addEntry);
+        await this.changeProfile(profilePath, 'ps', addEntry, this.resolveScriptPath('ps'));
         console.log(`\nSource your shell using\n${bold('. $PROFILE')}\nto activate the changes.`);
     }
 
-    getScript(shell) {
+    // Returns the absolute path to the pre-generated cache file bundled with this package.
+    resolveScriptPath(shell) {
+        const cacheFiles = { bash: 'cds.sh', gitbash: 'cds.sh', fish: 'cds.fish', ps: 'cds.ps1', zsh: 'cds.zsh' };
+        return path.join(__dirname, '../../../../bin/completion/scripts', cacheFiles[shell]);
+    }
+
+    // Generates the snippet written to the user's shell profile. The script path is hardcoded at
+    // install time to avoid spawning a subprocess on every shell startup.
+    getScript(shell, scriptPath) {
         switch (shell) {
             case 'bash':
             case 'gitbash':
-                return `
-CDS_PROFILE=$(cds completion --shell ${shell} --profile 2> /dev/null) || CDS_PROFILE=""
-if [ -r "$CDS_PROFILE" ]; then
-    . "$CDS_PROFILE"
-fi
-`
+                return `# cds shell completion script (path resolved at install time)
+_p="${scriptPath}" && [ -r "$_p" ] && . "$_p"`
             case 'fish':
-                return `
+                return `# cds shell completion script (path resolved at install time)
 if type "cds" >/dev/null 2>&1
-    set -l CDS_PROFILE (cds completion --shell fish --profile 2> /dev/null)
-    if test -e "$CDS_PROFILE"
-        source "$CDS_PROFILE"
-    end
-end
-`
+    set -l _p "${scriptPath}"
+    test -r "$_p" && source "$_p"
+end`
             case 'ps':
-                return `
-try {
-    $CDS_PROFILE = cds completion --shell ps --profile 2> $null
-    if (Test-Path -Path "$CDS_PROFILE" -PathType Leaf) {
-        . "$CDS_PROFILE"
-    }
-} catch {}
-`
-
+                return `# cds shell completion script (path resolved at install time)
+$_p = "${scriptPath}"; if (Test-Path -Path "$_p" -PathType Leaf) { . "$_p" }`
             case 'zsh':
-                return `
-# compinit can be removed here if loaded elsewhere in the script
+                return `# compinit can be removed here if loaded elsewhere in the script
 autoload -Uz compinit && compinit
 
-CDS_PROFILE=$(cds completion --shell zsh --profile 2> /dev/null) || CDS_PROFILE=""
-if [ -r "$CDS_PROFILE" ]; then
-    . "$CDS_PROFILE"
-fi
-`
+# cds shell completion script (path resolved at install time)
+_p="${scriptPath}" && [ -r "$_p" ] && \\. "$_p"`
             default:
                 throw `Unsupported shell: ${shell}`;
         }
     }
 
-    async changeProfile(profileFile, shell, addEntry) {
+    async changeProfile(profileFile, shell, addEntry, scriptPath) {
         let profile = '';
         let profileFileExists = true;
         try {
@@ -181,7 +178,7 @@ fi
             profile = profile + `
 
 # cds completion start
-${this.getScript(shell)}
+${this.getScript(shell, scriptPath)}
 # cds completion end`;
             changed = true;
         }

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

@@ -18,8 +18,8 @@ module.exports = class ConnectivityTemplate extends require('../../plugin') {
         await merge(__dirname, 'files', 'package.json.hbs').into(configFile, { with: project })
     }
 
-    async combine() {
-        const project = readProject()
+    async combine(facet) {
+        const project = readProject(facet)
         const { srv, addKyma, addMta } = project
 
         if (addMta) {

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

@@ -4,10 +4,10 @@ const { elementsSorter } = require('./as-json')
  * Serializes the given JSON data to CSV format
  * @param {object} data JSON data to serialize
  * @param {object} csn the model
- * @param {{ headerOnly: boolean, separator: boolean }} options
+ * @param {{ headerOnly: boolean, keysOnly: boolean, separator: boolean }} options
  * @returns {Promise<string>} CSV string
  */
-module.exports = async (data={}, csn, { headerOnly=false, separator=',' }={}) => {
+module.exports = async (data={}, csn, { headerOnly=false, keysOnly=false, separator=',' }={}) => {
 
   // We might need multiple passes if data for associations/compositions is created on the fly.
   // So loop as long as there is some non-string data left.
@@ -32,6 +32,15 @@ module.exports = async (data={}, csn, { headerOnly=false, separator=',' }={}) =>
             if (data[t] === undefined) {
               data[t] = value // Add object for a new entity. Next pass will process it.
             }
+            // managed to-one composition: emit the foreign-key column(s) on the parent, like an association
+            if (!element.on && element.keys) {
+              const targetRecord = Array.isArray(value) ? value[0] : value
+              const fk = {}
+              if (targetRecord) for (const k of element.keys) fk[k.ref[k.ref.length - 1]] = targetRecord[k.ref[k.ref.length - 1]]
+              const {headers: fkHeaders, records: fkRecords} = resolveStruct(fk, name)
+              if (i === 0) header.push(...fkHeaders)
+              record.push(...(keysOnly && !element.key ? fkRecords.map(() => '') : fkRecords))
+            }
           }
           else if (element._type === 'cds.Association') {
             if (element.on) {
@@ -42,18 +51,19 @@ module.exports = async (data={}, csn, { headerOnly=false, separator=',' }={}) =>
             if (i === 0) {
               header.push(...fkHeaders)
             }
-            record.push(...fkRecords)
+            // foreign keys of key associations are part of the primary key and must be kept
+            record.push(...(keysOnly && !element.key ? fkRecords.map(() => '') : fkRecords))
           }
           else if (element.is_struct && element.type !== 'cds.Map') {
             const {headers: structHeaders, records: structRecords} = resolveStruct(value, name);
             if (i === 0) {
               header.push(...structHeaders)
             }
-            record.push(...structRecords)
+            record.push(...(keysOnly && !element.key ? structRecords.map(() => '') : structRecords))
           }
           else {
             if (i === 0)  header.push(name)
-            record.push(processValue(value))
+            record.push(keysOnly && !element.key ? '' : processValue(value))
           }
         }
         records.push(record.join(separator))