@sap/cds-dk 7.0.0 → 7.0.2

package/bin/add.js

@@ -1,3 +1,4 @@
+const term = require('../lib/util/term')
 
 module.exports = Object.assign(add, {
   options: ['--for', '--out', '--data:for'],
@@ -8,72 +9,68 @@ module.exports = Object.assign(add, {
 
     *cds add* <feature | comma-separated list of features>
 
-    Adds one or more features to an existing project in the current working
-    folder - Grow-as-you-go scenario.
+    Adds one or more features to an existing project - grow as you go.
 
-    The following <features> are supported so far:
+    The following features are supported so far:
 
-    *hana*          - adds configuration for SAP HANA databases
+    *hana*                  - add support for SAP HANA
 
-    *sqlite*        - adds configuration for SQLite databases
+    *sqlite*                - add support for SQLite databases
 
-    *xsuaa*         - adds configuration for authentication via XSUAA
+    *xsuaa*                 - add support for authentication via XSUAA
 
-    *multitenancy*  - adds configuration for multitenancy
+    *multitenancy*          - add support for multitenancy
 
-    *toggles*       - adds configuration for feature toggles
+    *toggles*               - add support for feature toggles
 
-    *extensibility* - adds configuration for extensibility
+    *extensibility*         - add support for extensibility
 
-    *mtx*           - adds configuration for multitenancy, feature toggles and
-                      extensibility
+    *approuter*             - add support for application routing
 
-    *approuter*     - adds configuration for the Cloud Foundry approuter
+    *file-based-messaging*  - add support for file-based messaging
 
-    *mta*           - adds an _mta.yaml_ file for MTA-based SAP Business
-                      Technology Platform deployment
+    *enterprise-messaging*  - add support for SAP Event Mesh
 
-    *cf-manifest*   - adds _manifest.yml_ and _services-manifest.yml_ files for
-                      Cloud Foundry native deployment
+    *redis-messaging*       - add support for Redis messaging
 
-                      This approach makes use of the 'Create-Service-Push
-                      Plugin' that has to be installed separately using
-                      _cf install-plugin Create-Service-Push_.
-                      _cf create-service-push_ creates the service(s) and pushes
-                      the application(s) to the SAP Business Technology
-                      Platform.
+    *kibana-logging*        - add support for Kibana formatting
 
-    *pipeline*      - adds files for CI/CD pipeline integration
+    *mta*                   - add support for MTA-based deployment
 
-    *sample*        - adds sample files including Fiori UI
+    *cf-manifest*           - add support for CF-native deployment
 
-    *sample-tiny*   - adds minimal sample files
+    *helm*                  - add support for Helm-based Kyma deployment
 
-    *data*          - adds data content for CSN model entities (as csv files)
+    *html5-repo*            - add support for the HTML5 repository
 
-    *helm*          - adds helm chart folder that contains the files needed to
-                      deploy the application using Kyma.
+    *pipeline*              - add files for CI/CD pipeline integration
 
-    *html5-repo*    - adds configuration for HTML5 Application Deployer to Helm
-                      Chart (Kyma Only).
+    *tiny-sample*           - add minimal sample files
+
+    *sample*                - add sample files including Fiori UI
+
+    *data*                  - add CSV headers for modeled entities
+
+    *typer*                 - add type generation for CDS models
+
+    *lint*                  - add support for CDS Lint
 
 
 # OPTIONS
 
     *--for* <profile>
 
-      Writes configuration data, if any, under the given profile, like
-      \`"[production]": { "db": "hana" }\`
+      Write configuration data for the given profile.
 
     *--data:for* <entity name or prefix>
 
-      Adds data content for entities matching the given pattern.  If it contains
+      Add data content for entities matching the given pattern.  If it contains
       meta characters like '^' or '*', it is treated like a regular expression,
       otherwise as a prefix.
 
     *-o* | *--out* <target folder>
 
-      Specifies output target folder (applicable to data feature only)
+      Specify output target folder (applicable to ${term.bold('data')} feature only).
 
     *--force*
 
@@ -81,11 +78,10 @@ module.exports = Object.assign(add, {
 
 # EXAMPLES
 
-    *cds add* mta,pipeline
-    *cds add* multitenancy
-    *cds add* hana,xsuaa --for production
-    *cds add* cf-manifest
+    *cds add* sample
+    *cds add* multitenancy,hana,xsuaa --for production
     *cds add* data --data:for my.namespace.MyEntity
+    *cds add* mta
     *cds add* helm
 
 

package/bin/build.js

@@ -101,6 +101,10 @@ async function build([project], options = {}) {
     const { CliError } = require('../lib/client/helper/errors')
     const { build } = require('../lib/build')
 
+    const [major] = cds.version.split('.')
+    if (Number(major) < 6) {
+        throw new CliError("This application uses @sap/cds version < 6, which is not compatible with the installed @sap/cds-dk version >= 7. Update @sap/cds to version >= 6.")
+    }
     if (options.clean === "false") {
         throw new CliError("cds build option '--clean' is deprecated - build output folders are always cleaned before build")
     }

package/bin/cds.js

@@ -54,9 +54,13 @@ const cli = { //NOSONAR
         return await task.apply(this, args)
       }
     } catch (e) {
-      process.exitCode = 1
-      if (process.argv[1].endsWith('watched'))  throw e // bin/watched.js handles errors
-      cds._log(e.messages?.length ? e.messages : e.message ?? e, { 'log-level': cds.env.log.levels.cli })
+      const { BuildError } = require('../lib/build')
+      const { CliError } = require('../lib/client/helper/errors')
+      process.exitCode ??= 1
+      if (e.messages?.length) return cds._log(e.messages, { 'log-level': cds.env.log.levels.cli })
+      else if (e instanceof CliError || e instanceof BuildError) return console.error(e.message)
+      if (cds.watched)  throw e  // bin/watched.js handles errors
+      else return console.error(e)
     }
   },
 
@@ -93,15 +97,16 @@ const cli = { //NOSONAR
 
     function add (k,v) { options[k.slice(2)] = v || true }
     function add_global (k,v='') {
-      if (k === '--production') process.env.CDS_ENV = [...process.env.CDS_ENV?.split(',') ?? [], 'production']
-      if (k === '--profile') process.env.CDS_ENV = [...process.env.CDS_ENV?.split(',') ?? [], ...v.split(',')]
+      if (k === '--production') return process.env.CDS_ENV = [...process.env.CDS_ENV?.split(',') ?? [], 'production']
+      if (k === '--profile') return process.env.CDS_ENV = [...process.env.CDS_ENV?.split(',') ?? [], ...v.split(',')]
       if (k === '--odata') v = { flavor:v }
       let e=env || (env={}), path = k.slice(2).split('-')
       while (path.length > 1) { let p = path.shift(); e = e[p]||(e[p]={}) }
       add (k, e[path[0]] = v)
     }
 
-    if (env) require('../lib/cds').env.add (env)
+    // if (env) require('../lib/cds').env.add (env) //> avoid loading env
+    process.env.CDS_CONFIG = JSON.stringify(env)
     return [ args, options ]
   },
 
@@ -116,7 +121,7 @@ async function _resolveBindings(options) {
   const bindingManager = new BindingManager(options)
   const bindingEnv = await bindingManager.bindingEnv()
   Object.assign(process.env, bindingEnv)
-  cds.env = cds.env.for('cds') // reload env
+  cds.env = cds.env.for('cds') // reload env // FIXME: This is too early!
 }
 
 function _local (id, _else) {
@@ -179,7 +184,7 @@ function _dieForUnknownCommand(cmd) {
 `
   console.error(msg)
 
-  process.exitCode = 1
+  process.exit(1)
 }
 
 function _require (id,o) {

package/bin/compile/index.js

@@ -175,7 +175,7 @@ function compile (models, options={}) {
     model = readModelFromStdin()
     src = 'stdin'
   } else { // no args, no stdin
-    throw new Error (`You must specify a model to compile.\nRun 'cds c -?' to learn more.`)
+    throw `You must specify a model to compile.\nRun 'cds c -?' to learn more.`
   }
 
   let chain = model.then (m => model=m)
@@ -189,7 +189,7 @@ function compile (models, options={}) {
   if (typeof options.to === 'string')  for (let each of options.to.split(',')) {
     chain = chain.then (next (processor ('to', _suffix=each)))
   } else if (options.to) {
-    cds.error (`Specify a model processor`)
+    throw `Specify a model processor`
   }
 
   // add processor for i18n
@@ -235,7 +235,7 @@ function compile (models, options={}) {
     let p = cds.compile[kind]
     for (let each of tail.split('.')) {
       p = p[each]
-      if (!p) throw new Error (`Unknown model processor: cds.compile.${kind}.${tail}`)
+      if (!p) throw `Unknown model processor: cds.compile.${kind}.${tail}`
     }
     return p
   }

package/bin/env.js

@@ -95,7 +95,7 @@ const commands = {
   },
 
   get (conf, key, val, options) {
-    let fmt = !process.stdout.isTTY ? x => inspect (x, {depth:22}) : x => inspect (x, {depth:22,colors:true})
+    let fmt = x => inspect (x, {depth:22,colors:true})
 
     let obj = (
       !key ? conf
@@ -104,6 +104,9 @@ const commands = {
       : conf.get(key.replace(/^cds\./,''))
     )
 
+    if (!process.stdout.isTTY) {
+      fmt = x => typeof x !== 'object' ? x : JSON.stringify(x,0,2)
+    }
     if (options.json) {
       fmt = x => JSON.stringify(x,0,2)
     }

package/bin/help.js

@@ -39,9 +39,8 @@ module.exports = exports = Object.assign (help, {formatHelp, help:`
 
 function help (topic) {
   if (Array.isArray(topic))  topic = topic[0]
-  const task = !topic ? help : this.load && this.load (this.Shortcuts[topic] || topic)
-  if (task && task.help) console.log (formatHelp (task.help))
-  else throw new Error(`Didn't find a help topic for '${ topic.name || topic }'.`)
+  const task = !topic ? help : this.load?.(this.Shortcuts[topic] || topic)
+  if (task?.help) console.log (formatHelp (task.help))
 }
 
 function formatHelp (text) {

package/lib/bind/bindingManager.js

@@ -1,7 +1,7 @@
 const bindingResolver = require('./bindingResolver')
 const { logger } = require('./bindingUtil')
 const cds = require('../cds')
-const DEBUG = cds.debug('cli')
+const DEBUG = cds.debug('cli') // REVISIT: This loads cds.env too early!
 
 class BindingManager {
     constructor(options = {}) {

package/lib/bind/bindingResolver.js

@@ -4,7 +4,7 @@ const { platformText, bindingText, logger } = require('./bindingUtil');
 class BindingResolver {
     getUnresolvedBindings({ cwd = process.cwd(), env } = {}) {
         if (!env) {
-            env = cds.env.for('cds', cwd)
+            env = cds.env.for('cds', cwd) // REVISIT: This might load cds.env too early!
         }
         const bindings = {}
         const requires = env.requires || {}

package/lib/bind/bindingUtil.js

@@ -54,7 +54,7 @@ class BindingUtil {
         // Auto configure services based on VCAP_SERVICES
 
         const cds = require('../cds');
-        const env = cds.env.for('cds', process.cwd());
+        const env = cds.env.for('cds', process.cwd()); // REVISIT: This might load cds.env too early!
 
         if (!env._find_credentials_for_required_service) {
             throw new Error(`Please provide a service kind or update @sap/cds version to use the kind detection.`);

package/lib/build/buildTaskEngine.js

@@ -30,7 +30,7 @@ class BuildTaskEngine {
         const messages = []
 
         this.logger.log(`building project [${cds.root}], clean [${this.buildOptions.clean}]`)
-        this.logger.log(`cds [${cds.version}], compiler [${cds.compiler.version()}], home [${cds.home}]\n`)
+        this.logger.log(`cds-dk [${require('../../package.json').version}], cds [${cds.version}], compiler [${cds.compiler.version()}], home [${cds.home}]\n`)
 
         if (!tasks) {
             const buildTaskFactory = new BuildTaskFactory(this.buildOptions)

package/lib/build/provider/buildTaskHandlerFeatureToggles.js

@@ -3,6 +3,7 @@ const path = require('path')
 const cds = require('../../cds')
 const { DEFAULT_CSN_FILE_NAME, OUTPUT_MODE, OUTPUT_MODE_RESULT } = require('../constants')
 const BuildTaskHandlerInternal = require('./buildTaskHandlerInternal')
+const { getI18nDefaultFolder } = require('../util')
 
 class FeatureToggleBuilder extends BuildTaskHandlerInternal {
     init() {
@@ -46,7 +47,7 @@ class FeatureToggleBuilder extends BuildTaskHandlerInternal {
     }
 
     async collectAllLanguageBundles(dictionary, paths, destBase, destFts) {
-        const i18nFolder = cds.env.i18n.folders?.[0] || 'i18n'
+        const i18nFolder = getI18nDefaultFolder()
         // create language bundle for base model
         const i18n = await this.collectLanguageBundles(dictionary.base, path.join(destBase, i18nFolder))
         if (i18n && this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {

package/lib/build/provider/buildTaskHandlerInternal.js

@@ -128,7 +128,7 @@ class BuildTaskHandlerInternal extends BuildTaskHandler {
         // This ensures that the paths are relative to the cwd when executing cds run.
         const jsonOptions = {
             cwd: cds.root,
-            src: this.task.src
+            src: this.hasBuildOption('flatDeployLayout', true) || this.task.src === this.task.dest ? this.task.src : cds.root
         }
         const csnStr = cds.compile.to.json(model, jsonOptions)
         await this.write(csnStr).to(csnFile)

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

@@ -3,6 +3,7 @@ const path = require('path')
 const cds = require('../../../cds')
 const BuildTaskHandlerEdmx = require('../buildTaskHandlerEdmx')
 const { OUTPUT_MODE, OUTPUT_MODE_RESULT, FILE_EXT_CDS, CONTENT_LANGUAGE_BUNDLES, CONTENT_DEFAULT_CSN, DEFAULT_CSN_FILE_NAME } = require('../../constants')
+const { getI18nDefaultFolder } = require('../../util')
 const DEFAULT_COMPILE_DEST_FOLDER = path.normalize('src/main/resources/edmx')
 
 class JavaModuleBuilder extends BuildTaskHandlerEdmx {
@@ -28,8 +29,7 @@ class JavaModuleBuilder extends BuildTaskHandlerEdmx {
 
         if (this.hasBuildOption(CONTENT_LANGUAGE_BUNDLES, true)) {
             // collect and write language bundles into single i18n.json file
-            const i18nFolder = cds.env.i18n.folders?.[0] || 'i18n'
-            const i18n = await this.collectLanguageBundles(model, path.join(this.task.dest, i18nFolder))
+            const i18n = await this.collectLanguageBundles(model, path.join(this.task.dest, getI18nDefaultFolder()))
             if (i18n && this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
                 this._result.languageBundles = i18n.bundles
             }

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

@@ -5,7 +5,7 @@ const { FOLDER_GEN, DEFAULT_CSN_FILE_NAME } = require('../../constants')
 const NodeCfModuleBuilder = require('../nodejs')
 const ResourcesTarProvider = require('../mtx/resourcesTarBuilder')
 const { WARNING, ERROR } = NodeCfModuleBuilder
-const { relativePaths, BuildError, resolveRequiredSapModels } = require('../../util')
+const { relativePaths, BuildError, resolveRequiredSapModels, getI18nDefaultFolder } = require('../../util')
 
 const DEFAULT_MAIN_FOLDER = "_main"
 
@@ -45,12 +45,11 @@ class MtxSidecarModuleBuilder extends NodeCfModuleBuilder {
     async _buildNodeApp(sidecarEnv) {
         const destSidecar = this.task.dest
         const destSidecarSrc = path.join(destSidecar, cds.env.folders.srv)
-        const i18nFolder = cds.env.i18n.folders?.[0] || 'i18n'
         const model = this._compileSidecarSync(sidecarEnv)
         await this.compileToJson(model, path.join(destSidecarSrc, DEFAULT_CSN_FILE_NAME))
 
-        await this.collectLanguageBundles(model, path.join(destSidecarSrc, i18nFolder))
-        await this.copyProjectRootContent(this.task.src, destSidecar)
+        await this.collectLanguageBundles(model, path.join(destSidecarSrc, getI18nDefaultFolder()))
+        await this.copySrvContent(this.task.src, destSidecar, destSidecar)
     }
 
     /**

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

@@ -51,7 +51,7 @@ class NodejsModuleBuilder extends BuildTaskHandlerEdmx {
 
         if (this.isStagingBuild() && this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_FILESYSTEM)) {
             const srcSrv = this.task.src === cds.root ? path.resolve(this.task.src, cds.env.folders.srv) : this.task.src
-            await this._copyNativeContent(cds.root, srcSrv, destRoot)
+            await this._copyNativeContent(cds.root, srcSrv, destRoot, destSrv)
             await this._fixCapireSamplesDeps(destRoot)
         }
         return this._result
@@ -89,9 +89,9 @@ class NodejsModuleBuilder extends BuildTaskHandlerEdmx {
         }
     }
 
-    async _copyNativeContent(srcRoot, srcSrv, destRoot) {
+    async _copyNativeContent(srcRoot, srcSrv, destRoot, destSrv) {
         // project/srv/** -> 'gen/srv/srv/**'
-        const filesFilter = await this._copySrvContent(srcSrv, destRoot)
+        const filesFilter = await this.copySrvContent(srcSrv, destRoot, this.hasBuildOption('flatDeployLayout', true)? destRoot : destSrv)
 
         // project/* -> 'gen/srv/*'
         await this.copyProjectRootContent(srcRoot, destRoot, (entry) => !filesFilter.includes(path.basename(entry)))
@@ -104,16 +104,17 @@ class NodejsModuleBuilder extends BuildTaskHandlerEdmx {
      * are copied to <em>destSrv</em>.
      * @param {*} src
      * @param {*} destRoot - folder name representing the app root folder (e.g. gen/srv)
+     * @param {*} destSrv - folder name representing the app sub-folder (e.g. gen/srv/srv)
      * @returns the list of files that have been copied
      */
-    async _copySrvContent(src, destRoot) {
+    async copySrvContent(src, destRoot, destSrv) {
         const srvRootBlockList = RegExp('package\\.json$|package-lock\\.json$|\\.npmrc$|\\.cdsrc\\.json$')
         const srvBlockList = RegExp('\\.cds$|csn\\.json$|\\.csn$|manifest\\.y.?ml$|\\.env($|\\..*$)|default-env\\.json$')
         const srvRootFileNames = []
 
         // 1. copy all files to 'destSrv' except those contained in the blocklist (including node_modules)
         // project/srv -> 'gen/srv/srv'
-        await super.copyNativeContent(src, destRoot, (entry) => {
+        await super.copyNativeContent(src, destSrv, (entry) => {
             if (fs.statSync(entry).isDirectory()) {
                 // TODO shall not copy language bundles - return !/(\/|\\)(node_modules|_i18n)(\/|\\)?$/.test(entry)
                 return !/(\/|\\)node_modules(\/|\\)?$/.test(entry)

package/lib/build/util.js

@@ -170,6 +170,13 @@ async function copy(src, dest) {
     }
 }
 
+function getI18nDefaultFolder() {
+    // keep '_i18n' as preferred folder for compatibility reasons
+    if (cds.env.i18n.folders.includes('_i18n')) return '_i18n'
+    if (cds.env.i18n.folders.includes('i18n')) return 'i18n'
+    return cds.env.i18n.folders[0] ?? 'i18n'
+}
+
 /**
  * Return gnu-style error string for location `loc`:
  *  - 'File:Line:Col' without `loc.end`
@@ -258,6 +265,7 @@ module.exports = {
     getDefaultModelOptions,
     flatten,
     copy,
+    getI18nDefaultFolder,
     BuildMessage,
     BuildError
 }

package/lib/cds.js

@@ -3,8 +3,8 @@ const cds = _local ('@sap/cds')
 
 module.exports = Object.defineProperties (cds, {
   // for internal use in cds-dk only
-  _log: { value: _local ('../bin/util/log') },
-  _local: { value: _local },
+  _log: { value: _local ('../bin/util/log'), configurable: true },
+  _local: { value: _local, configurable: true },
 })
 
 function _local (id) {

package/lib/import/asyncapi/parserContext.js

@@ -71,8 +71,8 @@ module.exports = class ParserContext {
             const eventAnnotations = this.getEventAnnotations(value);
 
             // add topic annotation
-            if (this.topics[event]) {
-                eventAnnotations['@topic'] = this.topics[event];
+            if (this.topics[key]) {
+                eventAnnotations['@topic'] = this.topics[key];
             }
 
             let properties = {};

package/lib/index.js

@@ -12,3 +12,9 @@ cds.extend (cds.compile.to.constructor) .with (class {
   'edmx-w4'(csn,o) { return cds.compile.to.edmx(csn,{...o,flavor:'w4'}) }
   'edmx-x4'(csn,o) { return cds.compile.to.edmx(csn,{...o,flavor:'x4'}) }
 })
+
+// Compat to cds <=6. Esp. BAS tools need it, see cap/issues#13918
+// TODO remove compat w/ cds-dk 8
+if (cds.compile.to.constructor.name === 'Object') { // not a class as in cds 7
+  cds.compile.to.xsuaa = require('./compile/to-xsuaa')
+}

package/lib/init/constants.js

@@ -15,6 +15,9 @@ const constants = {
         JAVA_MVN: 'java:mvn',
         JAVA_PACKAGE: 'java:package',
         NODEJS: 'nodejs',
+        SAMPLES: 'samples', // deprecated
+        TINY_SAMPLE: 'tiny-sample',
+        SAMPLE: 'sample',
         PIPELINE: 'pipeline',
         MTA: 'mta',
         CONNECTIVITY: 'connectivity',
@@ -33,11 +36,8 @@ const constants = {
         REDIS_MESSAGING: 'redis-messaging',
         APPROUTER: 'approuter',
         DESTINATION: 'destination',
-        SAMPLES: 'samples', // deprecated
-        SAMPLE_TINY: 'sample-tiny',
-        SAMPLE: 'sample',
         DATA: 'data',
-        KIBANA_LOGGING: 'kibana-logging',
+        KIBANA: 'kibana',
         LINT: 'lint',
         LINT_GLOBAL: 'lint:global',
         LINT_DEV: 'lint:dev',