@sap/cds-dk 6.7.1 → 6.8.0

package/CHANGELOG.md

@@ -7,6 +7,37 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 6.8.0 - 2023-05-04
+
+### Added
+
+- `cds add file-based-messaging` adds configuration for file-based messaging (Node.js).
+- `cds add redis-messaging` adds configuration for Redis messaging (Node.js).
+- `cds add enterprise-messaging-shared` adds configuration for Event Mesh support with `kind = 'enterprise-messaging-shared'` (Node.js).
+- `cds import` now supports OData V4 EDMX file containing multiple `Schemas` with single `EntityContainer`.
+- `cds import` now supports importing of AsyncAPI documents.
+- `cds login -m <clientid>[:<key>]` now supports X.509 (mTLS) credential-type in XSUAA binding of @sap/cds-mtxs.
+
+### Changed
+
+- `cds init` uses latest Maven Java archetype version 1.34.0 for creating Java projects.
+
+
+### Fixed
+
+- `cds-ts watch` now honors a `tsconfig.json` in the project
+- launch script for `CAP projects` in VS Code fixed
+
+## Version 6.7.2 - 2023-04-27
+
+### Added
+
+- Added option `--skip-verification` to command `cds migrate`. It skips the extension verification to save memory. Requires `@sap/cds-mtxs@1.7.3`.
+
+### Fixed
+
+- Swagger UI no longer fails with an error `Value of 'namespaceAndName' parameter must be in the following format: <namespace>.<name>`
+
 ## Version 6.7.1 - 2023-04-19
 
 ### Changed

package/bin/deploy/index.js

@@ -120,7 +120,7 @@ async function update_package_json (kind, model, database) {
   else if (kind === 'sqlite') requires.db.credentials = { database:'db.sqlite' }
   if (schema_evolution) requires.db.schema_evolution = schema_evolution
   await writeFile (package_json, JSON.stringify(conf,null,2))
-  console.log (`/> ${ exists ? 'updated' : 'created' } .${path.sep}package_json`)
+  console.log (`/> ${ exists ? 'updated' : 'created' } .${path.sep}package.json`)
 }
 
 /* eslint no-console: off */

package/bin/import.js

