@sap/cds-dk 7.0.0 → 7.0.2

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

@@ -1,63 +1,46 @@
-const fs = require('fs').promises;
-const os = require('os');
-const { join, relative } = require('path');
-
-const commandUtil = require('../../../util/command');
-const mvnArchetypeUtil = require('../../util/mvn');
-const term = require('../../../util/term');
+const os = require('os')
 const cds = require('../../../cds')
-const { exists, copy, rimraf } = cds.utils
-const LOG = console
-
-const { COMMAND_ADD, URLS, OPTIONS: { NODEJS, JAVA } } = require('../../constants');
+const { exists, copy, rimraf, fs, path } = cds.utils, { join } = path
+const cmd = require('../../../util/command')
+const mvn = require('../../util/mvn')
+const term = require('../../../util/term')
+const { URLS, OPTIONS: { NODEJS, JAVA }, COMMAND_ADD } = require('../../constants')
 
 module.exports = class JavaTemplate extends require('../templateBase') {
 
     static hasFacet() {
-        return exists('pom.xml')
+        return exists('pom.xml') || cds.cli.options?.add?.has(JAVA)
     }
 
     async canRun() {
-        if (this.options._cmd === COMMAND_ADD) {
-            throw new Error(`You can't change the type of an existing project.`);
+        if (cds.cli.command === COMMAND_ADD) {
+            throw `You can't change the runtime of an existing project.`
         }
-
-        if (this.options.add.has(NODEJS)) {
-            throw new Error(`Only one runtime per project is supported. Specify either ${JAVA} or ${NODEJS}.`);
+        if (cds.cli.options.add?.has(NODEJS)) {
+            throw `Only one runtime per project is supported. Specify either ${term.bold(JAVA)} or ${term.bold(NODEJS)}.`
         }
-
-        return true;
+        return true
     }
 
     async run() {
-        const mvnCmdArgs = await mvnArchetypeUtil.getGenerateCmdArgs(this.projectName, this.options);
-        const { cmdLine, artifactId, archetypeVersion } = mvnCmdArgs
+        const { cmdLine, artifactId, archetypeVersion } = await mvn.getGenerateCmdArgs(this.projectName, this.options)
+        console.log(`Using Maven archetype version ${archetypeVersion}`)
 
-        LOG.info(`Using Maven archetype version ${archetypeVersion}`);
-
-        const tempFolder = await fs.mkdtemp(join(os.tmpdir(), `${this.projectName}_`));
+        const temp = await fs.promises.mkdtemp(join(os.tmpdir(), `${this.projectName}_`))
         try {
-            await commandUtil.spawnCommand('mvn', cmdLine, {
-                cwd: tempFolder
-            });
-
-            await copy(join(tempFolder, artifactId), this.projectPath);
+            await cmd.spawnCommand('mvn', cmdLine, { cwd: temp })
+            await copy(join(temp, artifactId), this.projectPath);
         } catch (err) {
             if (err.code === 'ENOENT' && err.path === 'mvn') {
-                throw new Error(`Maven executable 'mvn' not found, follow ${term.info(URLS.MAVEN_INSTALL_HELP)} and install Maven on your machine.`);
+                throw `Maven executable 'mvn' not found, follow ${term.info(URLS.MAVEN_INSTALL_HELP)} and install Maven on your machine.`
             }
             throw err;
         } finally {
-            await rimraf(tempFolder);
+            await rimraf(temp);
         }
     }
 
     async finalize() {
-        const relativeProjectPath = relative(this.cwd, cds.root);
-        if (relativeProjectPath && relativeProjectPath !== '.') {
-            LOG.info(`Continue with 'cd ${relativeProjectPath}'`);
-        }
-
-        LOG.info(`Learn about next steps at ${URLS.CAPIRE}`);
+        console.log(`Learn about next steps at ${term.link(URLS.CAPIRE)}`)
     }
 }

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

@@ -0,0 +1,29 @@
+---
+modules:
+  - name: {{appName}}-srv
+    type: {{language}}
+    path: {{& srvPath}}
+    requires:
+      - name: {{appName}}-logging
+
+{{#isMultitenant}}
+  - name: {{appName}}-mtx
+    type: nodejs
+    path: {{#isNodejs}}gen/{{/isNodejs}}mtx/sidecar
+    requires:
+      - name: {{appName}}-logging
+{{/isMultitenant}}
+
+{{#hasApprouter}}
+  - name: {{appName}}
+    type: approuter.nodejs
+    requires:
+      - name: {{appName}}-logging
+{{/hasApprouter}}
+
+resources:
+  - name: {{appName}}-logging
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: application-logs
+      service-plan: lite

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

@@ -0,0 +1,55 @@
+const { join } = require('path')
+const { readProject } = require('../../util/projectReader')
+const { mergeJSON, mergeYAML } = require('../../util/merge')
+const { srvNode4, srvJava4, mtxSidecar4, kibana, approuter } = require('../_merging/registry-mta')
+
+module.exports = class KibanaTemplate extends require('../templateBase') {
+
+    static hasFacet(env) {
+        return env.features.kibana_formatter
+    }
+
+    async canRun() {
+        const { hasMta, hasHelm, isJava } = await readProject(this.options)
+        if (hasHelm && !hasMta) throw `'cds add kibana' is not available for Kyma yet`
+        if (isJava) throw `'cds add kibana' is not available for Java yet`
+        return true
+    }
+
+    async run() {
+        const project = await readProject(this.options)
+        const { configFile } = project
+        await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
+        await this.runDependentMerging()
+    }
+
+    async runDependentMerging() {
+        const project = await readProject(this.options)
+        const { hasMta, hasApprouter, isJava, isMultitenant, srvPath } = project
+
+        if (hasMta) {
+            const srv = (isJava ? srvJava4 : srvNode4)(srvPath)
+            const additions = [srv, kibana]
+            const relationships = [{
+                insert: [kibana, 'name'],
+                into: [srv, 'requires', 'name']
+            }]
+            if (isMultitenant) {
+                const mtxSidecar = mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar')
+                additions.push(mtxSidecar)
+                relationships.push({
+                    insert: [kibana, 'name'],
+                    into: [mtxSidecar, 'requires', 'name']
+                })
+            }
+            if (hasApprouter) {
+                additions.push(approuter)
+                relationships.push({
+                    insert: [kibana, 'name'],
+                    into: [approuter, 'requires', 'name']
+                })
+            }
+            await mergeYAML('mta.yaml', join(__dirname, 'files', 'mta.yaml.hbs'), project, { additions, relationships })
+        }
+    }
+}

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

@@ -3,9 +3,6 @@
   "dependencies": {
     "@sap/cds-mtxs": "^1.9"
   },
-  {{#cap.isJava}}
-  "workspaces": [ "mtx/sidecar" ],
-  {{/cap.isJava}}
   "cds": {
   {{/isNodejs}}
     {{#isJava}}

package/lib/init/template/multitenancy/files/package.sidecar.json.hbs

@@ -9,7 +9,7 @@
     "passport": ">=0.6.0"
   },
   "devDependencies": {
-    "sqlite3": "^5"
+    "@cap-js/sqlite": "^1"
   },
   "scripts": {
     "start": "cds-serve"{{#isJava}},

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

@@ -1,6 +1,7 @@
 const { join } = require('path')
 const cds = require('../../../cds')
-const { exists } = cds.utils
+const { exists, read, write } = cds.utils
+const { APPROUTER, HANA, KIBANA } = require('../../constants').OPTIONS
 const { readProject } = require('../../util/projectReader')
 const { mergeJSON, mergeYAML, sort } = require('../../util/merge')
 const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5')
@@ -22,21 +23,26 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
   }
 
   getRelatedFacets() {
-    return ['approuter', 'hana']
+    return [APPROUTER, HANA, KIBANA]
   }
 
   async run() {
-    const projectDescriptor = await readProject(this.options)
-    const { isNodejs, configFile } = projectDescriptor
-    await mergeJSON(configFile, join(__dirname, 'files', `package.json.hbs`), projectDescriptor)
+    const project = await readProject(this.options)
+    const { isNodejs, isJava, configFile } = project
+    await mergeJSON(configFile, join(__dirname, 'files', `package.json.hbs`), project)
+    if (isJava) {
+      const packageJson = await read('package.json')
+      packageJson.workspaces = ['mtx/sidecar']
+      await write('package.json', packageJson, { spaces: 2 })
+    }
     if (isNodejs) await sort('package.json', 'dependencies')
-    await copyRenderedJSON(join(__dirname, 'files', 'package.sidecar.json.hbs'), join('mtx', 'sidecar', 'package.json'), projectDescriptor)
+    await copyRenderedJSON(join(__dirname, 'files', 'package.sidecar.json.hbs'), join('mtx', 'sidecar', 'package.json'), project)
     await this.runDependentMerging()
   }
 
   async runDependentMerging(context = {}) {
-    const projectDescriptor = await readProject(this.options)
-    const { isNodejs, isJava, hasMta, hasHelm, hasXsuaa, hasHana, srvPath } = projectDescriptor
+    const project = await readProject(this.options)
+    const { isNodejs, isJava, hasMta, hasHelm, hasXsuaa, hasHana, srvPath } = project
 
     if (hasMta) {
       const srv = (isNodejs ? srvNode4 : srvJava4)(srvPath)
@@ -75,7 +81,7 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
 
       const templateMtaPath = join(__dirname, 'files', 'mta.yaml.hbs')
       const mergingRules = { additions, overwrites, relationships }
-      await mergeYAML('mta.yaml', templateMtaPath, projectDescriptor, mergingRules)
+      await mergeYAML('mta.yaml', templateMtaPath, project, mergingRules)
     }
 
     // REVISIT: Why not just pass a Boolean from run() to indicate the merging isn't run transitively?
@@ -90,7 +96,7 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
       await mergeYAML(
         join('chart', 'values.yaml'),
         join(__dirname, 'files', 'values.yaml.hbs'),
-        projectDescriptor
+        project
       )
 
       const envFromObject = {
@@ -119,7 +125,7 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
             ]
           }
         },
-        projectDescriptor
+        project
       )
 
       // REVISIT: Don't reference other templates except for the safe `runDependentMerging` -> low coupling, high cohesion
@@ -156,7 +162,7 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
       await mergeJSON(
         'xs-security.json',
         join(__dirname, 'files', 'xs-security.json.hbs'),
-        projectDescriptor,
+        project,
         {
           additions: [{
             in: 'scopes',

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

@@ -10,7 +10,7 @@
     "express": "^4"
   },
   "devDependencies": {
-    "sqlite3": "^5"
+    "@cap-js/sqlite": "^1"
   },
   "scripts": {
     "start": "cds-serve"

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

@@ -1,27 +1,25 @@
-const { join, relative } = require('path');
+const { join } = require('path')
 const cds = require('../../../cds')
-const { mkdirp } = cds.utils
-const { COMMAND_ADD, OPTIONS: { JAVA, NODEJS }, URLS } = require('../../constants')
+const { exists, mkdirp } = cds.utils
+const { URLS, OPTIONS: { NODEJS, JAVA }, COMMAND_ADD } = require('../../constants')
+const term = require('../../../util/term')
 const { copyFiles } = require('../../util/template')
 const LOG = console
 
 module.exports = class NodejsTemplate extends require('../templateBase') {
 
     static hasFacet() {
-        // TODO: Implement
-        //return this.language === P_LANGUAGE_NODEJS
+        return !exists('pom.xml') || cds.cli.options?.add?.has(NODEJS)
     }
 
     async canRun() {
-        if (this.options._cmd === COMMAND_ADD) {
-            throw new Error(`You can't change the type of an existing project.`);
+        if (cds.cli.command === COMMAND_ADD) {
+            throw `You can't change the runtime of an existing project.`
         }
-
-        if (this.options.add.has(JAVA)) {
-            throw new Error(`Only one runtime per project is supported. Specify either ${JAVA} or ${NODEJS}.`);
+        if (cds.cli.options.add?.has(JAVA)) {
+            throw `Only one runtime per project is supported. Specify either ${term.bold(JAVA)} or ${term.bold(NODEJS)}.`
         }
-
-        return true;
+        return true
     }
 
     async run() {
@@ -32,12 +30,7 @@ module.exports = class NodejsTemplate extends require('../templateBase') {
     }
 
     async finalize() {
-        const relativeProjectPath = relative(this.cwd, cds.root);
-        if (relativeProjectPath && relativeProjectPath !== '.') {
-            LOG.info(`Continue with 'cd ${relativeProjectPath}'`);
-        }
-
-        LOG.info(`Find samples on ${URLS.SAMPLES}`);
-        LOG.info(`Learn about next steps at ${URLS.CAPIRE}`);
+        LOG.info(`Find samples on ${term.link(URLS.SAMPLES)}`)
+        LOG.info(`Learn about next steps at ${term.link(URLS.CAPIRE)}`)
     }
 }

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

@@ -14,7 +14,7 @@ module.exports = class PipelineTemplate extends require('../templateBase') {
         }
 
         if (exists('Jenkinsfile') || exists(join('.pipeline', 'config.yml'))) {
-            throw new Error(`Pipeline support file exists. Use --force to overwrite.`);
+            throw `Pipeline support file exists. Use --force to overwrite.`
         }
 
         return true;

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

@@ -19,23 +19,23 @@ module.exports = class RedisMessagingTemplate extends require('../templateBase')
   }
 
   async run() {
-    const projectDescriptor = await readProject(this.options)
-    const { configFile } = projectDescriptor
-    projectDescriptor.shortcut = !(await read(configFile)).cds?.requires?.messaging?.kind
-    await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), projectDescriptor)
+    const project = await readProject(this.options)
+    const { configFile } = project
+    project.shortcut = !(await read(configFile)).cds?.requires?.messaging?.kind
+    await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
     await this.runDependentMerging()
   }
 
   async runDependentMerging() {
-    const projectDescriptor = await readProject(this.options)
-    const { hasMta, isNodejs, srvPath } = projectDescriptor
+    const project = await readProject(this.options)
+    const { hasMta, isNodejs, srvPath } = project
 
     if (hasMta) {
       const srv = (isNodejs ? srvNode4 : srvJava4)(srvPath)
       await mergeYAML(
           'mta.yaml',
           join(__dirname, 'files', 'mta.yaml.hbs'),
-          projectDescriptor,
+          project,
           {
               additions: [srv, redis],
               relationships: [{

package/lib/init/template/sample/files/app/_i18n/i18n.properties

@@ -3,41 +3,12 @@ Book = Book
 ID = ID
 Title = Title
 Author = Author
+Authors = Authors
 AuthorID = Author ID
-Stock = Stock
+AuthorName = Author Name
 Name = Name
-Description = Description
-Image = Image
-AuthorName = Author's Name
-DateOfBirth = Date of Birth
-DateOfDeath = Date of Death
-PlaceOfBirth = Place of Birth
-PlaceOfDeath = Place of Death
 Age = Age
-Lifetime = Lifetime
-Authors = Authors
-
+Stock = Stock
 Order = Order
 Orders = Orders
-OrderNo = Order Number
-OrderItems = Order Items
-Customer = Customer
-Product = Product
-ProductID = Product ID
-ProductTitle = Product Title
-UnitPrice = Unit Price
-Quantity = Quantity
-
 Price = Price
-Currency = Currency
-Date = Date
-Rating = Rating
-NumberOfReviews = Number of Reviews
-
-Genre = Genre
-Genres = Genres
-SubGenres = Sub Genres
-
-NumCode = Numeric Code
-MinorUnit = Minor Unit
-Exponent = Exponent

package/lib/init/template/sample/files/app/_i18n/i18n_de.properties

@@ -2,12 +2,12 @@ Books = Bücher
 Book = Buch
 ID = ID
 Title = Titel
-Authors = Autoren
 Author = Autor
+Authors = Autoren
 AuthorID = ID des Autors
 AuthorName = Name des Autors
-Age = Alter
 Name = Name
+Age = Alter
 Stock = Bestand
 Order = Bestellung
 Orders = Bestellungen

package/lib/init/template/sample/files/app/admin-books/fiori-service.cds

@@ -7,7 +7,7 @@ using { sap.capire.bookshop } from '../../db/schema';
 //
 
 annotate AdminService.Books with @(UI: {
-  Facets             : [
+  Facets: [
     {
       $Type : 'UI.ReferenceFacet',
       Label : '{i18n>General}',
@@ -43,7 +43,7 @@ annotate AdminService.Books with @(UI: {
       Label: '{i18n>Currency}'
     },
   ]},
-  FieldGroup #Admin  : {Data: [
+  FieldGroup #Admin: {Data: [
     {Value: createdBy},
     {Value: createdAt},
     {Value: modifiedBy},
@@ -61,12 +61,12 @@ annotate sap.capire.bookshop.Books with @fiori.draft.enabled;
 annotate AdminService.Books with @odata.draft.enabled;
 
 annotate AdminService.Books.texts with @(UI: {
-  Identification : [{Value: title}],
+  Identification: [{Value: title}],
   SelectionFields: [
     locale,
     title
   ],
-  LineItem       : [
+  LineItem: [
     {
       Value: locale,
       Label: 'Locale'
@@ -93,14 +93,13 @@ annotate AdminService.Books.texts {
     ValueList.entity: 'Languages',
     Common.ValueListWithFixedValues, //show as drop down, not a dialog
   )
-}
+};
 
 // In addition we need to expose Languages through AdminService as a target for ValueList
 using {sap} from '@sap/cds/common';
 
 extend service AdminService {
-  @readonly
-  entity Languages as projection on sap.common.Languages;
+  @readonly entity Languages as projection on sap.common.Languages;
 }
 
 // Workaround for Fiori popup for asking user to enter a new UUID on Create

package/lib/init/template/sample/files/app/admin-books/webapp/Component.js

@@ -1,8 +1,8 @@
 sap.ui.define(["sap/fe/core/AppComponent"], function (AppComponent) {
   "use strict";
   return AppComponent.extend("books.Component", {
-    metadata: { manifest: "json" },
-  })
-})
+    metadata: { manifest: "json" }
+  });
+});
 
 /* eslint no-undef:0 */

package/lib/init/template/sample/files/app/admin-books/webapp/i18n/i18n.properties

@@ -1,11 +1,3 @@
-# This is the resource bundle of itelo
-# __ldi.translation.uuid=c3431418-9caf-11e8-98d0-529269fb1459
-
-# JCI app descriptor contains lower case TITLE
-appTitle=Bookshop Sample
-
-# JCI app descriptor contains lower case DESCRIPTION
-appSubTitle=CAP Sample Application
-
-# JCI app descriptor contains lower case DESCRIPTION
-appDescription=CDS Sample Service
+appTitle=Manage Books
+appSubTitle=Manage bookshop inventory
+appDescription=Manage your bookshop inventory with ease.