How to run embedded OrderService?

cds deploy excludes its definitions if `OrdersService` is marked
as external.  How would we tell it to include them in the embedded case?

.github/workflows/node.js.yml

@@ -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

@@ -5,7 +5,7 @@ const app = express()
 
 const { PORT=4444 } = process.env
 const [,,port=PORT] = process.argv
-process.chdir(__dirname)
+const cwd = __dirname
 
 app.use('/-/:tarball', (req,res,next) => {
   console.debug ('GET', req.params)
@@ -13,7 +13,7 @@ app.use('/-/:tarball', (req,res,next) => {
     const { tarball } = req.params
     const [, pkg ] = /^capire-(\w+)/.exec(tarball)
     fs.lstat(tarball,(err => {
-      if (err) exec(`npm pack ../${pkg}`,next)
+      if (err) exec(`npm pack ../${pkg}`,{cwd},next)
       else next()
     }))
   } catch (e) {

.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

@@ -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

@@ -35,7 +35,7 @@ const books = new Vue ({
             try {
                 const res = await POST(`/submitOrder`, { amount, book: book.ID })
                 book.stock = res.data.stock
-                books.order = { amount, succeeded: `Successfully orderd ${amount} item(s).` }
+                books.order = { amount, succeeded: `Successfully ordered ${amount} item(s).` }
             } catch (e) {
                 books.order = { amount, failed: e.response.data.error.message }
             }

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

bookshop/package.json

@@ -4,7 +4,7 @@
   "description": "A simple self-contained bookshop service.",
   "dependencies": {
     "@capire/common": "*",
-    "@sap/cds": ">=4",
+    "@sap/cds": "^5.0.4",
     "express": "^4.17.1",
     "passport": "0.4.1"
   },

bookshop/srv/cat-service.cds

@@ -1,13 +1,15 @@
 using { sap.capire.bookshop as my } from '../db/schema';
 service CatalogService @(path:'/browse') {
 
-  @readonly entity Books as SELECT from my.Books { *,
+  /** For displaying lists of Books */
+  @readonly entity ListOfBooks as projection on Books
+  excluding { descr };
+
+  /** For display in details pages */
+  @readonly entity Books as projection on my.Books { *,
     author.name as author
   } excluding { createdBy, modifiedBy };
 
-  @readonly entity ListOfBooks as SELECT from Books
-  excluding { descr };
-
   @requires: 'authenticated-user'
   action submitOrder ( book: Books:ID, amount: Integer ) returns { stock: Integer };
   event OrderedBook : { book: Books:ID; amount: Integer; buyer: String };

bookshop/srv/cat-service.js

@@ -5,10 +5,10 @@ class CatalogService extends cds.ApplicationService { init(){
 
   // Reduce stock of ordered books if available stock suffices
   this.on ('submitOrder', async req => {
-    const {book,amount} = req.data, tx = cds.tx(req)
+    const {book,amount} = req.data
-    let {stock} = await tx.read('stock').from(Books,book)
+    let {stock} = await SELECT `stock` .from (Books,book)
     if (stock >= amount) {
-      await tx.update (Books,book).with ({ stock: stock -= amount })
+      await UPDATE (Books,book) .with (`stock -=`, amount)
       await this.emit ('OrderedBook', { book, amount, buyer:req.user.id })
       return { stock }
     }
@@ -16,10 +16,8 @@ class CatalogService extends cds.ApplicationService { init(){
   })
 
   // Add some discount for overstocked books
-  this.after ('READ','Books', each => {
+  this.after ('READ','ListOfBooks', each => {
-    if (each.stock > 111) {
+    if (each.stock > 111) each.title += ` -- 11% discount!`
-      each.title += ` -- 11% discount!`
-    }
   })
 
   return super.init()

common/data/sap.common-Currencies_texts.csv

@@ -5,9 +5,11 @@ CAD;de;Kanadischer Dollar;Kanadischer Dollar
 AUD;de;Australischer Dollar;Australischer Dollar
 GBP;de;Pfund;Britische Pfund
 ILS;de;Schekel;Israelische Schekel
+JPY;de;Yen;Japanische Yen
 EUR;fr;euro;de la Zone euro
 USD;fr;dollar;dollar des États-Unis
 CAD;fr;dollar canadien;dollar canadien
 AUD;fr;dollar australien;dollar australien
 GBP;fr;livre sterling;pound sterling
 ILS;fr;Shekel;shekel israelien
+JPY;fr;Yen;Yen japonais

fiori/app/admin/fiori-service.cds

@@ -1,4 +1,4 @@
-using { AdminService } from '../../db/schema';
+using { AdminService, sap.capire.bookshop } from '../../db/schema';
 
 ////////////////////////////////////////////////////////////////////////////
 //
@@ -70,7 +70,7 @@ annotate AdminService.Authors with @(
 annotate sap.capire.bookshop.Books with @fiori.draft.enabled;
 annotate AdminService.Books with @odata.draft.enabled;
 
-annotate AdminService.Books_texts with @(
+annotate AdminService.Books.texts with @(
 	UI: {
 		Identification: [{Value:title}],
 		SelectionFields: [ locale, title ],
@@ -83,11 +83,12 @@ annotate AdminService.Books_texts with @(
 );
 
 // Add Value Help for Locales
-annotate AdminService.Books_texts {
+annotate AdminService.Books.texts {
 	locale @ValueList:{entity:'Languages',type:#fixed}
 }
-// In addition we need to expose Languages through AdminService
+// In addition we need to expose Languages and Books.texts through AdminService
 using { sap } from '@sap/cds/common';
 extend service AdminService {
 	entity Languages as projection on sap.common.Languages;
+	entity Books.texts as projection on bookshop.Books.texts;
 }

fiori/app/common.cds

@@ -54,7 +54,7 @@ annotate my.Books with {
 	title @title:'{i18n>Title}';
 	genre  @title:'{i18n>Genre}'  @Common: { Text: genre.name,  TextArrangement: #TextOnly };
 	author @title:'{i18n>Author}' @Common: { Text: author.name, TextArrangement: #TextOnly };
-	price @title:'{i18n>Price}';
+	price @title:'{i18n>Price}' @Measures.ISOCurrency: currency_code;
 	stock @title:'{i18n>Stock}';
 	descr @UI.MultiLineText;
 }

fiori/package.json

@@ -6,7 +6,7 @@
     "@capire/reviews": "*",
     "@capire/orders": "*",
     "@capire/common": "*",
-    "@sap/cds": ">=4",
+    "@sap/cds": "^5",
     "express": "^4.17.1",
     "passport": "^0.4.1"
   },
@@ -26,7 +26,7 @@
         "kind": "odata",
         "model": "@capire/reviews"
       },
-      "OrdersService": {
+      "--> OrdersService": {
         "kind": "odata",
         "model": "@capire/orders"
       },

fiori/server.js

@@ -1,4 +1,5 @@
 const cds = require ('@sap/cds')
+module.exports = cds.server
 
 cds.once('bootstrap',(app)=>{
   app.use ('/orders/webapp', _from('@capire/orders/app/orders/webapp/manifest.json'))
@@ -8,7 +9,11 @@ cds.once('bootstrap',(app)=>{
 
 cds.once('served', require('./srv/mashup'))
 
-module.exports = cds.server
+// Swagger UI - see https://cap.cloud.sap/docs/advanced/openapi
+if (process.env.NODE_ENV !== 'production') {
+  const cds_swagger = require ('cds-swagger-ui-express')
+  cds.once ('bootstrap', app => app.use (cds_swagger()) )
+}
 
 
 // -----------------------------------------------------------------------

fiori/test/requests.http

@@ -38,7 +38,11 @@ GET {{bookshop}}/browse/Books(201)?
 &$select=ID,title,rating
 &$expand=reviews
 
+###
 
+GET {{bookshop}}/browse/Books?
+  &$select=title,author&$expand=currency
+Accept-Language: de
 
 #################################################
 #

hello/package.json

@@ -2,6 +2,28 @@
   "name": "@capire/hello-world",
   "version": "1.0.0",
   "scripts": {
-    "watch": "cds serve world.cds"
+    "test": "npx jest --silent",
+    "watch": "cds serve world.cds",
+    "watch:ts": "cds-ts serve world.cds"
+  },
+  "devDependencies": {
+    "@types/jest": "^26.0.23",
+    "@types/node": "^15.12.0",
+    "ts-jest": "^27.0.2",
+    "typescript": "^4.3.5"
+  },
+  "jest": {
+    "testEnvironment": "node",
+    "preset": "ts-jest",
+    "globals": {
+      "ts-jest": {
+        "diagnostics": {
+          "_comment": "see https://githubmemory.com/repo/kulshekhar/ts-jest/issues/2722",
+          "ignoreCodes": [
+            151001
+          ]
+        }
+      }
+    }
   }
 }

hello/test/hello-world-ts.test.ts

@@ -0,0 +1,15 @@
+process.env.CDS_TYPESCRIPT = 'true';
+import * as cds from '@sap/cds';
+
+//@ts-ignore
+const {GET} = cds.test.in(__dirname,'..').run('serve', 'world.cds');
+
+describe('Hello world!', () => {
+    afterAll(() => { delete process.env.CDS_TYPESCRIPT; });
+
+    it('should say hello with class impl from a typescript file', async () => {
+        const {data} = await GET`/say/hello(to='world')`
+        expect(data.value).toMatch(/Hello world.*typescript.*/i)
+    })
+
+})

hello/world.ts

@@ -0,0 +1,5 @@
+module.exports = class say {
+    hello(req: any) {
+        return `Hello ${req.data.to} from a typescript file!`
+    }
+}

orders/db/schema.cds

@@ -13,7 +13,7 @@ entity Orders_Items {
   up_       : Association to Orders;
   product   : Association to Products @assert.integrity:false; // REVISIT: this is a temporary workaround for a glitch in cds-runtime
   amount    : Integer;
-  title     : String;
+  title     : String; //> intentionally replicated as snapshot from product.title
   price     : Double;
 }
 

orders/package.json

@@ -2,6 +2,6 @@
   "name": "@capire/orders",
   "version": "1.0.0",
   "dependencies": {
-    "@sap/cds": ">=4.3.0"
+    "@sap/cds": "^5"
   }
 }

package.json

@@ -11,29 +11,35 @@
     "@capire/hello": "./hello",
     "@capire/media": "./media",
     "@capire/orders": "./orders",
-    "@capire/reviews": "./reviews"
+    "@capire/reviews": "./reviews",
+    "@sap/cds": "^5",
+    "express": "^4"
   },
   "devDependencies": {
+    "cds-swagger-ui-express": "^0.2.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "chai-subset": "^1.6.0",
     "sqlite3": "^5.0.0"
   },
   "scripts": {
+    "cleanup": "rm -rf node_modules && rm -rf */node_modules && rm -rf */*/node_modules",
     "registry": "node .registry/server.js",
     "bookshop": "cds watch bookshop",
     "fiori": "cds watch fiori",
     "media": "cds watch media",
     "mocha": "npx mocha || echo",
     "jest": "npx jest",
-    "test": "npm run jest --silent"
+    "test": "npm run jest --silent && npm run test:hello",
+    "test:hello": "cd hello && npm test"
+  },
+  "jest": {
+    "testEnvironment": "node",
+    "testMatch": ["**/*.test.js"]
   },
   "mocha": {
     "parallel": true
   },
-  "jest": {
-    "testEnvironment": "node"
-  },
   "license": "SAP SAMPLE CODE LICENSE",
   "private": true
 }

reviews/package.json

@@ -7,7 +7,7 @@
     "index.cds"
   ],
   "dependencies": {
-    "@sap/cds": ">=4",
+    "@sap/cds": "^5",
     "express": "^4.17.1"
   },
   "scripts": {

reviews/readme.md

@@ -2,10 +2,10 @@
 
 ## Run all-in-one
 
-Open a terminal window and run the bookshop in it:
+Open a terminal window and run the `fiori` app in it:
 
 ```sh
-npm run bookshop
+npm run fiori
 ```
 
 
@@ -17,8 +17,8 @@ Open two terminal windows. In the first one start the reviews service stand-alon
 npm run reviews-service
 ```
 
-In the second one start the bookshop:
+In the second one start the `fiori` app:
 
 ```sh
-npm run bookshop
+npm run fiori
 ```

samples.md

@@ -7,6 +7,7 @@ Each sub directory essentially is an individual npm package arranged in an [all-
 ## [@capire/hello-world](hello)
 
 - 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).
+- [Typescript support](https://cap.cloud.sap/docs/get-started/using-typescript)
 
 
 ## [@capire/bookshop](bookshop)
@@ -63,6 +64,7 @@ Each sub directory essentially is an individual npm package arranged in an [all-
   - Support for [Value Helps](https://cap.cloud.sap/docs/guides/fiori#value-help)
   - Serving SAP Fiori apps locally
 - [The Vue.js app](bookshop/app/vue) imported from bookshop is served as well
+- [OpenAPI export + Swagger UI](https://cap.cloud.sap/docs/advanced/openapi)
 
 <br>
 

test/cds.ql.test.js

@@ -280,7 +280,7 @@ describe('cds.ql → cqn', () => {
       ).to.eql({
         SELECT: {
           from: { ref: ['Foo'] },
-          where: cdr
+          where: cds.version >= '5.3.0'
             ? [
                 // '(', //> this one is not required
                 { ref: ['ID'] },
@@ -289,7 +289,7 @@ describe('cds.ql → cqn', () => {
                 'and',
                 { ref: ['args'] },
                 'in',
-                { val: args },
+                { list: args.map(val => ({ val })) },
                 'and',
                 '(', //> this one is missing, and that's changing the logic -> that's a BUG
                 { ref: ['x'] },

test/custom-handlers.test.js

@@ -6,13 +6,9 @@ else cds.User = cds.User.Privileged // hard core monkey patch for older cds rele
 describe('Custom Handlers', () => {
 
   it('should reject out-of-stock orders', async () => {
-    await expect(
+    await POST('/browse/submitOrder', { book: 201, amount: 5 })
-      Promise.all([
+    await POST('/browse/submitOrder', { book: 201, amount: 5 })
-        POST('/browse/submitOrder', { book: 201, amount: 5 }),
+    await expect(POST('/browse/submitOrder', { book: 201, amount: 5 })).to.be.rejectedWith(/409 - 5 exceeds stock for book #201/)
-        POST('/browse/submitOrder', { book: 201, amount: 5 }),
-        POST('/browse/submitOrder', { book: 201, amount: 5 }),
-      ])
-    ).to.be.rejectedWith(/409 - 5 exceeds stock for book #201/)
     const { data } = await GET`/admin/Books/201/stock/$value`
     expect(data).to.equal(2)
   })

test/hierarchical-data.test.js

@@ -1,11 +1,10 @@
 const {expect} = require('../test')
 const cds = require('@sap/cds/lib')
 
-// monkey patching older releases:
-if (!cds.compile.cdl) cds.compile.cdl = cds.parse
 const { parse:cdr } = cds.ql
 
-const model = cds.compile.cdl (`
+// should become cds.compile(...) when cds5 is released
+const model = cds.compile.to.csn (`
   entity Categories {
     key ID   : Integer;
     name     : String;

test/index.js

@@ -1,6 +1,2 @@
-
+const cds = require('@sap/cds')
-const test = require('@sap/cds/lib/utils/tests').in(__dirname,'..')
+module.exports = cds.test.in(__dirname,'..')
-module.exports = Object.assign(test,{run:test})
-
-// REVISIT: With upcoming release of @sap/cds this should become:
-// module.exports = require('@sap/cds/tests').in(__dirname,'..')

test/localized-data.test.js

@@ -43,7 +43,7 @@ describe('Localized Data', () => {
       { title: 'Jane Eyre', author: 'Charlotte Brontë', currency: { name: 'Pfund' } },
       { title: 'The Raven', author: 'Edgar Allen Poe', currency: { name: 'US-Dollar' } },
       { title: 'Eleonora', author: 'Edgar Allen Poe', currency: { name: 'US-Dollar' } },
-      { title: 'Catweazle', author: 'Richard Carpenter', currency: { name: 'Euro' } },
+      { title: 'Catweazle', author: 'Richard Carpenter', currency: { name: 'Yen' } },
     ])
   })
 
@@ -85,7 +85,7 @@ describe('Localized Data', () => {
       { title: 'Jane Eyre', currency: { name: 'British Pound' } },
       { title: 'The Raven', currency: { name: 'US Dollar' } },
       { title: 'Eleonora',  currency: { name: 'US Dollar' } },
-      { title: 'Catweazle', currency: { name: 'Euro' } },
+      { title: 'Catweazle', currency: { name: 'Yen' } },
     ])
   })
 })

test/messaging.test.js

@@ -20,11 +20,11 @@ describe('Messaging', ()=>{
 
     let N=0, received=[], M=0
     it ('should add messaging event handlers', ()=>{
-        srv.on('reviewed', (msg,next)=> { received.push(msg); return next() })
+        srv.on('reviewed', (msg)=> received.push(msg))
     })
 
     it ('should add more messaging event handlers', ()=>{
-        srv.on('reviewed', (_,next)=> { ++M; return next() })
+        srv.on('reviewed', ()=> ++M)
     })
 
     it ('should add review', async ()=>{