Added changes for simple field extensibility (UIFlex)

Signed-off-by: Christian Georgi <christian.georgi@sap.com>

.github/workflows/node.js.yml

@@ -5,9 +5,9 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   build:
@@ -24,5 +24,5 @@ jobs:
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
-    - run: npm install
+    - run: npm ci
     - run: npm test

.gitignore

@@ -15,3 +15,5 @@ default-env.json
 packages/messageBox
 reviews/msg-box
 reviews/db/test.db
+
+*.openapi3.json

.npmrc

@@ -0,0 +1,3 @@
+# Ensure we always use public packages, i.e. avoid using local registries from ~/.npmrc
+@sap:registry=https://registry.npmjs.org/
+registry=https://registry.npmjs.org/

.registry/server.js

@@ -1,19 +1,25 @@
 const { exec } = require ('child_process')
+const isWin = process.platform === 'win32'
 const express = require ('express')
 const fs = require ('fs')
 const app = express()
 
 const { PORT=4444 } = process.env
-const [,,port=PORT] = process.argv
+const [,,port=PORT,scope='@capire'] = process.argv
-process.chdir(__dirname)
+const cwd = __dirname
+
+// clean up on start (exit handler might not complete on Windows)
+exec(isWin ? 'del *.tgz' : 'rm *.tgz', {cwd})
+
 
 app.use('/-/:tarball', (req,res,next) => {
   console.debug ('GET', req.params)
   try {
     const { tarball } = req.params
-    const [, pkg ] = /^capire-(\w+)/.exec(tarball)
+    const [, pkg ] = /^\w+-(\w+)/.exec(tarball)
     fs.lstat(tarball,(err => {
-      if (err) exec(`npm pack ../${pkg}`,next)
+      if (err) console.debug (`npm pack ../${pkg}`)
+      if (err) exec(`npm pack ../${pkg}`,{cwd},next)
       else next()
     }))
   } catch (e) {
@@ -25,12 +31,14 @@ app.use('/-/:tarball', (req,res,next) => {
 app.use('/-', express.static(__dirname))
 
 app.get('/*', (req,res)=>{
+  const urlRegex = /^\/(@\w+)\/(\w+)/
   const url = decodeURIComponent(req.url)
   console.debug ('GET',url)
   try {
-    const [, capire, pkg ] = /^\/(@capire)\/(\w+)/.exec(url)
+    if (!urlRegex.test(url))  return res.sendStatus(404)
-    const package = require (`${capire}/${pkg}/package.json`)
+    const [, scpe, pkg ] = urlRegex.exec(url)
-    const tarball = `capire-${pkg}-${package.version}.tgz`
+    const package = require (`${scpe}/${pkg}/package.json`)
+    const tarball = `${scpe.slice(1)}-${pkg}-${package.version}.tgz`
     // https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md
     res.json({
       "name": package.name,
@@ -42,29 +50,30 @@ app.get('/*', (req,res)=>{
           "name": package.name,
           "version": package.version,
           "dist": {
-            "tarball": `http://localhost:${port}/-/${tarball}`
+            "tarball": `${server.url}/-/${tarball}`
           },
         }
       },
     })
   } catch (e) {
-    console.error(e)
+    if (e.code === 'MODULE_NOT_FOUND')  return res.sendStatus(404)
-    res.sendStatus(404)
+    console.error(e);  throw e
   }
 })
 
-app.listen(port, ()=>{
+const server = app.listen(port, ()=>{
-  console.log (`npm set @capire:registry=http://localhost:${port}`)
+  const url = server.url = `http://localhost:${server.address().port}`
-  console.log (`@capire registry listening on http://localhost:${port}`)
+  console.log (`npm set ${scope}:registry=${url}`)
-  exec(`npm set @capire:registry=http://localhost:${port}`)
+  exec(`npm set ${scope}:registry=${url}`)
+  console.log (`${scope} registry listening on ${url}`)
 })
 
+
 const _exit = ()=>{
-  console.log ('\nnpm conf rm @capire:registry')
+  server.close()
-  exec('npm conf rm @capire:registry')
+  exec(`npm conf rm "${scope}:registry"`, ()=> { process.exit() })
-  exec('rm *.tgz')
-  process.exit()
 }
+
 process.on ('SIGTERM',_exit)
 process.on ('SIGHUP',_exit)
 process.on ('SIGINT',_exit)

.tours/db-native.tour

@@ -68,26 +68,35 @@
     },
     {
       "file": "fiori/package.json",
-      "description": "#### Configuration\n\nThe `cds` section in `package.json` is a place to configure which of the `db/sqlite` and `db/hana` folders are used for which database.\nWe use [Node.js profiles](https://cap.cloud.sap/docs/node.js/cds-env#profiles) to separate the configuration.\nIn the `development` profile, you can see that `db/sqlite` is set as the model, while the `db/hana` folder is configured in the `production` profile.",
+      "description": "#### Configuration\n\nThe `cds.requires` section in `package.json` is a place to configure which of the `db/sqlite` and `db/hana` folders are used for which database.\n\nWe use [Node.js profiles](https://cap.cloud.sap/docs/node.js/cds-env#profiles) to separate the configuration.\nIn the `development` profile, you can see that `db/sqlite` is set as the model, while the `db/hana` folder is configured in the `production` profile.  `db-ext` is a pseudo datasource, its name doesn't matter.\n\nSee [`cds.resolve`](https://cap.cloud.sap/docs/node.js/cds-compile#cds-resolve) to learn more about how models are found.",
-      "line": 17,
+      "selection": {
+        "start": {
+          "line": 41,
+          "character": 1
+        },
+        "end": {
+          "line": 48,
+          "character": 1
+        }
+      },
       "title": "Configuration"
     },
     {
       "file": "fiori/package.json",
       "description": "#### Run with SQLite\n\nTo run with `development` and an in-memory SQLite database, you don't need to do anything special, because it's activated by default.  Just run:\n\n>> cds watch fiori\n\nThen open [http://localhost:4004/admin/Authors](http://localhost:4004/admin/Authors) to see the two new fields.\n",
-      "line": 28,
+      "line": 43,
       "title": "Run with SQLite"
     },
     {
       "file": "fiori/package.json",
       "description": "#### Deploy the CDS Model to SAP HANA\n\nTo 'activate' SAP HANA through the `production` profile, you can use the global `--production` flag:\n\n>> cd fiori; cds deploy --to hana --production\n\n[Learn more about SAP HANA deployment](https://cap.cloud.sap/docs/guides/databases#get-hana)\n\n#### Run the Application\n\n>> cd fiori; cds watch --production\n\nThe service on [http://localhost:4004/admin/Authors](http://localhost:4004/admin/Authors) is the same as before, but this time the `Authors` entity is backed by a database view with an SAP HANA function.\n\n#### More\n\nIf you don't see data, you can add some in the next step.",
-      "line": 31,
+      "line": 46,
       "title": "Run with SAP HANA"
     },
     {
       "file": "fiori/test/requests.http",
       "description": "### Add More Data\n\nOptionally you can add some `Authors` data by clicking on the _Send Request_ link (provided by the [REST client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) extension).",
-      "line": 68,
+      "line": 72,
       "selection": {
         "start": {
           "line": 67,
@@ -104,6 +113,5 @@
       "title": "Wrap-up",
       "description": "### Summary\n\nThat's it!  You have seen: \n- How to integrate database-specific functions in a CDS model.\n- How to switch between the two implementations for SQLite and SAP HANA."
     }
-  ],
+  ]
-  "ref": "master"
 }

.tours/samples.tour

@@ -19,7 +19,7 @@
       }
     },
     {
-      "file": "hello/world.cds",
+      "file": "hello/srv/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": {
@@ -68,7 +68,7 @@
     },
     {
       "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",
+      "description": "### Orders - 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": {
@@ -84,7 +84,7 @@
     },
     {
       "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",
+      "description": "### Reviews - 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": {
@@ -99,8 +99,12 @@
       "title": "Reviews"
     },
     {
-      "file": "fiori/app/index.cds",
+      "title": "Bookstore",
-      "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",
+      "description": "### Bookstore - Reuse and UI\n\n- A [composite app, reusing and combining](https://cap.cloud.sap/docs/guides/reuse-and-compose) these packages:\n  - [@capire/bookshop](bookshop)\n  - [@capire/reviews](reviews)\n  - [@capire/orders](orders)\n  - [@capire/common](common)\n- [The Vue.js app](bookshop/app/vue) imported from bookshop is served as well\n- [The Vue.js app](reviews/app/vue) imported from reviews is served as well\n- [The Fiori app](orders/app) imported from orders is served as well\n- [OpenAPI export + Swagger UI](https://cap.cloud.sap/docs/advanced/openapi)"
+    },
+    {
+      "file": "fiori/app/services.cds",
+      "description": "### Annotations for SAP Fiori Elements\n\n- [Adds an SAP Fiori elements application](https://cap.cloud.sap/docs/guides/fiori/) to bookstore, 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",
       "line": 1,
       "selection": {
         "start": {
@@ -117,14 +121,13 @@
     {
       "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,
+          "line": 16,
           "character": 1
         }
       },

.vscode/launch.json

@@ -4,28 +4,31 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
-  {
-    "name": "Attach by Process ID",
-    "processId": "${command:PickProcess}",
-    "request": "attach",
-    "skipFiles": [
-      "<node_internals>/**"
-    ],
-    "type": "pwa-node"
-  },
     {
       "name": "bookshop",
-      "command": "cds watch bookshop",
+      "command": "npx cds watch bookshop",
-      "request": "launch",
       "type": "node-terminal",
-      "skipFiles": ["<node_internals>/**"]
+      "request": "launch",
+      "skipFiles": [
+        "<node_internals>/**",
+        "**/node_modules/**",
+        "**/cds/lib/lazy.js",
+        "**/cds/lib/req/cls.js",
+        "**/odata-v4/okra/**"
+      ]
     },
     {
-      "name": "Fiori app",
+      "name": "Fiori App",
-      "command": "cds watch fiori",
+      "command": "npx cds watch fiori",
-      "request": "launch",
       "type": "node-terminal",
-      "skipFiles": ["<node_internals>/**"]
+      "request": "launch",
+      "skipFiles": [
+        "<node_internals>/**",
+        "**/node_modules/**",
+        "**/cds/lib/lazy.js",
+        "**/cds/lib/req/cls.js",
+        "**/odata-v4/okra/**"
+      ]
     }
   ],
   "inputs": [
@@ -33,7 +36,7 @@
       "type": "pickString",
       "id": "sample",
       "description": "Which sample do you want to start?",
-      "options": ["bookshop", "fiori", "reviews", "reviews/test/bookshop"],
+      "options": [ "bookshop", "fiori", "reviews", "reviews" ],
       "default": "bookshop"
     }
   ]

.vscode/settings.json

@@ -4,5 +4,14 @@
     "**/.gitignore": true,
     "**/.vscode": true,
     "LICENSES/**": true
+  },
+  "debug.javascript.terminalOptions": {
+    "skipFiles": [
+      "<node_internals>/**",
+      "**/node_modules/**",
+      "**/cds/lib/lazy.js",
+      "**/cds/lib/req/cls.js",
+      "**/odata-v4/okra/**"
+    ]
   }
 }

README.md

@@ -17,7 +17,7 @@ Find here a collection of samples for the [SAP Cloud Application Programming Mod
 
 ### Download
 
-If you've [Git](https://git-scm.com/downloads) installed, clone this repo as shown below, otherwise [download as ZIP file](archive/master.zip).
+If you've [Git](https://git-scm.com/downloads) installed, clone this repo as shown below, otherwise [download as ZIP file](archive/main.zip).
 
 ```sh
 git clone https://github.com/sap-samples/cloud-cap-samples samples
@@ -83,4 +83,4 @@ In case you've a question, find a bug, or otherwise need support, use our [commu
 
 ## License
 
-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.
+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](LICENSE.txt) file.

bookshop/app/vue/app.js

@@ -10,7 +10,7 @@ const books = new Vue ({
     data: {
         list: [],
         book: undefined,
-        order: { amount:1, succeeded:'', failed:'' }
+        order: { quantity:1, succeeded:'', failed:'' }
     },
 
     methods: {
@@ -26,18 +26,18 @@ const books = new Vue ({
             const book = books.book = books.list [eve.currentTarget.rowIndex-1]
             const res = await GET(`/Books/${book.ID}?$select=descr,stock,image`)
             Object.assign (book, res.data)
-            books.order = { amount:1 }
+            books.order = { quantity:1 }
             setTimeout (()=> $('form > input').focus(), 111)
         },
 
         async submitOrder () {
-            const {book,order} = books, amount = parseInt (order.amount) || 1 // REVISIT: Okra should be less strict
+            const {book,order} = books, quantity = parseInt (order.quantity) || 1 // REVISIT: Okra should be less strict
             try {
-                const res = await POST(`/submitOrder`, { amount, book: book.ID })
+                const res = await POST(`/submitOrder`, { quantity, book: book.ID })
                 book.stock = res.data.stock
-                books.order = { amount, succeeded: `Successfully orderd ${amount} item(s).` }
+                books.order = { quantity, succeeded: `Successfully ordered ${quantity} item(s).` }
             } catch (e) {
-                books.order = { amount, failed: e.response.data.error.message }
+                books.order = { quantity, failed: e.response.data.error.message }
             }
         }
 

bookshop/app/vue/index.html

@@ -34,7 +34,7 @@
             <td>{{ book.author }}</td>
             <td>{{ book.genre.name }}</td>
             <td class="rating-stars">
-                {{ ('★'.repeat(Math.round(book.rating))+'☆☆☆☆☆').slice(0,5) }}
+                {{ ('★'.repeat(Math.round(book.rating))+'☆☆☆☆☆').slice(0,5) }} ({{ book.numberOfReviews }})
             </td>
             <td>{{ book.currency && book.currency.symbol }} {{ book.price }}</td>
         </tr>
@@ -48,7 +48,7 @@
             &nbsp;&nbsp; {{ book.stock }} in stock
         </label>
         <form @submit.prevent="submitOrder" style="float:right; display:flex; flex-direction:row-reverse">
-            <input type="number" v-model="order.amount" v-bind:class="{ failed: order.failed }" style="width:5em">
+            <input type="number" v-model="order.quantity" v-bind:class="{ failed: order.failed }" style="width:5em">
             <input type="submit" value="Order:" class="muted-button">
         </form>
         <h4> {{ book.title }} </h4>

bookshop/db/data/sap.capire.bookshop-Books.csv

@@ -3,4 +3,4 @@ ID;title;descr;author_ID;stock;price;currency_code;genre_ID
 207;Jane Eyre;"Jane Eyre /ɛər/ (originally published as Jane Eyre: An Autobiography) is a novel by English writer Charlotte Brontë, published under the pen name ""Currer Bell"", on 16 October 1847, by Smith, Elder & Co. of London. The first American edition was published the following year by Harper & Brothers of New York. Primarily a bildungsroman, Jane Eyre follows the experiences of its eponymous heroine, including her growth to adulthood and her love for Mr. Rochester, the brooding master of Thornfield Hall. The novel revolutionised prose fiction in that the focus on Jane's moral and spiritual development is told through an intimate, first-person narrative, where actions and events are coloured by a psychological intensity. The book contains elements of social criticism, with a strong sense of Christian morality at its core and is considered by many to be ahead of its time because of Jane's individualistic character and how the novel approaches the topics of class, sexuality, religion and feminism.";107;11;12.34;GBP;11
 251;The Raven;"""The Raven"" is a narrative poem by American writer Edgar Allan Poe. First published in January 1845, the poem is often noted for its musicality, stylized language, and supernatural atmosphere. It tells of a talking raven's mysterious visit to a distraught lover, tracing the man's slow fall into madness. The lover, often identified as being a student, is lamenting the loss of his love, Lenore. Sitting on a bust of Pallas, the raven seems to further distress the protagonist with its constant repetition of the word ""Nevermore"". The poem makes use of folk, mythological, religious, and classical references.";150;333;13.13;USD;16
 252;Eleonora;"""Eleonora"" is a short story by Edgar Allan Poe, first published in 1842 in Philadelphia in the literary annual The Gift. It is often regarded as somewhat autobiographical and has a relatively ""happy"" ending.";150;555;14;USD;16
-271;Catweazle;Catweazle is a British fantasy television series, starring Geoffrey Bayldon in the title role, and created by Richard Carpenter for London Weekend Television. The first series, produced and directed by Quentin Lawrence, was screened in the UK on ITV in 1970. The second series, directed by David Reid and David Lane, was shown in 1971. Each series had thirteen episodes, most but not all written by Carpenter, who also published two books based on the scripts.;170;22;15;EUR;13
+271;Catweazle;Catweazle is a British fantasy television series, starring Geoffrey Bayldon in the title role, and created by Richard Carpenter for London Weekend Television. The first series, produced and directed by Quentin Lawrence, was screened in the UK on ITV in 1970. The second series, directed by David Reid and David Lane, was shown in 1971. Each series had thirteen episodes, most but not all written by Carpenter, who also published two books based on the scripts.;170;22;150;JPY;13