@usehelical/workflows 0.0.1-alpha.3 → 0.0.1-alpha.5

package/dist/index.d.ts

@@ -1,15 +1,4 @@
-import { W as WorkflowStatus, a as WorkflowEntry, Q as QueueEntry, M as MessageDefinition, S as StateDefinition } from './state-CmpqDrnz.js';
-
-interface Run<TReturn = unknown> {
-    id: string;
-    status: () => Promise<WorkflowStatus>;
-    result: () => Promise<TReturn>;
-}
-
-type RunWorkflowOptions = {
-    timeout?: number;
-    deadline?: number;
-};
+import { W as WorkflowEntry, Q as QueueEntry, R as RunWorkflowOptions, a as Run, M as MessageDefinition, S as StateDefinition } from './state-DmLPhezR.js';
 
 type QueueWorkflowOptions = {
     timeout?: number;

package/dist/{state-CmpqDrnz.d.ts → state-DmLPhezR.d.ts}

@@ -34,6 +34,17 @@ declare function defineWorkflow<TArgs extends unknown[], TReturn>(fn: WorkflowFu
 }): () => WorkflowDefinition<TArgs, TReturn>;
 type WorkflowEntry<TArgs extends unknown[] = unknown[], TReturn = unknown> = () => WorkflowDefinition<TArgs, TReturn>;
 
+interface Run<TReturn = unknown> {
+    id: string;
+    status: () => Promise<WorkflowStatus>;
+    result: () => Promise<TReturn>;
+}
+
+type RunWorkflowOptions = {
+    timeout?: number;
+    deadline?: number;
+};
+
 type MessageDefinition<T> = {
     name: string;
     data?: T;
@@ -46,4 +57,4 @@ interface StateDefinition<T> {
 }
 declare function defineState<T>(name: string): StateDefinition<T>;
 
-export { type MessageDefinition as M, type QueueEntry as Q, type StateDefinition as S, WorkflowStatus as W, type WorkflowEntry as a, type QueueDefinition as b, type QueueOptions as c, type QueueRateLimit as d, type WorkflowDefinition as e, type WorkflowFunction as f, defineMessage as g, defineQueue as h, defineState as i, defineWorkflow as j };
+export { type MessageDefinition as M, type QueueEntry as Q, type RunWorkflowOptions as R, type StateDefinition as S, type WorkflowEntry as W, type Run as a, type QueueDefinition as b, type QueueOptions as c, type QueueRateLimit as d, type WorkflowDefinition as e, type WorkflowFunction as f, WorkflowStatus as g, defineMessage as h, defineQueue as i, defineState as j, defineWorkflow as k };

package/dist/workflows.d.ts

@@ -1,4 +1,5 @@
-export { M as MessageDefinition, b as QueueDefinition, Q as QueueEntry, c as QueueOptions, d as QueueRateLimit, S as StateDefinition, e as WorkflowDefinition, a as WorkflowEntry, f as WorkflowFunction, W as WorkflowStatus, g as defineMessage, h as defineQueue, i as defineState, j as defineWorkflow } from './state-CmpqDrnz.js';
+import { S as StateDefinition, M as MessageDefinition, W as WorkflowEntry, R as RunWorkflowOptions, a as Run } from './state-DmLPhezR.js';
+export { b as QueueDefinition, Q as QueueEntry, c as QueueOptions, d as QueueRateLimit, e as WorkflowDefinition, f as WorkflowFunction, g as WorkflowStatus, h as defineMessage, i as defineQueue, j as defineState, k as defineWorkflow } from './state-DmLPhezR.js';
 
 type RetryConfig = {
     maxRetries?: number;
@@ -16,4 +17,34 @@ type StepDefinition<TArgs extends unknown[], TReturn> = {
 };
 declare function defineStep<TArgs extends unknown[], TReturn>(fn: StepFunction<TArgs, TReturn>, options?: StepOptions): (...args: TArgs) => StepDefinition<TArgs, TReturn>;
 
-export { type RetryConfig, type StepDefinition, type StepFunction, defineStep };
+declare function runStep<TArgs extends unknown[], TReturn>(step: StepDefinition<TArgs, TReturn>): Promise<TReturn | (TReturn extends void ? void : TReturn)>;
+declare function executeStepWithRetries<TArgs extends unknown[], TReturn>(stepName: string, fn: StepFunction<TArgs, TReturn>, args: TArgs, retryConfig: RetryConfig): Promise<TReturn>;
+
+declare function setState<T = unknown>(state: StateDefinition<T> | string, value: T): Promise<void>;
+
+declare function receiveMessage<T>(message: MessageDefinition<T> | string): Promise<T>;
+
+/**
+ * Generates a stable, unique step ID based on the current run ID and sequence ID.
+ * This ID is deterministic and will remain the same across retries, making it
+ * suitable for use as an idempotency key with third-party systems.
+ *
+ * The step ID is a SHA-256 hash of the run ID and sequence ID, formatted as a
+ * hex string for easy use with external APIs.
+ *
+ * @returns A unique, stable identifier for the current step execution
+ */
+declare function getStepId(): string;
+
+declare function getAbortSignal(): AbortSignal;
+
+declare function getRunId(): string;
+
+declare function sleep(ms: number): Promise<void>;
+declare function cancellableSleep(ms: number, signal?: AbortSignal): Promise<void>;
+
+declare function randomUUID(): Promise<string | undefined>;
+
+declare function runWorkflow<TArgs extends unknown[], TReturn>(wf: WorkflowEntry<TArgs, TReturn> | string, args?: TArgs, options?: RunWorkflowOptions): Promise<Run<TReturn>>;
+
+export { MessageDefinition, type RetryConfig, StateDefinition, type StepDefinition, type StepFunction, WorkflowEntry, cancellableSleep, defineStep, executeStepWithRetries, getAbortSignal, getRunId, getStepId, randomUUID, receiveMessage, runStep, runWorkflow, setState, sleep };

package/dist/workflows.js

@@ -3,5 +3,6 @@ export * from './queue';
 export * from './state';
 export * from './step';
 export * from './workflow';
+export * from './steps';
 //# sourceMappingURL=workflows.js.map
 //# sourceMappingURL=workflows.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usehelical/workflows",
-  "version": "0.0.1-alpha.3",
+  "version": "0.0.1-alpha.5",
   "description": "simple typesage durable workflows without magic",
   "main": "./dist/index.js",
   "type": "module",
@@ -40,6 +40,7 @@
   "devDependencies": {
     "@electric-sql/pglite": "^0.3.15",
     "@eslint/js": "^9.39.2",
+    "@types/node": "^25.2.0",
     "@types/pg": "^8.16.0",
     "@vitest/coverage-v8": "^4.0.18",
     "eslint": "^9.39.2",