@solidactions/sdk 0.1.1 → 0.2.0

package/dist/src/dbos-executor.d.ts

@@ -1,189 +0,0 @@
-import { type WorkflowHandle, type WorkflowParams, type WorkflowStatus, type StepInfo } from './workflow';
-import { type StepConfig } from './step';
-import { TelemetryCollector } from './telemetry/collector';
-import { Tracer } from './telemetry/traces';
-import { DBOSContextualLogger, GlobalLogger } from './telemetry/logs';
-import { type SystemDatabase, type SystemDatabaseStoredResult } from './system_database';
-import { SolidActionsHttpConfig } from './config';
-import { TypedAsyncFunction } from './decorators';
-import type { step_info } from '../schemas/system_db_schema';
-import { DBOSSerializer } from './serialization';
-import { GetWorkflowsInput } from '.';
-export interface SolidActionsConfig {
-    name?: string;
-    api?: {
-        url: string;
-        key: string;
-        timeout?: number;
-        maxRetries?: number;
-    };
-    enableOTLP?: boolean;
-    logLevel?: string;
-    addContextMetadata?: boolean;
-    otlpTracesEndpoints?: string[];
-    otlpLogsEndpoints?: string[];
-    adminPort?: number;
-    runAdminServer?: boolean;
-    applicationVersion?: string;
-    executorID?: string;
-    serializer?: DBOSSerializer;
-    enablePatching?: boolean;
-}
-export interface SolidActionsRuntimeConfig {
-    admin_port: number;
-    runAdminServer: boolean;
-    start: string[];
-    setup: string[];
-}
-export interface TelemetryConfig {
-    logs?: LoggerConfig;
-    OTLPExporter?: OTLPExporterConfig;
-}
-export interface OTLPExporterConfig {
-    logsEndpoint?: string[];
-    tracesEndpoint?: string[];
-}
-export interface LoggerConfig {
-    logLevel?: string;
-    silent?: boolean;
-    addContextMetadata?: boolean;
-    forceConsole?: boolean;
-}
-export type SolidActionsConfigInternal = {
-    name?: string;
-    api: SolidActionsHttpConfig;
-    serializer: DBOSSerializer;
-    telemetry: TelemetryConfig;
-    http?: {
-        cors_middleware?: boolean;
-        credentials?: boolean;
-        allowed_origins?: string[];
-    };
-};
-export interface InternalWorkflowParams extends WorkflowParams {
-    readonly tempWfType?: string;
-    readonly tempWfName?: string;
-    readonly tempWfClass?: string;
-    readonly isRecoveryDispatch?: boolean;
-    readonly isQueueDispatch?: boolean;
-}
-export declare const OperationType: {
-    readonly HANDLER: "handler";
-    readonly WORKFLOW: "workflow";
-    readonly TRANSACTION: "transaction";
-    readonly STEP: "step";
-};
-export declare const TempWorkflowType: {
-    readonly step: "step";
-    readonly send: "send";
-};
-/**
- * State item to be kept in the system database on behalf of clients
- */
-export interface SolidActionsExternalState {
-    /** 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;
-}
-export interface SolidActionsExecutorOptions {
-    systemDatabase?: SystemDatabase;
-    debugMode?: boolean;
-}
-/** @deprecated Use SolidActionsExecutorOptions instead */
-export type DBOSExecutorOptions = SolidActionsExecutorOptions;
-export declare class SolidActionsExecutor {
-    #private;
-    readonly config: SolidActionsConfigInternal;
-    initialized: boolean;
-    readonly systemDatabase: SystemDatabase;
-    readonly telemetryCollector: TelemetryCollector;
-    static readonly defaultNotificationTimeoutSec = 60;
-    readonly logger: GlobalLogger;
-    readonly ctxLogger: DBOSContextualLogger;
-    readonly tracer: Tracer;
-    readonly serializer: DBOSSerializer;
-    readonly executorID: string;
-    static globalInstance: SolidActionsExecutor | undefined;
-    constructor(config: SolidActionsConfigInternal, { systemDatabase, debugMode }?: SolidActionsExecutorOptions);
-    get appName(): string | undefined;
-    init(): Promise<void>;
-    destroy(): Promise<void>;
-    static reviveResultOrError<R = unknown>(r: SystemDatabaseStoredResult, serializer: DBOSSerializer): R;
-    workflow<T extends unknown[], R>(wf: TypedAsyncFunction<T, R>, params: InternalWorkflowParams, ...args: T): Promise<WorkflowHandle<R>>;
-    internalWorkflow<T extends unknown[], R>(wf: TypedAsyncFunction<T, R>, params: InternalWorkflowParams, callerID?: string, callerFunctionID?: number, ...args: T): Promise<WorkflowHandle<R>>;
-    runStepTempWF<T extends unknown[], R>(stepFn: TypedAsyncFunction<T, R>, params: WorkflowParams, ...args: T): Promise<R>;
-    startStepTempWF<T extends unknown[], R>(stepFn: TypedAsyncFunction<T, R>, params: InternalWorkflowParams, callerWFID?: string, callerFunctionID?: number, ...args: T): Promise<WorkflowHandle<R>>;
-    /**
-     * Execute a step function.
-     * If it encounters any error, retry according to its configured retry policy until the maximum number of attempts is reached, then throw an DBOSError.
-     * The step may execute many times, but once it is complete, it will not re-execute.
-     */
-    callStepFunction<T extends unknown[], R>(stepFn: TypedAsyncFunction<T, R>, stepFnName: string | undefined, stepConfig: StepConfig | undefined, clsInst: object | null, ...args: T): Promise<R>;
-    runSendTempWF<T>(destinationId: string, message: T, topic?: string, idempotencyKey?: string): Promise<void>;
-    /**
-     * Wait for a workflow to emit an event, then return its value.
-     */
-    getEvent<T>(workflowUUID: string, key: string, timeoutSeconds?: number): Promise<T | null>;
-    /**
-     * Fork a workflow.
-     * The forked workflow will be assigned a new ID.
-     */
-    forkWorkflow(workflowID: string, startStep: number, options?: {
-        newWorkflowID?: string;
-        applicationVersion?: string;
-        timeoutMS?: number;
-    }): Promise<string>;
-    /**
-     * Retrieve a handle for a workflow UUID.
-     */
-    retrieveWorkflow<R>(workflowID: string): WorkflowHandle<R>;
-    runInternalStep<T>(callback: () => Promise<T>, functionName: string, workflowID: string, functionID: number, childWfId?: string): Promise<T>;
-    getWorkflowStatus(workflowID: string, callerID?: string, callerFN?: number): Promise<WorkflowStatus | null>;
-    listWorkflows(input: GetWorkflowsInput): Promise<WorkflowStatus[]>;
-    listWorkflowSteps(workflowID: string): Promise<StepInfo[] | undefined>;
-    /**
-     * A recovery process that by default runs during executor init time.
-     * It runs to completion all pending workflows that were executing when the previous executor failed.
-     */
-    recoverPendingWorkflows(executorIDs?: string[]): Promise<WorkflowHandle<unknown>[]>;
-    initEventReceivers(): Promise<void>;
-    deactivateEventReceivers(): Promise<void>;
-    executeWorkflowId(workflowID: string, options?: {
-        startNewWorkflow?: boolean;
-        isRecoveryDispatch?: boolean;
-        isQueueDispatch?: boolean;
-    }): Promise<WorkflowHandle<unknown>>;
-    getEventDispatchState(svc: string, wfn: string, key: string): Promise<DBOSExternalState | undefined>;
-    upsertEventDispatchState(state: DBOSExternalState): Promise<DBOSExternalState>;
-    cancelWorkflow(workflowID: string): Promise<void>;
-    getWorkflowSteps(workflowID: string): Promise<step_info[]>;
-    resumeWorkflow(workflowID: string): Promise<void>;
-    /**
-      An application's version is computed from a hash of the source of its workflows.
-      This is guaranteed to be stable given identical source code because it uses an MD5 hash
-      and because it iterates through the workflows in sorted order.
-      This way, if the app's workflows are updated (which would break recovery), its version changes.
-      App version can be manually set through the DBOS__APPVERSION environment variable.
-     */
-    computeAppVersion(): string;
-}
-/** @deprecated Use SolidActionsConfig instead */
-export type DBOSConfig = SolidActionsConfig;
-/** @deprecated Use SolidActionsConfigInternal instead */
-export type DBOSConfigInternal = SolidActionsConfigInternal;
-/** @deprecated Use SolidActionsRuntimeConfig instead */
-export type DBOSRuntimeConfig = SolidActionsRuntimeConfig;
-/** @deprecated Use SolidActionsExternalState instead */
-export type DBOSExternalState = SolidActionsExternalState;
-/** @deprecated Use SolidActionsExecutor instead - this is now a type alias */
-export type DBOSExecutor = SolidActionsExecutor;
-//# sourceMappingURL=dbos-executor.d.ts.map

package/dist/src/dbos-executor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dbos-executor.d.ts","sourceRoot":"","sources":["../../src/dbos-executor.ts"],"names":[],"mappings":"AAaA,OAAO,EAEL,KAAK,cAAc,EACnB,KAAK,cAAc,EAGnB,KAAK,cAAc,EACnB,KAAK,QAAQ,EAGd,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAA+C,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEtE,OAAO,EACL,KAAK,cAAc,EAGnB,KAAK,0BAA0B,EAChC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAElD,OAAO,EAML,kBAAkB,EAOnB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAY7D,OAAO,EAAE,cAAc,EAAgC,MAAM,iBAAiB,CAAC;AAC/E,OAAO,EAAQ,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAW5C,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IAGd,GAAG,CAAC,EAAE;QACJ,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IAEF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IAGd,GAAG,EAAE,sBAAsB,CAAC;IAE5B,UAAU,EAAE,cAAc,CAAC;IAC3B,SAAS,EAAE,eAAe,CAAC;IAE3B,IAAI,CAAC,EAAE;QACL,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;KAC5B,CAAC;CACH,CAAC;AAEF,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAC5D,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IACtC,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,eAAO,MAAM,aAAa;;;;;CAKhB,CAAC;AAEX,eAAO,MAAM,gBAAgB;;;CAGnB,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,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;AAED,MAAM,WAAW,2BAA2B;IAC1C,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,0DAA0D;AAC1D,MAAM,MAAM,mBAAmB,GAAG,2BAA2B,CAAC;AAE9D,qBAAa,oBAAoB;;IAyB7B,QAAQ,CAAC,MAAM,EAAE,0BAA0B;IAxB7C,WAAW,EAAE,OAAO,CAAC;IAErB,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAKxC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAEhD,MAAM,CAAC,QAAQ,CAAC,6BAA6B,MAAM;IAInD,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;IAEpC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAA2B;IAEtD,MAAM,CAAC,cAAc,EAAE,oBAAoB,GAAG,SAAS,CAAa;gBAIzD,MAAM,EAAE,0BAA0B,EAC3C,EAAE,cAAc,EAAE,SAAS,EAAE,GAAE,2BAAgC;IAuCjE,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAEhC;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAuDrB,OAAO;IAsBb,MAAM,CAAC,mBAAmB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,EAAE,0BAA0B,EAAE,UAAU,EAAE,cAAc;IAQ3F,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EACnC,EAAE,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,MAAM,EAAE,sBAAsB,EAC9B,GAAG,IAAI,EAAE,CAAC,GACT,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAKvB,gBAAgB,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EAC3C,EAAE,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,MAAM,EAAE,sBAAsB,EAC9B,QAAQ,CAAC,EAAE,MAAM,EACjB,gBAAgB,CAAC,EAAE,MAAM,EACzB,GAAG,IAAI,EAAE,CAAC,GACT,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IA6RvB,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EACxC,MAAM,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAChC,MAAM,EAAE,cAAc,EACtB,GAAG,IAAI,EAAE,CAAC,GACT,OAAO,CAAC,CAAC,CAAC;IAIP,eAAe,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EAC1C,MAAM,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAChC,MAAM,EAAE,sBAAsB,EAC9B,UAAU,CAAC,EAAE,MAAM,EACnB,gBAAgB,CAAC,EAAE,MAAM,EACzB,GAAG,IAAI,EAAE,CAAC,GACT,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAoB7B;;;;OAIG;IACG,gBAAgB,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EAC3C,MAAM,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAChC,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,UAAU,EAAE,UAAU,GAAG,SAAS,EAClC,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,GAAG,IAAI,EAAE,CAAC,GACT,OAAO,CAAC,CAAC,CAAC;IAwIP,aAAa,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;IA6BjH;;OAEG;IACG,QAAQ,CAAC,CAAC,EACd,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,MAAM,EACX,cAAc,GAAE,MAA2D,GAC1E,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAIpB;;;OAGG;IACH,YAAY,CACV,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GACxF,OAAO,CAAC,MAAM,CAAC;IAKlB;;OAEG;IACH,gBAAgB,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC;IAIpD,eAAe,CAAC,CAAC,EACrB,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAC1B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,CAAC,CAAC;IA2BP,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAM3G,aAAa,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIlE,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC;IAK5E;;;OAGG;IACG,uBAAuB,CAAC,WAAW,GAAE,MAAM,EAAc,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;IA4B9F,kBAAkB;IAMlB,wBAAwB;IAYxB,iBAAiB,CACrB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QACR,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,GACA,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAsG7B,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAGpG,wBAAwB,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAc9E,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjD,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAa1D,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD;;;;;;OAMG;IACH,iBAAiB,IAAI,MAAM;CAa5B;AAGD,iDAAiD;AACjD,MAAM,MAAM,UAAU,GAAG,kBAAkB,CAAC;AAC5C,yDAAyD;AACzD,MAAM,MAAM,kBAAkB,GAAG,0BAA0B,CAAC;AAC5D,wDAAwD;AACxD,MAAM,MAAM,iBAAiB,GAAG,yBAAyB,CAAC;AAC1D,wDAAwD;AACxD,MAAM,MAAM,iBAAiB,GAAG,yBAAyB,CAAC;AAC1D,8EAA8E;AAC9E,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC"}