Using ES Modules

* Post TechEd cosmetics

* Update package-lock.json

.vscode/settings.json

@@ -13,13 +13,5 @@
       "**/cds/lib/req/cds-context.js",
       "**/odata-v4/okra/**"
     ]
-  },
-  "eslint.probe": [
-    "cds",
-    "csn",
-    "csv",
-    "csv (semicolon)",
-    "tsv",
-    "tab"
-  ]
+  }
 }

bookshop/app/vue/app.js

@@ -77,7 +77,7 @@ function csrfToken (request) {
         document.csrfToken = token
         request.headers['x-csrf-token'] = document.csrfToken
         return request
-    }).catch(_ => {
+    }).catch(() => {
         document.csrfToken = null // set mark to not try again
         return request
     })

bookshop/db/init.js

@@ -1,3 +1,5 @@
+import cds from '@sap/cds'
+
 /**
  * In order to keep basic bookshop sample as simple as possible, we don't add
  * reuse dependencies. This db/init.js ensures we still have a minimum set of
@@ -6,7 +8,7 @@
 
 // NOTE: We use cds.on('served') to delay the UPSERTs after the db init
 // to run after all INSERTs from .csv files happened.
-module.exports = cds.on('served', ()=> cds.run(
+export default cds.on('served', ()=>
   UPSERT.into ('sap.common.Currencies') .columns (
     [ 'code', 'symbol', 'name' ]
   ) .rows (
@@ -16,4 +18,4 @@ module.exports = cds.on('served', ()=> cds.run(
     [ 'ILS', '₪', 'Shekel' ],
     [ 'JPY', '¥', 'Yen' ],
   )
-))
+)

bookshop/index.js

@@ -1,2 +0,0 @@
-const { CatalogService } = require('./srv/cat-service')
-module.exports = { CatalogService }

bookshop/package.json

@@ -2,6 +2,7 @@
   "name": "@capire/bookshop",
   "version": "1.0.0",
   "description": "A simple self-contained bookshop service.",
+  "type": "module",
   "files": [
     "app",
     "srv",

bookshop/srv/admin-service.js

@@ -1,13 +1,14 @@
-const cds = require('@sap/cds')
+import cds from '@sap/cds'
 
-module.exports = class AdminService extends cds.ApplicationService { init(){
-  this.before ('NEW','Authors', genid)
-  this.before ('NEW','Books', genid)
+export class AdminService extends cds.ApplicationService { init(){
+  this.before (['NEW','CREATE'],'Authors', genid)
+  this.before (['NEW','CREATE'],'Books', genid)
   return super.init()
 }}
 
 /** Generate primary keys for target entity in request */
 async function genid (req) {
+  if (req.data.ID) return
   const {id} = await SELECT.one.from(req.target).columns('max(ID) as id')
-  req.data.ID = id - id % 100 + 100 + 1
+  req.data.ID = id + 4 // Note: that is not safe! ok for this sample only.
 }

bookshop/srv/cat-service.js

