@sap/cds-dk 6.1.5 → 6.2.1

package/CHANGELOG.md

@@ -7,7 +7,39 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
-## Version 6.1.5 - tbd
+## Version 6.2.1 - 2022-10-10
+
+### Fixed
+
+- Installation errors with unresolvable `@sap/hdi` 4.4.0 are fixed.
+
+## Version 6.2.0 - 2022-10-07
+
+### Added
+
+- `cds import` now imports Singleton entities for OData V4 files.
+- `cds deploy` now supports the new default`.sqlite` file ending
+- `cds add mta` no longer creates a `before-all` custom build command for Java single and multi tenant applications. Custom build commands are defined for `db-deployer` and `mtx/sidecar` modules instead.
+- `cds import` now supports enum types for OData V4
+- `cds add enterprise-messaging` can be now be used to set up configuration and deployment descriptors for SAP Event Mesh.
+- `cds add` now throws an error if no facet is passed.
+- `cds watch` now also considers more files from SAP Fiori (`change,variant,ctrl_variant,ctrl_variant_change,ctrl_variant_management_change`)
+
+### Changed
+
+- `cds add data` no longer creates CSV headers in UPPERCASE, but keeps the original case of the declared element.  Both styles work, but the latter is preferred.
+- `cds pull` requires `@sap/cds` 6.2 or higher
+
+### Fixed
+
+- `cds import` now imports csn for OData V2 file even if the `association set` is missing and throws error if the corresponding `association` is missing.
+- `cds import` now adds the annotation `@odata.Precision` entry only if precision > 0 for Edm.DateTime and Edm.DateTimeOffset.
+- `cds compile --to openapi` now has schema Objects for `-create` and `-update` to only advertise "deep" insert/update for _containment_ navigation properties. Non-containment navigation properties are no longer mentioned.
+- `.sqlite` files are now git-ignored in new projects created with `cds init`
+- `cds compile --to openapi` now fixes the issue of failing range assertions for an element having undefined maximum and minimum range values.
+- `cds import` now for OData V2 files doesn't throw warning for `EntityType` being referred as type in complex types, functions and actions, provided it is present in the file.
+
+## Version 6.1.5 - 2022-09-13
 
 ### Fixed
 
@@ -23,6 +55,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ### Fixed
 
+- `cds import` now gives higher precedence to complex type in case of name collision with actions or functions.
 - `cds extend` and other commands no longer fail with `TypeError: Class constructor CliError cannot be invoked without 'new'`
 
 ## Version 6.1.2 - 2022-08-25
@@ -33,7 +66,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ### Fixed
 - `cds add helm` fixed JSON Schema for `srv` property in values.yaml
 - `cds add helm` fixed env property errors for `hana_deployer` and `html5_apps_deployer`
-- `cds add data` now creates proper data file names for entites in a `context`, i.e. `sap.common-Countries.csv` instead of `sap-common-Countries.csv`
+- `cds add data` now creates proper data file names for entities in a `context`, i.e. `sap.common-Countries.csv` instead of `sap-common-Countries.csv`
 - `cds import` now captures the parameter/property of collection type differently and the associated annotations are pulled out of the `items` object of the parameter/property entry in the csn.
 - Remove redundant `console.log()` statement in `cds lint`
 - `cds push` now shows complete error messages from extension validation
@@ -66,6 +99,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - `cds add lint:dev` updated to adjust to new api structure of `@sap/eslint-plugin-cds` v2.5.0
 - `cds init` uses latest Maven Java archetype version 1.27.0 for creating Java projects.
 - `cds login localhost:<port> -u <username>` now saves username (and empty password, if applicable) with project settings for convenience.
+- `cds add` error handling is improved and will give suggestions if you make a typo.
 
 ### Fixed
 

