@sap/cds-dk 7.1.1 → 7.3.0

package/bin/activate.js

@@ -1,7 +1,7 @@
 module.exports = Object.assign(activate, {
     options: ['--subdomain', '--passcode', '--username', '--clientid', '--to', '--sync'],
     flags: ['--undeploy', '--wsdl'],
-    shortcuts: ['-s', '-p', '-u', '-c'],
+    shortcuts: ['-s', '-p', '-u', '-c', '-2'],
     help: `
 # SYNOPSIS
 
@@ -55,7 +55,7 @@ module.exports = Object.assign(activate, {
 
     *cds push* to push an extension to a SaaS app based on current MTX Services
     (@sap/cds-mtxs).
-    
+
     https://cap.cloud.sap/docs/guides/multitenancy/mtxs for information on
     @sap/cds-mtxs.
 

package/bin/build.js

@@ -1,6 +1,7 @@
 module.exports = Object.assign(build, {
-    options: ['--project', '--src', '--dest', '--for', '--use', '--opts', '--log-level', '--options-model', '--clean'],
+    options: ['--project', '--src', '--dest', '--for', '--use', '--opts', '--log-level', '--options-model'],
     shortcuts: ['-in', '-s', '-o', '-4'],
+    flags: ['--ws', '--clean'],
     help: `
 # SYNOPSIS
 
@@ -88,11 +89,13 @@ module.exports = Object.assign(build, {
 async function build([project], options = {}) {
     const path = require('path')
     const cds = require('../lib/cds')
+    
+    // plugins are loaded based on cds.root path
+    cds.root = path.resolve(process.cwd(), project || options.project || '.')
 
     // IMPORTANT: call plugins before subsequent access to cds.env
     await cds.plugins
 
-    cds.root = path.resolve(process.cwd(), project || options.project || '.')
     cds.env = cds.env.for('cds', cds.root);
     delete options.project // avoid that relative project paths are resolved twice
 

package/bin/compile/index.js

@@ -2,7 +2,7 @@ const path = require("path");
 
 module.exports = Object.assign ( compile, {
   options: [
-  '--from', '--service', '--lang', '--for', '--to', '--dest', '--log-level', '--flavor', '--dialect', '--sql-dialect', '--openapi:url', '--openapi:servers'
+  '--from', '--service', '--lang', '--for', '--to', '--dest', '--log-level', '--flavor', '--dialect', '--sql-dialect', '--openapi:url', '--openapi:servers', '--odata-version'
   ],
   shortcuts: [
   undefined, '-s', '-l', '-4', '-2', '-o', undefined, '-f'
@@ -114,6 +114,10 @@ module.exports = Object.assign ( compile, {
     The servers definition used in the generated OpenAPI document. *--openapi:url* is
     ignored when this option is specified.
 
+    *--odata-version* 4.0|4.01
+
+    Adds the OData version's functionality of the input CDS/CSN file to the generated OpenAPI document.
+
   *--openapi:diagram*
 
     Include YUML diagram in the generated OpenAPI document, default: *false*.
@@ -122,7 +126,7 @@ module.exports = Object.assign ( compile, {
 
     A single AsyncAPI document is generated using the details of all input services. Information of _title_
     and _version_ should be provided as preset.
-    
+
 # EXAMPLES
 
    *cds* compile model.cds
@@ -132,11 +136,13 @@ module.exports = Object.assign ( compile, {
 
 `})
 
-function compile_all (root='.') {
+async function compile_all (root='.') {
 
   const {exec} = require ('child_process')
   const cds = require('../../lib') // get the enhanced cds w/ additional compile processors
 
+  await cds.plugins // ensure plugins that extend compile targets are loaded
+
   exec(`find ${root} -name *.cds ! -path '*/node_modules/*'`, (_,stdout)=>{
     const all = stdout.split('\n').slice(0,-1)
     const info = `\n/ compiled ${all.length} cds models in`
@@ -152,13 +158,15 @@ function compile_all (root='.') {
 
 }
 
-function compile (models, options={}) {
+async function compile (models, options={}) {
 
   if (options.all)  return compile_all (models[0])
 
   const { inspect } = require('util')
   const cds = require('../../lib') // get the enhanced cds w/ additional compile processors
 
+  await cds.plugins // ensure plugins that extend compile targets are loaded
+
   let model, src, _suffix; //> be filled in below
   if (!options.as && !/,/.test(options.to))  options.as = 'str'
   if (options.beta)  options.betaMode = true
@@ -274,7 +282,7 @@ function compile (models, options={}) {
     return console.log (o)
   }
 
-  function suffix4 (x) { return x && ({
+  function suffix4 (x) { return x && x !== 'hdbtable' && ({
     edmx: '.xml',
     "edmx-v2": '.xml',
     "edmx-v4": '.xml',

package/bin/env.js

@@ -62,9 +62,6 @@ async function env ([cmd, key, value], options={}) {
     commands[cmd] || ((key = cmd), commands.get)
   )
 
-  // Ensure loading plugins before calling cds.env!
-  await cds.plugins
-
   let env = cds.env
   if (options["resolve-bindings"]) {
     const BindingManager = require('../lib/bind/bindingManager')

package/bin/extend.js

@@ -1,6 +1,6 @@
 module.exports = Object.assign(extend, {
-    options: ['--directory', '--subdomain', '--passcode', '--username', '--clientid'],
-    flags: ['--wsdl', '--templates', '--force'],
+    options: ['--directory', '--subdomain', '--passcode', '--username', '--clientid', '--tagRule'],
+    flags: ['--wsdl', '--templates', '--force', '--download-migrated-projects'],
     shortcuts: ['-d', '-s', '-p', '-u', '-c'],
     help: `
 # SYNOPSIS
@@ -50,13 +50,21 @@ module.exports = Object.assign(extend, {
         Download only the templates provided by the SaaS application you want to
         extend.
 
+    *--download-migrated-projects*
+
+        To be used only after change to @sap/cds-mtxs. Allows to download migrated extension projects.
+
+    *--tagRule*
+
+        Rule used to split up migrated extension projects into separate projects (please check migration documentation for more).
+
 # SEE ALSO
 
     *cds activate* to activate an extension project.
 
     *cds pull* to get the CDS model of a SaaS app based on current MTX Services
     (@sap/cds-mtxs).
-    
+
     https://cap.cloud.sap/docs/guides/multitenancy/mtxs for information on
     @sap/cds-mtxs.
 
@@ -64,6 +72,20 @@ module.exports = Object.assign(extend, {
 
 
 async function extend ([url], options = {}) {
+
+    if (options['download-migrated-projects']) {
+        const [username, password] = options.username?.split(':') ?? [];
+        delete options.user;
+
+        await require('../lib/client/download_legacy').run({
+            ...options,
+            url,
+            username,
+            password
+        });
+        return
+    }
+
     if (options.force) {
         if (! await require('../lib/client/helper/question').askBooleanQuestion('Using option --force will overwrite existing files. Continue (yN)? ', false, false)) {
             console.log('Extend cancelled')

package/bin/gen.js

@@ -0,0 +1,27 @@
+const { join } = require('path')
+const DEBUG = /\b(y|all|cli)\b/.test(process.env.DEBUG) ? console.debug : undefined
+
+module.exports = require(global('@sap/cds-gen', 'bin/cds-gen'))
+
+function global (id, subpath) {
+  const pkgPath = join(id, 'package.json') // package.json gives a stable entry path
+  let mod
+  try {
+    mod = require.resolve (pkgPath, { paths: [ process.cwd(), __dirname ] })
+  } catch (err) { // one more try w/ NPM global paths
+      const paths = [ process.cwd(), __dirname, npmGlobalModules() ]
+      try {
+        mod = require.resolve (pkgPath, { paths })
+      } catch (error) {
+        DEBUG?.(error)
+        throw `\nNo '${id}' package found. Install it with\n\n  npm i -g ${id}\n`
+    }
+  }
+  return join(mod, '..', subpath)
+}
+
+function npmGlobalModules() {
+  try {
+    return require ('child_process').execSync('npm root -g').toString().trim()
+  } catch (err) { DEBUG?.(err); return '' }
+}

package/bin/help.js

@@ -10,6 +10,7 @@ module.exports = exports = Object.assign (help, {formatHelp, help:`
 
     *i* | *init*        jump-start cds-based projects
     *a* | *add*         add a feature to an existing project
+    * * | *gen*         generate models/data using a descriptive prompt [beta]
     *y* | *bind*        bind application to remote services
     *m* | *import*      add models from external sources
     *c* | *compile*     compile cds models to different outputs
@@ -27,7 +28,7 @@ module.exports = exports = Object.assign (help, {formatHelp, help:`
     * * | *logout*      logout from extensible multitenant SaaS app
     * * | *pull*        pull base model of extensible SaaS app
     * * | *push*        push extension to extensible SaaS app
-    *t* | *lint*        [beta] run linter for env or model checks
+    *t* | *lint*        run linter for env or model checks [beta]
     *v* | *version*     get detailed version information
     *?* | *help*        get detailed usage information
 

package/bin/import.js

@@ -1,8 +1,8 @@
 module.exports = Object.assign(_import, {
     _name: 'import',
-    options: ['--out', '--as', '--include-namespaces', '--from'],
+    options: ['--out', '--as', '--include-namespaces', '--from', '--config'],
     flags: ['--dry', '--force', '--no-copy', '--no-save', '--keep-namespace'],
-    shortcuts: ['-o', '-as', '-ns', undefined, '-', '-f'],
+    shortcuts: ['-o', '-as', '-ns', undefined, '-c', '-', '-f'],
     help: `
 # SYNOPSIS
 
@@ -43,6 +43,9 @@ module.exports = Object.assign(_import, {
     *--from*
         Imports the model from the one of the given options "edmx", "openapi" or
         "asyncapi".
+    
+    *-c | --config* <JSON Object>
+        Adds the provided JSON Object as custom configuration data to the package.json.
 
     *Below options are valid for OData only*
 
@@ -68,6 +71,7 @@ module.exports = Object.assign(_import, {
     cds import ~/Downloads/Petstore_OpenAPI.json --from openapi
     cds import ~/Downloads/BookStore_AsyncAPI.json
     cds import ~/Downloads/BookStore_AsyncAPI.json --from asyncapi
+    cds import ~/Downloads/API_BUSINESS_PARTNER.edmx -c {\\"[production]\\":{\\"credentials\\":{\\"destination\\":\\"UI3_noauth\\",\\"path\\":\\"/sap/cap/odata\\"}}}
 
 `})
 const messages = require('../lib/import/message').getMessages();
@@ -95,7 +99,7 @@ async function _import(file, options = {}) {
     }
 
     // reads the file version
-    options.inputFileVersion = apiOptions.odataVersion;
+    options.inputFileKind = apiOptions.odataVersion ? apiOptions.odataVersion : apiOptions.inputFileKind;
 
     // postprocess
     return await common.postProcess(destFilePath, options, csn, cwd);

package/bin/push.js

@@ -1,7 +1,7 @@
 module.exports = Object.assign(push, {
-    options: ['--subdomain', '--passcode', '--user', '--client', '--to'],
+    options: ['--subdomain', '--passcode', '--user', '--client', '--to', '--sync'],
     flags: [],
-    shortcuts: ['-s', '-p', '-u', '-c'],
+    shortcuts: ['-s', '-p', '-u', '-c', '-2'],
     help: `
 # SYNOPSIS
 
@@ -13,9 +13,9 @@ module.exports = Object.assign(push, {
     a local file or as a URL to download it from.
     A download URL may contain Basic-Auth credentials as in
     'https://user:pass@host'.
-    
+
     By default, the current working directory is used as project directory.
-    
+
     Unless a custom archive is given, the extension project will be
     automatically built in order to update the generated extension archive. This
     ensures the most recent extension model is pushed.
@@ -48,13 +48,17 @@ module.exports = Object.assign(push, {
 
         Client ID and optionally Client Secret for authentication.
 
+    *--sync*
+
+        Use the synchronous server API to upload extensions.
+
 
 # SEE ALSO
 
     *cds pull* to get the CDS model of the SaaS app.
-    
+
     *cds login* for more information on authentication options.
-    
+
     *cds login* to save project settings and authentication data, simplifying
     multiple runs of this command.
 

package/bin/watch.js

@@ -60,7 +60,7 @@ const t = module.exports.codes = {
 }
 const extDefaults = 'cds,csn,csv,ts,mjs,cjs,js,json,properties,edmx,xml,env'
 const fioriIncludes = /_?(change|variant)$/ // according to fiori: change,variant,ctrl_variant,ctrl_variant_change,ctrl_variant_management_change.
-let ignore = /node_modules|target|\.cds-services\.json$/
+const ignore = RegExp(`(node_modules\\${sep}|app(\\${sep}.+)?\\${sep}((webapp|dist|target)\\${sep}|\\.cds-services\\.json$|tsconfig\\.json$|.*\\.tsbuildinfo$))`)
 
 async function watch ([cwd], {
   args = ['serve', 'all'],
@@ -99,8 +99,6 @@ async function watch ([cwd], {
     env.CDS_LIVERELOAD_PATH = require.resolve ('../lib/watch/livereload-connect')
     env.CDS_LIVERELOAD_URL = await liveReload.start (options['livereload'])
       .catch(err => { console.log(`Error starting live reload: ${err.message}`); liveReload = null })
-  } else {
-    ignore = RegExp(`app${sep}.*\\.(js|ts)|`+ignore.source) // exclude more frontend stuff
   }
 
   const log = (first,...more) => console.log (t.yellow + (first||''), ...more, t.reset)
@@ -115,7 +113,8 @@ async function watch ([cwd], {
   log ()
   log (`${t.bold}cds ${args.join(' ')}`)
   DEBUG && log (process.pid, 'watching:', ext, '...')
-  if (includes) DEBUG && log (`also watching: ${includes.source}`)
+  includes && DEBUG && log (`also watching: ${includes.source}`)
+  DEBUG && log ('ignoring:', ignore.source)
   if (liveReload) log (`live reload enabled for browsers`)
 
   const BindingManager = require('../lib/bind/bindingManager')

package/bin/watched.js

@@ -21,9 +21,8 @@
     case 'NO_SERVICES_FOUND': return _no_services_found(e)
     case 'MODEL_NOT_FOUND': return _no_models_found(e)
     case 'EADDRINUSE': return process.send(e)  //> tell cds watch
-    default: if (!e.messages) { // compiler messages have been written by cli already
-      console.error('\n❗️ ERROR on server start: ❗️\n\n', e)
-    }
+    default: if (e.messages?.length) return cds._log(e.messages, { 'log-level': cds.env.log.levels.cli }) // REVISIT: no special handling for compiler messages
+             else console.error('\n❗️ ERROR on server start: ❗️\n\n', e)
   }}
 
   function _no_models_found(e) { console.log (`

package/lib/bind/bindingUtil.js

@@ -1,6 +1,7 @@
 
 const KindToRequiresNameMap = {
     xsuaa: 'auth',
+    'ias-auth': 'auth',
     'hana-cloud': 'db',
     hana: 'db',
     'hana-mt': 'db', // For compatibility only

package/lib/build/{buildTaskHandler.js → buildPlugin.js}

@@ -2,13 +2,13 @@ const path = require('path')
 const fs = require('fs').promises
 const cds = require('../cds')
 
-const { OUTPUT_MODE, OUTPUT_MODE_FILESYSTEM, SEVERITY_INFO, SEVERITY_WARNING, SEVERITY_ERROR, OVERRIDE_METHOD_MSG } = require('./constants')
-const { hasOptionValue, getProperty, relativePaths, copy, BuildMessage } = require('./util')
+const { OUTPUT_MODE, OUTPUT_MODE_FILESYSTEM, SEVERITY_INFO, SEVERITY_WARNING, SEVERITY_ERROR } = require('./constants')
+const { hasOptionValue, getProperty, relativePaths, BuildMessage } = require('./util')
 
 /**
- * The build task handler creates the build output for a dedicated build task. It is uniquely identified
- * by the build task's <code>use</code> property. It represents the fully qualified node module path
- * of the build task handler implementation.
+ * The build plugin creates the build output for a dedicated build task. It is uniquely identified
+ * by the build task's <code>for</code> or <code>use</code>property. The <code>use</code> property represents 
+ * the fully qualified node module path of the build plugin implementation.
  * <p>
  * The build task engine defines the following protocol. The methods are invoked in descending order:
  * <ul>
@@ -19,14 +19,11 @@ const { hasOptionValue, getProperty, relativePaths, copy, BuildMessage } = requi
  * </ul>
  * The reflected CSN can be accessed using the async method <code>model()</code>.
  */
-class BuildTaskHandler {
+class BuildPlugin {
     /**
-     * @class
+     * @constructor
      */
     constructor() {
-        if (new.target === BuildTaskHandler) {
-            throw new TypeError("Cannot construct BuildTaskHandler instances directly");
-        }
         this._written = new Set()
         this._messages = []
     }
@@ -47,7 +44,7 @@ class BuildTaskHandler {
         return this._context
     }
     /**
-     * Returns the build task executed by this build task handler.
+     * Returns the build task executed by this build plugin.
      * @return {object}
      */
     get task() {
@@ -56,7 +53,8 @@ class BuildTaskHandler {
     }
 
     /**
-     * Returns the message object to add build task specific messages. Severity 'Info', 'Warning', and 'Error' are supported.
+     * Returns a list of build and compiler messages created by this build plugin. 
+     * Supported message severities are 'Info', 'Warning', and 'Error'.
      * @return {Array}
      */
     get messages() {
@@ -64,7 +62,7 @@ class BuildTaskHandler {
     }
 
     /**
-     * Returns the list of files written by this build task handler of current CDS build execution.
+     * Returns the list of files written by this build plugin.
      * @return {Array}
      */
     get files() {
@@ -72,14 +70,14 @@ class BuildTaskHandler {
     }
 
     /**
-     * Returns the priority of this handler as number, where 0 represents the minimum value and
+     * Returns the priority of this plugin as number, where 0 represents the minimum value and
      * Number.MAX_SAFE_INTEGER the maximum value.
-     * Positive numbers mean higher and negative numbers lower priority. Build task handlers
-     * with higher priority value are executed before handlers with lower priority.
+     * Positive numbers mean higher and negative numbers lower priority. Build plugins
+     * with higher priority value are executed before plugins with lower priority.
      * <br>
-     * Note: Currently not supported for custom build task handlers as they are always executed
-     * before the built-in handlers.
-     * @return {number} the priority for this handler as integer.
+     * Note: Currently not supported for custom build plugins as they are always executed
+     * before the built-in plugins.
+     * @return {number} the priority for this plugin as integer.
      */
     get priority() {
         return 1
@@ -91,26 +89,26 @@ class BuildTaskHandler {
     init() { }
 
     /**
-     * Called by the framework to create the artifacts of this build task handler.
+     * @abstract
+     * Called by the framework to create the artifacts of this build plugin.
      */
     async build() {
-        throw new TypeError(OVERRIDE_METHOD_MSG)
     }
 
     /**
-     * Called by the framework immediately before 'build' to delete any output created by this build task handler.
+     * @abstract
+     * Called by the framework immediately before 'build' to delete any output created by this build plugin.
      * <p>
      * Note: The <code>BuildTaskEngine</code> is cleaning the common generation target folder if the build is
      * executed in staging mode, e.g. build.target: "gen".
      */
     async clean() {
-        throw new TypeError(OVERRIDE_METHOD_MSG)
     }
 
     /**
      * Asynchronously write the given content to a given file path.
      * If the file exists the content is replaced. If the file does not exist, a new file will be created.
-     * The file name is stored in the list of files written by this build task handler.
+     * The file name is stored in the list of files written by this build plugin.
      * @param {string} dest - absolute or relative file path. Relative paths will be resolved to this task's destination path.
      * @param {any} data - If data is of type object the JSON-stringified version is written.
      */
@@ -135,7 +133,7 @@ class BuildTaskHandler {
      * Copy a file or directory if the build task option 'outputMode' does not have the value 'resultOnly'.
      * The directory can have contents.
      * <p>
-     * Note: The file name is stored in the list of files written by this build task handler.
+     * Note: The file name is stored in the list of files written by this build plugin.
      * </p>
      * @param {string} src The absolute or relative source path of the file or directory to copy.
      * Relative paths will be resolved to this task's source path.
@@ -155,10 +153,7 @@ class BuildTaskHandler {
                         dest = path.resolve(this.task.dest, dest)
                     }
                     this.pushFile(dest)
-                    if (fs.cp) { // Node.js >= 16.7
-                        return fs.cp(src, dest, { recursive: true })
-                    }
-                    return copy(src, dest)
+                    return fs.cp(src, dest, { recursive: true })
                 }
                 return dest
             }
@@ -234,4 +229,4 @@ class BuildTaskHandler {
         return value
     }
 }
-module.exports = BuildTaskHandler
+module.exports = BuildPlugin