@cap-js/cds-types 0.14.0 → 0.16.0

package/dist/cds-types.d.ts

@@ -64,13 +64,15 @@ export type __UUID = classes.UUID
 
 export type __Vector = classes.Vector
 
-class action extends any_<'action' | 'function'> {}
+class action extends any__2<'action' | 'function'> {}
 
 export interface ActionEventHandler<S, P, R> {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-    (req: Omit<Request_2, 'data'> & { data: P, subject: S }, next: Function): Promise<R> | R
+    (req: ActionRequest<P, S>, next: Function): Promise<R> | R
 }
 
+export type ActionRequest<P, S> = Omit<Request_2, 'data'> & { data: P, subject: S }
+
 interface And {
     and: TaggedTemplateQueryPart<this>
     & ((predicate: object) => this)
@@ -88,11 +90,20 @@ export class Anonymous extends User {
 
 }
 
-const any: typeof any_;
+const any: typeof any__2;
+
+interface any_ {
+    kind?: kinds
+    /**
+     * only available when compiled with docs:true
+     * @see [capire docs](https://cap.cloud.sap/docs/cds/cdl#comments)
+     */
+    doc?: string
+}
 
-interface any_ extends csn.any_ {}
+interface any__2 extends csn.any_ {}
 
-class any_<K extends kinds = kinds> {
+class any__2<K extends kinds = kinds> {
     private _: K // break covariance
     constructor (...aspects: any[])
 
@@ -101,15 +112,6 @@ class any_<K extends kinds = kinds> {
     // is (kind: kinds | 'Association' | 'Composition'): boolean
 }
 
-interface any__2 {
-    kind?: kinds
-    /**
-     * only available when compiled with docs:true
-     * @see [capire docs](https://cap.cloud.sap/docs/cds/cdl#comments)
-     */
-    doc?: string
-}
-
 /**
  * The {@link https://expressjs.com/en/4x/api.html#app| express.js application} constructed by the server implementation.
  *
@@ -254,6 +256,7 @@ namespace cds {
         on,
         once,
         exit,
+        error,
         _cds,
         cds_services,
         connect,
@@ -342,6 +345,7 @@ namespace cds {
         CdsFunctions,
         HandlerFunction,
         CRUDEventHandler,
+        ActionRequest,
         ActionEventHandler,
         ResultsHandler,
         SpawnEvents,
@@ -350,7 +354,6 @@ namespace cds {
         SpawnOptions,
         context,
         tx,
-        entities,
         run,
         foreach,
         stream,
@@ -360,6 +363,7 @@ namespace cds {
         update,
         transaction,
         db,
+        entities,
         queued,
         unqueued,
         outboxed,
@@ -367,6 +371,8 @@ namespace cds {
         EventContext,
         Event_2 as Event,
         Request_2 as Request,
+        GetRequest,
+        PostRequest,
         User,
         Anonymous,
         Privileged,
@@ -391,6 +397,7 @@ namespace cds {
         _segment,
         _named,
         val,
+        list,
         xpr,
         _xpr,
         operator,
@@ -438,6 +445,7 @@ namespace cds_2 {
         on,
         once,
         exit,
+        error,
         _cds,
         cds_services,
         connect,
@@ -526,6 +534,7 @@ namespace cds_2 {
         CdsFunctions,
         HandlerFunction,
         CRUDEventHandler,
+        ActionRequest,
         ActionEventHandler,
         ResultsHandler,
         SpawnEvents,
@@ -534,7 +543,6 @@ namespace cds_2 {
         SpawnOptions,
         context,
         tx,
-        entities,
         run,
         foreach,
         stream,
@@ -544,6 +552,7 @@ namespace cds_2 {
         update,
         transaction,
         db,
+        entities,
         queued,
         unqueued,
         outboxed,
@@ -551,6 +560,8 @@ namespace cds_2 {
         EventContext,
         Event_2 as Event,
         Request_2 as Request,
+        GetRequest,
+        PostRequest,
         User,
         Anonymous,
         Privileged,
@@ -575,6 +586,7 @@ namespace cds_2 {
         _segment,
         _named,
         val,
+        list,
         xpr,
         _xpr,
         operator,
@@ -635,7 +647,7 @@ namespace classes {
         Column,
         Definitions,
         WithElements,
-        any_,
+        any__2 as any_,
         any,
         aspect,
         type,
@@ -862,9 +874,9 @@ export let context: EventContext | undefined;
 
 interface context_ extends csn.context {}
 
-class context_ extends any_ { }
+class context_ extends any__2 { }
 
-interface context_2 extends any__2 { }
+interface context_2 extends any_ { }
 
 namespace CQN {
     export {
@@ -888,6 +900,7 @@ namespace CQN {
         _segment,
         _named,
         val,
+        list,
         xpr,
         _xpr,
         operator,
@@ -963,7 +976,7 @@ namespace csn {
         Extension,
         Element,
         kinds,
-        any__2 as any_,
+        any_,
         context_2 as context,
         service_2 as service,
         type_2 as type,
@@ -1043,12 +1056,12 @@ type DeepPartial<T> = T extends object
  */
 type Definition = context_2 & service_2 & type_2 & struct_2 & entity_2 & Association_2
 
-type Definition_2 = any_
+type Definition_2 = any__2
 
 /**
  * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect#iterable)
  */
-type Definitions<T extends any_ = any_> = IterableMap<T>
+type Definitions<T extends any__2 = any__2> = IterableMap<T>
 
 const delete_: Service['delete'];
 export { delete_ as delete };
@@ -1097,7 +1110,7 @@ export type EDMX = XML
 
 type Element = type_2 & struct_2 & Association_2
 
-export const entities: Service['entities'];
+export const entities: linked_2.LinkedCSN['entities'];
 
 /**
  * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect#cds-entity)
@@ -1293,6 +1306,17 @@ export namespace env {
     }
 }
 
+/**
+ * @see [capire](https://cap.cloud.sap/docs/node.js/cds-facade#cds-error)
+ */
+export function error (status: number, message: string, details?: {stack?: unknown}, caller?: (...args: any[]) => unknown): Error
+
+export function error (message: string, details?: {status: number, stack?: unknown}, caller?: (...args: any[]) => unknown): Error
+
+export function error (details: {status: number, message: string}, caller?: (...args: any[]) => unknown): Error
+
+export function error (string: TemplateStringsArray, ...args: any[]): Error
+
 export class event extends aspect<'event'> {}
 
 /**
@@ -1349,7 +1373,7 @@ export interface EventHandler {
  */
 export function exit (): void
 
-export type expr = ref | val | xpr | function_call | SELECT_2
+export type expr = ref | val | list | xpr | function_call | SELECT_2
 
 export type expr_literal = { '=': string }
 
@@ -1388,7 +1412,7 @@ type Extension = {
 
 export type filename = string
 
-type Filter = string | (<T extends any_ = any_>(def: T) => boolean)
+type Filter = string | (<T extends any__2 = any__2>(def: T) => boolean)
 
 export type _flavor = 'parsed' | 'xtended' | 'inferred'
 
@@ -1430,6 +1454,10 @@ export type function_call = { func: string, args: { [key: string]: any }[] }
  */
 export function get (files: '*' | filename | filename[], o?: _options): Promise<csn.CSN>
 
+export type GetRequest<
+P extends Record<string, any>[]
+> = Request_2<Record<never, never>, P>;
+
 interface GroupBy {
     groupBy: TaggedTemplateQueryPart<this>
     & ((columns: Partial<{[column in KeyOfTarget<this extends ConstructedQuery<infer E> ? E : never, never>]: any}>) => this)
@@ -1739,6 +1767,7 @@ export namespace linked {
 namespace linked_2 {
     export {
         ModelPart,
+        ModelPartFn,
         Definition_2 as Definition,
         LinkedCSN,
         classes
@@ -1757,13 +1786,13 @@ interface LinkedCSN extends Omit<csn.CSN, 'definitions'> {
      	 *   let entities = m.all('entity')        //> equivalent shortcut
      	 * ```
      	 */
-    each<T extends any_>(x: Filter, defs?: Definitions<T>): IterableIterator<T>
+    each<T extends any__2>(x: Filter, defs?: Definitions<T>): IterableIterator<T>
 
     /**
      	 * Fetches definitions matching the given filter, returning them in an array.
      	 * Convenience shortcut for `[...reflect.each('entity')]`
      	 */
-    all<T extends any_>(x: Filter, defs?: Definitions<T>): T[]
+    all<T extends any__2>(x: Filter, defs?: Definitions<T>): T[]
 
     /**
      	 * Fetches definitions matching the given filter, returning the first match, if any.
@@ -1772,7 +1801,7 @@ interface LinkedCSN extends Omit<csn.CSN, 'definitions'> {
      	 * @param x - the filter
      	 * @param defs - the definitions to fetch in, default: `this.definitions`
      	 */
-    find<T extends any_>(x: Filter, defs?: Definitions<T>): T | undefined
+    find<T extends any__2>(x: Filter, defs?: Definitions<T>): T | undefined
 
     /**
      	 * Calls the visitor for each definition matching the given filter.
@@ -1800,7 +1829,7 @@ interface LinkedCSN extends Omit<csn.CSN, 'definitions'> {
      	 * @param parent - either the parent itself or its fully-qualified name
      	 * @param filter - an optional filter to apply before picking a child
      	 */
-    childrenOf(parent: any | string, filter?: ((def: any_) => boolean)): Definitions
+    childrenOf(parent: any | string, filter?: ((def: any__2) => boolean)): Definitions
 
     /**
      	 * Provides convenient access to the model's top-level definitions.
@@ -1818,13 +1847,16 @@ interface LinkedCSN extends Omit<csn.CSN, 'definitions'> {
      	 * SELECT.from (Books) .where ({ID:11})
      	 * ```
      	 */
-    exports: IterableMap<any_>
-    definitions: IterableMap<any_>
-    entities: ModelPart<entity>
+    exports: IterableMap<any__2>
+    definitions: IterableMap<any__2>
+    entities: ModelPartFn<entity>
     services: ModelPart<service_>
 
 }
 
+/** @private */
+export type list = { list: any[] }
+
 /**
  * Shortcut for `cds.get(files, 'inferred')`
  * @param files - filenames of models or if folder containing models
@@ -1995,6 +2027,7 @@ export type Middlewares = 'context' | 'trace' | 'auth' | 'ctx_model' | string
 
 export const middlewares: {
     add: (middleware: import('express').RequestHandler, pos?: XOR<XOR<{ at: number }, { after: Middlewares }>, { before: Middlewares }>) => void,
+    before: import('express').RequestHandler[],
 };
 
 /**
@@ -2040,7 +2073,12 @@ function mixin (...classes: (new () => any)[]): void
  */
 export let model: linked_2.LinkedCSN | undefined;
 
-type ModelPart<T extends any_> = IterableMap<T> & ((namespace: string) => IterableMap<T>)
+type ModelPart<T extends any__2> = IterableMap<T> & {
+    /** @deprecated undocumented variant that will be removed in cds^10 */
+    (namespace: string): IterableMap<T>,
+}
+
+type ModelPartFn<T extends any__2> = IterableMap<T> & ((namespace: string) => IterableMap<T>)
 
 namespace models {
     export {
@@ -2135,7 +2173,7 @@ export function on (event: 'connect', listener: (srv: Service) => void): _cds
 export function on (event: 'bootstrap', listener: (app: import('express').Application) => void): _cds
 
 /**
- 	 * Emitted before the model is compiled for usage in Node.js or Java runtime.
+ 	 * Emitted  the model is compiled for usage in Node.js or Java runtime.
  	 * @beta
  	 */
 export function on (event: 'compile.for.runtime', listener: (model: CSN) => void): _cds
@@ -2246,6 +2284,11 @@ type PK = number | string | object
 
 type PluralInstanceType<T extends Constructable> = Array<InstanceType<T>>
 
+export type PostRequest<
+D = any,
+P extends Record<string, any>[] = Record<string, any>[]
+> = Request_2<D, P>;
+
 export type predicate = _xpr
 
 type Primitive = string | number | boolean | Date
@@ -2337,8 +2380,6 @@ type Query_2 = CQN.Query
 
 export class QueryAPI {
 
-    entities: linked_2.LinkedCSN['entities']
-
     /**
      * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
      */
@@ -2460,9 +2501,24 @@ export class RemoteService extends Service {}
 /**
  * @see [capire docs](https://cap.cloud.sap/docs/node.js/events)
  */
-class Request_2<T = any> extends Event_2<T> {
+class Request_2<
+D = any,
+P extends Record<string, any>[] = Record<string, any>[]
+> extends Event_2<D> {
+
+    messages: {message: string, numericSeverity: levels}[]
+
+    errors: {
+        code?: number,
+        message: string,
+        stack: string,
+        target?: string,
+        args?: unknown[],
+    }[]
 
-    params: Record<string, any>[]
+    results: D[]
+
+    params: P
 
     method: string
 
@@ -2484,45 +2540,38 @@ class Request_2<T = any> extends Event_2<T> {
     /** @beta */
     reply (results: any, options: { mimetype?: string, filename?: string, [key: string]: any }): void
 
-    notify (code: number, message: string, target?: string, args?: any[]): Error
-
-    info (code: number, message: string, target?: string, args?: any[]): Error
-
-    warn (code: number, message: string, target?: string, args?: any[]): Error
-
-    error (code: number, message: string, target?: string, args?: any[]): Error
-
-    reject (code: number, message: string, target?: string, args?: any[]): never
-
-    notify (code: number, message: string, args?: any[]): Error
-
-    info (code: number, message: string, args?: any[]): Error
-
-    warn (code: number, message: string, args?: any[]): Error
-
-    error (code: number, message: string, args?: any[]): Error
-
-    reject (code: number, message: string, args?: any[]): never
-
+    // positional args
     notify (message: string, target?: string, args?: any[]): Error
+    notify (status: number, message?: string, target?: string, args?: any[]): Error
 
     info (message: string, target?: string, args?: any[]): Error
+    info (status: number, message?: string, target?: string, args?: any[]): Error
 
     warn (message: string, target?: string, args?: any[]): Error
+    warn (status: number, message?: string, target?: string, args?: any[]): Error
 
     error (message: string, target?: string, args?: any[]): Error
+    error (status: number, message?: string, target?: string, args?: any[]): Error
+    error (status: number, target?: string, args?: any[]): Error
 
     reject (message: string, target?: string, args?: any[]): never
+    reject (status: number, message?: string, target?: string, args?: any[]): never
 
-    notify (message: { code?: number | string, message: string, target?: string, args?: any[] }): Error
+    // single object arg
+    notify (message: { status?: number, code?: number | string, message: string, target?: string, args?: any[] }): Error
+    notify (message: { status?: number, code: number | string, message?: string, target?: string, args?: any[] }): Error
 
-    info (message: { code?: number | string, message: string, target?: string, args?: any[] }): Error
+    info (message: { status?: number, code?: number | string, message: string, target?: string, args?: any[] }): Error
+    info (message: { status?: number, code: number | string, message?: string, target?: string, args?: any[] }): Error
 
-    warn (message: { code?: number | string, message: string, target?: string, args?: any[] }): Error
+    warn (message: { status?: number, code?: number | string, message: string, target?: string, args?: any[] }): Error
+    warn (message: { status?: number, code: number | string, message?: string, target?: string, args?: any[] }): Error
 
-    error (message: { code?: number | string, message: string, target?: string, args?: any[], status?: number }): Error
+    error (message: { status?: number, code?: number | string, message: string, target?: string, args?: any[] }): Error
+    error (message: { status?: number, code: number | string, message?: string, target?: string, args?: any[] }): Error
 
-    reject (message: { code?: number | string, message: string, target?: string, args?: any[], status?: number }): never
+    reject (message: { status?: number, code?: number | string, message: string, target?: string, args?: any[] }): never
+    reject (message: { status?: number, code: number | string, message?: string, target?: string, args?: any[] }): never
 
 }
 export { Request_2 as Request }
@@ -2618,24 +2667,25 @@ class SELECT_3<T, Q = SELECT_from> extends ConstructedQuery<T> {
     }
 
     /**
-     * If a parameter is given, the raw data stream is piped into it.
-     *
-     * If no parameter is given, the raw data stream is returned.
+     * Pipes the raw data stream into the given writable stream.
      * @param stream the writable stream to pipe the raw data into
      * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-ql#pipeline)
      * @since 9.3.0
      */
     pipeline(stream: import('node:stream').Writable): Promise<void>
     /**
-     * If a parameter is given, the raw data stream is piped into it.
-     *
-     * If no parameter is given, the raw data stream is returned.
-     * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-ql#pipeline)
-     * @since 9.3.0
-     * @returns Readable
+     * @deprecated use `.stream()` instead
      */
     pipeline(): Promise<import('node:stream').Readable>
 
+    /**
+     * Returns the raw data stream.
+     * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-ql#stream)
+     * @since 9.4.0
+     * @returns Readable
+     */
+    stream(): Promise<import('node:stream').Readable>
+
     /**
      * Calls the given callback function for each row in the result set.
      * @param cb the callback function to call for each row
@@ -2777,11 +2827,18 @@ export class Service extends QueryAPI {
     types: linked_2.ModelPart<linked_2.classes.type>
 
     /**
+     * @deprecated use {@link actions} instead
      * Provides access to the operations, i.e. actions and functions, exposed by a service
      * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
      */
     operations: linked_2.ModelPart<linked_2.classes.action>
 
+    /**
+     * Provides access to the actions and functions, exposed by a service
+     * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
+     */
+    actions: linked_2.ModelPart<linked_2.classes.action>
+
     /**
      * 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.
@@ -2950,7 +3007,7 @@ class service_ extends context_ {
     get protocols (): { [protocol in Protocol]?: boolean | undefined }
 }
 
-interface service_2 extends any__2 { }
+interface service_2 extends any_ { }
 
 export interface ServiceImpl {
     (this: Service, srv: Service): any
@@ -3189,9 +3246,9 @@ export interface type extends Omit<csn.type, 'items'> {
     virtual?: boolean
 }
 
-export class type<K extends kinds = 'type'> extends any_<K> { }
+export class type<K extends kinds = 'type'> extends any__2<K> { }
 
-interface type_2 extends any__2 {
+interface type_2 extends any_ {
     type?: 'cds.Boolean' |
     'cds.UUID' | 'cds.String' | 'cds.LargeString' | 'cds.Binary' | 'cds.LargeBinary' | 'cds.Vector' |
     'cds.Integer' | 'cds.UInt8' | 'cds.Int16' | 'cds.Int32' | 'cds.Int64' | 'cds.Double' | 'cds.Decimal' |
@@ -3493,7 +3550,7 @@ class Vector extends Binary { }
 
 export const version: string;
 
-type Visitor = (def: any_, name: string, parent: any_, defs: Definitions) => void
+type Visitor = (def: any__2, name: string, parent: any__2, defs: Definitions) => void
 
 interface Where<T> {
     where: HavingWhere<this, T>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-types",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "Type definitions for main packages of CAP, like `@sap/cds`",
   "repository": "github:cap-js/cds-types",
   "homepage": "https://cap.cloud.sap/",