@cap-js/cds-types 0.2.0 → 0.3.0-beta.1

package/apis/services.d.ts

@@ -1,449 +0,0 @@
-/* eslint-disable @typescript-eslint/ban-types */
-import { SELECT, INSERT, UPDATE, DELETE, Query, ConstructedQuery, UPSERT } from './ql'
-import { Awaitable } from './ql'
-import { ArrayConstructable, Constructable } from './internal/inference'
-import { LinkedCSN, LinkedDefinition, Definitions as LinkedDefinitions, LinkedEntity } from './linked'
-import { CSN } from './csn'
-import { EventContext } from './events'
-import { Request } from './events'
-import { ReadableStream } from 'node:stream/web'
-
-type Key = number | string | any
-
-export class QueryAPI {
-
-  entities: LinkedCSN['entities']
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
-   */
-  read: {
-    <T extends ArrayConstructable>(entity: T, key?: Key): Awaitable<SELECT<T>, InstanceType<T>>,
-    <T>(entity: LinkedDefinition | string, key?: Key): SELECT<T>,
-  }
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
-   */
-  create: {
-    <T extends ArrayConstructable>(entity: T, key?: Key): INSERT<T>,
-    <T>(entity: LinkedDefinition | string, key?: Key): INSERT<T>,
-  }
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
-   */
-  insert: {
-    <T extends ArrayConstructable>(data: T): INSERT<T>,
-    <T>(data: object | object[]): INSERT<T>,
-  }
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
-   */
-  upsert: {
-    <T extends ArrayConstructable>(data: T): UPSERT<T>,
-    <T>(data: object | object[]): UPSERT<T>,
-  }
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
-   */
-  update: {
-    <T extends ArrayConstructable>(entity: T, key?: Key): UPDATE<T>,
-    <T>(entity: LinkedDefinition | string, key?: Key): UPDATE<T>,
-  }
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
-   */
-  run: {
-    (query: ConstructedQuery | ConstructedQuery[]): Promise<ResultSet | any>,
-    (query: Query): Promise<ResultSet | any>,
-    (query: string, args?: any[] | object): Promise<ResultSet | any>,
-  }
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#srv-stream-column)
-   */
-  stream: {
-    (column: string): {
-      from(entity: LinkedDefinition | string): {
-        where(filter: any): ReadableStream,
-      },
-    },
-    (query: Query): Promise<ReadableStream>,
-  }
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#crud-style-api)
-   */
-  delete<T>(entity: LinkedDefinition | string, key?: Key): DELETE<T>
-
-  /**
-   * @see [docs](https://cap.cloud.sap/docs/node.js/core-services#srv-foreach-entity)
-   */
-  foreach (query: Query, callback: (row: object) => void): this
-  transaction: {
-    (fn: (tx: Transaction) => object): Promise<any>,
-    (context?: object): Transaction,
-    (context: object, fn: (tx: Transaction) => object): Promise<any>,
-  }
-
-}
-
-
-/**
- * Class cds.Service
- * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
- */
-export class Service extends QueryAPI {
-
-  constructor (
-    name?: string,
-    model?: CSN,
-    options?: {
-      kind: string,
-      impl: string | ServiceImpl,
-    }
-  )
-
-  /**
-   * The kind of the service
-   */
-  kind: string
-
-  /**
-   * The name of the service
-   */
-  name: string
-
-  /**
-   * The model from which the service's definition was loaded
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
-   */
-  model: LinkedCSN
-
-  /**
-   * Provides access to the entities exposed by a service
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
-   */
-  entities: LinkedDefinitions & ((namespace: string) => LinkedDefinitions)
-
-  /**
-   * Provides access to the events declared by a service
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
-   */
-  events: LinkedDefinitions & ((namespace: string) => LinkedDefinitions)
-
-  /**
-   * Provides access to the types exposed by a service
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
-   */
-  types: LinkedDefinitions & ((namespace: string) => LinkedDefinitions)
-
-  /**
-   * 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: LinkedDefinitions & ((namespace: string) => LinkedDefinitions)
-
-  /**
-   * 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.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#srv-init)
-   */
-  init (): Promise<void>
-
-  /**
-   * Constructs and emits an asynchronous event.
-   * @see [capire docs](https://cap.cloud.sap/docs/core-services#srv-emit-event)
-   */
-  emit: {
-    <T = any>(details: { event: types.event, data?: object, headers?: object }): Promise<T>,
-    <T = any>(event: types.event, data?: object, headers?: object): Promise<T>,
-  }
-
-  /**
-   * Constructs and sends a synchronous request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#srv-send-request)
-   */
-  send: {
-    <T = any>(event: types.event, path: string, data?: object, headers?: object): Promise<T>,
-    <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>(details: { query: ConstructedQuery, data?: object, headers?: object }): Promise<T>,
-    <T = any>(details: { method: types.eventName, path: string, data?: object, headers?: object }): Promise<T>,
-    <T = any>(details: { event: types.eventName, entity: LinkedDefinition | string, data?: object, params?: object, headers?: object }): Promise<T>,
-  }
-
-  /**
-   * Constructs and sends a GET request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#rest-style-api)
-   */
-  get<T = any>(entityOrPath: types.target, data?: object): Promise<T>
-
-  /**
-   * Constructs and sends a POST request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#rest-style-api)
-   */
-  post<T = any>(entityOrPath: types.target, data?: object): Promise<T>
-
-  /**
-   * Constructs and sends a PUT request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#rest-style-api)
-   */
-  put<T = any>(entityOrPath: types.target, data?: object): Promise<T>
-
-  /**
-   * Constructs and sends a PATCH request.
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services#rest-style-api)
-   */
-  patch<T = any>(entityOrPath: types.target, data?: object): Promise<T>
-
-  /**
-   * Constructs and sends a DELETE request.
-   */
-  delete: {
-    <T = any>(entityOrPath: types.target, data?: object): DELETE<T>,
-    <T extends ArrayConstructable>(entity: T, key?: Key): DELETE<T>,
-    <T>(entity: LinkedDefinition | string, key?: Key): DELETE<T>,
-  }
-
-  // The central method to dispatch events
-  dispatch (msg: types.event): Promise<any>
-
-  // FIXME: not yet documented, will come in future version
-  // disconnect (tenant?: string): Promise<void>
-
-  // Provider API
-  prepend (fn: ServiceImpl): Promise<this>
-
-  on<T extends Constructable>(eve: types.event, entity: T, handler: CRUDEventHandler.On<InstanceType<T>, InstanceType<T> | void | Error>): this
-
-  on<F extends CdsFunction>(boundAction: F, service: string, handler: ActionEventHandler<F['__parameters'], void | Error | F['__returns']>): this
-
-  on<F extends CdsFunction>(unboundAction: F, handler: ActionEventHandler<F['__parameters'], void | Error | F['__returns']>): this
-
-  on (eve: types.event, entity: types.target, handler: OnEventHandler): this
-
-  on (eve: types.event, handler: OnEventHandler): this
-
-  on (eve: 'error', handler: OnErrorHandler): this
-
-
-  // onSucceeded (eve: types.Events, entity: types.Target, handler: types.EventHandler): this
-  // onSucceeded (eve: types.Events, handler: types.EventHandler): this
-  // onFailed (eve: types.Events, entity: types.Target, handler: types.EventHandler): this
-  // onFailed (eve: types.Events, handler: types.EventHandler): this
-  before<T extends Constructable>(eve: types.event, entity: T, handler: CRUDEventHandler.Before<InstanceType<T>, InstanceType<T> | void | Error>): this
-
-  before (eve: types.event, entity: types.target, handler: EventHandler): this
-
-  before (eve: types.event, handler: EventHandler): this
-
-  after<T extends Constructable>(eve: types.event, entity: T, handler: CRUDEventHandler.After<InstanceType<T>, InstanceType<T> | void | Error>): this
-
-  after (eve: types.event, entity: types.target, handler: ResultsHandler): this
-
-  after (eve: types.event, handler: ResultsHandler): this
-
-  reject (eves: types.event, ...entity: types.target[]): this
-
-}
-
-export class ApplicationService extends Service {}
-export class MessagingService extends Service {}
-export class RemoteService extends Service {}
-export class DatabaseService extends Service {
-
-  deploy (model?: CSN | string): Promise<CSN>
-
-  begin (): Promise<void>
-
-  commit (): Promise<void>
-
-  rollback (): Promise<void>
-
-}
-
-
-export default class cds {
-
-
-  /**
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/core-services)
-   */
-  Service: typeof Service
-
-  /**
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/app-services)
-   */
-  ApplicationService: typeof ApplicationService
-
-  /**
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/remote-services)
-   */
-  RemoteService: typeof RemoteService
-
-  /**
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/messaging)
-   */
-  MessagingService: typeof MessagingService
-
-  /**
-   * @see [capire docs](https://cap.cloud.sap/docs/node.js/databases)
-   */
-  DatabaseService: typeof DatabaseService
-
-}
-
-
-export interface Transaction extends Service {
-  commit(): Promise<void>
-  rollback(): Promise<void>
-}
-
-interface ResultSet extends Array<object> {}
-
-interface ServiceImpl {
-  (this: Service, srv: Service): any
-}
-
-interface EventHandler {
-  // (msg : types.EventMessage) : Promise<any> | any | void
-  (req: Request): Promise<any> | any | void
-}
-
-interface OnEventHandler {
-  (req: Request, next: Function): Promise<any> | any | void
-}
-
-interface OnErrorHandler {
-  (err: Error, req: Request): any | void
-}
-
-// `Partial` wraps any type and allows all properties to be undefined
-// in addition to their actual type.
-// This is important in the context of CRUD events, where
-// entities could be lacking any properties, like a non-existing ID
-// or when DB fields are corrupted, etc.
-type Partial<T> = { [Key in keyof T]: undefined | T[Key] }
-
-// Naming the first parameter in a handler `each` has special voodoo
-// semantic which makes it impossible for us to infer the exact behaviour on a type level.
-// So we always have to expect scalars as well as arrays in some callbacks.
-type OneOrMany<T> = T | T[]
-
-// functions generated by cds-typer explicitly carry types for
-// parameters and return type, as their names are not accessible from
-// function signatures to the type system.
-// This meta information is required in .on action handlers.
-type CdsFunction = {
-  (...args: any[]): any,
-  __parameters: object,
-  __returns: any,
-}
-
-type TypedRequest<T> = Omit<Request, 'data'> & { data: T }
-
-// https://cap.cloud.sap/docs/node.js/core-services#srv-on-before-after
-declare namespace CRUDEventHandler {
-  type Before<P, R> = (req: TypedRequest<P>) => Promise<R> | R
-  type On<P, R> = (req: TypedRequest<P>, next: (...args: any[]) => Promise<R> | R) => Promise<R> | R
-  type After<P, R> = (data: undefined | P, req: TypedRequest<P>) => Promise<R> | R
-}
-
-// Handlers for actions try to infer the passed .data property
-// as strictly as possible and therefore have to remove
-// { data: any } (inherited EventMessage} with a more restricted
-// type, based on the parameters of the action.
-interface ActionEventHandler<P, R> {
-  (req: Omit<Request, 'data'> & { data: P }, next: Function): Promise<R> | R
-}
-
-// Note: the behaviour of ResultsHandler changes based on the name of the parameter.
-// If the parameter in the hook is called "each", it is called once for each row in the result,
-// otherwise it gets called exactly one time with the entire result.
-// This runtime behaviour can not be described on type level
-// (in a way that would benefit the user).
-// The user will therefore receive "any" as their result/ each. If we could some day differentiate,
-// we may want to add a generic to ResultsHandler which is passed from the EventHandlers down below.
-interface ResultsHandler {
-  (results: any[], req: Request): void
-  (each: any, req: Request): void
-}
-
-interface SpawnEvents {
-  succeeded: (res: any) => void
-  failed: (error: any) => void
-  done: () => void
-}
-
-declare class SpawnEventEmitter {
-
-  on<U extends keyof SpawnEvents>(
-    event: U, listener: SpawnEvents[U]
-  ): this
-
-  emit<U extends keyof SpawnEvents>(
-    event: U, ...args: Parameters<SpawnEvents[U]>
-  ): boolean
-  timer: any
-
-}
-
-declare namespace types {
-  type event = eventName | eventName[]
-  type eventName = string
-    | 'CREATE' | 'READ' | 'UPDATE' | 'DELETE'
-    | 'NEW' | 'EDIT' | 'PATCH' | 'SAVE'
-    | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
-    | 'COMMIT' | 'ROLLBACK'
-  type target = string | LinkedDefinition | LinkedEntity | (string | LinkedDefinition | LinkedEntity)[] | ArrayConstructable
-}
-
-type SpawnOptions = {
-  [key: string]: any,
-  every?: number,
-  after?: number,
-}
-
-// FIXME: this was ?: EventContext before. Is context supposed to not be present sometimes?
-// let, as apparently we can reassign?
-/**
- * @see [docs](https://cap.cloud.sap/docs/node.js/cds-tx#event-contexts
- */
-export let context: EventContext | undefined
-
-/**
-* @see [docs](https://cap.cloud.sap/docs/node.js/cds-tx#cds-spawn)
-*/
-export function spawn (options: SpawnOptions, fn: (tx: Transaction) => object): SpawnEventEmitter
-
-
-// facade proxies into cds.db, which is a Service
-/**
-* Starts or joins a transaction
-* @see [docs](https://cap.cloud.sap/docs/node.js/cds-tx)
-*/
-export const tx: {
-  (fn: (tx: Transaction) => object): Promise<any>,
-  (context?: object): Transaction,
-  (context: object, fn: (tx: Transaction) => object): Promise<any>,
-}
-export const entities: Service['entities']
-export const run: Service['run']
-export const foreach: Service['foreach']
-export const stream: Service['stream']
-export const read: Service['read']
-export const create: Service['create']
-export const insert: Service['insert']
-export const update: Service['update']
-// temporarily moved to cds.d.ts, as "delete" is a reserved keyword
-// export const delete: Service['delete']
-// FIXME: see Service.disconnect comment
-// export const disconnect: Service['disconnect']
-export const transaction: Service['transaction']
-export const db: DatabaseService
-// export const upsert: Service['upsert']

