@sap/cds-dk 8.0.3 → 8.1.0

package/CHANGELOG.md

@@ -7,6 +7,33 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 8.1.0 - 2024-07-26
+
+### Added
+
+- `cds compile --to mermaid` can be configured with a layout direction like `LR`.
+- `cds deploy --to hana` now shows the `hdi-deploy` version when running.
+
+### Changed
+
+- Better generation of http files with `cds add http`, especially for draft requests.
+
+### Fixed
+
+- `cds add` recognizes `hasCfManifest` as inactive unless a `manifest.yml` file exists.
+- `cds add` help and suggestions are only shown when the `help` method is implemented.
+- `cds add sample` does not include the deprecated `synchronizationMode` property in `manifest.json` files any more.
+- `cds compile --to mermaid` no longer produces empty `namespace` blocks that would lead to rendering errors.
+- `cds compile --to mermaid` no longer fails for complex queries like joins.
+- `cds build --for mtx-sidecar` now correctly supports different `srv` folder name.
+- `cds add audit-log` in combination with `cds add multitenancy` correctly adds the audit-log dependency to the MTX sidecar.
+- `cds build` adds the correct hdbtabledata file paths to the hana result set.
+- `cds add` plugins can now correctly interpret `cds.cli` properties.
+- `cds deploy --to hana --dry` now shows correct files with their content.
+- `cds version` now reports the correct version of `@sap/cds` if this one is installed locally along with a local `@sap/cds-dk` installation.
+- Shell completion now works correctly for `cds init --add`.
+- `cds build --for mtx-sidecar` no longer fails if the severity of a compilation error has been downgraded from `Error` to `Warning`.
+
 ## Version 8.0.3 - 2024-07-20
 
 ### Fixed
@@ -142,7 +169,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 - `cds add notebook` is removed.  CAP Jupyter Notebooks have been replaced by custom CAP Notebooks for VS Code which are now part of the CDS Editor.  See https://cap.cloud.sap/docs/tools/#add-cds-editor for more.
 
-
 ## Version 7.9.6 - 2024-07-19
 
 ### Fixed

package/bin/bind.js

