@sap/cds-dk 7.9.6 → 8.0.3

package/lib/init/template/sample/files/nodejs/cat-service.js

@@ -16,8 +16,8 @@ class CatalogService extends cds.ApplicationService { init(){
   })
 
   // Add some discount for overstocked books
-  this.after ('READ','ListOfBooks', each => {
-    if (each.stock > 111) each.title += ` -- 11% discount!`
+  this.after ('each','ListOfBooks', book => {
+    if (book.stock > 111) book.title += ` -- 11% discount!`
   })
 
   return super.init()

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

@@ -0,0 +1,3 @@
+{
+  "sapux": ["{{& appPath}}admin-books", "{{& appPath}}browse"]
+}

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

@@ -1,10 +1,15 @@
 const { join } = require('path')
 const cds = require('../../../cds'), { exists, read, write, copy } = cds.utils
 const { env4, readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
 const mvn = require('../../mvn')
 
 module.exports = class SampleTemplate extends require('../../plugin') {
 
+    static help() {
+        return 'add sample files including Fiori UI'
+    }
+
     async run() {
         const { db, srv, app } = env4('production').folders
         const language = exists('pom.xml') ? 'java' : 'nodejs'
@@ -15,17 +20,19 @@ module.exports = class SampleTemplate extends require('../../plugin') {
                 copy(join(__dirname, 'files/srv')).to(srv)
             ])
             await copy(join(__dirname, 'files', language)).to(srv)
-            await copy(join(__dirname, 'files', 'app')).to(app)
-            const { appName, appPath, appUIPaths } = readProject()
-
-            // manifest.json must be unique // REVISIT: Check if relevant for `cds add sample` in Java scenario
-            await Promise.all(appUIPaths.map(async p => {
-                const manifest = await read(join(appPath, p, 'webapp/manifest.json'))
-                manifest['sap.app'].id = appName + '.' + p
-                await write(join(appPath, p, 'webapp/manifest.json'), manifest, { spaces: 2 })
-            }))
+            await copy(join(__dirname, 'files/app')).to(app)
         } else if (language === 'java') {
             await mvn.add('sample')
         }
+
+        const { appName, appPath, appUIPaths } = readProject()
+        await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: { appPath }})
+
+        // manifest.json must be unique
+        await Promise.all(appUIPaths.map(async p => {
+            const manifest = await read(join(appPath, p, 'webapp/manifest.json'))
+            manifest['sap.app'].id = appName + '.' + p
+            await write(join(appPath, p, 'webapp/manifest.json'), manifest, { spaces: 2 })
+        }))
     }
 }

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

