@sap/cds-dk 6.8.3 → 7.0.0

package/lib/init/constants.js

@@ -1,6 +1,6 @@
 const os = require('os');
 
-const MAVEN_ARCHETYPE_VERSION = '1.34.0';
+const MAVEN_ARCHETYPE_VERSION = '2.0.1';
 
 const constants = {
     IS_WIN: (os.platform() === 'win32'),
@@ -10,40 +10,43 @@ const constants = {
 
     MAVEN_ARCHETYPE_VERSION,
 
-    OPTION_NODEJS: 'nodejs',
-    OPTION_JAVA: 'java',
-    OPTION_HANA: 'hana',
-    OPTION_SQLITE: 'sqlite',
-    OPTION_XSUAA: 'xsuaa',
-    OPTION_DESTINATIONS: 'destinations',
-    OPTION_MTA: 'mta',
-    OPTION_MTX: 'mtx',
-    OPTION_MULTITENANCY: 'multitenancy',
-    OPTION_TOGGLES: 'toggles',
-    OPTION_EXTENSIBILITY: 'extensibility',
-    OPTION_AUDITLOG: 'auditlog',
-    OPTION_ENTERPRISE_MESSAGING: 'enterprise-messaging',
-    OPTION_ENTERPRISE_MESSAGING_SHARED: 'enterprise-messaging-shared',
-    OPTION_FILE_BASED_MESSAGING: 'file-based-messaging',
-    OPTION_REDIS_MESSAGING: 'redis-messaging',
-    OPTION_APPROUTER: 'approuter',
-    OPTION_KIBANA_LOGGING: 'kibana-logging',
-    OPTION_CF_MANIFEST: 'cf-manifest',
-    OPTION_PIPELINE: 'pipeline',
-    OPTION_SAMPLES: 'samples',
-    OPTION_DATA: 'data',
-    OPTION_NOTEBOOK: 'notebook',
-    OPTION_LINT: 'lint',
-    OPTION_LINT_GLOBAL: 'lint:global',
-    OPTION_LINT_DEV: 'lint:dev',
-    OPTION_JAVA_PACKAGE: 'java:package',
-    OPTION_JAVA_MVN: 'java:mvn',
-    OPTION_HELM: 'helm',
+    OPTIONS: Object.freeze({
+        JAVA: 'java',
+        JAVA_MVN: 'java:mvn',
+        JAVA_PACKAGE: 'java:package',
+        NODEJS: 'nodejs',
+        PIPELINE: 'pipeline',
+        MTA: 'mta',
+        CONNECTIVITY: 'connectivity',
+        CF_MANIFEST: 'cf-manifest',
+        MTX: 'mtx',
+        MULTITENANCY: 'multitenancy',
+        TOGGLES: 'toggles',
+        EXTENSIBILITY: 'extensibility',
+        XSUAA: 'xsuaa',
+        HANA: 'hana',
+        SQLITE: 'sqlite',
+        AUDITLOG: 'auditlog',
+        ENTERPRISE_MESSAGING: 'enterprise-messaging',
+        ENTERPRISE_MESSAGING_SHARED: 'enterprise-messaging-shared',
+        FILE_BASED_MESSAGING: 'file-based-messaging',
+        REDIS_MESSAGING: 'redis-messaging',
+        APPROUTER: 'approuter',
+        DESTINATION: 'destination',
+        SAMPLES: 'samples', // deprecated
+        SAMPLE_TINY: 'sample-tiny',
+        SAMPLE: 'sample',
+        DATA: 'data',
+        KIBANA_LOGGING: 'kibana-logging',
+        LINT: 'lint',
+        LINT_GLOBAL: 'lint:global',
+        LINT_DEV: 'lint:dev',
+        HELM: 'helm',
+        TYPER: 'typer'
+    }),
 
     PROJECT_TYPE: Object.freeze({ nodejs: 1, java: 2, unknown: 3 }),
 
-    PYTHON_VENV_NAME: '.cap-jupyter-nb',
-
     REGEX_JAVA_PACKAGE: /^[a-z_][a-z0-9_]*(\.[a-z_][a-z0-9_]*)*$/g,
     REGEX_PROJECT_NAME: /[^0-9a-zA-Z_-]/g,
 
@@ -51,52 +54,14 @@ const constants = {
         PIPELINE_HELP: 'https://sap.github.io/jenkins-library/',
         SAMPLES: 'https://github.com/SAP-samples/cloud-cap-samples',
         CAPIRE: 'https://cap.cloud.sap',
-        JUPYTERLAB: 'https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html',
         MAVEN_ARCHETYPE_HELP: `https://cap.cloud.sap/docs/java/development/#the-maven-archetype`,
         MAVEN_INSTALL_HELP: `https://maven.apache.org/install.html`,
-        PYTHON: 'https://www.python.org/downloads/',
-        PYTHON_PIP: 'https://packaging.python.org/en/latest/guides/',
         VSCODE: 'https://code.visualstudio.com/',
         VSCODE_NBVIEWER: 'https://marketplace.visualstudio.com/items?itemName=ms-python.python',
         VSCODE_ESLINT: 'https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint'
     }),
 
-    PROJECT_FILES: ['package.json', 'pom.xml', '.cdsrc.json'],
-
-    KIND_SQL: 'sql',
-    KIND_HANA: 'hana',
-    KIND_HANA_CLOUD: 'hana-cloud',
-    KIND_HANA_MT: 'hana-mt'
+    PROJECT_FILES: ['package.json', 'pom.xml', '.cdsrc.json']
 }
 
