@sap/cds-dk 8.9.4 → 9.0.4

package/lib/init/template/html5-repo/index.js

@@ -67,15 +67,20 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
         if (hasMta) {
             const srv = srv4(srvPath)
             project.apps = apps
-            const appModules = project.apps.map(app => ({
-                in: 'modules',
-                where: { type: 'html5', path: `${appPath}${app.app}` }
-            }))
-            const additions = [srv, appDeployer, html5RepoHost, ...appModules]
             const relationships = [{
                 insert: [html5RepoHost, 'name'],
                 into: [appDeployer, 'requires', 'name'],
             }]
+            const appModules = []
+            for (const { app } of project.apps) {
+                const html5App = { in: 'modules', where: { type: 'html5', path: `${appPath}${app}` } }
+                appModules.push(html5App)
+                relationships.push({
+                    insert: [html5App],
+                    into: [appDeployer, 'build-parameters.requires'],
+                })
+            }
+            const additions = [srv, appDeployer, html5RepoHost, ...appModules]
             if (hasApprouter || hasWorkzoneStandard || hasMultitenancy) {
                 additions.push(html5Runtime)
             }

package/lib/init/template/http/index.js

@@ -140,7 +140,7 @@ module.exports = class HttpTemplate extends require('../../plugin') {
         requests.push(`@server=${hostname}\n${auth}`)
       }
       varsDefined = true
-      const headerAuth = username ? `Authorization: Basic {{username}}:{{password}}` : ''
+      const headerAuth = username ? `Authorization: Basic {{username}} {{password}}` : ''
       const headers = headerAuth ? `Content-Type: application/json\n${headerAuth}` : `Content-Type: application/json`
 
       service.urlPaths.forEach((urlPath) => {

package/lib/init/template/ias/files/mta.yaml.hbs

@@ -31,7 +31,7 @@ modules:
         group: destinations
         properties:
           url: ~{srv-cert-url}
-          forwardAuthCertificates:  true
+          forwardAuthCertificates: true
           strictSSL: true
 
   - name: {{appName}}-mtx

package/lib/init/template/ias/files/sidecar.package.json.hbs

@@ -1,12 +1,5 @@
 {
   "dependencies": {
     "@sap/xssec": "^4"
-  },
-  "cds": {
-    "requires": {
-      "auth": {
-        "kind": "ias"
-      }
-    }
   }
 }

package/lib/init/template/ias/index.js

@@ -23,7 +23,6 @@ module.exports = class IasTemplate extends require('../../plugin') {
         const { configFile, isNodejs } = project
         await merge(__dirname, 'files/package.json.hbs').into(configFile, { project, forceOverwrite: true })
         if (isNodejs) await sort('package.json', 'dependencies')
-        // if (project.isJava) await mvn.add('ias')
     }
 
     async combine() {
@@ -54,9 +53,11 @@ module.exports = class IasTemplate extends require('../../plugin') {
             if (hasApprouter) {
                 additions.push(approuter)
                 additions.push({ in: [approuter, 'requires'], where: { 'parameters.config.app-identifier': 'approuter' }})
-                const srvApi = { in: [approuter, 'requires'], where: { 'name': 'srv-api' } }
-                additions.push(srvApi)
-                overwrites.push({ item: [srvApi, 'properties.url'], withValue: '~{srv-cert-url}' })
+                const approuterSrvApi = { in: [approuter, 'requires'], where: { 'name': 'srv-api' } }
+                additions.push(approuterSrvApi)
+                overwrites.push({ item: [approuterSrvApi, 'properties.url'], withValue: '~{srv-cert-url}' })
+                overwrites.push({ item: [approuterSrvApi, 'properties.forwardAuthCertificates'], withValue: true })
+                overwrites.push({ item: [approuterSrvApi, 'properties.strictSSL'], withValue: true })
             }
             if (hasMultitenancy) {
                 const mtxSidecar = mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar')

package/lib/init/template/lint/files/package.json

@@ -0,0 +1,6 @@
+{
+  "devDependencies": {
+    "@sap/eslint-plugin-cds": "^4",
+    "eslint": "^9"
+  }
+}

package/lib/init/template/lint/index.js

@@ -1,18 +1,38 @@
-const os = require("os");
-const path = require("path");
-const cp = require("child_process");
-const term = require("../../../util/term");
-const checks = require("../../../lint/checks");
-const io = require("../../../lint/io");
-const readline = require("readline");
-const { renderAndCopy } = require('../../template')
-const { LINT_DEV, LINT_GLOBAL } = require("../../constants").OPTIONS;
-const { COMMAND_INIT } = require("../../constants");
-const cds = require("../../../cds");
-const { mkdirp, exists } = cds.utils;
-const IS_WIN = os.platform() === "win32";
+const fs = require('node:fs')
+const path = require('node:path')
+const io = require('../../../lint/io')
+const cds = require('../../../cds')
+const { merge } = require('../../merge')
+const { dim, bold } = require('../../../util/term')
+
 const VSCODE_FILE_ASSOCIATIONS = {
-  "csv": ["csv", "csv (semicolon)", "tsv", "tab"]
+  csv: ['csv', 'csv (semicolon)', 'tsv', 'tab']
+}
+
+/**
+ * Searches for ESLint config file types (in order or precedence)
+ * and returns corresponding directory (usually project's root dir)
+ * https://eslint.org/docs/user-guide/configuring#configuration-file-formats
+ * @param {string} currentDir start here and search until root dir
+ * @returns {string} dir containing ESLint config file (empty if not exists)
+ */
+function getConfigPath(currentDir = '.') {
+  let configFiles = [
+    'eslint.config.js',
+    'eslint.config.cjs',
+    'eslint.config.mjs'
+  ]
+  let configDir = path.resolve(currentDir)
+  while (configDir !== path.resolve(configDir, '..')) {
+    for (const configFile of configFiles) {
+      const configPath = path.join(configDir, configFile)
+      if (fs.existsSync(configPath) && fs.statSync(configPath).isFile()) {
+        return configPath
+      }
+    }
+    configDir = path.join(configDir, '..')
+  }
+  return ''
 }
 
 module.exports = class LintTemplate extends require('../../plugin') {
@@ -22,204 +42,41 @@ module.exports = class LintTemplate extends require('../../plugin') {
   }
 
   constructor() {
-    super();
-    this.customPath = path.join(cds.root, ".eslint");
-    this.docsPath = path.join(this.customPath, "docs");
-    this.rulesPath = path.join(this.customPath, "rules");
-    this.testsPath = path.join(this.customPath, "tests");
-    this.lintType = "local";
-    this.customRuleExample = false;
-    this.missingNpmDependencies = { names: [], msgs: [] };
-    this.isTest = false;
-  }
-
-  async canRun() {
-    const { lint } = cds.cli.options
-    if (lint) {
-      // If custom rule example is requested, also trigger
-      // "custom" rule type of setup
-      if (lint.has(LINT_DEV)) {
-        this.customRuleExample = true;
-      }
-      if (lint.has(LINT_GLOBAL)) {
-        this.lintType = "global";
-      }
-    }
-    return true;
+    super()
+    const customPath = path.join(cds.root, '.eslint')
+    this.docsPath = path.join(customPath, 'docs')
+    this.rulesPath = path.join(customPath, 'rules')
+    this.testsPath = path.join(customPath, 'tests')
   }
 
   async run() {
-    // Require ESLint v>=8.0.0
-    if (!this.isTest) {
-      this._checkEslint();
-    }
-
-    // To enable custom lint rules ('lint' or 'lint:dev')
-    if (this.lintType === "local") {
-      // Require local ESLint plugin installation and corresponding config
-      this._checkEslintPlugin();
-      await this._addEslintPluginConfig();
-      // Include custom lint sample rule and test ('lint:dev')
-      if (this.customRuleExample) {
-        // Generate custom lint rules dirs
-        await this._generateEslintDirs();
-
-        if (!exists(".eslint/rules/no-entity-moo.js")) {
-          await renderAndCopy(".eslint/rules", this.rulesPath);
-        }
-        if (!exists(".eslint/tests/no-entity-moo.test.js")) {
-          await renderAndCopy(".eslint/tests", this.testsPath);
+    // Require local ESLint plugin installation and corresponding config
+    await this.#addEslintPluginConfig()
+
+    // Generate VS Code extension settings
+    const ALLOWED_FILE_EXTENSIONS = ['*.cds', '*.csn', '*.csv']
+    const extensions = new Set(ALLOWED_FILE_EXTENSIONS.map((ext) => path.extname(ext).replace('.', '')))
+    for (const ext of extensions) {
+      if (ext in VSCODE_FILE_ASSOCIATIONS) {
+        for (const assoc of VSCODE_FILE_ASSOCIATIONS[ext]) {
+          extensions.add(assoc)
         }
       }
-
-      // Generate VS Code extension settings
-      const { getFileExtensions } = require("@sap/eslint-plugin-cds/lib/api");
-      const ALLOWED_FILE_EXTENSIONS = getFileExtensions();
-      const extensions = new Set(ALLOWED_FILE_EXTENSIONS.map((ext) => {
-        return path.extname(ext).replace('.', '');
-      }))
-      extensions.forEach((ext) => {
-        if (ext in VSCODE_FILE_ASSOCIATIONS) {
-          VSCODE_FILE_ASSOCIATIONS[ext].forEach((assoc) => {
-            extensions.add(assoc)
-          })
-        }
-      });
-      await io.sanitizeVscodeSettings(
-        path.join(cds.root, ".vscode/settings.json"),
-        this.lintType,
-        Array.from(extensions),
-        this.customRuleExample
-      );
     }
+    await io.sanitizeVscodeSettings(
+      path.join(cds.root, '.vscode/settings.json'),
+      Array.from(extensions),
+      this.customRuleExample
+    )
 
-  }
-
-  async finalize() {
-    if (this.lintType !== "global") {
-      if (this.missingNpmDependencies["names"].length > 0) {
-        const task = `npm install --save-dev ${this.missingNpmDependencies[
-          "names"
-        ].join(" ")}`;
-
-        if (cds.cli.command === COMMAND_INIT) {
-          this._runTask(task + ' --package-lock-only');
-          return;
-        }
-
-        if (cds.cli.options.force) {
-          console.log(
-            `\n\nAlmost done - installing ${this.missingNpmDependencies["names"].length} npm dependencies:\n${task}`
-          );
-          this._runTask(task);
-        } else {
-          console.log(
-            `\n\nAlmost done - ${term.warn(
-              `you are missing ${this.missingNpmDependencies["names"].length} npm dependencies`
-            )}:\n`
-          );
-          this.missingNpmDependencies["msgs"].forEach((msg, i) => {
-            console.log(`(${i + 1}) ${msg}`);
-            if (i === this.missingNpmDependencies["msgs"].length - 1) {
-              console.log("\n");
-            }
-          });
+    await merge(path.join(__dirname, 'files', 'package.json')).into('package.json')
 
-          await this._promptInstallDependencies(task);
-        }
-      }
-    }
+    console.log('\n', dim('Make sure to also run ' + bold('npm i') + dim(' to install the newly added dependencies.')))
   }
 
-  _checkEslint() {
-    const eslintCmd = checks.resolveEslint(cds.root, '');
-    if (!eslintCmd) {
-      this.missingNpmDependencies["names"].push("eslint@^9");
-      this.missingNpmDependencies["msgs"].push("ESLint v>=9.0.0");
-    }
-    return;
+  async #addEslintPluginConfig() {
+    const configPath = getConfigPath(cds.root)
+      ?? path.join(cds.root, 'eslint.config.mjs')
+    await io.sanitizeEslintConfig(configPath)
   }
-
-  _checkEslintPlugin() {
-    const eslintPluginLocal = checks.resolvePlugin(
-      "@sap/eslint-plugin-cds",
-      cds.root
-    );
-
-    // Require locally installed ESLint CDS plugin
-    if (!eslintPluginLocal) {
-      this.missingNpmDependencies["names"].push("@sap/eslint-plugin-cds@^3");
-      this.missingNpmDependencies["msgs"].push("ESLint plugin for CDS v>=3.0.0");
-    }
-    return;
-  }
-
-  async _generateEslintDirs() {
-    await mkdirp(this.docsPath);
-    await mkdirp(this.rulesPath);
-    await mkdirp(this.testsPath);
-  }
-
-  async _addEslintPluginConfig() {
-    const { getConfigPath } = require("@sap/eslint-plugin-cds/lib/api");
-    let configPath = getConfigPath(cds.root);
-    if (!configPath) {
-      configPath = path.join(cds.root, "eslint.config.mjs");
-    }
-    await io.sanitizeEslintConfig(configPath, this.customRuleExample);
-  }
-
-  async _promptInstallDependencies(task) {
-    if (!process.stdin.isTTY) {
-      return; // non-interactive shell, like in tests
-    }
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-    // Do not install dependencies by default
-    let received = "no";
-    const timerID = setTimeout(() => {
-      rl.write("no" + os.EOL);
-    }, 10000);
-    // Ask user whether dependencies should be installed
-    const question = `${term.warn("Install dependencies now")} ? [y/n] `;
-    let todos = `${term.error(
-      "Aborted!\nPlease install the following components manually:"
-    )}\n\n${term.warn(task)}`;
-    return new Promise((resolve, reject) => {
-      rl.question(question, (answer) => {
-        rl.close();
-        clearTimeout(timerID);
-        received = answer.trim().toLowerCase();
-        // If user confirms or force flag is set, install dependencies
-        if (["y", "yes"].includes(received) || cds.cli.options.force) {
-          resolve(this._runTask(task));
-          // If use declines or question timeout is reached, print todos
-        } else if (["n", "no"].includes(received.toLowerCase())) {
-          console.log(todos);
-          resolve();
-        } else {
-          // Close and restart question (with new timeout)
-          rl.close();
-          clearTimeout(timerID);
-          this._promptInstallDependencies(task).then(resolve).catch(reject);
-        }
-      });
-    })
-  }
-
-  _runTask(task) {
-    let doneTask = true;
-    try {
-      cp.execSync(task, {
-        cwd: cds.root,
-        shell: IS_WIN,
-        stdio: "inherit",
-      });
-    } catch (err) {
-      doneTask = false;
-    }
-    return doneTask;
-  }
-};
+}

package/lib/init/template/mta/files/package.json

@@ -1,5 +1,5 @@
 {
   "devDependencies": {
-    "@sap/cds-dk": "^8"
+    "@sap/cds-dk": ">=8"
   }
 }

package/lib/init/template/multitenancy/files/mta.yaml.hbs

@@ -104,6 +104,6 @@ resources:
         iasServiceInstanceName: {{appName}}-auth{{#hasXsuaa}}
         saasManagerServiceInstanceName: {{appName}}-registry{{/hasXsuaa}}
     requires:
-      - name: mtx-api
-    {{#hasXsuaa}}processed-after: [{{appName}}-registry, {{appName}}-auth]{{/hasXsuaa}}
+      - name: {{#isJava}}srv-api{{/isJava}}{{^isJava}}mtx-api{{/isJava}}
+    processed-after: [{{#hasXsuaa}}{{appName}}-registry, {{/hasXsuaa}}{{appName}}-auth]
   {{/hasIas}}

package/lib/init/template/multitenancy/files/package.json.hbs

@@ -1,7 +1,7 @@
 {
   {{#isNodejs}}
   "dependencies": {
-    "@sap/cds-mtxs": "^2"
+    "@sap/cds-mtxs": "^3"
   },
   "cds": {
   {{/isNodejs}}

package/lib/init/template/multitenancy/files/package.sidecar.json.hbs

@@ -1,14 +1,17 @@
 {
   "name": "{{appName}}-mtx",
   "dependencies": {
-    "@cap-js/hana": "^1",
-    "@sap/cds": "^8",
-    "@sap/cds-mtxs": "^2",
+    "@cap-js/hana": "^2",
+    "@sap/cds": "^9",
+    "@sap/cds-mtxs": "^3",
     "@sap/xssec": "^4",
     "express": "^4"
   },
   "devDependencies": {
-    "@cap-js/sqlite": "^1"
+    "@cap-js/sqlite": "^2"
+  },
+  "engines": {
+    "node": "^22"
   },
   "scripts": {
     "start": "cds-serve"{{#isJava}},

package/lib/init/template/multitenancy/index.js

@@ -27,11 +27,14 @@ module.exports = class MultitenancyTemplate extends require('../../plugin') {
   async run() {
     const project = readProject()
     const { isNodejs, isJava, configFile } = project
+    project.profile ??= 'production'
     await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project })
     if (isJava) {
       const packageJson = await read('package.json')
       packageJson.workspaces = ['mtx/sidecar']
+      packageJson.devDependencies['@sap/cds-mtxs'] ??= '^3'
       await write('package.json', packageJson, { spaces: 2 })
+      await sort('package.json', 'devDependencies')
       await mvn.add('mtx')
     }
     if (isNodejs) await sort('package.json', 'dependencies')

package/lib/init/template/nodejs/files/package.json.hbs

@@ -6,11 +6,14 @@
   "license": "UNLICENSED",
   "private": true,
   "dependencies": {
-    "@sap/cds": "^8",
+    "@sap/cds": "^9",
     "express": "^4"
   },
+  "engines": {
+    "node": "^22"
+  },
   "devDependencies": {
-    "@cap-js/sqlite": "^1",
+    "@cap-js/sqlite": "^2",
     "@cap-js/cds-types": "^0.10.0"
   },
   "scripts": {

package/lib/init/template/redis/files/package.json.hbs

@@ -1,5 +1,5 @@
 {
   "dependencies": {
-    "redis": "^4"
+    "redis": "^5.0.0"
   }
 }

package/lib/init/template/sqlite/files/package.json

@@ -1,5 +1,5 @@
 {
   "devDependencies": {
-    "@cap-js/sqlite": "^1"
+    "@cap-js/sqlite": "^2"
   }
 }

package/lib/init/template/toggles/files/package.json.hbs

@@ -1,7 +1,7 @@
 {
   {{#isNodejs}}
   "dependencies": {
-    "@sap/cds-mtxs": "^2"
+    "@sap/cds-mtxs": "^3"
   },
   "cds": {
   {{/isNodejs}}

package/lib/init/template/typescript/files/package.json

@@ -2,9 +2,7 @@
   "devDependencies": {
     "@cap-js/cds-types": "^0.10.0",
     "@types/node": "^22.0.0",
+    "tsx": "^4",
     "typescript": "^5"
-  },
-  "scripts": {
-    "watch": "cds-tsx w"
   }
 }

package/lib/init/template/workzone-standard/index.js

@@ -59,6 +59,8 @@ module.exports = class extends require('../../plugin') {
 
     if (hasMultitenancy) {
       const mtxPackageJson = await read('mtx/sidecar/package.json')
+      mtxPackageJson.cds ??= {}
+      mtxPackageJson.cds.requires ??= {}
       mtxPackageJson.cds.requires['html5-host'] = true
       delete mtxPackageJson.cds.requires['html5-repo']
       // delete mtxPackageJson.cds.requires['html5-runtime']

package/lib/init/template/xsuaa/index.js

@@ -27,6 +27,7 @@ module.exports = class XsuaaTemplate extends require('../../plugin') {
         const project = readProject()
         const { configFile } = project
         project.shortcut = typeof (await read(configFile)).cds?.requires?.auth !== 'object'
+        project.profile ??= 'production'
         await merge(__dirname, 'files/package.json.hbs').into(configFile, { project, forceOverwrite: true })
     }
 
@@ -66,12 +67,7 @@ module.exports = class XsuaaTemplate extends require('../../plugin') {
         }
 
         if (hasHelm || hasHelmUnifiedRuntime) {
-            const overwrites = hasMultitenancy ? [{
-                item: [{
-                    in: 'xsuaa',
-                    where: { serviceOfferingName: 'xsuaa' }
-                }, 'parameters.tenant-mode'], withValue: 'shared'
-            }] : []
+            const overwrites = hasMultitenancy ? [{ item: 'xsuaa.parameters.tenant-mode', withValue: 'shared' }] : []
             await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project, overwrites })
             await merge({
                 xsuaa: {