@sap/cds-dk 4.4.2 → 4.5.4

package/CHANGELOG.md

@@ -6,6 +6,66 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 4.5.4 - 2021-10-07
+
+### Fixed
+
+- `cds watch` no longer fails if started with `--ext`, `--livereload`, or `--open` arguments
+
+## Version 4.5.3 - 2021-10-05
+
+### Fixed
+
+- `cds import` fix for `--dry` shortcut `-`
+- `cds import` fix for missing type properties in csn for unbounded action and function in OData V4.
+- A  bug with `cds init` when called in BAS project wizard
+
+## Version 4.5.2 - 2021-09-30
+
+### Changed
+
+- `cds init` uses latest `Maven Java archetype` version `1.19.0` for creating Java projects.
+
+### Fixed
+
+- `cds deploy --to sqlite` now writes `credentials.database` again to `package.json`
+
+## Version 4.5.1 - 2021-09-29
+
+### Added
+
+- `cds import` introduced option `--as` which converts EDMX file to different file formats such as cds, csn and json.
+- `cds import` introduced flag `--f` which forcefully overwrite the content of existing cds file when specified with `--as` option.
+
+### Changed
+
+- Marked `cds lint` as beta again to further investigate issues from 'extends' via prettier plugin.
+
+## Version 4.5.0 - 2021-09-23
+
+### Added
+
+- `cds import` supports import of functions, action, functionimport and actionimport from both OData V2 and V4 EDMX files.
+
+### Changed
+
+- `cds init` uses latest `Maven Java archetype` version `1.18.1` for creating Java projects.
+
+### Fixed
+
+- `cds watch` additional CLI args were not passed to launched process, for example, `--odata x4`.
+- `cds import` fix for TypeError issue during OData V4 EDMX conversion to CSN.
+- `cds import` fix for multi-line documentation text in OData V2 EDMX file.
+- `cds import` fix for V4 CSN generation when non standard OData vocabularies are referred.
+- `cds add data`
+    + no longer fails for entities without keys
+    + no longer creates csv files for synthetic draft entities
+    + no longer creates entries for virtual fields
+    + no longer skips over entities marked with `@cds.persistence.skip`, which is true for 'external' entities created by `cds import`.
+- `cds init --add` handles comma list correctly.
+- `cds import` fix for multi-line documentation text in OData V4 EDMX file.
+
+
 ## Version 4.4.2 - 2021-09-03
 
 ### Fixed

package/bin/activate.js

@@ -49,8 +49,7 @@ async function activate ([projectFolder], options = {}) {
 
     Object.assign(options, { projectFolder })
 
-    const client = require('@sap/cds-sidecar-client')
-    await client.apply(injection, options)
+    await require('../lib/client/activate').run(injection, options);
 }
 
 

package/bin/deploy/index.js

