@sap/cds-dk 8.2.2 → 8.2.3

package/CHANGELOG.md

@@ -7,6 +7,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 8.2.3 - 2024-09-25
+
+### Fixed
+
+- In `cds.cli.command`, commands now show up in the correct case.
+- `cds add` plugins don't throw a `TypeError` if `cds.cli.options` is `undefined`.
+- `cds watch` no longer ignores `*git/` folders, but only `.git/`.
+- `cds import` updates `package.json` file in `srv` folder if existing. The `srv` folder name is determined by `cds.env.folders.srv` config or parameter `--out`.
+- `cds import` doesn't change existing service configuration data. Now, `destination` credentials are only saved for the `production` profile.
+
 ## Version 8.2.2 - 2024-09-17
 
 ### Fixed

package/bin/cds.js

@@ -33,6 +33,10 @@ const cli = {
     if (cmd in this.Shortcuts) cmd = process.argv[2] = this.Shortcuts[cmd]
     if (argv.some(a => this.Shortcuts[a]==='help'))  return this.help (cmd)
 
+    // normalize command case (but not the shortcuts above) so that checks against `cds.cli.command` work
+    if (cmd === process.argv[2]) cmd = process.argv[2] = cmd.toLowerCase()
+    else if (cmd) cmd = cmd.toLowerCase()
+
     const cds = require('../lib') // make sure to load cds-dk API for plugins
     DEBUG?.(`[cds] - @sap/cds ${cds.version} loaded: ${cds.home}`)
 
@@ -69,11 +73,7 @@ const cli = {
         }
         const args = this.args(task, argv)
         args[0].push(...appendArgs)
-        cds.cli = {
-          command: cmd,
-          argv: args[0],
-          options: args[1],
-        }
+        cds.cli = { command: cmd, argv: args[0], options: args[1] }
 
         if (args[1]?.['resolve-bindings']) await _resolveBindings({ silent: cmd === 'env' })
 

package/bin/watch.js

@@ -56,7 +56,7 @@ const fs = require ('fs')
 
 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}` +
+  `(\\.git|node_modules|_out|@types|@cds-models)\\${sep}` +
   `|app(\\${sep}.+)?\\${sep}(` +
     `(webapp|dist|target)\\${sep}|` +
     `tsconfig\\.json$|` +

package/lib/import/common.js

@@ -176,7 +176,7 @@ async function processOptions(cliOptions, options) {
             options[item] = cliOptions[item];
         }
     });
-    
+
     // reads cli options from environment
     readEnvVariables(cliOptions, true);
 }
@@ -312,10 +312,10 @@ async function _write(result, service, cwd) {
     extension = dest.substring(dest.lastIndexOf('.'));
     dest = dest.replace(extension, '');
      if (service.length > 1){
-        using = `using { ${service.join(', ')}} from './${path.relative('srv', dest).replace(/\\/g, '/')}'`;
+        using = `using { ${service.join(', ')}} from './${path.relative(cds.env.folders.srv, dest).replace(/\\/g, '/')}'`;
      }
      else{
-        using = `using { ${service} as external } from './${path.relative('srv', dest).replace(/\\/g, '/')}'`;
+        using = `using { ${service} as external } from './${path.relative(cds.env.folders.srv, dest).replace(/\\/g, '/')}'`;
      }
     using = require('../util/term').info(using);
     message = `[cds] - imported API to ${path.relative(cwd, dest)}
@@ -327,21 +327,36 @@ ${using}
     console.log(message);
 }
 
