@dbos-inc/dbos-sdk 3.0.27-preview → 3.0.29-preview

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbos-inc/dbos-sdk",
-  "version": "3.0.27-preview",
+  "version": "3.0.29-preview",
   "description": "A Typescript framework built on the database",
   "license": "MIT",
   "repository": {

package/dist/src/eventreceiver.d.ts

@@ -1,152 +0,0 @@
-import { Tracer } from './telemetry/traces';
-import { GlobalLogger } from './telemetry/logs';
-import type { GetQueuedWorkflowsInput, GetWorkflowsInput, StepInfo, WorkflowHandle, WorkflowParams, WorkflowStatus } from './workflow';
-import type { MethodRegistrationBase } from './decorators';
-import type { Notification } from 'pg';
-export type DBNotification = Notification;
-export type DBNotificationCallback = (n: DBNotification) => void;
-export interface DBNotificationListener {
-    close(): Promise<void>;
-}
-/**
- * Interface for registration information provided to `DBOSEventReceiver`
- *  instances about each method and containing class.  This contains any
- *  information stored by the decorators that registered the method with
- *  its event receiver.
- */
-export interface DBOSEventReceiverRegistration {
-    /** Method-level configuration information, as stored by the event receiver's decorators (or other registration mechanism) */
-    methodConfig: unknown;
-    /** Class-level configuration information, as stored by the event receiver's decorators (or other registration mechanism) */
-    classConfig: unknown;
-    /** Method to dispatch, and associated DBOS registration information */
-    methodReg: MethodRegistrationBase;
-}
-export interface DBOSExecutorContext {
-    /** Logging service; @deprecated: Use `DBOS.logger` instead. */
-    readonly logger: GlobalLogger;
-    /** Tracing service; @deprecated: Use `DBOS.tracer` instead.  */
-    readonly tracer: Tracer;
-    /** @deprecated */
-    getConfig<T>(key: string): T | undefined;
-    /** @deprecated */
-    getConfig<T>(key: string, defaultValue: T): T;
-    /**
-     * Get the registrations for a receiver
-     * @param eri - all registrations for this `DBOSEventReceiver` will be returned
-     * @returns array of all methods registered for the receiver, including:
-     *  methodConfig: the method info the receiver stored
-     *  classConfig: the class info the receiver stored
-     *  methodReg: the method registration (w/ workflow, transaction, function, and other info)
-     */
-    getRegistrationsFor(eri: DBOSEventReceiver): DBOSEventReceiverRegistration[];
-    /**
-     * Invoke a transaction function.
-     *  Note that functions can be called directly instead of using this interface.
-     */
-    transaction<T extends unknown[], R>(txn: (...args: T) => Promise<R>, params: WorkflowParams, ...args: T): Promise<R>;
-    /**
-     * Invoke a workflow function.
-     *  Note that functions can be enqueued directly with `DBOS.startWorkflow` instead of using this interface.
-     */
-    workflow<T extends unknown[], R>(wf: (...args: T) => Promise<R>, params: WorkflowParams, ...args: T): Promise<WorkflowHandle<R>>;
-    /**
-     * @deprecated
-     * Invoke a step function.
-     *  Note that functions can be called directly instead of using this interface.
-     */
-    external<T extends unknown[], R>(func: (...args: T) => Promise<R>, params: WorkflowParams, ...args: T): Promise<R>;
-    /**
-     * @deprecated
-     * Invoke a stored procedure function.
-     *  Note that functions can be called directly instead of using this interface.
-     */
-    procedure<T extends unknown[], R>(proc: (...args: T) => Promise<R>, params: WorkflowParams, ...args: T): Promise<R>;
-    /**
-     * Send a messsage to workflow with a given ID.
-     * @deprecated `DBOS.send` can be used instead.
-     * @param destinationID - ID of workflow to receive the message
-     * @param message - Message
-     * @param topic - Topic for message
-     * @param idempotencyKey - For sending exactly once
-     * @template T - Type of object to send
-     */
-    send<T>(destinationID: string, message: T, topic?: string, idempotencyKey?: string): Promise<void>;
-    /**
-     * Get an event set by a workflow.
-     * @deprecated Note that `DBOS.getEvent` can be used instead.
-     */
-    getEvent<T>(workflowID: string, key: string, timeoutSeconds?: number): Promise<T | null>;
-    /**
-     * Retrieve a workflow handle given the workflow ID.
-     * @deprecated Note that `DBOS.retrieveWorkflow` can be used instead
-     */
-    retrieveWorkflow<R>(workflowID: string): WorkflowHandle<R>;
-    /** @deprecated Use functions on `DBOS` */
-    getWorkflowStatus(workflowID: string, callerID?: string, callerFN?: number): Promise<WorkflowStatus | null>;
-    /** @deprecated Use functions on `DBOS` */
-    listWorkflows(input: GetWorkflowsInput): Promise<WorkflowStatus[]>;
-    /** @deprecated Use functions on `DBOS` */
-    listQueuedWorkflows(input: GetQueuedWorkflowsInput): Promise<WorkflowStatus[]>;
-    /** @deprecated Use functions on `DBOS` */
-    listWorkflowSteps(workflowID: string): Promise<StepInfo[] | undefined>;
-    /** @deprecated Use functions on `DBOS` */
-    cancelWorkflow(workflowID: string): Promise<void>;
-    /** @deprecated Use functions on `DBOS` */
-    resumeWorkflow(workflowID: string): Promise<void>;
-    /** @deprecated Use functions on `DBOS` */
-    forkWorkflow(workflowID: string, startStep: number, options?: {
-        newWorkflowID?: string;
-        applicationVersion?: string;
-        timeoutMS?: number;
-    }): Promise<string>;
-    /** @deprecated see DBOS.getEventDispatchState */
-    getEventDispatchState(service: string, workflowFnName: string, key: string): Promise<DBOSEventReceiverState | undefined>;
-    /** @deprecated see DBOS.upsertEventDispatchState */
-    upsertEventDispatchState(state: DBOSEventReceiverState): Promise<DBOSEventReceiverState>;
-    /** @deprecated Use `DBOS.queryUserDB` */
-    queryUserDB(sql: string, params?: unknown[]): Promise<unknown[]>;
-    /** @deprecated Listen for notifications from the user DB */
-    userDBListen(channels: string[], callback: DBNotificationCallback): Promise<DBNotificationListener>;
-}
-/**
- * Interface for DBOS pluggable event receivers.
- *  This is for things like kafka, SQS, HTTP, schedulers, etc., that listen or poll
- *    for events and dispatch workflows in response.
- * A `DBOSEventReceiver` will be:
- *  Registered with DBOS executor when any endpoint workflow function needs it
- *  Initialized with the executor during launch
- *  Destroyed upon any clean `shutdown()`
- * It is the implementer's job to keep going and dispatch workflows between
- *  `initialize` and `destroy`
- */
-export interface DBOSEventReceiver {
-    /** Executor, for providing state and dispatching DBOS workflows or other methods */
-    executor?: DBOSExecutorContext;
-    /** Called upon shutdown (usually in tests) to stop event receivers and free resources */
-    destroy(): Promise<void>;
-    /** Called during DBOS launch to indicate that event receiving should start */
-    initialize(executor: DBOSExecutorContext): Promise<void>;
-    /** Called at launch; Implementers should emit a diagnostic list of all registrations */
-    logRegisteredEndpoints(): void;
-}
-/**
- * State item to be kept in the DBOS system database on behalf of `DBOSEventReceiver`s
- * @see DBOSEventReceiver.upsertEventDispatchState
- * @see DBOSEventReceiver.getEventDispatchState
- */
-export interface DBOSEventReceiverState {
-    /** Name of event receiver service */
-    service: string;
-    /** Fully qualified function name for which state is kept */
-    workflowFnName: string;
-    /** subkey within the service+workflowFnName */
-    key: string;
-    /** Value kept for the service+workflowFnName+key combination */
-    value?: string;
-    /** Updated time (used to version the value) */
-    updateTime?: number;
-    /** Updated sequence number (used to version the value) */
-    updateSeq?: bigint;
-}
-//# sourceMappingURL=eventreceiver.d.ts.map

package/dist/src/eventreceiver.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"eventreceiver.d.ts","sourceRoot":"","sources":["../../src/eventreceiver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EACV,uBAAuB,EACvB,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,cAAc,EACd,cAAc,EACf,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAEvC,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC;AAC1C,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;AACjE,MAAM,WAAW,sBAAsB;IACrC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC5C,6HAA6H;IAC7H,YAAY,EAAE,OAAO,CAAC;IACtB,4HAA4H;IAC5H,WAAW,EAAE,OAAO,CAAC;IACrB,uEAAuE;IACvE,SAAS,EAAE,sBAAsB,CAAC;CACnC;AAOD,MAAM,WAAW,mBAAmB;IAClC,+DAA+D;IAC/D,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,gEAAgE;IAChE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB,kBAAkB;IAClB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IACzC,kBAAkB;IAClB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;IAE9C;;;;;;;OAOG;IACH,mBAAmB,CAAC,GAAG,EAAE,iBAAiB,GAAG,6BAA6B,EAAE,CAAC;IAE7E;;;OAGG;IACH,WAAW,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAErH;;;OAGG;IACH,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EAC7B,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAC9B,MAAM,EAAE,cAAc,EACtB,GAAG,IAAI,EAAE,CAAC,GACT,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEnH;;;;OAIG;IACH,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEpH;;;;;;;;OAQG;IACH,IAAI,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnG;;;OAGG;IACH,QAAQ,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACzF;;;OAGG;IACH,gBAAgB,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAC3D,0CAA0C;IAC1C,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAC5G,0CAA0C;IAC1C,aAAa,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACnE,0CAA0C;IAC1C,mBAAmB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAC/E,0CAA0C;IAC1C,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAC;IACvE,0CAA0C;IAC1C,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,0CAA0C;IAC1C,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,0CAA0C;IAC1C,YAAY,CACV,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GACpF,OAAO,CAAC,MAAM,CAAC,CAAC;IAGnB,iDAAiD;IACjD,qBAAqB,CACnB,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC,CAAC;IAE/C,oDAAoD;IACpD,wBAAwB,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAEzF,yCAAyC;IACzC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEjE,4DAA4D;IAC5D,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACrG;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iBAAiB;IAChC,oFAAoF;IACpF,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,yFAAyF;IACzF,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,8EAA8E;IAC9E,UAAU,CAAC,QAAQ,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,wFAAwF;IACxF,sBAAsB,IAAI,IAAI,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,4DAA4D;IAC5D,cAAc,EAAE,MAAM,CAAC;IACvB,+CAA+C;IAC/C,GAAG,EAAE,MAAM,CAAC;IACZ,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/src/eventreceiver.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=eventreceiver.js.map

package/dist/src/eventreceiver.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"eventreceiver.js","sourceRoot":"","sources":["../../src/eventreceiver.ts"],"names":[],"mappings":""}