package/apis/test.d.ts

@@ -1,112 +0,0 @@
-import { AxiosInstance } from 'axios'
-import chai from 'chai'
-import * as http from 'http'
-import { Service } from './services'
-import * as cds from './cds'
-
-type _cds = typeof cds
-
-declare class Axios {
-
-  get axios (): AxiosInstance
-  get: AxiosInstance['get'];
-
-  put: AxiosInstance['put']
-
-  post: AxiosInstance['post']
-
-  patch: AxiosInstance['patch']
-
-  delete: AxiosInstance['delete']
-
-  options: AxiosInstance['options']
-
-  get GET (): Axios['get']
-
-  get PUT (): Axios['put']
-
-  get POST (): Axios['post']
-
-  get PATCH (): Axios['patch']
-
-  get DELETE (): Axios['delete']
-
-  get OPTIONS (): Axios['options']
-
-}
-
-declare class DataUtil {
-
-  delete (db?: Service): Promise<void>
-
-  reset (db?: Service): Promise<void>
-
-  /**
-   * @deprecated if needed, call `reset()`, considering test performance
-   */
-  autoReset (enabled: boolean): this
-
-}
-
-declare class Test extends Axios {
-
-  test: Test
-
-  run (cmd: string, ...args: string[]): this
-
-  in (...paths: string[]): this
-
-  silent (): this
-
-  /**
-   * @deprecated Server log is shown by default. Use `log()` to get control over it.
-   */
-  verbose (v: boolean): this
-
-  get chai (): typeof chai
-
-  get expect (): typeof chai.expect
-
-  get assert (): typeof chai.assert
-
-  get data (): DataUtil
-
-  get cds (): _cds
-
-  log (): {
-    output: string,
-    clear(): void,
-    release(): void,
-  }
-
-  then (r: (args: { server: http.Server, url: string }) => void): void
-
-  // get sleep(): (ms: number) => Promise<void>;
-  // get spy(): <T, K extends keyof T>(o: T, f: K) => T[K] extends (...args: infer TArgs) => infer TReturnValue
-  //   ? Spy<TArgs, TReturnValue>
-  //   : Spy;
-
-}
-
-// typings for spy inspired by @types/sinon
-// interface Spy<TArgs extends any[] = any[], TReturnValue = any> {
-//   (...args: TArgs): TReturnValue;
-//   called: number;
-//   restore(): (...args: TArgs) => TReturnValue;
-// }
-
-declare const test: {
-  Test: typeof Test,
-
-  /**
-     * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-test#class-cds-test-test)
-     */
-  (dirname: string): Test,
-
-  /**
-     * @see [capire docs](https://cap.cloud.sap/docs/node.js/cds-test#class-cds-test-test)
-     */
-  (command: string, ...args: string[]): Test,
-
-  in (dirname: string): Test,
-}

