@sap/cds-dk 10.1.2 → 10.2.0

package/lib/init/template/data/as-json.js

@@ -32,6 +32,13 @@ const asJson = module.exports = async (data, csn, numRecords=1, options={}) => {
   // sort all entities first that are referenced by others, so that dependant entities can be created after them
   const { definitions: defs } = csn
   const names = Object.keys(data).sort((n1, n2) => {
+    // Enum code lists have a fixed, model-defined set of keys. Generate them first,
+    // so that associations referencing them reuse these records (one per enum value)
+    // instead of eagerly creating a random one.
+    const n1IsEnum = !!enumKeyOf(defs[n1])
+    const n2IsEnum = !!enumKeyOf(defs[n2])
+    if (n1IsEnum && !n2IsEnum)  return -1
+    if (!n1IsEnum && n2IsEnum)  return 1
     const n1HasComp = Object.values(defs[n1].elements??[]).some(el => el.type === 'cds.Composition')
     const n2HasComp = Object.values(defs[n2].elements??[]).some(el => el.type === 'cds.Composition')
     if (n1HasComp && !n2HasComp)  return -1
@@ -45,11 +52,20 @@ const asJson = module.exports = async (data, csn, numRecords=1, options={}) => {
   addSemantics(csn)
 
   for (const name of names) {
-    if (!data[name] // removed on purpose because records are created inline through compositions
-      || data[name].length >= numRecords) { // numRecords already created by following associations
+    if (!data[name])  continue // removed on purpose because records are created inline through compositions
+
+    const artifact = defs[name]
+
+    // Code lists with an enum key have a fixed, model-defined set of keys.
+    // Generate exactly one record per enum value so the sample data matches all code list keys.
+    const enumKey = enumKeyOf(artifact)
+    if (enumKey) {
+      if (data[name].length === 0)  fillEnumCodeList(name, artifact, enumKey, csn, data, referenceData)
       continue
     }
 
+    if (data[name].length >= numRecords)  continue // numRecords already created by following associations
+
     let numRecordsToGenerate // numRecords might be reduced if some records were created by following associations
     let records = []
     if (data[name].length > 0) {
@@ -59,7 +75,6 @@ const asJson = module.exports = async (data, csn, numRecords=1, options={}) => {
       numRecordsToGenerate = numRecords
       records = data[name] = Array(numRecordsToGenerate).fill({}).map(() => ({}))
     }
-    const artifact = defs[name]
 
     const idNum = randomNumber()
     for (let i = 0; i < numRecordsToGenerate; i++) {
@@ -80,13 +95,29 @@ const asJson = module.exports = async (data, csn, numRecords=1, options={}) => {
   return data
 }
 
-function fillRecord(record, recordID, artifact, csn, data, parent, depth, referenceData) {
+/* Fills the given code-list entity with exactly one record per enum value, so the
+   generated data matches all model-defined code list keys. Values come from the model
+   (explicit enum value, else the enum name). The records are stored in data[name] and
+   marked as `fromModel` so they survive 'keys only' (headerOnly) CSV generation. */
+function fillEnumCodeList(name, artifact, enumKey, csn, data, referenceData) {
+  const enumValues = Object.keys(enumKey.enum)
+  const idNum = randomNumber()
+  data[name] = [] // fillRecord pushes each created record here (for circular-ref resolution)
+  for (let i = 0; i < enumValues.length; i++)
+    fillRecord({}, idNum+i, artifact, csn, data, null, 0, referenceData, i)
+  data[name] = uniqRecords(data[name], artifact)
+  // model-defined code lists keep their rows even in 'keys only' (headerOnly) CSV mode
+  Object.defineProperty(data[name], 'fromModel', { value: true, enumerable: false })
+  return data[name]
+}
+
+function fillRecord(record, recordID, artifact, csn, data, parent, depth, referenceData, enumIndex) {
   Object.defineProperty(record, '$id', {value: recordID, enumerable: false})
   if (data[artifact.name]) data[artifact.name].push(record) // add id to data, to be referenced by associations to prevent circular dependencies
 
   const elems = Object.values(artifact.elements ?? artifact.params ?? {}).sort(asJson.elementsSorter(csn))
   elems.forEach(el => {
-    record[el.name] = dataForField(el, artifact, csn, record, data, parent, depth, referenceData)
+    record[el.name] = dataForField(el, artifact, csn, record, data, parent, depth, referenceData, enumIndex)
   })
   return record
 }
@@ -116,7 +147,7 @@ asJson.elementsSorter = function (csn) {
 }
 
 
-function dataForField(element, artifact, csn, record, data, parent, depth, referenceData) {
+function dataForField(element, artifact, csn, record, data, parent, depth, referenceData, enumIndex) {
   if (element.virtual || (element['@Core.Computed'] && element.value))
     return
   if (record[element.name] !== undefined)
@@ -180,7 +211,11 @@ function dataForField(element, artifact, csn, record, data, parent, depth, refer
         return fakerValue(element['@data.gen'], csn)
       }
       if (element.enum) {
-        const enumName = randomFromList(Object.keys(element.enum))
+        const enumNames = Object.keys(element.enum)
+        // pick a distinct enum value by index when iterating a code list, else random
+        const enumName = (element.key && enumIndex !== undefined)
+          ? enumNames[enumIndex % enumNames.length]
+          : randomFromList(enumNames)
         const value = element.enum[enumName].val ?? element.enum[enumName].value ?? enumName
         // key of common.CodeList, also fill name and descr with enum name
         if (element.key && artifact.elements.name && artifact.elements.descr)
@@ -228,13 +263,19 @@ function dataForField(element, artifact, csn, record, data, parent, depth, refer
     case 'cds.Int64':
     case 'cds.Integer64':
     case 'cds.Integer': {
-      if (element.key)
-        return record['$id']
       if (element.enum) {
-        const enumName = randomFromList(Object.keys(element.enum))
+        const enumNames = Object.keys(element.enum)
+        const enumName = (element.key && enumIndex !== undefined)
+          ? enumNames[enumIndex % enumNames.length]
+          : randomFromList(enumNames)
         const value = element.enum[enumName].val ?? element.enum[enumName].value ?? enumName
+        // key of common.CodeList, also fill name and descr with enum name
+        if (element.key && artifact.elements?.name && artifact.elements?.descr)
+          record.name = record.descr = enumName
         return parseInt(value)
       }
+      if (element.key)
+        return record['$id']
       const range = {from: 0, to: 100}
       annotatedIntRange(element, range)
       return randomIntInRange(range)
@@ -315,17 +356,23 @@ function dataForField(element, artifact, csn, record, data, parent, depth, refer
           const ready = targetRecords.filter(r => targetKeys.every(k => r[k] !== undefined))
           targetRecord = ready.length ? ready[pickIndex(record['$id'], element.name, ready.length)] : targetRecords.at(-1)
         } else {
-          // a key association needs distinct targets across rows, else the composite key collapses to one row;
-          // seed a pool up to the requested record count so later rows can spread across it
-          let poolSize = element.key && target.name !== artifact.name ? requestedRecords : 1
-          // a self-referential link (2+ key associations to the same target) needs at least 2 targets to pair distinct rows
-          const keyAssocsToTarget = Object.values(artifact.elements).filter(e => e.key && e.target === element.target).length
-          if (keyAssocsToTarget > 1) poolSize = Math.max(poolSize, keyAssocsToTarget)
-          for (let p = 0; p < poolSize; p++) {
-            const rec = fillRecord({}, randomNumber(), target, csn, data, artifact, depth+1, referenceData)
-            if (rec) targetRecords.push(rec)
+          const targetEnumKey = enumKeyOf(target)
+          if (targetEnumKey) {
+            // enum code list: create the full, model-defined key set and reference one of them
+            targetRecords = fillEnumCodeList(target.name, target, targetEnumKey, csn, data, referenceData)
+          } else {
+            // a key association needs distinct targets across rows, else the composite key collapses to one row;
+            // seed a pool up to the requested record count so later rows can spread across it
+            let poolSize = element.key && target.name !== artifact.name ? requestedRecords : 1
+            // a self-referential link (2+ key associations to the same target) needs at least 2 targets to pair distinct rows
+            const keyAssocsToTarget = Object.values(artifact.elements).filter(e => e.key && e.target === element.target).length
+            if (keyAssocsToTarget > 1) poolSize = Math.max(poolSize, keyAssocsToTarget)
+            for (let p = 0; p < poolSize; p++) {
+              const rec = fillRecord({}, randomNumber(), target, csn, data, artifact, depth+1, referenceData)
+              if (rec) targetRecords.push(rec)
+            }
+            uniqRecords(targetRecords, target)
           }
-          uniqRecords(targetRecords, target)
           targetRecord = targetRecords.length ? targetRecords[pickIndex(record['$id'], element.name, targetRecords.length)] : undefined
           if (parent && (parent.name != artifact.name)) data[target.name].keepReference = true
         }
@@ -443,6 +490,16 @@ function findKeysInOnCondition(assocElement, target) {
   return [ownKey, ownKeyStructured, targetKey]
 }
 
+/* returns the single key element of a code list that is typed as an enum, if any.
+   Such entities (e.g. `sap.common.CodeList` extensions with `key code: String enum {...}`)
+   have a fixed, model-defined set of keys. */
+function enumKeyOf(artifact) {
+  const keys = Object.values(artifact?.keys ?? {})
+  // only treat as enum code list if the (single) key is an enum
+  if (keys.length === 1 && keys[0].enum && Object.keys(keys[0].enum).length > 0)
+    return keys[0]
+}
+
 function uniqRecords(records, artifact) {
   const keys = Object.keys(artifact.keys||{})
   if (keys.length === 0)  keys.push('$id') // no keys (e.g. in actions) -> use record's $id

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

@@ -25,22 +25,25 @@ module.exports = class DestinationTemplate extends require('../../plugin') {
 
     async combine(facet) {
         const project = readProject(facet)
-        const { addApprouter, hasApprouter, addMultitenancy, hasMultitenancy, addKyma, addMta, hasMta, srv, isJava } = project
+        const { affected, srv, isJava } = project
 
-        if (addMta || (addApprouter || addMultitenancy) && hasMta) {
+        if (affected('mta', 'approuter', 'multitenancy')) {
             const srvModule = srv4(srv.path)
             const additions = [srvModule, destination]
-            const relationships = [{
-                insert: [destination, 'name'],
-                into: [srvModule, 'requires', 'name']
-            }]
-            if (hasApprouter) {
+            const relationships = []
+            if (affected('mta')) {
+                relationships.push({
+                    insert: [destination, 'name'],
+                    into: [srvModule, 'requires', 'name']
+                })
+            }
+            if (affected('approuter', 'mta')) {
                 relationships.push({
                     insert: [destination, 'name'],
                     into: [approuter, 'requires', 'name']
                 })
             }
-            if (hasMultitenancy) {
+            if (affected('multitenancy', 'mta')) {
                 relationships.push({
                     insert: [destination, 'name'],
                     into: [mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar'), 'requires', 'name']
@@ -49,7 +52,7 @@ module.exports = class DestinationTemplate extends require('../../plugin') {
             await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project, additions, relationships })
         }
 
-        if (addKyma) {
+        if (affected('kyma')) {
             await merge(__dirname, 'files/values.yaml').into('chart/values.yaml')
             await KymaTemplate.mergeDependency('service-instance', 'destination')
         }

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

@@ -25,9 +25,9 @@ module.exports = class extends require('../../plugin') {
 
   async combine(facet) {
     const project = readProject(facet)
-    const { appName, addMta, addKyma, isJava, addMultitenancy, srv } = project
+    const { appName, affected, isJava, srv } = project
 
-    if (addMta || addMultitenancy) {
+    if (affected('mta', 'multitenancy')) {
       const dynatrace = {
         in: 'resources',
         where: {
@@ -36,14 +36,14 @@ module.exports = class extends require('../../plugin') {
         }
       }
       const additions = [dynatrace], relationships = []
-      if (addMta) {
+      if (affected('mta')) {
         const srvModule = srv4(srv.path)
         relationships.push({
           insert: [dynatrace, 'name'],
           into: [srvModule, 'requires', 'name']
         })
       }
-      if (addMultitenancy) {
+      if (affected('multitenancy')) {
         const mtxSidecar = mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar')
         relationships.push({
           insert: [dynatrace, 'name'],
@@ -56,7 +56,7 @@ module.exports = class extends require('../../plugin') {
       })
     }
 
-    if (addKyma) {
+    if (affected('kyma')) {
       await merge(__dirname, 'files', 'values.yaml').into('chart/values.yaml')
       await KymaTemplate.mergeDependency('service-instance', 'dynatrace')
     }

package/lib/init/template/enterprise-messaging/index.js

@@ -55,9 +55,9 @@ module.exports = class EnterpriseMessagingTemplate extends require('../../plugin
 
   async combine(facet) {
     const project = readProject(facet)
-    const { addXsuaa, hasXsuaa, addKyma, addMta, srv, appName } = project
+    const { affected, srv, appName } = project
 
-    if (addMta) {
+    if (affected('mta')) {
       const srvModule = srv4(srv.path)
       await merge(this._dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
         project,
@@ -71,8 +71,8 @@ module.exports = class EnterpriseMessagingTemplate extends require('../../plugin
       })
     }
 
-    if (addXsuaa || (addMta && hasXsuaa)) {
-      if (addMta) {
+    if (affected('xsuaa', 'mta')) {
+      if (affected('mta')) {
         await merge(this._dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
           project,
           additions: [xsuaa]
@@ -92,11 +92,11 @@ module.exports = class EnterpriseMessagingTemplate extends require('../../plugin
       })
     }
 
-    if (addKyma) {
+    if (affected('kyma')) {
       await merge(this._dirname, 'files', 'values.yaml').into('chart/values.yaml')
       await KymaTemplate.mergeDependency('service-instance', 'event-mesh')
     }
 
-    if (addKyma || addMta) await merge(this._dirname, 'files/event-mesh.json.hbs').into('event-mesh.json', { project })
+    if (affected('kyma') || affected('mta')) await merge(this._dirname, 'files/event-mesh.json.hbs').into('event-mesh.json', { project })
   }
 }

package/lib/init/template/enterprise-messaging-shared/index.js

@@ -19,9 +19,9 @@ module.exports = class EnterpriseMessagingSharedTemplate extends require('../ent
 
   async combine(facet) {
     const project = readProject(facet)
-    const { addMta, addKyma, srv } = project
+    const { affected, srv } = project
 
-    if (addMta) {
+    if (affected('mta')) {
       const srvModule = srv4(srv.path)
       await merge(this._dirname, 'files', 'mta.yaml.hbs').into('mta.yaml', {
         project,
@@ -35,11 +35,11 @@ module.exports = class EnterpriseMessagingSharedTemplate extends require('../ent
       })
     }
 
-    if (addKyma) {
+    if (affected('kyma')) {
       await merge(this._dirname, 'files/values.yaml').into('chart/values.yaml')
       await KymaTemplate.mergeDependency('service-instance', 'event-mesh')
     }
 
-    if (addKyma || addMta) await merge(this._dirname, 'files/event-mesh.json.hbs').into('event-mesh.json', { project })
+    if (affected('kyma') || affected('mta')) await merge(this._dirname, 'files/event-mesh.json.hbs').into('event-mesh.json', { project })
   }
 }

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

@@ -26,8 +26,8 @@ module.exports = class ExtensibilityTemplate extends require('../../plugin') {
 
   async combine(facet) {
     const project = readProject(facet)
-    const { addXsuaa } = project
-    if (addXsuaa) {
+    const { affected } = project
+    if (affected('xsuaa')) {
       await merge(__dirname, 'files', 'xs-security.json.hbs').into('xs-security.json', {
         project,
         additions: [

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

@@ -40,6 +40,12 @@ module.exports = class ExtensionProjectTemplate extends require('../../plugin')
       pkgJson.workspaces ??= []
       pkgJson.workspaces.push('.base')
     }
+
+    // Run the extension project on a dedicated port by default
+    pkgJson.cds ??= {}
+    pkgJson.cds.server ??= {}
+    pkgJson.cds.server.port ??= 4006
+
     await write('package.json', pkgJson, { spaces: 2 })
 
     if (force || !exists('.base/package.json')) {
@@ -76,6 +82,26 @@ module.exports = class ExtensionProjectTemplate extends require('../../plugin')
     }
 
   }
+
+  async finalize() {
+    // @cap-js/sqlite must be optional, else `cds push` fails for extensions
+    const SQLITE = '@cap-js/sqlite'
+    if (!exists('package.json')) return
+
+    const pkgJson = await read('package.json')
+    const version = pkgJson.dependencies?.[SQLITE] ?? pkgJson.devDependencies?.[SQLITE]
+    if (!version) return
+
+    if (pkgJson.dependencies) delete pkgJson.dependencies[SQLITE]
+    if (pkgJson.devDependencies) delete pkgJson.devDependencies[SQLITE]
+    if (pkgJson.dependencies && !Object.keys(pkgJson.dependencies).length) delete pkgJson.dependencies
+    if (pkgJson.devDependencies && !Object.keys(pkgJson.devDependencies).length) delete pkgJson.devDependencies
+
+    pkgJson.optionalDependencies ??= {}
+    pkgJson.optionalDependencies[SQLITE] ??= version
+
+    await write('package.json', pkgJson, { spaces: 2 })
+  }
 }
 
 function namespacify(s) {

package/lib/init/template/github-actions/index.js

@@ -51,15 +51,15 @@ module.exports = class GitHubActionTemplate extends require('../../plugin') {
 
   async combine(facet) {
     const project = readProject(facet)
-    const { addMta, addKyma } = project, { force } = cds.cli.options
+    const { affected } = project, { force } = cds.cli.options
     project.sap = cds.cli.options.sap
-    if (addMta) {
+    if (affected('mta')) {
       const cf = '.github/workflows/cf.yaml'
       if (force || !exists(cf)) {
         await renderAndCopy(path.join(__dirname, 'files/workflows/cf.yaml.hbs'), cf, project)
       }
     }
-    if (addKyma) {
+    if (affected('kyma')) {
       const kyma = '.github/workflows/kyma.yaml'
       if (force || !exists(kyma)) {
         await renderAndCopy(path.join(__dirname, 'files/workflows/kyma.yaml.hbs'), kyma, project)

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

@@ -24,6 +24,9 @@
     {{#profile}}
     "[{{profile}}]": {
     {{/profile}}
+    {{^profile}}
+    "[production]": {
+    {{/profile}}
     {{#shortcut}}
       "db": "hana"
     {{/shortcut}}
@@ -32,9 +35,7 @@
         "kind": "hana"
       }
     {{/shortcut}}
-    {{#profile}}
     }
-    {{/profile}}
   }
   {{/isJava}}
 }

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

@@ -41,9 +41,9 @@ module.exports = class HanaTemplate extends require('../../plugin') {
 
     async combine(facet) {
         const project = readProject(facet)
-        const { addMta, hasMta, addMultitenancy, addKyma, isJava, hasKyma, hasMultitenancy, srv } = project
+        const { affected, isJava, hasKyma, hasMultitenancy, srv } = project
 
-        if (addMta || addMultitenancy && hasMta) {
+        if (affected('mta', 'multitenancy')) {
             const srvModule = srv4(srv.path)
             const db = hasMultitenancy ? serviceManager : hdiContainer
             const deletions = hasMultitenancy ? [{
@@ -83,11 +83,11 @@ module.exports = class HanaTemplate extends require('../../plugin') {
             })
         }
 
-        if (!hasMultitenancy && addKyma) {
+        if (affected('kyma') && !hasMultitenancy) {
             await merge(__dirname, 'files', 'values.yaml.hbs').into('chart/values.yaml', { with: project })
         }
 
-        if (addMultitenancy && hasKyma) {
+        if (affected('multitenancy') && hasKyma) {
             await merge('chart/values.yaml')
                 .remove(['hana-deployer', 'srv.bindings.db', 'hana'])
 
@@ -98,7 +98,7 @@ module.exports = class HanaTemplate extends require('../../plugin') {
                 ])
         }
 
-        if (addKyma && !hasMultitenancy) {
+        if (affected('kyma') && !hasMultitenancy) {
             const additions = [{
                 in: 'modules',
                 where: { name: `${project.appName}-hana-deployer` }

package/lib/init/template/hana-serverless/index.js

@@ -51,9 +51,9 @@ module.exports = class HanaServerlessTemplate extends require('../../plugin') {
 
     async combine(facet) {
         const project = readProject(facet)
-        const { addMta, hasMta, addMultitenancy, addKyma, isJava, hasMultitenancy, srv } = project
+        const { affected, isJava, hasMultitenancy, srv } = project
 
-        if (addMta || addMultitenancy && hasMta) {
+        if (affected('mta', 'multitenancy')) {
             const existingIdentity = await this._existingIdentityName()
             const srvModule = srv4(srv.path)
 
@@ -99,7 +99,7 @@ module.exports = class HanaServerlessTemplate extends require('../../plugin') {
             if (hasMultitenancy) await this._alignSidecarDbKind()
         }
 
-        if (addKyma) {
+        if (affected('kyma')) {
             const KymaTemplate = require('../kyma')
             const existingIdentity = await this._existingIdentityInChart()
 

package/lib/init/template/html5-repo/files/mta.yaml.hbs

@@ -70,7 +70,9 @@ modules:
       build-result: dist
       builder: custom
       commands:
+        {{^hasNpmWorkspaces}}
         - npm ci
+        {{/hasNpmWorkspaces}}
         - npm run build
       {{/isStatic}}
       supported-platforms: []

package/lib/init/template/html5-repo/files/ui5.yaml.hbs

@@ -13,10 +13,6 @@ builder:
       - "/test/**"
       - "/localService/**"
   customTasks:
-    {{#isTypescript}}
-    - name: ui5-tooling-transpile-task
-      afterTask: replaceVersion
-    {{/isTypescript}}
     - name: ui5-task-zipper
       afterTask: generateVersionInfo
       configuration: