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/

fiori/app/admin/fiori-service.cds

@@ -1,4 +1,4 @@
-using { AdminService } from '../../db/schema';
+using { AdminService, sap.capire.bookshop } from '../../db/schema';
 
 ////////////////////////////////////////////////////////////////////////////
 //
@@ -86,8 +86,9 @@ annotate AdminService.Books.texts with @(
 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/package.json

@@ -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/srv/mashup.cds

@@ -19,7 +19,7 @@ extend Books with {
 //  Extend Orders with Books as Products
 //
 
-using { sap.capire.orders.Orders } from '@capire/orders';
-extend Orders.Items with {
+using { sap.capire.orders.Orders_Items } from '@capire/orders';
+extend Orders_Items with {
   book : Association to Books on product.ID = book.ID
 }

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/.env

@@ -1,3 +1,2 @@
 cds.requires.messaging.kind = file-based-messaging
 PORT = 4006
-# cds.odata.flavor = x4

orders/app/orders/fiori-service.cds

@@ -11,7 +11,6 @@
 
 
 using { OrdersService } from '../../srv/orders-service';
-using { sap.common } from '@capire/common';
 
 
 @odata.draft.enabled
@@ -69,7 +68,7 @@ annotate OrdersService.Orders with @(
 
 
 
-annotate OrdersService.Orders.Items with @(
+annotate OrdersService.Orders_Items with @(
 	UI: {
 		LineItem: [
 			{Value: product_ID, Label:'Product ID'},
@@ -78,22 +77,13 @@ annotate OrdersService.Orders.Items with @(
 			{Value: amount, Label:'Quantity'},
 		],
 		Identification: [ //Is the main field group
-			{Value: product_ID, Label:'Product ID'},
-			{Value: title, Label:'Product Title'},
 			{Value: amount, Label:'Amount'},
+			{Value: title, Label:'Product'},
 			{Value: price, Label:'Unit Price'},
 		],
 		Facets: [
 			{$Type: 'UI.ReferenceFacet', Label: '{i18n>OrderItems}', Target: '@UI.Identification'},
 		],
-		HeaderInfo: {
-			TypeName: 'Order Item', TypeNamePlural: 'Order Items',
-			Title: {
-				Label: 'Product ID ', //A label is possible but it is not considered on the ObjectPage yet
-				Value: product_ID
-			},
-			Description: {Value: createdBy}
-		},
 	},
 ) {
 	amount @(

orders/db/schema.cds

@@ -3,17 +3,17 @@ namespace sap.capire.orders;
 
 entity Orders : cuid, managed {
   OrderNo  : String @title:'Order Number'; //> readable key
-  Items    : Composition of many Orders.Items on Items.up_ = $self;
+  Items    : Composition of many Orders_Items on Items.up_ = $self;
   buyer    : User;
   currency : Currency;
 }
 
-entity Orders.Items {
-  /*key*/ up_   : Association to Orders; // REVISIT: 'key' doesn't work due to bug in runtime
+entity Orders_Items {
   key ID    : UUID;
-  product   : Association to Products;
+  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; //> intentionally replicated as snapshot from product.title or alike
+  title     : String; //> intentionally replicated as snapshot from product.title
   price     : Double;
 }
 

orders/package.json

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

orders/requests.http

@@ -1,31 +0,0 @@
-
-@Orders = http://localhost:4006/orders/Orders
-
-
-### Read Orders
-GET {{Orders}}?
-###
-GET {{Orders}}?$expand=Items
-###
-GET {{Orders}}(ID={{Order1}},IsActiveEntity=true)/Items
-
-
-
-@Order1 = 64e718c9-ff99-47f1-8ca3-950c850777d4
-@Order3 = e939604c-ab83-4d4f-bdb6-95fe30b3773e
-
-### Create order, still inactive
-POST {{Orders}}
-Content-Type: application/json
-
-{"ID": "{{Order3}}"}
-
-### Get inactive order.  We have to specify `IsActiveEntity`.
-GET {{Orders}}(ID={{Order3}},IsActiveEntity=false)
-
-### Activate order using `.../<servicename>.draftActivate`
-POST {{Orders}}(ID={{Order3}},IsActiveEntity=false)/OrdersService.draftActivate
-Content-Type: application/json
-
-### Get active order
-GET {{Orders}}(ID={{Order3}},IsActiveEntity=true)

orders/srv/orders-service.js

@@ -3,7 +3,7 @@ class OrdersService extends cds.ApplicationService {
 
   /** register custom handlers */
   init(){
-    const { 'Orders.Items':OrderItems } = this.entities
+    const { Orders_Items:OrderItems } = this.entities
 
     this.before ('UPDATE', 'Orders', async function(req) {
       const { ID, Items } = req.data

package.json

@@ -11,9 +11,12 @@
     "@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",
@@ -26,15 +29,17 @@
     "fiori": "cds watch fiori",
     "media": "cds watch media",
     "mocha": "npx mocha || echo",
-    "jest": "npx jest@^26",
-    "test": "npm run jest --silent"
+    "jest": "npx jest",
+    "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
 }

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>