@openwop/openwop 1.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 David Tufts and openwop contributors
+
+   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/README.md

@@ -0,0 +1,149 @@
+# `@openwop/openwop` — TypeScript SDK for the Multi-Agent Workflow Orchestration Protocol
+
+**openwop is an open, wire-level protocol for multi-agent workflow orchestration** — a single contract for runs in which LLM agents, deterministic tools, sub-workflows, and human reviewers collaborate, with durable suspend / resume, replay, version negotiation, and observability owned by the protocol itself. This package is the reference TypeScript client: typed methods for every spec'd REST endpoint plus an async-iterable SSE consumer, zero runtime deps.
+
+```bash
+npm install @openwop/openwop
+```
+
+> **Spec:** [github.com/openwop/openwop](https://github.com/openwop/openwop) · **Status:** FINAL v1 (2026-04-27) · **Mirrors:** [`api/openapi.yaml`](https://github.com/openwop/openwop/blob/main/api/openapi.yaml)
+
+The SDK is hand-authored rather than codegen'd from OpenAPI for two reasons:
+
+1. **Idiomatic shape.** OpenAPI codegen produces verbose accessors (`api.runs.runs_create()`, etc.) that are nicer if hand-curated. A v1 reference SDK should set the API style other ecosystems (Python, Go) follow.
+2. **Stays close to the spec.** Each method maps 1:1 to a documented endpoint, and types come from the spec's JSON Schemas (referenced via the OpenAPI doc), not from a generator's intermediate representation.
+
+---
+
+## Quickstart
+
+```typescript
+import { OpenwopClient } from '@openwop/openwop';
+
+const client = new OpenwopClient({
+  baseUrl: 'https://api.example.com',
+  apiKey: 'hk_test_abc123',
+});
+
+// Discovery
+const caps = await client.discovery.capabilities();
+console.log(caps.protocolVersion, caps.limits);
+
+// Workflows
+const wf = await client.workflows.get('my-workflow-id');
+
+// Run lifecycle
+const { runId } = await client.runs.create({
+  workflowId: 'my-workflow-id',
+  inputs: { foo: 'bar' },
+});
+
+// Poll (or use SSE — see below)
+let snap = await client.runs.get(runId);
+while (snap.status !== 'completed' && snap.status !== 'failed') {
+  await new Promise((r) => setTimeout(r, 500));
+  snap = await client.runs.get(runId);
+}
+
+// Cancel mid-flight
+await client.runs.cancel(runId, { reason: 'user request' });
+
+// HITL approval (run-scoped)
+await client.interrupts.resolveByRun(runId, 'gate', { resumeValue: { action: 'accept' } });
+
+// Replay / fork
+const fork = await client.runs.fork(runId, { fromSeq: 5, mode: 'branch' });
+
+// SSE stream
+for await (const event of client.runs.events(runId, { streamMode: 'updates' })) {
+  console.log(event.type, event.payload);
+}
+```
+
+---
+
+## Quickstart (Node)
+
+```bash
+cd sdk/typescript
+npm install        # installs @openwop/openwop deps locally (NOT in parent monorepo)
+npx tsc --noEmit   # typecheck the SDK source
+```
+
+---
+
+## What's Covered In v1.0
+
+| Endpoint | SDK method |
+|---|---|
+| `GET /.well-known/openwop` | `client.discovery.capabilities()` |
+| `GET /v1/openapi.json` | `client.discovery.openapi()` |
+| `GET /v1/workflows/{id}` | `client.workflows.get(id)` |
+| `POST /v1/runs` | `client.runs.create(body, opts?)` |
+| `GET /v1/runs/{id}` | `client.runs.get(id)` |
+| `GET /v1/runs/{id}/events` (SSE) | `client.runs.events(id, opts?)` (async iterable) |
+| `GET /v1/runs/{id}/events/poll` | `client.runs.pollEvents(id, opts?)` |
+| `POST /v1/runs/{id}/cancel` | `client.runs.cancel(id, body?)` |
+| `POST /v1/runs/{id}:fork` | `client.runs.fork(id, body)` |
+| `POST /v1/runs/{id}/interrupts/{nodeId}` | `client.interrupts.resolveByRun(id, nodeId, body)` |
+| `GET /v1/interrupts/{token}` | `client.interrupts.inspectByToken(token)` |
+| `POST /v1/interrupts/{token}` | `client.interrupts.resolveByToken(token, body)` |
+
+**Idempotency-Key** is supported via the `idempotencyKey` option on every mutation method.
+
+**Typed `RunConfigurable`** — `client.runs.create(...).configurable` is now a typed surface with reserved keys (`recursionLimit`, `model`, `temperature`, `maxTokens`, `promptOverrides`) plus pass-through for impl extensions.
+
+## Error Handling
+
+```typescript
+import { HTTP_ERROR_CODES, isHttpErrorCode, WopError } from '@openwop/openwop';
+
+try {
+  await client.runs.create({ workflowId: 'my-workflow-id' });
+} catch (err) {
+  if (err instanceof WopError && isHttpErrorCode(err.envelope?.error)) {
+    console.error(err.envelope.error, err.envelope.details);
+  }
+}
+```
+
+`HTTP_ERROR_CODES` is the canonical REST/MCP error-envelope vocabulary (`unauthenticated`, `validation_error`, `run_already_active`, etc.). Contextual fields live under `ErrorEnvelope.details`; for example retry hints are `details.retryAfter`, not a top-level response field. `RUN_ERROR_CODES` is separate and applies to `RunSnapshot.error.code` after a run itself fails.
+
+---
+
+## Not In The v1.0 SDK
+
+| Feature | Why |
+|---|---|
+| Webhook subscription helpers | v1 specifies webhook delivery, but the SDK keeps endpoint coverage focused on the run lifecycle and conformance-critical surfaces. |
+| Hosted registry publishing helpers | Node-pack registry publishing needs operator-specific credentials and policy; use direct HTTP until a dedicated package workflow is warranted. |
+| Auto-retry with exponential backoff | Retry policy is application-specific. The SDK exposes structured errors so callers can implement their own retry envelope. |
+| Separate browser entrypoint (`@openwop/openwop/browser`) | The default ESM build uses standard `fetch`/`ReadableStream` primitives and can be bundled by modern tools; a dedicated browser subpath can ship later without changing the v1 surface. |
+
+---
+
+## Layout
+
+```
+sdk/typescript/
+  README.md                  — this file
+  package.json               — @openwop/openwop package manifest
+  tsconfig.json              — strict TS, ESM
+  src/
+    index.ts                 — public surface (OpenwopClient + types)
+    client.ts                — OpenwopClient class (auth, request helper)
+    types.ts                 — request/response types mirrored from the OpenAPI spec
+    sse.ts                   — async-iterable SSE consumer
+```
+
+---
+
+## Versioning
+
+This SDK tracks OpenWOP v1. SDK majors match the protocol major; v1.x SDK releases remain forward-compatible with the v1 wire contract. Mismatch behavior is forward-compat tolerant — see `../../version-negotiation.md`. Breaking spec changes will increment the SDK major.
+
+## References
+
+- Spec corpus: `../../README.md`
+- OpenAPI: `../../api/openapi.yaml` (the SDK mirrors this surface)
+- AsyncAPI: `../../api/asyncapi.yaml` (the SSE consumer follows these channels)

package/dist/client.d.ts

@@ -0,0 +1,72 @@
+/**
+ * OpenwopClient — typed HTTP client for the openwop REST surface.
+ *
+ * Hand-authored. Each method maps 1:1 to a documented endpoint in
+ * ../../api/openapi.yaml. Request/response types live in ./types.ts.
+ *
+ * Auth: a single bearer-style API key, supplied at construction. See
+ * ../../auth.md for credential format.
+ */
+import { type EventsStreamOptions } from './sse.js';
+import { type Capabilities, type CancelRunRequest, type CancelRunResponse, type CreateRunRequest, type CreateRunResponse, type ForkRunRequest, type ForkRunResponse, type InterruptByTokenInspection, type PollEventsResponse, type ResolveInterruptByTokenResponse, type ResolveInterruptRequest, type ResolveInterruptResponse, type RunEventDoc, type RunSnapshot } from './types.js';
+export interface OpenwopClientOptions {
+    /** Base URL of the openwop server, e.g., `https://api.example.com`. Trailing slash optional. */
+    readonly baseUrl: string;
+    /** API key (bearer-style). See auth.md. */
+    readonly apiKey: string;
+    /** Optional fetch implementation override (test injection). Defaults to global `fetch`. */
+    readonly fetch?: typeof fetch;
+    /** Default `Accept-Language` to send. Optional. */
+    readonly acceptLanguage?: string;
+}
+export interface MutationOptions {
+    /** RFC-spec'd Idempotency-Key for at-most-once mutation semantics. */
+    readonly idempotencyKey?: string;
+    /** Optional X-Dedup hint for cross-host claim coordination on POST /v1/runs. */
+    readonly dedup?: 'enforce';
+}
+export declare class OpenwopClient {
+    #private;
+    constructor(opts: OpenwopClientOptions);
+    readonly discovery: {
+        capabilities: () => Promise<Capabilities>;
+        openapi: () => Promise<unknown>;
+    };
+    readonly workflows: {
+        get: (workflowId: string) => Promise<unknown>;
+    };
+    readonly runs: {
+        create: (body: CreateRunRequest, opts?: MutationOptions) => Promise<CreateRunResponse>;
+        get: (runId: string) => Promise<RunSnapshot>;
+        cancel: (runId: string, body?: CancelRunRequest, opts?: MutationOptions) => Promise<CancelRunResponse>;
+        fork: (runId: string, body: ForkRunRequest, opts?: MutationOptions) => Promise<ForkRunResponse>;
+        pollEvents: (runId: string, params?: {
+            lastSequence?: number;
+            timeoutSeconds?: number;
+        }) => Promise<PollEventsResponse>;
+        /**
+         * Async-iterable SSE consumer. The connection auto-closes when the
+         * server closes the stream (terminal run event); break out of the
+         * loop or call `signal.abort()` to terminate early.
+         */
+        events: (runId: string, opts?: EventsStreamOptions) => AsyncGenerator<RunEventDoc, void, void>;
+    };
+    readonly interrupts: {
+        resolveByRun: (runId: string, nodeId: string, body: ResolveInterruptRequest, opts?: MutationOptions) => Promise<ResolveInterruptResponse>;
+        /**
+         * Inspect an interrupt via signed token — useful for showing the
+         * interrupt's `kind`, `data`, and `resumeSchema` to a downstream
+         * UI before the user resolves. Token is the auth, no API key
+         * required (signed-token endpoints intentionally bypass bearer
+         * auth so external systems can resolve without openwop credentials).
+         */
+        inspectByToken: (token: string) => Promise<InterruptByTokenInspection>;
+        /**
+         * Resolve an interrupt via signed token — used by external
+         * systems (calendar webhooks, payment confirmations) that the
+         * engine handed a callback URL at suspension time.
+         */
+        resolveByToken: (token: string, body: ResolveInterruptRequest, opts?: MutationOptions) => Promise<ResolveInterruptByTokenResponse>;
+    };
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAgB,KAAK,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAClE,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EAEtB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,0BAA0B,EAC/B,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,EACpC,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,WAAW,EAChB,KAAK,WAAW,EACjB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,oBAAoB;IACnC,gGAAgG;IAChG,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,2CAA2C;IAC3C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,2FAA2F;IAC3F,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IAC9B,mDAAmD;IACnD,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,eAAe;IAC9B,sEAAsE;IACtE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,gFAAgF;IAChF,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;CAC5B;AAUD,qBAAa,aAAa;;gBAMZ,IAAI,EAAE,oBAAoB;IAUtC,QAAQ,CAAC,SAAS;4BACE,OAAO,CAAC,YAAY,CAAC;uBAG1B,OAAO,CAAC,OAAO,CAAC;MAE7B;IAGF,QAAQ,CAAC,SAAS;0BACE,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;MAK3C;IAGF,QAAQ,CAAC,IAAI;uBACI,gBAAgB,SAAQ,eAAe,KAAQ,OAAO,CAAC,iBAAiB,CAAC;qBAQ3E,MAAM,KAAG,OAAO,CAAC,WAAW,CAAC;wBAOjC,MAAM,SACP,gBAAgB,SAChB,eAAe,KACpB,OAAO,CAAC,iBAAiB,CAAC;sBASpB,MAAM,QACP,cAAc,SACd,eAAe,KACpB,OAAO,CAAC,eAAe,CAAC;4BASlB,MAAM,WACL;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,cAAc,CAAC,EAAE,MAAM,CAAA;SAAE,KACzD,OAAO,CAAC,kBAAkB,CAAC;QAe9B;;;;WAIG;wBACa,MAAM,SAAQ,mBAAmB,KAAQ,cAAc,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC;MAEhG;IAGF,QAAQ,CAAC,UAAU;8BAER,MAAM,UACL,MAAM,QACR,uBAAuB,SACvB,eAAe,KACpB,OAAO,CAAC,wBAAwB,CAAC;QAQpC;;;;;;WAMG;gCACqB,MAAM,KAAG,OAAO,CAAC,0BAA0B,CAAC;QASpE;;;;WAIG;gCAEM,MAAM,QACP,uBAAuB,SACvB,eAAe,KACpB,OAAO,CAAC,+BAA+B,CAAC;MAU3C;CAsEH"}

package/dist/client.js

@@ -0,0 +1,178 @@
+/**
+ * OpenwopClient — typed HTTP client for the openwop REST surface.
+ *
+ * Hand-authored. Each method maps 1:1 to a documented endpoint in
+ * ../../api/openapi.yaml. Request/response types live in ./types.ts.
+ *
+ * Auth: a single bearer-style API key, supplied at construction. See
+ * ../../auth.md for credential format.
+ */
+import { streamEvents } from './sse.js';
+import { WopError, } from './types.js';
+export class OpenwopClient {
+    #baseUrl;
+    #apiKey;
+    #fetch;
+    #acceptLanguage;
+    constructor(opts) {
+        if (!opts.baseUrl)
+            throw new TypeError('OpenwopClient: baseUrl is required');
+        if (!opts.apiKey)
+            throw new TypeError('OpenwopClient: apiKey is required');
+        this.#baseUrl = opts.baseUrl.replace(/\/$/, '');
+        this.#apiKey = opts.apiKey;
+        this.#fetch = opts.fetch ?? fetch;
+        this.#acceptLanguage = opts.acceptLanguage;
+    }
+    // ── Discovery ────────────────────────────────────────────────────────
+    discovery = {
+        capabilities: () => this.#request({ method: 'GET', path: '/.well-known/openwop' }, false),
+        openapi: () => this.#request({ method: 'GET', path: '/v1/openapi.json' }, false),
+    };
+    // ── Workflows ────────────────────────────────────────────────────────
+    workflows = {
+        get: (workflowId) => this.#request({
+            method: 'GET',
+            path: `/v1/workflows/${encodeURIComponent(workflowId)}`,
+        }),
+    };
+    // ── Runs ─────────────────────────────────────────────────────────────
+    runs = {
+        create: (body, opts = {}) => this.#request({
+            method: 'POST',
+            path: '/v1/runs',
+            body,
+            headers: this.#mutationHeaders(opts),
+        }),
+        get: (runId) => this.#request({
+            method: 'GET',
+            path: `/v1/runs/${encodeURIComponent(runId)}`,
+        }),
+        cancel: (runId, body = {}, opts = {}) => this.#request({
+            method: 'POST',
+            path: `/v1/runs/${encodeURIComponent(runId)}/cancel`,
+            body,
+            headers: this.#mutationHeaders(opts),
+        }),
+        fork: (runId, body, opts = {}) => this.#request({
+            method: 'POST',
+            path: `/v1/runs/${encodeURIComponent(runId)}:fork`,
+            body,
+            headers: this.#mutationHeaders(opts),
+        }),
+        pollEvents: (runId, params = {}) => {
+            const search = new URLSearchParams();
+            if (params.lastSequence !== undefined) {
+                search.set('lastSequence', String(params.lastSequence));
+            }
+            if (params.timeoutSeconds !== undefined) {
+                search.set('timeout', String(params.timeoutSeconds));
+            }
+            const qs = search.toString();
+            return this.#request({
+                method: 'GET',
+                path: `/v1/runs/${encodeURIComponent(runId)}/events/poll${qs ? `?${qs}` : ''}`,
+            });
+        },
+        /**
+         * Async-iterable SSE consumer. The connection auto-closes when the
+         * server closes the stream (terminal run event); break out of the
+         * loop or call `signal.abort()` to terminate early.
+         */
+        events: (runId, opts = {}) => streamEvents({ baseUrl: this.#baseUrl, apiKey: this.#apiKey }, runId, opts),
+    };
+    // ── HITL interrupts (run-scoped + signed-token) ──────────────────────
+    interrupts = {
+        resolveByRun: (runId, nodeId, body, opts = {}) => this.#request({
+            method: 'POST',
+            path: `/v1/runs/${encodeURIComponent(runId)}/interrupts/${encodeURIComponent(nodeId)}`,
+            body,
+            headers: this.#mutationHeaders(opts),
+        }),
+        /**
+         * Inspect an interrupt via signed token — useful for showing the
+         * interrupt's `kind`, `data`, and `resumeSchema` to a downstream
+         * UI before the user resolves. Token is the auth, no API key
+         * required (signed-token endpoints intentionally bypass bearer
+         * auth so external systems can resolve without openwop credentials).
+         */
+        inspectByToken: (token) => this.#request({
+            method: 'GET',
+            path: `/v1/interrupts/${encodeURIComponent(token)}`,
+        }, false),
+        /**
+         * Resolve an interrupt via signed token — used by external
+         * systems (calendar webhooks, payment confirmations) that the
+         * engine handed a callback URL at suspension time.
+         */
+        resolveByToken: (token, body, opts = {}) => this.#request({
+            method: 'POST',
+            path: `/v1/interrupts/${encodeURIComponent(token)}`,
+            body,
+            headers: this.#mutationHeaders(opts),
+        }, false),
+    };
+    // ── Internals ────────────────────────────────────────────────────────
+    #mutationHeaders(opts) {
+        const h = {};
+        if (opts.idempotencyKey)
+            h['Idempotency-Key'] = opts.idempotencyKey;
+        if (opts.dedup)
+            h['X-Dedup'] = opts.dedup;
+        return h;
+    }
+    async #request(opts, authenticated = true) {
+        const url = `${this.#baseUrl}${opts.path}`;
+        const headers = {
+            Accept: 'application/json',
+            ...(opts.headers ?? {}),
+        };
+        if (opts.body !== undefined && headers['Content-Type'] === undefined) {
+            headers['Content-Type'] = 'application/json';
+        }
+        if (authenticated) {
+            headers.Authorization = `Bearer ${this.#apiKey}`;
+        }
+        if (this.#acceptLanguage) {
+            headers['Accept-Language'] = this.#acceptLanguage;
+        }
+        const init = { method: opts.method, headers };
+        if (opts.body !== undefined) {
+            init.body = JSON.stringify(opts.body);
+        }
+        if (opts.signal) {
+            init.signal = opts.signal;
+        }
+        const res = await this.#fetch(url, init);
+        const text = await res.text();
+        // Capture traceparent for error reporting per observability.md
+        // §Trace context propagation. Header name is case-insensitive per
+        // RFC 9110; fetch normalizes to lowercase but be defensive.
+        const traceparent = res.headers.get('traceparent') ?? res.headers.get('Traceparent') ?? undefined;
+        if (!res.ok) {
+            let env;
+            try {
+                const parsed = text.length > 0 ? JSON.parse(text) : undefined;
+                if (parsed && typeof parsed === 'object' && 'error' in parsed && 'message' in parsed) {
+                    env = parsed;
+                }
+            }
+            catch {
+                // not JSON; leave envelope undefined
+            }
+            throw new WopError(res.status, text, env, traceparent);
+        }
+        if (text.length === 0)
+            return undefined;
+        try {
+            return JSON.parse(text);
+        }
+        catch {
+            throw new WopError(res.status, text, {
+                error: 'invalid_json',
+                message: 'Server returned non-JSON body for a 2xx response',
+            }, traceparent);
+        }
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,YAAY,EAA4B,MAAM,UAAU,CAAC;AAClE,OAAO,EACL,QAAQ,GAgBT,MAAM,YAAY,CAAC;AA4BpB,MAAM,OAAO,aAAa;IACf,QAAQ,CAAS;IACjB,OAAO,CAAS;IAChB,MAAM,CAAe;IACrB,eAAe,CAAqB;IAE7C,YAAY,IAA0B;QACpC,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,SAAS,CAAC,oCAAoC,CAAC,CAAC;QAC7E,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;QAC3E,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC;QAClC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC;IAC7C,CAAC;IAED,wEAAwE;IAC/D,SAAS,GAAG;QACnB,YAAY,EAAE,GAA0B,EAAE,CACxC,IAAI,CAAC,QAAQ,CAAe,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,sBAAsB,EAAE,EAAE,KAAK,CAAC;QAErF,OAAO,EAAE,GAAqB,EAAE,CAC9B,IAAI,CAAC,QAAQ,CAAU,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE,EAAE,KAAK,CAAC;KAC7E,CAAC;IAEF,wEAAwE;IAC/D,SAAS,GAAG;QACnB,GAAG,EAAE,CAAC,UAAkB,EAAoB,EAAE,CAC5C,IAAI,CAAC,QAAQ,CAAU;YACrB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,iBAAiB,kBAAkB,CAAC,UAAU,CAAC,EAAE;SACxD,CAAC;KACL,CAAC;IAEF,wEAAwE;IAC/D,IAAI,GAAG;QACd,MAAM,EAAE,CAAC,IAAsB,EAAE,OAAwB,EAAE,EAA8B,EAAE,CACzF,IAAI,CAAC,QAAQ,CAAoB;YAC/B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,IAAI;YACJ,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;SACrC,CAAC;QAEJ,GAAG,EAAE,CAAC,KAAa,EAAwB,EAAE,CAC3C,IAAI,CAAC,QAAQ,CAAc;YACzB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,kBAAkB,CAAC,KAAK,CAAC,EAAE;SAC9C,CAAC;QAEJ,MAAM,EAAE,CACN,KAAa,EACb,OAAyB,EAAE,EAC3B,OAAwB,EAAE,EACE,EAAE,CAC9B,IAAI,CAAC,QAAQ,CAAoB;YAC/B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,YAAY,kBAAkB,CAAC,KAAK,CAAC,SAAS;YACpD,IAAI;YACJ,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;SACrC,CAAC;QAEJ,IAAI,EAAE,CACJ,KAAa,EACb,IAAoB,EACpB,OAAwB,EAAE,EACA,EAAE,CAC5B,IAAI,CAAC,QAAQ,CAAkB;YAC7B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,YAAY,kBAAkB,CAAC,KAAK,CAAC,OAAO;YAClD,IAAI;YACJ,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;SACrC,CAAC;QAEJ,UAAU,EAAE,CACV,KAAa,EACb,SAA6D,EAAE,EAClC,EAAE;YAC/B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YACrC,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBACtC,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;YAC1D,CAAC;YACD,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;gBACxC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;YACvD,CAAC;YACD,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,QAAQ,CAAqB;gBACvC,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,YAAY,kBAAkB,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;aAC/E,CAAC,CAAC;QACL,CAAC;QAED;;;;WAIG;QACH,MAAM,EAAE,CAAC,KAAa,EAAE,OAA4B,EAAE,EAA2C,EAAE,CACjG,YAAY,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC;KAC9E,CAAC;IAEF,wEAAwE;IAC/D,UAAU,GAAG;QACpB,YAAY,EAAE,CACZ,KAAa,EACb,MAAc,EACd,IAA6B,EAC7B,OAAwB,EAAE,EACS,EAAE,CACrC,IAAI,CAAC,QAAQ,CAA2B;YACtC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,YAAY,kBAAkB,CAAC,KAAK,CAAC,eAAe,kBAAkB,CAAC,MAAM,CAAC,EAAE;YACtF,IAAI;YACJ,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;SACrC,CAAC;QAEJ;;;;;;WAMG;QACH,cAAc,EAAE,CAAC,KAAa,EAAuC,EAAE,CACrE,IAAI,CAAC,QAAQ,CACX;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,kBAAkB,kBAAkB,CAAC,KAAK,CAAC,EAAE;SACpD,EACD,KAAK,CACN;QAEH;;;;WAIG;QACH,cAAc,EAAE,CACd,KAAa,EACb,IAA6B,EAC7B,OAAwB,EAAE,EACgB,EAAE,CAC5C,IAAI,CAAC,QAAQ,CACX;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,kBAAkB,kBAAkB,CAAC,KAAK,CAAC,EAAE;YACnD,IAAI;YACJ,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;SACrC,EACD,KAAK,CACN;KACJ,CAAC;IAEF,wEAAwE;IACxE,gBAAgB,CAAC,IAAqB;QACpC,MAAM,CAAC,GAA2B,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,cAAc;YAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QACpE,IAAI,IAAI,CAAC,KAAK;YAAE,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1C,OAAO,CAAC,CAAC;IACX,CAAC;IAED,KAAK,CAAC,QAAQ,CAAI,IAAuB,EAAE,aAAa,GAAG,IAAI;QAC7D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC3C,MAAM,OAAO,GAA2B;YACtC,MAAM,EAAE,kBAAkB;YAC1B,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;SACxB,CAAC;QACF,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC,KAAK,SAAS,EAAE,CAAC;YACrE,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QACD,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,CAAC,aAAa,GAAG,UAAU,IAAI,CAAC,OAAO,EAAE,CAAC;QACnD,CAAC;QACD,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QACpD,CAAC;QAED,MAAM,IAAI,GAAgB,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;QAC3D,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC5B,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACzC,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,+DAA+D;QAC/D,kEAAkE;QAClE,4DAA4D;QAC5D,MAAM,WAAW,GACf,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,SAAS,CAAC;QAEhF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,IAAI,GAA8B,CAAC;YACnC,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC9D,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,MAAM,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;oBACrF,GAAG,GAAG,MAAuB,CAAC;gBAChC,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,qCAAqC;YACvC,CAAC;YACD,MAAM,IAAI,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAc,CAAC;QAC7C,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAM,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,QAAQ,CAChB,GAAG,CAAC,MAAM,EACV,IAAI,EACJ;gBACE,KAAK,EAAE,cAAc;gBACrB,OAAO,EAAE,kDAAkD;aAC5D,EACD,WAAW,CACZ,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @openwop/openwop — TypeScript reference SDK for OpenWOP-compliant servers.
+ *
+ * Public surface:
+ *   - OpenwopClient (auth + endpoint methods)
+ *   - WopError (typed error wrapping ErrorEnvelope)
+ *   - All request/response types mirroring the OpenAPI spec
+ *   - streamEvents helper for advanced SSE use cases
+ *
+ * See README.md for usage examples.
+ */
+export { OpenwopClient } from './client.js';
+export type { OpenwopClientOptions, MutationOptions } from './client.js';
+export { WopError } from './types.js';
+export type { Capabilities, CancelRunRequest, CancelRunResponse, CreateRunRequest, CreateRunResponse, ErrorEnvelope, ForkRunRequest, ForkRunResponse, InterruptByTokenInspection, PollEventsResponse, ResolveInterruptByTokenResponse, ResolveInterruptRequest, ResolveInterruptResponse, RunConfigurable, RunEventDoc, RunSnapshot, RunStatus, StreamMode, } from './types.js';
+export { streamEvents } from './sse.js';
+export type { EventsStreamContext, EventsStreamOptions } from './sse.js';
+export { ACTIVE_RUN_STATUSES, TERMINAL_RUN_STATUSES, isTerminalRunStatus, HTTP_ERROR_CODES, isHttpErrorCode, RUN_ERROR_CODES, isRunErrorCode, } from './run-helpers.js';
+export type { ActiveRunStatus, TerminalRunStatus, HttpErrorCode, RunErrorCode, RunError, } from './run-helpers.js';
+//# 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;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,YAAY,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,YAAY,EACV,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,cAAc,EACd,eAAe,EACf,0BAA0B,EAC1B,kBAAkB,EAClB,+BAA+B,EAC/B,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EACf,WAAW,EACX,WAAW,EACX,SAAS,EACT,UAAU,GACX,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,YAAY,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAKzE,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,cAAc,GACf,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,YAAY,EACZ,QAAQ,GACT,MAAM,kBAAkB,CAAC"}