@sap/cds-dk 7.9.6 → 8.0.3

package/bin/extend.js

@@ -1,19 +1,13 @@
 module.exports = Object.assign(extend, {
     options: ['--directory', '--subdomain', '--passcode', '--username', '--clientid', '--tagRule', '--defaultTag'],
-    flags: ['--wsdl', '--templates', '--force', '--download-migrated-projects'],
+    flags: ['--download-migrated-projects'],
     shortcuts: ['-d', '-s', '-p', '-u', '-c'],
     help: `
 # SYNOPSIS
 
-    *cds extend* <app-url>
+    *cds extend* --download-migrated-projects <app-url>
 
-    **Deprecated - for use with previous MTX Services (@sap/cds-mtx).**
-
-    Create an extension project from an extensible SaaS app.
-    Obtain the app URL from the SaaS application provider.
-
-    To facilitate running this multiple times against the same app, refer to the
-    *cds login* command.
+    Download extension project after migration to @sap/cds-mtxs.
 
 # OPTIONS
 
@@ -40,20 +34,6 @@ module.exports = Object.assign(extend, {
         Client ID for authentication. This will override the default Client ID
         from environment.
 
-    *--force*
-
-        Overwrite existing content. Make sure you are using a version control
-        system (like git) to avoid data loss.
-
-    *--templates*
-
-        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).
@@ -64,42 +44,31 @@ module.exports = Object.assign(extend, {
 
 # 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).
+    *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.
+    https://cap.cloud.sap/docs/guides/multitenancy/mtxs for information on @sap/cds-mtxs.
 
+    https://cap.cloud.sap/docs/guides/multitenancy/old-mtx-migration for information on migrating
+    from the old MTX Services to @sap/cds-mtxs.
 `})
 
 
 async function extend ([url], options = {}) {
-
-    if (options['download-migrated-projects']) {
-        const [username, password] = options.username?.split(':') ?? [];
-        delete options.user;
-
-        await require('../lib/mtx/download_legacy').run({
-            ...options,
-            url,
-            username,
-            password
-        });
-        return
+    if (!options['download-migrated-projects']) {
+        console.log('Please provide the --download-migrated-projects flag to enable this command.');
+        return;
     }
 
-    if (options.force) {
-        if (! await require('../lib/mtx/util/question').askBooleanQuestion('Using option --force will overwrite existing files. Continue (yN)? ', false, false)) {
-            console.log('Extend cancelled')
-            return
-        }
-    }
+    delete options['download-migrated-projects'];
+    const [username, password] = options.username?.split(':') ?? [];
+    delete options.user;
 
-    Object.assign(options, { url })
-    await require('../lib/mtx/extend').run(options);
+    await require('../lib/mtx/download_legacy').run({
+        ...options,
+        url,
+        username,
+        password
+    });
 }
 
-
 /* eslint no-console: off */

package/bin/help.js

@@ -1,6 +1,6 @@
 const cds = require('../lib/cds')
 
-/* eslint-disable no-console */
+ 
 module.exports = exports = Object.assign (help, {formatHelp, handleCompletion, help:`
 # USAGE
 
@@ -30,7 +30,7 @@ module.exports = exports = Object.assign (help, {formatHelp, handleCompletion, h
     * * | *logout*      logout from extensible multitenant SaaS app
     * * | *pull*        pull base model of extensible SaaS app
     * * | *push*        push extension to extensible SaaS app
-    *t* | *lint*        run linter for env or model checks [beta]
+    *t* | *lint*        run linter for env or model checks
     *v* | *version*     get detailed version information
     * * | *completion*  add/remove cli completion for cds commands
     *?* | *help*        get detailed usage information

package/bin/init.js

@@ -1,14 +1,14 @@
-const { URLS } = require('../lib/init/constants');
+const { join } = require('path')
+const { URLS } = require('../lib/init/constants')
 
-const currentOptions = ['--add', '--java:mvn', '--java:package', '--lint:custom', '--lint:custom:example'];
-const legacyOptions = ['--db-technology', '--insecure', '--java-package', '--modules',
-    '--mta', '--odata-version', '--pipeline', '--skip-install', '--skip-sample-models',
-    '--srv-memory', '--srv-technology']
+// REVISIT: necessary because module is loaded too early -> shouldn't be necessary
+const cds = require('../lib/cds')
+cds.root = join(process.cwd(), process.argv[3]?.startsWith('--') ? '.' : process.argv[3] ?? '')
 
 module.exports = Object.assign(init, {
     handleCompletion,
-    options: [...currentOptions, ...legacyOptions],
-    shortcuts: [],
+    options: ['--add', '--java:mvn', '--java:package', '--lint:custom', '--lint:custom:example'],
+    shortcuts: ['-a'],
     flags: ['--force', '--verbose'],
     help: `
 # SYNOPSIS
@@ -25,55 +25,7 @@ module.exports = Object.assign(init, {
         Add one or more features while creating the project.
         <feature> can be one of the following:
 
-        *nodejs*                - creates as a Node.js-based project
-
-        *java*                  - creates as a Java-based project
-
-        *hana*                  - add support for SAP HANA
-
-        *sqlite*                - add support for SQLite
-
-        *postgres*              - add support for PostgreSQL
-
-        *liquibase*             - add support for Liquibase
-
-        *xsuaa*                 - add support for authentication via XSUAA
-
-        *multitenancy*          - add support for multitenancy
-
-        *toggles*               - add support for feature toggles
-
-        *extensibility*         - add support for extensibility
-
-        *approuter*             - add support for application routing
-
-        *local-messaging*       - add support for local messaging
-
-        *enterprise-messaging*  - add support for SAP Event Mesh
-
-        *file-based-messaging*  - add support for file-based messaging
-
-        *redis-messaging*       - add support for Redis messaging
-
-        *mta*                   - add support for MTA-based deployment
-
-        *cf-manifest*           - add support for CF-native deployment
-
-        *helm*                  - add support for Helm-based Kyma deployment
-
-        *html5-repo*            - add support for the HTML5 repository
-
-        *pipeline*              - add files for CI/CD pipeline integration
-
-        *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
+${require('../lib/init').help()}
 
     *--java:mvn* <Comma separated maven archetype specific parameters>
 
@@ -101,7 +53,7 @@ module.exports = Object.assign(init, {
 
 async function handleCompletion(currentWord, previousWord, argv, util) {
     const allOptionsFlags = [
-        ...currentOptions ?? [],
+        ...init.options ?? [],
         ...init.flags ?? []
     ].filter(e => !argv.includes(e));
 
@@ -127,26 +79,7 @@ async function handleCompletion(currentWord, previousWord, argv, util) {
 }
 
 async function init(args) {
-    if (process.argv.some(a => legacyOptions.includes(a))) return _showWarningMessage()
     const CDSGenerator = require('../lib/init')
     const generator = new CDSGenerator()
-    await generator.initCmd(args[0])
-}
-
-
-function _showWarningMessage() {
-
-    const message = `
-  ************************************************
-  You are using 'cds init' with older parameters.
-  To find out more about the current parameters use
-
-    cds help init
-
-  ************************************************
-  `
-
-    const { warn } = require('../lib/util/term');
-
-    console.log(warn(message))
+    await generator.init(args[0])
 }

package/bin/login.js

@@ -1,7 +1,7 @@
 module.exports = Object.assign(login, {
     options: ['--subdomain', '--directory', '--passcode', '--user', '--client', '--mtls'],
     shortcuts: ['-s', '-d', '-p', '-u', '-c', '-m'],
-    flags: ['--plain'],
+    flags: ['--plain', '--save-refresh-token'],
     get help() {
         const config = require('../lib/mtx/settings_manager').SettingsManager.config
         return `
@@ -11,7 +11,7 @@ module.exports = Object.assign(login, {
 
     Simplifies usage of multitenancy-related commands (e.g. *cds subscribe* and
     *cds push*) by providing them with automatic authentication: fetches and
-    saves authentication tokens and provides relevant tokens to those commands.
+    saves Access Tokens and provides relevant tokens to those commands.
     Alternatively saves username for apps running locally.
 
     Saves further settings for the current project (<app-url>,
@@ -33,8 +33,9 @@ module.exports = Object.assign(login, {
 
     *Token Expiration*
 
-    If a refresh token has been provided with the original token and the
-    original token has expired, it will be automatically renewed.
+    If a Refresh Token has been saved with the original token (see option
+    --save-refresh-token) and the original token has expired, it will be
+    automatically renewed.
 
     *Storing Authentication Data*
 
@@ -113,6 +114,11 @@ module.exports = Object.assign(login, {
         Note: Productive secrets should not be specified on a command line,
         since this might expose them to unauthorized users on the same machine!
 
+    *--save-refresh-token*
+
+        Also store the Refresh Token (if provided) for automatic renewal of the
+        Access Token upon expiration.
+
     *--plain*
 
         Instead of saving authentication data for this login to the desktop
@@ -165,9 +171,11 @@ async function login ([url], options = {}) {
         password,
         tokenStorage: options.plain ? 'plain' : 'keyring',
         renewLogin: true,
-        saveData: true
+        saveData: true,
+        saveRefreshToken: options['save-refresh-token'] ?? false
     });
     delete options.plain;
+    delete options['save-refresh-token'];
 
     await require('../lib/mtx/auth_manager').login(options);
 }

package/bin/migrate.js

@@ -54,7 +54,7 @@ module.exports = Object.assign(migrate, {
 `})
 
 async function migrate (param, options = {}) {
-    // eslint-disable-next-line cds-dk/no-missing-dependencies
+     
     await require(_local('@sap/cds-mtxs/bin/cds-mtx-migrate')).run(param[0], options)
 }
 

package/bin/pull.js

@@ -10,6 +10,17 @@ module.exports = Object.assign(pull, {
     Pull the base model for your SaaS app extension.
     If the app URL is omitted, it is determined from the current user's active
     CDS or Cloud Foundry login.
+    
+    Before running this command, prepare your extension project from a template
+    obtained from the SaaS application provider. It must contain a package.json
+    file for the project metadata, including the 'extends' field, which
+    specifies the base-model name.
+    
+    The base model is saved in a sub-folder named '.base' (may be renamed after
+    the first pull). This folder is automatically included in package.json as a
+    workspace. Thus, any subsequent *npm install* will install the base model
+    into node_modules, in a sub-folder named after the base-model name. You can
+    thus refer to the base model in your extension by this name.
 
     Authentication data will not be saved.
 

package/bin/repl.js

@@ -1,3 +1,4 @@
+ 
 module.exports = Object.assign (repl, { options: [], help: `
 # SYNOPSIS
 
@@ -32,8 +33,10 @@ async function repl (_, options={}) {
 
   Object.defineProperty (cds,'repl',{value:repl})
   cds.lazify (Object.assign (repl.context,{ cds,
+     
     Foo: lazy => new cds.entity ({name:'Foo'}),
     Bar: lazy => new cds.entity ({name:'Bar'}),
+    expect: lazy => cds.test.expect,
   }))
 
   repl.history = new Array(222)

package/bin/test.js

@@ -0,0 +1,5 @@
+const {resolve} = require, _local = id => resolve (id, { paths: [ process.cwd(), __dirname ] })
+const require = id => module.require (_local(id)) // overwrite require so that navigation in VS Code works below
+
+// eslint-disable-next-line cds-dk/use-api-require, cds-dk/use-relative-require
+module.exports = require('@sap/cds/bin/test')

package/bin/version.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 const { join, resolve } = require ('path')
 const { execSync, spawnSync } = require('child_process')
 module.exports = Object.assign(list_versions, {
@@ -35,7 +34,7 @@ module.exports = Object.assign(list_versions, {
 const MISSING = '-- missing --'
 
 function list_versions(args, options) {
-  const colorsOff = options['no-colors'] ?? !process.stdout.isTTY
+  const {colors} = require('../lib/util/term')
 
   if (options['npm-list'] || options['npm-tree']) {
     let [pattern] = args, re = pattern ? RegExp(pattern) : /@sap\/cd[rs]|@sap\/eslint-plugin-cds/
@@ -43,7 +42,7 @@ function list_versions(args, options) {
     console.log (cmd,'| grep', re.source)
     return require('child_process').exec(cmd, (e,stdout)=>{
       // if (e) console.error(e)
-      const replacement = (colorsOff ? '$1 $2$3$4' : '\x1b[91m$1 \x1b[32m$2\x1b[0m\x1b[2m$3\x1b[32m$4\x1b[0m');
+      const replacement = (!colors ? '$1 $2$3$4' : '\x1b[91m$1 \x1b[32m$2\x1b[0m\x1b[2m$3\x1b[32m$4\x1b[0m');
       for (let line of stdout.split(/\n/)) if (line.match(re)) console.log(
         line.replace(/(@sap[^@]*)@([\S]+)( -> [\S]+)?(deduped)?/,replacement)
       )
@@ -55,7 +54,7 @@ function list_versions(args, options) {
   if (options.markdown || options.info) {
     _markdown (versions)
   } else {
-    const mark = colorsOff ? s => s : require('../lib/util/term').info
+    const mark = !colors ? s => s : require('../lib/util/term').info
     for (let each of Object.keys(versions))  console.log(`${mark(each)}: ${versions[each]}`)
   }
   process.stdout.isTTY && console.log()
@@ -63,8 +62,9 @@ function list_versions(args, options) {
 
 function info({ root:cwd=process.cwd() }) {
   const env = require('../lib').env.for('cds', cwd)
-  const isJava = env['project-nature'] === 'java'
-  if (isJava && process.stderr.isTTY) {
+  env.cli ??= {}; env.cli.version ??= {}
+  const javaInfo = !env.cli.version.skipjava && env['project-nature'] === 'java'
+  if (javaInfo && process.stderr.isTTY) {
     console.error('\x1b[2m'+'This takes a while. Collecting Java versions...', '\x1b[0m')
   }
 
@@ -82,7 +82,7 @@ function info({ root:cwd=process.cwd() }) {
   // sort Node entries
   versions = Object.keys(versions).sort().reduce((all, key) => { all[key] = versions[key]; return all }, {})
 
-  if (isJava) {
+  if (javaInfo) {
     Object.assign(versions, capJavaVersion(cwd))
   }
   return versions

package/bin/watch.js

@@ -51,18 +51,9 @@ module.exports = Object.assign ( watch, {
 const cds = require('../lib/cds')
 const DEBUG = cds.debug('cli|watch')
 const {delimiter,dirname,relative,resolve,sep} = require ('path')
+const {codes} = require('../lib/util/term'), t = codes
 const fs = require ('fs')
 
-const colors = !!process.stdout.isTTY && !!process.stderr.isTTY
-const t = module.exports.codes = {
-  reset: colors ? '\x1b[0m' : '', // Default
-  bold: colors ? '\x1b[1m' : '', // Bold/Bright
-  link: colors ? '\x1b[4m' : '', // underline
-  red: colors ? '\x1b[91m' : '', // Bright Foreground Red
-  green: colors ? '\x1b[32m' : '', // Foreground Green
-  yellow: colors ? '\x1b[33m' : '', // Foreground Green
-  orange: colors ? '\x1b[38;2;255;140;0m' : '' // darker orange, works with bright and dark background
-}
 const extDefaults = 'cds,csn,csv,ts,mjs,cjs,js,json,properties,edmx,xml,env'
 const ignore = RegExp(
   `(.git|node_modules|_out|@types|@cds-models)\\${sep}` +
@@ -85,6 +76,7 @@ async function watch ([cwd], {
   } catch (err) {
     throw `Error: No such folder or package: '${cwd}'`
   }
+  const _cwd = cwd || process.cwd()
 
   if (!Object.keys(options).includes('with-mocks'))               args.push ('--with-mocks')
   if (!Object.keys(options).find(a => /^in-memory\??$/.test(a)))  args.push ('--in-memory?')
@@ -100,18 +92,20 @@ async function watch ([cwd], {
   })
   if (process.env.CDS_TYPESCRIPT) {
     // Needed by ts-node/tsc to find the tsconfig.json. Same as `--project`.
-    env.TS_NODE_PROJECT = env.TS_NODE_PROJECT ?? cwd ?? process.cwd()
+    env.TS_NODE_PROJECT = env.TS_NODE_PROJECT ?? _cwd
   }
 
-  // allow running w/o or partial local node_modules, also add cds-dk for its sqlite
-  env.NODE_PATH = [...paths(cwd||process.cwd()), ...paths(__dirname)].join(delimiter)
+  // if sap/cds is not installed locally, run with cds-dk's deps. (sap/cds, sqlite etc)
+  if (!installed('@sap/cds', _cwd)) {
+    env.NODE_PATH = [...paths(_cwd), ...paths(__dirname)].join(delimiter)
+  }
 
   if (typeof ext !== 'string')  ext = extDefaults
   const delay = parseInt(process.env.CDS_WATCH_DELAY) || 200
 
   let liveReload //= ...
   let firstTime = true
-  if (!/false|no/.test(options['livereload']) && cds.env.for('cds', cwd||process.cwd()).livereload !== false) {
+  if (!/false|no/.test(options['livereload']) && cds.env.for('cds', _cwd).livereload !== false) {
     liveReload = new (require ('../lib/watch/livereload-server'))
     env.CDS_LIVERELOAD_PATH = require.resolve ('../lib/watch/livereload-connect')
     env.CDS_LIVERELOAD_URL = await liveReload.start (options['livereload'], cwd, delay)
@@ -208,3 +202,8 @@ function paths (dir) {
   const parts = resolve(dir).split(sep), n = parts.length, nm = sep+'node_modules'
   return parts.map ((_,i,a)=> a.slice(0,n-i).join(sep)+nm).filter(p => fs.existsSync(p))
 }
+
+function installed(id, ...paths) {
+  try { return require.resolve (id, { paths }) }
+  catch(e) { if (e.code !== 'MODULE_NOT_FOUND')  throw e }
+}

package/lib/bind/KubernetesApiAccessor.js

@@ -1,5 +1,5 @@
-const yaml = require('@sap/cds-foss')('yaml');
-const { exec } = require('../util/exec');
+const { yaml } = require('../cds').utils
+const { execSync } = require('child_process');
 const { bold } = require('../util/term');
 
 class KubernetesApiAccessor {
@@ -7,7 +7,7 @@ class KubernetesApiAccessor {
     constructor() {
 
         this.config = once( async() => {
-            const configString = await exec({result: 'stdout'}) `kubectl config view --raw`;
+            const configString = execSync('kubectl config view --raw').toString();
             const config = yaml.parse(configString);
 
             const currentContextName = config['current-context'];
@@ -56,12 +56,13 @@ class KubernetesApiAccessor {
 
     async get(options) {
         const {context, namespace, kind, name} = options;
-
-        const result = await exec({stdio: ['ignore', 'pipe', 'ignore'], acceptStatuses: [0, 1]}) `kubectl --output json --context ${context} --namespace ${namespace} get ${kind} ${name}`;
-        if (result.status === 0)
-            return JSON.parse(result.stdout);
-        else
-            return null;
+        try {
+            return JSON.parse(execSync(`kubectl --output json --context ${context} --namespace ${namespace} get ${kind} ${name}`).toString());
+          }
+          catch (error) {
+            if (error.status === 1) return null
+            else throw error
+        }
     }
 }
 

package/lib/build/buildTaskEngine.js

@@ -71,7 +71,7 @@ class BuildTaskEngine {
     }
 
     /**
-     * BuildPlugin#prepare has been deprecated and was never part of the public API.
+     * Plugin#prepare has been deprecated and was never part of the public API.
      * Currently only used by internal FioriBuildPlugin.
      * @deprecated
      * @param {*} plugins
@@ -208,11 +208,15 @@ class BuildTaskEngine {
         const plugin = this.taskFactory.createPlugin(task)
         plugin.init()
 
-        if (!(plugin instanceof InternalBuildPlugin) && plugin.priority !== 1) {
-            // Custom build plugins are executed before internal plugins to ensure
-            // that generated content cannot be overwritten by mistake
-            throw new Error(`Illegal priority for ${plugin.constructor.name} encountered for custom plugin - in this version only priority value '1' is allowed`)
+        if (!(plugin instanceof InternalBuildPlugin) && plugin.priority >= 0 && plugin.priority <= 512) {
+            throw new Error(
+                `Invalid priority value for ${plugin.constructor.name}.
+The valid priority value range for custom plugins is -1024..-1 and 512..1024.
+Range 0..512 is blocked for internal plugins.
+The higher the value the earlier the plugin is run.`
+            )
         }
+
         this._logTaskHandler(plugin)
         return plugin
     }
@@ -262,7 +266,7 @@ class BuildTaskEngine {
 
     _logTaskHandler(plugin) {
         DEBUG?.(`plugin ${plugin.constructor.name}`)
-        DEBUG?.(`details src [${relativePaths(cds.root, plugin.task.src)}], dest [${relativePaths(cds.root, plugin.task.dest)}], use [${plugin.task.use}], options [${JSON.stringify(plugin.task.options)}]`)
+        DEBUG?.(`details src [${relativePaths(cds.root, plugin.task.src)}], dest [${relativePaths(cds.root, plugin.task.dest)}], options [${JSON.stringify(plugin.task.options)}]`)
     }
 
     _logMessages(messages) {
@@ -312,7 +316,7 @@ class BuildTaskEngine {
 
     /**
      * Returns compiler messages and validation messages issued by plugins.
-     * @param {Array<BuildPlugin>} plugins
+     * @param {Array} plugins
      */
     static _getMessages(plugins) {
         return plugins.reduce((acc, plugin) => acc.concat(plugin.messages), [])