@sap/cds-dk 4.6.4 → 4.8.0

package/lib/init/template/approuter/files/default-env.json

@@ -0,0 +1,9 @@
+{
+  "destinations": [
+    {
+      "name": "srv-api",
+      "url": "http://localhost:4004",
+      "forwardAuthToken": true
+    }
+  ]
+}

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

@@ -0,0 +1,48 @@
+---
+modules:
+  - name: {{cap.appName}}-srv
+    type: {{cap.pLanguage}}
+    requires:
+      - name: {{cap.appName}}-uaa
+
+  - name: {{cap.appName}}
+    type: approuter.nodejs
+    path: {{& ui.appPath}} # from cds.env.folders. Consider also cds.env.build.target --> gen/app
+    parameters:
+      keep-existing-routes: true
+      disk-quota: 256M
+      memory: 256M
+      # hosts: # additional tenant specific hostnames (only for Canary)
+      ## the developer will do this via an extension descriptor:
+      # - <paas-subdomain >${tenant-delimiter}${host}
+      # - <saas-subdomain1>${tenant-delimiter}${host}
+      # - ...
+    {{#cap.isMultitenant}}
+    properties:
+      TENANT_HOST_PATTERN: "^(.*)-${default-uri}"
+    {{/cap.isMultitenant}}
+    requires:
+    - name: srv-api
+      group: destinations
+      properties:
+        name: srv-api # this is a name which must be used in xs-app.json as well
+        url: ~{srv-url}
+        forwardAuthToken: true
+    {{#cap.isMultitenant}}
+    - name: mtx-api # in here always, but really used only if mtx client is used (our recommendation is that they contact cds-mtx via the approuter)
+      group: destinations
+      properties:
+        name: mtx-api # this is a name which must be used in xs-app.json as well
+        url: ~{mtx-url}
+    {{/cap.isMultitenant}}
+
+resources:
+ - name: {{cap.appName}}-uaa{{#cap.isMultitenant}}-mt{{/cap.isMultitenant}}
+   type: org.cloudfoundry.managed-service
+   parameters:
+     service: xsuaa
+     service-plan: application
+     path: ./xs-security.json
+     config:
+       xsappname: {{cap.appName}}-${org}-${space}
+       tenant-mode: {{#cap.isMultitenant}}shared{{/cap.isMultitenant}}{{^cap.isMultitenant}}dedicated{{/cap.isMultitenant}}

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

@@ -0,0 +1,9 @@
+{
+  "name": "approuter",
+  "dependencies": {
+    "@sap/approuter": "^10"
+  },
+  "scripts": {
+    "start": "node node_modules/@sap/approuter/approuter.js"
+  }
+}

package/lib/init/template/approuter/files/xs-app.json

@@ -0,0 +1,8 @@
+{
+  "routes": [
+    {
+      "source": "^.*$",
+      "destination": "srv-api"
+    }
+  ]
+}

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

@@ -0,0 +1,66 @@
+const TemplateBase = require('../templateBase');
+const ProjectReader = require('../../util/projectReader');
+const { fse } = require('@sap/cds-foss');
+const path = require('path');
+const { OPTION_XSUAA } = require('../../constants');
+const { srvNode, srvJava, approuter, xsuaa } = require('../_merging/existences');
+
+module.exports = class ApprouterTemplate extends TemplateBase {
+    constructor(projectPath, generator) {
+        super(projectPath, generator, __dirname);
+        this.projectReader = new ProjectReader(this);
+    }
+
+    async getDependencies() {
+        return [OPTION_XSUAA];
+    }
+
+    async runMTAMerging() {
+        const projectDescriptor = await this.projectReader.read(this.options);
+        const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
+        if (!fse.existsSync(mtaYAMLPath)) return;
+        const srv = projectDescriptor.cap.isNodejs ? srvNode : srvJava
+        await this.templateUtil.mergeYAML(
+            mtaYAMLPath,
+            `${__dirname}/files/mta.yaml.hbs`,
+            projectDescriptor,
+            {
+                existences: [srv, approuter, xsuaa],
+                relationships: [{
+                    in: srv.ref,
+                    inKeyPath: ["requires"],
+                    into: "name",
+                    existences: [xsuaa.ref],
+                    existenceKeyPath: ["name"],
+                }, {
+                    in: approuter.ref,
+                    inKeyPath: ["requires"],
+                    into: "name",
+                    existences: [xsuaa.ref],
+                    existenceKeyPath: ["name"],
+                }],
+            }
+        );
+    }
+
+    async run() {
+        const projectDescriptor = await this.projectReader.read(this.options);
+        const appPath = path.join(this.projectPath, projectDescriptor.ui.appPath)
+
+        await this.templateUtil.mergeJSON(
+            `${appPath}/package.json`,
+            `${__dirname}/files/package.json`
+        );
+
+        await this.templateUtil.mergeJSON(
+            `${appPath}/xs-app.json`,
+            `${__dirname}/files/xs-app.json`
+        );
+
+        await this.templateUtil.mergeJSON(
+            `${appPath}/default-env.json`,
+            `${__dirname}/files/default-env.json`
+        );
+        await this.runMTAMerging()
+    }
+}

package/lib/init/template/auditlog/files/dependencies.package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+      "@sap/audit-logging": "^5"
+  }
+}

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

@@ -0,0 +1,13 @@
+---
+modules:
+ - name: {{cap.appName}}-srv
+   type: {{cap.pLanguage}}
+   requires:
+    - name: {{cap.appName}}-auditlog
+
+resources:
+  - name: {{cap.appName}}-auditlog
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: auditlog-api
+      service-plan: default

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

@@ -0,0 +1,38 @@
+const TemplateBase = require('../templateBase');
+const ProjectReader = require('../../util/projectReader');
+const { fse } = require('@sap/cds-foss');
+const path = require('path');
+const { srvNode, srvJava, auditlog } = require('../_merging/existences');
+
+module.exports = class AuditlogTemplate extends TemplateBase {
+    constructor(projectPath, generator) {
+        super(projectPath, generator, __dirname);
+        this.projectReader = new ProjectReader(this);
+    }
+
+    async runMTAMerging() {
+        const projectDescriptor = await this.projectReader.read(this.options);
+        const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
+        if (!fse.existsSync(mtaYAMLPath)) return;
+        const srv = projectDescriptor.cap.isNodejs ? srvNode : srvJava
+        await this.templateUtil.mergeYAML(
+            mtaYAMLPath,
+            `${__dirname}/files/mta.yaml.hbs`,
+            projectDescriptor,
+            {
+                existences: [srv, auditlog],
+                relationships: [{
+                    in: srv.ref,
+                    inKeyPath: ["requires"],
+                    into: "name",
+                    existences: [auditlog.ref],
+                    existenceKeyPath: ["name"],
+                }],
+            }
+        );
+    }
+
+    async run() {
+        await this.runMTAMerging()
+    }
+}

package/lib/init/template/cf-manifest/index.js

@@ -1,6 +1,6 @@
 const path = require('path')
 const TemplateBase = require('../templateBase');
-const ProjectReader = require('../mta/projectReader')
+const ProjectReader = require('../../util/projectReader');
 
 const { OPTION_CF_MANIFEST } = require('../../constants')
 const MANIFEST = 'manifest'

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

@@ -11,16 +11,12 @@ module.exports = class DataTemplate extends TemplateBase {
   async run() {
     const env = await this.getEnv();
 
-    const prefix = (typeof this.options.for === 'string') // --for <prefix>
-      ? this.options.for
-      : '';
-    const prefixedWith = (definition) => definition.name === prefix || definition.name.startsWith(prefix);
-
     let dest = (typeof this.options.out === 'string') // target folder
       ? this.options.out
       : getDefaultTargetFolder(env, this.projectPath);
     dest = resolve(this.projectPath, dest);
 
+    const nameFilter = asRegex(this.options.for)
     const force = this.options.force;
     const logger = this.logger;
 
@@ -35,7 +31,7 @@ module.exports = class DataTemplate extends TemplateBase {
     csn = cds.reflect(csn); // reflected model (adds additional helper functions)
 
     csn.all('entity')
-      .filter(prefixedWith)
+      .filter (e => e.name.match(nameFilter)) // --for prefix|regex
       .filter (e => !e.query) // exclude entities with queries (projection on, select from ...)
       .filter (e => e.name !== 'DRAFT.DraftAdministrativeData' && !e.name.endsWith('.drafts')) // exclude draft stuff
       .forEach(e => processEntity(e, dest, this.projectPath, csn, force, logger));
@@ -53,6 +49,22 @@ function includeExternalEntities(model, logger) {
   return model
 }
 
+function asRegex(spec) {
+  if (typeof spec === 'string') {
+    try {
+      if (spec.match(/[\^$|*]/))
+        return new RegExp(spec)
+      else { // no meta chars -> prefix semantics
+        spec = spec.replace(/\./g, '\\.') // escape dot
+        return new RegExp('^'+spec+'.*')
+      }
+    } catch (err) {
+      throw new Error (err.message) // user error, so cut off stack trace
+    }
+  }
+  return /.*/
+}
+
 function processEntity (entity, dest, projectPath, csn, force, logger) {
   let dataFileName;
   const namespace = getNamespace(csn, entity.name);

package/lib/init/template/hana/files/common/undeploy.json

@@ -0,0 +1,5 @@
+[
+    "src/gen/**/*.hdbview",
+    "src/gen/**/*.hdbindex",
+    "src/gen/**/*.hdbconstraint"
+]

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

@@ -3,6 +3,9 @@
   "dependencies": {
     "@sap/hdi-deploy": "^4"
   },
+  "engines": {
+    "node": "^16"
+  },
   "scripts": {
     "start": "node node_modules/@sap/hdi-deploy/deploy.js"
   }

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

@@ -0,0 +1,42 @@
+---
+modules:
+  - name: {{cap.appName}}-srv
+    type: {{cap.pLanguage}}
+    requires:
+      - name: {{cap.appName}}-db
+
+{{^cap.isMultitenant}}
+  - name: {{cap.appName}}-db-deployer
+    type: hdb
+    path: {{& cap.db.0.path}}
+    parameters:
+      buildpack: nodejs_buildpack
+    requires:
+      - name: {{cap.appName}}-db
+{{/cap.isMultitenant}}
+
+{{#cap.hasRequires}}
+resources:
+{{#cap.requires}}
+{{#resource.isHana}}
+ - name: {{cap.appName}}-db
+{{#resource.isPlainHana}}
+   type: com.sap.xs.hdi-container
+   parameters:
+     service: {{resource.service}} # or 'hanatrial' on trial landscapes
+{{/resource.isPlainHana}}
+{{#resource.isManagedHana}} {{! enable automatic switching to 'hanatrial' on trial accounts}}
+   type: org.cloudfoundry.managed-service
+   parameters:
+     service: {{resource.service}}
+{{/resource.isManagedHana}}
+     service-plan: {{resource.vcap.plan}}
+{{#resource.vcap.name}}
+     service-name: {{resource.vcap.name}}
+{{/resource.vcap.name}}
+   properties:
+     hdi-service-name: ${service-name}
+{{/resource.isHana}}
+
+{{/cap.requires}}
+{{/cap.hasRequires}}

package/lib/init/template/hana/files/nodejs/dependencies.package.json

@@ -0,0 +1,5 @@
+{
+    "dependencies": {
+        "hdb": "^0.18.3"
+    }
+}

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

@@ -1,34 +1,22 @@
 const path = require('path');
 
+const { fse } = require('@sap/cds-foss');
+
 const commandUtil = require('../../util/commandUtil');
 const mvnArchetypes = require('../../util/mvnArchetypeUtil');
 const term = require('../../../util/term');
+const ProjectReader = require('../../util/projectReader');
 
 const TemplateBase = require('../templateBase');
 
 const { PROJECT_TYPE, OPTION_JAVA, KIND_SQL, URLS, KIND_HANA } = require('../../constants');
 const { nullLogger } = require('../../util/logger');
-
+const { srvNode, srvJava, hdbDeployer, serviceManager, hdiContainer } = require('../_merging/existences');
 
 module.exports = class HanaTemplate extends TemplateBase {
     constructor(projectPath, generator) {
         super(projectPath, generator, __dirname);
-    }
-
-    async checkEnabled() {
-        if (this.options.force) {
-            return true;
-        }
-
-        const env = await this.getEnv();
-
-        const hdiConfigPath = path.join(this.projectPath, env.folders.db, 'src/.hdiconfig');
-        if (await this.fsUtil.pathExists(hdiConfigPath)) {
-            const configFilePath = path.join(env.folders.db, 'src/.hdiconfig');
-            throw new Error(`Database config file ${configFilePath} already exists. Use --force to overwrite.`);
-        }
-
-        return true;
+        this.projectReader = new ProjectReader(this);
     }
 
     // read env from project
@@ -42,28 +30,69 @@ module.exports = class HanaTemplate extends TemplateBase {
         }
     }
 
+    async runMTAMerging() {
+        const projectDescriptor = await this.projectReader.read(this.options);
+
+        const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
+        if (!fse.existsSync(mtaYAMLPath)) {
+            console.warn(`There is no MTA file in your project. Run \`cds add mta\` to add an MTA file or create the HANA services yourself.`)
+            return;
+        }
+        const srv = projectDescriptor.cap.isNodejs ? srvNode : srvJava
+        const deployer = projectDescriptor.cap.isMultitenant ? null : hdbDeployer
+        const db = projectDescriptor.cap.isMultitenant ? serviceManager : hdiContainer
+        await this.templateUtil.mergeYAML(
+            mtaYAMLPath,
+            `${__dirname}/files/mta.yaml.hbs`,
+            projectDescriptor,
+            {
+                existences: [srv, deployer, db],
+                relationships: [{
+                    in: srv.ref,
+                    inKeyPath: ["requires"],
+                    into: "name",
+                    existences: [db.ref],
+                    existenceKeyPath: ["name"],
+                },
+                !projectDescriptor.cap.isMultitenant && projectDescriptor.cap.isNodejs ?
+                {
+                    in: deployer.ref,
+                    inKeyPath: ["requires"],
+                    into: "name",
+                    existences: [db.ref],
+                    existenceKeyPath: ["name"],
+                } : null],
+            }
+        );
+    }
+
     async run() {
         const env = await this.getEnv();
 
-        await this.templateUtil.copyFiles('common', path.join(this.projectPath, env.folders.db), {
-            projectName: this.projectName
-        }, this.options.force);
+        const hdiConfigPath = path.join(this.projectPath, env.folders.db, 'src', '.hdiconfig');
+        const hdiConfigTemplatePath = path.join(__dirname, 'files', 'common', 'src', '.hdiconfig');
+        await this.templateUtil.mergeJSON(hdiConfigPath, hdiConfigTemplatePath);
+
+        const undeployJSONPath = path.join(this.projectPath, env.folders.db, 'undeploy.json');
+        const undeployJSONTemplatePath = path.join(__dirname, 'files', 'common', 'undeploy.json');
+        await this.templateUtil.mergeJSON(undeployJSONPath, undeployJSONTemplatePath);
 
-        const cdsrcJsonPath = path.join(this.projectPath, '.cdsrc.json');
         const projectType = await this.getProjectType();
         switch (projectType) {
-            case PROJECT_TYPE.java:
+            case PROJECT_TYPE.java: {
                 await this.templateUtil.copyFiles('java', 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);
                 break;
-
+            }
             case PROJECT_TYPE.nodejs:
                 await this._updatePackageJson(path.join(this.projectPath, 'package.json'), env.folders.db, env);
                 break;
 
             default: break;
         }
+        await this.runMTAMerging()
     }
 
     async _updatePomXml() {
@@ -158,6 +187,6 @@ module.exports = class HanaTemplate extends TemplateBase {
     }
 
     _isUsingHana(db, env) {
-        return env.get(`requires.${db}.kind`) === KIND_HANA || env.get(`requires.${db}.dialect`) === KIND_HANA || env.get(`requires.${db}.use`) === KIND_HANA;
+        return [`kind`, `dialect`, `use`].map(p => env.get(`requires.${db}.${p}`)).includes(KIND_HANA)
     }
 }

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

@@ -9,7 +9,7 @@ const mvnArchetypeUtil = require('../../util/mvnArchetypeUtil');
 const term = require('../../../util/term');
 
 const TemplateBase = require('../templateBase');
-const { COMMAND_ADD, URLS, OPTION_JAVA, OPTION_NODEJS, OPTION_MTX } = require('../../constants');
+const { COMMAND_ADD, URLS, OPTION_JAVA, OPTION_NODEJS } = require('../../constants');
 const { nullLogger } = require('../../util/logger');
 
 
@@ -27,10 +27,6 @@ module.exports = class JavaTemplate extends TemplateBase {
             throw new Error(`Only one runtime per project is supported. Specify either ${OPTION_JAVA} or ${OPTION_NODEJS}.`);
         }
 
-        if (this.options.add.has(OPTION_MTX)) {
-            throw new Error(`The '${OPTION_MTX}' option can only be used for Node.js projects as of yet.`);
-        }
-
         return true;
     }
 

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

@@ -9,10 +9,15 @@ const readline = require("readline");
 
 const { OPTION_LINT_DEV, OPTION_LINT_GLOBAL } = require("../../constants");
 const { mkdirp, fs } = require("@sap/cds/lib/utils");
-const { getConfigPath } = require("@sap/eslint-plugin-cds/lib/api");
+const { getConfigPath, getFileExtensions } = require("@sap/eslint-plugin-cds/lib/api");
 const generators = require("../../../lint/generators");
 
 const IS_WIN = os.platform() === "win32";
+const ALLOWED_FILE_EXTENSIONS = getFileExtensions();
+const VSCODE_FILE_ASSOCIATIONS = {
+  "csv": [ "csv", "csv (semicolon)", "tsv", "tab" ]
+}
+
 module.exports = class LintTemplate extends TemplateBase {
   constructor(projectPath, generator) {
     super(projectPath, generator, __dirname);
@@ -68,10 +73,21 @@ module.exports = class LintTemplate extends TemplateBase {
       }
 
       // Generate VS Code extension settings
+      const extensions = 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.push(assoc)
+          })
+        }
+      });
       await io.sanitizeVscodeSettings(
         this.projectPath,
         path.join(this.projectPath, ".vscode/settings.json"),
         this.lintType,
+        extensions,
         this.customRuleExample
       );
     }