cosmetics

5.0.1 is broken at the moment

.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [12.x, 14.x]
 
     steps:
     - uses: actions/checkout@v2

.registry/.gitignore

@@ -0,0 +1 @@
+*.tgz

.registry/server.js

@@ -5,9 +5,9 @@ const app = express()
 
 const { PORT=4444 } = process.env
 const [,,port=PORT] = process.argv
+process.chdir(__dirname)
 
 app.use('/-/:tarball', (req,res,next) => {
-  const url = decodeURIComponent(req.url)
   console.debug ('GET', req.params)
   try {
     const { tarball } = req.params

.tours/samples.tour

@@ -0,0 +1,136 @@
+{
+  "$schema": "https://aka.ms/codetour-schema",
+  "title": "CAP Samples",
+  "steps": [
+    {
+      "title": "Welcome",
+      "file": "README.md",
+      "description": "### Welcome to CAP Samples!\n\nThis tour leads you through a collection of samples for the [SAP Cloud Application Programming Model](https://cap.cloud.sap)\nYou will learn which features of the programming models are demonstrated in which sample.\n\nLet's start!",
+      "line": 2,
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 3,
+          "character": 108
+        }
+      }
+    },
+    {
+      "file": "hello/world.cds",
+      "description": "### Hello World!\n\nThis is a simplistic [Hello World](https://cap.cloud.sap/docs/get-started/hello-world) service using [CDS](https://cap.cloud.sap/docs/cds/) and [cds.services](https://cap.cloud.sap/docs/node.js/api#services-api).",
+      "line": 2,
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 4,
+          "character": 1
+        }
+      },
+      "title": "Hello World!"
+    },
+    {
+      "file": "bookshop/db/schema.cds",
+      "description": "### A Bookshop!\n\nIntroduces:\n- [Project Setup](https://cap.cloud.sap/docs/get-started/) and [Layouts](https://cap.cloud.sap/docs/get-started/projects)\n- [Domain Modeling](https://cap.cloud.sap/docs/guides/domain-models)\n- [Defining Services](https://cap.cloud.sap/docs/guides/providing-services)\n- [Generic Providers](https://cap.cloud.sap/docs/guides/generic-providers)\n- [Adding Custom Logic](https://cap.cloud.sap/docs/guides/service-impl)\n- [Using Databases](https://cap.cloud.sap/docs/guides/databases)\n",
+      "line": 1,
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 32,
+          "character": 1
+        }
+      },
+      "title": "Bookshop"
+    },
+    {
+      "file": "common/index.cds",
+      "description": "### Extend and Reuse\n\nShowcases how to extend [@sap/cds/common](https://cap.cloud.sap/docs/cds/common) thereby covering:\n- Building [extension packages](https://cap.cloud.sap/docs/guides/domain-models#aspects-extensibility)\n- Providing [reuse packages](https://cap.cloud.sap/docs/get-started/projects#sharing-and-reusing-content)\n- [Verticalization](https://cap.cloud.sap/docs/cds/common#adapting-to-your-needs)\n- Using [Aspects](https://cap.cloud.sap/docs/cds/cdl#aspects)\n- Used in the [fiori app sample](#fiori)\n",
+      "line": 1,
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 46,
+          "character": 1
+        }
+      },
+      "title": "Common"
+    },
+    {
+      "file": "orders/db/schema.cds",
+      "description": "### Compositions and Serving Documents\n\nA standalone orders management service, demonstrating:\n- Using [Compositions](https://cap.cloud.sap/docs/cds/cdl#compositions) in [Domain Models](https://cap.cloud.sap/docs/guides/domain-models), along with\n- [Serving deeply nested documents](https://cap.cloud.sap/docs/guides/generic-providers#serving-structured-data)\n",
+      "line": 1,
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 27,
+          "character": 1
+        }
+      },
+      "title": "Orders"
+    },
+    {
+      "file": "reviews/db/schema.cds",
+      "description": "### More Modularity\n\nShows how to implement a modular service to manage product reviews, including:\n- Consuming other services synchronously and asynchronously\n- Serving requests synchronously\n- Emitting events asynchronously\n- Grow as you go, with:\n- Mocking app services\n- Running service meshes\n- Late-cut Micro Services\n- As well as managed data, input validations, and authorization\n",
+      "line": 1,
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 39,
+          "character": 1
+        }
+      },
+      "title": "Reviews"
+    },
+    {
+      "file": "fiori/app/index.cds",
+      "description": "### Annotations for SAP Fiori Elements\n\nA [composite app, reusing and combining](https://cap.cloud.sap/docs/guides/verticalize) these packages:\n  - [@capire/bookshop](bookshop)\n  - [@capire/reviews](reviews)\n  - [@capire/orders](orders)\n  - [@capire/common](common)\n\n[Adds a SAP Fiori elements application](https://cap.cloud.sap/docs/guides/fiori/) to bookshop, thereby introducing to:\n  - [OData Annotations](https://cap.cloud.sap/docs/guides/fiori#adding-odata-annotations) in `.cds` files\n  - Support for [Fiori Draft](https://cap.cloud.sap/docs/guides/fiori#draft)\n  - Support for [Value Helps](https://cap.cloud.sap/docs/guides/fiori#value-help)\n  - Serving SAP Fiori apps locally\n\n[The Vue.js app](bookshop/app/vue) imported from bookshop is served as well.\n",
+      "line": 1,
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 13,
+          "character": 1
+        }
+      },
+      "title": "Fiori"
+    },
+    {
+      "file": "package.json",
+      "description": "### All-in-one Monorepo\n\nEach sample sub directory essentially is a standard npm package, some with standard npm dependencies to other samples. The root folder's [package.json](package.json) has local links to the sub folders, such that an `npm install` populates a local `node_modules` folder acts like a local npm registry to the individual sample packages.\n",
+      "line": 8,
+      "selection": {
+        "start": {
+          "line": 8,
+          "character": 1
+        },
+        "end": {
+          "line": 15,
+          "character": 1
+        }
+      },
+      "title": "Packages"
+    }
+  ],
+  "isPrimary": true,
+  "description": "Overview of CAP Samples for Node.js"
+}

