@sap/cds-dk 10.1.2 → 10.2.1

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

@@ -2,7 +2,7 @@ const cds = require('../../../cds')
 const { path } = cds.utils
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
-const { srv4, portal, portalDeployer, xsuaa, html5RepoHost, appDeployer, approuter, mtxSidecar4 } = require('../../registries/mta')
+const { srv4, portal, portalDeployer, xsuaa, ias, html5RepoHost, appDeployer, approuter, mtxSidecar4 } = require('../../registries/mta')
 const { renderAndCopy } = require('../../template')
 const KymaTemplate = require('../kyma')
 
@@ -29,13 +29,13 @@ module.exports = class PortalTemplate extends require('../../plugin') {
 
   async combine(facet) {
     const project = readProject(facet)
-    const { isJava, addMta, hasMta, srv, apps, addHtml5Repo, addXsuaa, addApprouter, addMultitenancy, addKyma, hasApprouter, hasHtml5Repo, hasMultitenancy, hasXsuaa } = project
+    const { isJava, affected, srv, apps } = project
 
-    if (addMultitenancy) {
+    if (affected('multitenancy')) {
       await merge(__dirname, 'files/package.sidecar.json').into('mtx/sidecar/package.json')
     }
 
-    if (addMta || (addXsuaa || addHtml5Repo || addApprouter || addMultitenancy) && hasMta) {
+    if (affected('mta', 'xsuaa', 'ias', 'html5-repo', 'approuter', 'multitenancy', 'sample')) {
       const srvModule = srv4(srv.path)
       const hasApps = apps.length > 0
       project.withApps = hasApps
@@ -44,34 +44,40 @@ module.exports = class PortalTemplate extends require('../../plugin') {
         insert: [portal, 'name'],
         into: [portalDeployer, 'requires', 'name']
       }]
-      if (hasApps) {
+      if (hasApps && affected('mta', 'sample')) {
         relationships.push({
           insert: [appDeployer, 'name'],
           into: [portalDeployer, 'requires', 'name']
         })
       }
 
-      if (hasXsuaa) {
+      if (affected('xsuaa', 'mta')) {
         relationships.push({
           insert: [xsuaa, 'name'],
           into: [portalDeployer, 'requires', 'name']
         })
       }
-      if (hasHtml5Repo) {
+      if (affected('ias', 'mta')) {
+        relationships.push({
+          insert: [ias, 'name'],
+          into: [portalDeployer, 'requires', 'name']
+        })
+      }
+      if (affected('html5-repo', 'mta')) {
         relationships.push({
           insert: [html5RepoHost, 'name'],
           into: [portalDeployer, 'requires', 'name']
         })
       }
 
-      if (hasApprouter) {
+      if (affected('approuter', 'mta')) {
         relationships.push({
             insert: [portal, 'name'],
             into: [approuter, 'requires', 'name']
         })
       }
 
-      if (hasMultitenancy) {
+      if (affected('multitenancy', 'mta')) {
         relationships.push({
           insert: [portal, 'name'],
           into: [isJava ? srvModule : mtxSidecar4('gen/mtx/sidecar'), 'requires', 'name']
@@ -83,7 +89,7 @@ module.exports = class PortalTemplate extends require('../../plugin') {
       })
     }
 
-    if (addKyma) {
+    if (affected('kyma', 'ias')) {
       await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project })
       await KymaTemplate.mergeDependency('service-instance', 'portal')
       await renderAndCopy(path.join(__dirname, 'files/portal-site'), path.join(project.html5DeployerPath, 'portal/portal-site'), project)

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

@@ -29,9 +29,9 @@ module.exports = class PostgresTemplate extends require('../../plugin') {
 
   async combine(facet) {
     const project = readProject(facet)
-    const { addMta, srv, hasMultitenancy, addKyma, hasKyma, addMultitenancy } = project
+    const { affected, srv, hasMultitenancy, hasKyma } = project
 
-    if (addMta) {
+    if (affected('mta')) {
       const srvModule = srv4(srv.path)
       await merge(__dirname, 'files/mta.yml.hbs').into('mta.yaml', {
         project,
@@ -46,7 +46,7 @@ module.exports = class PostgresTemplate extends require('../../plugin') {
       })
     }
 
-    if (!hasMultitenancy && addKyma) {
+    if (affected('kyma') && !hasMultitenancy) {
       const clusterIPGuess = execSync(`kubectl --namespace kyma-system get configmap kyma-info -o json | jq -r '.data["cloud.natGatewayIps"]'`, { stdio: "pipe" }).toString()
       project['KYMA_GATEWAY_IP'] = clusterIPGuess.replace(/\n/g, '')
       await merge(__dirname, 'files', 'values.yaml.hbs').into('chart/values.yaml', { with: project })
@@ -54,7 +54,7 @@ module.exports = class PostgresTemplate extends require('../../plugin') {
       await KymaTemplate.mergeDependency('content-deployment', 'postgres-deployer')
     }
 
-    if (addMultitenancy && hasKyma) {
+    if (affected('multitenancy') && hasKyma) {
       await merge('chart/values.yaml')
         .remove(['postgres-deployer', 'srv.bindings.db', 'postgres'])
 
@@ -65,7 +65,7 @@ module.exports = class PostgresTemplate extends require('../../plugin') {
         ])
     }
 
-     if (addKyma && !hasMultitenancy) {
+    if (affected('kyma') && !hasMultitenancy) {
       const additions = [{
           in: 'modules',
           where: { name: `${project.appName}-postgres-deployer` }

package/lib/init/template/react/files/index.html.hbs

@@ -8,6 +8,6 @@
   </head>
   <body>
     <div id="root"></div>
-    <script type="module" src="/src/main.jsx"></script>
+    <script type="module" src="/src/main.{{jsxExtension}}"></script>
   </body>
 </html>

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

@@ -5,7 +5,7 @@
   "type": "module",
   "scripts": {
     "dev": "vite",
-    "build": "vite build",
+    "build": "{{#typescript}}tsc -b && {{/typescript}}vite build",
     "preview": "vite preview"
   },
   "dependencies": {
@@ -17,6 +17,7 @@
     "@types/react-dom": "^19",
     "@vitejs/plugin-react": "^6",
     "adm-zip": "^0",
-    "vite": "^8"
+    {{#typescript}}"typescript": "~5.9.3",
+    {{/typescript}}"vite": "^8"
   }
 }

package/lib/init/template/react/files/src/{App.jsx.hbs → App.{{jsxExtension}}.hbs}

@@ -1,7 +1,13 @@
 import { useEffect, useState } from 'react'
 
-export default function App() {
-  const [books, setBooks] = useState([])
+{{#typescript}}interface Book {
+  ID: string
+  title: string
+  author?: string
+}
+
+{{/typescript}}export default function App() {
+  const [books, setBooks] = useState{{#typescript}}<Book[]>{{/typescript}}([])
 
   useEffect(() => {
     fetch('/odata/v4/{{#isJava}}CatalogService{{/isJava}}{{^isJava}}catalog{{/isJava}}/Books')

package/lib/init/template/react/files/src/{main.jsx → main.{{jsxExtension}}.hbs}

@@ -1,9 +1,9 @@
 import { StrictMode } from 'react'
 import { createRoot } from 'react-dom/client'
 import './index.css'
-import App from './App.jsx'
+import App from './App{{^typescript}}.jsx{{/typescript}}'
 
-createRoot(document.getElementById('root')).render(
+createRoot(document.getElementById('root'){{#typescript}}!{{/typescript}}).render(
   <StrictMode>
     <App />
   </StrictMode>,

package/lib/init/template/react/files/{vite.config.js.hbs → vite.config.{{extension}}.hbs}

@@ -1,8 +1,7 @@
-import { defineConfig } from 'vite'
 import AdmZip from 'adm-zip'
 import react from '@vitejs/plugin-react'
 
-export default defineConfig({
+export default {
   base: '{{{base}}}',
   plugins: [react(), {
       name: 'zip-dist', // zipping ./dist is required for BTP HTML5 repo or Application Frontend deployment
@@ -17,4 +16,4 @@ export default defineConfig({
       '/odata': 'http://localhost:4004'
     }
   }
-})
+}

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

@@ -1,6 +1,8 @@
 const cds = require('../../../cds')
-const { path, sh: $ } = cds.utils
+const { path } = cds.utils
 const { renderAndCopy } = require('../../template')
+const { merge } = require('../../merge')
+const { readProject } = require('../../projectReader')
 
 module.exports = class ReactTemplate extends require('../../plugin') {
 
@@ -10,6 +12,14 @@ module.exports = class ReactTemplate extends require('../../plugin') {
         type: 'string',
         short: 'i',
         help: `Name of the app folder in 'app/'. Example: 'catalog' → 'app/catalog'. Omit for a single-UI scenario where the Vite app sits directly in 'app/'.`
+      },
+      'ts': {
+        type: 'boolean',
+        help: 'Override the inferred project type and generate a TypeScript app.'
+      },
+      'js': {
+        type: 'boolean',
+        help: 'Override the inferred project type and generate a JavaScript app.'
       }
     }
   }
@@ -23,15 +33,22 @@ module.exports = class ReactTemplate extends require('../../plugin') {
     const isRoot = !into || into === '.' || into === ''
     const app = isRoot ? path.basename(cds.root) : into
     const target = isRoot ? cds.env.folders.app : path.join(cds.env.folders.app, into)
+    const modelsPath = path.relative(target, '@cds-models').split(path.sep).join('/')
+    if (cds.cli.options.ts && cds.cli.options.js) throw "options '--ts' and '--js' cannot be combined"
+    const typescript = cds.cli.options.ts || !cds.cli.options.js && readProject().isTypescript
     await renderAndCopy(path.join(__dirname, 'files'), target, {
       app,
+      typescript,
+      extension: typescript ? 'ts' : 'js',
+      jsxExtension: typescript ? 'tsx' : 'jsx',
       isJava: cds.env['project-nature'] === 'java',
       isRoot,
-      base: isRoot ? '/' : `/${into}/`,
+      base: './',
       archiveName: isRoot ? app : into,
+      modelsPath,
     })
-    let prefix = target
-    if (cds.cli.command === 'init') prefix = path.join(cds.cli.argv[0], target)
-    await $`npm i --prefix ${prefix}`
+    if (typescript) await renderAndCopy(path.join(__dirname, 'typescript'), target, { modelsPath })
+    await merge({ scripts: { watch: 'cds watch --exclude app/' }, workspaces: ['app/*'] }).into('package.json')
+    if (typescript) await merge({ compilerOptions: { noEmit: true }, exclude: ['app'] }).into('tsconfig.json')
   }
 }

package/lib/init/template/react/typescript/src/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/lib/init/template/react/typescript/tsconfig.json.hbs

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "types": ["vite/client"],
+    "paths": {
+      "#cds-models/*": ["{{& modelsPath}}/*"]
+    }
+  },
+  "include": ["src"]
+}

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

@@ -26,9 +26,9 @@ module.exports = class extends require('../../plugin') {
 
   async combine(facet) {
     const project = readProject(facet)
-    const { addMta, srv } = project
+    const { affected, srv } = project
 
-    if (addMta) {
+    if (affected('mta')) {
       const srvModule = srv4(srv.path)
       await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
         project,

package/lib/init/template/sample/files/app/index.html.hbs

@@ -0,0 +1,18 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>{{appName}}</title>
+  <style>html, body, body > div, #container, #container-uiarea { height: 100%; }</style>
+  <script id="sap-ui-bootstrap" src="https://ui5.sap.com/resources/sap-ui-core.js"
+    data-sap-ui-theme="sap_horizon"
+    data-sap-ui-compat-version="edge"
+    data-sap-ui-async="true"
+    data-sap-ui-on-init="module:sap/ui/core/ComponentSupport"
+    data-sap-ui-resourceroots='{"{{appName}}.{{app}}":"./"}'></script>
+</head>
+<body class="sapUiBody">
+  <div data-sap-ui-component data-name="{{appName}}.{{app}}" data-id="container" data-settings='{"id":"{{app}}"}'></div>
+</body>
+</html>

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

@@ -35,6 +35,7 @@ module.exports = class SampleTemplate extends require('../../plugin') {
             for (const uiApp of ['admin-books', 'admin-authors', 'browse', 'genres']) {
                 project.app = uiApp
                 await renderAndCopy(join(__dirname, 'files/app', uiApp), join(app, uiApp), project)
+                await renderAndCopy(join(__dirname, 'files/app/index.html.hbs'), join(app, uiApp, 'webapp/index.html'), project)
             }
             await Promise.all([
                 copy(join(__dirname, 'files/app/common.cds')).to(app, 'common.cds'),

package/lib/init/template/side-by-side-extensibility/index.js

@@ -28,8 +28,11 @@ module.exports = class extends require('../../plugin') {
       await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project })
     }
 
-    async combine() {
-      const project = readProject()
-      await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project, additions: [destinations, destinationSideBySideExtensibility]})
+    async combine(facet) {
+      const project = readProject(facet)
+      const { affected } = project
+      if (affected('mta')) {
+        await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project, additions: [destinations, destinationSideBySideExtensibility]})
+      }
     }
 }

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

@@ -7,10 +7,12 @@
     "forceConsistentCasingInFileNames": true,
     "strict": true,
     "skipLibCheck": true,
+    "noEmit": true,
     "sourceMap": true,
     "allowJs": true,
     "paths": {
       "@sap/cds": ["./node_modules/@cap-js/cds-types"]
     }
-  }
+  },
+  "exclude": ["app"]
 }

package/lib/init/template/vue/files/index.html.hbs

@@ -8,6 +8,6 @@
   </head>
   <body>
     <div id="app"></div>
-    <script type="module" src="/src/main.js"></script>
+    <script type="module" src="/src/main.{{extension}}"></script>
   </body>
 </html>

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

@@ -14,6 +14,7 @@
   "devDependencies": {
     "@vitejs/plugin-vue": "^6",
     "adm-zip": "^0",
-    "vite": "^8"
+    {{#typescript}}"typescript": "~5.9.3",
+    {{/typescript}}"vite": "^8"
   }
 }

package/lib/init/template/vue/files/src/App.vue.hbs

@@ -1,7 +1,13 @@
-<script setup>
+<script setup{{#typescript}} lang="ts"{{/typescript}}>
 import { ref, onMounted } from 'vue'
 
-const books = ref([])
+{{#typescript}}interface Book {
+  ID: string
+  title: string
+  author?: string
+}
+
+{{/typescript}}const books = ref{{#typescript}}<Book[]>{{/typescript}}([])
 
 onMounted(async () => {
   const r = await fetch('/odata/v4/{{#isJava}}CatalogService{{/isJava}}{{^isJava}}catalog{{/isJava}}/Books')

package/lib/init/template/vue/files/{vite.config.js.hbs → vite.config.{{extension}}.hbs}

@@ -1,8 +1,7 @@
-import { defineConfig } from 'vite'
 import AdmZip from 'adm-zip'
 import vue from '@vitejs/plugin-vue'
 
-export default defineConfig({
+export default {
   base: '{{{base}}}',
   plugins: [vue(), {
       name: 'zip-dist', // zipping ./dist is required for BTP HTML5 repo or Application Frontend deployment
@@ -17,4 +16,4 @@ export default defineConfig({
       '/odata': 'http://localhost:4004'
     }
   }
-})
+}

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

@@ -1,6 +1,8 @@
 const cds = require('../../../cds')
-const { path, sh: $ } = cds.utils
+const { path } = cds.utils
 const { renderAndCopy } = require('../../template')
+const { merge } = require('../../merge')
+const { readProject } = require('../../projectReader')
 
 module.exports = class VueTemplate extends require('../../plugin') {
 
@@ -10,6 +12,14 @@ module.exports = class VueTemplate extends require('../../plugin') {
         type: 'string',
         short: 'i',
         help: `Name of the app folder in 'app/'. Example: 'catalog' → 'app/catalog'. Omit for a single-UI scenario where the Vite app sits directly in 'app/'.`
+      },
+      'ts': {
+        type: 'boolean',
+        help: 'Override the inferred project type and generate a TypeScript app.'
+      },
+      'js': {
+        type: 'boolean',
+        help: 'Override the inferred project type and generate a JavaScript app.'
       }
     }
   }
@@ -23,16 +33,20 @@ module.exports = class VueTemplate extends require('../../plugin') {
     const isRoot = !into || into === '.' || into === ''
     const app = isRoot ? path.basename(cds.root) : into
     const target = isRoot ? cds.env.folders.app : path.join(cds.env.folders.app, into)
+    if (cds.cli.options.ts && cds.cli.options.js) throw "options '--ts' and '--js' cannot be combined"
+    const typescript = cds.cli.options.ts || !cds.cli.options.js && readProject().isTypescript
     await renderAndCopy(path.join(__dirname, 'files'), target, {
       app,
+      typescript,
+      extension: typescript ? 'ts' : 'js',
       isJava: cds.env['project-nature'] === 'java',
       isRoot,
-      base: isRoot ? '/' : `/${into}/`,
+      base: './',
       archiveName: isRoot ? app : into,
       literal: () => text => text,
     })
-    let prefix = target
-    if (cds.cli.command === 'init') prefix = path.join(cds.cli.argv[0], target)
-    await $`npm i --prefix ${prefix}`
+    if (typescript) await renderAndCopy(path.join(__dirname, 'typescript'), target)
+    await merge({ scripts: { watch: 'cds watch --exclude app/' }, workspaces: ['app/*'] }).into('package.json')
+    if (typescript) await merge({ compilerOptions: { noEmit: true }, exclude: ['app'] }).into('tsconfig.json')
   }
 }

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

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "types": ["vite/client"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.vue"]
+}

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

@@ -56,9 +56,9 @@ resources:
     parameters:
       service: destination
       service-plan: lite
-      {{#hasMultitenancy}}
       config:
         HTML5Runtime_enabled: true
+        {{#hasMultitenancy}}
         init_data:
           subaccount:
             existing_destinations_policy: update
@@ -69,7 +69,7 @@ resources:
                 ProxyType: Internet
                 URL: https://${org}.launchpad.${default-domain}
                 CEP.HTML5contentprovider: true
-      {{/hasMultitenancy}}
+        {{/hasMultitenancy}}
     requires:
       - name: srv-api
 

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

@@ -41,33 +41,35 @@ module.exports = class extends require('../../plugin') {
 
   async combine(facet) {
     const project = readProject(facet)
-    const { isJava, addMta, hasMta, srv, apps, appPath, appUIPaths, addMultitenancy, addXsuaa, strippedAppName } = project
+    const { isJava, affected, srv, apps, appPath, appUIPaths, strippedAppName } = project
 
-    await Promise.all(appUIPaths.map(async p => {
-      project.uiApp = p
-      const manifestPath = join(appPath, p, 'webapp/manifest.json')
-      const manifest = exists(manifestPath) ? await read(manifestPath) : {}
-      if (!manifest['sap.app']?.crossNavigation?.inbounds) {
-        return merge(__dirname, 'files/manifest.json.hbs').into(join(appPath, p, 'webapp/manifest.json'), { project })
-      } else {
-        return merge({ 'sap.cloud': {
-          public: true,
-          service: `${strippedAppName}.service`
-        }}).into(join(appPath, p, 'webapp/manifest.json'), { project })
-      }
-    }))
+    if (affected('workzone-standard', 'sample', 'xsuaa')) {
+      await Promise.all(appUIPaths.map(async p => {
+        project.uiApp = p
+        const manifestPath = join(appPath, p, 'webapp/manifest.json')
+        const manifest = exists(manifestPath) ? await read(manifestPath) : {}
+        if (!manifest['sap.app']?.crossNavigation?.inbounds) {
+          return merge(__dirname, 'files/manifest.json.hbs').into(join(appPath, p, 'webapp/manifest.json'), { project })
+        } else {
+          return merge({ 'sap.cloud': {
+            public: true,
+            service: `${strippedAppName}.service`
+          }}).into(join(appPath, p, 'webapp/manifest.json'), { project })
+        }
+      }))
 
-    await Promise.all(apps.map(async ({ app }) => {
-      const additions = [srvApi]
-      const overwrites = [{
-        item: [srvApi, 'destination'],
-        withValue: `srv-api`
-      }]
-      project.app = app
-      await merge(__dirname, 'files/xs-app.json.hbs').into(join(appPath, app, 'xs-app.json'), { with: project, additions, overwrites })
-    }))
+      await Promise.all(apps.map(async ({ app }) => {
+        const additions = [srvApi]
+        const overwrites = [{
+          item: [srvApi, 'destination'],
+          withValue: `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 (addMultitenancy) {
+    if (affected('multitenancy')) {
       const mtxPackageJson = await read('mtx/sidecar/package.json')
       mtxPackageJson.cds ??= {}
       mtxPackageJson.cds.requires ??= {}
@@ -78,20 +80,20 @@ module.exports = class extends require('../../plugin') {
       await write('mtx/sidecar/package.json', mtxPackageJson, { spaces: 2 })
     }
 
-    if (addMta || (addMultitenancy || addXsuaa) && hasMta) {
+    if (affected('mta', 'multitenancy', 'xsuaa')) {
       const srvModule = srv4(srv.path)
       const additions = [srvModule, destinations, destination, {
         in: [destination, 'requires'],
         where: { name: 'srv-api' }
       }]
       const relationships = []
-      if (addMultitenancy) {
+      if (affected('multitenancy')) {
         relationships.push({
           insert: [html5RepoHost, 'name'],
           into: [mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar'), 'requires', 'name']
         })
       }
-      if (addXsuaa) {
+      if (affected('xsuaa')) {
         relationships.push({
           insert: [xsuaa, 'name'],
           into: [destinations, 'requires']

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

@@ -13,7 +13,7 @@ modules:
       - name: {{appName}}-auth
 
 resources:
-  - name: {{appName}}-auth{{#servicePlan}}-{{servicePlan}}{{/servicePlan}}
+  - name: {{appName}}-auth
     type: org.cloudfoundry.managed-service
     parameters:
       service: xsuaa

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

@@ -17,7 +17,7 @@ srv:
       serviceInstanceName: xsuaa
 xsuaa:
   serviceOfferingName: xsuaa
-  servicePlanName: application
+  servicePlanName: {{#servicePlan}}{{servicePlan}}{{/servicePlan}}{{^servicePlan}}application{{/servicePlan}}
   parameters:
     tenant-mode: {{#hasMultitenancy}}shared{{/hasMultitenancy}}{{^hasMultitenancy}}dedicated{{/hasMultitenancy}}
     oauth2-configuration: