@voyantjs/workflows 0.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Voyant Cloud
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,52 @@
+Voyant Workflows
+Copyright 2026 Voyant Cloud
+
+This product includes software developed at Voyant Cloud
+(https://voyant.cloud).
+
+Licensed under the Apache License, Version 2.0 (the "License").
+See the LICENSE file in the root of this repository for details.
+
+-------------------------------------------------------------------------------
+Upstream attributions
+-------------------------------------------------------------------------------
+
+This project incorporates designs, patterns, and in some cases source
+code adapted from the following upstream projects. Each retains the
+copyright and license noted. Where specific files have been ported or
+derived, individual file headers preserve the upstream copyright notice.
+
+  Vercel Workflow
+    https://github.com/vercel/workflow
+    Copyright (c) Vercel, Inc.
+    Apache License, Version 2.0
+
+    Derivation scope: determinism Proxies (Date / Math.random / crypto);
+    event-log-as-source-of-truth storage shape; capabilities/version
+    table; OTEL semantic conventions; consumer state machines for
+    sleep / hook / step primitives; error taxonomy.
+
+  Trigger.dev
+    https://github.com/triggerdotdev/trigger.dev
+    Copyright (c) Trigger.dev Inc.
+    Apache License, Version 2.0
+
+    Derivation scope: execution-snapshot model with snapshot-id-gated
+    mutations; run-status vs execution-status enum split; unified
+    waitpoint entity; reserve-concurrency pattern; metadata API shape;
+    trigger options vocabulary; single-dev-instance CLI lockfile.
+
+  Hatchet
+    https://github.com/hatchet-dev/hatchet
+    Copyright (c) Hatchet Inc.
+    MIT License
+
+    Derivation scope: concurrency strategy enum (queue / cancel-in-progress
+    / cancel-newest / round-robin); match engine with OR groups; rate
+    limit token-bucket queries; waitFor / cancelIf / skipIf condition
+    actions; payload INLINE / EXTERNAL split; event filter scope model;
+    durable task eviction policy.
+
+Files that are near-verbatim ports carry an explicit upstream copyright
+header alongside Voyant Cloud's own. All other files are original to
+this project.

package/README.md

@@ -0,0 +1,46 @@
+# @voyantjs/workflows
+
+Authoring SDK for [Voyant Workflows](https://voyant.cloud/workflows) —
+durable, step-based orchestrations for Voyant Cloud.
+
+```ts
+import { workflow } from "@voyantjs/workflows";
+import { z } from "zod";
+
+export const sendBookingReminders = workflow({
+  id: "send-booking-reminders",
+  input: z.object({ bookingId: z.string() }),
+
+  async run(input, ctx) {
+    const booking = await ctx.step("fetch", () => db.bookings.findById(input.bookingId));
+
+    await ctx.sleep("24h");
+
+    await ctx.step("send-reminder", async () => {
+      await email.send(booking.customerEmail, "Reminder...");
+    });
+  },
+});
+```
+
+## Subpaths
+
+- `@voyantjs/workflows` — authoring API (`workflow`, `workflows`, `trigger`, conditions, errors).
+- `@voyantjs/workflows/testing` — in-process test harness
+  (`runWorkflowForTest`, `resumeWorkflowForTest`).
+- `@voyantjs/workflows/handler` — tenant-side step handler for the
+  v1 wire protocol. Mount at `POST /__voyant/workflow-step` in your
+  Worker: `export default { fetch: createStepHandler() }`.
+- `@voyantjs/workflows/auth` — paired HMAC signer + verifier for the
+  `X-Voyant-Dispatch-Auth` header. Wires into the orchestrator's
+  `sign` hook and the handler's `verifyRequest` hook with a shared
+  secret.
+- `@voyantjs/workflows/protocol` — wire-protocol types shared with the
+  orchestrator.
+
+## Full contract
+
+- [`docs/sdk-surface.md`](../../docs/sdk-surface.md) — locked API surface.
+- [`docs/design.md`](../../docs/design.md) — architecture and rationale.
+- [`docs/runtime-protocol.md`](../../docs/runtime-protocol.md) — wire protocol.
+

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@voyantjs/workflows",
+  "version": "0.0.0",
+  "description": "Authoring SDK for Voyant Workflows \u2014 durable, step-based orchestrations for Voyant Cloud.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/voyantjs/voyant.git",
+    "directory": "packages/workflows"
+  },
+  "homepage": "https://voyant.cloud/workflows",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts"
+    },
+    "./testing": {
+      "types": "./src/testing/index.ts",
+      "import": "./src/testing/index.ts"
+    },
+    "./protocol": {
+      "types": "./src/protocol/index.ts",
+      "import": "./src/protocol/index.ts"
+    },
+    "./handler": {
+      "types": "./src/handler/index.ts",
+      "import": "./src/handler/index.ts"
+    },
+    "./auth": {
+      "types": "./src/auth/index.ts",
+      "import": "./src/auth/index.ts"
+    },
+    "./rate-limit": {
+      "types": "./src/rate-limit/index.ts",
+      "import": "./src/rate-limit/index.ts"
+    }
+  },
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "files": [
+    "dist",
+    "src",
+    "!**/*.test.*",
+    "!**/*.spec.*",
+    "NOTICE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "build:examples": "tsc -p tsconfig.examples.json",
+    "spike": "pnpm build && pnpm build:examples && node examples-dist/drive.js",
+    "check-types": "tsc --noEmit",
+    "dev": "tsc -w -p tsconfig.json",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@voyantjs/workflows-errors": "workspace:*",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.0",
+    "@voyantjs/voyant-typescript-config": "workspace:*",
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.0"
+  },
+  "peerDependencies": {
+    "zod": "^3.23.0 || ^4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "zod": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/auth/index.ts

@@ -0,0 +1,156 @@
+// @voyantjs/workflows/auth
+//
+// Paired HMAC signer + verifier for the `X-Voyant-Dispatch-Auth`
+// header on `POST /__voyant/workflow-step`. Both sides share a
+// symmetric secret — suitable for local dev and single-region
+// deployments; asymmetric signing (control-plane issuer + tenant
+// public-key) is a later upgrade that keeps the same header shape.
+//
+// Built on Web Crypto (`crypto.subtle`), so it works unchanged in
+// Node 20+, Cloudflare Workers, Deno, Bun, and browsers.
+//
+// Usage on the orchestrator side:
+//
+//   import { createHmacSigner } from "@voyantjs/workflows/auth";
+//   const sign = await createHmacSigner(process.env.VOYANT_SIGNING_KEY!);
+//   createDispatchStepHandler(script, { dispatcher, sign });
+//
+// Usage on the tenant side:
+//
+//   import { createHmacVerifier } from "@voyantjs/workflows/auth";
+//   import { createStepHandler } from "@voyantjs/workflows/handler";
+//   const verify = await createHmacVerifier(env.VOYANT_SIGNING_KEY);
+//   export default { fetch: createStepHandler({ verifyRequest: verify }) };
+
+export const AUTH_HEADER = "x-voyant-dispatch-auth" as const;
+
+/**
+ * Returns a verifier that accepts `Authorization: Bearer <token>`
+ * where `<token>` matches any of the `validTokens` (case-sensitive,
+ * constant-time compared). Usable as the `verifyRequest` dep on
+ * `handleWorkerRequest` / `createStepHandler` for the public-facing
+ * surface of an orchestrator or tenant Worker.
+ *
+ * Intended for dev + single-tenant deployments. Production should
+ * issue per-tenant, short-lived tokens from a control plane.
+ */
+export function createBearerVerifier(
+  validTokens: readonly string[],
+): (req: Request) => void {
+  if (validTokens.length === 0) {
+    throw new Error("createBearerVerifier: need at least one valid token");
+  }
+  return (req) => {
+    const header = req.headers.get("authorization");
+    if (!header) throw new Error("missing Authorization header");
+    const match = /^Bearer (.+)$/.exec(header);
+    if (!match) {
+      throw new Error("Authorization header must use the Bearer scheme");
+    }
+    const presented = match[1]!;
+    for (const valid of validTokens) {
+      if (constantTimeEquals(presented, valid)) return;
+    }
+    throw new Error("bearer token does not match any configured value");
+  };
+}
+
+function constantTimeEquals(a: string, b: string): boolean {
+  if (a.length !== b.length) return false;
+  let diff = 0;
+  for (let i = 0; i < a.length; i++) {
+    diff |= a.charCodeAt(i) ^ b.charCodeAt(i);
+  }
+  return diff === 0;
+}
+
+/** Returns a signer: `(body: string) => Promise<string>` (base64 HMAC-SHA256). */
+export async function createHmacSigner(
+  secret: string,
+): Promise<(body: string) => Promise<string>> {
+  const key = await importKey(secret, ["sign"]);
+  return async (body) => {
+    const sig = await crypto.subtle.sign("HMAC", key, encode(body));
+    return toBase64(sig);
+  };
+}
+
+/**
+ * Returns a verifier: `(req: Request) => Promise<void>`. Throws if:
+ *   - the header is missing,
+ *   - the signature is malformed,
+ *   - the signature does not match the current body.
+ *
+ * The verifier consumes `req.body` via `req.text()`. Callers that
+ * need the body downstream should pre-clone: `req.clone()` before
+ * passing in.
+ */
+export async function createHmacVerifier(
+  secret: string,
+): Promise<(req: Request) => Promise<void>> {
+  const key = await importKey(secret, ["verify"]);
+  return async (req) => {
+    const header = req.headers.get(AUTH_HEADER);
+    if (!header) {
+      throw new Error(`missing ${AUTH_HEADER} header`);
+    }
+    let sig: ArrayBuffer;
+    try {
+      sig = fromBase64(header);
+    } catch {
+      throw new Error(`malformed ${AUTH_HEADER} header (expected base64)`);
+    }
+    const body = await req.clone().text();
+    const ok = await crypto.subtle.verify("HMAC", key, sig, encode(body));
+    if (!ok) {
+      throw new Error(`${AUTH_HEADER} signature does not match request body`);
+    }
+  };
+}
+
+// ---- Internals ----
+
+async function importKey(
+  secret: string,
+  usages: readonly ("sign" | "verify")[],
+): Promise<CryptoKey> {
+  if (secret.length === 0) {
+    throw new Error("HMAC secret must be a non-empty string");
+  }
+  return crypto.subtle.importKey(
+    "raw",
+    encode(secret),
+    { name: "HMAC", hash: "SHA-256" },
+    false,
+    usages as KeyUsage[],
+  );
+}
+
+/**
+ * Encode to a freshly-allocated ArrayBuffer. TextEncoder's Uint8Array
+ * is typed as `Uint8Array<ArrayBufferLike>` under recent TS lib, which
+ * doesn't satisfy the `BufferSource` param of `subtle.sign/verify`.
+ * Copying into a new ArrayBuffer sidesteps the nominal mismatch.
+ */
+function encode(s: string): ArrayBuffer {
+  const view = new TextEncoder().encode(s);
+  const buf = new ArrayBuffer(view.byteLength);
+  new Uint8Array(buf).set(view);
+  return buf;
+}
+
+function toBase64(buffer: ArrayBuffer): string {
+  // btoa is available in every modern runtime (Node 16+, Workers, browsers).
+  const bytes = new Uint8Array(buffer);
+  let bin = "";
+  for (let i = 0; i < bytes.length; i++) bin += String.fromCharCode(bytes[i]!);
+  return btoa(bin);
+}
+
+function fromBase64(s: string): ArrayBuffer {
+  const bin = atob(s);
+  const buf = new ArrayBuffer(bin.length);
+  const view = new Uint8Array(buf);
+  for (let i = 0; i < bin.length; i++) view[i] = bin.charCodeAt(i);
+  return buf;
+}

package/src/conditions.ts

@@ -0,0 +1,43 @@
+// Condition types used in step options (waitFor / cancelIf / skipIf)
+// and in event-filter match expressions.
+// Authoritative contract in docs/sdk-surface.md §4.
+
+import type { Duration, RunStatus } from "./types.js";
+
+export interface EventCondition {
+  event: string;
+  match?: Record<string, unknown> | ((payload: unknown) => boolean);
+}
+
+export interface SignalCondition {
+  signal: string;
+  match?: Record<string, unknown> | ((payload: unknown) => boolean);
+}
+
+export interface TimeCondition {
+  after?: Duration | Date;
+  before?: Duration | Date;
+}
+
+export interface RunStatusCondition {
+  run: { id: string; status: RunStatus[] };
+}
+
+export interface OrCondition {
+  or: Condition[];
+}
+
+export interface AndCondition {
+  and: Condition[];
+}
+
+export type Condition =
+  | EventCondition
+  | SignalCondition
+  | TimeCondition
+  | RunStatusCondition
+  | OrCondition
+  | AndCondition;
+
+export const or = (...conditions: Condition[]): OrCondition => ({ or: conditions });
+export const and = (...conditions: Condition[]): AndCondition => ({ and: conditions });