awaitly 2.0.0 → 3.0.0

package/dist/engine.d.cts

@@ -0,0 +1,113 @@
+import { S as SnapshotStore, c as AnyResultFn, d as WorkflowContext } from './types-C9Y71dua.cjs';
+import { a as RunStep } from './index-ICmfQi08.cjs';
+import { D as DurableOptions } from './index-Bwt-iz50.cjs';
+import './types-d8q8iQlk.cjs';
+import '@standard-schema/spec';
+import './errors-sDSeaZBO.cjs';
+
+/** A registered workflow definition */
+interface WorkflowRegistration<Deps extends Readonly<Record<string, AnyResultFn>> = Readonly<Record<string, AnyResultFn>>> {
+    /** Workflow dependencies (Result-returning functions) */
+    deps: Deps;
+    /** Workflow function */
+    fn: (context: {
+        step: RunStep<any>;
+        deps: Deps;
+        ctx: WorkflowContext;
+    }) => any;
+    /** Default durable options (version, lockTtlMs, etc.) */
+    durableDefaults?: Partial<Pick<DurableOptions, 'version' | 'lockTtlMs' | 'heartbeatIntervalMs'>>;
+}
+interface EnqueueOptions {
+    /** Custom workflow execution ID (default: auto-generated UUID) */
+    id?: string;
+    /** Idempotency key for deduplication */
+    idempotencyKey?: string;
+    /** Workflow input for idempotency conflict detection */
+    input?: unknown;
+    /** Custom metadata */
+    metadata?: Record<string, unknown>;
+}
+interface ScheduleOptions {
+    /** Repeat interval in milliseconds */
+    intervalMs: number;
+    /** Run immediately on schedule creation */
+    immediate?: boolean;
+}
+interface EngineOptions {
+    /** Snapshot store for workflow persistence */
+    store: SnapshotStore;
+    /** Registered workflows keyed by name */
+    workflows: Record<string, WorkflowRegistration>;
+    /** Max parallel workflow runs per tick (default: 5) */
+    concurrency?: number;
+    /** Event handler */
+    onEvent?: (event: EngineEvent) => void;
+    /** Error handler for background operations */
+    onError?: (error: unknown) => void;
+}
+type EngineEvent = {
+    type: "engine_start";
+    ts: number;
+} | {
+    type: "engine_stop";
+    ts: number;
+} | {
+    type: "engine_tick";
+    ts: number;
+    processed: number;
+} | {
+    type: "workflow_enqueued";
+    workflowName: string;
+    id: string;
+    ts: number;
+} | {
+    type: "workflow_started";
+    workflowName: string;
+    id: string;
+    ts: number;
+} | {
+    type: "workflow_completed";
+    workflowName: string;
+    id: string;
+    ts: number;
+} | {
+    type: "workflow_failed";
+    workflowName: string;
+    id: string;
+    error: unknown;
+    ts: number;
+} | {
+    type: "schedule_created";
+    workflowName: string;
+    scheduleId: string;
+    intervalMs: number;
+    ts: number;
+} | {
+    type: "schedule_removed";
+    scheduleId: string;
+    ts: number;
+};
+interface Engine {
+    /** Enqueue a workflow for execution. Returns the workflow execution ID. */
+    enqueue(name: string, options?: EnqueueOptions): Promise<string>;
+    /** Schedule recurring workflow execution. Returns the schedule ID. */
+    schedule(name: string, options: ScheduleOptions & EnqueueOptions): string;
+    /** Remove a schedule */
+    unschedule(scheduleId: string): boolean;
+    /** Start the polling loop */
+    start(pollIntervalMs?: number): void;
+    /** Stop the polling loop gracefully */
+    stop(): Promise<void>;
+    /** Execute a single tick manually (process pending workflows). Returns number processed. */
+    tick(): Promise<number>;
+    /** Get engine status */
+    status(): {
+        running: boolean;
+        pendingSchedules: number;
+    };
+}
+
+declare function createEngine(options: EngineOptions): Engine;
+
+export { type Engine, type EngineEvent, type EngineOptions, type EnqueueOptions, type ScheduleOptions, type WorkflowRegistration, createEngine };

