@sap/cds 7.3.1 → 7.4.0

package/CHANGELOG.md

@@ -4,6 +4,61 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 7.4.0 - 2023-11-13
+
+### Added
+
+- Any service is outboxable via `srv = cds.outboxed(srv)`
+- Draft: support `HasActiveEntity eq false` by read
+- Check if OData function/action params exist for complex types
+- Remote services: destination option `jwt` set to `null` instructs that an incoming request's JWT shall not be passed to SAP Cloud SDK, e.g., when it shall use a fresh client credentials flow token
+  + Example:
+    ```json
+    "requires": {
+      "API_BUSINESS_PARTNER": {
+        [...]
+        "destinationOptions": {
+          "jwt": null
+        }
+      }
+    }
+    ```
+- Alpha feature flag `cds.env.fiori.wrap_multiple_errors` to toggle the following behaviour for OData errors meant to be consumed by SAP Fiori Elements:
+  In cases where multiple errors occur and the flag is set to `false`, the first error is presented as the top-level error (replacing the generic "multiple errors" wrapper).
+  The default value is `true`, but `false` will become the default value in cds^8.
+- On CF, the default keep alive timeout of the server is set to 91s (to exceed the 90s of CF's gorouter)
+- `cds deploy` now auto-fills the `ID_texts` field (which get created for entities marked with `@fiori.draft.enabled`) in csv and json data files with a stable UUID.  This way, it does not need to be manually added to data files.  Also, as the value is stable (a hash of the semantic key fields `ID` and `locale`), it works with `UPSERT` statements.
+
+### Changed
+
+- Default outbox configuration (overridable via `cds.env.requires.outbox = { ... }`):
+  + `kind` changed to `persistent-outbox` (was `in-memory-outbox`)
+  + `parallel` changed to `true` (i.e., messages are not emitted in sequence)
+- Internal class `OutboxService` is deprecated and will be removed
+
+### Fixed
+
+- `req.subject` in lean-draft handlers
+- `cds.odata.batch_limit` wasn't taken into account
+- Enterprise-Messaging: Only set tenant information for multitenant apps
+- Enterprise-Messaging: Race condition in `subscribe` event
+- Draft: delete of active entity is forbidden, if draft exist
+- Draft: sorting of draft entities in `list status: all`
+- Draft: invalid delete draft request now rejects with error
+- Draft: Enhance Draft Edit functionality with exclusive record lock
+- Typings for `req.reject/error/info/warn`
+- Deep delete with mixins on new db layer did not work
+- Special strings like `'$now'`, `'$user'` and `'$uuid'` expanded automatically
+- Only services that are served via OData are precompiled during startup
+- Response status of not existing mocks returned 200 instead of 404
+- Calculation of @Capabilities in case of complex $apply
+- `test.data.reset()` did not delete drafts
+- `resolveView` considers `list` for renamed columns
+- `cds.schema` now loads lazily
+- `odata_new_parser`: `$expand=` no longer throws an error with and is simply ignored
+- `odata_new_parser`: Empty custom query params like `Foo?bar` are ignored
+- `odata_new_parser`: generated wrong CQN for queries like `$filter=false or ref eq 5`
+
 ## Version 7.3.1 - 2023-10-23
 
 ### Fixed
@@ -18,7 +73,7 @@
 - `cds.localized` now caches i18n bundles per locale and per model to speed up repeated usages of the same bundle at runtime, for example, in repeated calls to `cds.compile.for.edmx()`.
 - Based on `cds.localized` with cached bundles, a new operation `cds.localized.lookup(i18n_key, locale)` is provided.
 - If env variable `CDS_TEST_ENV_CHECK` is set, `cds.test.in()` detects if `cds.env` was loaded before from a different folder.
-- `cds.test.log()` allows to capture and analyse any console log output. `cds.test.verbose()` is now deprecated.
+- `cds.test.log()` allows to capture and analyze any console log output. `cds.test.verbose()` is now deprecated.
 - Typings for `cds.tx`
 - Add method `cds.schema.default4(schemaId)` to retrieve json schema based on its id
 - Support for pseudo role `internal-user` with authentication kind `ias`
@@ -26,7 +81,7 @@
 
 ### Changed
 
-- If ommitted in the accept header, `ExponentialDecimals` no longer gets defaulted (to `true`), which violated the OData 4.0 specification.
+- If omitted in the accept header, `ExponentialDecimals` no longer gets defaulted (to `true`), which violated the OData 4.0 specification.
   This change can _temporarily_ be overridden via `cds.env.odata.defaultExponentialDecimals = 'true/false'`.
 - Make type signature of `extend.with` more general
 - `cds.test.data.autoReset()` is deprecated in favor of explicit `cds.test.data.reset()` call, like `beforeEach (test.data.reset)`.
@@ -728,7 +783,7 @@ Content-Length: 145
 - Signatures for QL operations are now more specific
 - `basic-auth` does not inherit users of `mocked-auth`
 - `cds.localize` now ignores i18n files defined outside the project scope.
-- Allow `@Capabilities.NavigationRestrictions.RestrictedProperties` to be specified in the format `{ InsertRestrictions.Insertable: false }`
+- Allow `@Capabilities.NavigationRestrictions.RestrictedProperties` to be specified in the format `{ InsertRestrictions: { Insertable: false } }`
 - Bound actions/functions while calling remote service
 - `$search`: Search on localized projections/views does not always return the localized data
 - `cds push` now shows better output for failed extension validations

package/_i18n/i18n_es_MX.properties

@@ -0,0 +1,110 @@
+#Text Types
+#
+#XACT: Text with explicit importance for accessibility.
+#XBUT: Button
+#XCKL: Checkbox
+#XFLD: Field label
+#XLNK: Hyperlink
+#XMIT: Menu item (Menu item, either top-level like "File" or lower-level like "Save as...")
+#XMSG: Message
+#XRBL: Radio button
+#XSEL: Selection (Values in a drop-down list, or a status. For example: "In Process", "Shipped" or "Open".)
+#XTIT: Title (or heading) of a non-actionable user interface element like a column, wizard, or screen area.
+#XTOL: Explanatory text for an UI element, such as a tooltip, input help.
+#YINS: Instruction for a user, for example, a permanent text on a screen that introduces a group of fields.
+#----------------------------------------------------------------------------------------------------------------------
+#For text elements that are not supposed to be translated, use the text type NOTR
+#----------------------------------------------------------------------------------------------------------------------
+#Recommended pattern
+#
+#<TextType>:<AdditionalContextInformation>
+#If there is a maximum length restriction, please indicate as shown below.
+#<TextType>,<MaximumLength>:<AdditionalContextInformation>
+#----------------------------------------------------------------------------------------------------------------------
+# This is the resource bundle for foundation
+# __ldi.translation.uuid=dd6c5800-b108-11e8-be90-bd1cf6ac87fb
+#----------------------------------------------------------------------------------------------------------------------
+
+#XTIT: Created By (Answer to: "Which user has created a certain entity?")
+CreatedBy=Creado por
+
+#XTIT: Created On (Answer to: "When has a certain entity been created?")
+CreatedAt=Fecha de creaci\u00F3n
+
+#XTIT: Changed By (Answer to: "Which user has changed a certain entity?")
+ChangedBy=Modificado por
+
+#XTIT: Changed On (Answer to: "When has a certain entity been changed?")
+ChangedAt=Modificado el
+
+#XTIT: Currency
+Currency=Moneda
+
+#XTIT: Currency Code
+CurrencyCode=C\u00F3digo de moneda
+
+#XTIT: Currency Code Description
+CurrencyCode.Description=C\u00F3digo de moneda seg\u00FAn especificado por ISO 4217
+
+#XTIT: Currency Symbol
+CurrencySymbol=S\u00EDmbolo de moneda
+
+#XTIT: Currency Minor Unit Fractions (Answer to: "How many fractions has a currency's minor unit?", e.g. "0" or "2")
+CurrencyMinorUnit=Fracciones unidad secundaria de moneda
+
+#XTIT: Country/Region
+Country=Pa\u00EDs/Regi\u00F3n
+
+#XTIT: Country/Region Code
+CountryCode=C\u00F3digo de pa\u00EDs/regi\u00F3n
+
+#XTIT: Country/Region Code Description
+CountryCode.Description=C\u00F3digo de pa\u00EDs/regi\u00F3n seg\u00FAn especificado por ISO 3166-1
+
+#XTIT: Language
+Language=Idioma
+
+#XTIT: Language Code
+LanguageCode=C\u00F3digo de idioma
+
+#XTIT: Language Code Description
+LanguageCode.Description=C\u00F3digo de idioma seg\u00FAn especificado por ISO 639-1
+
+#XTIT: User Identifier
+UserID=ID de usuario
+
+#XTIT: Any kind of name
+Name=Nombre
+
+#XTIT: Any kind of description
+Description=Descripci\u00F3n
+
+#XTOL: A user's unique Indentifier
+UserID.Description=ID \u00FAnico de usuario
+
+#XTIT: Admin data for a draft document
+Draft_DraftAdministrativeData=Datos administrativos en borrador
+
+#XTIT: Technical ID of a draft document
+Draft_DraftUUID=Borrador (ID t\u00E9cnico)
+
+#XTIT: Creation time of a draft
+Draft_CreationDateTime=Borrador creado el
+
+#XTIT: User created the draft
+Draft_CreatedByUser=Borrador creado por
+
+#XTIT: The current user (me) created the draft
+Draft_DraftIsCreatedByMe=Borrador creado por m\u00ED
+
+#XTIT: Time a draft was last changed on
+Draft_LastChangeDateTime=Fecha del \u00FAltimo cambio en borrador
+
+#XTIT: User that changed the draft last
+Draft_LastChangedByUser=Autor del \u00FAltimo cambio en borrador
+
+#XTIT: User that is working on the draft
+Draft_InProcessByUser=Borrador en proceso por
+
+#XTIT: The current user (me) is working on the draft
+Draft_DraftIsProcessedByMe=Borrador en proceso por m\u00ED

package/apis/cds.d.ts

@@ -1,24 +1,25 @@
 import * as ql from './ql'
 
-declare const cds : {}
+declare global {
+	const cds : cds_facade
+}
+
+export = cds
+
+type cds_facade = {}
 & import('./core').default
-& import('./models')
-& import('./connect')
-& import('./serve').default
-& import('./ql').cds_ql
-& import('./services').default
+& import('./env').default
+& import('./models').default
+& import('./server').default
 & import('./services').QueryAPI
+& import('./services').default
+& import('./events').default
+& import('./ql').cds_ql
 & import('./log')
 & import('./utils')
 & import('./test')
-export default cds
-
-export * from './core'
-export * from './serve'
-export * from './services'
 
 declare global {
-
 	// these provide the functionality from SELECT, INSERT, etc in the global facade
 	const SELECT: typeof cds.ql.SELECT
 	const INSERT: typeof cds.ql.INSERT

package/apis/core.d.ts

@@ -1,68 +1,17 @@
-// import types from '../lib/core'
-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
-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
-   */
-  tenant: string | undefined
-
-  attr: Record<string, string>
-  roles: Array<string> | Record<string, string>
-  static Privileged: typeof Privileged
-  is(role: string): boolean
-}
-
-/**
- * Subclass for executing code with superuser privileges.
- */
-declare class Privileged extends User {
-  constructor()
-  is(): boolean
-}
-
-declare class cds {
-  /**
-   * Turns the given plain CSN model into a linked model
-   * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect)
-   */
-  linked(model: csn): LinkedModel
-
-  /**
-   * Turns the given plain CSN model into a reflected model
-   * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect)
-   */
-  reflect(model: csn): ReflectedModel
-
-  /**
-   * Represents the user in a given context.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/authentication#cds-user)
-   */
-  User: typeof User
-
+import { LinkedAssociation, LinkedEntity, linked } from './linked'
+import * as csn from './csn'
+import { service } from './server'
+
+// These are classes actually -> using the new() => interface trick
+export type Association = new() => LinkedAssociation
+export type Composition = new() => LinkedAssociation
+export type entity = new() => LinkedEntity
+export type event = new() => linked & csn.struct
+export type type = new() => linked & csn.type
+export type array = new() => linked & csn.type
+export type struct = new() => linked & csn.struct
+
+export default class cds {
   // infer (query : cqn, model : csn) : LinkedDefinition
 
   builtin: {
@@ -71,15 +20,14 @@ declare class cds {
      * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect#cds-builtin-classes)
      */
     classes: {
-      Association: Definition
-      Composition: Definition
-      context: Definition
-      service: Definition
-      type: Definition
-      array: Definition
-      struct: Definition
-      entity: Definition
-      event: Definition
+      Association: Association
+      Composition: Composition
+      entity: entity
+      event: event
+      type: type
+      array: array
+      struct: struct
+      service: service
     }
     types: {}
   }
@@ -130,7 +78,7 @@ declare class cds {
    * The first usage of `facade.sub` will load the sub module
    * using standard Node.js's `module.require` functions.
    */
-  lazify: <T>(target: T) => T
+  lazify <T>(target: T) : T
 
   /**
    * Prepare a node module for lazy-loading submodules instead
@@ -144,39 +92,10 @@ declare class cds {
    * The first usage of `facade.sub` will load the sub module
    * 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
+  lazified <T>(target: T) : T
 
 }
 
-// & typeof import ('../lib/index')
-export default cds
+type Intersect<T extends readonly unknown[]> = T extends [infer Head, ...infer Tail]
+  ? Head & Intersect<Tail>
+  : unknown

package/apis/cqn.d.ts

@@ -1,8 +1,7 @@
-import { entity } from "./csn"
+import { entity } from "./csn" // cyclic dependency
 
-export type CQNQuery = SELECT & INSERT & UPDATE & DELETE & CREATE & DROP & UPSERT
-export type Query = SELECT | INSERT | UPDATE | DELETE | CREATE | DROP | UPSERT
-export type ParsedExpr = expr & { _:string }
+// FIXME: a union type would be more appropriate here
+export type Query = Partial<SELECT & INSERT & UPDATE & DELETE & CREATE & DROP & UPSERT>
 
 export type SELECT = {SELECT:{
 	distinct?: true
@@ -16,37 +15,33 @@ export type SELECT = {SELECT:{
 	groupBy? : expr[]
 	orderBy? : ordering_term[]
 	limit?: { rows:val, offset:val }
-	forUpdate?: { wait: number }
-	forShareLock?: { wait: number }
-	search?: _xpr
-	count?: boolean
 }}
 
 export type INSERT = {INSERT:{
-	into : name | ref
-	entries : any[]
+	into : ref | name
+	entries : data[]
 	columns : string[]
-	values : any[]
-	rows : any[]
+	values : scalar[]
+	rows : scalar[][]
 	as : SELECT
 }}
 
 export type UPSERT = {UPSERT:{
-	into : name | ref
-	entries : any[]
+	into : ref | name
 	columns : string[]
-	values : any[]
-	rows : any[]
+	entries : data[]
+	values : scalar[]
+	rows : scalar[][]
 }}
 
 export type UPDATE = {UPDATE:{
-	entity : name
+	entity : ref | name
 	data : { [key:string] : expr }
 	where? : predicate
 }}
 
 export type DELETE = {DELETE:{
-	from : name
+	from : ref | name
 	where? : predicate
 }}
 
@@ -61,6 +56,8 @@ export type DROP = {DROP:{
 	view: ref
 }}
 
+type scalar = number | string | boolean | null
+type data = Record<string,any>
 type name = string
 type source = ( ref | SELECT ) & { as?: name, join?:name, on?:xpr }
 export type column_expr = expr & { as?: name, cast?:any, expand?: column_expr[], inline?: column_expr[] }

package/apis/csn.d.ts

@@ -1,82 +1,117 @@
-import { SELECT, expr, predicate, column_expr } from "./cqn"
+import { SELECT, ref, predicate } from './cqn'
 
-export type csn = CSN
-
-/** A parsed model. */
+/**
+ * A parsed CDS model in CSN object notation.
+ */
 export interface CSN {
+  /**
+   * The assigned namespace. If parsed from multiple sources,
+   * this is the topmost model's namespace, if any, not the
+   * ones of imported models.
+   */
+  namespace?: string
 
-    /** The assigned namespace. If parsed from multiple sources, this is the topmost model's namespace, if any, not the ones of imported models. */
-    namespace? : string
-
-    /** The list of usings in this parsed model. Not available after imports have been resolved into a merged model. */
-    using? : { name: string, as?: string, from?: string }[]
+  /**
+   * The list of usings in this parsed model. Not available after
+   * imports have been resolved into a merged model.
+   */
+  requires?: string[]
 
-    /** All definitions in the model including those from imported models. */
-    definitions? : Definitions
+  /**
+   * All definitions in the model including those from imported models.
+   */
+  definitions?: Record<FQN, Definition>
 
-    /** All extensions in the model including those from imported models. Not available after extensions have been applied. */
-    extensions? : Definition[]
+  /**
+   * All extensions in the model including those from imported models.
+   * Not available after extensions have been applied.
+   */
+  extensions?: Extension[]
 
-    $sources?: string[]
+  /**
+   * The names of the files from which this model has been loaded.
+   */
+  $sources?: string[]
 }
 
-export interface DefinitionRegistry {
-    type: type,
-    struct: struct,
-    entity: entity,
-    Association: Association
-}
-export type Definition = DefinitionRegistry[keyof DefinitionRegistry];
+/**
+ * The fully-quality name of a definition.
+ */
+export type FQN = string
 
-export interface Definitions {
-    [name:string]: Definition
-}
+/**
+ * Definitions are the central elements of a CDS model.
+ */
+export type Definition = context & service & type & struct & entity & Association
+// NOTE: If we use & instead of | CSN.definitions values would be reduced to <never>
 
-export type kind = 'context' | 'service' | 'type' | 'entity' | 'element' | 'const' | 'annotation'
-export type Element = type & struct & Association & {
-    kind : 'element' | undefined
+/**
+ * Extensions capture extend Foo with { ... } directives.
+ */
+export type Extension = {
+  extend: FQN
+  elements?: { [name: string]: Element }
+  includes?: FQN[]
 }
 
-export interface type {
-    kind? : kind
-    type? : string
-    name : string
+export type Element = type & struct & Association
+
+export type kinds = 'type' | 'entity' | 'event' | 'service' | 'context' | 'struct'
+
+export interface any_ { kind?: kinds }
+export interface context extends any_ { }
+export interface service extends any_ { }
+
+export interface type extends any_ {
+  type?: FQN
+  items?: type
 }
 
 export interface struct extends type {
-    /** structs have elements which are in turn Definitions */
-    elements : { [name:string]: Element }
-    /** References to definitions to be included. Not available after extensions have been applied. */
-    include? : string[]
+  /**
+   * References to definitions to be included.
+   * Not available after extensions have been applied.
+  */
+  includes?: FQN[]
+  elements: { [name: string]: Element }
 }
 
-export interface entity extends struct {
-    kind : 'entity'
-    /** Entities with a query signify a view */
-    query?: SELECT & { cql: string }
-    /** Elements of entities may have additional qualifiers */
-    elements : {
-        [name:string]: Element & {
-            key? : boolean
-            virtual? : boolean
-            unique? : boolean
-            notNull? : boolean
-        }
-    }
-    keys : {
-        [name:string]: Definition
+export interface entity extends Omit<struct,'elements'> {
+  /**
+   * Entities with a query signify a view
+   */
+  query?: SELECT
+  /**
+   * Elements of entities may have additional qualifiers
+   */
+  elements : EntityElements
+  // REVISIT: following should move to LinkedCSN
+  keys: { [name: string]: Definition }
+  drafts: entity
+}
+
+export type EntityElements = {
+    [name:string]: Element & {
+        key? : boolean
+        virtual? : boolean
+        unique? : boolean
+        notNull? : boolean
     }
-    drafts: entity
 }
 
 export interface Association extends type {
-    type : 'cds.Association' | 'cds.Composition'
-    /** The fully-qualified name of the Association's target entity */
-    target : string
-    /** The specified cardinality. to-one = {max:1}, to-many = {max:'*'} */
-    cardinality? : {src?:1,min?:1|0,max?:1|'*'}
-    /** The parsed on condition in case of unmanaged Associations */
-    on? : predicate
-    /** The optionally specified keys in case of managed Associations */
-    keys? : column_expr[]
+  type: 'cds.Association' | 'cds.Composition'
+  target: FQN
+  /**
+   * The specified cardinality. to-one = {max:1}, to-many = {max:'*'}
+   */
+  cardinality?: { src?: 1; min?: 1 | 0; max?: 1 | '*' }
+  /**
+   * The parsed on condition in case of unmanaged Associations
+   */
+  on?: predicate
+  /**
+   * The optionally specified keys in case of managed Associations
+   */
+  keys?: (ref & { as: string })[]
 }

package/apis/env.d.ts

@@ -0,0 +1,25 @@
+export default class {
+  /**
+   * 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
+
+}