@sap/cds-dk 8.7.2 → 8.8.0

package/lib/init/template/sample/files/app/admin-books/webapp/manifest.json

@@ -1,144 +1,144 @@
 {
-    "_version": "1.49.0",
-    "sap.app": {
-      "applicationVersion": {
-        "version": "1.0.0"
-      },
-      "id": "books",
-      "type": "application",
-      "title": "{{appTitle}}",
-      "description": "{{appDescription}}",
-      "i18n": "i18n/i18n.properties",
-      "dataSources": {
-        "AdminService": {
-          "uri": "odata/v4/admin/",
-          "type": "OData",
-          "settings": {
-            "odataVersion": "4.0"
-          }
-        }
-      },
-      "crossNavigation": {
-        "inbounds": {
-          "intent-Books-manage": {
-            "signature": {
-              "parameters": {},
-              "additionalParameters": "allowed"
-            },
-            "semanticObject": "Books",
-            "action": "manage"
-          }
+  "_version": "1.49.0",
+  "sap.app": {
+    "id": "admin-books",
+    "applicationVersion": {
+      "version": "1.0.0"
+    },
+    "type": "application",
+    "title": "{{appTitle}}",
+    "description": "{{appDescription}}",
+    "i18n": "i18n/i18n.properties",
+    "dataSources": {
+      "AdminService": {
+        "uri": "odata/v4/admin/",
+        "type": "OData",
+        "settings": {
+          "odataVersion": "4.0"
         }
       }
     },
-    "sap.ui": {
-      "technology": "UI5",
-      "fullWidth": false,
-      "deviceTypes": {
-          "desktop": true,
-          "tablet": true,
-          "phone": true
+    "crossNavigation": {
+      "inbounds": {
+        "intent-Books-manage": {
+          "signature": {
+            "parameters": {},
+            "additionalParameters": "allowed"
+          },
+          "semanticObject": "Books",
+          "action": "manage"
+        }
+      }
+    }
+  },
+  "sap.ui": {
+    "technology": "UI5",
+    "fullWidth": false,
+    "deviceTypes": {
+      "desktop": true,
+      "tablet": true,
+      "phone": true
+    }
+  },
+  "sap.ui5": {
+    "dependencies": {
+      "minUI5Version": "1.115.1",
+      "libs": {
+        "sap.fe.templates": {}
       }
     },
-    "sap.ui5": {
-      "dependencies": {
-        "minUI5Version": "1.115.1",
-        "libs": {
-          "sap.fe.templates": {}
-        }
+    "models": {
+      "i18n": {
+        "type": "sap.ui.model.resource.ResourceModel",
+        "uri": "i18n/i18n.properties"
       },
-      "models": {
-        "i18n": {
-          "type": "sap.ui.model.resource.ResourceModel",
-          "uri": "i18n/i18n.properties"
-        },
-        "": {
-          "dataSource": "AdminService",
-          "settings": {
-            "operationMode": "Server",
-            "autoExpandSelect": true,
-            "earlyRequests": true,
-            "groupProperties": {
-              "default": {
-                "submit": "Auto"
-              }
+      "": {
+        "dataSource": "AdminService",
+        "settings": {
+          "operationMode": "Server",
+          "autoExpandSelect": true,
+          "earlyRequests": true,
+          "groupProperties": {
+            "default": {
+              "submit": "Auto"
             }
           }
         }
-      },
-      "routing": {
-        "routes": [
-          {
-            "pattern": ":?query:",
-            "name": "BooksList",
-            "target": "BooksList"
-          },
-          {
-            "pattern": "Books({key}):?query:",
-            "name": "BooksDetails",
-            "target": "BooksDetails"
-          },
-          {
-            "pattern": "Books({key}/author({key2}):?query:",
-            "name": "AuthorsDetails",
-            "target": "AuthorsDetails"
-          }
-        ],
-        "targets": {
-          "BooksList": {
-            "type": "Component",
-            "id": "BooksList",
-            "name": "sap.fe.templates.ListReport",
-            "options": {
-              "settings": {
-                "entitySet": "Books",
-                "initialLoad": true,
-                "navigation": {
-                  "Books": {
-                    "detail": {
-                      "route": "BooksDetails"
-                    }
+      }
+    },
+    "routing": {
+      "routes": [
+        {
+          "pattern": ":?query:",
+          "name": "BooksList",
+          "target": "BooksList"
+        },
+        {
+          "pattern": "Books({key}):?query:",
+          "name": "BooksDetails",
+          "target": "BooksDetails"
+        },
+        {
+          "pattern": "Books({key}/author({key2}):?query:",
+          "name": "AuthorsDetails",
+          "target": "AuthorsDetails"
+        }
+      ],
+      "targets": {
+        "BooksList": {
+          "type": "Component",
+          "id": "BooksList",
+          "name": "sap.fe.templates.ListReport",
+          "options": {
+            "settings": {
+              "entitySet": "Books",
+              "initialLoad": true,
+              "navigation": {
+                "Books": {
+                  "detail": {
+                    "route": "BooksDetails"
                   }
                 }
               }
             }
-          },
-          "BooksDetails": {
-            "type": "Component",
-            "id": "BooksDetailsList",
-            "name": "sap.fe.templates.ObjectPage",
-            "options": {
-              "settings": {
-                "entitySet": "Books",
-                "navigation": {
-                  "Authors": {
-                    "detail": {
-                      "route": "AuthorsDetails"
-                    }
+          }
+        },
+        "BooksDetails": {
+          "type": "Component",
+          "id": "BooksDetailsList",
+          "name": "sap.fe.templates.ObjectPage",
+          "options": {
+            "settings": {
+              "entitySet": "Books",
+              "navigation": {
+                "Authors": {
+                  "detail": {
+                    "route": "AuthorsDetails"
                   }
                 }
               }
             }
-          },
-          "AuthorsDetails": {
-            "type": "Component",
-            "id": "AuthorsDetailsList",
-            "name": "sap.fe.templates.ObjectPage",
-            "options": {
-              "settings": {
-                "entitySet": "Authors"
-              }
+          }
+        },
+        "AuthorsDetails": {
+          "type": "Component",
+          "id": "AuthorsDetailsList",
+          "name": "sap.fe.templates.ObjectPage",
+          "options": {
+            "settings": {
+              "entitySet": "Authors"
             }
           }
         }
-      },
-      "contentDensities": {
-        "compact": true,
-        "cozy": true
       }
     },
-    "sap.fiori": {
-      "registrationIds": [],
-      "archeType": "transactional"
+    "contentDensities": {
+      "compact": true,
+      "cozy": true
     }
+  },
+  "sap.fiori": {
+    "registrationIds": [],
+    "archeType": "transactional"
   }
+}

package/lib/init/template/sample/files/app/browse/webapp/manifest.json

@@ -1,7 +1,7 @@
 {
   "_version": "1.49.0",
   "sap.app": {
-    "id": "bookshop",
+    "id": "browse-books",
     "applicationVersion": {
       "version": "1.0.0"
     },

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

@@ -1,6 +1,4 @@
 const cds = require('../../../cds')
-const { readProject } = require('../../projectReader')
-const { merge, sort } = require('../../merge')
 
 module.exports = class extends require('../../plugin') {
 
@@ -8,18 +6,7 @@ module.exports = class extends require('../../plugin') {
     return !!env.requires?.telemetry || cds.cli.argv?.includes('telemetry') || !!cds.cli.options?.add?.telemetry
   }
 
-  async canRun() {
-    return true
-  }
-
   requires() {
     return ['cloud-logging']
   }
-
-  async run() {
-    const project = readProject();
-    project.profile ??= 'production'
-    await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: project })
-    await sort('package.json', 'dependencies')
-  }
 }

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

@@ -4,5 +4,8 @@
   },
   "imports": {
     "#cds-models/*": "./@cds-models/*/index.js"
+  },
+  "scripts": {
+    "before:cds-watch": "cds-typer \"*\""
   }
 }

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

@@ -0,0 +1,97 @@
+{
+  "_version": "3.0.0",
+  "identification": {
+    "title": "{{appName}}",
+    "id": "{{appName}}-workzone",
+    "entityType": "bundle"
+  },
+  "payload": {
+    "catalogs": [
+      {
+        "_version": "3.0.0",
+        "identification": {
+          "id": "{{appName}}-catalog",
+          "title": "{{#literal}}{{title}}{{/literal}}",
+          "entityType": "catalog",
+          "i18n": "i18n/catalog.properties"
+        },
+        "payload": {
+          "viz": [
+            {{#apps}}
+            {
+              "appId": "{{manifestAppId}}",
+              "vizId": "{{vizId}}"
+            }{{#isNotLast}},{{/isNotLast}}
+            {{/apps}}
+          ]
+        }
+      }
+    ],
+    "groups": [
+      {
+        "_version": "3.0.0",
+        "identification": {
+          "id": "{{appName}}-group",
+          "title": "{{#literal}}{{title}}{{/literal}}",
+          "entityType": "group",
+          "i18n": "i18n/group.properties"
+        },
+        "payload": {
+          "viz": [
+            {{#apps}}
+            {
+              "id": "{{appName}}{{app}}-001",
+              "appId": "{{manifestAppId}}",
+              "vizId": "{{vizId}}"
+            }{{#isNotLast}},{{/isNotLast}}
+            {{/apps}}
+          ]
+        }
+      }
+    ],
+    "sites": [
+      {
+        "_version": "3.0.0",
+        "identification": {
+          "id": "{{appName}}-site",
+          "entityType": "site",
+          "title": "{{appName}}",
+          "description": "{{appDescription}}"
+        },
+        "payload": {
+          "config": {
+            "ushellConfig": {
+              "renderers": {
+                "fiori2": {
+                  "componentData": {
+                    "config": {
+                      "applications": {
+                        "Shell-home": {}
+                      },
+                      "enableSearch": true,
+                      "enablePersonalization": true,
+                      "enableSetTheme": true,
+                      "enableSetLanguage": true
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "groupsOrder": ["{{appName}}-group"],
+          "sap.cloud.portal": {
+            "config": {
+              "theme.id": "sap_horizon",
+              "theme.active": [
+                "sap_horizon",
+                "sap_horizon_dark",
+                "sap_horizon_hcw",
+                "sap_horizon_hcb"
+              ]
+            }
+          }
+        }
+      }
+    ]
+  }
+}

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

@@ -40,6 +40,12 @@ modules:
               ServiceKeyName: {{appName}}-auth-key
               sap.cloud.service: {{strippedAppName}}.service
 
+  - name: {{appName}}-mtx
+    type: nodejs
+    path: {{#isNodejs}}gen/{{/isNodejs}}mtx/sidecar
+    requires:
+      - name: {{appName}}-html5-repo-host
+
 resources:
   - name: {{appName}}-destination
     type: org.cloudfoundry.managed-service
@@ -49,6 +55,17 @@ resources:
       config:
         HTML5Runtime_enabled: true
         init_data:
+          {{#hasMultitenancy}}
+          subaccount:
+            existing_destinations_policy: update
+            destinations:
+              - Name: {{appName}}-workzone-runtime
+                Authentication: NoAuthentication
+                Type: HTTP
+                ProxyType: Internet
+                URL: https://${org}.launchpad.${default-domain}
+                CEP.HTML5contentprovider: true
+          {{/hasMultitenancy}}
           instance:
             existing_destinations_policy: update
             destinations:
@@ -66,3 +83,9 @@ resources:
           name: srv-api # must be used in xs-app.json as well
           url: ~{srv-url}
           forwardAuthToken: true
+
+  - name: {{appName}}-html5-repo-host
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: html5-apps-repo
+      service-plan: app-host

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

@@ -1,57 +1,88 @@
 const cds = require('../../../cds')
+const { read, write } = cds.utils
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
 const { join } = require('path')
-const { destination, destinations, srv4 } = require('../../registries/mta')
+const { destination, destinations, srv4, html5RepoHost, mtxSidecar4 } = require('../../registries/mta')
 const { odataApi } = require('../../registries/xs-app')
 
 module.exports = class extends require('../../plugin') {
 
-    static help() {
-      return 'SAP BTP Work Zone, Standard Edition'
+  options() {
+    return {
+      'cdm': {
+        describe: 'Add Common Data Model',
+        type: 'boolean'
+      }
     }
+  }
 
-    requires() {
-      return ['html5-repo', 'destination']
-    }
+  static help() {
+    return 'SAP BTP Work Zone, Standard Edition'
+  }
 
-    static hasInProduction(env) {
-      return !!env.requires?.workzone || cds.cli.options.add.has('workzone-standard')
-    }
+  requires() {
+    return ['html5-repo', 'destination']
+  }
+
+  static hasInProduction(env) {
+    return !!env.requires?.workzone || cds.cli.options.add.has('workzone-standard')
+  }
 
-    async run() {
+  async run() {
+    await merge({ cds: { requires: { workzone: true } } }).into('package.json')
+
+    if (cds.cli.options.cdm) {
       const project = readProject()
-      const { appUIPaths, appPath } = project
-      await Promise.all(appUIPaths.map(p => {
-        project.uiApp = p
-        return merge(__dirname, 'files/manifest.json.hbs').into(join(appPath, p, 'webapp/manifest.json'), { project })
-      }))
-      await merge({ cds: { requires: { workzone: true } } }).into('package.json')
+      await merge(join(__dirname, 'files/cdm.json.hbs')).into('app/workzone/cdm.json', { project })
     }
+  }
 
-    async combine() {
-      const project = readProject()
-      const { hasMta, srvPath, apps, appPath } = project
-
-      await Promise.all(apps.map(async ({app}) => {
-        const additions = [odataApi]
-        const overwrites = [{
-          item: [odataApi, 'destination'],
-          withValue: `${project.appName}-srv-api`
-        }]
-        project.app = app
-        await merge(__dirname, 'files/xs-app.json.hbs').into(join(appPath, app, 'xs-app.json'), { with: project, additions, overwrites })
-      }))
-
-      if (hasMta) {
-        const srv = srv4(srvPath)
-        const additions = [srv, destinations, destination,
-          {
-            in: [destination, 'requires'],
-            where: { name: 'srv-api' }
-          }
-        ]
-        await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project, additions })
+  async combine() {
+    const project = readProject()
+    const { isJava, hasMta, srvPath, apps, appPath, appName, appUIPaths, hasMultitenancy } = project
+
+    await Promise.all(appUIPaths.map(p => {
+      project.uiApp = p
+      return merge(__dirname, 'files/manifest.json.hbs').into(join(appPath, p, 'webapp/manifest.json'), { project })
+    }))
+
+    await Promise.all(apps.map(async ({ app }) => {
+      const additions = [odataApi]
+      const overwrites = [{
+        item: [odataApi, 'destination'],
+        withValue: `${appName}-srv-api`
+      }]
+      project.app = app
+      await merge(__dirname, 'files/xs-app.json.hbs').into(join(appPath, app, 'xs-app.json'), { with: project, additions, overwrites })
+    }))
+
+    if (hasMultitenancy) {
+      const mtxPackageJson = await read('mtx/sidecar/package.json')
+      mtxPackageJson.cds.requires['html5-host'] = true
+      delete mtxPackageJson.cds.requires['html5-repo']
+      // delete mtxPackageJson.cds.requires['html5-runtime']
+      // delete mtxPackageJson.cds.requires['destinations']
+      await write('mtx/sidecar/package.json', mtxPackageJson, { spaces: 2 })
+    }
+
+    if (hasMta) {
+      const srv = srv4(srvPath)
+      const additions = [srv, destinations, destination, {
+        in: [destination, 'requires'],
+        where: { name: 'srv-api' }
+      }]
+      const relationships = []
+      if (hasMultitenancy) {
+        additions.push(html5RepoHost)
+        relationships.push({
+          insert: [html5RepoHost, 'name'],
+          into: [mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar'), 'requires', 'name']
+        })
       }
+
+
+      await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project, additions, relationships })
+    }
   }
 }

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

@@ -15,11 +15,11 @@ modules:
 {{/hasMultitenancy}}
 
 resources:
-  - name: {{appName}}-auth
+  - name: {{appName}}-auth{{#servicePlan}}-{{servicePlan}}{{/servicePlan}}
     type: org.cloudfoundry.managed-service
     parameters:
       service: xsuaa
-      service-plan: application
+      service-plan: {{#servicePlan}}{{servicePlan}}{{/servicePlan}}{{^servicePlan}}application{{/servicePlan}}
       path: ./xs-security.json
       config:
         xsappname: {{appName}}-${org}-${space}

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

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