package/dist/engine.d.ts

@@ -0,0 +1,113 @@
+import { S as SnapshotStore, c as AnyResultFn, d as WorkflowContext } from './types-BDTxgKKc.js';
+import { a as RunStep } from './index-Cv4K_3sZ.js';
+import { D as DurableOptions } from './index-Bew12SZ8.js';
+import './types-sObbY4mX.js';
+import '@standard-schema/spec';
+import './errors-sDSeaZBO.js';
+
+/** A registered workflow definition */
+interface WorkflowRegistration<Deps extends Readonly<Record<string, AnyResultFn>> = Readonly<Record<string, AnyResultFn>>> {
+    /** Workflow dependencies (Result-returning functions) */
+    deps: Deps;
+    /** Workflow function */
+    fn: (context: {
+        step: RunStep<any>;
+        deps: Deps;
+        ctx: WorkflowContext;
+    }) => any;
+    /** Default durable options (version, lockTtlMs, etc.) */
+    durableDefaults?: Partial<Pick<DurableOptions, 'version' | 'lockTtlMs' | 'heartbeatIntervalMs'>>;
+}
+interface EnqueueOptions {
+    /** Custom workflow execution ID (default: auto-generated UUID) */
+    id?: string;
+    /** Idempotency key for deduplication */
+    idempotencyKey?: string;
+    /** Workflow input for idempotency conflict detection */
+    input?: unknown;
+    /** Custom metadata */
+    metadata?: Record<string, unknown>;
+}
+interface ScheduleOptions {
+    /** Repeat interval in milliseconds */
+    intervalMs: number;
+    /** Run immediately on schedule creation */
+    immediate?: boolean;
+}
+interface EngineOptions {
+    /** Snapshot store for workflow persistence */
+    store: SnapshotStore;
+    /** Registered workflows keyed by name */
+    workflows: Record<string, WorkflowRegistration>;
+    /** Max parallel workflow runs per tick (default: 5) */
+    concurrency?: number;
+    /** Event handler */
+    onEvent?: (event: EngineEvent) => void;
+    /** Error handler for background operations */
+    onError?: (error: unknown) => void;
+}
+type EngineEvent = {
+    type: "engine_start";
+    ts: number;
+} | {
+    type: "engine_stop";
+    ts: number;
+} | {
+    type: "engine_tick";
+    ts: number;
+    processed: number;
+} | {
+    type: "workflow_enqueued";
+    workflowName: string;
+    id: string;
+    ts: number;
+} | {
+    type: "workflow_started";
+    workflowName: string;
+    id: string;
+    ts: number;
+} | {
+    type: "workflow_completed";
+    workflowName: string;
+    id: string;
+    ts: number;
+} | {
+    type: "workflow_failed";
+    workflowName: string;
+    id: string;
+    error: unknown;
+    ts: number;
+} | {
+    type: "schedule_created";
+    workflowName: string;
+    scheduleId: string;
+    intervalMs: number;
+    ts: number;
+} | {
+    type: "schedule_removed";
+    scheduleId: string;
+    ts: number;
+};
+interface Engine {
+    /** Enqueue a workflow for execution. Returns the workflow execution ID. */
+    enqueue(name: string, options?: EnqueueOptions): Promise<string>;
+    /** Schedule recurring workflow execution. Returns the schedule ID. */
+    schedule(name: string, options: ScheduleOptions & EnqueueOptions): string;
+    /** Remove a schedule */
+    unschedule(scheduleId: string): boolean;
+    /** Start the polling loop */
+    start(pollIntervalMs?: number): void;
+    /** Stop the polling loop gracefully */
+    stop(): Promise<void>;
+    /** Execute a single tick manually (process pending workflows). Returns number processed. */
+    tick(): Promise<number>;
+    /** Get engine status */
+    status(): {
+        running: boolean;
+        pendingSchedules: number;
+    };
+}
+
+declare function createEngine(options: EngineOptions): Engine;
+
+export { type Engine, type EngineEvent, type EngineOptions, type EnqueueOptions, type ScheduleOptions, type WorkflowRegistration, createEngine };