.vscode/extensions.json

@@ -4,14 +4,15 @@
 
 	// List of extensions which should be recommended for users of this workspace.
 	"recommendations": [
-		"SAPSE.vscode-cds",
+		"sapse.vscode-cds",
 		"dbaeumer.vscode-eslint",
 		"esbenp.prettier-vscode",
 		"mechatroner.rainbow-csv",
 		"humao.rest-client",
 		"alexcvzz.vscode-sqlite",
 		"hbenl.vscode-mocha-test-adapter",
-		"sdras.night-owl"
+		"sdras.night-owl",
+		"vsls-contrib.codetour"
 	],
 	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
 	"unwantedRecommendations": [

README.md

@@ -3,21 +3,22 @@
 Find here a collection of samples for the [SAP Cloud Application Programming Model](https://cap.cloud.sap) organized in a simplistic [monorepo setup](samples.md#all-in-one-monorepo). → See [**Overview** of contained samples](samples.md)
 
 ![](https://github.com/SAP-samples/cloud-cap-samples/workflows/CI/badge.svg)
-[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/cloud-cap-samples)](https://api.reuse.software/info/github.com/SAP-samples/cloud-cap-samples)
+<!--[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/cloud-cap-samples)](https://api.reuse.software/info/github.com/SAP-samples/cloud-cap-samples)-->
 
 
 ### Preliminaries
 
-1. [Install @sap/cds-dk](https://cap.cloud.sap/docs/get-started/) globally as documented in [capire](https://cap.cloud.sap)
+1. Install [**@sap/cds-dk**](https://cap.cloud.sap/docs/get-started/) globally:
+
    ```sh
    npm i -g @sap/cds-dk
    ```
-2. _Optional:_ [Use Visual Studio Code](https://cap.cloud.sap/docs/get-started/in-vscode)
+
+2. _Optional:_ [Use Visual Studio Code](https://cap.cloud.sap/docs/get-started/tools#vscode)
 
 ### Download
 
-Clone this repo as shown below, if you have [git](https://git-scm.com/downloads) installed,
-otherwise [download as zip file](archive/master.zip).
+If you have [Git](https://git-scm.com/downloads) installed, clone this repo as shown below, otherwise [download as ZIP file](archive/master.zip).
 
 ```sh
 git clone https://github.com/sap-samples/cloud-cap-samples samples
@@ -47,6 +48,7 @@ When asked to log in, type `alice` as user and leave the password field blank, w
 ### Testing
 
 Run the provided tests with [_jest_](http://jestjs.io) or [_mocha_](http://mochajs.org), for example:
+
 ```sh
 npx jest
 ```
@@ -55,7 +57,7 @@ npx jest
 
 ### Serve `npm`
 
-We've included a simple npm registry mock which allows you to do an `npm install @capire/<package>` locally. Use it as follows:
+We've included a simple npm registry mock, which allows you to do an `npm install @capire/<package>` locally. Use it as follows:
 
 1. Start the @capire registry:
 ```sh
@@ -63,7 +65,8 @@ npm run registry
 ```
 > While running this will have `@capire:registry=http://localhost:4444` set with npmrc.
 
-2. Install one of the @capire packages wherever you like, e.g.:
+2. Install one of the @capire packages wherever you like, for example:
+
 ```sh
 npm add @capire/common @capire/bookshop
 ```
@@ -77,4 +80,4 @@ In case you have a question, find a bug, or otherwise need support, please use o
 
 ## License
 
-Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSES/Apache-2.0.txt) file.
+Copyright (c) 2021 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSES/Apache-2.0.txt) file.

bookshop/app/vue/index.html

@@ -36,7 +36,7 @@
             <td class="rating-stars">
                 {{ ('★'.repeat(Math.round(book.rating))+'☆☆☆☆☆').slice(0,5) }}
             </td>
-            <td>{{ book.currency.symbol }} {{ book.price }}</td>
+            <td>{{ book.currency && book.currency.symbol }} {{ book.price }}</td>
         </tr>
     </table>
 

bookshop/readme.md

@@ -5,10 +5,10 @@ This stand-alone sample introduces the essential tasks in the development of CAP
 ## Hypothetical Use Cases
 
 1. Build a service that allows to browse _Books_ and _Authors_.
-2. Books have assigned _Genres_ which are organized hierarchically.
+2. Books have assigned _Genres_, which are organized hierarchically.
 3. All users may browse books without login.
 4. All entries are maintained by Administrators.
-5. End users may order books (the actual order mgmt being out of scope)
+5. End users may order books (the actual order mgmt being out of scope).
 
 ## Running the Sample
 
@@ -20,12 +20,12 @@ npm run watch
 
 | Links to capire                                                                                           | Sample files / folders               |
 | --------------------------------------------------------------------------------------------------------- | ------------------------------------ |
-| [Project Setup and Layouts](https://cap.cloud.sap/docs/get-started/projects#sharing-and-reusing-content)  | [`./`](./)                           |
-| [Defining Domain Models](https://cap.cloud.sap/docs/guides/domain-models)                                 | [`./db/schema.cds`](./db/schema.cds) |
-| [Defining Services](https://cap.cloud.sap/docs/guides/providing-services)                                 | [`./srv/*.cds`](./srv)               |
-| [Single-purposed Services](https://cap.cloud.sap/docs/guides/providing-services#single-purposed-services) | [`./srv/*.cds`](./srv)               |
-| [Generic Providers](https://cap.cloud.sap/docs/guides/providing-services)                                  | http://localhost:4004                |
-| Using Databases                                            | [`./db/data/*.csv`](./db/data)       |
+| [Project Setup & Layouts](https://cap.cloud.sap/docs/get-started/projects#sharing-and-reusing-content)    | [`./`](./)                           |
+| [Domain Modeling with CDS](https://cap.cloud.sap/docs/guides/domain-models)                               | [`./db/schema.cds`](./db/schema.cds) |
+| [Defining Services](https://cap.cloud.sap/docs/guides/services#defining-services)                         | [`./srv/*.cds`](./srv)               |
+| [Single-purposed Services](https://cap.cloud.sap/docs/guides/services#single-purposed-services)           | [`./srv/*.cds`](./srv)               |
+| [Providing & Consuming Providers](https://cap.cloud.sap/docs/guides/providing-services)                   | http://localhost:4004                |
+| [Using Databases](https://cap.cloud.sap/docs/guides/databases)                                            | [`./db/data/*.csv`](./db/data)       |
 | [Adding Custom Logic](https://cap.cloud.sap/docs/guides/service-impl)                                     | [`./srv/*.js`](./srv)                |
-| Adding Tests                                                 | [`./test`](./test)                   |
-| [Sharing for Reuse](https://cap.cloud.sap/docs/get-started/projects#sharing-and-reusing-content)          | [`./index.cds`](./index.cds)         |
+| Adding Tests                                                                                              | [`./test`](./test)                   |
+| [Sharing for Reuse](https://cap.cloud.sap/docs/guides/reuse-and-compose)                                  | [`./index.cds`](./index.cds)         |

common/package.json

@@ -3,6 +3,6 @@
   "description": "Provides a pre-built extension package for std @sap/cds/common",
   "version": "1.0.0",
   "dependencies": {
-    "@sap/cds": "latest"
+    "@sap/cds": "*"
   }
 }

fiori/app/bookshop.html

@@ -1,3 +1,3 @@
 <head>
-  <meta http-equiv="refresh" content="0;url=vue/bookshop/index.html">
+  <meta http-equiv="refresh" content="0;url=bookshop/index.html">
 </head>

fiori/app/reviews.html

@@ -1,3 +1,3 @@
 <head>
-  <meta http-equiv="refresh" content="0;url=vue/reviews/index.html">
+  <meta http-equiv="refresh" content="0;url=reviews/index.html">
 </head>

fiori/server.js

@@ -1,19 +1,18 @@
-const express = require ('express')
 const cds = require ('@sap/cds')
 
 cds.once('bootstrap',(app)=>{
-  const {dirname} = require ('path')
-  // serving the orders app imported from @capire/orders
-  const orders_app = dirname (require.resolve('@capire/orders/app/orders/webapp/manifest.json'))
-  app.use ('/orders/webapp', express.static(orders_app))
-  // serving the vue.js app imported from @capire/bookshop
-  const bookshop_app = dirname (require.resolve('@capire/bookshop/app/vue/index.html'))
-  app.use ('/vue/bookshop', express.static(bookshop_app))
-  // serving the vue.js app imported from @capire/reviews
-  const reviews_app = dirname (require.resolve('@capire/reviews/app/vue/index.html'))
-  app.use ('/vue/reviews', express.static(reviews_app))
+  app.use ('/orders/webapp', _from('@capire/orders/app/orders/webapp/manifest.json'))
+  app.use ('/bookshop', _from('@capire/bookshop/app/vue/index.html'))
+  app.use ('/reviews', _from('@capire/reviews/app/vue/index.html'))
 })
 
 cds.once('served', require('./srv/mashup'))
 
 module.exports = cds.server
+
+
+// -----------------------------------------------------------------------
+// Helper for serving static content from npm-installed packages
+const {static} = require('express')
+const {dirname} = require('path')
+const _from = target => static (dirname (require.resolve(target)))

fiori/test/build/build-task.js

@@ -0,0 +1,14 @@
+const cds = require ('./sap-cds')
+
+module.exports = class extends cds.build.Task {
+
+  async build ({src='*'}) {
+    this.log (`Generating edmx output for '${src}'...`)
+    const csn = await this.model(src)
+    return Promise.all (csn.services.map (({name:service}) => {
+      const edmx = cds.compile(csn).to.edmx({service})
+      return this.write(edmx).to(`{srv}/src/main/resources/${service}.edmx`)
+    }))
+  }
+
+}

fiori/test/build/sap-cds.js

@@ -0,0 +1,51 @@
+const cds = require ('@sap/cds/lib')
+const path = require('path')
+const cwd = process.cwd()
+
+const _resolve = (root,file) => path.resolve (cwd, root, file.replace(/{(app|db|srv)}\/?/g, (_,folder) => cds.env.folders[folder]))
+const _local = (file) => path.relative (cwd,file)
+
+
+class BuildTask {
+
+  async build (options) {}
+  async clean (options) {}
+
+  async model(src='*') {
+    return cds.linked (await cds.load(src))
+  }
+
+  log(...args) { return console.log(...args) }
+  warn(...args) { return console.warn(...args) }
+  error(...args) { return console.error(...args) }
+
+  write(x) {
+    if (typeof x === 'object') x = JSON.stringify(x,null,'  ')
+    return { to: async (dst)=>{
+      const file = _resolve (this.options.dest, dst)
+      await cds.utils.mkdirp (path.dirname (file))
+      await cds.utils.promises.writeFile (file,x)
+      console.log ('> wrote:', _local(file))
+      return file
+    }}
+  }
+
+  copy(x) {
+    return { to: async (dst) => {} }
+  }
+
+}
+
+
+module.exports = Object.assign (cds, {
+  build: {
+    run (tasks, _options) {
+      const options = { dest:'gen', ..._options }
+      return Promise.all(tasks.map (async each => {
+        const task = Object.assign (new each, {options})
+        await task.build (options)
+      }))
+    },
+    Task: BuildTask
+  }
+})

fiori/test/build/test.js

@@ -0,0 +1,5 @@
+const cds = require ('./sap-cds')
+const task = require('./build-task')
+
+cds.build.run ([task], {src:process.argv[2]})
+.catch(console.error)

orders/db/schema.cds

@@ -21,6 +21,3 @@ entity Orders_Items {
 entity Products @(cds.persistence.skip:'always') {
   key ID : String;
 }
-
-// Activate extension package
-using from '@capire/common';

orders/package.json

@@ -2,7 +2,6 @@
   "name": "@capire/orders",
   "version": "1.0.0",
   "dependencies": {
-    "@capire/common": "*",
     "@sap/cds": "^4.3.0"
   }
 }

package.json

@@ -17,10 +17,10 @@
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "chai-subset": "^1.6.0",
-    "sqlite3": "^5"
+    "sqlite3": "5.0.0"
   },
   "scripts": {
-    "registry": "cd .registry && node server.js",
+    "registry": "node .registry/server.js",
     "bookshop": "cds watch bookshop",
     "fiori": "cds watch fiori",
     "media": "cds watch media",

samples.md

@@ -1,7 +1,7 @@
 # Overview of Samples
 
-The list below gives an overview of the samples provided in subdirectories.
-Each sub directory essentially is a individual npm package arranged in an [all-in-one monorepo](all-in-one-monorepo) umbrella setup.
+The following list gives an overview of the samples provided in subdirectories.
+Each sub directory essentially is an individual npm package arranged in an [all-in-one monorepo](all-in-one-monorepo) umbrella setup.
 
 
 ## [@capire/hello-world](hello)
@@ -13,7 +13,7 @@ Each sub directory essentially is a individual npm package arranged in an [all-i
 
 - [Getting Started](https://cap.cloud.sap/docs/get-started/in-a-nutshell) with CAP, briefly introducing:
 - [Project Setup](https://cap.cloud.sap/docs/get-started/) and [Layouts](https://cap.cloud.sap/docs/get-started/projects)
-- [Domain Modelling](https://cap.cloud.sap/docs/guides/domain-models)
+- [Domain Modeling](https://cap.cloud.sap/docs/guides/domain-models)
 - [Defining Services](https://cap.cloud.sap/docs/guides/providing-services)
 - [Generic Providers](https://cap.cloud.sap/docs/guides/generic-providers)
 - [Adding Custom Logic](https://cap.cloud.sap/docs/guides/service-impl)
@@ -22,7 +22,7 @@ Each sub directory essentially is a individual npm package arranged in an [all-i
 
 ## [@capire/common](common)
 
-- Showcases how to extend [@sap/cds/common](https://cap.cloud.sap/docs/cds/common) thereby covering...
+- Showcases how to extend [@sap/cds/common](https://cap.cloud.sap/docs/cds/common) thereby covering:
 - Building [extension packages](https://cap.cloud.sap/docs/guides/domain-models#aspects-extensibility)
 - Providing [reuse packages](https://cap.cloud.sap/docs/get-started/projects#sharing-and-reusing-content)
 - [Verticalization](https://cap.cloud.sap/docs/cds/common#adapting-to-your-needs)
@@ -32,22 +32,22 @@ Each sub directory essentially is a individual npm package arranged in an [all-i
 
 ## [@capire/orders](orders)
 
-- A standalone orders mgmt service, demonstrating...
+- A standalone orders management service, demonstrating:
 - Using [Compositions](https://cap.cloud.sap/docs/cds/cdl#compositions) in [Domain Models](https://cap.cloud.sap/docs/guides/domain-models), along with
 - [Serving deeply nested documents](https://cap.cloud.sap/docs/guides/generic-providers#serving-structured-data)
 
 
 ## [@capire/reviews](reviews)
 
-- Shows how to implement a modular service to manage product reviews, including...
+- Shows how to implement a modular service to manage product reviews, including:
 - Consuming other services synchronously and asynchronously
 - Serving requests synchronously
 - Emitting events asynchronously
-- Grow as you go, with...
+- Grow as you go, with:
 - Mocking app services
 - Running service meshes
 - Late-cut Micro Services
-- As well as managed data, input validations and authorization
+- As well as managed data, input validations, and authorization
 
 
 ## [@capire/fiori](fiori)
@@ -57,11 +57,11 @@ Each sub directory essentially is a individual npm package arranged in an [all-i
   - [@capire/reviews](reviews)
   - [@capire/orders](orders)
   - [@capire/common](common)
-- [Adds a Fiori elements application](https://cap.cloud.sap/docs/guides/fiori/) to bookshop, thereby introducing to...
+- [Adds a SAP Fiori elements application](https://cap.cloud.sap/docs/guides/fiori/) to bookshop, thereby introducing to:
   - [OData Annotations](https://cap.cloud.sap/docs/guides/fiori#adding-odata-annotations) in `.cds` files
   - Support for [Fiori Draft](https://cap.cloud.sap/docs/guides/fiori#draft)
   - Support for [Value Helps](https://cap.cloud.sap/docs/guides/fiori#value-help)
-  - Serving Fiori apps locally
+  - Serving SAP Fiori apps locally
 - [The Vue.js app](bookshop/app/vue) imported from bookshop is served as well