@@ -4,6 +4,10 @@ const { merge } = require('../../merge')
 
 module.exports = class SQLiteTemplate extends require('../../plugin') {
 
+    static help() {
+      return 'database support for SQLite'
+    }
+
     async run() {
       const project = readProject()
       const { isNodejs, isJava, configFile } = project

package/lib/init/template/tiny-sample/files/nodejs/db/data/my.bookshop-Books.csv

@@ -1,3 +1,3 @@
-ID;title;stock
-1;Wuthering Heights;100
-2;Jane Eyre;500
+ID,title,stock
+1,Wuthering Heights,100
+2,Jane Eyre,500

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

@@ -1,4 +1,4 @@
-using my.bookshop as my from '../{{ dbFolder }}/data-model';
+using my.bookshop as my from '../{{ dbFolder }}/schema';
 
 service CatalogService {
     @readonly entity Books as projection on my.Books;

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

@@ -7,6 +7,10 @@ const { JAVA } = require('../../constants')
 
 module.exports = class TinySampleTemplate extends require('../../plugin') {
 
+    static help() {
+        return 'add minimal sample files'
+    }
+
     async run() {
         const { isJava } = readProject()
         if (isJava) {

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

@@ -1,7 +1,7 @@
 {
   {{#isNodejs}}
   "dependencies": {
-    "@sap/cds-mtxs": "^1.9"
+    "@sap/cds-mtxs": "^2"
   },
   "cds": {
   {{/isNodejs}}

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

@@ -3,6 +3,10 @@ const { merge, sort } = require('../../merge')
 
 module.exports = class TogglesTemplate extends require('../../plugin') {
 
+  static help() {
+    return 'allow dynamically toggled features'
+  }
+
   static hasInProduction(env) {
     return !!env.requires?.toggles
   }

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

@@ -6,6 +6,10 @@ const { TYPER } = require('../../constants').OPTIONS
 const { exists, read } = require('../../../cds').utils
 
 module.exports = class TyperTemplate extends require('../../plugin') {
+  static help() {
+    return 'type generation for CDS models'
+  }
+
   async canRun() {
     const { isJava } = readProject()
     if (isJava) {

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

@@ -0,0 +1,12 @@
+{
+  "devDependencies": {
+    "typescript": "^5",
+    "@cap-js/cds-types": "<1",
+    "@types/node": "^20"
+  },
+  "scripts": {
+    "watch": "cds-ts w",
+    "build:ts": "tsc",
+    "build": "cds build && npm run build:ts"
+  }
+}

package/lib/init/template/typescript/files/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "allowJs": true
+  }
+}

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

@@ -0,0 +1,39 @@
+const { join } = require('path')
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { warn } = require('../../../util/term')
+const { TYPESCRIPT } = require('../../constants').OPTIONS
+const { exists } = require('../../../cds').utils
+const TyperTemplate = require('../typer')
+
+module.exports = class TypescriptTemplate extends require('../../plugin') {
+  static help() {
+    return 'add minimum configuration for a bare TypeScript project'
+  }
+
+  async canRun() {
+    const { isJava } = readProject()
+    if (isJava) {
+      console.warn(warn(`This appears to be a Java project. 'cds add ${TYPESCRIPT}' is intended to be used in Node.js projects. Proceeding anyway.\n`))
+    }
+    return true
+  }
+
+  static hasInProduction() {
+    return exists('tsconfig.ts')
+  }
+
+  async run() {
+    const tsconfig = join(__dirname, 'files', 'tsconfig.json')
+
+    try {
+      await merge(tsconfig).into('tsconfig.json')
+    } catch (e) {
+      throw e instanceof SyntaxError
+        ? `SyntaxError in existing tsconfig.json. This could indicate a JSON file with comments, which is not supported at this time. Remove all comments from your tsconfig.json and rerun`
+        : e
+    }
+    await merge(join(__dirname, 'files', 'package.json')).into('package.json')
+    await new TyperTemplate().run() // REVISIT: we should avoid referencing other plugins
+  }
+}

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

@@ -0,0 +1,9 @@
+module.exports = class extends require('../../plugin') {
+    help() {
+      return 'SAP BTP Work Zone'
+    }
+
+    requires() {
+      return ['workzone-standard']
+    }
+}

package/lib/init/template/workzone-standard/files/manifest.json.hbs

@@ -0,0 +1,6 @@
+{
+  "sap.cloud": {
+    "public": true,
+    "service": "{{appName}}.service"
+  }
+}

package/lib/init/template/workzone-standard/files/mta.yaml.hbs

@@ -0,0 +1,59 @@
+---
+modules:
+  - name: {{appName}}-destinations
+    type: com.sap.application.content
+    requires:
+      - name: {{appName}}-auth
+        parameters:
+          service-key:
+            name: {{appName}}-auth-key
+      - name: {{appName}}-html5-repo-host
+        parameters:
+          service-key:
+            name: {{appName}}-html5-repo-host-key
+      - name: srv-api
+      - name: {{appName}}-destination
+        parameters:
+          content-target: true
+    build-parameters:
+      no-source: true
+    parameters:
+      content:
+        instance:
+          existing_destinations_policy: update
+          destinations:
+            - Name: {{appName}}-html5-repository
+              ServiceInstanceName: {{appName}}-html5-repo-host
+              ServiceKeyName: {{appName}}-html5-repo-host-key
+              sap.cloud.service: {{appName}}.service
+            - Name: {{appName}}-auth
+              Authentication: OAuth2UserTokenExchange
+              ServiceInstanceName: {{appName}}-auth
+              ServiceKeyName: {{appName}}-auth-key
+              sap.cloud.service: {{appName}}.service
+
+  - name: {{appName}}-destination
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: destination
+      service-plan: lite
+      config:
+        HTML5Runtime_enabled: true
+        init_data:
+          instance:
+            existing_destinations_policy: update
+            destinations:
+              - Name: {{appName}}-srv-api
+                URL: ~{srv-api/srv-url}
+                Authentication: NoAuthentication
+                Type: HTTP
+                ProxyType: Internet
+                HTML5.ForwardAuthToken: true
+                HTML5.DynamicDestination: true
+    requires:
+      - name: srv-api
+        group: destinations
+        properties:
+          name: srv-api # must be used in xs-app.json as well
+          url: ~{srv-url}
+          forwardAuthToken: true

package/lib/init/template/workzone-standard/index.js

@@ -0,0 +1,46 @@
+const cds = require('../../../cds')
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { join } = require('path')
+const { destination, destinations } = require('../../registries/mta')
+
+module.exports = class extends require('../../plugin') {
+
+    static help() {
+      return 'SAP BTP Work Zone, Standard Edition'
+    }
+
+    requires() {
+      return ['html5-repo', 'destination']
+    }
+
+    static hasInProduction(env) {
+      return !!env.requires?.workzone
+    }
+
+    canRun() {
+      if (cds.requires.multitenancy) {
+        throw `SAP BTP Work Zone, Standard Edition does not support multitenancy yet.`
+      }
+      return true
+    }
+
+    async run() {
+      const project = readProject()
+      const { appUIPaths, appPath } = project
+      await Promise.all(appUIPaths.map(p =>
+        merge(__dirname, 'files/manifest.json.hbs').into(join(appPath, p, 'webapp/manifest.json'), { project })
+      ))
+      await merge({ cds: { requires: { workzone: true } } }).into('package.json')
+    }
+
+    async combine() {
+      const project = readProject()
+      const { hasMta } = project
+
+      if (hasMta) {
+          const additions = [destinations, destination]
+          await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project, additions })
+      }
+  }
+}

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

@@ -1,7 +1,7 @@
 {
   {{#isNodejs}}
   "dependencies": {
-    "@sap/xssec": "^3"
+    "@sap/xssec": "^4"
   },
   "cds": {
   {{/isNodejs}}

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

@@ -19,10 +19,11 @@ xsuaa:
   serviceOfferingName: xsuaa
   servicePlanName: application
   parameters:
-    xsappname: {{appName}}
     tenant-mode: {{#hasMultitenancy}}shared{{/hasMultitenancy}}{{^hasMultitenancy}}dedicated{{/hasMultitenancy}}
 {{#hasApprouter}}
     oauth2-configuration:
       redirect-uris:
-      - https://*.<your-cluster-domain>/**
+{{=<% %>=}}
+      - https://*.{{ tpl .Values.global.domain . }}/**
+<%={{ }}=%>
 {{/hasApprouter}}

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

@@ -1,12 +1,15 @@
 const cds = require('../../../cds')
 const { read } = cds.utils
-const term = require('../../../util/term')
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
 const { srv4, xsuaa, mtxSidecar4 } = require('../../registries/mta')
 
 module.exports = class XsuaaTemplate extends require('../../plugin') {
 
+    static help() {
+        return 'authentication via XSUAA'
+    }
+
     static hasInProduction(env) {
         return env.requires?.auth?.kind === 'xsuaa'
     }
@@ -50,13 +53,14 @@ module.exports = class XsuaaTemplate extends require('../../plugin') {
 
         if (hasHelm || hasHelmUnifiedRuntime) {
             await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project })
-        }
-    }
 
-    finalize() {
-        const { hasUI, hasApprouter } = readProject()
-        if (hasUI && !hasApprouter) {
-            console.log(`\nAlso run ${term.bold('cds add approuter --for production')} to route and authenticate the paths accessed via the UI.`)
+            await merge({
+                xsuaa: {
+                    parameters: {
+                        xsappname: `${project.appName}-{{ .Release.Namespace }}`
+                    }
+                }
+            }).into('chart/values.yaml')
         }
     }
 }

package/lib/init/validate.js

@@ -0,0 +1,27 @@
+const { PROJECT_FILES } = require('./constants')
+const REGEX_PROJECT_NAME = /[^0-9a-zA-Z_-]+/g
+const cds = require('../../lib/cds')
+const { exists } = cds.utils
+const { bold } = require('../../lib/util/term')
+
+module.exports.projectName = projectName => {
+  if (!projectName) throw 'Specify a project name.'
+  const invalidChars = new Set(projectName.match(REGEX_PROJECT_NAME)) // remove duplicates
+  if (invalidChars.size > 0) {
+    throw `Project name '${projectName}' contains at least one character ('${[...invalidChars]}') which is not supported in npm package names.
+Specify a different project name by replacing characters with '_' or '-', for example '${projectName.replace(REGEX_PROJECT_NAME, '_')}' or '${projectName.replace(REGEX_PROJECT_NAME, '-')}'.`
+  }
+}
+
+module.exports.projectFolder = cwd => {
+  const existingProjectFile = PROJECT_FILES.find(exists)
+  if (existingProjectFile) {
+    let message
+    if (cwd === cds.root) {
+      message = `You seem to be working in a project which is already initialized. Use ${bold('cds add')} to add more features.`
+    } else {
+      message = `You seem to be trying to initialize an existing project. Use a different project name instead.`
+    }
+    throw `${message}\nDetails: File '${existingProjectFile}' exists in the project folder which indicates an existing project. Use ${bold('cds add')} to add more features.`
+  }
+}

package/lib/lint/generators.js

@@ -34,7 +34,7 @@ module.exports = {
     eslintOpts[0] = `
         # SYNOPSIS
 
-            ${cdslintCmd} [beta]
+            ${cdslintCmd}
 
             Runs environment checks and/or checks the specified models
             based on the ESLint framework

package/lib/lint/io.js

@@ -1,8 +1,7 @@
+const { read, write, exists, yaml } = require('../cds').utils;
+const { readJSONC } = require("../util/fs");
 const path = require("path");
-const yaml = require("@sap/cds-foss")("yaml");
 const term = require("../util/term");
-const { read, write, exists } = require('../cds').utils;
-const { readJSONC } = require("../util/fs");
 const JSONC = require('../util/jsonc');
 
 module.exports = {
@@ -226,7 +225,6 @@ module.exports = {
     switch (configFile) {
       case "eslint.config.js":
       case "eslint.config.cjs":
-      case "eslint.config.mjs":
         if (exists(configPath)) {
           logger.log(
             `${term.warn(
@@ -245,16 +243,36 @@ module.exports = [
   cds.configs.recommended,
   {
     plugins: {
-      "@sap/cds": cds
+      '@sap/cds': cds
     },
-    "files": [
+    files: [
       ...cds.configs.recommended.files
     ],
-    "rules": {
+    rules: {
       ...cds.configs.recommended.rules
     }
   }
 ]
+`)
+        }
+        break;
+      case "eslint.config.mjs":
+        if (exists(configPath)) {
+          logger.log(
+            `${term.warn(
+              `\n\nPlease add the following to your "${configFile}":` +
+              '\n\n  1. At the top of your file, import the following:')}` +
+              `\n\n     ${term.bold('import cdsPlugin from \'@sap/eslint-plugin-cds\'')}` +
+            `${term.warn(
+              '\n\n  2. In your export, add the following to the front of the array:')}` +
+            `\n\n     ${term.bold('cdsPlugin.configs.recommended')}`
+          );
+        } else {
+          await write(configPath, `
+import cds from '@sap/cds/eslint.config.mjs'
+import cdsPlugin from '@sap/eslint-plugin-cds'
+
+export default [...cds.recommended, cdsPlugin.configs.recommended]
 `)
         }
         break;

package/lib/mtx/auth_manager.js

@@ -12,9 +12,13 @@ const REASONS = { invalid_scope: /\binvalid_scope\b/ };
 
 function assign(params, authData) {
     if (authData?.access_token) {
+        let message = 'Retrieved access token';
         params.set('token', authData.access_token);
         if (authData.expires_in) {
             params.set('tokenExpirationDate', Date.now() + authData.expires_in * 1000);
+            if (params.get('saveData')) {
+                message += ` (expires on ${(new Date(params.get('tokenExpirationDate'))).toLocaleString()})`;
+            }
         } else {
             params.delete('tokenExpirationDate');
         }
@@ -23,6 +27,7 @@ function assign(params, authData) {
         } else {
             params.delete('refreshToken');
         }
+        console.log(message + '.');
     }
     if (authData?.passcode_url) {
         params.set('passcodeUrl', authData.passcode_url);
@@ -31,15 +36,19 @@ function assign(params, authData) {
 function reqParams(method, params) {
     const url = params.get('tokenUrl');
     const d = {};
+    const ignored = {};
     if (params.has('subdomain')) {
         d.subdomain = params.get('subdomain');
     }
     if (params.has('refreshToken')) {
         d.refresh_token = params.get('refreshToken');
+        const param = ['passcode', 'clientid'].find(param => params.has(param));
+        if (param) {
+            ignored[param] = 'refresh token is present';
+        }
     } else if (params.has('passcode')) {
         d.passcode = params.get('passcode');
-    }
-    if (params.has('clientsecret')) {
+    } else if (params.has('clientsecret')) {
         d.clientid = params.get('clientid');
         d.clientsecret = params.get('clientsecret');
     } else if (params.has('key')) {
@@ -48,43 +57,60 @@ function reqParams(method, params) {
     }
     const data = new URLSearchParams(d).toString();
     return method === 'post'
-        ? { url, data }
-        : { url: `${url}?${data}`, data: undefined };
+        ? { url, data, ignored }
+        : { url: `${url}?${data}`, data: undefined, ignored };
 }
 
-async function retrieveTokenOrPasscodeUrl(params) {
-    if (params.has('token') || !params.has('refreshToken') && !params.has('passcode') && params.has('passcodeUrl')) {
+async function fetchToken(params) {
+    if (params.has('token') || !(params.has('refreshToken') || params.has('passcode') || !params.has('passcodeUrl'))) {
         return;
     }
 
     let response, error;
-    reqParams: for (const method of ['post', 'get']) {
-        do {
-            const { url, data } = reqParams(method, params);
-            try {
-                DEBUG?.(`Getting authentication token or passcode URL from ${method.toUpperCase()} ${params.obfuscateQueryParams(url)}`);
-                response = await axios[method](url, data);
-            } catch (e) {
-                if (e.status === 404) { // may represent 405 in case of wrong method
-                    continue reqParams;
-                } else if (params.has('refreshToken')) {
-                    DEBUG?.('Discarding invalid refresh token');
-                    params.delete('refreshToken');
-                } else {
-                    error = e;
-                    break reqParams;
-                }
+    const method = 'post';
+    do {
+        const { url, data, ignored } = reqParams(method, params);
+        if (Object.keys(ignored).length) {
+            console.log(`Ignoring parameters for fetching token: ${Object.entries(ignored).map(([param, reason]) => `${param} (${reason})`).join(', ')}.`);
+        }
+        DEBUG?.(`Getting authentication token from ${method.toUpperCase()} ${params.obfuscateQueryParams(url)}`);
+        error = undefined;
+        try {
+            response = await axios[method](url, data);
+            break;
+        } catch (e) {
+            error = e;
+            DEBUG?.(`HTTP status ${e.status}`);
+            if (params.has('refreshToken')) {
+                DEBUG?.('Discarding invalid refresh token');
+                params.delete('refreshToken');
+            } else {
+                break;
             }
-        } while (!response);
-    }
+        }
+    } while (!response);
     const data = response?.data ?? error?.auth;
     assign(params, data);
     if (error) {
-        throw new Error(REASONS.invalid_scope.test(error.message)
-            ? 'Token has invalid scope. Check if your user has the required roles'
-            : `No valid passcode or token provided. Get a passcode${
-                params.get('passcodeUrl') ? ' from ' + params.get('passcodeUrl') : ''
-            } and re-run the command with '-p <passcode>'`, { cause: error });
+        let message;
+        if (REASONS.invalid_scope.test(error.message)) {
+            message = 'token has invalid scope. Check if your user has the required roles';
+        } else if (error.status === 404) {
+            message = 'token endpoint not found. Check if MTX is running with extensibility enabled';
+        } else if (error.message.includes('<html')) { // should already be caught when fetching passcode URL
+            message = 'HTML response received. Check if route to MTX is configured correctly in App Router';
+        } else if (error.status === 401) {
+            message = `invalid credentials`;
+            if (params.has('passcode')) {
+                message += `. Check if passcode is correct`;
+                if (params.has('passcodeUrl')) {
+                    message += `. Passcode URL: ${params.get('passcodeUrl')}`;
+                }
+            }
+        } else {
+            message = 'error on token request';
+        }
+        throw new Error(message + '.', { cause: error });
     }
 }
 
@@ -98,7 +124,7 @@ module.exports = class AuthManager {
             params.set('reqAuth', { auth: { username: params.get('username'), password: params.get('password') } });
         } else if (!params.get('skipToken')) {
             try {
-                await retrieveTokenOrPasscodeUrl(params);
+                await fetchToken(params);
             } catch (error) {
                 if (params.get('saveData')) {
                     await SettingsManager.saveSettings(params);
@@ -106,6 +132,14 @@ module.exports = class AuthManager {
                 throw getMessage('Failed to login', { error });
             }
             params.set('reqAuth', { headers: { Authorization: 'Bearer ' + params.get('token') } });
+            if (params.has('refreshToken') && params.get('saveData')) {
+                if (params.get('saveRefreshToken')) {
+                    console.log('Refresh Token saved. Token will be refreshed automatically.');
+                } else {
+                    console.log(`Note: Refresh Token is not saved by default for security reasons. Use '--save-refresh-token' to override.`);
+                    params.delete('refreshToken');
+                }
+            }
         }
 
         if (params.get('saveData')) {