@@ -12,7 +12,7 @@ module.exports = Object.assign(_import, {
     Imports the given source and converts it to CSN.
     Currently following file formats are supported.
     - EDMX and XML for OData V2 and V4
-    - JSON for OpenAPI
+    - JSON for OpenAPI and AsyncAPI
 
     Without any options the source is copied to ./srv/external and the csn
     output written next to it. Finally it will add an entry for the imported
@@ -40,7 +40,7 @@ module.exports = Object.assign(_import, {
         Forcefully overwrites the contents in the CDS file and updates the checksum
 
     *--from*
-        Imports the model from the one of the given options "edmx" or "openapi".
+        Imports the model from the one of the given options "edmx", "openapi" or "asyncapi".
 
     *Below options are valid for OData only*
 
@@ -63,6 +63,8 @@ module.exports = Object.assign(_import, {
     cds import ~/Downloads/API_BUSINESS_PARTNER.edmx --include-namespaces "\x2A"
     cds import ~/Downloads/Petstore_OpenAPI.json
     cds import ~/Downloads/Petstore_OpenAPI.json --from openapi
+    cds import ~/Downloads/BookStore_AsyncAPI.json
+    cds import ~/Downloads/BookStore_AsyncAPI.json --from asyncapi
 
 `})
 const messages = require('../lib/import/message').getMessages();
@@ -90,7 +92,7 @@ async function _import(file, options = {}) {
     }
 
     //reads the file version 
-    options.inputFileVersion = apiOptions.inputFileVersion;
+    options.inputFileVersion = apiOptions.odataVersion;
 
     // postprocess
     return await common.postProcess(destFilePath, options, csn, cwd);

package/bin/login.js

@@ -1,6 +1,6 @@
 module.exports = Object.assign(login, {
-    options: ['--subdomain', '--directory', '--passcode', '--user', '--client'],
-    shortcuts: ['-s', '-d', '-p', '-u', '-c'],
+    options: ['--subdomain', '--directory', '--passcode', '--user', '--client', '--mtls'],
+    shortcuts: ['-s', '-d', '-p', '-u', '-c', '-m'],
     flags: ['--plain'],
     get help() {
         const config = require('../lib/client/settings_manager').SettingsManager.config
@@ -84,10 +84,25 @@ module.exports = Object.assign(login, {
 
     *-c* | *--client* <clientid>[:<clientsecret>]
 
-        Client ID and optionally Client Secret for authentication. If omitted, Client Secret will be
-        queried interactively.
+        Client Credentials (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.
+        Obtain the Client Credentials from the UAA binding of MTXS.
+        
+        Client Credentials will not 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!
+
+    *-m* | *--mtls* <clientid>[:<key>]
+
+        Client Credentials (Client ID and optionally Client-Certificate Private Key in Base64 encoding)
+        for authentication. If omitted, Private Key will be queried interactively (avoid newline characters
+        when pasting it).
+        
+        Obtain the Client Credentials from the UAA binding of MTXS.
+        
+        Client Credentials will not 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!
@@ -121,14 +136,19 @@ module.exports = Object.assign(login, {
 async function login ([url], options = {}) {
     const [username, password] = options.user?.split(':') ?? [];
     delete options.user;
-    const [clientid, clientsecret] = options.client?.split(':') ?? [];
-    delete options.client;
+    if (options.client) {
+        const [clientid, clientsecret] = options.client.split(':');
+        delete options.client;
+        Object.assign(options, { clientid, clientsecret });
+    } else if (options.mtls) {
+        const [clientid, key = 'ask'] = options.mtls.split(':');
+        delete options.mtls;
+        Object.assign(options, { clientid, key });
+    }
     Object.assign(options, {
         url,
         username,
         password,
-        clientid,
-        clientsecret,
         tokenStorage: options.plain ? 'plain' : 'keyring',
         renewLogin: true,
         saveData: true

package/bin/migrate.js

@@ -1,11 +1,11 @@
 module.exports = Object.assign(migrate, {
     options: ['--directory', '--tag', '--tagRule'],
     shortcuts: ['-d'],
-    flags: ['--dry', '--force', '--cleanup', '--resolve-bindings'],
+    flags: ['--dry', '--force', '--skip-verification', '--cleanup', '--resolve-bindings'],
     help: `
 # SYNOPSIS
 
-    *cds migrate* <tenant1|"*">[,<tenant2>] [-d <directory>] [--tag <tag>] [--tagRule <tag rule>] [--dry] [--force]
+    *cds migrate* <tenant1|"*">[,<tenant2>] [-d <directory>] [--tag <tag>] [--tagRule <tag rule>] [--dry] [--force] [--skip-verification]
 
     Migrate extensions created with @sap/cds-mtx to extensions for @sap/cds-mtxs
 
@@ -33,6 +33,10 @@ module.exports = Object.assign(migrate, {
 
         Do a dry-run only. Only run a verification of the extension migration.
 
+    *--skip-verification
+
+        Skip verification step. Does not check for potential deployment differences.
+
     *--cleanup* (beta)
 
         Removes all metadata containers created by @sap/cds-mtx.

package/bin/watch.js

@@ -79,6 +79,10 @@ async function watch ([cwd], {
     _args: JSON.stringify(args),
     _options: JSON.stringify(options)
   })
+  if (process.env.CDS_TYPESCRIPT) {
+    const tsNodeRegister = localOrGlobal('ts-node', 'register')
+    env.NODE_OPTIONS = `-r ${tsNodeRegister} ` + (env.NODE_OPTIONS || '')
+  }
 
   // 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)
@@ -190,6 +194,18 @@ function paths (dir) {
   return parts.map ((_,i,a)=> a.slice(0,n-i).join(sep)+nm).filter(p => fs.existsSync(p))
 }
 
+function localOrGlobal (id, pathInMod) {
+  // require package.json to get a stable root path of the moduloe, not its main script
+  const modPath = require.resolve (id+'/package.json', { paths:[ process.cwd(), npmGlobalModules() ] })
+  return resolve(modPath, '..', pathInMod)
+}
+
+function npmGlobalModules() {
+  try {
+    return require ('child_process').execSync('npm root -g').toString().trim()
+  } catch (err) { return }
+}
+
 //
 // Child process impl launched by watch
 //

package/lib/bind/bindingUtil.js

@@ -5,8 +5,8 @@ const KindToRequiresNameMap = {
     xsuaa: 'auth',
     'hana-cloud': 'db',
     hana: 'db',
-    'hana-mt': 'db',
-    'sql-mt': 'db',
+    'hana-mt': 'db', // For compatibility only
+    'sql-mt': 'db', // For compatibility only
     destinations: 'destinations',
     connectivity: 'connectivity',
     'audit-log': 'audit-log',

package/lib/bind/userCdsrcJsonStorageProvider.js

@@ -9,7 +9,7 @@ const fs = require('fs').promises;
 const { highlight } = require('../util/term');
 const { logger } = require('./bindingUtil');
 
-const commandUtil = require('../init/util/commandUtil');
+const commandUtil = require('../util/command');
 
 const CDSRC_FILENAME = '.cdsrc-private.json';
 const GIT_IGNORE_FILE = '.gitignore';

package/lib/client/auth_manager.js

@@ -31,8 +31,10 @@ function getTokenUrl(params) {
     } else if (params.has('passcode')) {
         tokenUrl.search += `&passcode=${encodeURIComponent(params.get('passcode'))}`;
     }
-    if (params.has('clientid')) {
+    if (params.has('clientsecret')) {
         tokenUrl.search += `&clientid=${encodeURIComponent(params.get('clientid'))}&clientsecret=${encodeURIComponent(params.get('clientsecret'))}`;
+    } else if (params.has('key')) {
+        tokenUrl.search += `&clientid=${encodeURIComponent(params.get('clientid'))}&key=${encodeURIComponent(params.get('key'))}`;
     }
     return tokenUrl.toString();
 }

package/lib/client/helper/errors.js

@@ -1,11 +1,16 @@
+const cds = require('../../cds');
 const { getMessage } = require('./logging');
 
+const DEBUG = cds.debug('cli');
+
 class CliError extends Error {
     // noinspection JSAnnotator
     constructor(message, { error, command } = {}) {
         const help = command && getCommandHelp(command);
         const stackLimit = Error.stackTraceLimit;
-        Error.stackTraceLimit = 0
+        if (!DEBUG) {
+            Error.stackTraceLimit = 0
+        }
         super(getMessage(message, { error, help }));
         Error.stackTraceLimit = stackLimit;
     }

package/lib/client/params.js

@@ -125,7 +125,7 @@ class Param {
             : this.obfuscate === ObfuscationLevel.none && (!this.abbreviate || process.env.DEBUG)
                 ? this.val
                 : this.obfuscate === ObfuscationLevel.partial && process.env.DEBUG && typeof this.val === 'string'
-                    ? this.val.substr(0, DISCLOSURE_LENGTH) + '...' + this.val.substr(-DISCLOSURE_LENGTH)
+                    ? this.val.slice(0, DISCLOSURE_LENGTH) + '...' + this.val.slice(-DISCLOSURE_LENGTH)
                     : '...';
     }
 
@@ -158,24 +158,16 @@ class Param {
  */
 class BasicParams {
     constructor() {
-        // NON-PERSISTED PARAMS
-        // - general
+        // GENERAL PARAMS
+        // - non-persisted
         this.projectFolder          = new Param('projectFolder',          '');
         this.directory              = this.projectFolder.newAlias('directory');
 
-        // - auth-related
-        this.passcode               = new Param('passcode',               '', { obfuscate: ObfuscationLevel.partial });
-        this.tokenStorage           = new Param('tokenStorage',           undefined, { allowedValues: ['plain', 'keyring'] });
-        this.plain                  = new Param('plain',                  false, { internal: true }); // for backward compatibility - ignored
-        this.saveData               = new Param('saveData',               false, { internal: true });
-        this.renewLogin             = new Param('renewLogin',             false);
-        this.username               = new Param('username',               '', { persist: Persistence.setting }); // only saved against localhost (non-productive); as setting due to ambiguous app URL
-        this.password               = new Param('password',               '', { obfuscate: ObfuscationLevel.full });
-        this.isEmptyPassword        = new Param('isEmptyPassword',        false, { internal: true, persist: Persistence.setting }); // extra param so we can ensure we never save a password
-        this.clientid               = new Param('clientid',               '');
-        this.clientsecret           = new Param('clientsecret',           '', { obfuscate: ObfuscationLevel.partial });
+        // - non-persisted, internal
+        this.reqAuth                = new Param('reqAuth',                null, { obfuscate: ObfuscationLevel.full, internal: true });
+        this.clearOtherTokenStorage = new Param('clearOtherTokenStorage', false, { internal: true });
 
-        // PERSISTED PARAMS (SETTINGS)
+        // - persisted
         this.appUrl                 = new Param('appUrl',                 '', { persist: Persistence.setting });
         this.url                    = this.appUrl.newAlias('url');
         this.from                   = this.appUrl.newAlias('from');
@@ -186,14 +178,24 @@ class BasicParams {
         this.passcode_url           = this.passcodeUrl.newAlias('passcode_url');
         this.tokenUrl               = new Param('tokenUrl',               '', { persist: Persistence.setting, abbreviate: true })
 
-        // PERSISTED AUTH PARAMS
+        // AUTH PARAMS
+        // - non-persisted
+        this.passcode               = new Param('passcode',               '', { obfuscate: ObfuscationLevel.partial });
+        this.tokenStorage           = new Param('tokenStorage',           undefined, { allowedValues: ['plain', 'keyring'] });
+        this.plain                  = new Param('plain',                  false, { internal: true }); // for backward compatibility - superseded by tokenStorage
+        this.saveData               = new Param('saveData',               false, { internal: true });
+        this.renewLogin             = new Param('renewLogin',             false);
+        this.password               = new Param('password',               '', { obfuscate: ObfuscationLevel.full });
+        this.clientid               = new Param('clientid',               '');
+        this.clientsecret           = new Param('clientsecret',           '', { obfuscate: ObfuscationLevel.partial });
+        this.key                    = new Param('key',                    '', { obfuscate: ObfuscationLevel.partial }); // private key of client certificate
+
+        // - persisted
+        this.username               = new Param('username',               '', { persist: Persistence.setting }); // only saved against localhost (non-productive); as setting due to ambiguous app URL
+        this.isEmptyPassword        = new Param('isEmptyPassword',        false, { internal: true, persist: Persistence.setting }); // extra param so we can ensure we never save a password
         this.token                  = new Param('token',                  '', { persist: Persistence.auth, obfuscate: ObfuscationLevel.partial });
         this.tokenExpirationDate    = new Param('tokenExpirationDate',    Number.MAX_SAFE_INTEGER, { persist: Persistence.auth });
         this.refreshToken           = new Param('refreshToken',           '', { persist: Persistence.auth, obfuscate: ObfuscationLevel.partial });
-
-        // INTERNAL PARAMS (HIDDEN FROM USER, COMPUTED)
-        this.reqAuth                = new Param('reqAuth',                null, { obfuscate: ObfuscationLevel.full, internal: true });
-        this.clearOtherTokenStorage = new Param('clearOtherTokenStorage', false, { internal: true });
     }
 }
 

package/lib/client/settings_manager.js

@@ -328,6 +328,13 @@ class SettingsManager {
                 throw new CliError('Clientsecret cannot be empty');
             }
         }
+        async function addKey() {
+            params.set('key', await Question.askQuestion('key: ', undefined, true));
+            console.log();
+            if (params.get('key') === '') {
+                throw new CliError('Key cannot be empty');
+            }
+        }
         async function addPasscode() {
             const prompt = `Passcode${params.get('passcodeUrl') ? ' (visit ' + params.get('passcodeUrl') + ' to generate)' : ''}: `;
             params.set('passcode', (await Question.askQuestion(prompt, undefined, true)).trim());
@@ -387,8 +394,15 @@ class SettingsManager {
             return;
         }
 
-        if (params.get('clientid') && !params.get('clientsecret') && !logout) {
-            await addClientSecret();
+        if (params.get('clientid') && !logout) {
+            if (params.has('key')) {
+                if (params.get('key') === 'ask') {
+                    params.delete('key');
+                    await addKey();
+                }
+            } else if (!params.has('clientsecret')) {
+                await addClientSecret();
+            }
         }
 
         const auth = {
@@ -398,7 +412,7 @@ class SettingsManager {
 
         setRelevantAuth(auth);
 
-        if (!logout && !params.has('token') && !params.has('passcode') && !params.has('clientsecret')) {
+        if (!logout && !params.has('token') && !params.has('passcode') && !params.has('clientsecret') && !params.has('key')) {
             await addPasscode();
         }
     }

package/lib/compile/openapi/csdl2openapi.js

@@ -38,7 +38,7 @@ const TITLE_SUFFIX = {
 const ODM_ANNOTATIONS = Object.freeze(
     {
         '@ODM.entityName': 'x-sap-odm-entity-name',
-        '@ODM.oid': 'x-sap-odm-oid',
+        '@ODM.oid': 'x-sap-odm-oid'
     });
 
 /**
@@ -59,6 +59,8 @@ module.exports.csdl2openapi = function (
         maxLevels: maxLevels = 5
     } = {}
 ) {
+    // as preProcess below mutates the csdl, copy it before, to avoid side-effects on the caller side
+    csdl = JSON.parse(JSON.stringify(csdl))
     serviceRoot = serviceRoot || (scheme + '://' + host + basePath);
     const queryOptionPrefix = csdl.$Version <= '4.0' ? '$' : '';
     const typesToInline = {}; // filled in schema() and used in inlineTypes()
@@ -1838,6 +1840,7 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
         if (Object.keys(schemaProperties).length > 0)
             schemas[schemaName].properties = schemaProperties;
 
+        if (suffix === SUFFIX.read && type["@ODM.root"]) schemas[schemaName]["x-sap-root-entity"] = type["@ODM.root"]
         odmExtensions(type, schemas[schemaName]);
 
         if (suffix === SUFFIX.create && required.length > 0)

package/lib/import/asyncapi/importAsyncAPI.js

@@ -0,0 +1,32 @@
+
+const ParserContext = require("./parserContext");
+const cdsDkVersion = require("../../../package.json").version;
+
+function importAsyncAPI(input) {
+     const context = new ParserContext(input);
+     return convertToCSN(context);
+}
+
+function convertToCSN(context) {
+     const csn = {
+          meta: {
+               creator: `cds-dk ${cdsDkVersion}`
+          },
+          $version: '2.0',
+          definitions: {}
+     };
+
+     Object.entries(context.services).forEach(([key, value]) => {
+          const events = value.events;
+          const types = value.types;
+          delete value.events;
+          delete value.types;
+
+          csn.definitions[key] = value;
+          Object.assign(csn.definitions, events, types);
+     });
+
+     return csn;
+}
+
+module.exports = { importAsyncAPI }

package/lib/import/asyncapi/index.js

@@ -0,0 +1,15 @@
+const { importAsyncAPI } = require("./importAsyncAPI");
+const { validateAsyncAPI } = require('./utils');
+
+/* The starting function for conversion of AsyncAPI document to csn*/
+function asyncapi2csn(source) {
+    //validate asyncapi document
+    const content = JSON.parse(source);
+    validateAsyncAPI(content);
+
+    return importAsyncAPI(content);
+}
+
+module.exports = {
+    asyncapi2csn
+}