@sap/cds-dk 6.0.2 → 6.1.1

package/lib/init/template/extensibility/files/cds.package.json.hbs

@@ -0,0 +1,9 @@
+{
+  "cds": {
+    "requires": {
+      "[{{cap.for}}]": {
+        "extensibility": true
+      }
+    }
+  }
+}

package/lib/init/template/extensibility/files/xs-security.json.hbs

@@ -0,0 +1,26 @@
+{
+  "scopes": [
+    {
+      "name": "$XSAPPNAME.cds.ExtensionDeveloper",
+      "description": "Extend CAP applications via extension projects"
+    },
+    {
+      "name": "$XSAPPNAME.cds.UIFlexDeveloper",
+      "description": "Extend CAP applications via UIFlex extensibility"
+    }
+  ],
+  "role-templates": [
+    {
+      "name": "ExtensionDeveloper",
+      "description": "Extension development including UIFlex extensibility",
+      "scope-references": [
+        "$XSAPPNAME.cds.ExtensionDeveloper",
+        "$XSAPPNAME.cds.UIFlexDeveloper"
+      ]
+    }
+  ],
+  "authorities": [
+    "$XSAPPNAME.cds.ExtensionDeveloper",
+    "$XSAPPNAME.cds.UIFlexDeveloper"
+  ]
+}

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

@@ -0,0 +1,48 @@
+const cds = require('../../../cds'), { path } = cds.utils
+const TemplateBase = require('../templateBase')
+const ProjectReader = require('../../util/projectReader')
+
+module.exports = class ExtensibilityTemplate extends TemplateBase {
+  constructor(projectPath, generator) {
+    super(projectPath, generator, __dirname)
+    this.projectReader = new ProjectReader(this)
+  }
+
+  async runDependentMerging() {
+    const projectDescriptor = await this.projectReader.read()
+    const { hasXsuaa } = projectDescriptor.cap
+    if (hasXsuaa) {
+      await this.templateUtil.mergeJSON(
+        path.join(this.projectPath, 'xs-security.json'),
+        path.join(__dirname, 'files', 'xs-security.json.hbs'),
+        projectDescriptor,
+        {
+          additions: [{
+            ref: 'scope-extension-developer',
+            in: 'scopes',
+            where: [{ property: 'name', isEqualTo: '$XSAPPNAME.cds.ExtensionDeveloper' }],
+          }, {
+            ref: 'scope-uiflex',
+            in: 'scopes',
+            where: [{ property: 'name', isEqualTo: '$XSAPPNAME.cds.UIFlexDeveloper' }],
+          }, {
+            ref: 'template-extension-developer',
+            in: 'role-templates',
+            where: [{ property: 'name', isEqualTo: 'ExtensionDeveloper' }],
+          }]
+        }
+      )
+    }
+  }
+
+  async run() {
+    const projectDescriptor = await this.projectReader.read(this.options)
+    const { for: forProfile, isJava } = projectDescriptor.cap
+    const basePath = isJava ? path.join(this.projectPath, 'mtx', 'sidecar') : this.projectPath
+    const packageJSONPath = path.join(basePath, 'package.json')
+    const cdsTemplateFile = forProfile ? 'cds.package.json.hbs' : 'cds.package.json'
+    await this.templateUtil.mergeJSON(packageJSONPath, path.join(__dirname, 'files', cdsTemplateFile), projectDescriptor)
+    await this.templateUtil.sortDependencies(packageJSONPath)
+    await this.runDependentMerging()
+  }
+}

package/lib/init/template/hana/files/java/cdsrc.json.hbs

@@ -1,7 +1,7 @@
 {
   "requires": {
     "db": {
-      "kind": { "#overwrite": "{{#cap.isMultitenant}}hana-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}" }
+      "kind": "{{#cap.isMultitenant}}hana-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}"
     }
   }
 }

package/lib/init/template/hana/files/java/profile.cdsrc.json.hbs

@@ -2,11 +2,11 @@
   "requires": {
     "[{{cap.for}}]": {
       "db": {
-        "kind": { "#overwrite": "{{#cap.isMultitenant}}hana-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}" }
+        "kind": "{{#cap.isMultitenant}}hana-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}"
       }
     },
     "db": {
-      "kind": "sql"
+      "kind": "{{#cap.isMultitenant}}sqlite{{/cap.isMultitenant}}{{^cap.isMultitenant}}sql{{/cap.isMultitenant}}"
     }
   }
 }

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

@@ -15,6 +15,16 @@ modules:
       - name: {{cap.appName}}-db
 {{/cap.isMultitenant}}
 