-constants.OPTIONS_PRIORITY = [
-    constants.OPTION_JAVA,
-    constants.OPTION_NODEJS,
-    constants.OPTION_PIPELINE,
-    constants.OPTION_MTA,
-    constants.OPTION_CF_MANIFEST,
-    constants.OPTION_MTX,
-    constants.OPTION_MULTITENANCY,
-    constants.OPTION_TOGGLES,
-    constants.OPTION_EXTENSIBILITY,
-    constants.OPTION_XSUAA,
-    constants.OPTION_HANA,
-    constants.OPTION_SQLITE,
-    constants.OPTION_AUDITLOG,
-    constants.OPTION_ENTERPRISE_MESSAGING,
-    constants.OPTION_ENTERPRISE_MESSAGING_SHARED,
-    constants.OPTION_FILE_BASED_MESSAGING,
-    constants.OPTION_REDIS_MESSAGING,
-    constants.OPTION_APPROUTER,
-    constants.OPTION_DESTINATIONS,
-    constants.OPTION_SAMPLES,
-    constants.OPTION_DATA,
-    constants.OPTION_KIBANA_LOGGING,
-    constants.OPTION_NOTEBOOK,
-    constants.OPTION_LINT,
-    constants.OPTION_LINT_CUSTOM,
-    constants.OPTION_LINT_EXAMPLE,
-    constants.OPTION_HELM
-];
-
 module.exports = constants;

package/lib/init/index.js

@@ -2,11 +2,8 @@ const path = require('path');
 
 const term = require('../util/term');
 
-const { OPTIONS_PRIORITY, COMMAND_ADD, COMMAND_INIT,
-    // eslint-disable-next-line no-unused-vars
-    OPTION_XSUAA, OPTION_AUDITLOG, OPTION_HANA, OPTION_MTA, OPTION_MTX, OPTION_APPROUTER, OPTION_KIBANA_LOGGING,
-    OPTION_NODEJS, OPTION_JAVA, OPTION_HELM,
-    OPTION_PIPELINE, OPTION_SAMPLES, OPTION_CF_MANIFEST, PROJECT_FILES, REGEX_PROJECT_NAME } = require('./constants');
+const { OPTIONS, COMMAND_ADD, COMMAND_INIT, PROJECT_FILES, REGEX_PROJECT_NAME } = require('./constants')
+const { NODEJS, JAVA, HANA, MTA,PIPELINE, SAMPLES, CF_MANIFEST } = OPTIONS
 
 const cds = require('../cds'), { exists, readdir } = cds.utils
 const LOG = console