@@ -46,7 +46,7 @@ module.exports = Object.assign(cds_bind, {
 
     *-a | --to-app-services* <app>
 
-        Bind to a given application (Cloud Foundry only).
+        Bind services of a given application (Cloud Foundry only).
 
     *--no-create-service-key*
 
@@ -164,11 +164,11 @@ async function cds_bind(args, options) {
         options.targets = options.to.split(/,/g);
 
         if (options.targets.length >= 2 && options.serviceArg) {
-            throw `Service argument cannot be specified together with multiple targets (${term.bold('--to')}) services. Use one service per call or omit the service argument.`;
+            throw `Service argument cannot be specified together with multiple target (${term.bold('--to')}) services. Use one service per call or omit the service argument.`;
         }
 
         if (options.targets.length >= 2 && options.kind) {
-            throw `The option '--kind' cannot be specified together with multiple targets (${term.bold('--to')}) services. Use one service per call or omit the ${term.bold('--kind')} option.`;
+            throw `The option '--kind' cannot be specified together with multiple target (${term.bold('--to')}) services. Use one service per call or omit the ${term.bold('--kind')} option.`;
         }
 
         const services = await bind({ ...options, out });

package/bin/cds.js

@@ -55,8 +55,15 @@ const cli = {
           argv = argv.slice(0, endOfOptions)
         }
 
-        const unknown = new Set
-        const args = this.args(task, argv, unknown)
+        // REVISIT: Have to load plugins to allow for plugin-contributed flags!
+        if (cmd === 'add') {
+          cds.cli = { command: 'add' }
+          await cds.plugins
+          for (const [, Plugin] of cds.add.registered) {
+            task.options.push(...Object.keys((new Plugin).options()).map(key => '--'+key))
+          }
+        }
+        const args = this.args(task, argv)
         args[0].push(...appendArgs)
         cds.cli = {
           command: cmd,
@@ -64,17 +71,6 @@ const cli = {
           options: args[1],
         }
 
-        if (cmd === 'add') { // cds add plugins allow additional custom options
-          await cds.plugins
-          for (const [, Plugin] of cds.add.registered) {
-            const options = Object.keys((new Plugin).options()).map(key => '--'+key)
-            task.options.push(options)
-            options.forEach(o => unknown.delete(o))
-          }
-        }
-        if (unknown.size === 1) throw 'Invalid option: ' + Array.from(unknown)[0]
-        if (unknown.size > 1) throw 'Invalid options: ' + Array.from(unknown).join(', ')
-
         if (args[1]?.['resolve-bindings']) await _resolveBindings({ silent: cmd === 'env' })
 
         // cds.root may for some subcommands not point to the correct directory (e.g. cds w where users can pass a project directory)
@@ -106,7 +102,7 @@ const cli = {
   },
 
   // TODO replace w/ common arg parser from node
-  args (task, argv, unknown) {
+  args (task, argv) {
 
     const { options:o=[], flags:f=[], shortcuts:s=[] } = task
     const _global = /^--(profile|production|sql|odata|add-.*|build-.*|cdsc-.*|odata-.*|folders-.*)$/
@@ -120,7 +116,7 @@ const cli = {
       else if ((k = o.indexOf(a)) >= 0) add(o[k],argv[++i])
       else if ((k = f.indexOf(a)) >= 0) add(f[k])
       else if (_global.test(a)) add_global(a, _flags[a] || argv[++i])
-      else unknown.add(a)
+      else throw 'Invalid option: '+ a
     }
     // consistent production setting for NODE_ENV and CDS_ENV
     // if (process.env.NODE_ENV !== 'production') process.env.NODE_ENV = process.env.CDS_ENV?.split(',').find(p => p === 'production') || process.env.NODE_ENV

package/bin/init.js

@@ -61,18 +61,15 @@ async function handleCompletion(currentWord, previousWord, argv, util) {
         return allOptionsFlags;
     }
 
-    if (previousWord === '--add') {
-        return util.completionFs.readTemplates(argv);
-    }
-
     if (previousWord === '--java:package') {
         const excludes = ['_merging'];
         return (await util.completionFs.readdir(currentWord, { files: false }))
             .filter(e => !excludes.includes(e));
     }
 
-    if (!currentWord && init.options?.includes(previousWord)) {
-        return [];
+    const templates = await util.completionFs.readTemplates(argv);
+    if (previousWord === '--add' || argv.includes('--add') && previousWord.endsWith(',')) {
+        return templates;
     }
 
     return allOptionsFlags;

package/bin/version.js

@@ -61,7 +61,8 @@ function list_versions(args, options) {
 }
 
 function info({ root:cwd=process.cwd() }) {
-  const env = require('../lib').env.for('cds', cwd)
+  const cds = require('../lib')
+  const env = cds.env.for('cds', cwd)
   env.cli ??= {}; env.cli.version ??= {}
   const javaInfo = !env.cli.version.skipjava && env['project-nature'] === 'java'
   if (javaInfo && process.stderr.isTTY) {
@@ -74,10 +75,11 @@ function info({ root:cwd=process.cwd() }) {
     ..._versions_from(_pkg_path('@sap/cds-dk', npmRoot), '@sap/cds-dk (global)'), // ... or installed globally
     ..._versions_from(_pkg_path('@sap/cds-dk', cwd)), // local dk, important for Java projects
     ..._versions_from(_pkg_path('@sap/cds', __dirname)), // @sap/cds from here
-    ..._versions_from(cwd), // ... or from local app dependencies
+    ..._versions_from(_pkg_path('@sap/cds', cds.home)),  // ... or local @sap/cds
+    ..._versions_from(cwd), // ... more from local app dependencies
     ..._versions_from(_pkg_path('@sap/cds-compiler', cwd, __dirname)), // compiler is no direct dependency, so list it explicitly
     'Node.js': process.version,
-    'home': require('../lib/cds').home, // effective (local) cds
+    'home': cds.home, // effective cds home
   }
   // sort Node entries
   versions = Object.keys(versions).sort().reduce((all, key) => { all[key] = versions[key]; return all }, {})

package/lib/build/provider/hana/index.js

@@ -26,7 +26,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
         if (this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
             this._result = {
                 dest: this.task.dest,
-                hana: []
+                hana: new Set()
             }
         }
         this.task.options.compileDest = path.resolve(this.task.dest, this.task.options.compileDest || DEFAULT_COMPILE_DEST_FOLDER)
@@ -228,7 +228,6 @@ class HanaBuildPlugin extends InternalBuildPlugin {
             }
 
             const promises = []
-            const relDest = path.relative(this.task.dest, this.task.options.compileDest)
             const options = { ...this.options(), messages: this.messages, dirs: csvDirs, baseDir: this.task.options.compileDest }
 
             const toHdbtabledata = cds.compile.to.hdbtabledata ?? require(path.join(cds.home, 'bin/build/provider/hana/2tabledata')) // cds@6 compatibility
@@ -240,7 +239,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
                 let tableDataPath = csvFolder.startsWith(this.task.options.compileDest) ? csvFolder : this.task.options.compileDest
                 tableDataPath = path.join(tableDataPath, file)
                 if (this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
-                    this._result.hana.push(path.join(relDest, file))
+                    this._result.hana.add(path.relative(this.task.dest, tableDataPath))
                 }
                 promises.push(this.write(tableData).to(tableDataPath))
             }
@@ -296,7 +295,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
 
             hdiPlugins.add(suffix)
             if (this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
-                this._result.hana.push(path.join(relDest, file))
+                this._result.hana.add(path.join(relDest, file))
             }
             promises.push(this.write(content).to(path.join(this.task.options.compileDest, file)))
             if (suffix === FILE_EXT_HDBTABLE) {
@@ -345,7 +344,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
                     migrationTableFiles.push(path.join(relDbSrcDir, fileName))
                     if (changed) {
                         if (this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
-                            this._result.hana.push(path.join("src", fileName))
+                            this._result.hana.add(path.join("src", fileName))
                         }
                         promises.push(this.write(content).to(path.join(dbSrcDir, fileName)))
                     } else {
@@ -354,7 +353,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
                 }
             } else {
                 if (this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
-                    this._result.hana.push(path.join(relDestDir, fileName))
+                    this._result.hana.add(path.join(relDestDir, fileName))
                 }
                 promises.push(this.write(content).to(path.join(this.task.options.compileDest, fileName)))
                 if (suffix === FILE_EXT_HDBTABLE) {

package/lib/build/provider/mtx-sidecar/index.js

@@ -45,7 +45,7 @@ class MtxSidecarBuildPlugin extends NodejsBuildPlugin {
      */
     async _buildNodeApp(sidecarEnv) {
         const destSidecar = this.task.dest
-        const destSidecarSrc = path.join(destSidecar, cds.env.folders.srv)
+        const destSidecarSrc = path.join(destSidecar, sidecarEnv.folders.srv)
         const model = this._compileSidecarSync(sidecarEnv)
         await this.compileToJson(model, path.join(destSidecarSrc, DEFAULT_CSN_FILE_NAME))
         await this.collectLanguageBundles(model, path.join(destSidecarSrc, getI18nDefaultFolder()))
@@ -129,8 +129,15 @@ class MtxSidecarBuildPlugin extends NodejsBuildPlugin {
                 this.pushMessage(`CDS models [${unresolved.join(', ')}] required by MTX sidecar cannot be resolved. Make sure up-to-date versions of the missing npm modules are installed.`, ERROR)
             }
 
-            // synchronous compilation
-            return cds.load(modelFilePaths, { sync: true, ...this.options() })
+            // using synchronous compilation as cds.root and cds.env have been switched to mtx/sidecar
+            // using different messages array ensures that cds compilation doesn't fail because of 
+            // existing compilation error messages that have been downgraded to warnings
+            // see cap/issues/issues/16401#issuecomment-7205397
+            const messages = []
+            const model = cds.load(modelFilePaths, { sync: true, messages })
+            messages.forEach(msg => this.messages.push(msg))
+            
+            return model
         } finally {
             // restore project scope
             cds.root = root

package/lib/compile/to-mermaid.js

@@ -2,12 +2,13 @@ const cds = require('../cds')
 
 module.exports = function to_mermaid (model, options={}) {
   options = Object.assign({
-    assocnames: false,    // include association names
-    elements  : false,    // include all elements { falsy | 'all'|true | 'keys' }
-    min       : false,    // minify the model, i.e. remove unused definitions, available in CLI
-    namespaces: true,     // group entities by namespace/service
-    queries   : false,    // include relations for queries
-    service   : undefined // filter service by name, available in CLI
+    assocnames: false,     // include association names
+    elements  : false,     // include all elements { falsy | 'all'|true | 'keys' }
+    min       : false,     // minify the model, i.e. remove unused definitions, available in CLI
+    namespaces: true,      // group entities by namespace/service
+    queries   : false,     // include relations for queries
+    service   : undefined, // filter service by name, available in CLI
+    direction : undefined  // direction of the graph
   }, cds.env.mermaid ?? {}, options)
 
   const elemOpts = options.elements === 'none' ? false : options.elements
@@ -27,6 +28,7 @@ module.exports = function to_mermaid (model, options={}) {
   const entityFilter = e => !e.name.startsWith('cds.') && !e.name.endsWith('.texts')
 
   let diag = ''
+  const direction = options.direction ? `  direction ${options.direction}\n` : ''
 
   // if requested, filter by one service
   model.all('service')
@@ -56,8 +58,10 @@ module.exports = function to_mermaid (model, options={}) {
     })
 
     // create namespace groups and classes
-    Object.keys(namespaces).forEach(ns => {
-      if (!diag.length)  diag = `classDiagram\n`
+    Object.keys(namespaces)
+    .filter (ns => namespaces[ns].length) // empty namespaces can cause rendering errors, so skip them
+    .forEach(ns => {
+      if (!diag.length)  diag = `classDiagram\n${direction}`
       diag += `  namespace ${ns.replaceAll('.','_')} {\n`
       namespaces[ns].forEach (e => {
         const simpleName = e.name.slice(e.name.lastIndexOf('.')+1)
@@ -65,7 +69,7 @@ module.exports = function to_mermaid (model, options={}) {
         diag += `["${simpleName}"]` // simple name as label
         if (elemOpts) {
           diag += ` {\n`
-          e.elements.forEach (el => {
+          e.elements?.forEach (el => {
             if ((elemOpts === 'all' || elemOpts === true) || (el.key && elemOpts == 'keys')) {
               diag += `      +${el._type?.replace('cds.','')} ${el.name}`
               diag += `\n`
@@ -85,8 +89,8 @@ module.exports = function to_mermaid (model, options={}) {
     ? Array.from(seenEntities).map(name => model.definitions[name])
     : model.all('entity').filter (entityFilter) // if no grouping and no service filter is on
   entities.forEach(e => {
-    if (!diag.length)  diag = `classDiagram\n`
-    e.elements.forEach (el => {
+    if (!diag.length)  diag = `classDiagram\n${direction}`
+    e.elements?.forEach (el => {
       if (el instanceof cds.Association) {
         if (el.target.endsWith('.texts'))  return
         const type = el.type === 'cds.Composition' ? '*-->' : '-->'
@@ -100,9 +104,20 @@ module.exports = function to_mermaid (model, options={}) {
     })
     // add relations for queries
     if (e.query && options.queries)  {
-      diag += `  \`${e.name}\` ..> \`${e.query.target.name}\`\n`
+      resolveTargets(e.query).forEach(t => {
+        diag += `  \`${e.name}\` ..> \`${t}\`\n`
+      })
     }
   })
 
   return diag.trim()
 }
+
+function resolveTargets (query) {
+  if (query.target)  return [ query.target.name ] // simple query, like projection on
+
+  // SELECT: { from: { args: [{ ref: ['t1'] }, { ref: ['t2'] }], join: ..., on: ... } }
+  const targets = query.SELECT?.from?.args?.filter(arg => arg.ref?.length).map (arg => arg.ref[0])
+
+  return targets
+}

package/lib/deploy/to-hana/hana.js

@@ -6,7 +6,6 @@ const cds = require('../../../lib/cds');
 const { exists, read } = cds.utils;
 
 const { build } = require('../../build');
-const buildConstants = require('../../build/constants');
 
 const hdi = require('./hdiDeployUtil');
 const cfUtil = require('../../util/cf');
@@ -16,6 +15,7 @@ const mtaUtil = require('./mtaUtil');
 const { bold, info, warn } = require('../../util/term');
 
 const { bind, storeBindings } = require('../../bind');
+const { BUILD_TASK_HANA, OUTPUT_MODE, OUTPUT_MODE_FILESYSTEM, OUTPUT_MODE_RESULT } = require('../../build/constants');
 
 const DEBUG = cds.debug('cli');
 
@@ -73,13 +73,13 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
       vcapEnv.TARGET_CONTAINER = process.env.TARGET_CONTAINER;
     }
 
-    for (const { task } of buildResults) {
+    for (const { task, result } of buildResults) {
       if (dry) {
-        const model = await cds.load(task.src);
-        const data = cds.compile.to.hdbtable(model);
-        for (const [src, { file }] of data) {
-          console.log(`-- ${file}`);
-          console.log(src);
+        const sortedResult = Array.from(result.hana).sort();
+        for (const file of sortedResult) {
+          const srcPath = path.join(result.dest, file);
+          console.log(`-- ${path.relative(cds.root, srcPath)}`);
+          console.log(await read(srcPath));
           console.log();
         }
       } else {
@@ -221,7 +221,9 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
 
   async _build() {
     const buildTaskOptions = {
-      for: buildConstants.BUILD_TASK_HANA
+      for: BUILD_TASK_HANA,
+      src: cds.env.folders.db,
+      [OUTPUT_MODE]: OUTPUT_MODE_FILESYSTEM | OUTPUT_MODE_RESULT
     }
 
     console.log(`Running build`);

package/lib/deploy/to-hana/hdiDeployUtil.js

@@ -59,7 +59,15 @@ module.exports = new class HdiDeployUtil {
     Add it either to ${bold('devDependencies')} using 'npm install -D ${HDI_DEPLOY_LIB}' or install it globally using 'npm install -g ${HDI_DEPLOY_LIB}'.`);
         }
 
-        console.log(`Using HDI deployer from ${libPath}`)
+        console.log(`HDI deployer path: ${libPath}`)
+
+        const libRoot = path.dirname(libPath);
+        try {
+            const libPackageJson = require(path.join(libRoot, 'package.json'));
+            console.log(`HDI deployer version: ${libPackageJson.version}`);
+        } catch {
+            // ignore
+        }
 
         // let any error go through and abort deploy
         return require(libPath);

package/lib/init/constants.js

@@ -5,7 +5,7 @@ module.exports = {
     COMMAND_ADD: 'add',
 
     JAVA_LTS_VERSIONS: [17, 21],
-    MAVEN_ARCHETYPE_VERSION: '3.0.0',
+    MAVEN_ARCHETYPE_VERSION: '3.0.1',
 
     OPTIONS: Object.freeze({
         COMPLETION: 'completion',
@@ -57,7 +57,10 @@ module.exports = {
         LINT_DEV: 'lint:dev',
         PIPELINE: 'pipeline',
         TYPER: 'typer',
-        TYPESCRIPT: 'typescript'
+        TYPESCRIPT: 'typescript',
+        EVENT_QUEUE: 'event-queue',
+        COV2AP: 'cov2ap',
+        WEBSOCKET: 'websocket'
     }),
 
     REGEX_JAVA_PACKAGE: /^[a-z_][a-z0-9_]*(\.[a-z_][a-z0-9_]*)*$/g,
@@ -69,7 +72,10 @@ module.exports = {
         SAMPLES: 'https://github.com/SAP-samples/cloud-cap-samples',
         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`
+        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'
     }),
 
     PROJECT_FILES: ['package.json', 'pom.xml', '.cdsrc.json']

package/lib/init/index.js

@@ -22,14 +22,16 @@ module.exports = class CDSGenerator {
     }
 
     static help({ exclude = [] } = {}) {
+        if (!cds.add) return // use case shell completion: cds.add is undefined and not needed
+
         const plugins = this.readPlugins(exclude)
         const nameFixedLength = Math.max(...plugins.map(plugin => plugin.name.length))
         return plugins
+            .filter(({module}) => module.help())
             .map(({name, module}) => {
-                const help = module.help?.() ?? ''
-                return `      *${name}*${' '.repeat(nameFixedLength - name.length)}  - ${help}`
+                return `      *${name}*${' '.repeat(nameFixedLength - name.length)}  - ${module.help()}`
             })
-            .join('\n\n')
+            .join('\n')
     }
 
     /**
@@ -176,7 +178,7 @@ module.exports = class CDSGenerator {
                 const fuzzySearch = require('../../bin/util/fuzzySearch')
                 const [bestMatch] = fuzzySearch(plugin, entries.map(e => e.name))
                 const max = entries.reduce((max, {name}) => Math.max(max, name.length), 0)
-                const allFacetsText = entries.map(({name, module}) => {
+                const allFacetsText = entries.filter(({module})=> module.help()).map(({name, module}) => {
                     const help = module.help?.() ?? ''
                     return `${term.bold(name) + ' '.repeat(max - name.length)}  ${term.dim(help)}`
                 }).join('\n')

package/lib/init/projectReader.js

@@ -4,6 +4,7 @@ const { fs, exists, isdir, path } = cds.utils
 const { parseXml } = require('./xml')
 const { REGEX_JAVA_VERSION, JAVA_LTS_VERSIONS } = require('./constants')
 const DEBUG = cds.debug('cli')
+const TRACE = cds.debug('trace')
 
 module.exports = new class ProjectReader {
 
@@ -88,7 +89,7 @@ module.exports = new class ProjectReader {
      * @property {boolean} hasAttachments Indicates if the project uses SAP BTP Object Store Service.
      * @property {boolean} hasApprouter Indicates if the project uses the SAP Application Router.
      * @property {boolean} hasHtml5Repo Indicates if the project uses the SAP BTP HTML5 Application Repository.
-     * @property {boolean} hasPortal Indicates if the project uses the SAP Cloud Portal serivce.
+     * @property {boolean} hasPortal Indicates if the project uses the SAP Cloud Portal service.
      * @property {boolean} hasDestination Indicates if the project uses the SAP BTP Destination service.
      * @property {boolean} hasMTXRoute Indicates if the approuter should have a multitenant route.
      * @property {boolean} hasMTXRouteJava Indicates if the approuter should have a multitenant subscription route (java).
@@ -106,7 +107,7 @@ module.exports = new class ProjectReader {
         if (!this.appName) this.#setPackageInfo()
         const env = this.env4('production')
         const { appVersion, appName, appId, appDescription, jdkVersion } = this
-        DEBUG?.({ env })
+        TRACE?.({ env })
 
         const _inProd = plugin => require(`./template/${plugin}`).hasInProduction(env)
         const _ui5 = () => exists('package.json') && !!JSON.parse(fs.readFileSync(path.resolve(cds.root, 'package.json'))).sapux
@@ -187,7 +188,6 @@ module.exports = new class ProjectReader {
             })
         })()
 
-        DEBUG?.({ project })
         return project
     }
 }

package/lib/init/template/audit-logging/files/package.sidecar.json

@@ -0,0 +1,7 @@
+{
+  "cds": {
+    "requires": {
+      "audit-log": true
+    }
+  }
+}

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

@@ -36,7 +36,7 @@ module.exports = class AuditLoggingTemplate extends require('../../plugin') {
     const { hasMta, hasHelm, hasMultitenancy, srvPath } = project
     const { plan = 'premium' } = cds.cli.options
     project.servicePlan = plan
-    
+
     if (hasMultitenancy) {
       await merge(__dirname, 'files/package.sidecar.json').into('mtx/sidecar/package.json')
     }

package/lib/init/template/cf-manifest/index.js

@@ -12,6 +12,10 @@ module.exports = class CfManifestTemplate extends require('../../plugin') {
         return 'Cloud Foundry deployment using manifest files'
     }
 
+    static hasInProduction() {
+        return exists(MANIFEST_FILE)
+    }
+
     async canRun() {
         if (cds.cli.options.force) {
             return true

package/lib/init/template/cov2ap/files/dependencies.package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@cap-js-community/odata-v2-adapter": "^1"
+  }
+}

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

@@ -0,0 +1,31 @@
+const { readProject } = require('../../projectReader')
+const { merge, sort } = require('../../merge')
+const { link } = require('../../../util/term')
+const { CAP_JS_COMMUNITY_ODATA_V2 } = require('../../constants').URLS
+
+module.exports = class Cov2apTemplate extends require('../../plugin') {
+
+  static help() {
+    return 'cap-js-community: expose CDS services via the OData V2 protocol'
+  }
+
+  static hasInProduction() {
+    const { dependencies } = readProject()
+    return !!dependencies?.['@cap-js-community/odata-v2-adapter']
+  }
+
+  async canRun() {
+    const { isJava } = readProject()
+    if (isJava) throw `'cds add cov2ap' is not available for Java`
+    return true
+  }
+
+  async run() {
+    await merge(__dirname, 'files/dependencies.package.json').into('package.json')
+    await sort('package.json', 'dependencies')
+  }
+
+  async finalize() {
+    console.log(`Find plugin documentation on ${link(CAP_JS_COMMUNITY_ODATA_V2)}`)
+  }
+}

package/lib/init/template/event-queue/files/dependencies.package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@cap-js-community/event-queue": "^1"
+  }
+}

package/lib/init/template/event-queue/index.js

@@ -0,0 +1,35 @@
+const { readProject } = require('../../projectReader')
+const { merge, sort } = require('../../merge')
+const { link } = require('../../../util/term')
+const { CAP_JS_COMMUNITY_EVENT_QUEUE } = require('../../constants').URLS
+
+module.exports = class EventQueueTemplate extends require('../../plugin') {
+
+  static help() {
+    return 'cap-js-community: transactional event processing with automatic load distribution'
+  }
+
+  async canRun() {
+    const { isJava } = readProject()
+    if (isJava) throw `'cds add event-queue' is not available for Java`
+    return true
+  }
+
+  static hasInProduction() {
+    const { dependencies } = readProject()
+    return !!dependencies?.['@cap-js-community/event-queue']
+  }
+
+  requires() {
+    return ['redis']
+  }
+
+  async run() {
+    await merge(__dirname, 'files/dependencies.package.json').into('package.json')
+    await sort('package.json', 'dependencies')
+  }
+
+  async finalize() {
+    console.log(`Find plugin documentation on ${link(CAP_JS_COMMUNITY_EVENT_QUEUE)}`)
+  }
+}

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

@@ -149,6 +149,7 @@ module.exports = class HttpTemplate extends require('../../plugin') {
       }
       varsDefined = true
       const headers = auth ? `Content-Type: application/json\n{{auth}}` : `Content-Type: application/json`
+      const headerAuth = auth ? '{{auth}}' : ''
 
       service.urlPaths.forEach((urlPath) => {
         if (service.urlPaths.length > 1) {
@@ -156,36 +157,41 @@ module.exports = class HttpTemplate extends require('../../plugin') {
         }
 
         service.entities.forEach((e) => {
-          const entityNameSimple = e.name.slice(e.name.lastIndexOf('.') + 1)
+          const entityNameSimple = e.name.slice(serviceName.length + 1)
+          const nameSlug = slug(entityNameSimple)
           const url = `{{server}}/${urlPath}${entityNameSimple}`
-          const requestTitle = `\n### ${e.name}`
-          requests.push(`${requestTitle}\nGET ${url}\n${headers}\n`)
+          const requestTitle = `\n### ${entityNameSimple}`
+          requests.push(`${requestTitle}\n# @name ${nameSlug}_GET\nGET ${url}\n${headerAuth}\n`)
           if (e.readOnly) return
 
           const entityData = payload[`${e.name}`] ? payload[`${e.name}`][0] : null
           if (!entityData) return
-          const postBody = JSON.stringify(entityData, null, 2)
-
-          let id
-          const compositeKey = Object.keys(e.keys).length > 1
-          if (compositeKey) {
-            id = e.keys.map(k => k.type === 'cds.String' ? `${k.name}='${entityData[k.name]}'` : `${k.name}=${entityData[k.name]}`).join(',')
-            } else {
-            id = entityData[Object.keys(e.keys)[0]]
-          }
 
           if (e.isDraft) {
-            generateDraftRequests(requests, requestTitle, url, headers, postBody, id)
-          } else {
+            const key = Object.keys(e.keys)[0] // draft keys are always single
+            delete entityData[key] // draft keys should always by auto generated (either UUID or through custom logic), so remove them from the payload
+            const postBody = JSON.stringify(entityData, null, 2)
+            generateDraftRequests(requests, requestTitle, url, headers, headerAuth, postBody, key)
+          }
+          else {
+            const postBody = JSON.stringify(entityData, null, 2)
+            let id
+            const compositeKey = Object.keys(e.keys).length > 1
+            if (compositeKey) {
+              id = e.keys.map(k => k.type === 'cds.String' ? `${k.name}='${entityData[k.name]}'` : `${k.name}=${entityData[k.name]}`).join(',')
+            } else {
+              id = entityData[Object.keys(e.keys)[0]]
+            }
             compositeKey ? id = `(${id})` : id = `/${id}`
-            requests.push(`${requestTitle}\nPOST ${url}\n${headers}\n\n${postBody}\n`)
-            requests.push(`${requestTitle}\nPATCH ${url}${id}\n${headers}\n\n${postBody}\n`)
-            requests.push(`${requestTitle}\nDELETE ${url}${id}\n${headers}\n`)
+            requests.push(`${requestTitle}\n# @name ${nameSlug}_POST\nPOST ${url}\n${headers}\n\n${postBody}\n`)
+            requests.push(`${requestTitle}\n# @name ${nameSlug}_PATCH\nPATCH ${url}${id}\n${headers}\n\n${postBody}\n`)
+            requests.push(`${requestTitle}\n# @name ${nameSlug}_DELETE\nDELETE ${url}${id}\n${headers}\n`)
           }
         })
 
         service.actions.forEach((a) => {
-          const url = `{{server}}/${urlPath}${a.name.split(".")[1]}`
+          const simpleNameAction = a.name.slice(serviceName.length + 1)
+          const url = `{{server}}/${urlPath}${simpleNameAction}`
 
           let actionPayload = {}
           if (a.params) {
@@ -197,20 +203,25 @@ module.exports = class HttpTemplate extends require('../../plugin') {
                     : null
             }
           }
-          requests.push(`\n### ${a.name}\nPOST ${url}\n${headers}\n\n${JSON.stringify(actionPayload, null, 2)}\n`)
+          requests.push(`\n### ${simpleNameAction}\n# @name ${simpleNameAction}_POST\nPOST ${url}\n${headers}\n\n${JSON.stringify(actionPayload, null, 2)}\n`)
         })
 
       })
       this.#write(requests, serviceName)
     }
 
-    function generateDraftRequests(requests, requestTitle, url, headers, postBody, id) {
-      requests.push(`${requestTitle} Drafts \nGET ${url}?$filter=(IsActiveEntity eq false)\n${headers}\n`) // unencoded URL for better readability (client can handle this)
-      requests.push(`${requestTitle} Drafts \nPOST ${url}\n${headers}\n\n${postBody}\n`)
-      requests.push(`\n### Please paste the server-generated draft id here e.g. ID=101 or ID=101,secodKey='stringValue' \n@draftID = ${id}\n`)
-      requests.push(`${requestTitle} Patch Draft \nPATCH ${url}({{draftID}},IsActiveEntity=false)\n${headers}\n\n${postBody}\n`)
-      requests.push(`${requestTitle} Prepare Draft \nPOST ${url}({{draftID}},IsActiveEntity=false)/AdminService.draftPrepare\n${headers}\n\n{}\n`)
-      requests.push(`${requestTitle} Activate Draft \nPOST ${url}({{draftID}},IsActiveEntity=false)/AdminService.draftActivate\n${headers}\n\n{}\n`)
+    function generateDraftRequests(requests, title, url, headers, headerAuth, postBody, key) {
+      const nameDraftsCreate = slug(title+'_Draft_POST')
+      requests.push(`${title} Drafts GET\n# @name ${slug(title+'_Drafts_GET')}\nGET ${url}?$filter=(IsActiveEntity eq false)\n${headerAuth}\n`) // unencoded URL for better readability (client can handle this)
+      requests.push(`${title} Draft POST\n# @name ${nameDraftsCreate}\nPOST ${url}\n${headers}\n\n${postBody}\n`)
+      requests.push(`\n### Result from POST request above\n@draftID = {{${nameDraftsCreate}.response.body.$.${key}}}\n`)
+      requests.push(`${title} Draft PATCH\n# @name ${slug(title+'_Draft_Patch')}\nPATCH ${url}(${key}={{draftID}},IsActiveEntity=false)\n${headers}\n\n${postBody}\n`)
+      requests.push(`${title} Draft Prepare\n# @name ${slug(title+'_Draft_Prepare')}\nPOST ${url}(${key}={{draftID}},IsActiveEntity=false)/AdminService.draftPrepare\n${headers}\n\n{}\n`)
+      requests.push(`${title} Draft Activate\n# @name ${slug(title+'_Draft_Activate')}\nPOST ${url}(${key}={{draftID}},IsActiveEntity=false)/AdminService.draftActivate\n${headers}\n\n{}\n`)
+    }
+
+    function slug(str) {
+      return str.trim().replace(/[#\\. ]/g, '')
     }
   }
 
@@ -248,5 +259,3 @@ module.exports = class HttpTemplate extends require('../../plugin') {
     return `${outputDir}/${serviceName}.http`
   }
 }
-
-

package/lib/init/template/sample/files/app/admin-books/webapp/manifest.json

@@ -55,7 +55,6 @@
         "": {
           "dataSource": "AdminService",
           "settings": {
-            "synchronizationMode": "None",
             "operationMode": "Server",
             "autoExpandSelect": true,
             "earlyRequests": true,

package/lib/init/template/sample/files/app/browse/webapp/manifest.json

@@ -71,7 +71,6 @@
       "": {
         "dataSource": "CatalogService",
         "settings": {
-          "synchronizationMode": "None",
           "operationMode": "Server",
           "autoExpandSelect": true,
           "earlyRequests": true,

package/lib/init/template/sample/files/nodejs/admin-service.js

@@ -1,12 +1,17 @@
-const cds = require('@sap/cds/lib')
+const cds = require('@sap/cds')
 
 module.exports = class AdminService extends cds.ApplicationService { init(){
-  this.before ('NEW','Books.drafts', genid)
+
+  const { Books } = this.entities
+
+  /**
+   * Generate IDs for new Books drafts
+   */
+  this.before ('NEW', Books.drafts, async (req) => {
+    if (req.data.ID) return
+    const { ID:id1 } = await SELECT.one.from(Books).columns('max(ID) as ID')
+    const { ID:id2 } = await SELECT.one.from(Books.drafts).columns('max(ID) as ID')
+    req.data.ID = Math.max(id1||0, id2||0) + 1
+  })
   return super.init()
 }}
-
-/** Generate primary keys for target entity in request */
-async function genid (req) {
-  const {ID} = await cds.tx(req).run (SELECT.one.from(req.target.actives).columns('max(ID) as ID'))
-  req.data.ID = ID - ID % 100 + 100 + 1
-}

package/lib/init/template/sample/files/nodejs/cat-service.js

@@ -1,26 +1,38 @@
 const cds = require('@sap/cds')
-const { Books } = cds.entities ('sap.capire.bookshop')
 
-class CatalogService extends cds.ApplicationService { init(){
+class CatalogService extends cds.ApplicationService { init() {
 
-  // Reduce stock of ordered books if available stock suffices
-  this.on ('submitOrder', async req => {
-    const {book,quantity} = req.data
-    let {stock} = await SELECT `stock` .from (Books,book)
-    if (stock >= quantity) {
-      await UPDATE (Books,book) .with (`stock -=`, quantity)
-      await this.emit ('OrderedBook', { book, quantity, buyer:req.user.id })
-      return { stock }
-    }
-    else return req.error (409,`${quantity} exceeds stock for book #${book}`)
-  })
+  const { Books } = cds.entities('sap.capire.bookshop')
+  const { ListOfBooks } = this.entities
 
   // Add some discount for overstocked books
-  this.after ('each','ListOfBooks', book => {
+  this.after('each', ListOfBooks, book => {
     if (book.stock > 111) book.title += ` -- 11% discount!`
   })
 
+  // Reduce stock of ordered books if available stock suffices
+  this.on('submitOrder', async req => {
+    let { book:id, quantity } = req.data
+    let book = await SELECT.from (Books, id, b => b.stock)
+
+    // Validate input data
+    if (!book) return req.error (404, `Book #${id} doesn't exist`)
+    if (quantity < 1) return req.error (400, `quantity has to be 1 or more`)
+    if (quantity > book.stock) return req.error (409, `${quantity} exceeds stock for book #${id}`)
+
+    // Reduce stock in database and return updated stock value
+    await UPDATE (Books, id) .with ({ stock: book.stock -= quantity })
+    return book
+  })
+
+  // Emit event when an order has been submitted
+  this.after('submitOrder', async (_,req) => {
+    let { book, quantity } = req.data
+    await this.emit('OrderedBook', { book, quantity, buyer: req.user.id })
+  })
+
+  // Delegate requests to the underlying generic service
   return super.init()
 }}
 
-module.exports = { CatalogService }
+module.exports = CatalogService

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

@@ -1,8 +1,8 @@
 {
   "devDependencies": {
-    "typescript": "^5",
-    "@cap-js/cds-types": "<1",
-    "@types/node": "^20"
+    "@cap-js/cds-types": "^0.6",
+    "@types/node": "^20",
+    "typescript": "^5"
   },
   "scripts": {
     "watch": "cds-ts w",

package/lib/init/template/websocket/files/dependencies.package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@cap-js-community/websocket": "^1"
+  }
+}

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

@@ -0,0 +1,35 @@
+const { readProject } = require('../../projectReader')
+const { merge, sort } = require('../../merge')
+const { link } = require('../../../util/term')
+const { CAP_JS_COMMUNITY_WEBSOCKET } = require('../../constants').URLS
+
+module.exports = class WebsocketTemplate extends require('../../plugin') {
+
+  static help() {
+    return 'cap-js-community: expose CDS services via the Websocket protocol'
+  }
+
+  async canRun() {
+    const { isJava } = readProject()
+    if (isJava) throw `'cds add websocket' is not available for Java`
+    return true
+  }
+
+  requires() {
+    return ['redis']
+  }
+
+  static hasInProduction() {
+    const { dependencies } = readProject()
+    return !!dependencies?.['@cap-js-community/websocket']
+  }
+
+  async run() {
+    await merge(__dirname, 'files/dependencies.package.json').into('package.json')
+    await sort('package.json', 'dependencies')
+  }
+
+  async finalize() {
+    console.log(`Find plugin documentation on ${link(CAP_JS_COMMUNITY_WEBSOCKET)}`)
+  }
+}

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

@@ -1,7 +1,4 @@
 module.exports = class extends require('../../plugin') {
-    help() {
-      return 'SAP BTP Work Zone'
-    }
 
     requires() {
       return ['workzone-standard']

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@sap/cds-dk",
-  "version": "8.0.3",
+  "version": "8.1.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@sap/cds-dk",
-      "version": "8.0.3",
+      "version": "8.1.0",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "@cap-js/asyncapi": "^1.0.0",
@@ -42,9 +42,12 @@
       }
     },
     "node_modules/@cap-js/db-service": {
-      "version": "1.11.0",
+      "version": "1.12.0",
       "license": "SEE LICENSE",
       "optional": true,
+      "dependencies": {
+        "generic-pool": "^3.9.0"
+      },
       "peerDependencies": {
         "@sap/cds": ">=7.9"
       }
@@ -102,7 +105,7 @@
       }
     },
     "node_modules/@eslint/config-array": {
-      "version": "0.17.0",
+      "version": "0.17.1",
       "license": "Apache-2.0",
       "dependencies": {
         "@eslint/object-schema": "^2.1.4",
@@ -135,7 +138,7 @@
       }
     },
     "node_modules/@eslint/js": {
-      "version": "9.7.0",
+      "version": "9.8.0",
       "license": "MIT",
       "engines": {
         "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
@@ -200,7 +203,7 @@
       }
     },
     "node_modules/@sap/cds": {
-      "version": "8.0.4",
+      "version": "8.1.0",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "@sap/cds-compiler": ">=5",
@@ -226,7 +229,7 @@
       }
     },
     "node_modules/@sap/cds-compiler": {
-      "version": "5.0.6",
+      "version": "5.1.0",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "antlr4": "4.9.3"
@@ -866,14 +869,14 @@
       }
     },
     "node_modules/eslint": {
-      "version": "9.7.0",
+      "version": "9.8.0",
       "license": "MIT",
       "dependencies": {
         "@eslint-community/eslint-utils": "^4.2.0",
         "@eslint-community/regexpp": "^4.11.0",
-        "@eslint/config-array": "^0.17.0",
+        "@eslint/config-array": "^0.17.1",
         "@eslint/eslintrc": "^3.1.0",
-        "@eslint/js": "9.7.0",
+        "@eslint/js": "9.8.0",
         "@humanwhocodes/module-importer": "^1.0.1",
         "@humanwhocodes/retry": "^0.3.0",
         "@nodelib/fs.walk": "^1.2.8",
@@ -2422,7 +2425,7 @@
       }
     },
     "node_modules/yaml": {
-      "version": "2.4.5",
+      "version": "2.5.0",
       "license": "ISC",
       "bin": {
         "yaml": "bin.mjs"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-dk",
-  "version": "8.0.3",
+  "version": "8.1.0",
   "description": "Command line client and development toolkit for the SAP Cloud Application Programming Model",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [