@sap/cds-dk 7.0.2 → 7.1.0

package/lib/init/template/sample/files/app/admin-books/webapp/manifest.json

@@ -11,7 +11,7 @@
       "i18n": "i18n/i18n.properties",
       "dataSources": {
         "AdminService": {
-          "uri": "/admin/",
+          "uri": "/odata/v4/admin/",
           "type": "OData",
           "settings": {
             "odataVersion": "4.0"

package/lib/init/template/sample/files/app/browse/webapp/manifest.json

@@ -11,7 +11,7 @@
     "i18n": "i18n/i18n.properties",
     "dataSources": {
       "CatalogService": {
-        "uri": "/browse/",
+        "uri": "/odata/v4/catalog/",
         "type": "OData",
         "settings": {
           "odataVersion": "4.0"

package/lib/init/template/sample/files/srv/admin-service.cds

@@ -1,5 +1,5 @@
 using { sap.capire.bookshop as my } from '../db/schema';
-service AdminService @(requires:'admin', path:'/admin') {
+service AdminService @(requires:'admin') {
   entity Books as projection on my.Books;
   entity Authors as projection on my.Authors;
 }

package/lib/init/template/sample/files/srv/cat-service.cds

@@ -1,5 +1,5 @@
 using { sap.capire.bookshop as my } from '../db/schema';
-service CatalogService @(path:'/browse') {
+service CatalogService {
 
   /** For displaying lists of Books */
   @readonly entity ListOfBooks as projection on Books

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

@@ -6,7 +6,7 @@ const { copyFiles } = require('../../util/template')
 module.exports = class SampleTemplate extends require('../templateBase') {
 
     async canRun() {
-        const { isJava } = await readProject(this.options)
+        const { isJava } = await readProject()
         if (isJava) throw `'cds add sample' is not available for Java yet`
         return true
     }
@@ -14,11 +14,12 @@ module.exports = class SampleTemplate extends require('../templateBase') {
     async run() {
         const { db, srv, app } = (await this.getEnv()).folders
         const language = exists('pom.xml') ? 'java' : 'nodejs'
+        const { force } = cds.cli.options
         await Promise.all([
-          copyFiles(join(__dirname, 'files', 'db'),  db, {}, this.options.force),
-          copyFiles(join(__dirname, 'files', 'app'), app, {}, this.options.force),
-          copyFiles(join(__dirname, 'files', 'srv'), srv, {}, this.options.force),
-          copyFiles(join(__dirname, 'files', language), srv, {}, this.options.force)
+          copyFiles(join(__dirname, 'files', 'db'),  db, {}, force),
+          copyFiles(join(__dirname, 'files', 'app'), app, {}, force),
+          copyFiles(join(__dirname, 'files', 'srv'), srv, {}, force),
+          copyFiles(join(__dirname, 'files', language), srv, {}, force)
         ])
     }
 }

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

@@ -7,7 +7,7 @@ const { mergeJSON } = require('../../util/merge')
 module.exports = class SQLiteTemplate extends require('../templateBase') {
 
     async run() {
-      const project = await readProject(this.options)
+      const project = await readProject()
       const { configFile } = project
       project.shortcut = !(await read(configFile)).cds?.requires?.db?.kind
       await mergeJSON(configFile, join(__dirname, 'files', `package.json.hbs`), project)

package/lib/init/template/templateBase.js

@@ -1,25 +1,14 @@
-const cds = require('../../cds');
-const path = require('path');
-
-const { PROJECT_TYPE } = require('../constants');
-const { exists } = require('../../cds').utils;
+const cds = require('../../cds')
+const { exists } = require('../../cds').utils
+const { PROJECT_TYPE } = require('../constants')
 
 module.exports = class TemplateBase {
+
     /**
      * @constructor
      */
-    constructor(generator) {
-        if (generator.options?.for && typeof generator.options?.for !== 'string') {
-            throw 'The --for argument must not be empty.'
-        }
-        this.projectPath = cds.root;
-        this.options = generator.options || {};
-        this.generator = generator;
+    constructor() {
         this.name = this.constructor.name.replace(/template/i, '').replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase()
-
-        this.cwd = this.options.cwd || process.cwd();
-
-        this.projectName = path.basename(cds.root);
     }
 
     /**
@@ -51,7 +40,7 @@ module.exports = class TemplateBase {
     }
 
     // eslint-disable-next-line no-unused-vars
-    static hasFacet(env, options) {
+    static hasFacet(env) {
         return true;
     }
 
@@ -85,13 +74,14 @@ module.exports = class TemplateBase {
     }
 
     /**
+     * @abstract
      * Executes steps for related facets that are set up for the project.
      */
     async runRelatedMerging() {
         for (const facet of this.getRelatedFacets()) {
             const Template = require('./'+facet)
-            const template = new Template(this.generator)
-            if (Template.hasFacet(await this.getEnv(), this.options)) await template.runDependentMerging()
+            const template = new Template()
+            if (Template.hasFacet(await this.getEnv())) await template.runDependentMerging()
         }
     }
 

package/lib/init/template/tiny-sample/index.js

@@ -16,11 +16,11 @@ module.exports = class TinySampleTemplate extends require('../templateBase') {
     }
 
     async _addJavaSamples() {
-        if (!this.options.add.has(JAVA)) {
-            const mvnAddSamplesArgs = mvnArchetypes.getAddSamplesCmdArgs(this.options)
+        if (!cds.cli.options.add.has(JAVA)) {
+            const mvnAddSamplesArgs = mvnArchetypes.getAddSamplesCmdArgs()
             try {
                 await commandUtil.spawnCommand('mvn', mvnAddSamplesArgs, { cwd: cds.root })
-                const mvnAddTestsArgs = mvnArchetypes.getAddTestsCmdArgs(this.options)
+                const mvnAddTestsArgs = mvnArchetypes.getAddTestsCmdArgs()
                 await commandUtil.spawnCommand('mvn', mvnAddTestsArgs, { cwd: cds.root })
             } catch (err) {
                 if (err.code === 'ENOENT' && err.path === 'mvn') {
@@ -33,7 +33,7 @@ module.exports = class TinySampleTemplate extends require('../templateBase') {
 
     async _addNodejsSamples() {
         const { db, srv } = (await this.getEnv()).folders
-        await copyFiles(join(__dirname, 'files', 'nodejs', 'db'), db, {}, this.options.force)
-        await copyFiles(join(__dirname, 'files', 'nodejs', 'srv'), srv, { dbFolder: db.replace(/[\\/]+$/, '') }, this.options.force)
+        await copyFiles(join(__dirname, 'files', 'nodejs', 'db'), db, {}, cds.cli.options.force)
+        await copyFiles(join(__dirname, 'files', 'nodejs', 'srv'), srv, { dbFolder: db.replace(/[\\/]+$/, '') }, cds.cli.options.force)
     }
 }

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

@@ -9,10 +9,9 @@ module.exports = class TogglesTemplate extends require('../templateBase') {
   }
 
   async run() {
-    const project = await readProject(this.options)
+    const project = await readProject()
     const { isNodejs , configFile} = project
     await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
     if (isNodejs) await sort('package.json', 'dependencies')
-    await this.runDependentMerging()
   }
 }

package/lib/init/template/typer/files/xsconfig.json

@@ -1,6 +1,5 @@
 {
   "compilerOptions": {
-    "checkJs": true,
     "moduleResolution": "nodenext",
     "paths": {
       "#cds-models/*": ["./@cds-models/*"]

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

@@ -7,7 +7,7 @@ const { exists, read } = require('../../../cds').utils
 
 module.exports = class TyperTemplate extends require('../templateBase') {
   async canRun() {
-    const { isJava } = await readProject(this.options)
+    const { isJava } = await readProject()
     if (isJava) {
       console.warn(warn(`This appears to be a Java project. 'cds add ${TYPER}' is intended to be used in Node.js projects. Proceeding anyway.\n`))
     }

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

@@ -17,15 +17,14 @@ module.exports = class XsuaaTemplate extends require('../templateBase') {
     }
 
     async run() {
-        const project = await readProject(this.options)
+        const project = await readProject()
         const { configFile } = project
         project.shortcut = !(await read(configFile)).cds?.requires?.auth?.kind
         await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project, { forceOverwrite: true })
-        await this.runDependentMerging()
     }
 
     async runDependentMerging( context = {}) {
-        const project = await readProject(this.options)
+        const project = await readProject()
         const { isMultitenant, hasMta, hasHelm, isJava, srvPath } = project
 
         const cds = require('../../../../lib')
@@ -71,7 +70,7 @@ module.exports = class XsuaaTemplate extends require('../templateBase') {
 
             // copy service-instance chart
             const HelmTemplate = require(`../helm`);
-            const helmTemplate = new HelmTemplate(this.generator, context.oldTrackingData, context.newTrackingData);
+            const helmTemplate = new HelmTemplate(context.oldTrackingData, context.newTrackingData);
             isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('service-instance');
 
             // add dependency entry in chart.yaml

package/lib/init/util/indent.js

@@ -0,0 +1,57 @@
+const indentRegEx = new RegExp(/^(\s*)/)
+const leadingSpacesRegEx = new RegExp(/^( +)/)
+const leadingTabsRegEx = new RegExp(/^(\t+)/)
+
+/**
+ * Greatest Common Divisor Euclidean algorithm
+ * @param {number[]} xs - list of number to find the gcd of.
+ * @returns {number} - greatest common divisor of all numbers in xs.
+ */
+function gcd (xs) {
+    const euclid = (a, b) => b === 0 ? a : euclid(b, a % b)
+    const [a, b, ...tail] = xs
+    return tail.length
+        ? gcd([euclid(a, b)].concat(tail))
+        : euclid(a, b ?? 0)  // coalesce in case xs consists of exactly one element
+}
+
+/**
+ * Detects indent used for a file.
+ * The algorithm inspects the indentation of every line to find whether tabs or spaces are more prevalent.
+ * Once that has been determined, it derives the spacing by calculating the gcd of all relevant lines.
+ * I.e. if there are lines indented with 2, 4, or 8 spaces, it will find '  ' as indent.
+ * If lines are indented using 1 or 2 tabs, '\t' will be returned.
+ * TODO: filter out outliers, i.e. if the user used three spaces in one line, should ' ' space be used for spacing? Or should that be ignored?
+ * @param {string[]} file - lines of a file.
+ * @returns {string | null} - the string used to space (e.g. 2 spaces, 4 spaces, 1 tab, etc.) or null if the file was empty.
+ */
+function detectIndent (file) {
+    if (file.length === 0) return null
+    if (file.length === 1) return indentRegEx.exec(file[0])[0]
+
+    const indents = file
+        .map(line => indentRegEx.exec(line)[0])
+        .filter(Boolean)
+        .reduce((bins, indent) => {
+            const type = leadingSpacesRegEx.test(indent)
+                ? 'spaces'
+                : leadingTabsRegEx.test(indent)
+                ? 'tabs'
+                : undefined
+            if (type) {
+                const length = indent.split('').length
+                const bin = bins[type]
+                bin.total++
+                bin.indents[length] = (bin.indents[length] ?? 0) + 1
+            }
+            return bins
+        }, { tabs: { indents: {}, total: 0, character: '\t' }, spaces: { indents: {}, total: 0, character: ' ' } })
+
+    const preferred = indents.tabs.total > indents.spaces.total ? indents.tabs : indents.spaces
+    const width = gcd(Object.keys(preferred.indents)) ?? 2
+    return preferred.character.repeat(width)
+}
+
+module.exports = {
+    detectIndent
+}

package/lib/init/util/merge.js

@@ -2,7 +2,7 @@ const YAML = require('@sap/cds-foss').yaml
 const { copy, read, write, exists } = require('../../cds').utils
 const { readYAML, writeYAML, readJSON } = require('../../util/fs')
 const { EOL } = require('node:os')
-
+const { detectIndent } = require('../util/indent')
 
 function _isObject(item) {
   return item && typeof item === 'object' && !Array.isArray(item)
@@ -53,37 +53,93 @@ async function mergeGitignore (into, from) {
     return enhanced
   }
 
+/**
+ * @typedef {Object} MatchedNode
+ * @property {string | MatchedNode} in - key path or matched node to start search from
+ * @property {Object[]} where - list of constraints
+ * @property {string} where[].property - property key path
+ * @property {string} where[].isEqualTo - comparison string
+ */
+
+/**
+ * @typedef {Object} Overwrites
+ * @property {(string | MatchedNode)[]} item - path to item to be overwritten
+ * @property {string} withValue - replacement string
+ */
+
+/**
+ * @typedef {Object} Deletion
+ * @property {MatchedNode} item - matched node to delete
+ * @property {Object[]} relationships - list of relationships to delete
+ * @property {string} relationships[].removeProperty - key path to to-be-removed property
+ * @property {string[]} relationships[].allWithin - key path to relationship
+ */
+
+/**
+ * @typedef {Object} Relationship
+ * @property {(string | MatchedNode)[]} insert - source path to matched node
+ * @property {(string | MatchedNode)[]} into - target path for inserted relationship
+ */
+
+/**
+ * @typedef {Object} MergingSemantics
+ * @property {boolean} [forceOverwrite] - overwrite values for existing keys
+ * @property {MatchedNode[]} [additions] - matched nodes to be added from source template
+ * @property {Overwrites[]} [overwrites] - matched keys to be overwritten with given string
+ * @property {Deletion[]} [deletions] - matched nodes to be deleted
+ * @property {Relationship[]} [relationships] - relationships to be inserted
+ */
+
+/**
+ * @param {string | JSON} into - file path or JSON to merge into
+ * @param {string | JSON} from - file path or JSON to merge from
+ * @param {import('./projectReader').readProject} [project] - project descriptor used for Mustache replacements
+ * @param {MergingSemantics} [semantics] - merging algorithm semantics
+ * @returns {Promise<JSON>} - merged JSON
+ */
 async function mergeJSON(into, from, project, semantics) {
     const source = typeof from === 'string' ? await readJSON(from, project) : from
 
-    if (typeof into === 'string' && !exists(into)) {
-        return write(into, source, { spaces: 2 })
-    }
-
     let result
-    if (semantics) {
+    if (typeof into === 'string' && !exists(into)) {
+        result = source
+    } else if (semantics) {
         const target = await read(into)
         const targetYAML = YAML.parseDocument(YAML.stringify(target))
         const sourceYAML = YAML.parseDocument(YAML.stringify(source))
         const resultYAML = await mergeYAML(targetYAML, sourceYAML, project, semantics)
         result = YAML.parse(YAML.stringify(resultYAML))
     } else {
-        const target = typeof into === 'string' ? await read(into) : into
+        const target = typeof into === 'string' ? await read(into, 'json') : into
         result = _deepMerge(target, source)
     }
-    if (typeof into === 'string') await write(into, result, { spaces: 2 })
+    // we need to stringify result on site to be able to apply the appropriate indentation.
+    // cds-utils.write is currently hardcoded to use spaces for indentation.
+    if (typeof into === 'string') {
+        const indent = exists(into) && detectIndent((await read(into, 'utf-8')).split(EOL)) || '  '
+        await write(into, JSON.stringify(result, null, indent) + EOL)
+    }
     return result
 }
 
+/**
+ * @param {string | YAML.Document} into - file path or YAML to merge into
+ * @param {string | YAML.Document} from - file path or YAML to merge from
+ * @param {Object} [project] - project descriptor used for Mustache replacements
+ * @param {MergingSemantics} [semantics] - merging algorithm semantics
+ * @returns {Promise<YAML.Document>} - merged YAML
+ * @throws {Error} Throws an error if empty target YAML is passed in
+ */
 async function mergeYAML(into, from, project, semantics = {}) {
     const target = typeof into === 'string' ? await readYAML(into) : into instanceof YAML.Document ? into : new YAML.Document(into)
     const source = typeof from === 'string' ? await readYAML(from, project) : from instanceof YAML.Document ? from : new YAML.Document(from)
 
-    if (!target || !target.contents) {
+    if (!target?.contents) {
         if (typeof into === 'string' && typeof from === 'string') {
-            return project ? writeYAML(into, source) : copy(from, into)
+            project ? await writeYAML(into, source) : await copy(from, into)
+            return source
         }
-        return /* has no YAML */
+        throw new Error(`Target YAML doesn't exist`)
     }
 
     const entryMap = new Map, templateEntryMap = new Map()
@@ -148,7 +204,7 @@ async function mergeYAML(into, from, project, semantics = {}) {
 
         if (node.items) {
             if (YAML.isSeq(node) && templateNode?.items) {
-                actions?.mergeCollection && actions.mergeCollection(node, templateNode)
+                actions.mergeCollection?.(node, templateNode)
                 _traverseYAMLCollection(node, actions, templateNode)
             } else {
                 _traverseYAMLCollection(node, actions, templateNode)
@@ -194,12 +250,12 @@ async function mergeYAML(into, from, project, semantics = {}) {
                 const targetNode = collection.items?.[i]
                 if (targetNode) {
                     _traverseYAMLNode(targetNode, templateIndex, actions, templateNode)
-                } else if (actions.mergePair) {
-                    actions.mergePair(collection, templateNode)
+                } else {
+                    actions.mergePair?.(collection, templateNode)
                 }
             } else if (YAML.isMap(templateNode)) {
                 const targetNode = collection.items[templateIndexToIndex.get(templateIndex)]
-                if (actions.mergeCollection) actions.mergeCollection(targetNode, templateNode)
+                actions.mergeCollection?.(targetNode, templateNode)
                 if (targetNode) {
                     _traverseYAMLNode(targetNode, templateIndex, actions, templateNode)
                 }
@@ -266,7 +322,7 @@ async function mergeYAML(into, from, project, semantics = {}) {
                     .filter(addition => {
                         const keyPath = typeof addition.in === 'string' ? addition.in : Array.isArray(addition.in) && typeof addition.in[0] === 'string' ? addition.in[0] : addition.in[1]
                         const keys = keyPath.split('.')
-                        if (keys.length > collectionStack.length + 1) return
+                        if (keys.length > collectionStack.length + 1) return false
                         if (keys.length > 1) parent = collectionStack[keys.length]
                         return _getYAMLProperty(parent, keyPath) === targetNode
                     })

package/lib/init/util/mvn.js

@@ -1,13 +1,11 @@
 
-const { MAVEN_ARCHETYPE_VERSION, OPTIONS: { JAVA_MVN, JAVA_PACKAGE, SAMPLES, HANA }, REGEX_JAVA_PACKAGE } = require('../constants');
-
-const { CliError } = require('../../client/helper/errors');
-
+const { URLS, MAVEN_ARCHETYPE_VERSION, OPTIONS: { JAVA_MVN, JAVA_PACKAGE, SAMPLES, HANA }, REGEX_JAVA_PACKAGE } = require('../constants');
 
 const cp = require('child_process');
 const util = require('util');
 const execAsync = util.promisify(cp.exec);
-
+const term = require('../../util/term');
+const cmd = require('../../util/command');
 
 const DEFAULT_GROUP_ID = 'customer';
 
@@ -15,7 +13,6 @@ const LOG = console
 const cds = require('../../cds')
 const DEBUG = cds.debug('cli')
 
-
 class MvnArchetypeUtil {
 
     _scanMvnParams(mvnParams, params) {
@@ -51,11 +48,12 @@ class MvnArchetypeUtil {
         return Array.from(params, ([arg, val]) => val !== null && val !== undefined ? `${arg}=${val}` : arg)
     }
 
-    getAddSamplesCmdArgs(options) {
+    getAddSamplesCmdArgs() {
         const params = new Map();
 
         params.set(`com.sap.cds:cds-maven-plugin:${MAVEN_ARCHETYPE_VERSION}:addSample`);
 
+        const { options } = cds.cli
         if (options[JAVA_MVN]) {
             this._scanMvnParams(options[JAVA_MVN], params);
         }
@@ -67,11 +65,12 @@ class MvnArchetypeUtil {
         return this._finalize(params);
     }
 
-    getAddTestsCmdArgs(options) {
+    getAddTestsCmdArgs() {
         const params = new Map();
 
         params.set(`com.sap.cds:cds-maven-plugin:${MAVEN_ARCHETYPE_VERSION}:addIntegrationTest`);
 
+        const { options } = cds.cli
         if (options[JAVA_MVN]) {
             this._scanMvnParams(options[JAVA_MVN], params);
         }
@@ -83,14 +82,15 @@ class MvnArchetypeUtil {
         return this._finalize(params);
     }
 
-    getAddHanaCmdArgs(options) {
+    getAddHanaCmdArgs() {
         const params = new Map();
 
         params.set(`com.sap.cds:cds-maven-plugin:${MAVEN_ARCHETYPE_VERSION}:addTargetPlatform`);
         params.set(`-DtargetPlatform`, `cloudfoundry`);
 
-        if (options[JAVA_MVN]) {
-            this._scanMvnParams(options[JAVA_MVN], params);
+        const javaMvn = cds.cli.options[JAVA_MVN]
+        if (javaMvn) {
+            this._scanMvnParams(javaMvn, params);
         }
 
         return this._finalize(params);
@@ -100,7 +100,7 @@ class MvnArchetypeUtil {
         return packageName.toLowerCase().replace(/-/g, '_').replace(/\.([0-9])/g, '._$1').replace(/^([0-9])/, '_$1').replace(/\.+/g, '.');
     }
 
-    async getGenerateCmdArgs(projectName, options) {
+    async getGenerateCmdArgs(projectName, options = cds.cli.options) {
         const params = new Map();
 
         // set header
@@ -129,29 +129,27 @@ class MvnArchetypeUtil {
 
         // -DjdkVersion=[11|17]
         if (!params.get('-DjdkVersion')) {
+            let javaVersion
             try {
-                const javaVersion = await execAsync('java -version');
-                const match = javaVersion?.stderr?.match(/version\s*"?(\d+\.\d+\.\d+)"?/);
-                if (match?.[1]) {
-                    const segments = match[1]?.split('.');
-                    const version = new Number(segments?.[0]);
-                    switch (true) {
-                        case (version < 17):
-                            if (process.env.WS_BASE_URL) {
-                                throw new CliError(`Java version ${match[1]} is not supported. Use Java 17 or higher. You can use command 'Java: Set Default JDK' to switch to Java 17.`)
-                            }
-                            throw new CliError(`Java version ${match[1]} is not supported. Use Java 17 or higher.`)
-                        case (version < 20): params.set(`-DjdkVersion`, 17); break;
-                        case (version >= 20): params.set(`-DjdkVersion`, 20); break;
-                        default:
-                    }
-                }
+                javaVersion = await execAsync('java -version');
             } catch (err) {
-                if (err instanceof CliError) {
-                    throw err;
-                }
                 DEBUG?.(err);
             }
+            const match = javaVersion?.stderr?.match(/version\s*"?(\d+\.\d+\.\d+)"?/);
+            if (match?.[1]) {
+                const segments = match[1]?.split('.');
+                const version = new Number(segments?.[0]);
+                switch (true) {
+                    case (version < 17):
+                        if (process.env.WS_BASE_URL) {
+                            throw `Java version ${match[1]} is not supported. Use Java 17 or higher. You can use command 'Java: Set Default JDK' to switch to Java 17.`
+                        }
+                        throw `Java version ${match[1]} is not supported. Use Java 17 or higher.`
+                    case (version < 20): params.set(`-DjdkVersion`, 17); break;
+                    case (version >= 20): params.set(`-DjdkVersion`, 20); break;
+                    default:
+                }
+            }
         }
 
         if (options[JAVA_PACKAGE]) {
@@ -184,6 +182,17 @@ class MvnArchetypeUtil {
             artifactId
         };
     }
+
+    async execMvn(args) {
+        try {
+            await cmd.spawnCommand('mvn', args, { cwd: cds.root });
+        } catch (err) {
+            if (err.code === 'ENOENT' && err.path === 'mvn') {
+                throw `Maven executable 'mvn' not found, follow ${term.info(URLS.MAVEN_INSTALL_HELP)} and install Maven on your machine.`;
+            }
+            throw err;
+        }
+    }
 }
 
 module.exports = new MvnArchetypeUtil();