@lucid-softworks/workflow-core 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lucid Softworks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,4 @@
+# `@lucid-softworks/workflow-core`
+
+Shared workflow states, execution context, cancellation errors, and injectable
+clock contracts. The system clock supports abortable sleeps.

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+export type WorkflowTaskState = "pending" | "running" | "succeeded" | "failed" | "skipped" | "cancelled" | "compensated";
+export interface WorkflowAbortSignal {
+    readonly aborted: boolean;
+    readonly reason: unknown;
+    addEventListener(type: "abort", listener: () => void, options?: Readonly<{
+        once?: boolean;
+    }>): void;
+    removeEventListener(type: "abort", listener: () => void): void;
+}
+export type WorkflowExecutionContext = Readonly<{
+    executionId: string;
+    taskId: string;
+    attempt: number;
+    signal: WorkflowAbortSignal;
+    results: ReadonlyMap<string, unknown>;
+}>;
+export type WorkflowTaskRecord = Readonly<{
+    id: string;
+    state: WorkflowTaskState;
+    output?: unknown;
+    error?: unknown;
+}>;
+export type WorkflowClock = Readonly<{
+    now: () => number;
+    sleep: (milliseconds: number, signal?: WorkflowAbortSignal) => Promise<void>;
+}>;
+export declare class WorkflowCancelledError extends Error {
+    readonly reason?: unknown;
+    readonly name = "WorkflowCancelledError";
+    constructor(reason?: unknown);
+}
+export declare function throwIfWorkflowCancelled(signal: WorkflowAbortSignal): void;
+export declare const systemWorkflowClock: WorkflowClock;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GACzB,SAAS,GACT,SAAS,GACT,WAAW,GACX,QAAQ,GACR,SAAS,GACT,WAAW,GACX,aAAa,CAAC;AAElB,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,gBAAgB,CACd,IAAI,EAAE,OAAO,EACb,QAAQ,EAAE,MAAM,IAAI,EACpB,OAAO,CAAC,EAAE,QAAQ,CAAC;QAAE,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,GACrC,IAAI,CAAC;IACR,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CAChE;AAED,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC;IAC9C,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC,CAAC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,iBAAiB,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC;IACnC,GAAG,EAAE,MAAM,MAAM,CAAC;IAClB,KAAK,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9E,CAAC,CAAC;AAEH,qBAAa,sBAAuB,SAAQ,KAAK;IAEnC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO;IADrC,SAAkB,IAAI,4BAA4B;IAClD,YAAqB,MAAM,CAAC,EAAE,OAAO,EAEpC;CACF;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAE1E;AAED,eAAO,MAAM,mBAAmB,EAAE,aAmBjC,CAAC"}

package/dist/index.js

@@ -0,0 +1,29 @@
+export class WorkflowCancelledError extends Error {
+    reason;
+    name = "WorkflowCancelledError";
+    constructor(reason) {
+        super("Workflow execution was cancelled");
+        this.reason = reason;
+    }
+}
+export function throwIfWorkflowCancelled(signal) {
+    if (signal.aborted)
+        throw new WorkflowCancelledError(signal.reason);
+}
+export const systemWorkflowClock = {
+    now: Date.now,
+    sleep(milliseconds, signal) {
+        return new Promise((resolve, reject) => {
+            if (signal?.aborted) {
+                reject(new WorkflowCancelledError(signal.reason));
+                return;
+            }
+            const timeout = setTimeout(resolve, milliseconds);
+            signal?.addEventListener("abort", () => {
+                clearTimeout(timeout);
+                reject(new WorkflowCancelledError(signal.reason));
+            }, { once: true });
+        });
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwCA,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAE1B,MAAM;IADT,IAAI,GAAG,wBAAwB,CAAC;IAClD,YAAqB,MAAgB;QACnC,KAAK,CAAC,kCAAkC,CAAC,CAAC;sBADvB,MAAM;IAE3B,CAAC;CACF;AAED,MAAM,UAAU,wBAAwB,CAAC,MAA2B;IAClE,IAAI,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACtE,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAkB;IAChD,GAAG,EAAE,IAAI,CAAC,GAAG;IACb,KAAK,CAAC,YAAY,EAAE,MAAM;QACxB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;gBACpB,MAAM,CAAC,IAAI,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;gBAClD,OAAO;YACT,CAAC;YACD,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YAClD,MAAM,EAAE,gBAAgB,CACtB,OAAO,EACP,GAAG,EAAE;gBACH,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,MAAM,CAAC,IAAI,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;YACpD,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@lucid-softworks/workflow-core",
+  "version": "0.0.0",
+  "description": "Shared workflow execution context, state, clock, and cancellation contracts.",
+  "keywords": [
+    "core",
+    "javascript",
+    "typescript",
+    "utility",
+    "workflow"
+  ],
+  "homepage": "https://github.com/lucid-softworks/workflow-core#readme",
+  "bugs": {
+    "url": "https://github.com/lucid-softworks/workflow-core/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lucid-softworks/workflow-core.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "bench": "vitest bench --run",
+    "bench:smoke": "VITEST_BENCHMARK_SMOKE=1 vitest bench --run",
+    "build": "tsc -p tsconfig.build.json",
+    "check": "oxfmt --check . && oxlint . && tsc -p tsconfig.json && tsc -p tsconfig.build.json && vitest run --coverage && publint && VITEST_BENCHMARK_SMOKE=1 vitest bench --run",
+    "format": "oxfmt --write .",
+    "format:check": "oxfmt --check .",
+    "lint": "oxlint .",
+    "pack:check": "publint",
+    "test": "vitest run --coverage",
+    "typecheck": "tsc -p tsconfig.json"
+  },
+  "devDependencies": {
+    "@lucid-softworks/oxfmt-config": "^0.1.1",
+    "@lucid-softworks/oxlint-config": "^0.1.0",
+    "@lucid-softworks/tsconfig": "^0.1.0",
+    "@lucid-softworks/vitest-config": "^0.1.1",
+    "@types/node": "26.1.1",
+    "@vitest/coverage-v8": "4.1.10",
+    "oxfmt": "0.60.0",
+    "oxlint": "1.75.0",
+    "publint": "0.3.22",
+    "typescript": "7.0.2",
+    "vitest": "4.1.10"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "packageManager": "pnpm@11.16.0"
+}