@sap/cds 7.2.0 → 7.3.0

package/README.md

@@ -2,7 +2,7 @@
 
 The API package for the [SAP Cloud Application Programming Model (CAP)](https://cap.cloud.sap).
 
-See the [API documentation](https://cap.cloud.sap/docs/node.js/api) for more details.
+See the [API documentation](https://cap.cloud.sap/docs/node.js) for more details.
 
 ## How to Obtain Support
 

package/apis/connect.d.ts

@@ -18,7 +18,7 @@ declare class cds {
 
 		/**
 		 * Connects the primary datasource.
-		 * @see [capire](https://cap.cloud.sap/docs/node.js/api#cds-connect)
+		 * @see [capire](https://cap.cloud.sap/docs/node.js/cds-connect)
 		 */
 		(options?: string | ConnectOptions) : Promise<typeof cds>  //> cds.connect(<options>)
 	}

package/apis/core.d.ts

@@ -3,6 +3,9 @@ import { ReflectedModel, LinkedModel } from './reflect'
 import { CSN as csn, Definition } from './csn'
 
 type UserInput = string | { id: string; attr: Record<string, string>; roles: Record<string, string> } | User
+type Intersect<T extends readonly unknown[]> = T extends [infer Head, ...infer Tail]
+  ? Head & Intersect<Tail>
+  : unknown
 
 export type Association = Definition
 export type Composition = Association
@@ -26,8 +29,9 @@ export class User {
    * @deprecated Use https://cap.cloud.sap/docs/node.js/events#tenant instead
    */
   tenant: string | undefined
+
   attr: Record<string, string>
-  roles: Record<string, string>
+  roles: Array<string> | Record<string, string>
   static Privileged: typeof Privileged
   is(role: string): boolean
 }
@@ -112,9 +116,7 @@ declare class cds {
    *    }.prototype)
    */
   extend<T>(target: T): {
-    with<X, Y, Z>(x: X, y: Y, z: Z): T & X & Y & Z
-    with<X, Y>(x: X, y: Y): T & X & Y
-    with<X>(x: X): T & X
+    with<E extends readonly unknown[]>(...ext: E): T & Intersect<E>
   }
 
   /**

package/apis/serve.d.ts

@@ -27,7 +27,7 @@ declare class cds_serve {
 
 	/**
 	 * Constructs service providers from respective service definitions
-	 * @see [capire](https://cap.cloud.sap/docs/node.js/api#cds-serve)
+	 * @see [capire](https://cap.cloud.sap/docs/node.js/cds-serve)
 	 */
 	serve (service : string, options?: service_options) : _fluent & Promise<cds_services>
 

package/apis/services.d.ts

@@ -13,7 +13,7 @@ export class QueryAPI {
   entities : LinkedModel['entities']
 
   /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
    */
   read: {
     <T extends ArrayConstructable<any>>(entity: T, key?: any): Awaitable<SELECT<T>, InstanceType<T>>
@@ -21,7 +21,7 @@ export class QueryAPI {
   }
 
   /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
    */
   create: {
     <T extends ArrayConstructable<any>>(entity: T, key?: any): INSERT<T>
@@ -29,7 +29,7 @@ export class QueryAPI {
   }
 
   /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
    */
   insert: {
     <T extends ArrayConstructable<any>>(data: T): INSERT<T>
@@ -37,7 +37,7 @@ export class QueryAPI {
   }
 
   /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
    */
   upsert: {
     <T extends ArrayConstructable<any>>(data: T): UPSERT<T>
@@ -45,7 +45,7 @@ export class QueryAPI {
   }
 
   /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
    */
   update: {
     <T extends ArrayConstructable<any>>(entity: T, key?: any): UPDATE<T>
@@ -53,7 +53,7 @@ export class QueryAPI {
   }
 
   /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
    */
   run: {
     (query: ConstructedQuery | ConstructedQuery[]): Promise<ResultSet | any>
@@ -62,17 +62,17 @@ export class QueryAPI {
   }
 
   /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/cds-facade?q=cds.delete)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
    */
   delete<T>(entity: Definition | string, key?: any): DELETE<T>
 
   /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-run)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#srv-foreach-entity)
    */
   foreach(query: Query, callback: (row: object) => void): this
 
   /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-stream)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#srv-stream-column)
    */
   stream: {
     (column: string): {
@@ -85,18 +85,28 @@ export class QueryAPI {
 
   /**
    * Starts or joins a transaction
-   * @see [docs](https://cap.cloud.sap/docs/node.js/services#srv-tx)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/cds-tx)
    */
-  tx(context?: object): Transaction
-  transaction(context?: object): Transaction
+
+  tx: {
+    (fn: (tx: Transaction) => {}): Promise<unknown>
+    (context?: object): Transaction
+    (context: object, fn: (tx: Transaction) => {}): Promise<unknown>
+  }
+  
+  transaction: {
+    (fn: (tx: Transaction) => {}): Promise<unknown>
+    (context?: object): Transaction
+    (context: object, fn: (tx: Transaction) => {}): Promise<unknown>
+  }
 
   /**
-   * @see [docs](https://pages.github.tools.sap/cap/docs/node.js/cds-context-tx?q=spawn#cds-spawn)
+   * @see [docs](https://cap.cloud.sap/docs/node.js/cds-tx#cds-spawn)
    */
   spawn(options: Options, fn: (tx: Transaction) => {}): SpawnEventEmitter
 
   /**
-   * @see [docs](https://pages.github.tools.sap/cap/docs/node.js/cds-context-tx?q=cds.context#cds-context
+   * @see [docs](https://cap.cloud.sap/docs/node.js/cds-tx#event-contexts
    */
   context:  ContextProperties
 }
@@ -110,7 +120,7 @@ type ContextProperties = {
 
 /**
  * Class cds.Service
- * @see [capire docs](https://cap.cloud.sap/docs/node.js/services)
+ * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
  */
 export class Service extends QueryAPI {
   constructor(
@@ -129,44 +139,44 @@ export class Service extends QueryAPI {
 
   /**
    * The model from which the service's definition was loaded
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-reflect)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
    */
   model: LinkedModel
 
   /**
    * Provides access to the entities exposed by a service
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-reflect)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
    */
   entities: Definitions & ((namespace: string) => Definitions)
 
   /**
    * Provides access to the events declared by a service
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-reflect)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
    */
   events: Definitions & ((namespace: string) => Definitions)
 
   /**
    * Provides access to the types exposed by a service
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-reflect)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
    */
   types: Definitions & ((namespace: string) => Definitions)
 
   /**
    * Provides access to the operations, i.e. actions and functions, exposed by a service
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-reflect)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
    */
   operations: Definitions & ((namespace: string) => Definitions)
 
   /**
    * Acts like a parameter-less constructor. Ensure to call `await super.init()` to have the base class’s handlers added.
    * You may register own handlers before the base class’s ones, to intercept requests before the default handlers snap in.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#cds-service-subclasses)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#srv-init)
    */
   init(): Promise<void>
 
   /**
    * Constructs and emits an asynchronous event.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-emit)
+   * @see [capire docs](https://cap.cloud.sap/docs/core-services#srv-emit-event)
    */
   emit: {
     <T = any>(details: { event: EventArg; data?: object; headers?: object }): Promise<T>
@@ -175,7 +185,7 @@ export class Service extends QueryAPI {
 
   /**
    * Constructs and sends a synchronous request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srvsend--method-path-data-headers--results-)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#srv-send-request)
    */
   send: {
     <T = any>(event: EventArg, path: string, data?: object, headers?: object): Promise<T>
@@ -188,22 +198,22 @@ export class Service extends QueryAPI {
 
   /**
    * Constructs and sends a GET request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#rest-style-api)
    */
   get<T = any>(entityOrPath: Target, data?: object): Promise<T>
   /**
    * Constructs and sends a POST request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#rest-style-api)
    */
   post<T = any>(entityOrPath: Target, data?: object): Promise<T>
   /**
    * Constructs and sends a PUT request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#rest-style-api)
    */
   put<T = any>(entityOrPath: Target, data?: object): Promise<T>
   /**
    * Constructs and sends a PATCH request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services#srv-send)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#rest-style-api)
    */
   patch<T = any>(entityOrPath: Target, data?: object): Promise<T>
   /**
@@ -221,8 +231,8 @@ export class Service extends QueryAPI {
   // Provider API
   prepend(fn: ServiceImpl): Promise<this>
   on<T extends Constructable>(eve: EventArg, entity: T, handler: CRUDEventHandler.On<InstanceType<T>, InstanceType<T> | void | Error>): this
-  on<P,R>(boundAction: (args: P) => R, service: string, handler: ActionEventHandler<P, void | Error | R>): this
-  on<P,R>(action: (args: P) => R, handler: ActionEventHandler<P, void | Error | R>): this
+  on<F extends CdsFunction>(boundAction: F, service: string, handler: ActionEventHandler<F['__parameters'], void | Error | F['__returns']>): this
+  on<F extends CdsFunction>(unboundAction: F, handler: ActionEventHandler<F['__parameters'], void | Error | F['__returns']>): this
   on(eve: EventArg, entity: Target, handler: OnEventHandler): this
   on(eve: EventArg, handler: OnEventHandler): this
 
@@ -259,7 +269,7 @@ export interface ResultSet extends Array<{}> {}
 
 declare class cds {
   /**
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/services)
+   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
    */
   Service: typeof Service
   Request: typeof Request
@@ -312,9 +322,19 @@ type Partial<T> = { [Key in keyof T]: undefined | T[Key] }
 // So we always have to expect scalars as well as arrays in some callbacks.
 type OneOrMany<T> = T | T[];
 
+// functions generated by cds-typer explicitly carry types for
+// parameters and return type, as their names are not accessible from
+// function signatures to the type system.
+// This meta information is required in .on action handlers.
+type CdsFunction = {
+  (...args: any[]): any,
+  __parameters: object,
+  __returns: unknown
+}
+
 type TypedRequest<T> = Omit<Request, 'data'> & { data: T }
 
-// https://cap.cloud.sap/docs/node.js/services#event-handlers
+// https://cap.cloud.sap/docs/node.js/core-services#srv-on-before-after
 export namespace CRUDEventHandler {
   type Before<P,R> = (req: TypedRequest<P>) => Promise<R> | R
   type On<P,R> = (req: TypedRequest<P>, next: (...args: any) => Promise<R> | R) => Promise<R> | R

package/apis/test.d.ts

@@ -24,13 +24,17 @@ declare class Axios {
 declare class DataUtil {
   delete(db?: Service): Promise<void>;
   reset(db?: Service): Promise<void>;
-  autoReset(enabled: boolean): this;
+  /** @deprecated */ autoReset(enabled: boolean): this;
 }
 
 declare class Test extends Axios {
+
+  test : Test
+
   run(cmd: string, ...args: string[]): this;
   in(...paths: string[]): this;
-  verbose(v: boolean): this;
+  silent(): this;
+  /** @deprecated */ verbose(v: boolean): this;
 
   get chai(): typeof chai;
   get expect(): typeof chai.expect;
@@ -38,6 +42,12 @@ declare class Test extends Axios {
   get data(): DataUtil;
   get cds(): typeof import('./cds').default;
 
+  log() : {
+    output: string
+    clear(): void
+    release(): void
+  }
+
   then(r: (args: { server: http.Server, url: string }) => void): void;
 
   // get sleep(): (ms: number) => Promise<void>;
@@ -56,12 +66,16 @@ declare class Test extends Axios {
 export = cds
 
 declare class cds {
-  /**
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-test?q=cds.test#run)
-   */
-  test(projectDir: string): Test;
-  /**
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-test?q=cds.test#run-2)
-   */
-  test(command: string, ...args: string[]): Test;
+  test: {
+    Test: typeof Test
+    /**
+     * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-test?q=cds.test#run)
+     */
+    (projectDir: string): Test;
+    /**
+     * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-test?q=cds.test#run-2)
+     */
+    (command: string, ...args: string[]): Test;
+    in (string) : Test
+  }
 }

package/bin/serve.js

@@ -128,6 +128,7 @@ module.exports = Object.assign ( serve, {
 
 
 const cds = require('../lib'), { exists, isfile, local, path } = cds.utils
+const COLORS = !!process.stdout.isTTY && !!process.stderr.isTTY && !process.env.NO_COLOR
 
 // provisional loggers, see _prepare_logging
 let log = console.log
@@ -201,7 +202,7 @@ async function serve (all=[], o={}) {
       _warn_if_cds_was_loaded_from_different_locations()
       const url = cds.server.url = `http://localhost:${server.address().port}`
       cds.emit ('listening', {server,url}) //> inform local listeners
-      _resolve (server)
+      _resolve ({ server, url })
     }
 
     const LOG = cds.log('cli|server')
@@ -256,9 +257,9 @@ function _prepare_logging () { // NOSONAR
 
   // print information when model is loaded
   cds.on ('loaded', (model)=>{
-    LOG.info (`loaded model from ${model.$sources.length} file(s):\n\x1b[2m`)
+    LOG.info (`loaded model from ${model.$sources.length} file(s):\n${COLORS ? '\x1b[2m' : ''}`)
     for (let each of model.$sources)  console.log (' ', local(each))
-    console.log ('\x1b[0m')
+    COLORS && console.log ('\x1b[0m')
   })
 
   // print information about each connected service

package/common.cds

@@ -35,7 +35,7 @@ context sap.common {
   /**
    * Code list for languages
    *
-   * See https://cap.cloud.sap/docs/cds/common#entity-sapcommonlanguages
+   * See https://cap.cloud.sap/docs/cds/common#entity-languages
    */
   entity Languages : CodeList {
     key code : Locale;
@@ -44,7 +44,7 @@ context sap.common {
   /**
    * Code list for countries
    *
-   * See https://cap.cloud.sap/docs/cds/common#entity-sapcommoncountries
+   * See https://cap.cloud.sap/docs/cds/common#entity-countries
    */
   entity Countries : CodeList {
     key code : String(3) @(title : '{i18n>CountryCode}');
@@ -53,7 +53,7 @@ context sap.common {
   /**
    * Code list for currencies
    *
-   * See https://cap.cloud.sap/docs/cds/common#entity-sapcommoncurrencies
+   * See https://cap.cloud.sap/docs/cds/common#entity-currencies
    */
   entity Currencies : CodeList {
     key code      : String(3) @(title : '{i18n>CurrencyCode}');
@@ -64,7 +64,7 @@ context sap.common {
   /**
    * Aspect for a code list with name and description
    *
-   * See https://cap.cloud.sap/docs/cds/common#aspect-sapcommoncodelist
+   * See https://cap.cloud.sap/docs/cds/common#aspect-codelist
    */
   aspect CodeList @(
     cds.autoexpose,

package/lib/auth/ias-auth.js

@@ -41,15 +41,14 @@ module.exports = function ias_auth(config) {
     .use((req, res, next) => {
       if (!('authInfo' in req)) return next()
 
-      if (req.tokenInfo.getClientId() === req.tokenInfo.getSubject()) //> grant_type === client_credentials or x509
-        req.user = new cds.User({
-          id: 'system',
-          roles: ['authenticated-user', 'system-user'],
-          attr: {}
-        })
-      else {
+      const payload = req.tokenInfo.getPayload()
+      if (req.tokenInfo.getClientId() === req.tokenInfo.getSubject()) {
+        //> grant_type === client_credentials or x509
+        const roles = ['authenticated-user', 'system-user']
+        if (payload.azp === config.credentials.clientid) roles.push('internal-user')
+        req.user = new cds.User({ id: 'system', roles, attr: {} })
+      } else {
         // add all unknown attributes to req.user.attr in order to keep public API small
-        const payload = req.tokenInfo.getPayload()
         const attributes = Object.keys(payload)
           .filter(k => !RESERVED_ATTRIBUTES.has(k))
           .reduce((attrs, k) => { attrs[k] = payload[k]; return attrs }, {})

package/lib/compile/cdsc.js

@@ -1,8 +1,4 @@
 const cds = require ('../index')
-const {cdsc,odata,sql,features} = cds.env
-const constraints = {
-  assertIntegrity: features.assert_integrity
-}
 const compile = require ('@sap/cds-compiler')
 const _4cdsc = Symbol('_4cdsc')
 
@@ -24,7 +20,7 @@ function _options4 (src, ...mappings) {
   // Optionally add .messages array to avoid compiler writing messages to stderr
   dst.messages = dst.messages || []
   // Finally override with options from cds.env.cdsc
-  return Object.assign(dst,cdsc)
+  return Object.assign(dst,cds.env.cdsc)
 }
 
 
@@ -38,6 +34,7 @@ function _options4 (src, ...mappings) {
 const _options = {for: Object.assign (_options4, {
 
   odata(o,_more) {
+    const odata = cds.env.odata
     if (o && o[_4cdsc]) return o
     let f = o && o.flavor || odata.flavor || o, flavor = odata.flavors && odata.flavors[f] || {}
     let v = o && o.version || flavor.version || odata.version   //> env.odata.flavors.version overrides env.odata.version!
@@ -66,8 +63,9 @@ const _options = {for: Object.assign (_options4, {
 
   sql(o,_env) {
     // REVISIT: compiler requires to only provide assertIntegrityType if defined
-    if(constraints.assertIntegrity) constraints.assertIntegrityType = features.assert_integrity_type
-    return _options4 ({ ...constraints, ..._env||sql, ...o }, {
+    let assertIntegrity = cds.env.features.assert_integrity
+    let constraints = assertIntegrity && { assertIntegrityType: cds.env.features.assert_integrity_type }
+    return _options4 ({ ...constraints, ..._env||cds.env.sql, ...o }, {
       sql_mapping  : 'names', //> legacy
       sqlDialect   : 'dialect', //> legacy
       sqlMapping   : 'names',

package/lib/compile/etc/csv.js

@@ -12,12 +12,19 @@ function read (res) {
 function parse (csv) {
   if (csv[0] === BOM)  csv = csv.slice(1)
   let sep
-  const lines = csv.split(/\s*\n/)
+  const lines = csv.split('\n')
   const rows = [], headers = []
-  for (let line of lines) {
+
+  let val, values=[]
+  let inString=false, quoted=false
+  for (let l = 0; l < lines.length; l++) {
+    const line = lines[l]
     if (!rows.length && _ignoreLine (line))  continue
     if (!sep)  [sep] = SEPARATOR.exec(line)||[';']
-    const values=[]; let val, currCol=0, c, inString=false, quoted=false
+    if (inString)  val += '\n' // overflow from last line
+    else val = undefined
+
+    let currCol=0, c
     for (let i=0; i<line.length; ) {
       c = line[i++]
       if (c === sep && !inString) {  // separator
@@ -39,19 +46,23 @@ function parse (csv) {
         val += c === '\\' ? '\\\\' : c
       }
     }
-    // remaining value
-    currCol++
-    if (!rows.length && val !== undefined)  headers.push(currCol)  // skip column if header value is empty
-    if ((val !== undefined || c === sep) && headers.includes(currCol))  values.push (_value4(val, quoted))
-    if (values.length > 0)  rows.push (values)
+
+    // finish line w/ remaining value
+    if (!inString || l === lines.length-1 ) { // unless unterminated string and more lines to come
+      currCol++
+      if (!rows.length && val !== undefined)  headers.push(currCol)  // skip column if header value is empty
+      if ((val !== undefined || c === sep) && headers.includes(currCol))  values.push (_value4(val, quoted))
+      if (values.length > 0)  { rows.push (values); values = [] }
+    }
   }
   return rows
 }
 
-function _value4 (val, quoted = false) { //NOSONAR
+function _value4 (val, quoted = false) {
+  if (quoted)  return val
   if (val)  val = val.trim()
-  if (!quoted && val === 'true') return true
-  if (!quoted && val === 'false') return false
+  if (val === 'true') return true
+  else if (val === 'false') return false
   else return val
 }
 

package/lib/dbs/cds-deploy.js

@@ -3,7 +3,7 @@ const cds = require('../index'), { local } = cds.utils
 const COLORS = !!process.stdout.isTTY && !!process.stderr.isTTY && !process.env.NO_COLOR
 const GREY = COLORS ? '\x1b[2m' : ''
 const RESET = COLORS ? '\x1b[0m' : ''
-let DEBUG // IMPORTANT: initialized later after await cds.plugins
+const DEBUG = cds.debug('deploy')
 
 /**
  * Implementation of `cds.deploy` common to all databases.
@@ -12,7 +12,6 @@ let DEBUG // IMPORTANT: initialized later after await cds.plugins
  * in initial data, if present.
  */
 module.exports = exports = function cds_deploy (model,options,csvs) {
-  DEBUG = cds.debug('deploy')
   return {
     /** @param {import('@sap/cds/lib/srv/srv-api')} db */
     async to(db, o = options || {}) {