openworkflow 0.5.0 → 0.6.0

package/dist/workflow.js

@@ -46,4 +46,3 @@ export function isWorkflow(value) {
         typeof spec.name === "string" &&
         typeof fn === "function");
 }
-//# sourceMappingURL=workflow.js.map

package/dist/workflow.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=workflow.test.d.ts.map

package/dist/workflow.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.test.d.ts","sourceRoot":"","sources":["../workflow.test.ts"],"names":[],"mappings":""}

package/dist/workflow.test.js

@@ -0,0 +1,84 @@
+import { defineWorkflow, defineWorkflowSpec, isWorkflow } from "./workflow.js";
+import { describe, expect, test } from "vitest";
+describe("defineWorkflowSpec", () => {
+    test("returns spec (passthrough)", () => {
+        const spec = { name: "test-workflow" };
+        const definedSpec = defineWorkflowSpec(spec);
+        expect(definedSpec).toStrictEqual(spec);
+    });
+});
+describe("defineWorkflow", () => {
+    test("returns workflow with spec and fn", () => {
+        // eslint-disable-next-line unicorn/consistent-function-scoping
+        function fn() {
+            return { result: "done" };
+        }
+        const spec = { name: "test-workflow" };
+        const workflow = defineWorkflow(spec, fn);
+        expect(workflow).toStrictEqual({
+            spec,
+            fn,
+        });
+    });
+});
+describe("isWorkflow", () => {
+    test("returns true for valid workflow objects", () => {
+        const workflow = defineWorkflow({ name: "test" }, () => "done");
+        expect(isWorkflow(workflow)).toBe(true);
+    });
+    test("returns false for null", () => {
+        expect(isWorkflow(null)).toBe(false);
+    });
+    test("returns false for undefined", () => {
+        // eslint-disable-next-line unicorn/no-useless-undefined
+        expect(isWorkflow(undefined)).toBe(false);
+    });
+    test("returns false for primitives", () => {
+        expect(isWorkflow("string")).toBe(false);
+        expect(isWorkflow(123)).toBe(false);
+        expect(isWorkflow(true)).toBe(false);
+    });
+    test("returns false for objects without spec", () => {
+        expect(isWorkflow({ fn: () => "result" })).toBe(false);
+    });
+    test("returns false for objects without fn", () => {
+        expect(isWorkflow({ spec: { name: "test" } })).toBe(false);
+    });
+    test("returns false for objects with invalid spec", () => {
+        expect(isWorkflow({ spec: null, fn: () => "result" })).toBe(false);
+        expect(isWorkflow({ spec: "invalid", fn: () => "result" })).toBe(false);
+    });
+    test("returns false for objects with invalid fn", () => {
+        expect(isWorkflow({ spec: { name: "test" }, fn: "not-a-function" })).toBe(false);
+    });
+});
+// --- type checks below -------------------------------------------------------
+// they're unused but useful to ensure that the types work as expected for both
+// defineWorkflowSpec and defineWorkflow
+const inferredTypesSpec = defineWorkflowSpec({
+    name: "inferred-types",
+});
+defineWorkflow(inferredTypesSpec, async ({ step }) => {
+    await step.run({ name: "step-1" }, () => {
+        return "success";
+    });
+    return { result: "done" };
+});
+const explicitInputTypeSpec = defineWorkflowSpec({
+    name: "explicit-input-type",
+});
+defineWorkflow(explicitInputTypeSpec, async ({ step }) => {
+    await step.run({ name: "step-1" }, () => {
+        return "success";
+    });
+    return { result: "done" };
+});
+const explicitInputAndOutputTypesSpec = defineWorkflowSpec({
+    name: "explicit-input-and-output-types",
+});
+defineWorkflow(explicitInputAndOutputTypesSpec, async ({ step }) => {
+    await step.run({ name: "step-1" }, () => {
+        return "success";
+    });
+    return { result: "done" };
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openworkflow",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Open-source TypeScript framework for building durable, resumable workflows",
   "keywords": [
     "durable execution",
@@ -28,13 +28,19 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "development": "./index.ts",
       "default": "./dist/index.js"
     },
     "./internal": {
       "types": "./dist/internal.d.ts",
-      "development": "./internal.ts",
       "default": "./dist/internal.js"
+    },
+    "./postgres": {
+      "types": "./dist/postgres.d.ts",
+      "default": "./dist/postgres.js"
+    },
+    "./sqlite": {
+      "types": "./dist/sqlite.d.ts",
+      "default": "./dist/sqlite.js"
     }
   },
   "bin": {
@@ -51,9 +57,17 @@
   "devDependencies": {
     "arktype": "^2.1.29",
     "valibot": "^1.2.0",
-    "vitest": "^4.0.16",
+    "vitest": "^4.0.18",
     "yup": "^1.7.1",
-    "zod": "^4.3.5"
+    "zod": "^4.3.6"
+  },
+  "peerDependencies": {
+    "postgres": ">=3"
+  },
+  "peerDependenciesMeta": {
+    "postgres": {
+      "optional": true
+    }
   },
   "engines": {
     "node": ">=20"

package/dist/backend-postgres/index.d.ts

@@ -1,44 +0,0 @@
-import type { Backend, CancelWorkflowRunParams, ClaimWorkflowRunParams, CompleteStepAttemptParams, CompleteWorkflowRunParams, CreateStepAttemptParams, CreateWorkflowRunParams, ExtendWorkflowRunLeaseParams, FailStepAttemptParams, FailWorkflowRunParams, GetStepAttemptParams, GetWorkflowRunParams, ListStepAttemptsParams, ListWorkflowRunsParams, PaginatedResponse, SleepWorkflowRunParams } from "../backend.js";
-import type { StepAttempt } from "../core/step.js";
-import type { WorkflowRun } from "../core/workflow.js";
-interface BackendPostgresOptions {
-    namespaceId?: string;
-    runMigrations?: boolean;
-}
-/**
- * Manages a connection to a Postgres database for workflow operations.
- */
-export declare class BackendPostgres implements Backend {
-    private pg;
-    private namespaceId;
-    private constructor();
-    /**
-     * Create and initialize a new BackendPostgres instance. This will
-     * automatically run migrations on startup unless `runMigrations` is set to
-     * false.
-     * @param url - Postgres connection URL
-     * @param options - Backend options
-     * @returns A connected backend instance
-     */
-    static connect(url: string, options?: BackendPostgresOptions): Promise<BackendPostgres>;
-    stop(): Promise<void>;
-    createWorkflowRun(params: CreateWorkflowRunParams): Promise<WorkflowRun>;
-    getWorkflowRun(params: GetWorkflowRunParams): Promise<WorkflowRun | null>;
-    listWorkflowRuns(params: ListWorkflowRunsParams): Promise<PaginatedResponse<WorkflowRun>>;
-    private buildListWorkflowRunsWhere;
-    claimWorkflowRun(params: ClaimWorkflowRunParams): Promise<WorkflowRun | null>;
-    extendWorkflowRunLease(params: ExtendWorkflowRunLeaseParams): Promise<WorkflowRun>;
-    sleepWorkflowRun(params: SleepWorkflowRunParams): Promise<WorkflowRun>;
-    completeWorkflowRun(params: CompleteWorkflowRunParams): Promise<WorkflowRun>;
-    failWorkflowRun(params: FailWorkflowRunParams): Promise<WorkflowRun>;
-    cancelWorkflowRun(params: CancelWorkflowRunParams): Promise<WorkflowRun>;
-    createStepAttempt(params: CreateStepAttemptParams): Promise<StepAttempt>;
-    getStepAttempt(params: GetStepAttemptParams): Promise<StepAttempt | null>;
-    listStepAttempts(params: ListStepAttemptsParams): Promise<PaginatedResponse<StepAttempt>>;
-    private buildListStepAttemptsWhere;
-    private processPaginationResults;
-    completeStepAttempt(params: CompleteStepAttemptParams): Promise<StepAttempt>;
-    failStepAttempt(params: FailStepAttemptParams): Promise<StepAttempt>;
-}
-export {};
-//# sourceMappingURL=index.d.ts.map

package/dist/backend-postgres/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/backend-postgres/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,OAAO,EACP,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EACvB,uBAAuB,EACvB,4BAA4B,EAC5B,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,eAAe,CAAC;AAGvB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAWvD,UAAU,sBAAsB;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,qBAAa,eAAgB,YAAW,OAAO;IAC7C,OAAO,CAAC,EAAE,CAAW;IACrB,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO;IAKP;;;;;;;OAOG;WACU,OAAO,CAClB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,eAAe,CAAC;IAiBrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IA0CjB,cAAc,CAClB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAYxB,gBAAgB,CACpB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IA2B1C,OAAO,CAAC,0BAA0B;IA0B5B,gBAAgB,CACpB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAmDxB,sBAAsB,CAC1B,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,WAAW,CAAC;IAkBjB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBtE,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,WAAW,CAAC;IAuBjB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC;IAgEpE,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IA2CjB,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAoCjB,cAAc,CAClB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAWxB,gBAAgB,CACpB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IA2B1C,OAAO,CAAC,0BAA0B;IA6BlC,OAAO,CAAC,wBAAwB;IAyC1B,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,WAAW,CAAC;IA0BjB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC;CAyB3E"}