+{{#cap.isJava}}
+{{#cap.isMultitenant}}
+  - name: {{cap.appName}}-mtx-sidecar
+    type: nodejs
+    path: mtx/sidecar
+    requires:
+      - name: {{cap.appName}}-db
+{{/cap.isMultitenant}}
+{{/cap.isJava}}
+
 resources:
   - name: {{cap.appName}}-db
     {{^cap.isMultitenant}}

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

@@ -2,7 +2,7 @@
   "cds": {
     "requires": {
       "db": {
-        "kind": { "#overwrite": "{{#cap.isMultitenant}}hana-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}" }
+        "kind": "{{#cap.isMultitenant}}sql-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}"
       }
     }
   }

package/lib/init/template/hana/files/nodejs/cds.profile.package.json.hbs

@@ -3,11 +3,11 @@
     "requires": {
       "[{{cap.for}}]": {
         "db": {
-          "kind": { "#overwrite": "{{#cap.isMultitenant}}hana-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}" }
+          "kind": "{{#cap.isMultitenant}}hana-mt{{/cap.isMultitenant}}{{^cap.isMultitenant}}hana-cloud{{/cap.isMultitenant}}"
         }
       },
       "db": {
-        "kind": "sql"
+        "kind": "{{#cap.isMultitenant}}sqlite{{/cap.isMultitenant}}{{^cap.isMultitenant}}sql{{/cap.isMultitenant}}"
       }
     }
   }

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

@@ -7,10 +7,11 @@ const term = require('../../../util/term');
 const ProjectReader = require('../../util/projectReader');
 
 const TemplateBase = require('../templateBase');
+const versionCompare = require('../../util/versionCompare');
 
 const { PROJECT_TYPE, OPTION_JAVA, URLS, OPTION_HELM_UPDATE } = require('../../constants');
 const { nullLogger } = require('../../util/logger');
-const { srvNode, srvJava, hdbDeployer, serviceManager, hdiContainer } = require('../_merging/existences');
+const { srvNode, srvJava, hdbDeployer, serviceManager, hdiContainer, mtxSidecar } = require('../_merging/registry-mta');
 
 module.exports = class HanaTemplate extends TemplateBase {
     constructor(projectPath, generator) {
@@ -34,66 +35,70 @@ module.exports = class HanaTemplate extends TemplateBase {
     }
 
     async checkEnabled() {
-        const { lt } = require('semver')
         const cds = require('../../../cds')
-        if (lt(cds.version, '5.9.0')) {
+        if (versionCompare(cds.version, '5.9.0') < 0) {
             cds.error('The added configuration requires @sap/cds 5.9.0 or higher. Please update @sap/cds to the latest version and run \x1b[1mcds add hana\x1b[0m again.')
         }
         return true
     }
 
     async runDependentMerging() {
-        const projectDescriptor = await this.projectReader.read(this.options);
+        const projectDescriptor = await this.projectReader.read(this.options)
+        const { hasMtaDeployment, isNodejs, isJava, isMultitenant, hasHana } = projectDescriptor.cap
+
+        if (isNodejs && isMultitenant) {
+            await this._updateCdsConfiguration()
+        } else if (isJava && isMultitenant) {
+            await this._updateCdsrcJson()
+        }
 
-        const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
+        if (hasMtaDeployment) {
+            const srv = isNodejs ? srvNode : srvJava
+            const db = isMultitenant ? serviceManager : hdiContainer
+            const deletions = isMultitenant ? [{
+                item: hdbDeployer,
+                relationships: [{
+                    removeProperty: 'name',
+                    allWithin: ['modules', 'requires', 'name'],
+                }]
+            }, {
+                item: hdiContainer,
+                relationships: [{
+                    removeProperty: 'name',
+                    allWithin: ['modules', 'requires', 'name'],
+                }]
+            }] : []
 
-        if (!fs.existsSync(mtaYAMLPath)) return
+            const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml')
 
-        const srv = projectDescriptor.cap.isNodejs ? srvNode : srvJava
-        const deployer = projectDescriptor.cap.isMultitenant ? null : hdbDeployer
-        const db = projectDescriptor.cap.isMultitenant ? serviceManager : hdiContainer
-        const deletions = projectDescriptor.cap.isMultitenant ? [{
-            existence: hdbDeployer,
-            relationships: [{
-                allWithinKeyPath: ["modules"],
-                inKeyPath: ["requires"],
-                into: "name",
-                existenceKeyPath: ["name"],
-            }]
-        }, {
-            existence: hdiContainer,
-            relationships: [{
-                allWithinKeyPath: ["modules"],
-                inKeyPath: ["requires"],
-                into: "name",
-                existenceKeyPath: ["name"],
+            const relationships = [{
+                insert: [db, 'name'],
+                into: [srv, 'requires', 'name']
             }]
-        }] : []
-
-        await this.templateUtil.mergeYAML(
-            mtaYAMLPath,
-            `${__dirname}/files/mta.yaml.hbs`,
-            projectDescriptor,
-            {
-                existences: [srv, deployer, db],
-                relationships: [{
-                    in: srv,
-                    inKeyPath: ["requires"],
-                    into: "name",
-                    existences: [db],
-                    existenceKeyPath: ["name"],
-                },
-                !projectDescriptor.cap.isMultitenant && projectDescriptor.cap.isNodejs ?
-                    {
-                        in: deployer,
-                        inKeyPath: ["requires"],
-                        into: "name",
-                        existences: [db],
-                        existenceKeyPath: ["name"],
-                    } : null],
-                deletions
+
+            if (!isMultitenant) {
+                relationships.push({
+                    insert: [hdiContainer, 'name'],
+                    into: [hdbDeployer, 'requires', 'name']
+                })
+            }
+
+            if (isJava && isMultitenant) {
+                relationships.push({
+                    insert: [serviceManager, 'name'],
+                    into: [mtxSidecar, 'requires', 'name']
+                })
             }
-        );
+
+            const modules = !isMultitenant ? [srv, hdbDeployer] : [srv]
+
+            await this.templateUtil.mergeYAML(
+                mtaYAMLPath,
+                `${__dirname}/files/mta.yaml.hbs`,
+                projectDescriptor,
+                { additions: [...modules, db].filter(a => a), deletions, relationships }
+            )
+        }
     }
 
     async run() {
@@ -112,14 +117,13 @@ module.exports = class HanaTemplate extends TemplateBase {
             case PROJECT_TYPE.java: {
                 await this.templateUtil.copyFiles(path.join('java', 'db'), path.join(this.projectPath, env.folders.db), {}, this.options.force);
                 await this._updatePomXml();
-                const cdsrcJsonPath = path.join(this.projectPath, '.cdsrc.json');
-                await this._updateCdsrcJson(cdsrcJsonPath, env.folders.db, env);
+                await this._updateCdsrcJson();
                 break;
             }
-            case PROJECT_TYPE.nodejs:
-                await this._updatePackageJson(path.join(this.projectPath, 'package.json'));
+            case PROJECT_TYPE.nodejs: {
+                await this._updatePackageJson()
                 break;
-
+            }
             default: break;
         }
         await this.runDependentMerging()
@@ -142,29 +146,38 @@ module.exports = class HanaTemplate extends TemplateBase {
         }
     }
 
-    async _updatePackageJson(packageJsonPath) {
-        const projectDescriptor = await this.projectReader.read(this.options);
+    async _updatePackageJson() {
+        const packageJsonPath = path.join(this.projectPath, 'package.json')
         const dependenciesTemplatePath = path.join(__dirname, 'files', 'nodejs', 'dependencies.package.json');
         await this.templateUtil.mergeJSON(packageJsonPath, dependenciesTemplatePath);
 
-        const cdsTemplateFile = projectDescriptor.cap.for ? 'cds.profile.package.json.hbs' : 'cds.package.json.hbs';
-        const cdsTemplatePath = path.join(__dirname, 'files', 'nodejs', cdsTemplateFile);
-        await this.templateUtil.mergeJSON(packageJsonPath, cdsTemplatePath, projectDescriptor);
-
         const packageJson = await this.fsUtil.readJSON(packageJsonPath);
         if (packageJson.dependencies['@sap/hana-client']) {
             delete packageJson.dependencies['@sap/hana-client'];
             await this.fsUtil.writeJSON(packageJsonPath, packageJson);
         }
+
+        await this._updateCdsConfiguration(packageJsonPath)
+    }
+
+    async _updateCdsConfiguration() {
+        const packageJsonPath = path.join(this.projectPath, 'package.json')
+        const projectDescriptor = await this.projectReader.read(this.options);
+        const { for: forProfile } = projectDescriptor.cap;
+        const cdsTemplateFile = forProfile ? 'cds.profile.package.json.hbs' : 'cds.package.json.hbs';
+        const cdsTemplatePath = path.join(__dirname, 'files', 'nodejs', cdsTemplateFile);
+        await this.templateUtil.mergeJSON(packageJsonPath, cdsTemplatePath, projectDescriptor, { forceOverwrite: true })
     }
 
-    async _updateCdsrcJson(cdsrcJsonPath) {
+    async _updateCdsrcJson() {
+        const cdsrcJsonPath = path.join(this.projectPath, '.cdsrc.json');
         const projectDescriptor = await this.projectReader.read(this.options);
-        const cdsTemplateFile = projectDescriptor.cap.for ? 'profile.cdsrc.json.hbs' : 'cdsrc.json.hbs';
+        const { for: forProfile } = projectDescriptor.cap;
+        const cdsTemplateFile = forProfile ? 'profile.cdsrc.json.hbs' : 'cdsrc.json.hbs';
         const cdsTemplatePath = path.join(__dirname, 'files', 'java', cdsTemplateFile);
         if (!fs.existsSync(cdsrcJsonPath)) {
             this.fsUtil.writeJSON(cdsrcJsonPath, {})
         }
-        await this.templateUtil.mergeJSON(cdsrcJsonPath, cdsTemplatePath, projectDescriptor);
+        await this.templateUtil.mergeJSON(cdsrcJsonPath, cdsTemplatePath, projectDescriptor, { forceOverwrite: true });
     }
 }

package/lib/init/template/kibana-logging/index.js

@@ -1,59 +1,53 @@
 const cds = require('../../../cds')
-const fs = require('fs');
-const path = require('path');
+const path = require('path')
 
-const ProjectReader = require('../../util/projectReader');
-
-const TemplateBase = require('../templateBase');
-
-const { PROJECT_TYPE, } = require('../../constants');
-const { srvNode, srvJava, kibanaLogging } = require('../_merging/existences');
+const ProjectReader = require('../../util/projectReader')
+const TemplateBase = require('../templateBase')
+const { PROJECT_TYPE, } = require('../../constants')
+const { srvNode, srvJava, kibanaLogging } = require('../_merging/registry-mta')
 
 module.exports = class KibanaTemplate extends TemplateBase {
     constructor(projectPath, generator) {
-        super(projectPath, generator, __dirname);
-        this.projectReader = new ProjectReader(this);
+        super(projectPath, generator, __dirname)
+        this.projectReader = new ProjectReader(this)
     }
 
     async runDependentMerging() {
-        const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
-
-        if (!fs.existsSync(mtaYAMLPath)) {
-            return;
+        const projectDescriptor = await this.projectReader.read(this.options)
+        const { hasMtaDeployment, isNodejs } = projectDescriptor.cap
+
+        if (hasMtaDeployment) {
+            const srv = isNodejs ? srvNode : srvJava
+
+            const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml')
+            await this.templateUtil.mergeYAML(
+                mtaYAMLPath,
+                `${__dirname}/files/mta.yaml.hbs`,
+                projectDescriptor,
+                {
+                    additions: [srv, kibanaLogging],
+                    relationships: [{
+                        insert: [kibanaLogging, 'name'],
+                        into: [srv, 'requires', 'name']
+                    }],
+                }
+            )
         }
-
-        const projectDescriptor = await this.projectReader.read(this.options);
-        const srv = projectDescriptor.cap.isNodejs ? srvNode : srvJava
-
-        await this.templateUtil.mergeYAML(
-            mtaYAMLPath,
-            `${__dirname}/files/mta.yaml.hbs`,
-            projectDescriptor,
-            {
-                existences: [srv, kibanaLogging],
-                relationships: [{
-                    in: srv,
-                    inKeyPath: ["requires"],
-                    into: "name",
-                    existences: [kibanaLogging],
-                    existenceKeyPath: ["name"],
-                }],
-            }
-        );
     }
 
     async run() {
-        const projectType = await this.getProjectType();
+        const projectType = await this.getProjectType()
 
         switch (projectType) {
             case PROJECT_TYPE.java:
             default:
-                cds.error(`kibana-logging is not implemented for project type '${projectType}' yet`);
+                cds.error(`kibana-logging is not implemented for project type '${projectType}' yet`)
                 // TODO: implement
-                break;
+                break
             case PROJECT_TYPE.nodejs: {
                 const projectDescriptor = await this.projectReader.read(this.options);
-                const cdsTemplateFile = projectDescriptor.cap.for ? 'cds.profile.package.json.hbs' : 'cds.package.json'
+                const { for: forProfile } = projectDescriptor.cap
+                const cdsTemplateFile = forProfile ? 'cds.profile.package.json.hbs' : 'cds.package.json'
                 const cdsTemplatePath = path.join(__dirname, 'files', cdsTemplateFile)
                 await this.templateUtil.mergeJSON(path.join(this.projectPath, 'package.json'), cdsTemplatePath, projectDescriptor)
             }

package/lib/init/template/lint/files/.eslint/rules/no-entity-moo.js

@@ -1,4 +1,4 @@
-module.exports = require("@sap/eslint-plugin-cds/lib/api").createRule({
+module.exports = require("@sap/eslint-plugin-cds").createRule({
   meta: {
     docs: {
       description: `Demonstrates how to implement a model validation check.
@@ -11,30 +11,30 @@ module.exports = require("@sap/eslint-plugin-cds/lib/api").createRule({
                       (__)\       )\/\
                           ||----w |
                           ||     ||`,
-      version: "1.0.0",
+      version: "1.0.0"
     },
-    fixable: "code",
+    fixable: "code"
   },
   create: function (context) {
-    const m = context.cds.model;
-    m.forall("entity", (d) => {
-      const entityName = d.name.split(".").pop();
+    return { entity: checkForMoo };
+
+    function checkForMoo(e) {
+      const entityName = e.name.split(".").pop();
       if (entityName === "Moo") {
-        const loc = context.cds.getLocation(entityName, d);
+        const loc = context.getLocation(entityName, e);
         const fix = (fixer) => {
-          const rangeEnd = context.sourcecode.getIndexFromLoc({
+          const rangeEnd = context.getSourceCode().getIndexFromLoc({
             line: loc.end.line,
-            column: loc.end.column,
+            column: loc.end.column
           });
           return fixer.insertTextAfterRange([0, rangeEnd], "n");
         };
         context.report({
           message: "Entity 'Moo' not allowed!",
-          loc,
-          fix,
-          file: d.$location.file,
+          node: context.getNode(e),
+          fix
         });
       }
-    });
-  },
+    }
+  }
 })

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

@@ -8,7 +8,7 @@ const io = require("../../../lint/io");
 const readline = require("readline");
 
 const { OPTION_LINT_DEV, OPTION_LINT_GLOBAL } = require("../../constants");
-const { mkdirp, fs } = require("@sap/cds/lib/utils");
+const { mkdirp, fs } = require("@sap/cds").utils;
 const { getConfigPath, getFileExtensions } = require("@sap/eslint-plugin-cds/lib/api");
 const generators = require("../../../lint/generators");
 

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

@@ -9,7 +9,7 @@ build-parameters:
   before-all:
     - builder: custom
       commands:
-        - npx -p @sap/cds-dk cds build --production
+        - npx -p @sap/cds-dk{{#cap.isJava}}@^6{{/cap.isJava}} cds build --production
 
 modules:
   - name: {{cap.appName}}-srv

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

@@ -11,6 +11,7 @@ module.exports = class MtaTemplate extends TemplateBase {
 
     async run() {
         const projectDescriptor = await this.projectReader.read();
+        const { hasApprouter, hasHana, hasXsuaa, isMultitenant, isExtensible } = projectDescriptor.cap;
         if (!existsSync(join(this.projectPath, 'mta.yaml'))) {
             await this.templateUtil.copyFiles('.', this.projectPath, projectDescriptor);
         }
@@ -18,25 +19,30 @@ module.exports = class MtaTemplate extends TemplateBase {
         // Re-applying the merging part of `cds add xsuaa`, `cds add hana`, and `cds add mtx`, if necessary.
         // TODO: Find a generic solution for situation like these. Probably involves some restructuring in the
         // project reader, so that there's a logical mapping from hasX to XTemplate.
-        if (projectDescriptor.cap.hasApprouter) {
+        if (hasApprouter) {
             const ApprouterTemplate = require(`../approuter`)
             const template = new ApprouterTemplate(this.projectPath, this.generator)
             await template.runDependentMerging()
         }
-        if (projectDescriptor.cap.hasHana) {
+        if (hasHana) {
             const HanaTemplate = require(`../hana`)
             const template = new HanaTemplate(this.projectPath, this.generator)
             await template.runDependentMerging()
         }
-        if (projectDescriptor.cap.hasXsuaa) {
+        if (hasXsuaa) {
             const XsuaaTemplate = require(`../xsuaa`)
             const template = new XsuaaTemplate(this.projectPath, this.generator)
             await template.runDependentMerging()
         }
-        if (projectDescriptor.cap.isMultitenant) {
-            const MtxTemplate = require(`../mtx`)
-            const template = new MtxTemplate(this.projectPath, this.generator)
+        if (isMultitenant) {
+            const MultitenancyTemplate = require(`../multitenancy`)
+            const template = new MultitenancyTemplate(this.projectPath, this.generator)
+            await template.runDependentMerging()
+        }
+        if (isExtensible) {
+            const ExtensibilityTemplate = require(`../extensibility`)
+            const template = new ExtensibilityTemplate(this.projectPath, this.generator)
             await template.runDependentMerging()
         }
     }
-};
+}