package/bin/cds.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+
 const cli = { //NOSONAR
 
   Shortcuts: {
@@ -25,10 +26,6 @@ const cli = { //NOSONAR
   },
 
   exec (cmd = process.argv[2], ...argv) {
-    if (process[Symbol.for('ts-node.register.instance')]) {
-      process.env.CDS_TYPESCRIPT = process.env.CDS_TYPESCRIPT || 'true'
-    }
-    require('util').inspect.defaultOptions = { colors: !!process.stderr.isTTY, depth:11 }
     if (!argv.length) argv = process.argv.slice(3)
     if (!cmd) cmd = process.stdin.isTTY ? 'help' : 'compile'
     if (cmd in this.Shortcuts) cmd = process.argv[2] = this.Shortcuts[cmd]
@@ -93,9 +90,14 @@ function _dieForUnknownCommand(cmd) {
   const term = require('../lib/util/term');
   const fuzzySearch = _require('./util/fuzzySearch');
 
-  const commands = Array.from(new Set(Object.values(cli.Shortcuts))).sort();
   let bestMatchText = '';
 
+  const excludeList = ['cds.js', 'cds-ts.js', 'fix-redirects.js'];
+  const { readdirSync } = require('fs');
+  const commands = readdirSync(__dirname, { withFileTypes: true })
+    .filter((f) => f.isFile() && !excludeList.includes(f.name))
+    .map((f) => f.name.split('.')[0]).sort();
+
   const bestMatches = fuzzySearch(cmd, commands, DEBUG);
 
   switch (bestMatches.length) {

package/bin/deploy/index.js

@@ -46,7 +46,8 @@ module.exports = Object.assign(deploy, {
 
       Use credentials from the given file when deploying to *SAP HANA*, instead of
       creating new credentials. File must be in *default-env.json* format, with a root
-      node *VCAP_SERVICES*.
+      node *VCAP_SERVICES*. The following hdi related entries are supported:
+      TARGET_CONTAINER, VCAP_SERVICES and SERVICE_REPLACEMENTS.
 
     *--store-credentials* (only in combination with *--to hana*)
 
@@ -114,7 +115,7 @@ async function update_package_json (kind, model, database) {
   const requires = ['cds','requires'] .reduce ((p,n)=>p[n] || (p[n]={}), conf)
   requires.db = cds.env.requires.db = { kind, model }
   if (database)  requires.db.credentials = { database }
-  else if (kind === 'sqlite') requires.db.credentials = { database:'sqlite.db' }
+  else if (kind === 'sqlite') requires.db.credentials = { database:'db.sqlite' }
   await writeFile (package_json, JSON.stringify(conf,null,'  '))
   console.log (`/> ${ exists ? 'updated' : 'created' } ./package.json`)
 }

package/bin/deploy/to-sqlite.js

@@ -6,14 +6,15 @@ exports.deploy = function deploy_to_sqlite (_model, _db, options) {
     const model = _model || conf.model || cds.resolve(!fts ? '*' : ['*',fts], false)
     const file = _database4 (_db, _dbrl, conf)
     const dialect = _dbrl && _dbrl.match(/^(\w+)/) && RegExp.$1
-    if (dialect) options.dialect = dialect === 'sql' ? 'plain' : dialect
+    if (dialect) options.dialect = dialect === 'sql' ? conf.dialect || 'plain' : dialect
     return cds.deploy(model) .to ('sqlite:'+file, options)
     .then (db => db && db.disconnect()) // REVISIT: we should NOT require to disconnect explicitly
 }
 
 function _database4 (_db,_dbrl,conf) {
     if (_db)  return _db
-    if (_dbrl === 'sqlite')  return 'sqlite.db'
+    if (conf.credentials?.database) return conf.credentials.database
+    if (conf.credentials?.url) return conf.credentials.url
+    if (_dbrl === 'sqlite')  return 'db.sqlite'
     if (_dbrl === 'sql')  return ':memory:'
-    if (conf.credentials) return conf.credentials.database || conf.credentials.url
 }

package/bin/help.js

@@ -25,6 +25,10 @@ module.exports = exports = Object.assign (help, {help:`
     *t* | *lint*       [beta] run linter for env or model checks
     *v* | *version*    get detailed version information
     *?* | *help*       get detailed usage information
+    * * | *pull*       pull the base model for your SaaS app extension.
+    * * | *push*       push your extension to the SaaS app in order to enable or update it
+    * * | *subscribe*  subscribe a tenant to a multitenant SaaS app
+    * * | *mock*       call _cds serve_ with mocked service
 
   Learn more about each command using:
   *cds help* <command> or

package/bin/init.js

@@ -100,6 +100,7 @@ function _showWarningMessage () {
   ************************************************
   `
 
-    const { warn } = require('@sap/cds/bin/utils/term')
+    const { warn } = require('../lib/util/term');
+
     console.log(warn(message))
 }

package/bin/login.js

@@ -1,7 +1,7 @@
 const { bold } = require('../lib/util/term');
 
 module.exports = Object.assign(login, {
-    options: ['--subdomain', '--directory', '--passcode', '--user', '--clientid'],
+    options: ['--subdomain', '--directory', '--passcode', '--user', '--client'],
     shortcuts: ['-s', '-d', '-p', '-u', '-c'],
     flags: ['--plain'],
     get help() {
@@ -73,18 +73,28 @@ module.exports = Object.assign(login, {
 
     *-u* | *--user* <name>[:[<password>]]
 
-        Username and optionally password for authentication with Basic Auth in test scenarios.        
+        Username and optionally password for authentication with Basic Auth in test scenarios.
         See https://cap.cloud.sap/docs/guides/multitenancy/#send-subscribe-events for information
         on suitable mock users.
 
-        When typing the colon but omitting <password>, the password is assumed empty. 
+        When typing the colon but omitting <password>, the password is assumed empty.
+        When omitting both, password will be queried interactively.
 
         For security reasons, username will only be saved for app URLs that look like localhost.
         The same is true for an empty password. Non-empty passwords will never be saved.
+        
+        Note: Productive secrets should not be specified on a command line, since this might expose them to
+        unauthorized users on the same machine!
 
-    *-c* | *--clientid* <clientid>
+    *-c* | *--client* <clientid>[:<clientsecret>]
 
-        Client ID for authentication. This will override the default Client ID from environment.
+        Client ID and optionally Client Secret for authentication. If omitted, Client Secret will be
+        queried interactively.
+        
+        Neither Client ID nor Client Secret will be saved, only the resulting token.
+        
+        Note: Productive secrets should not be specified on a command line, since this might expose them to
+        unauthorized users on the same machine!
 
     *--plain*
 
@@ -107,23 +117,27 @@ module.exports = Object.assign(login, {
 
     *cds logout* to remove any authentication data
 `
-    }})
+}});
 
 
 async function login ([url], options = {}) {
     const [username, password] = options.user?.split(':') ?? [];
     delete options.user;
+    const [clientid, clientsecret] = options.client?.split(':') ?? [];
+    delete options.client;
     Object.assign(options, {
         url,
         username,
         password,
+        clientid,
+        clientsecret,
         tokenStorage: options.plain ? 'plain' : 'keyring',
         renewLogin: true,
         saveData: true
-    })
-    delete options.plain
+    });
+    delete options.plain;
 
-    await require('../lib/client/auth_manager').login(options)
+    await require('../lib/client/auth_manager').login(options);
 }
 
 

package/bin/mock.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line
 const serve = require ('@sap/cds/bin/serve')
 module.exports = Object.assign (
     cds_mock, serve, {help: `

package/bin/pull.js

@@ -1,25 +1,17 @@
 module.exports = Object.assign(pull, {
-    options: ['--directory', '--subdomain', '--passcode', '--username', '--clientid'],
+    options: ['--directory', '--subdomain', '--passcode', '--user', '--client', '--from'],
     flags: [],
     shortcuts: ['-d', '-s', '-p', '-u', '-c'],
     help: `
 # SYNOPSIS
 
-    *cds pull* [ <app-url> ]
+    *cds pull* [ [--from] <app url> ]
 
     Pull the base model for your SaaS app extension.
-    
-    To run this command, you need to obtain from the SaaS application provider:
-    - the app URL
-    - a template for your extension project.
-
-    Then create your extension project from the template and run *cds pull* to update your copy of the CDS model of the
-    SaaS app (also known as the base model).
-
-    To facilitate running this multiple times against the same app, refer to the *cds login* command.
-
     If the app URL is omitted, it is determined from the current user's active CDS or Cloud Foundry login.
 
+    Authentication data will not be saved.
+
 
 # OPTIONS
 
@@ -35,24 +27,37 @@ module.exports = Object.assign(pull, {
 
         Tenant-specific passcode for authentication.
 
-    *-u* | *--username* <name>
+    *-u* | *--user* <name>[:[<password>]]
 
-        Username for authentication with Basic Auth in test scenarios.
+        Username and optionally password for authentication with Basic Auth in test scenarios.
 
-    *-c* | *--clientid* <clientid>
+    *-c* | *--client* <clientid>[:<clientsecret>]
 
-        Client ID for authentication. This will override the default Client ID from environment.
+        Client ID and optionally Client Secret for authentication.
 
 # SEE ALSO
 
     *cds push* to push an extension to the SaaS app.
-    
-`})
+    *cds login* for more information on authentication options.
+    *cds login* to save authentication data, simplifying multiple runs of *cds pull* and *cds push* against the same app.
+
+`});
 
 
 async function pull([url], options = {}) {
+    const [username, password] = options.user?.split(':') ?? [];
+    delete options.user;
+    const [clientid, clientsecret] = options.client?.split(':') ?? [];
+    delete options.client;
+    if (options.from) url = options.from
+    delete options.from
+
     await require('../lib/client/pull').run({
         ...options,
-        url
+        url,
+        username,
+        password,
+        clientid,
+        clientsecret
     })
 }

package/bin/push.js

@@ -1,5 +1,5 @@
 module.exports = Object.assign(push, {
-    options: ['--subdomain', '--passcode', '--username', '--clientid', '--to'],
+    options: ['--subdomain', '--passcode', '--user', '--client', '--to'],
     flags: [],
     shortcuts: ['-s', '-p', '-u', '-c'],
     help: `
@@ -8,10 +8,10 @@ module.exports = Object.assign(push, {
     *cds push* [ <extension-project-directory> ]
 
     Push your extension to the SaaS app in order to enable or update it.
-    
+
     By default, the current working directory is used as project directory.
 
-    To facilitate running this multiple times against the same app, refer to the *cds login* command.
+    Authentication data will not be saved.
 
 
 # OPTIONS
@@ -29,24 +29,35 @@ module.exports = Object.assign(push, {
 
         Tenant-specific passcode for authentication.
 
-    *-u* | *--username* <name>
+    *-u* | *--user* <name>[:[<password>]]
 
-        Username for authentication with Basic Auth in test scenarios.
+        Username and optionally password for authentication with Basic Auth in test scenarios.
 
-    *-c* | *--clientid* <clientid>
+    *-c* | *--client* <clientid>[:<clientsecret>]
 
-        Client ID for authentication. This will override the default Client ID from environment.
+        Client ID and optionally Client Secret for authentication.
 
 # 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 authentication data, simplifying multiple runs of *cds pull* and *cds push* against the same app.
 
-`})
+`});
 
 
 async function push([projectFolder], options = {}) {
+    const [username, password] = options.user?.split(':') ?? [];
+    delete options.user;
+    const [clientid, clientsecret] = options.client?.split(':') ?? [];
+    delete options.client;
+
     await require('../lib/client/push').run({
         ...options,
-        projectFolder
+        projectFolder,
+        username,
+        password,
+        clientid,
+        clientsecret
     })
 }

package/bin/subscribe.js

@@ -22,7 +22,7 @@ module.exports = Object.assign(subscribe, {
 
     Username and optionally password for authentication. Required setting.
     See https://cap.cloud.sap/docs/guides/multitenancy/#send-subscribe-events for information on suitable mock users.
-    
+
     If password is omitted, it is assumed empty.
     Note: productive passwords should not be specified on the command line.
 
@@ -31,15 +31,45 @@ module.exports = Object.assign(subscribe, {
 
 
 async function subscribe([tenant], { to: url, user } = {}) {
-  const Logger = require('../lib/client/helper/logging');
-
-  if (!tenant)  throw new Error('Must provide a tenant')
-  if (!url)  throw new Error('Must provide an app URL via `--to`')  // for now, if we don't infer it from the project
-  if (typeof user !== 'string')  throw new Error('Must provide a username')
-  const [username, password = ''] = user.split(':');
-  Logger.log(`Subscribing to ${url} for tenant '${tenant}' with user '${username}'${password === '' ? ' and empty password' : ''}`);
-  const options = { auth: { username, password } };
-  return require('axios').post (url+'/-/cds/deployment/subscribe', { tenant }, options);
+
+  const cds = require('../lib/cds')
+
+  // check for application environment
+  // fails for edge cases (ignored for now):
+  // @sap/cds-mtx application with missing modules (no npm install)
+  // dev scenario with both @sap/cds-mtx and @sap/cds-mtxs installed
+  function _hasMtEnv() {
+    return cds.requires.multitenancy && !cds.mtx
+  }
+
+
+  if (!tenant) {
+    console.error('Must provide a tenant')
+    return this.help('subscribe')
+  }
+  if (!url) {
+    // check whether we are in a mt(xs) environment
+    if (!_hasMtEnv()) throw new Error('Local cds subscribe operation can only be run inside a multitenant application environment using @sap/cds-mtxs. Please specify application url (--to <url>) if you want to subscribe from remote')
+    console.log ('\nSubscribing', {tenant})
+    const { 'cds.xt.DeploymentService':ds } = await cds.serve ([
+      '@sap/cds-mtxs/srv/deployment-service',
+      '@sap/cds-mtxs/srv/model-provider'
+    ])
+    cds.emit('served')
+    // await cds.connect.to('db')
+    await ds.subscribe(tenant)
+  } else {
+    // Connecting to a deployment service in a subscribed application
+    if (typeof user !== 'string')  throw new Error('Must provide a username')
+    const [username, password = ''] = user.split(':');
+    console.log ('\nSubscribing', {tenant}, 'to', {url})
+    await require('axios').post (url+'/-/cds/deployment/subscribe', {
+      tenant
+    }, {
+      auth: { username, password }
+    });
+  }
+  console.log('Subscription succeeded.\n')
 }
 
 // cds subscribe t1 --to http://localhost:4004 -u yves

package/bin/watch.js

@@ -45,16 +45,19 @@ module.exports = Object.assign ( watch, {
 const DEBUG = /\bwatch\b/.test(process.env.DEBUG) && console.debug
 const {delimiter,dirname,relative,resolve,sep} = require ('path')
 const fs = require ('fs')
+
+const colors = !!process.stdout.isTTY && !!process.stderr.isTTY
 const t = module.exports.codes = {
-  reset: '\x1b[0m', // Default
-  bold: '\x1b[1m', // Bold/Bright
-  link: '\x1b[4m', // underline
-  red: '\x1b[91m', // Bright Foreground Red
-  green: '\x1b[32m', // Foreground Green
-  yellow: '\x1b[33m', // Foreground Green
-  orange: '\x1b[38;2;255;140;0m' // darker orange, works with bright and dark background
+  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 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$/
 
 async function watch ([cwd], {
@@ -80,10 +83,12 @@ async function watch ([cwd], {
 
   if (typeof ext !== 'string')  ext = extDefaults
 
+  let includes
   let liveReload //= ...
   let firstTime = true
   if (!/false|no/.test(options['livereload'])) {
     ext += ',css,gif,html,jpg,png,svg'
+    includes = fioriIncludes
     liveReload = new (require ('../lib/watch/livereload-server'))
     env.CDS_LIVERELOAD_PATH = require.resolve ('connect-livereload')
     env.CDS_LIVERELOAD_URL = await liveReload.start (options['livereload'])
@@ -104,6 +109,7 @@ async function watch ([cwd], {
   log ()
   log (`${t.bold}cds ${args.join(' ')}`)
   log (`watching: ${ext}...`)
+  DEBUG && log (`also watching: ${includes.source}`)
   if (liveReload) log (`live reload enabled for browsers`)
 
   const BindingManager = require('../lib/bind/BindingManager')
@@ -113,11 +119,11 @@ async function watch ([cwd], {
 
   const nodemon = require('../lib/watch/node-watch')
   const watcher = nodemon ({
-    watch: ['*','.env','.cdsrc.json'],
-    script:__filename, cwd, env, ext, ignore,
+    script:__filename, cwd, env, ext, includes, ignore,
     delay: parseInt(process.env.CDS_WATCH_DELAY) || 200,
     options
   }).on('restart', (files)=>{
+    log (`\n${t.bold}        ___________________________\n\n`)
     DEBUG && DEBUG (files)
     if (liveReload) liveReload.markPending(files)
     if (this.delayed) clearTimeout (this.delayed)
@@ -129,7 +135,6 @@ async function watch ([cwd], {
           watcher.restart()
         }
       })
-      log (`\n${t.bold}        ___________________________\n\n`)
       FileHandlers.changed (files,cwd)
     }, 111)
   }).on('message', async (msg) => { switch (msg.code) { // messages from child process

package/lib/bind/kubernetesCredentialsProvider.js

@@ -158,6 +158,7 @@ function readBinding(name, secret) {
 
     let parseBinding
     try {
+        // eslint-disable-next-line
         parseBinding = require('@sap/cds/lib/env/serviceBindings').parseBinding;
     } catch (error) {
         //