-async function _updatePackageJson(dest, services, kind, cwd, config) {
-    const package_json = path.resolve(cwd, 'package.json');
-    const conf = await exists(package_json) ? require(package_json) : {};
+async function _updatePackageJson(dest, services, kind, cwd, config, destination) {
+    // try to find package.json in the srv folder
+    let package_json = _findPackageJson(path.resolve(cwd, dest), cwd);
+    let conf = {};
+    if (package_json) {
+        conf = JSON.parse(await read(package_json, "utf-8"));
+    } else {
+        package_json = path.resolve(cwd, 'package.json');
+    }
     const requires = ['cds', 'requires'].reduce((p, n) => p[n] || (p[n] = {}), conf);
     if (kind !== 'rest' && kind !== 'rfc') {
         kind = (kind === "V2") ? 'odata-v2' : 'odata';
     }
+    // add destination configuration
+    if (!config && destination) {
+        config = { "[production]": { credentials: { destination } } };
+    }
+
     let package_json_updated = false;
     for (let service of services) {
         // existing service configuration data can be updated, e.g. in case of delta imports
         const model = path.relative(cwd, dest).replace(/\\/g, '/'); // cds env must not be platform specific
         const serviceConfig = { kind, model, ...config }
-        if (!requires[service] || JSON.stringify(serviceConfig) !== JSON.stringify(requires[service])) {
+        if (!requires[service]) {
             cds.env.requires[service] = requires[service] = serviceConfig;
             package_json_updated = true;
+        } else {
+            if (JSON.stringify(serviceConfig) !== JSON.stringify(requires[service])) {
+                console.warn(`Service '${service}' already exists in ./package.json with a different configuration, skipping update.\n`);
+            }
         }
     }
     if (package_json_updated) {
@@ -350,6 +365,21 @@ async function _updatePackageJson(dest, services, kind, cwd, config) {
     }
 }
 
+function _findPackageJson(dir, cwd) {
+    const packageJsonPath = path.join(dir, 'package.json');
+    if (fs.existsSync(packageJsonPath)) {
+        return packageJsonPath;
+    }
+    if (dir === cwd) {
+        return null;
+    }
+    const parentDir = path.dirname(dir);
+    if (parentDir === dir) {
+        return null;
+    }
+    return _findPackageJson(parentDir, cwd);
+}
+
 function _parseValidJsonConfig(config) {
     try {
         if (config) {
@@ -363,19 +393,12 @@ function _parseValidJsonConfig(config) {
 async function postProcess(filePath, options, csn, cwd) {
     const services = _getServiceNames(csn);
     let config = _parseValidJsonConfig(options.config);
-    
-    // add destination configuration
-    if (options.destination) {
-        config ??= {};
-        config.credentials = { destination: options.destination };
-    }
-
-    const destFilePath = path.resolve(cwd, options.out ? path.join(options.out, path.basename(filePath)) : path.join('srv/external/', path.basename(filePath)));
+    const destFilePath = path.resolve(cwd, options.out ? path.join(options.out, path.basename(filePath)) : path.join(cds.env.folders.srv, 'external', path.basename(filePath)));
     if (options.out) options.out = _validateAndComputeOutputFilePath(options.out, options.as, destFilePath);
     const kind = options.inputFileKind;
     const result = await _getResult(csn, options.as, options.out || destFilePath.replace(/\.[^.]+$/, ''), options.force, kind);
     const written = options.dry || await _write(result, services, cwd);
-    const registered = options.dry || options.no_save || await _updatePackageJson(result[1].replace(/\.[^.]+$/, ''), services, kind, cwd, config);
+    const registered = options.dry || options.no_save || await _updatePackageJson(result[1].replace(/\.[^.]+$/, ''), services, kind, cwd, config, options.destination);
     if (!options.dry && !options.no_copy)
         await _copyToSrvExternal(filePath, destFilePath, cwd);
     if (options.dry) return console.log(result[0]);

package/lib/init/projectReader.js

@@ -13,7 +13,7 @@ module.exports = new class ProjectReader {
 
     #setPackageInfo() {
         // 1. Use project name and static default values
-        this.appVersion = cds.cli.options.add?.has('java') ? '1.0.0-SNAPSHOT' : '1.0.0'
+        this.appVersion = cds.cli.options?.add?.has('java') ? '1.0.0-SNAPSHOT' : '1.0.0'
         this.appName = this.appId = basename(cds.root)
         this.appDescription = 'A simple CAP project.'
 

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@sap/cds-dk",
-  "version": "8.2.2",
+  "version": "8.2.3",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@sap/cds-dk",
-      "version": "8.2.2",
+      "version": "8.2.3",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "@cap-js/asyncapi": "^1.0.0",
@@ -99,7 +99,7 @@
       }
     },
     "node_modules/@eslint-community/regexpp": {
-      "version": "4.11.0",
+      "version": "4.11.1",
       "license": "MIT",
       "engines": {
         "node": "^12.0.0 || ^14.0.0 || >=16.0.0"
@@ -214,7 +214,7 @@
       }
     },
     "node_modules/@sap/cds": {
-      "version": "8.2.2",
+      "version": "8.2.3",
       "license": "SEE LICENSE IN LICENSE",
       "dependencies": {
         "@sap/cds-compiler": ">=5.1",
@@ -302,13 +302,13 @@
       }
     },
     "node_modules/@sap/hdi": {
-      "version": "4.5.2",
+      "version": "4.6.0",
       "license": "See LICENSE file",
       "dependencies": {
-        "async": "3.2.3"
+        "async": "^3.2.3"
       },
       "engines": {
-        "node": ">=12 <=20"
+        "node": ">=18 <=20"
       },
       "peerDependencies": {
         "@sap/hana-client": "^2 >= 2.5",
@@ -324,16 +324,16 @@
       }
     },
     "node_modules/@sap/hdi-deploy": {
-      "version": "5.2.3",
+      "version": "5.3.1",
       "hasInstallScript": true,
       "license": "See LICENSE file",
       "dependencies": {
-        "@sap/hdi": "4.5.2",
-        "@sap/xsenv": "5.2.0",
-        "async": "3.2.6",
-        "dotenv": "16.4.5",
-        "handlebars": "4.7.8",
-        "micromatch": "4.0.8"
+        "@sap/hdi": "^4.6.0",
+        "@sap/xsenv": "^5.2.0",
+        "async": "^3.2.6",
+        "dotenv": "^16.4.5",
+        "handlebars": "^4.7.8",
+        "micromatch": "^4.0.8"
       },
       "engines": {
         "node": "^18.0.0 || ^20.0.0"
@@ -351,16 +351,12 @@
         }
       }
     },
-    "node_modules/@sap/hdi/node_modules/async": {
-      "version": "3.2.3",
-      "license": "MIT"
-    },
     "node_modules/@sap/xsenv": {
-      "version": "5.2.0",
+      "version": "5.3.0",
       "license": "SEE LICENSE IN LICENSE file",
       "dependencies": {
-        "debug": "4.3.5",
-        "node-cache": "^5.1.0",
+        "debug": "4.3.7",
+        "node-cache": "^5.1.2",
         "verror": "1.10.1"
       },
       "engines": {
@@ -734,10 +730,10 @@
       }
     },
     "node_modules/debug": {
-      "version": "4.3.5",
+      "version": "4.3.7",
       "license": "MIT",
       "dependencies": {
-        "ms": "2.1.2"
+        "ms": "^2.1.3"
       },
       "engines": {
         "node": ">=6.0"
@@ -1649,7 +1645,7 @@
       "optional": true
     },
     "node_modules/ms": {
-      "version": "2.1.2",
+      "version": "2.1.3",
       "license": "MIT"
     },
     "node_modules/mustache": {
@@ -1680,7 +1676,7 @@
       "license": "MIT"
     },
     "node_modules/node-abi": {
-      "version": "3.67.0",
+      "version": "3.68.0",
       "license": "MIT",
       "optional": true,
       "dependencies": {
@@ -2089,10 +2085,6 @@
         "node": ">= 0.8"
       }
     },
-    "node_modules/send/node_modules/ms": {
-      "version": "2.1.3",
-      "license": "MIT"
-    },
     "node_modules/serve-static": {
       "version": "1.16.2",
       "license": "MIT",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-dk",
-  "version": "8.2.2",
+  "version": "8.2.3",
   "description": "Command line client and development toolkit for the SAP Cloud Application Programming Model",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [