openworkflow 0.6.0 → 0.6.2

package/dist/factory.d.ts

@@ -1,74 +0,0 @@
-/**
- * Drizzle-style factory function for creating OpenWorkflow instances.
- *
- * This module provides a factory function that follows the Drizzle ORM pattern
- * for creating database instances. It supports multiple calling conventions:
- *
- * ```ts
- * // With a pre-configured driver
- * const ow = openworkflow(postgres(url));
- *
- * // With inline configuration
- * const ow = openworkflow(postgres({ connection: url, namespace: 'app' }));
- * ```
- */
-import type { Backend } from "./backend.js";
-import { OpenWorkflow } from "./client.js";
-import type { Driver } from "./driver.js";
-/**
- * Extended OpenWorkflow instance with driver metadata.
- */
-export interface OpenWorkflowWithDriver extends OpenWorkflow {
-    /**
-     * The underlying driver used to create this instance.
-     */
-    readonly $driver: Driver;
-    /**
-     * The underlying backend instance.
-     */
-    readonly $backend: Backend;
-}
-/**
- * Creates a new OpenWorkflow instance from a driver.
- *
- * This is the Drizzle-style factory function that provides a clean API for
- * creating OpenWorkflow instances with different database backends.
- * @param driver - A configured driver (e.g., from `postgres()` or `sqlite()`)
- * @returns A promise that resolves to an OpenWorkflow instance
- * @example
- * ```ts
- * import { openworkflow } from 'openworkflow';
- * import { postgres } from 'openworkflow/postgres';
- *
- * // Simple usage
- * const ow = await openworkflow(postgres(process.env.DATABASE_URL));
- *
- * // With SQLite
- * import { sqlite } from 'openworkflow/sqlite';
- * const ow = await openworkflow(sqlite(':memory:'));
- *
- * // Define and run workflows
- * const myWorkflow = ow.defineWorkflow(
- *   { name: 'my-workflow' },
- *   async ({ input, step }) => {
- *     const result = await step.run({ name: 'do-work' }, async () => {
- *       return 'done';
- *     });
- *     return result;
- *   }
- * );
- *
- * const handle = await myWorkflow.run({ data: 'test' });
- * const result = await handle.result();
- * ```
- */
-export declare function openworkflow(driver: Driver): Promise<OpenWorkflowWithDriver>;
-/**
- * Synchronous version of openworkflow for drivers that support sync creation.
- * Note: Most drivers require async creation due to migrations.
- * @param driver - A configured driver
- * @returns An OpenWorkflow instance
- * @throws {TypeError} If driver requires async setup
- */
-export declare function openworkflowSync(driver: Driver): OpenWorkflowWithDriver;
-//# sourceMappingURL=factory.d.ts.map

package/dist/factory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../factory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,YAAY,EAA4B,MAAM,aAAa,CAAC;AACrE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,sBAAsB,CAAC,CAgBjC;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,sBAAsB,CAsBvE"}

package/dist/factory.js

@@ -1,72 +0,0 @@
-import { OpenWorkflow } from "./client.js";
-/**
- * Creates a new OpenWorkflow instance from a driver.
- *
- * This is the Drizzle-style factory function that provides a clean API for
- * creating OpenWorkflow instances with different database backends.
- * @param driver - A configured driver (e.g., from `postgres()` or `sqlite()`)
- * @returns A promise that resolves to an OpenWorkflow instance
- * @example
- * ```ts
- * import { openworkflow } from 'openworkflow';
- * import { postgres } from 'openworkflow/postgres';
- *
- * // Simple usage
- * const ow = await openworkflow(postgres(process.env.DATABASE_URL));
- *
- * // With SQLite
- * import { sqlite } from 'openworkflow/sqlite';
- * const ow = await openworkflow(sqlite(':memory:'));
- *
- * // Define and run workflows
- * const myWorkflow = ow.defineWorkflow(
- *   { name: 'my-workflow' },
- *   async ({ input, step }) => {
- *     const result = await step.run({ name: 'do-work' }, async () => {
- *       return 'done';
- *     });
- *     return result;
- *   }
- * );
- *
- * const handle = await myWorkflow.run({ data: 'test' });
- * const result = await handle.result();
- * ```
- */
-export async function openworkflow(driver) {
-    // Create the backend from the driver
-    const backend = await driver.createBackend();
-    // Create the OpenWorkflow instance
-    const options = {
-        backend,
-    };
-    const ow = new OpenWorkflow(options);
-    // Return an extended instance with driver metadata
-    return Object.assign(ow, {
-        $driver: driver,
-        $backend: backend,
-    });
-}
-/**
- * Synchronous version of openworkflow for drivers that support sync creation.
- * Note: Most drivers require async creation due to migrations.
- * @param driver - A configured driver
- * @returns An OpenWorkflow instance
- * @throws {TypeError} If driver requires async setup
- */
-export function openworkflowSync(driver) {
-    // Try to create the backend synchronously
-    const backendOrPromise = driver.createBackend();
-    if (backendOrPromise instanceof Promise) {
-        throw new TypeError(`Driver '${driver.dialect}' requires async setup. Use 'await openworkflow()' instead of 'openworkflowSync()'.`);
-    }
-    const backend = backendOrPromise;
-    const options = {
-        backend,
-    };
-    const ow = new OpenWorkflow(options);
-    return Object.assign(ow, {
-        $driver: driver,
-        $backend: backend,
-    });
-}