@@ -42,10 +39,10 @@ module.exports = class CDSGenerator {
             {
                 title: `Type`,
                 description: `Select your runtime.`,
-                default: OPTION_NODEJS,
+                default: NODEJS,
                 choices: [
-                    { name: 'Node.js', value: OPTION_NODEJS },
-                    { name: 'Java', value: OPTION_JAVA }
+                    { name: 'Node.js', value: NODEJS },
+                    { name: 'Java', value: JAVA }
                 ],
                 multiple: false,
                 target: 'add',
@@ -59,14 +56,13 @@ module.exports = class CDSGenerator {
                 description: `Add features to your project.`,
                 default: '',
                 choices: [
-                    { name: 'CI/CD Pipeline Integration', value: OPTION_PIPELINE },
-                    { name: 'Configuration for SAP HANA Deployment', value: OPTION_HANA },
-                    { name: 'MTA based SAP Business Technology Platform Deployment', value: OPTION_MTA },
-                    // { name: 'Multitenancy', value: OPTION_MTX },
-                    // { name: 'Jupyter base CAP Notebook', value: OPTION_NOTEBOOK },
-                    { name: `Cloud Foundry native Deployment`, value: OPTION_CF_MANIFEST }
-                    // { name: `CDS Linter for custom rules`, value: OPTION_LINT },
-                    // { name: `CDS Linter for custom rules with sample`, value: OPTION_LINT_DEV }
+                    { name: 'CI/CD Pipeline Integration', value: PIPELINE },
+                    { name: 'Configuration for SAP HANA Deployment', value: HANA },
+                    { name: 'MTA based SAP Business Technology Platform Deployment', value: MTA },
+                    // { name: 'Multitenancy', value: mtx },
+                    { name: `Cloud Foundry native Deployment`, value: CF_MANIFEST }
+                    // { name: `CDS Linter for custom rules`, value: lint },
+                    // { name: `CDS Linter for custom rules with sample`, value: lintDev }
                 ],
                 multiple: true,
                 target: 'add',
@@ -79,47 +75,15 @@ module.exports = class CDSGenerator {
                 description: `Add sample content to your project.`,
                 default: '',
                 choices: [
-                    { name: 'Basic Sample Files', value: OPTION_SAMPLES }
+                    { name: 'Basic Sample Files', value: SAMPLES }
                 ],
                 multiple: true,
                 target: 'add',
                 guiOptions: {
                     hint: 'Speed up your ramp-up phase with some sample files in your project.'
                 }
-            },
-            {
-                // OPTION_HELM this.config
             }
         ]
-
-        // legacy handling for generator-cap-project < 3.0
-        // does not contain OPTION_NODJES since old Yeoman generator
-        // cannot handle types correctly
-        this.config = {
-            add: {
-                title: `Features`,
-                description: `Select the features for the new project.`,
-                default: '',
-                // choices: OPTIONS_PRIORITY.filter((currOption) => currOption !== OPTION_NODEJS),
-                choices: [
-                    OPTION_JAVA,
-                    OPTION_HANA,
-                    OPTION_XSUAA,
-                    OPTION_PIPELINE,
-                    OPTION_CF_MANIFEST,
-                    OPTION_MTA,
-                    OPTION_SAMPLES,
-                    OPTION_KIBANA_LOGGING,
-                    OPTION_HELM,
-                    OPTION_SAMPLES
-                ],
-                multiple: true,
-                promptOrder: 10 // used to identify ui prompts
-            },
-            force: {
-                default: false
-            }
-        }
     }
 
     /**
@@ -205,6 +169,7 @@ module.exports = class CDSGenerator {
             const msg = `Adding feature '${template.name}'...`;
             LOG.info(msg);
             await template.run();
+            await template.runRelatedMerging();
         }
 
         LOG.info(`Done adding features`);
@@ -251,8 +216,9 @@ module.exports = class CDSGenerator {
             }
         }
 
+        const cmds = Object.values(OPTIONS);
         this.templateList = Array.from(templates.entries()).sort(([a], [b]) => {
-            return OPTIONS_PRIORITY.indexOf(a) - OPTIONS_PRIORITY.indexOf(b);
+            return cmds.indexOf(a) - cmds.indexOf(b);
         }).map((entry) => entry[1]);
 
         // check debug to avoid lengthy computation when not in debug mode
@@ -297,8 +263,8 @@ module.exports = class CDSGenerator {
         // set is ordered ... always
         this.options.add = new Set(trimmedTokens);
 
-        if (this.options._cmd === COMMAND_INIT && !this.options.add.has(OPTION_JAVA)) {
-            this.options.add.add(OPTION_NODEJS);
+        if (this.options._cmd === COMMAND_INIT && !this.options.add.has(JAVA)) {
+            this.options.add.add(NODEJS);
         }
 
         this._checkAdditionalOptions();

package/lib/init/template/_merging/registry-mta.js

@@ -31,16 +31,32 @@ const approuter = {
 }
 
 const xsuaa = {
+    in: 'resources',
+    where: [{
+        property: 'parameters.service',
+        isEqualTo: 'xsuaa',
+    }]
+}
+
+const destination = {
     in: 'resources',
     where: [{
         property: 'type',
         isEqualTo: 'org.cloudfoundry.managed-service',
     }, {
         property: 'parameters.service',
-        isEqualTo: 'xsuaa',
+        isEqualTo: 'destination',
+    }]
+}
+
+const connectivity = {
+    in: 'resources',
+    where: [{
+        property: 'type',
+        isEqualTo: 'org.cloudfoundry.managed-service',
     }, {
-        property: 'parameters.service-plan',
-        isEqualTo: 'application'
+        property: 'parameters.service',
+        isEqualTo: 'connectivity',
     }]
 }
 
@@ -245,6 +261,8 @@ module.exports = {
     approuter,
     xsuaa,
     auditlog,
+    destination,
+    connectivity,
     enterpriseMessaging,
     hdbDeployer,
     hdiContainer,

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

@@ -1,33 +1,33 @@
 ---
 modules:
-  - name: {{cap.appName}}-srv
-    type: {{cap.language}}
-    path: {{& cap.srvPath}}
-    {{#cap.isJava}}
-    {{#cap.isMultitenant}}
+  - name: {{appName}}-srv
+    type: {{language}}
+    path: {{& srvPath}}
+    {{#isJava}}
+    {{#isMultitenant}}
     properties:
       CDS_MULTITENANCY_APPUI_TENANTSEPARATOR: "-"
-    {{/cap.isMultitenant}}
-    {{/cap.isJava}}
+    {{/isMultitenant}}
+    {{/isJava}}
     requires:
-      - name: {{cap.appName}}-auth
-    {{#cap.isJava}}
+      - name: {{appName}}-auth
+    {{#isJava}}
       - name: app-api
         properties:
           CDS_MULTITENANCY_APPUI_URL: ~{url}
-    {{/cap.isJava}}
+    {{/isJava}}
 
-  - name: {{cap.appName}}
+  - name: {{appName}}
     type: approuter.nodejs
-    path: {{& ui.appPath}} # from cds.env.folders. Consider also cds.env.build.target -> gen/app
+    path: {{& appPath}} # from cds.env.folders. Consider also cds.env.build.target -> gen/app
     parameters:
       keep-existing-routes: true
       disk-quota: 256M
       memory: 256M
-    {{#cap.isMultitenant}}
+    {{#isMultitenant}}
     properties:
       TENANT_HOST_PATTERN: "^(.*)-${default-uri}"
-    {{/cap.isMultitenant}}
+    {{/isMultitenant}}
     requires:
       - name: srv-api
         group: destinations
@@ -35,46 +35,46 @@ modules:
           name: srv-api # must be used in xs-app.json as well
           url: ~{srv-url}
           forwardAuthToken: true
-      {{#cap.isMultitenant}}
+      {{#isMultitenant}}
       - name: mtx-api
         group: destinations
         properties:
           name: mtx-api # must be used in xs-app.json as well
           url: ~{mtx-url}
-      {{/cap.isMultitenant}}
-    {{#cap.isMultitenant}}
-    {{#cap.isNodejs}}
+      {{/isMultitenant}}
+    {{#isMultitenant}}
+    {{#isNodejs}}
     provides:
       - name: app-api
         properties:
           app-protocol: ${protocol}
           app-uri: ${default-uri}
-    {{/cap.isNodejs}}
-    {{/cap.isMultitenant}}
-    {{#cap.isJava}}
+    {{/isNodejs}}
+    {{/isMultitenant}}
+    {{#isJava}}
     provides:
       - name: app-api
         properties:
           url: ${default-url}
-    {{/cap.isJava}}
+    {{/isJava}}
 
-  {{#cap.isMultitenant}}
-  - name: {{cap.appName}}-mtx
+  {{#isMultitenant}}
+  - name: {{appName}}-mtx
     type: nodejs
-    path: {{#cap.isNodejs}}gen/{{/cap.isNodejs}}mtx/sidecar
+    path: {{#isNodejs}}gen/{{/isNodejs}}mtx/sidecar
     requires:
       - name: app-api
         properties:
           SUBSCRIPTION_URL: ~{app-protocol}://\${tenant_subdomain}-~{app-uri}
-  {{/cap.isMultitenant}}
+  {{/isMultitenant}}
 
 resources:
-  - name: {{cap.appName}}-auth
+  - name: {{appName}}-auth
     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}}
+        xsappname: {{appName}}-${org}-${space}
+        tenant-mode: {{#isMultitenant}}shared{{/isMultitenant}}{{^isMultitenant}}dedicated{{/isMultitenant}}

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

@@ -1,19 +1,19 @@
 ---
-{{#cap.hasXsuaa}}
+{{#hasXsuaa}}
 xsuaa:
   parameters:
     oauth2-configuration:
       redirect-uris:
       - https://*.<your-cluster-domain>/**
-{{/cap.hasXsuaa}}
+{{/hasXsuaa}}
 approuter:
-{{#cap.hasXsuaa}}
+{{#hasXsuaa}}
   bindings:
     auth:
       serviceInstanceName: xsuaa
-{{/cap.hasXsuaa}}
+{{/hasXsuaa}}
   image:
-    repository: <your-container-registry>/{{cap.appName}}-approuter
+    repository: <your-container-registry>/{{appName}}-approuter
     tag: latest
   resources:
     limits:

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

@@ -1,18 +1,24 @@
 {
+  "welcomeFile": "app/index.html",
   "routes": [
-    {{#cap.isExtensible}}
+    {{#isExtensible}}
     {
       "source": "^/-/cds/.*",
       "destination": "mtx-api",
       "authenticationType": "none"
     },
-    {{/cap.isExtensible}}
+    {{/isExtensible}}
     {
       "source": "^/app/(.*)$",
       "target": "$1",
       "localDir": ".",
       "cacheControl": "no-cache, no-store, must-revalidate"
     },
+    {
+      "source": "^/appconfig/",
+      "localDir": ".",
+      "cacheControl": "no-cache, no-store, must-revalidate"
+    },
     {
       "source": "^/(.*)$",
       "target": "$1",

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

@@ -2,8 +2,8 @@ const cds = require('../../../cds')
 const { exists } = cds.utils
 const { join } = require('path')
 const { readProject } = require('../../util/projectReader')
-const { mergeJSON, mergeYAML, sortDependencies } = require('../../util/merge')
-const { OPTION_XSUAA } = require('../../constants')
+const { mergeJSON, mergeYAML, sort } = require('../../util/merge')
+const { XSUAA } = require('../../constants').OPTIONS
 const {
     srvNode4, srvJava4, mtxSidecar4, approuter, // Modules
     xsuaa, // BTP Services
@@ -20,22 +20,21 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
     }
 
     getDependencies() {
-        return [OPTION_XSUAA]
+        return [XSUAA]
     }
 
     async run() {
-        const projectDescriptor = await readProject(this.options)
-        const appPath = projectDescriptor.ui.appPath ?? 'app'
+        const { appPath = 'app' } = await readProject(this.options)
         const appPackageJSONPath = join(appPath, 'package.json')
         await mergeJSON(appPackageJSONPath, join(__dirname, 'files', 'package.json'))
-        await sortDependencies(appPackageJSONPath)
+        await sort(appPackageJSONPath, 'dependencies')
         await mergeJSON(join(appPath, 'default-env.json'), join(__dirname, 'files', 'default-env.json'))
         await this.runDependentMerging()
     }
 
     async runDependentMerging(context = {}) {
         const projectDescriptor = await readProject(this.options)
-        const { isNodejs, isJava, isExtensible, isMultitenant, hasMta, hasHelm, srvPath } = projectDescriptor.cap
+        const { isNodejs, isJava, isExtensible, isMultitenant, hasMta, hasHelm, srvPath } = projectDescriptor
 
         if (hasMta) {
             const srv = (isNodejs ? srvNode4 : srvJava4)(srvPath)
@@ -114,7 +113,7 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
             if (isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData);
         }
 
-        const xsAppPath = join(projectDescriptor.ui.appPath ?? 'app', 'xs-app.json')
+        const xsAppPath = join(projectDescriptor.appPath ?? 'app', 'xs-app.json')
         const additions = isExtensible ? [{ ...approuterExtensibility, at: 0 }] : []
         await mergeJSON(xsAppPath, join(__dirname, 'files', 'xs-app.json.hbs'), projectDescriptor, { additions })
     }

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

@@ -1,13 +1,13 @@
 ---
 modules:
- - name: {{cap.appName}}-srv
-   type: {{cap.language}}
-   path: {{& cap.srvPath}}
+ - name: {{appName}}-srv
+   type: {{language}}
+   path: {{& srvPath}}
    requires:
-    - name: {{cap.appName}}-auditlog
+    - name: {{appName}}-auditlog
 
 resources:
-  - name: {{cap.appName}}-auditlog
+  - name: {{appName}}-auditlog
     type: org.cloudfoundry.managed-service
     parameters:
       service: auditlog-api

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

@@ -1,27 +1,27 @@
 {
-  {{#cap.isNodejs}}
+  {{#isNodejs}}
   "dependencies": {
       "@sap/audit-logging": "^5"
   },
   "cds": {
-  {{/cap.isNodejs}}
+  {{/isNodejs}}
     "requires": {
-      {{#cap.for}}
-      "[{{cap.for}}]": {
-      {{/cap.for}}
-      {{#cap.shortcut}}
+      {{#profile}}
+      "[{{profile}}]": {
+      {{/profile}}
+      {{#shortcut}}
         "audit-log": "service"
-      {{/cap.shortcut}}
-      {{^cap.shortcut}}
+      {{/shortcut}}
+      {{^shortcut}}
         "audit-log": {
           "kind": "service"
         }
-      {{/cap.shortcut}}
-      {{#cap.for}}
+      {{/shortcut}}
+      {{#profile}}
       }
-      {{/cap.for}}
+      {{/profile}}
     }
-  {{#cap.isNodejs}}
+  {{#isNodejs}}
   }
-  {{/cap.isNodejs}}
+  {{/isNodejs}}
 }

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

@@ -14,15 +14,15 @@ module.exports = class AuditlogTemplate extends require('../templateBase') {
 
     async run() {
         const projectDescriptor = await readProject(this.options)
-        const { configFile } = projectDescriptor.cap
-        projectDescriptor.cap.shortcut = !(await read(configFile)).cds?.requires?.['audit-log']?.kind
+        const { configFile } = projectDescriptor
+        projectDescriptor.shortcut = !(await read(configFile)).cds?.requires?.['audit-log']?.kind
         await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), projectDescriptor)
         await this.runDependentMerging()
     }
 
     async runDependentMerging(context = {}) {
         const projectDescriptor = await readProject(this.options)
-        const { isNodejs, hasMta, hasHelm, srvPath } = projectDescriptor.cap
+        const { isNodejs, hasMta, hasHelm, srvPath } = projectDescriptor
 
         if (hasMta) {
             const srv = (isNodejs ? srvNode4 : srvJava4)(srvPath)