@@ -1,5 +1,6 @@
-const cds = require('@sap/cds')
-module.exports = class CatalogService extends cds.ApplicationService { init() {
+import cds from '@sap/cds'
+
+export class CatalogService extends cds.ApplicationService { init() {
 
   const { Books } = cds.entities('sap.capire.bookshop')
   const { ListOfBooks } = this.entities

bookshop/srv/user-service.js

@@ -1,5 +1,5 @@
-const cds = require('@sap/cds')
-module.exports = class UserService extends cds.Service { init(){
+import cds from '@sap/cds'
+export class UserService extends cds.Service { init(){
   this.on('READ', 'me', ({ tenant, user, locale }) => ({ id: user.id, locale, tenant }))
   this.on('login', (req) => {
     if (req.user._is_anonymous)

bookshop/test/genres.http

@@ -3,15 +3,15 @@
 #   Genres
 #
 
-GET http://localhost:4004/test/Genres?
+GET http://localhost:4004/odata/v4/test/Genres?
 ###
 
-GET http://localhost:4004/test/Genres?
+GET http://localhost:4004/odata/v4/test/Genres?
 &$filter=parent_ID eq null&$select=name
 &$expand=children($select=name)
 ###
 
-POST http://localhost:4004/test/Genres?
+POST http://localhost:4004/odata/v4/test/Genres?
 Content-Type: application/json
 
 { "ID":100, "name":"Some Sample Genres...", "children":[
@@ -26,13 +26,13 @@ Content-Type: application/json
 ]}
 ###
 
-GET http://localhost:4004/test/Genres(100)?
+GET http://localhost:4004/odata/v4/test/Genres(100)?
 # &$expand=children
 # &$expand=children($expand=children($expand=children($expand=children)))
 ###
 
-DELETE http://localhost:4004/test/Genres(103)
+DELETE http://localhost:4004/odata/v4/test/Genres(103)
 ###
 
-DELETE http://localhost:4004/test/Genres(100)
+DELETE http://localhost:4004/odata/v4/test/Genres(100)
 ###

bookstore/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@capire/bookstore",
   "version": "1.0.0",
+  "type": "module",
   "dependencies": {
     "@capire/bookshop": "*",
     "@capire/reviews": "*",

bookstore/server.js

@@ -1,7 +1,8 @@
-const cds = require ('@sap/cds')
+import mashup from './srv/mashup.js'
+import cds from '@sap/cds'
 
 // Add mashup logic
-cds.once('served', require('./srv/mashup'))
+cds.once('served', mashup)
 
 // Add routes to UIs from imported packages
 cds.once('bootstrap',(app)=>{
@@ -10,6 +11,3 @@ cds.once('bootstrap',(app)=>{
   app.serve ('/orders') .from('@capire/orders','app/orders')
   app.serve ('/data') .from('@capire/data-viewer','app/viewer')
 })
-
-// Add Swagger UI
-require('./srv/swagger-ui')

bookstore/srv/mashup.js

@@ -1,10 +1,11 @@
+import cds from '@sap/cds'
+
 ////////////////////////////////////////////////////////////////////////////
 //
 //    Mashing up bookshop services with required services...
 //
-module.exports = async()=>{ // called by server.js
+export default async()=>{ // called by server.js
 
-  const cds = require('@sap/cds')
   const CatalogService = await cds.connect.to ('CatalogService')
   const ReviewsService = await cds.connect.to ('ReviewsService')
   const OrdersService = await cds.connect.to ('OrdersService')
@@ -18,7 +19,7 @@ module.exports = async()=>{ // called by server.js
   // Note: prepend is neccessary to intercept generic default handler
   //
   CatalogService.prepend (srv => srv.on ('READ', 'Books/reviews', (req) => {
-    console.debug ('> delegating request to ReviewsService')
+    console.debug ('> delegating request to ReviewsService') // eslint-disable-line no-console
     const [id] = req.params, { columns, limit } = req.query.SELECT
     return ReviewsService.read ('Reviews',columns).limit(limit).where({subject:String(id)})
   }))
@@ -40,7 +41,7 @@ module.exports = async()=>{ // called by server.js
   // Update Books' average ratings when ReviewsService signals updated reviews
   //
   ReviewsService.on ('reviewed', (msg) => {
-    console.debug ('> received:', msg.event, msg.data)
+    console.debug ('> received:', msg.event, msg.data) // eslint-disable-line no-console
     const { subject, count, rating } = msg.data
     return UPDATE(Books,subject).with({ numberOfReviews:count, rating })
   })
@@ -49,7 +50,7 @@ module.exports = async()=>{ // called by server.js
   // Reduce stock of ordered books for orders are created from Orders admin UI
   //
   OrdersService.on ('OrderChanged', (msg) => {
-    console.debug ('> received:', msg.event, msg.data)
+    console.debug ('> received:', msg.event, msg.data) // eslint-disable-line no-console
     const { product, deltaQuantity } = msg.data
     return UPDATE (Books) .where ('ID =', product)
     .and ('stock >=', deltaQuantity)

bookstore/srv/swagger-ui.js

@@ -1,10 +0,0 @@
-
-// -----------------------------------------------------------------------
-// Adding Swagger UI - see https://cap.cloud.sap/docs/advanced/openapi
-const cds = require ('@sap/cds')
-try {
-  const cds_swagger = require ('cds-swagger-ui-express')
-  cds.once ('bootstrap', app => app.use (cds_swagger()) )
-} catch (err) {
-  if (err.code !== 'MODULE_NOT_FOUND')  throw err
-}

bookstore/test/requests.http

@@ -12,11 +12,12 @@
 #
 
 GET {{reviews-service}}/Reviews
+Authorization: Basic me:
 
 ###
 
 POST {{reviews-service}}/Reviews
-Authorization: Basic {{$processEnv USER}}:
+Authorization: Basic me:
 Content-Type: application/json
 
 {"subject":"201", "title":"boo", "rating":3 }
@@ -41,7 +42,7 @@ GET {{bookshop}}/browse/Books(201)?
 ###
 
 GET {{bookshop}}/browse/Books?
-  &$select=title,author&$expand=currency
+&$select=title,author&$expand=currency
 Accept-Language: de
 
 #################################################
@@ -50,23 +51,23 @@ Accept-Language: de
 #
 @newOrderID = e939604c-ab83-4d4f-bdb6-95fe30b3773e
 
-GET {{bookshop}}/orders/Orders
+GET {{bookshop}}/odata/v4/orders/Orders
 
 ### Create order, still inactive
-POST {{bookshop}}/orders/Orders
+POST {{bookshop}}/odata/v4/orders/Orders
 Content-Type: application/json
 
 {"ID": "{{newOrderID}}"}
 
 ### Get inactive order.  We have to specify `IsActiveEntity`.
-GET {{bookshop}}/orders/Orders(ID={{newOrderID}},IsActiveEntity=false)
+GET {{bookshop}}/odata/v4/orders/Orders(ID={{newOrderID}},IsActiveEntity=false)
 
 ### Activate order using `.../<servicename>.draftActivate`
-POST {{bookshop}}/orders/Orders(ID={{newOrderID}},IsActiveEntity=false)/OrdersService.draftActivate
+POST {{bookshop}}/odata/v4/orders/Orders(ID={{newOrderID}},IsActiveEntity=false)/OrdersService.draftActivate
 Content-Type: application/json
 
 ### Get active order
-GET {{bookshop}}/orders/Orders(ID={{newOrderID}},IsActiveEntity=true)
+GET {{bookshop}}/odata/v4/orders/Orders(ID={{newOrderID}},IsActiveEntity=true)
 
 ### Create author
 POST {{bookshop}}/admin/Authors

data-viewer/srv/data-service.js

@@ -18,7 +18,7 @@ class DataService extends cds.ApplicationService { init(){
       .sort((e1, e2) => e1.name.localeCompare(e2.name))
       .map(e => {
         const columns = Object.entries(e.elements)
-          .filter(([_, el]) => !(el instanceof cds.Association)) // exclude assocs+compositions
+          .filter(([,el]) => !(el instanceof cds.Association)) // exclude assocs+compositions
           .map(([name, el]) => { return { name, type: el.type, isKey:!!el.key }})
         return { name: e.name, columns }
       })

eslint.config.js

@@ -1,36 +0,0 @@
-const cds = require('@sap/eslint-plugin-cds')
-const globals = require('globals')
-const js = require('@eslint/js')
-
-module.exports = [
-  cds.configs.recommended,
-  js.configs.recommended,
-  {
-    languageOptions: {
-      globals: {
-        es2022: true,
-        ...globals.browser,
-        ...globals.node,
-        ...globals.jest,
-        ...globals.mocha,
-        cds: true,
-        sap: true,
-        CDL: true,
-        CQL: true,
-        CREATE: true,
-        DELETE: true,
-        DROP: true,
-        INSERT: true,
-        SELECT: true,
-        UPDATE: true,
-        UPSERT: true
-      }
-    },
-    rules: {
-      'no-console': 'off',
-      'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
-      'require-atomic-updates': 'off',
-      'require-await': 'warn'
-    }
-  }
-]

eslint.config.mjs

@@ -0,0 +1,20 @@
+import cds from '@sap/cds/eslint.config.mjs'
+export default [ ...cds.recommended ]
+
+//
+// The above is the recommended minimalistic eslint config, just using
+// recommended defaults provided by cds. Alternatively, go for enhanced
+// project-specific options, but only if really required, like this:
+//
+// export default [ ...cds.recommended, {
+//   rules: {
+//     'complexity': [ 'warn', 66 ],
+//     'require-await': 'warn',
+//     'no-await-in-loop': 'warn',
+//   },
+// }, {
+//   ignores: [
+//     '**/webapp/**'
+//   ]
+// }]
+//

hello/package.json

@@ -1,42 +1,13 @@
 {
   "name": "@capire/hello-world",
   "version": "1.0.0",
+  "type": "module",
   "scripts": {
     "test": "npx jest --silent",
-    "start": "cds serve srv/world.cds",
+    "start": "cds-serve srv/world.cds",
     "start:ts": "cds-ts serve srv/world.cds"
   },
   "dependencies": {
     "@sap/cds": ">=5.0.4"
-  },
-  "devDependencies": {
-    "@types/jest": "*",
-    "@types/node": "*",
-    "typescript": ">=4.3.5"
-  },
-  "eslintConfig": {
-    "extends": "eslint:recommended",
-    "env": {
-      "es2020": true,
-      "node": true,
-      "jest": true,
-      "mocha": true
-    },
-    "globals": {
-      "SELECT": true,
-      "INSERT": true,
-      "UPDATE": true,
-      "DELETE": true,
-      "CREATE": true,
-      "DROP": true,
-      "CDL": true,
-      "CQL": true,
-      "CXL": true,
-      "cds": true
-    },
-    "rules": {
-      "no-console": "off",
-      "require-atomic-updates": "off"
-    }
   }
 }

hello/srv/world.cds

@@ -1,3 +1,3 @@
-service say @(path: '/say') {
+service say {
   function hello (to:String) returns String;
-}
+}

hello/srv/world.js

@@ -1,7 +1,6 @@
-module.exports = class say {
-  hello(req) {
-    let {to} = req.data
-    if (to === 'me') to = require('os').userInfo().username
+import cds from '@sap/cds'
+export class say extends cds.ApplicationService {
+  hello (to = 'World') {
     return `Hello ${to}!`
   }
 }

hello/srv/world.ts

@@ -1,7 +1,6 @@
-import { Request } from "@sap/cds"
-
-module.exports = class say {
-    hello(req: Request) {
-        return `Hello ${req.data.to} from a TypeScript file!`
-    }
+import cds from '@sap/cds'
+export class say extends cds.ApplicationService {
+  hello (to : String = 'World') {
+    return `Hello ${to} from TypeScript!`
+  }
 }

hello/test/hello-world-test.js

@@ -1,10 +0,0 @@
-const cds = require ('@sap/cds')
-describe('Hello world!', () => {
-    const {GET} = cds.test.in(__dirname,'../srv').run('serve', 'world.cds')
-
-    it('should say hello with class impl', async () => {
-        const {data} = await GET`/say/hello(to='world')`
-        expect(data.value).to.match(/Hello world.*typescript.*/i)
-    })
-
-})

hello/test/test.http

@@ -1 +1,5 @@
-GET http://localhost:4004/say/hello(to='world')
+GET http://localhost:4004/odata/v4/say/hello
+###
+
+GET http://localhost:4004/odata/v4/say/hello(to='me')
+###

loggers/package.json

@@ -13,10 +13,5 @@
   "scripts": {
     "start": "cds-serve",
     "watch": "cds watch"
-  },
-  "cds": {
-    "requires": {
-      "db": "sql"
-    }
   }
 }

orders/srv/orders-service.js

@@ -29,7 +29,7 @@ class OrdersService extends cds.ApplicationService {
   /** order changed -> broadcast event */
   orderChanged (product, deltaQuantity) {
     // Emit events to inform subscribers about changes in orders
-    console.log ('> emitting:', 'OrderChanged', { product, deltaQuantity })
+    console.log ('> emitting:', 'OrderChanged', { product, deltaQuantity }) // eslint-disable-line no-console
     return this.emit ('OrderChanged', { product, deltaQuantity })
   }
 

package.json

@@ -1,11 +1,11 @@
 {
     "name": "@capire/samples",
-    "version": "2.0.0",
+    "version": "2.1.0",
     "description": "A monorepo with several samples for CAP.",
     "repository": "https://github.com/sap-samples/cloud-cap-samples.git",
     "author": "daniel.hutzel@sap.com",
     "dependencies": {
-      "@sap/cds": ">=7"
+      "@sap/cds": ">=8"
     },
     "workspaces": [
       "./bookshop",
@@ -21,7 +21,6 @@
     ],
     "devDependencies": {
       "@cap-js/sqlite": "^1",
-      "@sap/eslint-plugin-cds": "^3",
       "axios": "^1",
       "chai": "^4.3.4",
       "chai-as-promised": "^7.1.1",
@@ -30,23 +29,16 @@
       "semver": "^7"
     },
     "scripts": {
-      "cleanup": "rm -rf node_modules && rm -rf */node_modules && rm -rf */*/node_modules",
       "bookshop": "cds watch bookshop",
+      "start": "cds watch fiori",
       "fiori": "cds watch fiori",
       "hello": "cds watch hello",
       "media": "cds watch media",
-      "mocha": "CDS_TEST_SILENT=y npx mocha",
+      "lint": "eslint",
+      "test": "npx jest --silent",
       "jest": "npx jest --silent",
-      "start": "cds watch fiori",
-      "test": "npm run jest -- --silent",
-      "test:hello": "cd hello && npm test",
-      "lint": "eslint ."
-    },
-    "jest": {
-      "testTimeout": 20000,
-      "testMatch": [
-        "**/*.test.js"
-      ]
+      "mocha": "CDS_TEST_SILENT=y npx mocha",
+      "test:hello": "cd hello && npm test"
     },
     "mocha": {
       "recursive": true,
@@ -55,4 +47,4 @@
     },
     "license": "SEE LICENSE IN LICENSE",
     "private": true
-  }
+  }

reviews/app/vue/app.js

@@ -50,7 +50,6 @@ const reviews = Vue.createApp ({
                     const res = await POST(`/Reviews`,review)
                     reviews.ID = res.data.ID
                 } else {
-                    console.trace()
                     await PUT(`/Reviews/${review.ID}`,review)
                 }
                 reviews.message = { succeeded: 'Your review was submitted successfully. Thanks.' }

reviews/srv/reviews-service.js

@@ -15,7 +15,7 @@ module.exports = cds.service.impl (function(){
     const { count, rating } = await cds.tx(req) .run (
       SELECT.one `round(avg(rating),2) as rating, count(*) as count` .from (Reviews) .where ({subject})
     )
-    global.it || console.log ('< emitting:', 'reviewed', { subject, count, rating })
+    global.it || console.log ('< emitting:', 'reviewed', { subject, count, rating }) // eslint-disable-line no-console
     await this.emit ('reviewed', { subject, count, rating })
   })
 

test/cds.ql.test.js

@@ -677,7 +677,7 @@ describe('cds.ql → cqn', () => {
         .to.eql(INSERT.into(Foo).entries(...entries))
         .to.eql(INSERT.into(Foo).entries(entries))
         .to.eql({
-          INSERT: { into: cds.env.ql.quirks_mode ? 'Foo' : { ref: ['Foo'] }, entries },
+          INSERT: { into: { ref: ['Foo'] }, entries },
         })
     })
 
@@ -693,7 +693,7 @@ describe('cds.ql → cqn', () => {
         .to.eql(INSERT.into(Foo).columns('a', 'b').rows([1, 2], [3, 4]))
         .to.eql({
           INSERT: {
-            into: cds.env.ql.quirks_mode ? 'Foo' : { ref: ['Foo'] },
+            into: { ref: ['Foo'] },
             columns: ['a', 'b'],
             rows: [
               [1, 2],
@@ -707,7 +707,7 @@ describe('cds.ql → cqn', () => {
       expect(INSERT.into(Foo).columns('a', 'b').values([1, 2]))
         .to.eql(INSERT.into(Foo).columns('a', 'b').values(1, 2))
         .to.eql({
-          INSERT: { into:  cds.env.ql.quirks_mode ? 'Foo' : { ref: ['Foo'] }, columns: ['a', 'b'], values: [1, 2] },
+          INSERT: { into:  { ref: ['Foo'] }, columns: ['a', 'b'], values: [1, 2] },
         })
     })
 
@@ -722,7 +722,7 @@ describe('cds.ql → cqn', () => {
     test('entity (..., <key>)', () => {
       const cqnWhere = {
           UPDATE: {
-            entity: cds.env.ql.quirks_mode ? 'capire.bookshop.Books' : { ref: ['capire.bookshop.Books'] },
+            entity: { ref: ['capire.bookshop.Books'] },
             where: [{ ref: ['ID'] }, '=', { val: 4711 }],
           },
         }
@@ -766,7 +766,7 @@ describe('cds.ql → cqn', () => {
         .to.eql(UPDATE(Foo).with({ foo: 11, bar: { '-=': 22 } }))
         .to.eql({
           UPDATE: {
-            entity: cds.env.ql.quirks_mode ? 'Foo' : { ref: ['Foo'] },
+            entity: { ref: ['Foo'] },
             data: { foo: 11 },
             with: {
               bar: { xpr: [{ ref: ['bar'] }, '-', { val: 22 }] },
@@ -777,7 +777,7 @@ describe('cds.ql → cqn', () => {
       // some more
       expect(UPDATE(Foo).with(`bar = coalesce(x,y), car = 'foo''s bar, car'`)).to.eql({
         UPDATE: {
-          entity: cds.env.ql.quirks_mode ? 'Foo' : { ref: ['Foo'] },
+          entity: { ref: ['Foo'] },
           data: {
             car: "foo's bar, car",
           },
@@ -797,7 +797,7 @@ describe('cds.ql → cqn', () => {
     test('from (..., <key>)', () => {
       const cqnWhere = {
           DELETE: {
-            from: cds.env.ql.quirks_mode ? 'capire.bookshop.Books' : { ref: ['capire.bookshop.Books'] },
+            from: { ref: ['capire.bookshop.Books'] },
             where: [{ ref: ['ID'] }, '=', { val: 4711 }],
           },
         }

test/hello-world.test.js

@@ -5,7 +5,7 @@ describe('cap/samples - Hello world!', () => {
   const { GET, expect } = cds.test (__dirname+'/../hello')
 
   it('should say hello with class impl', async () => {
-    const {data} = await GET `/say/hello(to='world')`
+    const {data} = await GET `/odata/v4/say/hello(to='world')`
     expect(data.value).to.eql('Hello world!')
   })