@sap/cds-dk 7.9.4 → 8.0.2

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

@@ -1,8 +1,7 @@
 ---
 approuter:
   image:
-    repository: <your-container-registry>/{{appName}}-approuter
-    tag: latest
+    repository: {{appName}}-approuter
 {{#hasMultitenancy}}
 {{=<% %>=}}
   env:
@@ -22,11 +21,27 @@ approuter:
       path: /
     readiness:
       path: /
-backendDestinations: {}
-{{^hasMultitenancy}}
+{{=<% %>=}}
+  envFrom:
+    - configMapRef:
+        name: "{{ .Release.Name }}-approuter-configmap"
+<%={{ }}=%>
+backendDestinations:
+  srv-api:
+    service: srv
+  {{#hasMultitenancy}}
+  mtx-api:
+    service: {{#isJava}}srv{{/isJava}}{{^isJava}}sidecar{{/isJava}}
+  {{/hasMultitenancy}}
 srv:
   expose:
     enabled: false
   networkSecurity:
     allowNamespaceInternal: true
+{{#hasMultitenancy}}
+sidecar:
+  expose:
+    enabled: false
+  networkSecurity:
+    allowNamespaceInternal: true
 {{/hasMultitenancy}}

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

@@ -1,13 +1,22 @@
 {
-  "welcomeFile": "app/index.html",
+  {{#hasPortal}}
+  "welcomeFile": "/cp.portal",
+  {{/hasPortal}}
   "routes": [
-    {{#hasExtensibility}}
+    {{#hasMTXRoute}}
     {
       "source": "^/-/cds/.*",
       "destination": "mtx-api",
       "authenticationType": "none"
     },
-    {{/hasExtensibility}}
+    {{/hasMTXRoute}}
+    {{#hasMTXRouteJava}}
+    {
+      "source": "^/mt/.*",
+      "destination": "srv-api",
+      "authenticationType": "none"
+    },
+    {{/hasMTXRouteJava}}
     {
       "source": "^/app/(.*)$",
       "target": "$1",

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

@@ -1,5 +1,5 @@
 const cds = require('../../../cds')
-const { exists, copy } = cds.utils
+const { exists } = cds.utils
 const { join } = require('path')
 const { readProject } = require('../../projectReader')
 const { sort, merge } = require('../../merge')
@@ -8,17 +8,18 @@ const {
     xsuaa, // BTP Services
     requiredMtxApi, providedJavaApprouterApi4, providedJavaApprouterApi, // APIs
     requiredAppApi4, providedAppApi,
-    approuterExtensibility // xs-app.json config
+    approuterMTXRoute,
+    approuterMTXRouteJava // xs-app.json config
 } = require('../../registries/mta')
 
 module.exports = class ApprouterTemplate extends require('../../plugin') {
 
-    static hasInProduction(env) {
-        return exists(join(env.folders.app, 'xs-app.json')) || exists(join(env.folders.app, 'router', 'xs-app.json'))
+    static help() {
+        return 'dynamic routing using @sap/approuter'
     }
 
-    requires() {
-        return ['xsuaa']
+    static hasInProduction(env) {
+        return exists(join(env.folders.app, 'xs-app.json')) || exists(join(env.folders.app, 'router', 'xs-app.json'))
     }
 
     async run() {
@@ -31,7 +32,7 @@ module.exports = class ApprouterTemplate extends require('../../plugin') {
 
     async combine() {
         const project = readProject(this.options)
-        const { isNodejs, isJava, hasExtensibility, hasMultitenancy, hasMta, hasHelm, hasHelmUnifiedRuntime, srvPath, approuterPath } = project
+        const { isNodejs, isJava, hasMTXRoute, hasMultitenancy, hasXsuaa, hasMta, hasHelm, hasHelmUnifiedRuntime, hasMTXRouteJava, hasContainerize, srvPath, approuterPath } = project
 
         if (hasMta) {
             const srv = srv4(srvPath)
@@ -41,33 +42,36 @@ module.exports = class ApprouterTemplate extends require('../../plugin') {
             if (isJava && hasMultitenancy) apis.push(requiredMtxApi)
             const modules = [srv, approuter]
             if (hasMultitenancy) modules.push(mtxSidecar)
-            const additions = [...modules, xsuaa, ...apis]
-            await merge(__dirname, 'files', 'mta.yaml.hbs').into('mta.yaml', {
-                with: project,
-                additions,
-                relationships: [{
-                    insert: [xsuaa, 'name'],
-                    into: [srv, 'requires', 'name']
-                }, {
-                    insert: [xsuaa, 'name'],
-                    into: [approuter, 'requires', 'name']
-                }],
+            const additions = [...modules, ...apis]
+            if (hasXsuaa) additions.push(xsuaa)
+            const relationships = []
+            if (hasXsuaa) relationships.push({
+                insert: [xsuaa, 'name'],
+                into: [srv, 'requires', 'name']
+            }, {
+                insert: [xsuaa, 'name'],
+                into: [approuter, 'requires', 'name']
+            })
+            await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
+                with: project, additions, relationships,
             })
         }
 
         if (hasHelm || hasHelmUnifiedRuntime) {
             await merge(__dirname, 'files', 'values.yaml.hbs').into('chart/values.yaml', { with: project })
-            await merge({ approuter: { envFrom: [{
-                configMapRef: {
-                    name: "{{ .Release.Name }}-approuter-configmap"
-                }
-            }]}}).into('chart/values.yaml', { with: project })
+        }
 
-            await copy(join(__dirname, 'files/approuter-configmap.yaml')).to('chart', 'templates', 'approuter-configmap.yaml')
+        if (hasContainerize) {
+            const additions = [{
+                in: 'modules',
+                where: { name: `${project.appName}-approuter` }
+            }]
+            await merge(__dirname, '/files/containerize.yaml.hbs').into('containerize.yaml', { with: project, additions })
         }
 
         const xsAppPath = join(approuterPath, 'xs-app.json')
-        const additions = hasExtensibility ? [{ ...approuterExtensibility, at: 0 }] : []
+        const additions = hasMTXRoute ? [{ ...approuterMTXRoute, at: 0 }] : []
+        if (hasMTXRouteJava) additions.push({ ...approuterMTXRouteJava, at: 0 })
         await merge(__dirname, 'files/xs-app.json.hbs').into(xsAppPath, { project, additions })
     }
 }

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

@@ -0,0 +1,14 @@
+---
+modules:
+  - name: {{appName}}-srv
+    type: {{language}}
+    path: {{& srvPath}}
+    requires:
+      - name: {{appName}}-attachments
+
+resources:
+  - name: {{appName}}-attachments
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: objectstore
+      service-plan: standard

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

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@cap-js/attachments": "^1"
+  }
+}

package/lib/init/template/attachments/files/values.yaml

@@ -0,0 +1,7 @@
+srv:
+  bindings:
+    objectstore:
+      serviceInstanceName: attachments
+attachments:
+  serviceOfferingName: objectstore
+  servicePlanName: standard

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

@@ -0,0 +1,53 @@
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { srv4, attachments } = require('../../registries/mta')
+
+module.exports = class AttachmentsTemplate extends require('../../plugin') {
+
+    static help() {
+        return 'SAP BTP Object Store Service'
+    }
+
+    requires() {
+        return ['malware-scanner']
+    }
+
+    static hasInProduction(env) {
+        return !!env.requires?.attachments
+    }
+
+    async canRun() {
+        const { isJava } = readProject()
+        if (isJava) throw `'cds add attachments' is not available for Java yet`
+        return true
+    }
+
+    async run() {
+        const project = readProject()
+        const { isNodejs } = project
+        if (isNodejs) {
+            await merge(__dirname, 'files/package.json.hbs').into('package.json')
+        }
+    }
+
+    async combine() {
+        const project = readProject()
+        const { hasMta, hasHelm, hasHelmUnifiedRuntime, srvPath } = project
+
+        if (hasMta) {
+            const srv = srv4(srvPath)
+            const additions = [srv, attachments]
+            const relationships = [{
+                insert: [attachments, 'name'],
+                into: [srv, 'requires', 'name']
+            }]
+            await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
+                with: project, additions, relationships
+            })
+        }
+
+        if (hasHelm || hasHelmUnifiedRuntime) {
+            await merge(__dirname, 'files', 'values.yaml').into('chart/values.yaml')
+        }
+    }
+}

package/lib/init/template/audit-logging/files/mta.yaml.hbs

@@ -0,0 +1,14 @@
+---
+modules:
+ - name: {{appName}}-srv
+   type: {{language}}
+   path: {{& srvPath}}
+   requires:
+    - name: {{appName}}-auditlog
+
+resources:
+  - name: {{appName}}-auditlog
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: auditlog
+      service-plan: {{servicePlan}}

package/lib/init/template/audit-logging/files/package.json.hbs

@@ -0,0 +1,7 @@
+{
+  {{#isNodejs}}
+  "dependencies": {
+    "@cap-js/audit-logging": ">=0"
+  }
+  {{/isNodejs}}
+}

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

@@ -0,0 +1,66 @@
+const { join } = require('path')
+const cds = require('../../../cds')
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { srv4, auditlog } = require('../../registries/mta')
+const mvn = require('../../mvn')
+
+module.exports = class AuditLoggingTemplate extends require('../../plugin') {
+
+  static help() {
+   return 'SAP BTP Audit Logging Service'
+  }
+
+  static hasInProduction(env) {
+    return env.requires?.['audit-log']
+  }
+
+  options() {
+    return {
+      'plan': {
+        type: 'string',
+        help: 'Specify the service plan.',
+      }
+    }
+  }
+
+  async run() {
+    const project = readProject()
+    const { configFile, isJava } = project
+    await merge(join(__dirname, 'files/package.json.hbs')).into(configFile, { with: project })
+    if (isJava) await mvn.add('audit_logging')
+  }
+
+  async combine() {
+    const project = readProject()
+    const { hasMta, hasHelm, hasMultitenancy, srvPath } = project
+    const { plan = 'premium' } = cds.cli.options
+    project.servicePlan = plan
+    
+    if (hasMultitenancy) {
+      await merge(__dirname, 'files/package.sidecar.json').into('mtx/sidecar/package.json')
+    }
+
+    if (hasMta) {
+      const srv = srv4(srvPath)
+      await merge(join(__dirname, 'files/mta.yaml.hbs')).into('mta.yaml', {
+        with: project,
+        additions: [srv, auditlog],
+        relationships: [{
+            insert: [auditlog, 'name'],
+            into: [srv, 'requires', 'name']
+          }
+        ]
+      })
+    }
+    if (hasHelm) {
+      await merge({
+        srv: { bindings: { auditlog: { serviceInstanceName: 'auditlog' }}},
+        auditlog: {
+          serviceOfferingName: 'auditlog',
+          servicePlanName: plan
+        }
+      }).into('chart/values.yaml')
+    }
+  }
+}

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

@@ -8,6 +8,10 @@ const SERVICES_MANIFEST_FILE = 'services-manifest.yml'
 
 module.exports = class CfManifestTemplate extends require('../../plugin') {
 
+    static help() {
+        return 'Cloud Foundry deployment using manifest files'
+    }
+
     async canRun() {
         if (cds.cli.options.force) {
             return true

package/lib/init/template/completion/completionSetup.js

@@ -8,32 +8,39 @@ const { bold } = require('../../../util/term');
 
 const ENTRY_REGEX = /\n{0,2}# cds completion start(.+)# cds completion end/is;
 
+const SUPPORTED_LINUX_SHELLS = ['bash', 'fish', 'gitbash', 'zsh'];
+const SUPPORTED_WINDOWS_SHELLS = ['ps'];
+const SUPPORTED_SHELLS = [...SUPPORTED_LINUX_SHELLS, ...SUPPORTED_WINDOWS_SHELLS].sort();
+
 
 module.exports = new class CompletionSetup {
+    supportedShells = SUPPORTED_SHELLS
+
     async setup(addEntry, options) {
         const shell = options.shell
-            || (process.env.MSYSTEM?.includes('MINGW64') ? 'gitbash' : process.env.SHELL?.match(/(bash|zsh)/)?.[0])
+            || (process.env.MSYSTEM?.includes('MINGW64') ? 'gitbash' : process.env.SHELL?.match(/(bash|fish|zsh)/)?.[0])
             || (process.env.PSModulePath ? 'ps' : null);
 
         switch (shell) {
             case 'bash':
+            case 'fish':
             case 'gitbash':
             case 'zsh':
-                return this.setupBashZsh(addEntry, shell);
+                return this.setupLinuxLike(addEntry, shell);
             case 'ps':
                 return this.setupPs(addEntry);
             case null:
                 try {
                     const shellType = this.determineShellLinux();
                     if (!shellType) {
-                        throw `Unsupported shell.\nSupported shells are: bash, zsh, gitbash, ps.`;
+                        throw `Unsupported shell.\nSupported shells are: ${SUPPORTED_SHELLS.join(', ')}.`;
                     }
-                    return this.setupBashZsh(addEntry, shellType);
+                    return this.setupLinuxLike(addEntry, shellType);
                 } catch (err) {
                     throw `Error during completion setup: ${err}`;
                 }
             default:
-                throw `Unsupported shell: ${shell}.\nSupported shells are: bash, zsh, gitbash, ps.`;
+                throw `Unsupported shell: ${shell}.\nSupported shells are: ${SUPPORTED_SHELLS.join(', ')}.`;
         }
     }
 
@@ -67,23 +74,26 @@ module.exports = new class CompletionSetup {
         await fsp.copyFile(fileName, fileName + '.cds.bak');
     }
 
-    async setupBashZsh(addEntry, shell) {
-        const isBash = shell.includes('bash'); // also for gitbash
-        const isZsh = shell.includes('zsh');
-        const isGitBash = shell.includes('gitbash');
-
-        if (!isBash && !isZsh) {
-            throw 'Completion is only supported for bash, zsh or Git Bash shell.';
+    async setupLinuxLike(addEntry, shell) {
+        let profileFile;
+        switch (shell) {
+            case 'bash':
+                profileFile = os.platform() === 'darwin' ? '.bash_profile' : '.bashrc';
+                break;
+            case 'gitbash':
+                profileFile = '.bash_profile'
+                break;
+            case 'zsh':
+                profileFile = '.zshrc';
+                break;
+            case 'fish':
+                profileFile = '.config/fish/config.fish';
+                break;
+            default:
+                throw `Completion is only supported for ${SUPPORTED_LINUX_SHELLS.join(', ')}.`;
         }
 
-        const profileFile = path.join(
-            os.homedir(),
-            isZsh
-                ? '.zshrc'
-                : os.platform() === 'darwin' || isGitBash
-                    ? '.bash_profile'
-                    : '.bashrc'
-        );
+        profileFile = path.join(os.homedir(), profileFile);
 
         await this.changeProfile(profileFile, shell, addEntry);
 
@@ -109,15 +119,6 @@ module.exports = new class CompletionSetup {
 
     getScript(shell) {
         switch (shell) {
-            case 'ps':
-                return `
-try {
-    $CDS_PROFILE = cds completion --shell ps --profile 2> $null
-    if (Test-Path -Path "$CDS_PROFILE" -PathType Leaf) {
-        . $CDS_PROFILE
-    }
-} catch {}
-`
             case 'bash':
             case 'gitbash':
                 return `
@@ -126,6 +127,25 @@ if [ -r "$CDS_PROFILE" ]; then
     . "$CDS_PROFILE"
 fi
 `
+            case 'fish':
+                return `
+if type "cds" >/dev/null 2>&1
+    set -l CDS_PROFILE (cds completion --shell fish --profile 2> /dev/null)
+    if test -e "$CDS_PROFILE"
+        source "$CDS_PROFILE"
+    end
+end
+`
+            case 'ps':
+                return `
+try {
+    $CDS_PROFILE = cds completion --shell ps --profile 2> $null
+    if (Test-Path -Path "$CDS_PROFILE" -PathType Leaf) {
+        . "$CDS_PROFILE"
+    }
+} catch {}
+`
+
             case 'zsh':
                 return `
 # compinit can be removed here if loaded elsewhere in the script
@@ -136,7 +156,8 @@ if [ -r "$CDS_PROFILE" ]; then
     . "$CDS_PROFILE"
 fi
 `
-            default: throw `Unsupported shell: ${shell}`;
+            default:
+                throw `Unsupported shell: ${shell}`;
         }
     }
 
@@ -171,13 +192,13 @@ ${this.getScript(shell)}
             const relProfilePath = path.relative(os.homedir(), profileFile);
             if (profileFileExists) {
                 await this.createBackup(profileFile);
-                console.log(`Created backup ${bold(`~/${relProfilePath}.cds.bak`)}.`);
+                console.log(`Created backup ${bold(`~/${relProfilePath}.cds.bak`)}`);
             }
             await fsp.writeFile(profileFile, profile);
             if (addEntry) {
-                console.log(`Added entry to ${bold(`~/${relProfilePath}`)}.`);
+                console.log(`Added entry to ${bold(`~/${relProfilePath}`)}`);
             } else {
-                console.log(`Removed entry from ${bold(`~/${relProfilePath}`)}.`);
+                console.log(`Removed entry from ${bold(`~/${relProfilePath}`)}`);
             }
         }
     }

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

@@ -2,14 +2,20 @@ const cds = require('../../../cds');
 
 
 module.exports = class CompletionTemplate extends require('../../plugin') {
+
+    static help() {
+        return 'shell completion for cds commands'
+    }
+
     options() {
+        const completionSetup = require('./completionSetup');
         return {
             'shell': {
                 type: 'string',
                 short: 's',
                 help: `<optional> Forces completion setup for a given shell and disables auto detection.
         Usually the shell is determined automatically and this is only for cases where the automatic
-        detection fails. Valid values: bash, gitbash, zsh, ps`
+        detection fails. Valid values: ${completionSetup.supportedShells.join(', ')}.`
             }
         }
     }

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

@@ -1,12 +1,13 @@
-const cds = require('../../../cds')
-const { copy } = cds.utils
-const { join } = require('path')
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
 const { srv4, connectivity } = require('../../registries/mta')
 
 module.exports = class ConnectivityTemplate extends require('../../plugin') {
 
+    static help() {
+        return 'SAP BTP Connectivity Service'
+    }
+
     static hasInProduction(env) {
         return !!env.requires.connectivity
     }
@@ -39,7 +40,6 @@ module.exports = class ConnectivityTemplate extends require('../../plugin') {
                     where: { name: 'connectivity-secret' }
                 }]
             })
-            await copy(join(__dirname, 'files', 'connectivity-proxy-info.yaml')).to('chart', 'templates', 'connectivity-proxy-info.yaml') // REVISIT: Move to build
         }
     }
 }

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

@@ -0,0 +1,26 @@
+---
+_schema-version: '1.0'
+repository: <your-container-registry>
+tag: latest
+before-all:
+  - npx cds build --production
+  {{#isJava}}
+  - mvn clean package -DskipTests=true --batch-mode
+  {{/isJava}}
+modules:
+  - name: {{appName}}-srv
+    build-parameters:
+      buildpack:
+        {{#isNodejs}}
+        type: nodejs
+        {{/isNodejs}}
+        builder: builder-jammy-base
+        path: {{#isNodejs}}gen/srv{{/isNodejs}}{{#isJava}}srv/target/{{appName}}-exec.jar{{/isJava}}
+        env:
+        {{#isNodejs}}
+          BP_NODE_RUN_SCRIPTS: ""
+        {{/isNodejs}}
+        {{#isJava}}
+          SPRING_PROFILES_ACTIVE: cloud
+          BP_JVM_VERSION: 21
+        {{/isJava}}

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

@@ -0,0 +1,24 @@
+const cds = require('../../../cds')
+const { exists, rimraf } = cds.utils
+const { readProject } = require('../../projectReader');
+const { merge } = require('../../merge')
+
+module.exports = class ContainerizeTemplate extends require('../../plugin') {
+
+    static help() {
+        return 'containerization using ctz CLI'
+    }
+
+    static hasInProduction () {
+        return exists('containerize.yaml')
+    }
+
+    async run() {
+        if (cds.cli.options.force) {
+            await rimraf('containerize.yaml')
+        }
+
+        const project = readProject()
+        await merge(__dirname, '/files/containerize.yaml.hbs').into('containerize.yaml', { with: project })
+    }
+}

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

@@ -9,6 +9,10 @@ const asCsv = require('./as-csv')
 
 module.exports = class DataTemplate extends require('../../plugin') {
 
+  static help() {
+    return 'add CSV headers for modeled entities'
+  }
+
   options() {
     return {
       'filter': {

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

@@ -6,9 +6,33 @@ modules:
     requires:
       - name: {{appName}}-destination
 
+  - name: {{appName}}
+    type: approuter.nodejs
+    requires:
+      - name: {{appName}}-destination
+
 resources:
   - name: {{appName}}-destination
     type: org.cloudfoundry.managed-service
     parameters:
       service: destination
-      service-plan: lite
+      service-plan: lite{{#hasHtml5Repo}}
+      config:
+        HTML5Runtime_enabled: true
+        init_data:
+          instance:
+            existing_destinations_policy: update
+            destinations:
+              - Name: {{appName}}-srv-api
+                URL: ~{srv-api/srv-url}
+                Authentication: OAuth2UserTokenExchange
+                Type: HTTP
+                ProxyType: Internet
+                HTML5.ForwardAuthToken: true
+                HTML5.DynamicDestination: true
+              - Authentication: NoAuthentication
+                Name: ui5
+                ProxyType: Internet
+                Type: HTTP
+                URL: https://ui5.sap.com
+        {{/hasHtml5Repo}}