@sap/cds 7.1.1 → 7.2.0

package/CHANGELOG.md

@@ -4,19 +4,67 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 7.2.0 - 2023-09-04
+
+### Added
+
+- Typescript definition for:
+  - The `cds.exit()` method.
+  - The `label` option parameter in the `cds.log()` API. For example: `cds.log('log message', { label: 'adapter' }`.
+- `@restrict` annotations can now prevent the creation of drafts([see documentation](https://pages.github.tools.sap/cap/docs/guides/authorization#restrictions-and-draft-mode))
+- JSON Schema validation for `cds.requires.multitenancy.jobs` settings.
+- Managed associations to-one with exactly one foreign key can now have a default value.
+- Skip Okra's parsing of query options via experimental feature flag `cds.env.features.okra_skip_query_options = true`.
+  Only allowed in combination with new OData parser, i.e., `cds.env.features.odata_new_parser = true`.
+- Support for `@requires: 'any'` to make service public, i.e., no authenticated user is required
+
+### Changed
+
+- The built-in `java` profile sets `build.target` to `.` by default
+- Decimals from query options (e.g., `$filter`) are represented as strings in CQN
+- Improve error message for unsupported transformations with `$apply`
+- For database dialect H2, specialized localized views for languages `de` and `fr` are no longer generated.
+- Authentication kinds `jwt`, `xsuaa`, and `ias` throw an error during bootstrapping if the necessary credentials are not available.
+  Previously, a warning was logged and authentication was skipped.
+  See `cds bind`/ Hybrid Testing in CAPire for how to combine local development and cloud resources.
+- The Typescript definitions now make use of the default export.
+
+### Fixed
+
+- Trace middleware: Adapted usage of `performance.now()` for Node 20.
+- Draft: Associations to non-draft enabled entities must never point to drafts
+- Avoid type error in old db post processing
+- `<remote-srv>.run('/arbitrary-url')` properly defaults to a get request and does not add request body
+- `@cds.query.limit` is cached per projection
+- Application crash for incorrect usage of REST-style API to run queries
+- The `@requires` annotation on entity level didn't get applied to bound operations
+- `cds.test` run with a profile parameter such as `cds.test('run', '--profile', 'integration-tests')` will use the correct profile.
+- `cds.env.requires.auth.restrict_all_services = false` in combination with `cds.env.requires.middlewares = true` (the default)
+
+## Version 7.1.2 - 2023-08-11
+
+### Fixed
+
+- `req.tenant` is undefined when using new OData parser
+- Draft: replace some occurrences of the `arr.push(...largeArray)` pattern when copying large arrays to prevent maximum call stack size exceeded errors due to large deep update processing when saving the draft
+- Do not add keys to diff as they could be renamed (which leads to SQL error)
+- Custom bound actions for draft-enabled entities don't trigger a READ request on application service anymore
+- `cds.connect.to('db', options)`: add-hoc options for SAP HANA Database Service
+- Reading key-less singleton with `$select` clause while using the new OData parser `cds.env.features.odata_new_parser`
+- Don't use colored logs if `process.env.NO_COLOR` is set or not logging to a terminal (i.e., `!process.stdout.isTTY || !process.stderr.isTTY`)
+
 ## Version 7.1.1 - 2023-08-01
 
 ### Fixed
 
 - Lean draft: read actives via service on draft edit
-- Resolve column name for `STREAM` CQN queries that point to views
 - Only log the error in case of an unhandled rejection
+- Resolve column name for experimental `STREAM` CQN queries that point to views
 
 ## Version 7.1.0 - 2023-07-28
 
 ### Added
 
-- Support for resolving of `STREAM` CQN queries that point to views
 - Enable PDF export via GET to collection with accept header `appplication/pdf`.
   Custom handler must return the following:
   ```
@@ -36,6 +84,15 @@
     { kind: 'rest', path: '/rest/browse' }
   ]
   ```
+- Service level support for @restrict. Limited to grant: '*' and all filter conditions in `where` are ignored.
+  Example:
+  ```
+  @(restrict: [{
+    grant: '*',
+    to: ['authenticated-user']
+  }])
+  ```
+- Support for resolving of experimental `STREAM` CQN queries that point to views
 
 ### Fixed
 
@@ -140,13 +197,19 @@
 - Deprecated compat mode `cds.env.features.cds_tx_protection = false`
 - Beta `AuditLogService` and out-of-the-box audit logging. Use plugin `@cap-js/audit-logging` instead.
 
+## Version 6.8.4 - 2023-06-14
+
+### Fixed
+
+- `$metadata` requests for multitenant applications
+
 ## Version 6.8.3 - 2023-06-13
 
 ### Fixed
 
 - `cds build` no longer reports CAP Java Classic runtime usage by mistake.
 - `cds version` prints the local `@sap/cds` version, even if called from a different `@sap/cds` installation.
-- User challenges handling in case of `cds.env.auth.restrict_all_services: false`
+- User challenges handling in case of `cds.env.requires.auth.restrict_all_services: false`
 
 ## Version 6.8.2 - 2023-05-26
 
@@ -312,6 +375,7 @@ cds env requires/cds.xt.ModelProviderService
 ## Version 6.6.0 - 2023-02-27
 
 ### Added
+
 - Improved error handling for `cds build` if the SaaS base model is missing in an extension project.
 - Support for reliable paging using `$skiptoken`. Can be activated via `cds.query.limit.reliablePaging = true`
 - Built-in models are now added to existing model options of custom build tasks.
@@ -1017,7 +1081,7 @@ In such scenarios, now the HTTP `404 Not Found` status code is returned rather t
 - Avoid error that is caused e.g. in a streaming scenario when there is an issue while processing the stream. Trying to change/send the response object could cause a crash because the response was sent already.
 - Correct URL generation for `Integer64` and `Decimal` for remote services
 - Operation parameters from structured type and annotated with @open are not filtered from the input query
-- Services are secured by default in production. Can be disabled via feature flag `cds.env.auth.restrict_all_services: false` or by using `mocked-auth`.
+- Services are secured by default in production. Can be disabled via feature flag `cds.env.requires.auth.restrict_all_services: false` or by using `mocked-auth`.
 - Optimized Search: Exception when searching on views using built-in SQL SAP HANA functions
 - In some cases, custom error handlers were not called for rest
 - `cds build` adds newline at EOF for `hdbmigrationtable` files

package/apis/cds.d.ts

@@ -1,18 +1,24 @@
 import * as ql from './ql'
 
-type cds_facade = import('./core')
+declare const cds : {}
+& import('./core').default
 & import('./models')
 & import('./connect')
-& import('./serve')
+& import('./serve').default
 & import('./ql').cds_ql
-& import('./services').cds
+& import('./services').default
 & import('./services').QueryAPI
 & import('./log')
 & import('./utils')
 & import('./test')
+export default cds
+
+export * from './core'
+export * from './serve'
+export * from './services'
 
 declare global {
-	const cds : cds_facade
+
 	// these provide the functionality from SELECT, INSERT, etc in the global facade
 	const SELECT: typeof cds.ql.SELECT
 	const INSERT: typeof cds.ql.INSERT
@@ -31,5 +37,3 @@ declare global {
 	type CREATE<T> = ql.CREATE<T>
 	type DROP<T>   = ql.DROP<T>
 }
-
-export = cds

package/apis/connect.d.ts

@@ -1,5 +1,4 @@
 import { Service } from "./services"
-import * as cds_facade from './cds'
 
 export = cds
 declare class cds {

package/apis/core.d.ts

@@ -1,16 +1,27 @@
 // import types from '../lib/core'
-import { ReflectedModel, LinkedModel, LinkedDefinition } from './reflect'
+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
 
+export type Association = Definition
+export type Composition = Association
+export type entity = Definition
+export type event = Definition
+export type type = Definition
+export type array = Definition
+export type struct = Definition
+
+
 export class User {
   constructor(obj?: UserInput)
   id: string
+
   /**
    * @deprecated Use https://cap.cloud.sap/docs/node.js/events#locale instead
    */
   locale: string
+
   /**
    * @deprecated Use https://cap.cloud.sap/docs/node.js/events#tenant instead
    */
@@ -20,6 +31,7 @@ export class User {
   static Privileged: typeof Privileged
   is(role: string): boolean
 }
+
 /**
  * Subclass for executing code with superuser privileges.
  */
@@ -72,19 +84,24 @@ declare class cds {
    * Base class for linked Associations from reflected models.
    * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect#cds-Association)
    */
-  Association: Definition
+  Association: Association
 
   /**
    * Base class for linked Compositions from reflected models.
    * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect#cds-Association)
    */
-  Composition: Definition
+  Composition: Composition
 
   /**
    * Base class for linked entities from reflected models.
    * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect#cds-entity)
    */
-  entity: Definition
+  entity: entity
+
+  event: event
+  type: type
+  array: array
+  struct: struct
 
   /**
    * Add aspects to a given object, for example:
@@ -126,6 +143,38 @@ declare class cds {
    * using standard Node.js's `module.require` functions.
    */
   lazified: <T>(target: T) => T
+
+  /**
+   * Provides a graceful shutdown for running servers, by first emitting `cds.emit('shutdown')`.
+   * @see [capire](https://cap.cloud.sap/docs/node.js/cds-facade#cds-exit)
+   */
+  exit(): void
+
+
+  /**
+   * Access to the configuration for Node.js runtime and tools.
+   * The object is the effective result of configuration merged from various sources,
+   * filtered through the currently active profiles, thus highly dependent on the current working
+   * directory and process environment.
+   */
+  env : {
+    build: any,
+    hana: any,
+    i18n: any,
+    mtx: any,
+    requires: any,
+    folders: any,
+    odata: any,
+    query: any,
+    sql: any
+  }
+
+  requires: any
+  version: string
+  home: string
+  root: string
+
 }
+
 // & typeof import ('../lib/index')
-export = cds
+export default cds

package/apis/log.d.ts

@@ -20,6 +20,7 @@ declare class cds {
 }
 
 declare type LogFactory = {
+
     /**
      * Returns a trace logger for the given module if trace is switched on for it,
      * otherwise returns null. All cds runtime packages use this method for their
@@ -27,24 +28,27 @@ declare type LogFactory = {
      *
      * By default this logger would prefix all output with `[sql] - `
      * You can change this by specifying another prefix in the options:
+     *
      * ```
-     *   const LOG = cds.log('sql|db',{ prefix:'cds.ql' })
+     *   const LOG = cds.log('sql|db', { prefix: 'cds.ql' })
      * ```
+     *
      * Call `cds.log()` for a given module again to dynamically change the log level
      * of all formerly created loggers, for example:
+     *
      * ```
      *   const LOG = cds.log('sql')
      *   LOG.info ('this will show, as default level is info')
-     *   cds.log('sql','warn')
-     *   LOG.info ('this will be suppressed now')
+     *   cds.log('sql', 'warn')
+     *   LOG.info('this will be suppressed now')
      * ```
+     *
      * @param name logger name
-     * @param options level and prefix
+     * @param options level, label and prefix
      * @returns the logger
-     *
      * @see [capire](https://cap.cloud.sap/docs/node.js/cds-log)
      */
-    (name: string, options?: string | number | { level?: number, prefix?: string }): Logger
+    (name: string, options?: string | number | { level?: number, label?: string, prefix?: string }): Logger
 
     /**
      * Set a custom formatter function like that:
@@ -72,22 +76,27 @@ declare class Logger {
      * Logs with 'trace' level
      */
     trace: Log
+
     /**
      * Logs with 'debug' level
      */
     debug: Log
+
     /**
      * Logs with 'info' level
      */
     info: Log
+
     /**
      * Logs with 'warn' level
      */
     warn: Log
+
     /**
      * Logs with 'error' level
      */
     error: Log
+
     /**
      * Logs with default level
      */
@@ -97,18 +106,22 @@ declare class Logger {
      * @returns whether 'trace' level is active
      */
     _trace: boolean
+
     /**
      * @returns whether 'debug' level is active
      */
      _debug: boolean
+
     /**
      * @returns whether 'info' level is active
      */
      _info: boolean
+
     /**
      * @returns whether 'warn' level is active
      */
      _warn: boolean
+
     /**
      * @returns whether 'error' level is active
      */

package/apis/models.d.ts

@@ -162,22 +162,4 @@ declare class cds {
      */
     resolve (files: '*' | filename | filename[]) : filename[] | undefined
 
-    /**
-     * Access to the configuration for Node.js runtime and tools.
-     * The object is the effective result of configuration merged from various sources,
-     * filtered through the currently active profiles, thus highly dependent on the current working
-     * directory and process environment.
-     */
-    env : {
-        build: object,
-        hana: object,
-        i18n: object,
-        mtx: object,
-        requires: object,
-        folders: object,
-        odata: object,
-        query: object,
-        sql: object
-    }
-
 }

package/apis/ql.d.ts

@@ -43,7 +43,7 @@ type QLExtensions_<T> = {
 	get: (path: string) => any
 
 	// have to exclude undefined from the type, or we'd end up with a distribution of Subqueryable
-	// over T and undefined, which gives us zero code completion within the callable. 
+	// over T and undefined, which gives us zero code completion within the callable.
 } & Subqueryable<Exclude<T, undefined>>
 
 /**
@@ -51,45 +51,45 @@ type QLExtensions_<T> = {
  * The final result of each subquery will be the property itself:
  * `Book.title` == `Subqueryable<Book>.title()`
  */
-type Subqueryable<T> = 
+type Subqueryable<T> =
 T extends Primitive	? {}
 // composition of many/ association to many
-: T extends readonly unknown[] ? { 
+: T extends readonly unknown[] ? {
 	/**
 	 * @example
 	 * ```js
 	 * SELECT.from(Books, b => b.author)
 	 * ```
 	 * means: "select all books and project each book's author"
-	 * 
+	 *
 	 * whereas
 	 * ```js
 	 * SELECT.from(Books, b => b.author(a => a.ID))
 	 * ```
 	 * means: "select all books, subselect each book's author's ID
-	 * 
+	 *
 	 * Note that you do not need to return anything from these subqueries.
 	 */
-	(fn: ((a:QLExtensions<T[number]>) => any) | '*'): T[number] 
+	(fn: ((a:QLExtensions<T[number]>) => any) | '*'): T[number]
 }
 // composition of one/ association to one
-: { 
+: {
 	/**
 	 * @example
 	 * ```js
 	 * SELECT.from(Books, b => b.author)
 	 * ```
 	 * means: "select all books and project each book's author"
-	 * 
+	 *
 	 * whereas
 	 * ```js
 	 * SELECT.from(Books, b => b.author(a => a.ID))
 	 * ```
 	 * means: "select all books, subselect each book's author's ID
-	 * 
+	 *
 	 * Note that you do not need to return anything from these subqueries.
 	 */
-	(fn: ((a:QLExtensions<T>) => any) | '*'): T 
+	(fn: ((a:QLExtensions<T>) => any) | '*'): T
 }
 ;
 
@@ -102,7 +102,7 @@ export type Projection<T> = (e:QLExtensions<T extends ArrayConstructable ?  Sing
 // awaited to materialise the result:
 // `Awaitable<SELECT<Book>, Book> = SELECT<Book> & Promise<Book>`
 //
-// While the benefit is probably not immediately obvious as we don't exactly 
+// While the benefit is probably not immediately obvious as we don't exactly
 // save a lot of typing over explicitly writing `SELECT<Book> & Promise<Book>`,
 // it makes the semantics more explicit. Also sets us up for when TypeScript ever
 // improves their generics to support:
@@ -116,7 +116,7 @@ export type Awaitable<T, I> = T & Promise<I>
 // new SELECT(...).(...) == SELECT(...)
 export type StaticSELECT<T> = typeof SELECT
 	& ((...columns: (T extends ArrayConstructable<any> ? keyof SingularType<T> : keyof T)[]) => SELECT<T>)
-	& ((...columns:string[]) => SELECT<T>) 
+	& ((...columns:string[]) => SELECT<T>)
 	& ((columns:string[]) => SELECT<T>)
 	& (TaggedTemplateQueryPart<SELECT<T>>)
 	& SELECT_one // as it is not directly quantified, ...
@@ -124,11 +124,11 @@ export type StaticSELECT<T> = typeof SELECT
 
 declare class QL<T> {
 	SELECT : StaticSELECT<T>
-	INSERT : typeof INSERT 
+	INSERT : typeof INSERT
 		& ((...entries:object[]) => INSERT<any>) & ((entries:object[]) => INSERT<any>)
 	UPSERT: typeof UPSERT
 		& ((...entries:object[]) => UPSERT<any>) & ((entries:object[]) => UPSERT<any>)
-	UPDATE : typeof UPDATE 
+	UPDATE : typeof UPDATE
 		& typeof UPDATE.entity
 	DELETE : typeof DELETE
 	CREATE : typeof CREATE
@@ -146,7 +146,7 @@ export class SELECT<T> extends ConstructedQuery {
 	static one : SELECT_one & { from: SELECT_one }
 	static distinct : typeof SELECT
     static from : SELECT_from
-	from: TaggedTemplateQueryPart<this> 
+	from: TaggedTemplateQueryPart<this>
 		& ((entity: Definition | string, primaryKey? : PK, projection? : Projection<unknown>) => this)
 	byKey (primaryKey? : PK) : this
 	columns: TaggedTemplateQueryPart<this>
@@ -230,9 +230,9 @@ export class INSERT<T> extends ConstructedQuery {
 		& ((entity : Definition | string, entries? : object | object[]) => INSERT<any>)
 		& (<T> (entity:Constructable<T>, entries? : object | object[]) => INSERT<T>)
 		& (<T> (entity:T, entries? : T | object | object[]) => INSERT<T>)
-	
-	into: (<T extends ArrayConstructable> (entity:T) => this) 
-		& TaggedTemplateQueryPart<this> 
+
+	into: (<T extends ArrayConstructable> (entity:T) => this)
+		& TaggedTemplateQueryPart<this>
 		& ((entity : Definition | string) => this)
 	data (block : (e:T)=>void) : this
 	entries (...entries : object[]) : this
@@ -251,9 +251,9 @@ export class UPSERT<T> extends ConstructedQuery {
 		& ((entity : Definition | string, entries? : object | object[]) => UPSERT<any>)
 		& (<T> (entity:Constructable<T>, entries? : object | object[]) => UPSERT<T>)
 		& (<T> (entity:T, entries? : T | object | object[]) => UPSERT<T>)
-	
-	into: (<T extends ArrayConstructable> (entity:T) => this) 
-		& TaggedTemplateQueryPart<this> 
+
+	into: (<T extends ArrayConstructable> (entity:T) => this)
+		& TaggedTemplateQueryPart<this>
 		& ((entity : Definition | string) => this)
 	data (block : (e:T)=>void) : this
 	entries (...entries : object[]) : this
@@ -290,7 +290,7 @@ export class UPDATE<T> extends ConstructedQuery {
 	// set (block: (e:T)=>void) : this
 	set: TaggedTemplateQueryPart<this>
 		& ((data:object) => this)
-	with: TaggedTemplateQueryPart<this> 
+	with: TaggedTemplateQueryPart<this>
 		& ((data:object) => this)
 	where (predicate:object) : this
 	where (...expr : any[]) : this
@@ -307,4 +307,4 @@ export class CREATE<T> extends ConstructedQuery {
 export class DROP<T> extends ConstructedQuery {
 	static entity (entity : Definition | string) : DROP<any>
 	DROP : CQN.DROP["DROP"]
-}
+}

package/apis/serve.d.ts

@@ -22,7 +22,7 @@ interface service_options {
 	[key: string]: unknown
 }
 
-export = cds_serve
+export default cds_serve
 declare class cds_serve {
 
 	/**
@@ -36,7 +36,7 @@ declare class cds_serve {
 	 */
 	server: cds_server
 
-	
+
 
 	/**
 	 * Emitted at the very beginning of the bootsrapping process, when the
@@ -81,18 +81,7 @@ declare class cds_serve {
 	 * Shortcut to base class for all service definitions from linked models.
 	 * Plus accessors to impl functions and constructed providers.
 	 */
-	service : LinkedDefinition & {
-		/**
-		 * Dummy wrapper for service implementation functions.
-		 * Use that in modules to get IntelliSense.
-		 */
-		impl (impl: ServiceImpl) : typeof impl
-		impl <T> (srv:T, impl: ( this: T, srv: (T) ) => any) : typeof impl
-		/**
-		 * Array of all services constructed.
-		 */
-		providers : Service
-	}
+	service : service
 
 	/**
 	 * The effective CDS model loaded during bootstrapping, which contains all service and entity definitions,
@@ -102,5 +91,19 @@ declare class cds_serve {
 
 }
 
+export type service = LinkedDefinition & {
+	/**
+	 * Dummy wrapper for service implementation functions.
+	 * Use that in modules to get IntelliSense.
+	 */
+	impl (impl: ServiceImpl) : typeof impl
+	impl <T> (srv:T, impl: ( this: T, srv: (T) ) => any) : typeof impl
+	/**
+	 * Array of all services constructed.
+	 */
+	providers : Service
+}
+
+
 declare type cds_services = { [name:string]: Service }
 declare type cds_server = Function