@usehelical/workflows 0.0.1-alpha.2 → 0.0.1-alpha.4

package/dist/{index.d.mts → index.d.ts}

@@ -1,4 +1,4 @@
-import { W as WorkflowStatus, a as WorkflowEntry, Q as QueueEntry, M as MessageDefinition, S as StateDefinition } from './state-CmpqDrnz.mjs';
+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;

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './runtime';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/{index.mjs.map → index.js.map}

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"index.mjs","sourcesContent":[]}
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js","sourcesContent":[]}

package/dist/workflows.d.ts

@@ -0,0 +1,43 @@
+import { S as StateDefinition, M as MessageDefinition } from './state-CmpqDrnz.js';
+export { b as QueueDefinition, Q as QueueEntry, c as QueueOptions, d as QueueRateLimit, 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';
+
+type RetryConfig = {
+    maxRetries?: number;
+    retryDelay?: number;
+    backOffRate?: number;
+};
+type StepOptions = RetryConfig & {
+    name?: string;
+};
+type StepFunction<Args extends unknown[], R> = (...args: Args) => Promise<R> | R;
+type StepDefinition<TArgs extends unknown[], TReturn> = {
+    fn: StepFunction<TArgs, TReturn>;
+    args: TArgs;
+    options: StepOptions;
+};
+declare function defineStep<TArgs extends unknown[], TReturn>(fn: StepFunction<TArgs, TReturn>, options?: StepOptions): (...args: TArgs) => StepDefinition<TArgs, TReturn>;
+
+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 | (T extends void ? void : T)>;
+
+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;
+
+export { MessageDefinition, type RetryConfig, StateDefinition, type StepDefinition, type StepFunction, defineStep, executeStepWithRetries, getAbortSignal, getRunId, getStepId, receiveMessage, runStep, setState };

package/dist/{workflows.mjs → workflows.js}

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

package/dist/{workflows.mjs.map → workflows.js.map}

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"workflows.mjs","sourcesContent":[]}
+{"version":3,"sources":[],"names":[],"mappings":"","file":"workflows.js","sourcesContent":[]}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@usehelical/workflows",
-  "version": "0.0.1-alpha.2",
+  "version": "0.0.1-alpha.4",
   "description": "simple typesage durable workflows without magic",
   "main": "./dist/index.js",
+  "type": "module",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
@@ -39,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",

package/dist/index.mjs

@@ -1,3 +0,0 @@
-export * from './runtime';
-//# sourceMappingURL=index.mjs.map
-//# sourceMappingURL=index.mjs.map

package/dist/workflows.d.mts

@@ -1,19 +0,0 @@
-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.mjs';
-
-type RetryConfig = {
-    maxRetries?: number;
-    retryDelay?: number;
-    backOffRate?: number;
-};
-type StepOptions = RetryConfig & {
-    name?: string;
-};
-type StepFunction<Args extends unknown[], R> = (...args: Args) => Promise<R> | R;
-type StepDefinition<TArgs extends unknown[], TReturn> = {
-    fn: StepFunction<TArgs, TReturn>;
-    args: TArgs;
-    options: StepOptions;
-};
-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 };