@cap-js/cds-types 0.10.0 → 0.12.0

package/dist/cds-types.d.ts

@@ -1,5 +1,6 @@
 declare module '@sap/cds' {
-
+export * from "@sap/cds-dk";
+
 
 export type __any_ = classes.any_
 
@@ -102,6 +103,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 +117,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 +228,6 @@ export type CDL = string
 
 namespace cds {
     export {
-        default_2 as default,
         log,
         debug,
         test,
@@ -309,6 +322,7 @@ namespace cds {
         spawn,
         Key,
         QueryAPI,
+        PropertiesOf,
         Service,
         ApplicationService,
         MessagingService,
@@ -387,10 +401,188 @@ namespace cds {
         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
@@ -609,7 +801,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
@@ -625,7 +817,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.
@@ -825,181 +1017,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,
-        Texts,
-        I18nBundle,
-        I18nFacade,
-        I18nFilesOptions,
-        I18nFiles,
-        i18n
-    }
-}
-
 /**
  * Definitions are the central elements of a CDS model.
  */
@@ -1169,7 +1186,6 @@ export namespace env {
         [key: string]: MockUser | undefined
     }
 
-    /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
     export type Requires = {
         auth: {
             kind: 'dummy' | 'mocked' | 'basic' | 'xsuaa' | 'ias' | string,
@@ -1503,7 +1519,7 @@ type INSERT_2 = { INSERT: {
         columns: string[],
         values: primitive[],
         rows: primitive[][],
-        as: SELECT_2,
+        from: SELECT_2,
     }, }
 export { INSERT_2 as INSERT }
 
@@ -1520,10 +1536,6 @@ class INSERT_3<T> extends ConstructedQuery<T> {
     & (<T> (entity: Constructable<T>, ...entries: T[]) => INSERT_3<T>)
     & (<T> (entity: Constructable<T>, entries?: T[]) => INSERT_3<T>)
 
-    /**
-     * @deprected
-     */
-    as (select: SELECT_3<T>): this
     from (select: SELECT_3<T>): this
     INSERT: CQN.INSERT['INSERT']
 
@@ -1648,6 +1660,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
@@ -2201,6 +2216,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
@@ -2391,7 +2410,7 @@ export class RemoteService extends Service {}
  */
 class Request_2<T = any> extends Event_2<T> {
 
-    params: (string | object)[]
+    params: Record<string, any>[]
 
     method: string
 
@@ -2410,6 +2429,8 @@ class Request_2<T = any> extends Event_2<T> {
     subject: ref
 
     reply (results: any): void
+    /** @beta */
+    reply (results: any, options: { mimetype?: string, filename?: string, [key: string]: any }): void
 
     notify (code: number, message: string, target?: string, args?: any[]): Error
 
@@ -2419,7 +2440,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
 
@@ -2429,7 +2450,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
 
@@ -2439,7 +2460,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
 
@@ -2449,7 +2470,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 }
@@ -2538,17 +2559,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 },
@@ -2698,6 +2708,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>,
     }
@@ -2952,6 +2970,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
 : {
@@ -2972,6 +2992,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
@@ -3302,6 +3324,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.10.0",
+  "version": "0.12.0",
   "description": "Type definitions for main packages of CAP, like `@sap/cds`",
   "repository": "github:cap-js/cds-types",
   "homepage": "https://cap.cloud.sap/",
@@ -29,7 +29,7 @@
     "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": "rm -rf dist/ && mkdir -p etc/ && .github/api-extractor/run-api-extractor.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",
     "lint": "npx eslint .",
@@ -40,11 +40,13 @@
     "dependencies": "node ./scripts/postinstall.js"
   },
   "peerDependencies": {
-    "@sap/cds": ">=8.0.0",
+    "@sap/cds": ">=9.0.0",
+    "@sap/cds-dk": "^9",
     "@types/express": ">=4"
   },
   "devDependencies": {
     "@cap-js/cds-test": "^0",
+    "@microsoft/api-extractor": "^7.52.8",
     "@stylistic/eslint-plugin-js": "^4.0.1",
     "@stylistic/eslint-plugin-ts": "^4.0.1",
     "axios": "^1.6.2",