@sap/cds-dk 8.0.2 → 8.1.0

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

@@ -149,6 +149,7 @@ module.exports = class HttpTemplate extends require('../../plugin') {
       }
       varsDefined = true
       const headers = auth ? `Content-Type: application/json\n{{auth}}` : `Content-Type: application/json`
+      const headerAuth = auth ? '{{auth}}' : ''
 
       service.urlPaths.forEach((urlPath) => {
         if (service.urlPaths.length > 1) {
@@ -156,36 +157,41 @@ module.exports = class HttpTemplate extends require('../../plugin') {
         }
 
         service.entities.forEach((e) => {
-          const entityNameSimple = e.name.slice(e.name.lastIndexOf('.') + 1)
+          const entityNameSimple = e.name.slice(serviceName.length + 1)
+          const nameSlug = slug(entityNameSimple)
           const url = `{{server}}/${urlPath}${entityNameSimple}`
-          const requestTitle = `\n### ${e.name}`
-          requests.push(`${requestTitle}\nGET ${url}\n${headers}\n`)
+          const requestTitle = `\n### ${entityNameSimple}`
+          requests.push(`${requestTitle}\n# @name ${nameSlug}_GET\nGET ${url}\n${headerAuth}\n`)
           if (e.readOnly) return
 
           const entityData = payload[`${e.name}`] ? payload[`${e.name}`][0] : null
           if (!entityData) return
-          const postBody = JSON.stringify(entityData, null, 2)
-
-          let id
-          const compositeKey = Object.keys(e.keys).length > 1
-          if (compositeKey) {
-            id = e.keys.map(k => k.type === 'cds.String' ? `${k.name}='${entityData[k.name]}'` : `${k.name}=${entityData[k.name]}`).join(',')
-            } else {
-            id = entityData[Object.keys(e.keys)[0]]
-          }
 
           if (e.isDraft) {
-            generateDraftRequests(requests, requestTitle, url, headers, postBody, id)
-          } else {
+            const key = Object.keys(e.keys)[0] // draft keys are always single
+            delete entityData[key] // draft keys should always by auto generated (either UUID or through custom logic), so remove them from the payload
+            const postBody = JSON.stringify(entityData, null, 2)
+            generateDraftRequests(requests, requestTitle, url, headers, headerAuth, postBody, key)
+          }
+          else {
+            const postBody = JSON.stringify(entityData, null, 2)
+            let id
+            const compositeKey = Object.keys(e.keys).length > 1
+            if (compositeKey) {
+              id = e.keys.map(k => k.type === 'cds.String' ? `${k.name}='${entityData[k.name]}'` : `${k.name}=${entityData[k.name]}`).join(',')
+            } else {
+              id = entityData[Object.keys(e.keys)[0]]
+            }
             compositeKey ? id = `(${id})` : id = `/${id}`
-            requests.push(`${requestTitle}\nPOST ${url}\n${headers}\n\n${postBody}\n`)
-            requests.push(`${requestTitle}\nPATCH ${url}${id}\n${headers}\n\n${postBody}\n`)
-            requests.push(`${requestTitle}\nDELETE ${url}${id}\n${headers}\n`)
+            requests.push(`${requestTitle}\n# @name ${nameSlug}_POST\nPOST ${url}\n${headers}\n\n${postBody}\n`)
+            requests.push(`${requestTitle}\n# @name ${nameSlug}_PATCH\nPATCH ${url}${id}\n${headers}\n\n${postBody}\n`)
+            requests.push(`${requestTitle}\n# @name ${nameSlug}_DELETE\nDELETE ${url}${id}\n${headers}\n`)
           }
         })
 
         service.actions.forEach((a) => {
-          const url = `{{server}}/${urlPath}${a.name.split(".")[1]}`
+          const simpleNameAction = a.name.slice(serviceName.length + 1)
+          const url = `{{server}}/${urlPath}${simpleNameAction}`
 
           let actionPayload = {}
           if (a.params) {
@@ -197,20 +203,25 @@ module.exports = class HttpTemplate extends require('../../plugin') {
                     : null
             }
           }
-          requests.push(`\n### ${a.name}\nPOST ${url}\n${headers}\n\n${JSON.stringify(actionPayload, null, 2)}\n`)
+          requests.push(`\n### ${simpleNameAction}\n# @name ${simpleNameAction}_POST\nPOST ${url}\n${headers}\n\n${JSON.stringify(actionPayload, null, 2)}\n`)
         })
 
       })
       this.#write(requests, serviceName)
     }
 