package/dist/node-sqlite/backend.d.ts

@@ -1,52 +0,0 @@
-import { Backend, CancelWorkflowRunParams, ClaimWorkflowRunParams, CompleteStepAttemptParams, CompleteWorkflowRunParams, CreateStepAttemptParams, CreateWorkflowRunParams, ExtendWorkflowRunLeaseParams, FailStepAttemptParams, FailWorkflowRunParams, GetStepAttemptParams, GetWorkflowRunParams, ListStepAttemptsParams, ListWorkflowRunsParams, PaginatedResponse, SleepWorkflowRunParams } from "../backend.js";
-import { StepAttempt } from "../core/step.js";
-import { WorkflowRun } from "../core/workflow.js";
-import type { DatabaseSync } from "node:sqlite";
-interface BackendSqliteOptions {
-    namespaceId?: string;
-    runMigrations?: boolean;
-}
-/**
- * Manages a connection to a SQLite database for workflow operations.
- */
-export declare class BackendSqlite implements Backend {
-    private db;
-    private namespaceId;
-    private constructor();
-    /**
-     * Create and initialize a new BackendSqlite instance. This will
-     * automatically run migrations on startup unless `runMigrations` is set to
-     * false.
-     * @param path - Database path
-     * @param options - Backend options
-     * @returns A connected backend instance
-     */
-    static connect(path: string, options?: BackendSqliteOptions): BackendSqlite;
-    /**
-     * Create and initialize a new BackendSqlite instance from an existing
-     * SQLite database connection. This will automatically run migrations on
-     * startup unless `runMigrations` is set to false.
-     * @param db - SQLite database connection
-     * @param options - Backend options
-     * @returns A connected backend instance
-     */
-    static fromClient(db: DatabaseSync, options?: BackendSqliteOptions): BackendSqlite;
-    stop(): Promise<void>;
-    createWorkflowRun(params: CreateWorkflowRunParams): Promise<WorkflowRun>;
-    getWorkflowRun(params: GetWorkflowRunParams): Promise<WorkflowRun | null>;
-    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>;
-    listWorkflowRuns(params: ListWorkflowRunsParams): Promise<PaginatedResponse<WorkflowRun>>;
-    listStepAttempts(params: ListStepAttemptsParams): Promise<PaginatedResponse<StepAttempt>>;
-    private processPaginationResults;
-    createStepAttempt(params: CreateStepAttemptParams): Promise<StepAttempt>;
-    getStepAttempt(params: GetStepAttemptParams): Promise<StepAttempt | null>;
-    completeStepAttempt(params: CompleteStepAttemptParams): Promise<StepAttempt>;
-    failStepAttempt(params: FailStepAttemptParams): Promise<StepAttempt>;
-}
-export {};
-//# sourceMappingURL=backend.d.ts.map

package/dist/node-sqlite/backend.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["../../node-sqlite/backend.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,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,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAYlD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAIhD,UAAU,oBAAoB;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,OAAO;IAC3C,OAAO,CAAC,EAAE,CAAe;IACzB,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO;IAKP;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,aAAa;IAgB3E;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CACf,EAAE,EAAE,YAAY,EAChB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,aAAa;IAeV,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAgDvB,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAenE,gBAAgB,CACpB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IA0FxB,sBAAsB,CAC1B,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,WAAW,CAAC;IAmCjB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAoCtE,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,WAAW,CAAC;IAyCjB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC;IA+DpE,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAuDvB,gBAAgB,CACd,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAgE1C,gBAAgB,CACd,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAmE1C,OAAO,CAAC,wBAAwB;IAyC1B,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAwCvB,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAenE,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,WAAW,CAAC;IA0DjB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC;CAyD3E"}