package/apis/utils.d.ts

@@ -1,90 +0,0 @@
-import * as fs from 'node:fs'
-
-/**
- * Provides a set of utility functionss
- */
-declare const utils: {
-
-  /**
-	 * Generates a new v4 UUID
-	 * @see https://cap.cloud.sap/docs/node.js/cds-facade#cds-utils
-	 */
-  uuid (): string,
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#decodeuri
-	 */
-  decodeURI(input: string): string,
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#decodeuricomponent
-	 */
-  decodeURIComponent(input: string): string,
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#local-filename
-	 */
-  local(filename: string): string,
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#exists-file
-	 */
-  exist(file: string): boolean,
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#isdir-file
-	 */
-  isdir(file: string): string,
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#isdir-file
-	 */
-  isfile(file: string): string,
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-read-file
-	 */
-  read(file: string): Promise<Buffer | object>,
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-write-data-to-file
-	 */
-  write: {
-    (data: object): {
-      to(...file: string[]): Promise<ReturnType<typeof fs.promises.writeFile>>,
-    },
-    (file: string, data: object): Promise<ReturnType<typeof fs.promises.writeFile>>,
-  },
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-copy-src-to-dst
-	 */
-  copy: {
-    (src: string): {
-      to(...dst: string[]): Promise<ReturnType<typeof fs.promises.copyFile>>,
-    },
-    (dst: string, src: string): Promise<ReturnType<typeof fs.promises.copyFile>>,
-  },
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-mkdirp-path
-	 */
-  mkdirp: (...path: string[]) => Promise<string>,
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-rmdir-path
-	 */
-  rmdir: (...path: string[]) => Promise<ReturnType<typeof fs.promises.rm>>,
-
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-rimraf-path
-	 */
-  rimraf: (...path: string[]) => Promise<ReturnType<typeof fs.promises.rm>>,
-
-
-  /**
-	 * @see https://cap.cloud.sap/docs/node.js/cds-utils#async-rm-path
-	 */
-  rm: (...path: string[]) => Promise<ReturnType<typeof fs.promises.rm>>,
-}