@cap-js/cds-types 0.9.0 → 0.11.0

package/dist/cds-types.d.ts

@@ -1,5 +1,5 @@
 declare module '@sap/cds' {
-
+
 
 export type __any_ = classes.any_
 
@@ -102,6 +102,11 @@ class any_<K extends kinds = kinds> {
 
 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
 }
 
 /**
@@ -111,7 +116,15 @@ interface any__2 {
  */
 export const app: import('express').Application;
 
-export class ApplicationService extends Service {}
+export class ApplicationService extends Service {
+    new<T extends Constructable>(draft: T, data: {[K in keyof InstanceType<T>]?: InstanceType<T>[K]}): Promise<unknown>
+    new<T extends Constructable>(draft: T): {
+        for(keys: Key[]): Promise<unknown>,
+    }
+    discard(draft: Constructable, keys: Key[]): Promise<unknown>
+    edit(draft: Constructable, keys: Key[]): Promise<unknown>
+    save(draft: Constructable, keys: Key[]): Promise<unknown>
+}
 
 export class array extends type<'type' | 'elements'> { }
 
@@ -214,7 +227,6 @@ export type CDL = string
 
 namespace cds {
     export {
-        default_2 as default,
         log,
         debug,
         test,
@@ -309,6 +321,7 @@ namespace cds {
         spawn,
         Key,
         QueryAPI,
+        PropertiesOf,
         Service,
         ApplicationService,
         MessagingService,
@@ -378,13 +391,197 @@ namespace cds {
         operator,
         function_call,
         enum_literal,
-        expr_literal
+        expr_literal,
+        Texts,
+        I18nBundle,
+        I18nFacade,
+        I18nFilesOptions,
+        I18nFiles,
+        i18n
     }
 }
+export default cds;
 
-export type _cds = typeof cds
+export type _cds = typeof cds_2
 
-type _cds_2 = typeof cds
+namespace cds_2 {
+    export {
+        cds as default,
+        log,
+        debug,
+        test,
+        ql,
+        QLExtensions,
+        csn,
+        delete_ as delete,
+        version,
+        home,
+        root,
+        cli,
+        requires,
+        extend,
+        lazify,
+        lazified,
+        entity,
+        event,
+        type,
+        array,
+        struct,
+        Association,
+        Composition,
+        builtin,
+        on,
+        once,
+        exit,
+        _cds,
+        cds_services,
+        connect,
+        server,
+        serve,
+        services,
+        service,
+        cds_serve_fluent,
+        cds_connect_options,
+        Middlewares,
+        middlewares,
+        app,
+        env,
+        _TODO,
+        get,
+        load,
+        resolve,
+        minify,
+        reflect,
+        _flavor,
+        _odata_options,
+        _options,
+        JSON_2 as JSON,
+        YAML,
+        CDL,
+        SQL,
+        XML,
+        EDM,
+        EDMX,
+        filename,
+        model,
+        parse,
+        linked,
+        __type,
+        __aspect,
+        __any_,
+        __scalar,
+        __Boolean,
+        __UUID,
+        __String,
+        __LargeString,
+        __Binary,
+        __LargeBinary,
+        __Vector,
+        __Integer,
+        __UInt8,
+        __Int16,
+        __Int32,
+        __Int64,
+        __Float,
+        __Double,
+        __Decimal,
+        __date,
+        __Date,
+        __Time,
+        __DateTime,
+        __TimeStamp,
+        __array,
+        __struct,
+        __context_,
+        __service,
+        __entity,
+        __Association,
+        __Composition,
+        compile,
+        spawn,
+        Key,
+        QueryAPI,
+        PropertiesOf,
+        Service,
+        ApplicationService,
+        MessagingService,
+        RemoteService,
+        DatabaseService,
+        Transaction,
+        ResultSet,
+        ServiceImpl,
+        EventHandler,
+        OnEventHandler,
+        OnErrorHandler,
+        Partial_2 as Partial,
+        OneOrMany,
+        CdsFunction,
+        CdsFunctions,
+        HandlerFunction,
+        CRUDEventHandler,
+        ActionEventHandler,
+        ResultsHandler,
+        SpawnEvents,
+        SpawnEventEmitter,
+        types,
+        SpawnOptions,
+        context,
+        tx,
+        entities,
+        run,
+        foreach,
+        stream,
+        read,
+        create,
+        insert,
+        update,
+        transaction,
+        db,
+        outboxed,
+        unboxed,
+        EventContext,
+        Event_2 as Event,
+        Request_2 as Request,
+        User,
+        Anonymous,
+        Privileged,
+        utils,
+        Query,
+        SELECT_2 as SELECT,
+        INSERT_2 as INSERT,
+        UPSERT_2 as UPSERT,
+        UPDATE_2 as UPDATE,
+        DELETE_2 as DELETE,
+        CREATE_2 as CREATE,
+        DROP_2 as DROP,
+        primitive,
+        data,
+        name,
+        source,
+        column_expr,
+        predicate,
+        ordering_term,
+        expr,
+        ref,
+        _segment,
+        _named,
+        val,
+        xpr,
+        _xpr,
+        operator,
+        function_call,
+        enum_literal,
+        expr_literal,
+        Texts,
+        I18nBundle,
+        I18nFacade,
+        I18nFilesOptions,
+        I18nFiles,
+        i18n
+    }
+}
+
+type _cds_2 = typeof cds_2
 
 export interface cds_connect_options {
     impl?: string
@@ -458,6 +655,7 @@ namespace classes {
         TimeStamp,
         array,
         struct,
+        Map_3 as Map,
         context_,
         service_,
         action,
@@ -602,7 +800,7 @@ export const connect: {
      	 * Shortcut for 'db' as the primary database returning `cds.DatabaseService`
      	 * @example await cds.connect.to ('db')
      	*/
-    to(datasource: 'db', options?: cds_connect_options): Promise<cds.DatabaseService>,
+    to(datasource: 'db', options?: cds_connect_options): Promise<cds_2.DatabaseService>,
 
     /**
      	 * Connects to a specific datasource via a Service subclass
@@ -618,7 +816,7 @@ export const connect: {
      	 *   await cds.connect.to (ServiceClass)
      	 * @see [capire](https://cap.cloud.sap/docs/node.js/cds-connect#cds-connect-to)
      	 */
-    to<S>(datasource: S, options?: cds_connect_options): Promise<cds.CdsFunctions<S> & Service>,
+    to<S>(datasource: S, options?: cds_connect_options): Promise<cds_2.CdsFunctions<S> & Service>,
 
     /**
      		 * Connects to a specific datasource via options.
@@ -644,7 +842,7 @@ class ConstructedQuery<T> {
     // that don't make explicit use of the generic. So `UPDATE<Books> !<: UPDATE<number>`
     private _: T
     then (_resolved: (x: any) => any, _rejected: (e: Error) => any): any
-
+    bind (service: Service): this
 }
 
 /**
@@ -760,6 +958,7 @@ namespace csn {
         service_2 as service,
         type_2 as type,
         struct_2 as struct,
+        Map_2 as Map,
         entity_2 as entity,
         EntityElements,
         Association_2 as Association
@@ -817,175 +1016,6 @@ class Decimal extends Float {
     scale?: number
 }
 
-export namespace default_2 {
-    export {
-        log,
-        debug,
-        test,
-        ql,
-        QLExtensions,
-        csn,
-        delete_ as delete,
-        version,
-        home,
-        root,
-        cli,
-        requires,
-        extend,
-        lazify,
-        lazified,
-        entity,
-        event,
-        type,
-        array,
-        struct,
-        Association,
-        Composition,
-        builtin,
-        on,
-        once,
-        exit,
-        _cds,
-        cds_services,
-        connect,
-        server,
-        serve,
-        services,
-        service,
-        cds_serve_fluent,
-        cds_connect_options,
-        Middlewares,
-        middlewares,
-        app,
-        env,
-        _TODO,
-        get,
-        load,
-        resolve,
-        minify,
-        reflect,
-        _flavor,
-        _odata_options,
-        _options,
-        JSON_2 as JSON,
-        YAML,
-        CDL,
-        SQL,
-        XML,
-        EDM,
-        EDMX,
-        filename,
-        model,
-        parse,
-        linked,
-        __type,
-        __aspect,
-        __any_,
-        __scalar,
-        __Boolean,
-        __UUID,
-        __String,
-        __LargeString,
-        __Binary,
-        __LargeBinary,
-        __Vector,
-        __Integer,
-        __UInt8,
-        __Int16,
-        __Int32,
-        __Int64,
-        __Float,
-        __Double,
-        __Decimal,
-        __date,
-        __Date,
-        __Time,
-        __DateTime,
-        __TimeStamp,
-        __array,
-        __struct,
-        __context_,
-        __service,
-        __entity,
-        __Association,
-        __Composition,
-        compile,
-        spawn,
-        Key,
-        QueryAPI,
-        Service,
-        ApplicationService,
-        MessagingService,
-        RemoteService,
-        DatabaseService,
-        Transaction,
-        ResultSet,
-        ServiceImpl,
-        EventHandler,
-        OnEventHandler,
-        OnErrorHandler,
-        Partial_2 as Partial,
-        OneOrMany,
-        CdsFunction,
-        CdsFunctions,
-        HandlerFunction,
-        CRUDEventHandler,
-        ActionEventHandler,
-        ResultsHandler,
-        SpawnEvents,
-        SpawnEventEmitter,
-        types,
-        SpawnOptions,
-        context,
-        tx,
-        entities,
-        run,
-        foreach,
-        stream,
-        read,
-        create,
-        insert,
-        update,
-        transaction,
-        db,
-        outboxed,
-        unboxed,
-        EventContext,
-        Event_2 as Event,
-        Request_2 as Request,
-        User,
-        Anonymous,
-        Privileged,
-        utils,
-        Query,
-        SELECT_2 as SELECT,
-        INSERT_2 as INSERT,
-        UPSERT_2 as UPSERT,
-        UPDATE_2 as UPDATE,
-        DELETE_2 as DELETE,
-        CREATE_2 as CREATE,
-        DROP_2 as DROP,
-        primitive,
-        data,
-        name,
-        source,
-        column_expr,
-        predicate,
-        ordering_term,
-        expr,
-        ref,
-        _segment,
-        _named,
-        val,
-        xpr,
-        _xpr,
-        operator,
-        function_call,
-        enum_literal,
-        expr_literal
-    }
-}
-
 /**
  * Definitions are the central elements of a CDS model.
  */
@@ -1430,8 +1460,57 @@ type HavingWhere<This, E> =
 & ((...expr: string[]) => This)
 & TaggedTemplateQueryPart<This>
 
+interface Hints {
+    hints: ((...hints: string[]) => this)
+    & ((hints: string[]) => this)
+}
+
 export const home: string;
 
+export const i18n: I18nFacade;
+
+export class I18nBundle {
+    constructor(options: I18nFilesOptions)
+    for(key: number | string | object, locale?: string | object, args?: object): string | undefined
+    at(key: number | string | object, locale?: string | object, args?: object): string | undefined
+    files: I18nFiles
+    get defaults(): Record<string, string>
+    get fallback(): Record<string, string>
+    key4(definition: entity): string
+    texts4 (locale: string): Texts
+    translations4 (...locales : string[]) : { [locale: string]: Texts }
+    translations4 (locale : 'all' ) : { [locale: string]: Texts }
+    all () : Record<string, Texts>
+}
+
+export interface I18nFacade {
+    Bundle: typeof I18nBundle
+    Facade: I18nFacade
+    Files: typeof I18nFiles
+    get file(): string
+    get folders(): string[]
+    get labels(): I18nBundle
+    get messages(): I18nBundle
+
+    bundle4 (file: string, options?: I18nFilesOptions): I18nBundle
+    bundle4 (model: csn.CSN): I18nBundle
+}
+
+export class I18nFiles {
+    constructor (options: I18nFilesOptions)
+    get options(): I18nFilesOptions
+    get basename(): string
+    content4(locale: string, suffix: string): Array<object>
+}
+
+export interface I18nFilesOptions {
+    file?    : string   
+    model?   : csn.CSN     
+    roots?   : string[] 
+    leafs?   : string[] 
+    folders? : string[]
+}
+
 export const insert: Service['insert'];
 
 type INSERT_2 = { INSERT: {
@@ -1585,6 +1664,9 @@ export const linked: {
 export namespace linked {
     export type LinkedDefinitions = IterableMap<linked_2.classes.any_>
     export type LinkedCSN = linked_2.LinkedCSN
+    // synthetic class that is prominently featured in capire,
+    // but described as "accessible through cds.linked.classes.any"
+    export type LinkedDefinition = linked_2.classes.any_
 
     export namespace classes {
         export type type = __type
@@ -1874,6 +1956,17 @@ type ManagedAssociation = Association & {
     keys: Column[],
 }
 
+interface Map_2 extends Omit<struct_2, 'includes' | 'items'> {
+    elements: Record<string,never>
+}
+
+/**
+ * @since 8.6.0
+ */
+interface Map_3 extends csn.Map {}
+
+class Map_3 {}
+
 export class MessagingService extends Service {}
 
 export type Middlewares = 'context' | 'trace' | 'auth' | 'ctx_model' | string
@@ -2127,6 +2220,10 @@ export class Privileged extends User {
 
 type Projection<T> = (e: QLExtensions<T extends ArrayConstructable ? SingularInstanceType<T> : T>) => void
 
+export type PropertiesOf<T> = {
+    [K in keyof T]?: T[K];
+};
+
 /**
  * @alpha
  * related to .protocols getters
@@ -2345,7 +2442,7 @@ class Request_2<T = any> extends Event_2<T> {
 
     error (code: number, message: string, target?: string, args?: any[]): Error
 
-    reject (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
 
@@ -2355,7 +2452,7 @@ class Request_2<T = any> extends Event_2<T> {
 
     error (code: number, message: string, args?: any[]): Error
 
-    reject (code: number, message: string, args?: any[]): Error
+    reject (code: number, message: string, args?: any[]): never
 
     notify (message: string, target?: string, args?: any[]): Error
 
@@ -2365,7 +2462,7 @@ class Request_2<T = any> extends Event_2<T> {
 
     error (message: string, target?: string, args?: any[]): Error
 
-    reject (message: string, target?: string, args?: any[]): Error
+    reject (message: string, target?: string, args?: any[]): never
 
     notify (message: { code?: number | string, message: string, target?: string, args?: any[] }): Error
 
@@ -2375,7 +2472,7 @@ class Request_2<T = any> extends Event_2<T> {
 
     error (message: { code?: number | string, message: string, target?: string, args?: any[], status?: number }): Error
 
-    reject (message: { code?: number | string, message: string, target?: string, args?: any[], status?: number }): Error
+    reject (message: { code?: number | string, message: string, target?: string, args?: any[], status?: number }): never
 
 }
 export { Request_2 as Request }
@@ -2437,7 +2534,7 @@ type SELECT_2 = { SELECT: {
     }, }
 export { SELECT_2 as SELECT }
 
-interface SELECT_3<T> extends Where<T>, And, Having<T>, GroupBy, OrderBy<T>, Limit {
+interface SELECT_3<T> extends Where<T>, And, Having<T>, GroupBy, OrderBy<T>, Limit, Hints {
     // overload specific to SELECT
     columns: Columns<T, this>['columns'] & ((projection: Projection<T>) => this)
 }
@@ -2464,17 +2561,6 @@ class SELECT_3<T, Q = SELECT_from> extends ConstructedQuery<T> {
     alias (as: string): this
     elements: EntityElements
 
-
-    // Not yet public
-    // fullJoin (other: string, as: string) : this
-    // leftJoin (other: string, as: string) : this
-    // 	rightJoin (other: string, as: string) : this
-    // 	innerJoin (other: string, as: string) : this
-    // 	join (other: string, as: string, kind?: string) : this
-    // on : TaggedTemplateQueryPart<this>
-    //   & ((...expr : string[]) => this)
-    //   & ((predicate:object) => this)
-
     SELECT: CQN.SELECT['SELECT'] & {
         forUpdate?: { wait: number },
         forShareLock?: { wait: number },
@@ -2624,6 +2710,14 @@ export class Service extends QueryAPI {
      * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#srv-emit-event)
      */
     emit: {
+        // we can only give very little guidance as to code completion here.
+        // Users will receive suggestions/ code completion for the property names of P.
+        // But they will see no complaints for when they pass a non-existing property or use the wrong type for it.
+        // That is because classes still fulfill {name:string}, so they can be used for the overload where event of type types.event,
+        // which allows for any object as data.
+        <P extends Constructable, R>(event: P, data: PropertiesOf<InstanceType<P>>, headers?: object): Promise<R>,
+        <P extends ArrayConstructable, R>(event: P, data: PropertiesOf<SingularInstanceType<P>>, headers?: object): Promise<R>,
+        <T = any>(event: types.event, data?: object, headers?: object): Promise<T>,
         <T = any>(details: { event: types.event, data?: object, headers?: object }): Promise<T>,
         <T = any>(event: types.event, data?: object, headers?: object): Promise<T>,
     }
@@ -2878,6 +2972,8 @@ type Subqueryable<T> = T extends Primitive ? unknown
      	 * Note that you do not need to return anything from these subqueries.
      	 */
     (fn: ((a: QLExtensions<T[number]>) => any) | '*'): T[number],
+    // infix filters, like b.author`[city='Paris']`('*')
+    (predicate: TemplateStringsArray): Subqueryable<T>,
 }
 // composition of one/ association to one
 : {
@@ -2898,6 +2994,8 @@ type Subqueryable<T> = T extends Primitive ? unknown
      	 * Note that you do not need to return anything from these subqueries.
      	 */
     (fn: ((a: QLExtensions<T>) => any) | '*'): T,
+    // infix filters, like b.author`[city='Paris']`('*')
+    (predicate: TemplateStringsArray): Subqueryable<T>,
 }
 
 type TaggedTemplateQueryPart<T> = (strings: TemplateStringsArray, ...params: unknown[]) => T
@@ -2962,6 +3060,8 @@ export const test: {
     log: Test['log'],
 };
 
+export type Texts = Record<string, string>
+
 class Time extends date { }
 
 class TimeStamp extends DateTime { }
@@ -3006,7 +3106,7 @@ interface type_2 extends any__2 {
     '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' |
     'cds.Date' | 'cds.Time' | 'cds.DateTime' | 'cds.Timestamp' |
-    'cds.Association' | 'cds.Composition' |
+    'cds.Association' | 'cds.Composition' | 'cds.Map' |
     FQN & Record<never,never> // allow any other CDS type as well (e.g. 'User')
     items?: type_2
 }
@@ -3226,6 +3326,21 @@ export const utils: {
      	 */
     rm: (...path: string[]) => Promise<ReturnType<typeof import('node:fs').promises.rm>>,
 
+    /**
+     * Shortcut for require("fs")
+     */
+    fs: typeof import('node:fs'),
+
+    /**
+     * Shortcut for require("path")
+     */
+    path: typeof import('node:path'),
+
+    /**
+     * Shortcut for require("util").inspect
+     */
+    inspect: typeof import('node:util').inspect,
+
     /**
      * @since 8.3.0
      * @see https://cap.cloud.sap/docs/node.js/cds-utils#colors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-types",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Type definitions for main packages of CAP, like `@sap/cds`",
   "repository": "github:cap-js/cds-types",
   "homepage": "https://cap.cloud.sap/",
@@ -10,18 +10,25 @@
     "Node.js"
   ],
   "author": "SAP SE (https://www.sap.com)",
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "Apache-2.0",
   "typings": "dist/cds-types.d.ts",
   "files": [
     "dist/",
     "scripts/",
-    "LICENSE",
     "README.md"
   ],
   "scripts": {
-    "test": "jest --silent",
-    "test:integration": "jest --testMatch \"**/test/**/*.integrationtest.js\"",
-    "test:rollup": "npm run rollup; npm run rollup:on; npm run test; npm run rollup:off",
+    "test:integration": "node --test ./test/postinstall.integrationtest.js",
+    "test:runtime": "npm run test:runtime:post-mortem; rm -rf test/typescript/_out",
+    "test:runtime:tsc": "npx tsc test/typescript/runtime.test.ts --outDir test/typescript/_out --target ES2020 --module commonjs --esModuleInterop",
+    "test:runtime:post-mortem": "npm run test:runtime:tsc && node --test './test/typescript/_out/runtime.test.js'",
+    "test:api-calls": "node --test './test/typescript/apis/cds-api-calls.test.js'",
+    "test:typings": "node --test './test/typescript/cds-typings.test.js'",
+    "test:all": "npm run test:runtime && npm run test:api-calls && npm run test:typings",
+    "test:setup": "npm install file:. --no-save --force && npm run prerelease:ci-fix",
+    "test": "npm run test:setup && npm run test:rollup-on",
+    "test:rollup-on": "npm run rollup && npm run rollup:on && npm run test:all --silent",
+    "test:rollup-off": "npm run rollup:off && npm run test:all --silent",
     "rollup": "rm -rf dist/ && mkdir -p etc/ && npx -y @microsoft/api-extractor run --local --verbose && .github/rollup-patch.js",
     "rollup:on": "npm pkg set typings=dist/cds-types.d.ts && [ -d 'apis' ] && mv -- apis -apis || true",
     "rollup:off": "npm pkg set typings=apis/cds.d.ts  && [ -d '-apis' ] && mv -- -apis apis || true",
@@ -33,28 +40,16 @@
     "dependencies": "node ./scripts/postinstall.js"
   },
   "peerDependencies": {
-    "@sap/cds": "^8.0.0",
+    "@sap/cds": ">=8.0.0",
     "@types/express": ">=4"
   },
   "devDependencies": {
-    "@eslint/js": "^9.2.0",
-    "@sap/cds": ">=8.0.0",
-    "@stylistic/eslint-plugin-js": "^2.1.0",
-    "@stylistic/eslint-plugin-ts": "^2.1.0",
-    "@types/jest": "^29.5.11",
-    "@types/node": "^22",
+    "@cap-js/cds-test": "^0",
+    "@stylistic/eslint-plugin-js": "^4.0.1",
+    "@stylistic/eslint-plugin-ts": "^4.0.1",
     "axios": "^1.6.2",
-    "chai": "^4.3.10",
     "eslint": "^9.2.0",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.1.1",
     "typescript": "^5.4.5",
-    "typescript-eslint": "^8.0.0-alpha.51",
-    "winston": "^3.13.0"
-  },
-  "jest": {
-    "transform": {
-      "^.+\\.(ts|tsx)$": "ts-jest"
-    }
+    "typescript-eslint": "^8.0.0-alpha.51"
   }
 }