@@ -71,7 +71,7 @@ async function deploy (_model, options) { // NOSONAR
 
   const conf = cds.env.requires.db || {}
   const [,_kind,_db] = /(\w+)?(?::(.*))?/.exec(url||'')
-  const kind = _kind || conf.use || conf.kind
+  const kind = _kind || conf.dialect || conf.use || conf.kind
 
   try {
     var deployer = require ('./to-'+kind)
@@ -94,7 +94,7 @@ async function deploy (_model, options) { // NOSONAR
 }
 
 
-async function updata_package_json (kind, model='*', database) {
+async function updata_package_json (kind, model, database) {
   const { fs, path, isfile } = cds.utils
   const { readFile, writeFile } = fs.promises
   const package_json = path.resolve ('package.json'), exists = isfile (package_json)
@@ -102,6 +102,7 @@ async function updata_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' }
   await writeFile (package_json, JSON.stringify(conf,null,'  '))
   console.log (`/> ${ exists ? 'updated' : 'created' } ./package.json`)
 }

package/bin/deploy/to-sqlite.js

@@ -10,9 +10,9 @@ exports.deploy = function deploy_to_sqlite (_model, _db, options) {
     .then (db => db && db.disconnect()) // REVISIT: we should NOT require to disconnect explicitly
 }
 
-function _database4  (_db,_dbrl,conf) {
+function _database4 (_db,_dbrl,conf) {
     if (_db)  return _db
     if (_dbrl === 'sqlite')  return 'sqlite.db'
     if (_dbrl === 'sql')  return ':memory:'
-    return conf.credentials && conf.credentials.database
+    if (conf.credentials) return conf.credentials.database || conf.credentials.url
 }

package/bin/extend.js

@@ -49,17 +49,15 @@ module.exports = Object.assign(extend, {
 
 
 async function extend ([url], options = {}) {
-    const client = require('@sap/cds-sidecar-client')
-
     if (options.force) {
-        if (! await client.question.askBooleanQuestion('Using option --force will overwrite existing files. Continue (yN)? ', false, false)) {
+        if (! await require('../lib/client/helper/question').askBooleanQuestion('Using option --force will overwrite existing files. Continue (yN)? ', false, false)) {
             console.log('Extend cancelled')
             return
         }
     }
 
     Object.assign(options, { url })
-    client.extend(options)
+    await require('../lib/client/extend').run(options);
 }
 
 

package/bin/help.js

@@ -20,7 +20,7 @@ module.exports = exports = Object.assign (help, {help:`
     *d* | *deploy*     deploy to databases or cloud
     *l* | *login*      login to extendable SaaS application
     *x* | *extend*     create extension project from SaaS application
-    *t* | *lint*       run linter for env or model checks
+    *t* | *lint*       [beta] run linter for env or model checks
     *v* | *version*    get detailed version information
     *?* | *help*       get detailed usage information
 

package/bin/import.js

@@ -1,9 +1,9 @@
 
 module.exports = Object.assign(_import, {
     _name: 'import',
-    options: ['--out', '--into'],
-    flags: ['--dry', '--no-copy', '--no-save', '--keep-namespace'],
-    shortcuts: ['-o', '-in', '-'],
+    options: ['--out', '--into', '--as'],
+    flags: ['--dry', '--force', '--no-copy', '--no-save', '--keep-namespace'],
+    shortcuts: ['-o', '-in', '-as', '-', '-f'],
     help: `
 # SYNOPSIS
 
@@ -38,23 +38,39 @@ module.exports = Object.assign(_import, {
     *- | --dry*
         Writes the converted csn to stdout only.
 
+    *-as | --as <output_file_format>*
+        Converts the input edmx or xml file into one of these supported formats "cds", "csn", "json"
+
+    *-f | --force*
+        Forcefully overwrites the contents in the CDS file and updates the checksum 
+
+       
+       
 
 # EXAMPLES
 
     cds import ~/Downloads/API_BUSINESS_PARTNER.edmx
     cds import - ~/Downloads/API_BUSINESS_PARTNER.edmx
+    cds import ~/Downloads/API_BUSINESS_PARTNER.edmx --as cds
 
 `})
 const cds = require('@sap/cds/lib')
-const { fs, path, write, mkdirp, exists } = cds.utils
+const { fs, path, write, mkdirp, exists, read} = cds.utils
 const edm2csn = require('../lib/import')
+const messages = require('../lib/import/message').getMessages();
+const common = require('../lib/import/common');
+const cdsCompiler = require('../lib/compile').compile.to;
+const md5 = require('md5');
 let cwd;
-async function _import(file, { out, dry, into,
+async function _import(file, { out, dry, into, as,
     'no-save': no_save,
     'no-copy': no_copy,
-    'keep-namespace': keep_namespace
+    'keep-namespace': keep_namespace,
+    force
 } = {}) {
     cwd = into || process.cwd();
+    if (as && !common.supportedFormats().includes(as)) 
+        throw new Error(messages.INVALID_AS_OPTION);
     if (Array.isArray(file)) file = file[0]
     if (!file) return this.help('import')
     file = await edm2csn.isValidInputFile(path.resolve(cwd, file))
@@ -62,25 +78,94 @@ async function _import(file, { out, dry, into,
     const dst = path.join(external, path.basename(file))
     if (!dry && !no_copy) file = await _copy_to_srv_external(file, dst)
     const src = await edm2csn.getMetadataFromFile(file)
-    const csn = await edm2csn.edmx2csn(src, !keep_namespace && file, this)
-    if (out) out = edm2csn.validateAndComputeOutputFilePath(out);
-    const written = dry || await _write(csn, out = out || dst.replace(/\.[^.]+$/, '.csn'))
-    const registered = dry || no_save || await _update_package_json(out, csn, this.oDataVersion)
-    if (dry) return console.log(JSON.stringify(csn, 0, '  '))
+    let csn = await edm2csn.edmx2csn(src, !keep_namespace && file, this)
+    const service = _service_name_from(csn);
+    if (out) out = edm2csn.validateAndComputeOutputFilePath(out, as);
+    const result = await _getResult(csn, service, as, out || dst.replace(/\.[^.]+$/, ''), force);
+    const written = dry || await _write(result[0], result[1], result[2]);
+    const registered = dry || no_save || await _update_package_json(result[1].replace(/\.[^.]+$/, ''), service, this.oDataVersion);
+    if (dry) return console.log(result[0]);
     return Promise.all([written, registered])
 }
 
-async function _write(csn, dest) {
-    await edm2csn.saveCSNModel(JSON.stringify(csn, null, '  '), dest);
-    const service = _service_name_from(csn)
-    let using = `using { ${service} as external } from './${path.relative('srv', dest).replace(/\\/g, '/')}';`
-    using = require('../lib/util/term').info(using)
-    console.log(
-        `[cds] - imported API to ${path.relative(cwd, dest)}
+async function _generateChecksumValidate(dest, output, force) {
+    let fileResolved = await exists(dest);
+    if (fileResolved === false) {
+        let checksum = md5(output);
+        output = "/* checksum : " + checksum + " */\n" + output;
+        return output;
+    }
+    else {
+        let fileContent = await read(dest, "utf-8");
+        fileContent = String(fileContent);
+        if (fileContent.indexOf("checksum") === -1){
+            let checksum = md5(fileContent);
+            output = "/* checksum : " + checksum + " */\n" + output;
+            return output;
+        }      
+        let fileChecksum = fileContent.substring(fileContent.indexOf("checksum") + 11, fileContent.indexOf(" */"));
+        let newFile = fileContent.substring(fileContent.indexOf('*/') + 3);
+        let checksum = md5(newFile);
+        if (fileChecksum === checksum) {
+            output = "/* checksum : " + checksum + " */\n" + output;
+            return output;
+        }
+        else {
+            if (force) {
+                output = "/* checksum : " + checksum + " */\n" + newFile;
+                return output;
+            }
+            else {
+                throw new Error(messages.FILE_MODIFIED);
+            }
+        }
+    }
+}
+
+async function _getResult(output, service, as, dest, force) {
+    let using, message, extension;
+    as = (as === "cds") ? "cdl" : as;
+
+    if (!common.supportedFormats().includes(extension = dest.substring(dest.lastIndexOf(".") + 1))) {
+        // dest doesn't have any file extension, so get it
+        extension = common.getSuffix(as);
+    } 
+
+    dest = dest.replace('.' + extension, '');
+    using = `using { ${service} as external } from './${path.relative('srv', dest).replace(/\\/g, '/')}'`;
+    using = require('../lib/util/term').info(using);    
+    message = `[cds] - imported API to ${path.relative(cwd, dest)}
 > use it in your CDS models through the like of:
 
 ${using}
-`) // Please keep the newline above! -> it's intentional
+`;
+
+    dest += '.' + extension;
+
+    if (as && as != "csn" && as != "json") {
+        // cdsCompiler[as] will convert the csn output into various output formats
+        output = cdsCompiler[as](output);
+    }
+
+    switch(as) {
+        case "cdl":
+            output = await _generateChecksumValidate(dest, output, force);
+            break;
+        case undefined:
+        case "csn":
+        case "json":
+            output = JSON.stringify(output, null, '  ');
+            break;
+        default:
+            break;
+    }
+
+    return [output, dest, message];
+}
+
+async function _write(output, dest, message) {
+    await edm2csn.saveCSNModel(output, dest);
+    console.log(message);
 }
 
 async function _copy_to_srv_external(file, dst) {
@@ -100,14 +185,11 @@ function _service_name_from(csn) {
     }
 }
 
-async function _update_package_json(dest, csn, version) {
+async function _update_package_json(dest, service, version) {
     const package_json = path.resolve(cwd, 'package.json')
     const conf = await exists(package_json) ? require(package_json) : {}
-    const service = _service_name_from(csn)
     const requires = ['cds', 'requires'].reduce((p, n) => p[n] || (p[n] = {}), conf)
     if (!requires[service]) {
-        if (dest.endsWith(".json")) dest = dest.replace(/\.json$/, '').replace(/\\/g, '/');
-        else dest = dest.replace(/\.csn$/, '').replace(/\\/g, '/');
         const model = path.relative(cwd, dest)
         cds.env.requires[service] = requires[service] = { kind: (version === "V2") ? 'odata-v2' : 'odata', model }
         await write(package_json, JSON.stringify(conf, null, '  '))

package/bin/login.js

@@ -5,9 +5,9 @@ module.exports = Object.assign(login, {
     shortcuts: ['-s', '-d', '-p', '-c'],
     flags: ['--plain'],
     get help() {
-        const client = require('@sap/cds-sidecar-client')
-         const cdsExtendAndCdsActivate = `${bold('cds extend')} and ${bold('cds activate')}`
-        const keyring = client.config.keyringDesignation
+        const config = require('../lib/client/settings_manager').SettingsManager.config
+        const cdsExtendAndCdsActivate = `${bold('cds extend')} and ${bold('cds activate')}`
+        const keyring = config.keyringDesignation
         return `
 # SYNOPSIS
 
@@ -42,13 +42,13 @@ module.exports = Object.assign(login, {
 
     Authentication data for all logins is saved by <app-url> and <tenant-subdomain> in the
     desktop keyring (${keyring} on your platform) or, if requested, in config
-    file ${client.config.paths.auth}.
+    file ${config.paths.auth}.
 
     To make use of keyring storage, the 'keytar' Node.js module must be installed.
     A corresponding hint will be given in case the module is not found.
 
     Project settings are saved by project directory in config file
-    ${client.config.paths.settings}.
+    ${config.paths.settings}.
 
     Note that local storage of authentication data incurs a certain security risk:
     a malicious locally-running application might be able to perform any action with
@@ -96,7 +96,7 @@ module.exports = Object.assign(login, {
 # SEE ALSO
 
     *cds logout* to remove any authentication data
-`;
+`
     }})
 
 
@@ -108,8 +108,7 @@ async function login ([url], options = {}) {
     })
     delete options.plain
 
-    const client = require('@sap/cds-sidecar-client')
-    client.login(options)
+    await require('../lib/client/auth_manager').loginAndUpdateSettings(options)
 }
 
 

package/bin/logout.js

@@ -56,8 +56,7 @@ module.exports = Object.assign(logout, {
 async function logout ([projectFolder], options = {}) {
     Object.assign(options, { projectFolder })
 
-    const client = require('@sap/cds-sidecar-client')
-    client.logout(options)
+    await require('../lib/client/auth_manager').logout(options)
 }
 
 

package/bin/repl.js

@@ -27,7 +27,7 @@ function repl (_, options={}) {
   const info = colors ? require('../lib/util/term').info : s => s
   log(info('Welcome to cds repl v'+ cds.version))
 
-  const cdsr = require('repl').start ({...options, writer:_writer, ignoreUndefined:true })
+  const cdsr = cds.repl = require('repl').start ({...options, writer:_writer, ignoreUndefined:true })
 
   cds.lazify (Object.assign (cdsr.context,{ cds,
     Foo: lazy => new cds.entity ({name:'Foo'}),

package/bin/watch.js

@@ -1,6 +1,7 @@
+const watchOnlyOptions = ['--ext', '--livereload', '--open']
 module.exports = Object.assign ( watch, {
   flags: [ '--debug', '--in-memory', '--in-memory?' ],
-  options: [ '--port', '--ext', '--livereload', '--open' ],
+  options: [ '--port', ...watchOnlyOptions ],
   help: `
 # SYNOPSIS
 
@@ -59,22 +60,27 @@ let ignore = /node_modules|\.cds-services\.json$/
 async function watch ([cwd], {
   args = ['serve', 'all', '--with-mocks'],
   ext = extDefaults,
-  ...etc
+  ...options
 }={}) {
-
-  args.push (`--${Object.keys(etc).find(a => /^in-memory\??$/.test(a)) || 'in-memory?'}`)
-  const env = Object.assign (process.env, { _args: JSON.stringify(args) })
+  args.push (`--${Object.keys(options).find(a => /^in-memory\??$/.test(a)) || 'in-memory?'}`)
+  args.push (...process.argv.slice(3)
+    .filter(removeArgsIn(watchOnlyOptions))  // remove all watch-only options, as `cds serve` would not accept them
+    .filter(a => a !== cwd))
+
+  const env = Object.assign (process.env, {
+    _args: JSON.stringify(args),
+    _options: JSON.stringify(options)
+  })
   if (typeof ext !== 'string')  ext = extDefaults
-  if ('port' in etc) env.PORT = etc.port
   env.NODE_PATH = path.resolve (__dirname,'../node_modules') // allow global sqlite to be resolved
 
   let liveReload //= ...
   let firstTime = true
-  if (!/false|no/.test(etc['livereload'])) {
+  if (!/false|no/.test(options['livereload'])) {
     ext += ',css,gif,html,jpg,png,svg'
     liveReload = new (require ('../lib/watch/livereload-server'))
     env.CDS_LIVERELOAD_PATH = require.resolve ('connect-livereload')
-    env.CDS_LIVERELOAD_URL = await liveReload.start (etc['livereload'])
+    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${path.sep}.*\\.(js|ts)|`+ignore.source) // exclude more frontend stuff
@@ -99,7 +105,7 @@ async function watch ([cwd], {
     watch: ['*','.env','.cdsrc.json'],
     script:__filename, cwd, env, ext, ignore,
     delay: parseInt(process.env.CDS_WATCH_DELAY) || 200,
-    options: etc
+    options
   }).on('restart', (files)=>{
     DEBUG && DEBUG (files)
     if (liveReload) liveReload.markPending(files)
@@ -115,7 +121,7 @@ async function watch ([cwd], {
     case 'listening':
       env.PORT = (msg.address && msg.address.port) || msg.port
       liveReload && liveReload.reload()
-      firstTime && etc['open'] && require('../lib/watch/open').openURL (etc['open'], env.PORT)
+      firstTime && options['open'] && require('../lib/watch/open').openURL (options['open'], env.PORT)
       firstTime = false
       break
     case 'EADDRINUSE': env.PORT = 0; _addr_in_use(msg); break
@@ -139,7 +145,20 @@ const FileHandlers = {
   },
 }
 
-
+function removeArgsIn (toRemove) {
+  let argRemoved = false
+  return arg => { // filter function
+    if (toRemove.includes(arg)) {
+      argRemoved = true
+      return false
+    }
+    else if (argRemoved) {  // if next arg is a value, skip it as well
+      argRemoved = false
+      if (!arg.startsWith('-'))  return false
+    }
+    return true
+  }
+}
 
 //
 // Child process impl launched by watch