-    function generateDraftRequests(requests, requestTitle, url, headers, postBody, id) {
-      requests.push(`${requestTitle} Drafts \nGET ${url}?$filter=(IsActiveEntity eq false)\n${headers}\n`) // unencoded URL for better readability (client can handle this)
-      requests.push(`${requestTitle} Drafts \nPOST ${url}\n${headers}\n\n${postBody}\n`)
-      requests.push(`\n### Please paste the server-generated draft id here e.g. ID=101 or ID=101,secodKey='stringValue' \n@draftID = ${id}\n`)
-      requests.push(`${requestTitle} Patch Draft \nPATCH ${url}({{draftID}},IsActiveEntity=false)\n${headers}\n\n${postBody}\n`)
-      requests.push(`${requestTitle} Prepare Draft \nPOST ${url}({{draftID}},IsActiveEntity=false)/AdminService.draftPrepare\n${headers}\n\n{}\n`)
-      requests.push(`${requestTitle} Activate Draft \nPOST ${url}({{draftID}},IsActiveEntity=false)/AdminService.draftActivate\n${headers}\n\n{}\n`)
+    function generateDraftRequests(requests, title, url, headers, headerAuth, postBody, key) {
+      const nameDraftsCreate = slug(title+'_Draft_POST')
+      requests.push(`${title} Drafts GET\n# @name ${slug(title+'_Drafts_GET')}\nGET ${url}?$filter=(IsActiveEntity eq false)\n${headerAuth}\n`) // unencoded URL for better readability (client can handle this)
+      requests.push(`${title} Draft POST\n# @name ${nameDraftsCreate}\nPOST ${url}\n${headers}\n\n${postBody}\n`)
+      requests.push(`\n### Result from POST request above\n@draftID = {{${nameDraftsCreate}.response.body.$.${key}}}\n`)
+      requests.push(`${title} Draft PATCH\n# @name ${slug(title+'_Draft_Patch')}\nPATCH ${url}(${key}={{draftID}},IsActiveEntity=false)\n${headers}\n\n${postBody}\n`)
+      requests.push(`${title} Draft Prepare\n# @name ${slug(title+'_Draft_Prepare')}\nPOST ${url}(${key}={{draftID}},IsActiveEntity=false)/AdminService.draftPrepare\n${headers}\n\n{}\n`)
+      requests.push(`${title} Draft Activate\n# @name ${slug(title+'_Draft_Activate')}\nPOST ${url}(${key}={{draftID}},IsActiveEntity=false)/AdminService.draftActivate\n${headers}\n\n{}\n`)
+    }
+
+    function slug(str) {
+      return str.trim().replace(/[#\\. ]/g, '')
     }
   }
 
@@ -248,5 +259,3 @@ module.exports = class HttpTemplate extends require('../../plugin') {
     return `${outputDir}/${serviceName}.http`
   }
 }
-
-

package/lib/init/template/malware-scanner/index.js

@@ -5,7 +5,7 @@ const { srv4, malwareScanner } = require('../../registries/mta')
 module.exports = class MalwareScannerTemplate extends require('../../plugin') {
 
     static help() {
-        return 'SAP Malware Scanning service'
+        return 'SAP Malware Scanning Service'
     }
 
     static hasInProduction(env) {

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

@@ -1,5 +1,5 @@
 {
   "devDependencies": {
-    "@sap/cds-dk": ">=7"
+    "@sap/cds-dk": "^8"
   }
 }

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

@@ -0,0 +1,25 @@
+---
+modules:
+ - name: {{appName}}-srv
+   type: {{language}}
+   path: {{& srvPath}}
+   requires:
+    - name: {{appName}}-redis
+
+resources:
+  - name: {{appName}}-redis
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: redis-cache
+      service-plan: standard
+      # config:
+        # memory: 2 # GB, can be 2 or 4
+        # multi_az: true
+        # cluster_mode: true
+        # shard_count: 1
+        # node_count: 3 # per shard minimum is 3 (for standard plan)
+        # engine_version: "6.0" # can be "4.0" or "6.0"
+        # maintenance_window:
+          # day_of_week: Friday
+          # start_hour_utc: 0
+          # duration: 5 # hours

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

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "redis": "^4"
+  }
+}

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

@@ -0,0 +1,44 @@
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { srv4, redis } = require('../../registries/mta')
+
+module.exports = class extends require('../../plugin') {
+
+  static help() {
+    return 'SAP BTP Redis, Hyperscaler Option'
+  }
+
+  async canRun() {
+    const { hasMta, hasHelm, hasHelmUnifiedRuntime, isJava } = readProject()
+    const onlyHelm = !hasMta && (hasHelmUnifiedRuntime || hasHelm)
+    if (isJava)   throw `'cds add redis' is not available for Java yet`
+    if (onlyHelm) throw `'cds add redis' is not available for Kyma yet`
+    return true
+  }
+
+  static hasInProduction() {
+    const { dependencies } = readProject()
+    return !!dependencies?.['redis']
+  }
+
+  async run() {
+    await merge(__dirname, 'files/package.json.hbs').into('package.json')
+  }
+
+  async combine() {
+    const project = readProject()
+    const { hasMta, srvPath } = project
+
+    if (hasMta) {
+      const srv = srv4(srvPath)
+      await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
+        project,
+        additions: [srv, redis],
+        relationships: [{
+          insert: [redis, 'name'],
+          into: [srv, 'requires', 'name']
+        }]
+      })
+    }
+  }
+}

