@mokronos/wfkit 0.1.0

package/dist/sdk/sdk.d.ts

@@ -0,0 +1,102 @@
+import type { DefinedWorkflow } from "../core.ts";
+import type { JsonSchema, WorkflowHistoryEvent } from "../schemas.ts";
+import type { ExecuteWorkflowOptions } from "../runtime.ts";
+import type { WorkflowRuntime } from "../runtime.ts";
+import type { WorkflowArtifact, WorkflowRunEventRecord, WorkflowRunRecord, WorkflowRunStore, WorkflowStore } from "./artifact.ts";
+export type WorkflowExecutionStatus = "running" | "suspended" | "completed" | "failed" | "compensating";
+export interface WorkflowExecutionHandle {
+    readonly executionId: string;
+    readonly version: number;
+}
+export type WorkflowResult = {
+    readonly type: "completed";
+    readonly value: unknown;
+} | {
+    readonly type: "failed";
+    readonly error: unknown;
+};
+export type { WorkflowHistoryEvent };
+export interface WorkflowHistoryRecord {
+    readonly sequence: number;
+    readonly createdAt: string;
+    readonly event: WorkflowHistoryEvent;
+}
+export interface PendingSignal {
+    readonly name: string;
+    readonly invocation: number;
+    readonly activityName: string;
+    readonly timeout?: unknown;
+    /** JSON Schema of the payload the wait expects. */
+    readonly payloadSchema?: JsonSchema;
+}
+export interface WorkflowListResult {
+    readonly executions: ReadonlyArray<{
+        readonly executionId: string;
+        readonly workflowName: string;
+        readonly version: number;
+        readonly status: WorkflowExecutionStatus;
+        readonly startedAt: string;
+        readonly finishedAt?: string;
+    }>;
+    readonly cursor?: string;
+}
+export interface WorkflowClient {
+    start<I, O, E>(workflow: DefinedWorkflow<I, O, E>, payload: I, opts?: {
+        readonly idempotencyKey?: string;
+        readonly actor?: string;
+        readonly version?: number;
+    }): Promise<WorkflowExecutionHandle>;
+    signal(executionId: string, name: string, payload: unknown, opts?: {
+        readonly actor?: string;
+    }): Promise<void>;
+    result(executionId: string): Promise<WorkflowResult>;
+    status(executionId: string): Promise<WorkflowExecutionStatus>;
+    list<I, O, E>(workflow: DefinedWorkflow<I, O, E>, opts?: {
+        readonly status?: WorkflowExecutionStatus;
+        readonly version?: number;
+        readonly limit?: number;
+        readonly cursor?: string;
+    }): Promise<WorkflowListResult>;
+    history(executionId: string): Promise<ReadonlyArray<WorkflowHistoryRecord>>;
+    pendingSignals(executionId: string): Promise<ReadonlyArray<PendingSignal>>;
+    cancel(executionId: string, opts?: {
+        readonly compensate?: boolean;
+        readonly actor?: string;
+    }): Promise<void>;
+}
+export { Cancelled } from "../core.ts";
+export declare class MissingWorkflowVersionError extends Error {
+    readonly _tag = "MissingWorkflowVersionError";
+    readonly workflowName: string;
+    readonly version: number;
+    constructor(options: {
+        readonly workflowName: string;
+        readonly version: number;
+    });
+}
+export declare const pendingSignalsFromHistory: (history: ReadonlyArray<WorkflowHistoryRecord>) => ReadonlyArray<PendingSignal>;
+export declare const createWorkflowClient: (runtime?: WorkflowRuntime) => WorkflowClient;
+export interface RunWorkflowOptions {
+    readonly id: string;
+    readonly input: unknown;
+    readonly onEvent?: ExecuteWorkflowOptions["onEvent"];
+}
+export interface WorkflowRunResult {
+    readonly artifact: WorkflowArtifact;
+    readonly exportName: string;
+    readonly runId?: string;
+    readonly result: unknown;
+}
+export interface WorkflowSdk {
+    listWorkflows(): Promise<ReadonlyArray<WorkflowArtifact>>;
+    getWorkflow(id: string): Promise<WorkflowArtifact | undefined>;
+    listRuns(): Promise<ReadonlyArray<WorkflowRunRecord>>;
+    listRunEvents(runId: string): Promise<ReadonlyArray<WorkflowRunEventRecord>>;
+    runWorkflow(options: RunWorkflowOptions): Promise<WorkflowRunResult>;
+}
+export interface WorkflowSdkOptions {
+    readonly store?: WorkflowStore;
+    readonly runStore?: WorkflowRunStore;
+}
+export declare const createWorkflowSdk: (options?: WorkflowSdkOptions) => WorkflowSdk;
+//# sourceMappingURL=sdk.d.ts.map

package/dist/sdk/sdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../src/sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAIjD,OAAO,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAErE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAEpD,OAAO,KAAK,EACV,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACd,MAAM,eAAe,CAAA;AAMtB,MAAM,MAAM,uBAAuB,GAC/B,SAAS,GACT,WAAW,GACX,WAAW,GACX,QAAQ,GACR,cAAc,CAAA;AAElB,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,MAAM,cAAc,GACtB;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GACvD;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAA;AAExD,YAAY,EAAE,oBAAoB,EAAE,CAAA;AAEpC,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,KAAK,EAAE,oBAAoB,CAAA;CACrC;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B,mDAAmD;IACnD,QAAQ,CAAC,aAAa,CAAC,EAAE,UAAU,CAAA;CACpC;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;QACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;QAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;QAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;QACxB,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAA;QACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;QAC1B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAC7B,CAAC,CAAA;IACF,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACX,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAClC,OAAO,EAAE,CAAC,EACV,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAC9F,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACnC,MAAM,CACJ,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,EAChB,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GACjC,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IACpD,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAA;IAC7D,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACV,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAClC,IAAI,CAAC,EAAE;QACL,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,CAAA;QACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;QACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;QACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KACzB,GACA,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAC9B,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAA;IAC3E,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAA;IAC1E,MAAM,CACJ,WAAW,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAChE,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB;AAED,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,qBAAa,2BAA4B,SAAQ,KAAK;IACpD,QAAQ,CAAC,IAAI,iCAAgC;IAC7C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;gBAEZ,OAAO,EAAE;QAAE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE;CAQjF;AA8BD,eAAO,MAAM,yBAAyB,GACpC,SAAS,aAAa,CAAC,qBAAqB,CAAC,KAC5C,aAAa,CAAC,aAAa,CAsB7B,CAAA;AAED,eAAO,MAAM,oBAAoB,GAC/B,UAAS,eAA8D,KACtE,cACwG,CAAA;AAmoB3G,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAA;IACnC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAA;IACzD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAA;IAC9D,QAAQ,IAAI,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAA;IACrD,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC,CAAA;IAC5E,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;CACrE;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAA;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAA;CACrC;AAED,eAAO,MAAM,iBAAiB,GAAI,UAAS,kBAAuB,KAAG,WAsDpE,CAAA"}