package/lib/init/template/redis-messaging/files/package.json.hbs

@@ -1,8 +1,5 @@
 {
   {{#isNodejs}}
-  "dependencies": {
-    "redis": "^4"
-  },
   "cds": {
   {{/isNodejs}}
     "requires": {

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

@@ -2,7 +2,6 @@ const cds = require('../../../cds')
 const { read } = cds.utils
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
-const { srv4, redis } = require('../../registries/mta')
 
 module.exports = class RedisMessagingTemplate extends require('../../plugin') {
 
@@ -10,6 +9,10 @@ module.exports = class RedisMessagingTemplate extends require('../../plugin') {
     return 'messaging via Redis'
   }
 
+  requires() {
+    return ['redis']
+  }
+
   async canRun() {
     const { hasMta, hasHelm, hasHelmUnifiedRuntime, isJava } = readProject()
     const onlyHelm = !hasMta && (hasHelmUnifiedRuntime || hasHelm)
@@ -28,21 +31,4 @@ module.exports = class RedisMessagingTemplate extends require('../../plugin') {
     project.shortcut = !(await read(configFile)).cds?.requires?.messaging?.kind
     await merge(__dirname, 'files/package.json.hbs').into(configFile, { project })
   }
-
-  async combine() {
-    const project = readProject()
-    const { hasMta, srvPath } = project
-
-    if (hasMta) {
-      const srv = srv4(srvPath)
-      await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
-        project,
-        additions: [srv, redis],
-        relationships: [{
-          insert: [redis, 'name'],
-          into: [srv, 'requires', 'name']
-        }]
-      })
-    }
-  }
 }

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

@@ -55,7 +55,6 @@
         "": {
           "dataSource": "AdminService",
           "settings": {
-            "synchronizationMode": "None",
             "operationMode": "Server",
             "autoExpandSelect": true,
             "earlyRequests": true,

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

@@ -71,7 +71,6 @@
       "": {
         "dataSource": "CatalogService",
         "settings": {
-          "synchronizationMode": "None",
           "operationMode": "Server",
           "autoExpandSelect": true,
           "earlyRequests": true,

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

@@ -1,12 +1,17 @@
-const cds = require('@sap/cds/lib')
+const cds = require('@sap/cds')
 
 module.exports = class AdminService extends cds.ApplicationService { init(){
-  this.before ('NEW','Books.drafts', genid)
+
+  const { Books } = this.entities
+
+  /**
+   * Generate IDs for new Books drafts
+   */
+  this.before ('NEW', Books.drafts, async (req) => {
+    if (req.data.ID) return
+    const { ID:id1 } = await SELECT.one.from(Books).columns('max(ID) as ID')
+    const { ID:id2 } = await SELECT.one.from(Books.drafts).columns('max(ID) as ID')
+    req.data.ID = Math.max(id1||0, id2||0) + 1
+  })
   return super.init()
 }}
-
-/** Generate primary keys for target entity in request */
-async function genid (req) {
-  const {ID} = await cds.tx(req).run (SELECT.one.from(req.target.actives).columns('max(ID) as ID'))
-  req.data.ID = ID - ID % 100 + 100 + 1
-}

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

@@ -1,26 +1,38 @@
 const cds = require('@sap/cds')
-const { Books } = cds.entities ('sap.capire.bookshop')
 
-class CatalogService extends cds.ApplicationService { init(){
+class CatalogService extends cds.ApplicationService { init() {
 
-  // Reduce stock of ordered books if available stock suffices
-  this.on ('submitOrder', async req => {
-    const {book,quantity} = req.data
-    let {stock} = await SELECT `stock` .from (Books,book)
-    if (stock >= quantity) {
-      await UPDATE (Books,book) .with (`stock -=`, quantity)
-      await this.emit ('OrderedBook', { book, quantity, buyer:req.user.id })
-      return { stock }
-    }
-    else return req.error (409,`${quantity} exceeds stock for book #${book}`)
-  })
+  const { Books } = cds.entities('sap.capire.bookshop')
+  const { ListOfBooks } = this.entities
 
   // Add some discount for overstocked books
-  this.after ('each','ListOfBooks', book => {
+  this.after('each', ListOfBooks, book => {
     if (book.stock > 111) book.title += ` -- 11% discount!`
   })
 
+  // Reduce stock of ordered books if available stock suffices
+  this.on('submitOrder', async req => {
+    let { book:id, quantity } = req.data
+    let book = await SELECT.from (Books, id, b => b.stock)
+
+    // Validate input data
+    if (!book) return req.error (404, `Book #${id} doesn't exist`)
+    if (quantity < 1) return req.error (400, `quantity has to be 1 or more`)
+    if (quantity > book.stock) return req.error (409, `${quantity} exceeds stock for book #${id}`)
+
+    // Reduce stock in database and return updated stock value
+    await UPDATE (Books, id) .with ({ stock: book.stock -= quantity })
+    return book
+  })
+
+  // Emit event when an order has been submitted
+  this.after('submitOrder', async (_,req) => {
+    let { book, quantity } = req.data
+    await this.emit('OrderedBook', { book, quantity, buyer: req.user.id })
+  })
+
+  // Delegate requests to the underlying generic service
   return super.init()
 }}
 
-module.exports = { CatalogService }
+module.exports = CatalogService

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

@@ -1,8 +1,8 @@
 {
   "devDependencies": {
-    "typescript": "^5",
-    "@cap-js/cds-types": "<1",
-    "@types/node": "^20"
+    "@cap-js/cds-types": "^0.6",
+    "@types/node": "^20",
+    "typescript": "^5"
   },
   "scripts": {
     "watch": "cds-ts w",

package/lib/init/template/websocket/files/dependencies.package.json

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

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

@@ -0,0 +1,35 @@
+const { readProject } = require('../../projectReader')
+const { merge, sort } = require('../../merge')
+const { link } = require('../../../util/term')
+const { CAP_JS_COMMUNITY_WEBSOCKET } = require('../../constants').URLS
+
+module.exports = class WebsocketTemplate extends require('../../plugin') {
+
+  static help() {
+    return 'cap-js-community: expose CDS services via the Websocket protocol'
+  }
+
+  async canRun() {
+    const { isJava } = readProject()
+    if (isJava) throw `'cds add websocket' is not available for Java`
+    return true
+  }
+
+  requires() {
+    return ['redis']
+  }
+
+  static hasInProduction() {
+    const { dependencies } = readProject()
+    return !!dependencies?.['@cap-js-community/websocket']
+  }
+
+  async run() {
+    await merge(__dirname, 'files/dependencies.package.json').into('package.json')
+    await sort('package.json', 'dependencies')
+  }
+
+  async finalize() {
+    console.log(`Find plugin documentation on ${link(CAP_JS_COMMUNITY_WEBSOCKET)}`)
+  }
+}

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

@@ -1,4 +1,5 @@
 module.exports = class extends require('../../plugin') {
+
     requires() {
       return ['workzone-standard']
     }

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

@@ -2,22 +2,27 @@ 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') {
 
-    canRun() {
-      if (cds.requires.multitenancy) {
-        throw `SAP BTP Work Zone, Standard Edition does not support multitenancy yet.`
-      }
-      return true
+    static help() {
+      return 'SAP BTP Work Zone, Standard Edition'
     }
 
     requires() {
-      return ['html5-repo']
+      return ['html5-repo', 'destination']
     }
 
-    static help() {
-      return 'SAP BTP Work Zone, Standard Edition'
+    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() {
@@ -26,5 +31,16 @@ module.exports = class extends require('../../plugin') {
       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 })
+      }
+  }
 }