@krizaka/orazaka-client 0.0.0-stage → 0.1.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 reasonable and customary use in 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 [yyyy] [name of copyright owner]
+
+   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

@@ -1,3 +1,20 @@
-# Temporary Holding Version
+# @krizaka/orazaka-client
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+One client of Orazaka's edge for every Krizaka TypeScript product, instead of one copy per product (Yomizaka, Orochia, soon Akinaza): start a Studio run, read its status and its outputs, wait for it. The base URL, the key and the clock are **parameters** — this package reads no environment and no wall clock.
+
+```ts
+import { createOrazakaClient, outputOf } from "@krizaka/orazaka-client";
+
+const orazaka = createOrazakaClient({ baseUrl: "https://api.orazaka.com", apiKey: env.AI_API_KEY, clock: { now: () => new Date() } });
+
+const { run } = await orazaka.startRun("compliance-check", { document: text }, { idempotencyKey: `doc-${documentId}-v${version}` });
+const done = await orazaka.waitForRun(run.id); // or poll `getRun` yourself
+if (done.status === "SUCCEEDED") use(outputOf(done, "report"));
+```
+
+- **Safe to retry.** `startRun` with an `idempotencyKey` answers the run already started for the same key and inputs (`replayed: true`) instead of paying for a second one; the same key for other inputs is `ORAZAKA_KEY_REUSED`.
+- **Typed errors.** Every failure is an `OrazakaError` with a stable `code` (`ORAZAKA_KEY`, `ORAZAKA_CREDITS`, `ORAZAKA_LOCKED`, `ORAZAKA_INPUT`, `ORAZAKA_NOT_FOUND`, `ORAZAKA_BUSY` with `retryAfterSeconds`, `ORAZAKA_UNAVAILABLE`, `ORAZAKA_TIMEOUT`, `ORAZAKA_SHAPE`, `ORAZAKA_CIRCUIT_OPEN`…) and the `status` a product answers its own caller with. A product translates the codes; none is a sentence. A failed *run* is not an error: `waitForRun` gives it back with its `errorMessage`.
+- **A time limit and a circuit breaker**, as options: `timeoutMs` (20 s by default) on every call; five failures in a row (no answer, timeout, 5xx) open the circuit for 30 s — it refuses at once, then lets one call probe. A refusal (401, 402, 404, 429…) is an answer and never opens it. `circuit: false` turns it off.
+- **Contract-tested** against the edge's answers kept as fixtures (`test/fixtures`): when the edge changes a shape, the fixture changes first.
+
+Run events as a stream (Server-Sent Events, `GET /api/v1/studios/runs/{id}/events`) come in a later minor; `waitForRun` polls until then.

package/dist/index.d.ts

@@ -0,0 +1,172 @@
+interface Clock {
+    now(): Date;
+}
+interface CircuitOptions {
+    /** Consecutive failures (no answer, timeout, 5xx) that open the circuit. */
+    failureThreshold: number;
+    /** How long it stays open before one call is let through to probe. */
+    openSeconds: number;
+}
+/**
+ * A circuit breaker over a dependency that may be down: after `failureThreshold` failures in a row it refuses at once (no waiting on
+ * a timeout, no load on a struggling service) for `openSeconds`, then lets ONE call through; its success closes the circuit, its
+ * failure opens it again. A refusal of the edge (401, 402, 404…) is an answer, not a failure: only the caller reports failures.
+ */
+declare function createCircuit(options: CircuitOptions, clock: Clock): {
+    /** Throws `ORAZAKA_CIRCUIT_OPEN` while the circuit is open (or its probe is in flight). */
+    check(): void;
+    success(): void;
+    failure(): void;
+    /** Test and diagnostics: is it refusing now? */
+    readonly isOpen: boolean;
+};
+type Circuit = ReturnType<typeof createCircuit>;
+
+/** One output of a run (orazaka-studio `RunArtefactResponse`): `type` is a rendering hint (`TEXT`, `IMAGE`, `VIDEO`…). */
+interface RunOutput {
+    key: string;
+    label: string | null;
+    type: string;
+    value: string | null;
+}
+/** Where a run sits (orazaka-studio `RunStatus`). The client keeps the string the edge sent, so a new status is not a failure. */
+declare const RUN_STATUS: {
+    readonly pendingApproval: "PENDING_APPROVAL";
+    readonly running: "RUNNING";
+    readonly awaitingInput: "AWAITING_INPUT";
+    readonly succeeded: "SUCCEEDED";
+    readonly failed: "FAILED";
+    readonly cancelled: "CANCELLED";
+    readonly compensating: "COMPENSATING";
+};
+/** A run, as the edge answers it (`GET /api/v1/studios/runs/{id}`). Only what a product reads. */
+interface OrazakaRun {
+    id: string;
+    studioKey: string;
+    blueprintVersion: string | null;
+    status: string;
+    outputs: RunOutput[];
+    errorMessage: string | null;
+    startedAt: string | null;
+    finishedAt: string | null;
+}
+/** The run is over, green or not: nothing more will change. */
+declare const isTerminal: (run: Pick<OrazakaRun, "status">) => boolean;
+/** The value of one output, or null when the run did not produce it (yet). */
+declare const outputOf: (run: Pick<OrazakaRun, "outputs">, key: string) => string | null;
+/** Reads a run from the edge's JSON; anything else is `ORAZAKA_SHAPE`. */
+declare function parseRun(body: unknown): OrazakaRun;
+/** The Studios an account installed: `GET /api/v1/studios/installations`. */
+declare function parseInstallations(body: unknown): string[];
+
+type Fetch = typeof fetch;
+interface OrazakaClientOptions {
+    /** `https://api.orazaka.com` — the edge. A parameter: this package reads no environment. */
+    baseUrl: string;
+    /** The product's service key (`oz_…`). Without one every call throws `ORAZAKA_NOT_CONFIGURED`. */
+    apiKey: string | undefined;
+    /** Time is injected: the circuit and `waitForRun` read it from here. */
+    clock: Clock;
+    fetch?: Fetch;
+    /** One call's time limit, in milliseconds (default 20 000). */
+    timeoutMs?: number;
+    /** The breaker: `false` for none; default 5 failures in a row open it for 30 seconds. */
+    circuit?: CircuitOptions | false;
+    /** Install the Studio on the account before its first run (default true: the edge asks for it). */
+    autoInstall?: boolean;
+    /** How `waitForRun` waits between two reads (default `setTimeout`); tests give their own. */
+    sleep?: (milliseconds: number) => Promise<void>;
+}
+interface StartRunOptions {
+    /** Retrying with the same key (and the same inputs) answers the run already started instead of paying for a second one. */
+    idempotencyKey?: string;
+}
+interface StartedRun {
+    run: OrazakaRun;
+    /** The edge answered a run it had already started for this key (`Idempotent-Replayed`). */
+    replayed: boolean;
+}
+interface WaitOptions {
+    /** Between two reads, in milliseconds (default 2 000). */
+    intervalMs?: number;
+    /** Give up after this long, in milliseconds (default 120 000): `ORAZAKA_WAIT_EXPIRED`. */
+    timeoutMs?: number;
+}
+interface OrazakaClient {
+    /** Starts a Studio run (`POST /api/v1/studios/{studio}/runs`, 202). Pass an idempotency key to make the retry safe. */
+    startRun(studio: string, inputs: Record<string, unknown>, options?: StartRunOptions): Promise<StartedRun>;
+    /** The run, its status and its outputs (`GET /api/v1/studios/runs/{id}`). */
+    getRun(runId: string): Promise<OrazakaRun>;
+    /** Reads the run until it is over (succeeded, failed or cancelled) and answers it; a failed run is returned, not thrown. */
+    waitForRun(runId: string, options?: WaitOptions): Promise<OrazakaRun>;
+    /** The Studios this key has installed — also the cheapest call that proves the key and the connection. */
+    studios(): Promise<string[]>;
+    /** The circuit breaker, for diagnostics. */
+    readonly circuit: Circuit | null;
+}
+/** Orazaka's edge, for every TypeScript product: one client instead of one copy per product. */
+declare function createOrazakaClient(options: OrazakaClientOptions): OrazakaClient;
+
+/** The stable codes of a refusal or a failure of Orazaka's edge — a product translates them; none is a sentence. */
+declare const ORAZAKA_CODE: {
+    /** No API key was given. */
+    readonly notConfigured: "ORAZAKA_NOT_CONFIGURED";
+    /** 401/403: the key is wrong, revoked or lacks the right. */
+    readonly key: "ORAZAKA_KEY";
+    /** 402: the run is not affordable now. */
+    readonly credits: "ORAZAKA_CREDITS";
+    /** 409: the Studio is locked (to buy, or already installed). */
+    readonly locked: "ORAZAKA_LOCKED";
+    /** 400/422: the inputs are not what the Studio asks for. */
+    readonly input: "ORAZAKA_INPUT";
+    /** 404: no such Studio or run (or not the caller's). */
+    readonly notFound: "ORAZAKA_NOT_FOUND";
+    /** 429: too many runs at once; `retryAfterSeconds` says when to come back. Not a failure of the document. */
+    readonly busy: "ORAZAKA_BUSY";
+    /** 422 `idempotency_key_reused`: the key already started a different request. */
+    readonly keyReused: "ORAZAKA_KEY_REUSED";
+    /** 451: a consent is to be agreed to first. */
+    readonly consent: "ORAZAKA_CONSENT";
+    /** The edge did not answer, or answered 5xx. */
+    readonly unavailable: "ORAZAKA_UNAVAILABLE";
+    /** The edge did not answer within the time given. */
+    readonly timeout: "ORAZAKA_TIMEOUT";
+    /** The edge answered something that is not a run (or a list of installations). */
+    readonly shape: "ORAZAKA_SHAPE";
+    /** Too many failures in a row: the client does not call until the pause is over. */
+    readonly circuitOpen: "ORAZAKA_CIRCUIT_OPEN";
+    /** A run id that is not one: refused before any call. */
+    readonly badRun: "ORAZAKA_BAD_RUN";
+    /** `waitForRun` gave up: the run was still going. */
+    readonly waitExpired: "ORAZAKA_WAIT_EXPIRED";
+};
+type OrazakaCode = (typeof ORAZAKA_CODE)[keyof typeof ORAZAKA_CODE];
+/** What the edge's status means for a product that answers its own caller: the status to send back and the code. */
+declare function orazakaRefusal(status: number): {
+    status: number;
+    code: OrazakaCode;
+};
+declare class OrazakaError extends Error {
+    readonly code: OrazakaCode;
+    readonly details: {
+        /** What the edge answered, when it answered. */
+        upstreamStatus?: number;
+        /** The status a product should answer its own caller with. */
+        status?: number;
+        /** For `ORAZAKA_BUSY` and `ORAZAKA_CIRCUIT_OPEN`: seconds to wait. */
+        retryAfterSeconds?: number;
+    };
+    constructor(code: OrazakaCode, message: string, details?: {
+        /** What the edge answered, when it answered. */
+        upstreamStatus?: number;
+        /** The status a product should answer its own caller with. */
+        status?: number;
+        /** For `ORAZAKA_BUSY` and `ORAZAKA_CIRCUIT_OPEN`: seconds to wait. */
+        retryAfterSeconds?: number;
+    });
+    /** The HTTP status a product answers its own caller with (502 for a failure upstream, 429 when busy). */
+    get status(): number;
+    get retryAfterSeconds(): number | undefined;
+}
+
+export { type Circuit, type CircuitOptions, type Clock, ORAZAKA_CODE, type OrazakaClient, type OrazakaClientOptions, type OrazakaCode, OrazakaError, type OrazakaRun, RUN_STATUS, type RunOutput, type StartRunOptions, type StartedRun, type WaitOptions, createCircuit, createOrazakaClient, isTerminal, orazakaRefusal, outputOf, parseInstallations, parseRun };

package/dist/index.js

@@ -0,0 +1,257 @@
+// src/circuit.ts
+import { addSeconds, differenceInSeconds, isBefore } from "date-fns";
+
+// src/errors.ts
+var ORAZAKA_CODE = {
+  /** No API key was given. */
+  notConfigured: "ORAZAKA_NOT_CONFIGURED",
+  /** 401/403: the key is wrong, revoked or lacks the right. */
+  key: "ORAZAKA_KEY",
+  /** 402: the run is not affordable now. */
+  credits: "ORAZAKA_CREDITS",
+  /** 409: the Studio is locked (to buy, or already installed). */
+  locked: "ORAZAKA_LOCKED",
+  /** 400/422: the inputs are not what the Studio asks for. */
+  input: "ORAZAKA_INPUT",
+  /** 404: no such Studio or run (or not the caller's). */
+  notFound: "ORAZAKA_NOT_FOUND",
+  /** 429: too many runs at once; `retryAfterSeconds` says when to come back. Not a failure of the document. */
+  busy: "ORAZAKA_BUSY",
+  /** 422 `idempotency_key_reused`: the key already started a different request. */
+  keyReused: "ORAZAKA_KEY_REUSED",
+  /** 451: a consent is to be agreed to first. */
+  consent: "ORAZAKA_CONSENT",
+  /** The edge did not answer, or answered 5xx. */
+  unavailable: "ORAZAKA_UNAVAILABLE",
+  /** The edge did not answer within the time given. */
+  timeout: "ORAZAKA_TIMEOUT",
+  /** The edge answered something that is not a run (or a list of installations). */
+  shape: "ORAZAKA_SHAPE",
+  /** Too many failures in a row: the client does not call until the pause is over. */
+  circuitOpen: "ORAZAKA_CIRCUIT_OPEN",
+  /** A run id that is not one: refused before any call. */
+  badRun: "ORAZAKA_BAD_RUN",
+  /** `waitForRun` gave up: the run was still going. */
+  waitExpired: "ORAZAKA_WAIT_EXPIRED"
+};
+function orazakaRefusal(status) {
+  if (status === 401 || status === 403) return { status: 502, code: ORAZAKA_CODE.key };
+  if (status === 402) return { status: 502, code: ORAZAKA_CODE.credits };
+  if (status === 409) return { status: 502, code: ORAZAKA_CODE.locked };
+  if (status === 400 || status === 422) return { status: 422, code: ORAZAKA_CODE.input };
+  if (status === 404) return { status: 502, code: ORAZAKA_CODE.notFound };
+  if (status === 429) return { status: 429, code: ORAZAKA_CODE.busy };
+  if (status === 451) return { status: 502, code: ORAZAKA_CODE.consent };
+  return { status: 502, code: ORAZAKA_CODE.unavailable };
+}
+var OrazakaError = class extends Error {
+  constructor(code, message, details = {}) {
+    super(message);
+    this.code = code;
+    this.details = details;
+    this.name = "OrazakaError";
+  }
+  code;
+  details;
+  /** The HTTP status a product answers its own caller with (502 for a failure upstream, 429 when busy). */
+  get status() {
+    return this.details.status ?? 502;
+  }
+  get retryAfterSeconds() {
+    return this.details.retryAfterSeconds;
+  }
+};
+
+// src/circuit.ts
+function createCircuit(options, clock) {
+  let failures = 0;
+  let openUntil = null;
+  let probing = false;
+  return {
+    /** Throws `ORAZAKA_CIRCUIT_OPEN` while the circuit is open (or its probe is in flight). */
+    check() {
+      if (openUntil === null) return;
+      const now = clock.now();
+      if (isBefore(now, openUntil)) throw open(Math.max(1, differenceInSeconds(openUntil, now)));
+      if (probing) throw open(1);
+      probing = true;
+    },
+    success() {
+      failures = 0;
+      openUntil = null;
+      probing = false;
+    },
+    failure() {
+      failures += 1;
+      if (probing || failures >= options.failureThreshold) {
+        openUntil = addSeconds(clock.now(), options.openSeconds);
+        probing = false;
+      }
+    },
+    /** Test and diagnostics: is it refusing now? */
+    get isOpen() {
+      return openUntil !== null;
+    }
+  };
+}
+var open = (retryAfterSeconds) => new OrazakaError(ORAZAKA_CODE.circuitOpen, "Orazaka failed several times in a row: not calling it for a moment", { retryAfterSeconds, status: 502 });
+
+// src/client.ts
+import { addMilliseconds, isAfter } from "date-fns";
+
+// src/run.ts
+var RUN_STATUS = {
+  pendingApproval: "PENDING_APPROVAL",
+  running: "RUNNING",
+  awaitingInput: "AWAITING_INPUT",
+  succeeded: "SUCCEEDED",
+  failed: "FAILED",
+  cancelled: "CANCELLED",
+  compensating: "COMPENSATING"
+};
+var TERMINAL = [RUN_STATUS.succeeded, RUN_STATUS.failed, RUN_STATUS.cancelled];
+var isTerminal = (run) => TERMINAL.includes(run.status);
+var outputOf = (run, key) => run.outputs.find((o) => o.key === key)?.value ?? null;
+var shape = (what) => new OrazakaError(ORAZAKA_CODE.shape, `Orazaka's answer has an unexpected shape: ${what}`);
+var text = (v) => typeof v === "string" ? v : null;
+var parseOutput = (raw) => {
+  const o = raw ?? {};
+  if (typeof o.key !== "string" || typeof o.type !== "string") throw shape("an output without key and type");
+  return { key: o.key, label: text(o.label), type: o.type, value: text(o.value) };
+};
+function parseRun(body) {
+  const o = body ?? {};
+  if (typeof o.id !== "string" || typeof o.studioKey !== "string" || typeof o.status !== "string") throw shape("a run needs id, studioKey and status");
+  if (o.outputs !== void 0 && o.outputs !== null && !Array.isArray(o.outputs)) throw shape("outputs is not a list");
+  return {
+    id: o.id,
+    studioKey: o.studioKey,
+    blueprintVersion: text(o.blueprintVersion),
+    status: o.status,
+    outputs: (o.outputs ?? []).map(parseOutput),
+    errorMessage: text(o.errorMessage),
+    startedAt: text(o.startedAt),
+    finishedAt: text(o.finishedAt)
+  };
+}
+function parseInstallations(body) {
+  if (!Array.isArray(body)) throw shape("installations is not a list");
+  return body.map((i) => {
+    const key = i?.studioKey;
+    if (typeof key !== "string") throw shape("an installation without studioKey");
+    return key;
+  });
+}
+
+// src/client.ts
+var STUDIO_KEY = /^[a-z0-9][a-z0-9-]{0,79}$/i;
+var RUN_ID = /^[0-9a-f-]{36}$/i;
+var IDEMPOTENCY_KEY = /^[!-~]{1,255}$/;
+var KEY_REUSED = "idempotency_key_reused";
+var DEFAULT_TIMEOUT_MS = 2e4;
+var DEFAULT_CIRCUIT = { failureThreshold: 5, openSeconds: 30 };
+var DEFAULT_WAIT_INTERVAL_MS = 2e3;
+var DEFAULT_WAIT_TIMEOUT_MS = 12e4;
+var BUSY_MIN_SECONDS = 1;
+var BUSY_MAX_SECONDS = 300;
+var BUSY_DEFAULT_SECONDS = 15;
+var NO_STORE = { cache: "no-store" };
+var sleepFor = (milliseconds) => new Promise((resolve) => setTimeout(resolve, milliseconds));
+function createOrazakaClient(options) {
+  const doFetch = options.fetch ?? fetch;
+  const base = options.baseUrl.replace(/\/+$/, "");
+  const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+  const circuit = options.circuit === false ? null : createCircuit(options.circuit ?? DEFAULT_CIRCUIT, options.clock);
+  const sleep = options.sleep ?? sleepFor;
+  const installed = /* @__PURE__ */ new Set();
+  async function refusal(res, method, path) {
+    const where = `${method} ${path.split("?")[0]}`;
+    const body = await res.json().catch(() => null);
+    if (res.status === 429) {
+      const asked = Number(res.headers.get("retry-after") ?? body?.retryAfterSeconds);
+      const wait = Math.min(BUSY_MAX_SECONDS, Math.max(BUSY_MIN_SECONDS, asked || BUSY_DEFAULT_SECONDS));
+      return new OrazakaError(ORAZAKA_CODE.busy, `Orazaka is busy on ${where}`, { upstreamStatus: 429, status: 429, retryAfterSeconds: wait });
+    }
+    if (res.status === 422 && (body?.status === KEY_REUSED || body?.code === KEY_REUSED)) {
+      return new OrazakaError(ORAZAKA_CODE.keyReused, `The idempotency key already started a different request on ${where}`, { upstreamStatus: 422, status: 409 });
+    }
+    const { status, code } = orazakaRefusal(res.status);
+    return new OrazakaError(code, `Orazaka answered ${res.status} on ${where}`, { upstreamStatus: res.status, status });
+  }
+  async function call(path, init = {}) {
+    if (!options.apiKey) throw new OrazakaError(ORAZAKA_CODE.notConfigured, "The Orazaka API key is not set", { status: 503 });
+    circuit?.check();
+    const method = init.method ?? "GET";
+    let res;
+    try {
+      res = await doFetch(`${base}${path}`, {
+        method,
+        headers: { authorization: `Bearer ${options.apiKey}`, accept: "application/json", ...init.body === void 0 ? {} : { "content-type": "application/json" }, ...init.headers },
+        body: init.body === void 0 ? void 0 : JSON.stringify(init.body),
+        signal: AbortSignal.timeout(timeoutMs),
+        ...NO_STORE
+      });
+    } catch (cause) {
+      circuit?.failure();
+      const timedOut = cause instanceof Error && (cause.name === "TimeoutError" || cause.name === "AbortError");
+      throw new OrazakaError(timedOut ? ORAZAKA_CODE.timeout : ORAZAKA_CODE.unavailable, timedOut ? "Orazaka did not answer in time" : "Orazaka did not answer", { status: 502 });
+    }
+    if (res.status >= 500) {
+      circuit?.failure();
+      throw new OrazakaError(ORAZAKA_CODE.unavailable, `Orazaka answered ${res.status} on ${method} ${path.split("?")[0]}`, { upstreamStatus: res.status, status: 502 });
+    }
+    circuit?.success();
+    if (!res.ok) throw await refusal(res, method, path);
+    return res;
+  }
+  const json = (res) => res.json().catch(() => void 0);
+  async function studios() {
+    return parseInstallations(await json(await call("/api/v1/studios/installations")));
+  }
+  async function ensureInstalled(studio) {
+    if (installed.has(studio)) return;
+    if (!(await studios()).includes(studio)) await call(`/api/v1/studios/${studio}/installations?locale=en`, { method: "POST", body: { config: {} } });
+    installed.add(studio);
+  }
+  const checkRunId = (runId) => {
+    if (!RUN_ID.test(runId)) throw new OrazakaError(ORAZAKA_CODE.badRun, "Not a run id", { status: 400 });
+  };
+  async function getRun(runId) {
+    checkRunId(runId);
+    return parseRun(await json(await call(`/api/v1/studios/runs/${runId}`)));
+  }
+  return {
+    circuit,
+    studios,
+    getRun,
+    async startRun(studio, inputs, { idempotencyKey } = {}) {
+      if (!STUDIO_KEY.test(studio)) throw new OrazakaError(ORAZAKA_CODE.input, "Not a Studio key", { status: 422 });
+      if (idempotencyKey !== void 0 && !IDEMPOTENCY_KEY.test(idempotencyKey)) throw new OrazakaError(ORAZAKA_CODE.input, "An idempotency key is 1 to 255 printable characters", { status: 422 });
+      if (options.autoInstall !== false) await ensureInstalled(studio);
+      const res = await call(`/api/v1/studios/${studio}/runs`, { method: "POST", body: { inputs }, headers: idempotencyKey ? { "idempotency-key": idempotencyKey } : {} });
+      return { run: parseRun(await json(res)), replayed: res.headers.get("idempotent-replayed") === "true" };
+    },
+    async waitForRun(runId, { intervalMs = DEFAULT_WAIT_INTERVAL_MS, timeoutMs: waitMs = DEFAULT_WAIT_TIMEOUT_MS } = {}) {
+      const deadline = addMilliseconds(options.clock.now(), waitMs);
+      for (; ; ) {
+        const run = await getRun(runId);
+        if (isTerminal(run)) return run;
+        if (isAfter(options.clock.now(), deadline)) throw new OrazakaError(ORAZAKA_CODE.waitExpired, `The run is still ${run.status} after ${waitMs} ms`, { status: 504 });
+        await sleep(intervalMs);
+      }
+    }
+  };
+}
+export {
+  ORAZAKA_CODE,
+  OrazakaError,
+  RUN_STATUS,
+  createCircuit,
+  createOrazakaClient,
+  isTerminal,
+  orazakaRefusal,
+  outputOf,
+  parseInstallations,
+  parseRun
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/circuit.ts","../src/errors.ts","../src/client.ts","../src/run.ts"],"sourcesContent":["import { addSeconds, differenceInSeconds, isBefore } from \"date-fns\";\n\nimport { ORAZAKA_CODE, OrazakaError } from \"./errors\";\n\nexport interface Clock {\n  now(): Date;\n}\n\nexport interface CircuitOptions {\n  /** Consecutive failures (no answer, timeout, 5xx) that open the circuit. */\n  failureThreshold: number;\n  /** How long it stays open before one call is let through to probe. */\n  openSeconds: number;\n}\n\n/**\n * A circuit breaker over a dependency that may be down: after `failureThreshold` failures in a row it refuses at once (no waiting on\n * a timeout, no load on a struggling service) for `openSeconds`, then lets ONE call through; its success closes the circuit, its\n * failure opens it again. A refusal of the edge (401, 402, 404…) is an answer, not a failure: only the caller reports failures.\n */\nexport function createCircuit(options: CircuitOptions, clock: Clock) {\n  let failures = 0;\n  let openUntil: Date | null = null;\n  let probing = false;\n  return {\n    /** Throws `ORAZAKA_CIRCUIT_OPEN` while the circuit is open (or its probe is in flight). */\n    check(): void {\n      if (openUntil === null) return;\n      const now = clock.now();\n      if (isBefore(now, openUntil)) throw open(Math.max(1, differenceInSeconds(openUntil, now)));\n      if (probing) throw open(1);\n      probing = true;\n    },\n    success(): void {\n      failures = 0;\n      openUntil = null;\n      probing = false;\n    },\n    failure(): void {\n      failures += 1;\n      if (probing || failures >= options.failureThreshold) {\n        openUntil = addSeconds(clock.now(), options.openSeconds);\n        probing = false;\n      }\n    },\n    /** Test and diagnostics: is it refusing now? */\n    get isOpen(): boolean {\n      return openUntil !== null;\n    },\n  };\n}\n\nexport type Circuit = ReturnType<typeof createCircuit>;\n\nconst open = (retryAfterSeconds: number) => new OrazakaError(ORAZAKA_CODE.circuitOpen, \"Orazaka failed several times in a row: not calling it for a moment\", { retryAfterSeconds, status: 502 });\n","/** The stable codes of a refusal or a failure of Orazaka's edge — a product translates them; none is a sentence. */\nexport const ORAZAKA_CODE = {\n  /** No API key was given. */\n  notConfigured: \"ORAZAKA_NOT_CONFIGURED\",\n  /** 401/403: the key is wrong, revoked or lacks the right. */\n  key: \"ORAZAKA_KEY\",\n  /** 402: the run is not affordable now. */\n  credits: \"ORAZAKA_CREDITS\",\n  /** 409: the Studio is locked (to buy, or already installed). */\n  locked: \"ORAZAKA_LOCKED\",\n  /** 400/422: the inputs are not what the Studio asks for. */\n  input: \"ORAZAKA_INPUT\",\n  /** 404: no such Studio or run (or not the caller's). */\n  notFound: \"ORAZAKA_NOT_FOUND\",\n  /** 429: too many runs at once; `retryAfterSeconds` says when to come back. Not a failure of the document. */\n  busy: \"ORAZAKA_BUSY\",\n  /** 422 `idempotency_key_reused`: the key already started a different request. */\n  keyReused: \"ORAZAKA_KEY_REUSED\",\n  /** 451: a consent is to be agreed to first. */\n  consent: \"ORAZAKA_CONSENT\",\n  /** The edge did not answer, or answered 5xx. */\n  unavailable: \"ORAZAKA_UNAVAILABLE\",\n  /** The edge did not answer within the time given. */\n  timeout: \"ORAZAKA_TIMEOUT\",\n  /** The edge answered something that is not a run (or a list of installations). */\n  shape: \"ORAZAKA_SHAPE\",\n  /** Too many failures in a row: the client does not call until the pause is over. */\n  circuitOpen: \"ORAZAKA_CIRCUIT_OPEN\",\n  /** A run id that is not one: refused before any call. */\n  badRun: \"ORAZAKA_BAD_RUN\",\n  /** `waitForRun` gave up: the run was still going. */\n  waitExpired: \"ORAZAKA_WAIT_EXPIRED\",\n} as const;\nexport type OrazakaCode = (typeof ORAZAKA_CODE)[keyof typeof ORAZAKA_CODE];\n\n/** What the edge's status means for a product that answers its own caller: the status to send back and the code. */\nexport function orazakaRefusal(status: number): { status: number; code: OrazakaCode } {\n  if (status === 401 || status === 403) return { status: 502, code: ORAZAKA_CODE.key };\n  if (status === 402) return { status: 502, code: ORAZAKA_CODE.credits };\n  if (status === 409) return { status: 502, code: ORAZAKA_CODE.locked };\n  if (status === 400 || status === 422) return { status: 422, code: ORAZAKA_CODE.input };\n  if (status === 404) return { status: 502, code: ORAZAKA_CODE.notFound };\n  if (status === 429) return { status: 429, code: ORAZAKA_CODE.busy };\n  if (status === 451) return { status: 502, code: ORAZAKA_CODE.consent };\n  return { status: 502, code: ORAZAKA_CODE.unavailable };\n}\n\nexport class OrazakaError extends Error {\n  constructor(\n    readonly code: OrazakaCode,\n    message: string,\n    readonly details: {\n      /** What the edge answered, when it answered. */\n      upstreamStatus?: number;\n      /** The status a product should answer its own caller with. */\n      status?: number;\n      /** For `ORAZAKA_BUSY` and `ORAZAKA_CIRCUIT_OPEN`: seconds to wait. */\n      retryAfterSeconds?: number;\n    } = {},\n  ) {\n    super(message);\n    this.name = \"OrazakaError\";\n  }\n\n  /** The HTTP status a product answers its own caller with (502 for a failure upstream, 429 when busy). */\n  get status(): number {\n    return this.details.status ?? 502;\n  }\n\n  get retryAfterSeconds(): number | undefined {\n    return this.details.retryAfterSeconds;\n  }\n}\n","import { addMilliseconds, isAfter } from \"date-fns\";\n\nimport { type Circuit, type CircuitOptions, type Clock, createCircuit } from \"./circuit\";\nimport { ORAZAKA_CODE, OrazakaError, orazakaRefusal } from \"./errors\";\nimport { isTerminal, type OrazakaRun, parseInstallations, parseRun } from \"./run\";\n\ntype Fetch = typeof fetch;\n\nexport interface OrazakaClientOptions {\n  /** `https://api.orazaka.com` — the edge. A parameter: this package reads no environment. */\n  baseUrl: string;\n  /** The product's service key (`oz_…`). Without one every call throws `ORAZAKA_NOT_CONFIGURED`. */\n  apiKey: string | undefined;\n  /** Time is injected: the circuit and `waitForRun` read it from here. */\n  clock: Clock;\n  fetch?: Fetch;\n  /** One call's time limit, in milliseconds (default 20 000). */\n  timeoutMs?: number;\n  /** The breaker: `false` for none; default 5 failures in a row open it for 30 seconds. */\n  circuit?: CircuitOptions | false;\n  /** Install the Studio on the account before its first run (default true: the edge asks for it). */\n  autoInstall?: boolean;\n  /** How `waitForRun` waits between two reads (default `setTimeout`); tests give their own. */\n  sleep?: (milliseconds: number) => Promise<void>;\n}\n\nexport interface StartRunOptions {\n  /** Retrying with the same key (and the same inputs) answers the run already started instead of paying for a second one. */\n  idempotencyKey?: string;\n}\n\nexport interface StartedRun {\n  run: OrazakaRun;\n  /** The edge answered a run it had already started for this key (`Idempotent-Replayed`). */\n  replayed: boolean;\n}\n\nexport interface WaitOptions {\n  /** Between two reads, in milliseconds (default 2 000). */\n  intervalMs?: number;\n  /** Give up after this long, in milliseconds (default 120 000): `ORAZAKA_WAIT_EXPIRED`. */\n  timeoutMs?: number;\n}\n\nexport interface OrazakaClient {\n  /** Starts a Studio run (`POST /api/v1/studios/{studio}/runs`, 202). Pass an idempotency key to make the retry safe. */\n  startRun(studio: string, inputs: Record<string, unknown>, options?: StartRunOptions): Promise<StartedRun>;\n  /** The run, its status and its outputs (`GET /api/v1/studios/runs/{id}`). */\n  getRun(runId: string): Promise<OrazakaRun>;\n  /** Reads the run until it is over (succeeded, failed or cancelled) and answers it; a failed run is returned, not thrown. */\n  waitForRun(runId: string, options?: WaitOptions): Promise<OrazakaRun>;\n  /** The Studios this key has installed — also the cheapest call that proves the key and the connection. */\n  studios(): Promise<string[]>;\n  /** The circuit breaker, for diagnostics. */\n  readonly circuit: Circuit | null;\n}\n\nconst STUDIO_KEY = /^[a-z0-9][a-z0-9-]{0,79}$/i;\nconst RUN_ID = /^[0-9a-f-]{36}$/i;\nconst IDEMPOTENCY_KEY = /^[!-~]{1,255}$/;\n/** The stable code the edge answers (HTTP 422) when an idempotency key already started a different request. */\nconst KEY_REUSED = \"idempotency_key_reused\";\nconst DEFAULT_TIMEOUT_MS = 20_000;\nconst DEFAULT_CIRCUIT: CircuitOptions = { failureThreshold: 5, openSeconds: 30 };\nconst DEFAULT_WAIT_INTERVAL_MS = 2000;\nconst DEFAULT_WAIT_TIMEOUT_MS = 120_000;\nconst BUSY_MIN_SECONDS = 1;\nconst BUSY_MAX_SECONDS = 300;\nconst BUSY_DEFAULT_SECONDS = 15;\n\n/** Never served from a framework's fetch cache: a run's status changes. (`cache` is a runtime option the Node typings do not list.) */\nconst NO_STORE = { cache: \"no-store\" } as RequestInit;\n\nconst sleepFor = (milliseconds: number) => new Promise<void>((resolve) => setTimeout(resolve, milliseconds));\n\ninterface Call {\n  method?: \"GET\" | \"POST\";\n  body?: unknown;\n  headers?: Record<string, string>;\n}\n\n/** Orazaka's edge, for every TypeScript product: one client instead of one copy per product. */\nexport function createOrazakaClient(options: OrazakaClientOptions): OrazakaClient {\n  const doFetch = options.fetch ?? fetch;\n  const base = options.baseUrl.replace(/\\/+$/, \"\");\n  const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;\n  const circuit = options.circuit === false ? null : createCircuit(options.circuit ?? DEFAULT_CIRCUIT, options.clock);\n  const sleep = options.sleep ?? sleepFor;\n  const installed = new Set<string>();\n\n  /** The edge answered with a refusal: a stable error. A refusal is an answer, so the circuit stays closed. */\n  async function refusal(res: Response, method: string, path: string): Promise<OrazakaError> {\n    const where = `${method} ${path.split(\"?\")[0]}`;\n    const body = (await res.json().catch(() => null)) as { status?: unknown; code?: unknown; retryAfterSeconds?: unknown } | null;\n    if (res.status === 429) {\n      const asked = Number(res.headers.get(\"retry-after\") ?? body?.retryAfterSeconds);\n      const wait = Math.min(BUSY_MAX_SECONDS, Math.max(BUSY_MIN_SECONDS, asked || BUSY_DEFAULT_SECONDS));\n      return new OrazakaError(ORAZAKA_CODE.busy, `Orazaka is busy on ${where}`, { upstreamStatus: 429, status: 429, retryAfterSeconds: wait });\n    }\n    if (res.status === 422 && (body?.status === KEY_REUSED || body?.code === KEY_REUSED)) {\n      return new OrazakaError(ORAZAKA_CODE.keyReused, `The idempotency key already started a different request on ${where}`, { upstreamStatus: 422, status: 409 });\n    }\n    const { status, code } = orazakaRefusal(res.status);\n    return new OrazakaError(code, `Orazaka answered ${res.status} on ${where}`, { upstreamStatus: res.status, status });\n  }\n\n  async function call(path: string, init: Call = {}): Promise<Response> {\n    if (!options.apiKey) throw new OrazakaError(ORAZAKA_CODE.notConfigured, \"The Orazaka API key is not set\", { status: 503 });\n    circuit?.check();\n    const method = init.method ?? \"GET\";\n    let res: Response;\n    try {\n      res = await doFetch(`${base}${path}`, {\n        method,\n        headers: { authorization: `Bearer ${options.apiKey}`, accept: \"application/json\", ...(init.body === undefined ? {} : { \"content-type\": \"application/json\" }), ...init.headers },\n        body: init.body === undefined ? undefined : JSON.stringify(init.body),\n        signal: AbortSignal.timeout(timeoutMs),\n        ...NO_STORE,\n      });\n    } catch (cause) {\n      circuit?.failure();\n      const timedOut = cause instanceof Error && (cause.name === \"TimeoutError\" || cause.name === \"AbortError\");\n      throw new OrazakaError(timedOut ? ORAZAKA_CODE.timeout : ORAZAKA_CODE.unavailable, timedOut ? \"Orazaka did not answer in time\" : \"Orazaka did not answer\", { status: 502 });\n    }\n    if (res.status >= 500) {\n      circuit?.failure();\n      throw new OrazakaError(ORAZAKA_CODE.unavailable, `Orazaka answered ${res.status} on ${method} ${path.split(\"?\")[0]}`, { upstreamStatus: res.status, status: 502 });\n    }\n    circuit?.success();\n    if (!res.ok) throw await refusal(res, method, path);\n    return res;\n  }\n\n  const json = (res: Response): Promise<unknown> => res.json().catch(() => undefined);\n\n  async function studios(): Promise<string[]> {\n    return parseInstallations(await json(await call(\"/api/v1/studios/installations\")));\n  }\n\n  async function ensureInstalled(studio: string): Promise<void> {\n    if (installed.has(studio)) return;\n    if (!(await studios()).includes(studio)) await call(`/api/v1/studios/${studio}/installations?locale=en`, { method: \"POST\", body: { config: {} } });\n    installed.add(studio);\n  }\n\n  const checkRunId = (runId: string) => {\n    if (!RUN_ID.test(runId)) throw new OrazakaError(ORAZAKA_CODE.badRun, \"Not a run id\", { status: 400 });\n  };\n\n  async function getRun(runId: string): Promise<OrazakaRun> {\n    checkRunId(runId);\n    return parseRun(await json(await call(`/api/v1/studios/runs/${runId}`)));\n  }\n\n  return {\n    circuit,\n    studios,\n    getRun,\n    async startRun(studio, inputs, { idempotencyKey } = {}) {\n      if (!STUDIO_KEY.test(studio)) throw new OrazakaError(ORAZAKA_CODE.input, \"Not a Studio key\", { status: 422 });\n      if (idempotencyKey !== undefined && !IDEMPOTENCY_KEY.test(idempotencyKey)) throw new OrazakaError(ORAZAKA_CODE.input, \"An idempotency key is 1 to 255 printable characters\", { status: 422 });\n      if (options.autoInstall !== false) await ensureInstalled(studio);\n      const res = await call(`/api/v1/studios/${studio}/runs`, { method: \"POST\", body: { inputs }, headers: idempotencyKey ? { \"idempotency-key\": idempotencyKey } : {} });\n      return { run: parseRun(await json(res)), replayed: res.headers.get(\"idempotent-replayed\") === \"true\" };\n    },\n    async waitForRun(runId, { intervalMs = DEFAULT_WAIT_INTERVAL_MS, timeoutMs: waitMs = DEFAULT_WAIT_TIMEOUT_MS } = {}) {\n      const deadline = addMilliseconds(options.clock.now(), waitMs);\n      for (;;) {\n        const run = await getRun(runId);\n        if (isTerminal(run)) return run;\n        if (isAfter(options.clock.now(), deadline)) throw new OrazakaError(ORAZAKA_CODE.waitExpired, `The run is still ${run.status} after ${waitMs} ms`, { status: 504 });\n        await sleep(intervalMs);\n      }\n    },\n  };\n}\n","import { ORAZAKA_CODE, OrazakaError } from \"./errors\";\n\n/** One output of a run (orazaka-studio `RunArtefactResponse`): `type` is a rendering hint (`TEXT`, `IMAGE`, `VIDEO`…). */\nexport interface RunOutput {\n  key: string;\n  label: string | null;\n  type: string;\n  value: string | null;\n}\n\n/** Where a run sits (orazaka-studio `RunStatus`). The client keeps the string the edge sent, so a new status is not a failure. */\nexport const RUN_STATUS = {\n  pendingApproval: \"PENDING_APPROVAL\",\n  running: \"RUNNING\",\n  awaitingInput: \"AWAITING_INPUT\",\n  succeeded: \"SUCCEEDED\",\n  failed: \"FAILED\",\n  cancelled: \"CANCELLED\",\n  compensating: \"COMPENSATING\",\n} as const;\n\nconst TERMINAL: readonly string[] = [RUN_STATUS.succeeded, RUN_STATUS.failed, RUN_STATUS.cancelled];\n\n/** A run, as the edge answers it (`GET /api/v1/studios/runs/{id}`). Only what a product reads. */\nexport interface OrazakaRun {\n  id: string;\n  studioKey: string;\n  blueprintVersion: string | null;\n  status: string;\n  outputs: RunOutput[];\n  errorMessage: string | null;\n  startedAt: string | null;\n  finishedAt: string | null;\n}\n\n/** The run is over, green or not: nothing more will change. */\nexport const isTerminal = (run: Pick<OrazakaRun, \"status\">): boolean => TERMINAL.includes(run.status);\n\n/** The value of one output, or null when the run did not produce it (yet). */\nexport const outputOf = (run: Pick<OrazakaRun, \"outputs\">, key: string): string | null => run.outputs.find((o) => o.key === key)?.value ?? null;\n\nconst shape = (what: string) => new OrazakaError(ORAZAKA_CODE.shape, `Orazaka's answer has an unexpected shape: ${what}`);\nconst text = (v: unknown): string | null => (typeof v === \"string\" ? v : null);\n\nconst parseOutput = (raw: unknown): RunOutput => {\n  const o = (raw ?? {}) as Record<string, unknown>;\n  if (typeof o.key !== \"string\" || typeof o.type !== \"string\") throw shape(\"an output without key and type\");\n  return { key: o.key, label: text(o.label), type: o.type, value: text(o.value) };\n};\n\n/** Reads a run from the edge's JSON; anything else is `ORAZAKA_SHAPE`. */\nexport function parseRun(body: unknown): OrazakaRun {\n  const o = (body ?? {}) as Record<string, unknown>;\n  if (typeof o.id !== \"string\" || typeof o.studioKey !== \"string\" || typeof o.status !== \"string\") throw shape(\"a run needs id, studioKey and status\");\n  if (o.outputs !== undefined && o.outputs !== null && !Array.isArray(o.outputs)) throw shape(\"outputs is not a list\");\n  return {\n    id: o.id,\n    studioKey: o.studioKey,\n    blueprintVersion: text(o.blueprintVersion),\n    status: o.status,\n    outputs: ((o.outputs as unknown[] | null | undefined) ?? []).map(parseOutput),\n    errorMessage: text(o.errorMessage),\n    startedAt: text(o.startedAt),\n    finishedAt: text(o.finishedAt),\n  };\n}\n\n/** The Studios an account installed: `GET /api/v1/studios/installations`. */\nexport function parseInstallations(body: unknown): string[] {\n  if (!Array.isArray(body)) throw shape(\"installations is not a list\");\n  return body.map((i) => {\n    const key = (i as Record<string, unknown> | null)?.studioKey;\n    if (typeof key !== \"string\") throw shape(\"an installation without studioKey\");\n    return key;\n  });\n}\n"],"mappings":";AAAA,SAAS,YAAY,qBAAqB,gBAAgB;;;ACCnD,IAAM,eAAe;AAAA;AAAA,EAE1B,eAAe;AAAA;AAAA,EAEf,KAAK;AAAA;AAAA,EAEL,SAAS;AAAA;AAAA,EAET,QAAQ;AAAA;AAAA,EAER,OAAO;AAAA;AAAA,EAEP,UAAU;AAAA;AAAA,EAEV,MAAM;AAAA;AAAA,EAEN,WAAW;AAAA;AAAA,EAEX,SAAS;AAAA;AAAA,EAET,aAAa;AAAA;AAAA,EAEb,SAAS;AAAA;AAAA,EAET,OAAO;AAAA;AAAA,EAEP,aAAa;AAAA;AAAA,EAEb,QAAQ;AAAA;AAAA,EAER,aAAa;AACf;AAIO,SAAS,eAAe,QAAuD;AACpF,MAAI,WAAW,OAAO,WAAW,IAAK,QAAO,EAAE,QAAQ,KAAK,MAAM,aAAa,IAAI;AACnF,MAAI,WAAW,IAAK,QAAO,EAAE,QAAQ,KAAK,MAAM,aAAa,QAAQ;AACrE,MAAI,WAAW,IAAK,QAAO,EAAE,QAAQ,KAAK,MAAM,aAAa,OAAO;AACpE,MAAI,WAAW,OAAO,WAAW,IAAK,QAAO,EAAE,QAAQ,KAAK,MAAM,aAAa,MAAM;AACrF,MAAI,WAAW,IAAK,QAAO,EAAE,QAAQ,KAAK,MAAM,aAAa,SAAS;AACtE,MAAI,WAAW,IAAK,QAAO,EAAE,QAAQ,KAAK,MAAM,aAAa,KAAK;AAClE,MAAI,WAAW,IAAK,QAAO,EAAE,QAAQ,KAAK,MAAM,aAAa,QAAQ;AACrE,SAAO,EAAE,QAAQ,KAAK,MAAM,aAAa,YAAY;AACvD;AAEO,IAAM,eAAN,cAA2B,MAAM;AAAA,EACtC,YACW,MACT,SACS,UAOL,CAAC,GACL;AACA,UAAM,OAAO;AAXJ;AAEA;AAUT,SAAK,OAAO;AAAA,EACd;AAAA,EAbW;AAAA,EAEA;AAAA;AAAA,EAcX,IAAI,SAAiB;AACnB,WAAO,KAAK,QAAQ,UAAU;AAAA,EAChC;AAAA,EAEA,IAAI,oBAAwC;AAC1C,WAAO,KAAK,QAAQ;AAAA,EACtB;AACF;;;ADpDO,SAAS,cAAc,SAAyB,OAAc;AACnE,MAAI,WAAW;AACf,MAAI,YAAyB;AAC7B,MAAI,UAAU;AACd,SAAO;AAAA;AAAA,IAEL,QAAc;AACZ,UAAI,cAAc,KAAM;AACxB,YAAM,MAAM,MAAM,IAAI;AACtB,UAAI,SAAS,KAAK,SAAS,EAAG,OAAM,KAAK,KAAK,IAAI,GAAG,oBAAoB,WAAW,GAAG,CAAC,CAAC;AACzF,UAAI,QAAS,OAAM,KAAK,CAAC;AACzB,gBAAU;AAAA,IACZ;AAAA,IACA,UAAgB;AACd,iBAAW;AACX,kBAAY;AACZ,gBAAU;AAAA,IACZ;AAAA,IACA,UAAgB;AACd,kBAAY;AACZ,UAAI,WAAW,YAAY,QAAQ,kBAAkB;AACnD,oBAAY,WAAW,MAAM,IAAI,GAAG,QAAQ,WAAW;AACvD,kBAAU;AAAA,MACZ;AAAA,IACF;AAAA;AAAA,IAEA,IAAI,SAAkB;AACpB,aAAO,cAAc;AAAA,IACvB;AAAA,EACF;AACF;AAIA,IAAM,OAAO,CAAC,sBAA8B,IAAI,aAAa,aAAa,aAAa,sEAAsE,EAAE,mBAAmB,QAAQ,IAAI,CAAC;;;AEtD/L,SAAS,iBAAiB,eAAe;;;ACWlC,IAAM,aAAa;AAAA,EACxB,iBAAiB;AAAA,EACjB,SAAS;AAAA,EACT,eAAe;AAAA,EACf,WAAW;AAAA,EACX,QAAQ;AAAA,EACR,WAAW;AAAA,EACX,cAAc;AAChB;AAEA,IAAM,WAA8B,CAAC,WAAW,WAAW,WAAW,QAAQ,WAAW,SAAS;AAe3F,IAAM,aAAa,CAAC,QAA6C,SAAS,SAAS,IAAI,MAAM;AAG7F,IAAM,WAAW,CAAC,KAAkC,QAA+B,IAAI,QAAQ,KAAK,CAAC,MAAM,EAAE,QAAQ,GAAG,GAAG,SAAS;AAE3I,IAAM,QAAQ,CAAC,SAAiB,IAAI,aAAa,aAAa,OAAO,6CAA6C,IAAI,EAAE;AACxH,IAAM,OAAO,CAAC,MAA+B,OAAO,MAAM,WAAW,IAAI;AAEzE,IAAM,cAAc,CAAC,QAA4B;AAC/C,QAAM,IAAK,OAAO,CAAC;AACnB,MAAI,OAAO,EAAE,QAAQ,YAAY,OAAO,EAAE,SAAS,SAAU,OAAM,MAAM,gCAAgC;AACzG,SAAO,EAAE,KAAK,EAAE,KAAK,OAAO,KAAK,EAAE,KAAK,GAAG,MAAM,EAAE,MAAM,OAAO,KAAK,EAAE,KAAK,EAAE;AAChF;AAGO,SAAS,SAAS,MAA2B;AAClD,QAAM,IAAK,QAAQ,CAAC;AACpB,MAAI,OAAO,EAAE,OAAO,YAAY,OAAO,EAAE,cAAc,YAAY,OAAO,EAAE,WAAW,SAAU,OAAM,MAAM,sCAAsC;AACnJ,MAAI,EAAE,YAAY,UAAa,EAAE,YAAY,QAAQ,CAAC,MAAM,QAAQ,EAAE,OAAO,EAAG,OAAM,MAAM,uBAAuB;AACnH,SAAO;AAAA,IACL,IAAI,EAAE;AAAA,IACN,WAAW,EAAE;AAAA,IACb,kBAAkB,KAAK,EAAE,gBAAgB;AAAA,IACzC,QAAQ,EAAE;AAAA,IACV,UAAW,EAAE,WAA4C,CAAC,GAAG,IAAI,WAAW;AAAA,IAC5E,cAAc,KAAK,EAAE,YAAY;AAAA,IACjC,WAAW,KAAK,EAAE,SAAS;AAAA,IAC3B,YAAY,KAAK,EAAE,UAAU;AAAA,EAC/B;AACF;AAGO,SAAS,mBAAmB,MAAyB;AAC1D,MAAI,CAAC,MAAM,QAAQ,IAAI,EAAG,OAAM,MAAM,6BAA6B;AACnE,SAAO,KAAK,IAAI,CAAC,MAAM;AACrB,UAAM,MAAO,GAAsC;AACnD,QAAI,OAAO,QAAQ,SAAU,OAAM,MAAM,mCAAmC;AAC5E,WAAO;AAAA,EACT,CAAC;AACH;;;ADlBA,IAAM,aAAa;AACnB,IAAM,SAAS;AACf,IAAM,kBAAkB;AAExB,IAAM,aAAa;AACnB,IAAM,qBAAqB;AAC3B,IAAM,kBAAkC,EAAE,kBAAkB,GAAG,aAAa,GAAG;AAC/E,IAAM,2BAA2B;AACjC,IAAM,0BAA0B;AAChC,IAAM,mBAAmB;AACzB,IAAM,mBAAmB;AACzB,IAAM,uBAAuB;AAG7B,IAAM,WAAW,EAAE,OAAO,WAAW;AAErC,IAAM,WAAW,CAAC,iBAAyB,IAAI,QAAc,CAAC,YAAY,WAAW,SAAS,YAAY,CAAC;AASpG,SAAS,oBAAoB,SAA8C;AAChF,QAAM,UAAU,QAAQ,SAAS;AACjC,QAAM,OAAO,QAAQ,QAAQ,QAAQ,QAAQ,EAAE;AAC/C,QAAM,YAAY,QAAQ,aAAa;AACvC,QAAM,UAAU,QAAQ,YAAY,QAAQ,OAAO,cAAc,QAAQ,WAAW,iBAAiB,QAAQ,KAAK;AAClH,QAAM,QAAQ,QAAQ,SAAS;AAC/B,QAAM,YAAY,oBAAI,IAAY;AAGlC,iBAAe,QAAQ,KAAe,QAAgB,MAAqC;AACzF,UAAM,QAAQ,GAAG,MAAM,IAAI,KAAK,MAAM,GAAG,EAAE,CAAC,CAAC;AAC7C,UAAM,OAAQ,MAAM,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI;AAC/C,QAAI,IAAI,WAAW,KAAK;AACtB,YAAM,QAAQ,OAAO,IAAI,QAAQ,IAAI,aAAa,KAAK,MAAM,iBAAiB;AAC9E,YAAM,OAAO,KAAK,IAAI,kBAAkB,KAAK,IAAI,kBAAkB,SAAS,oBAAoB,CAAC;AACjG,aAAO,IAAI,aAAa,aAAa,MAAM,sBAAsB,KAAK,IAAI,EAAE,gBAAgB,KAAK,QAAQ,KAAK,mBAAmB,KAAK,CAAC;AAAA,IACzI;AACA,QAAI,IAAI,WAAW,QAAQ,MAAM,WAAW,cAAc,MAAM,SAAS,aAAa;AACpF,aAAO,IAAI,aAAa,aAAa,WAAW,8DAA8D,KAAK,IAAI,EAAE,gBAAgB,KAAK,QAAQ,IAAI,CAAC;AAAA,IAC7J;AACA,UAAM,EAAE,QAAQ,KAAK,IAAI,eAAe,IAAI,MAAM;AAClD,WAAO,IAAI,aAAa,MAAM,oBAAoB,IAAI,MAAM,OAAO,KAAK,IAAI,EAAE,gBAAgB,IAAI,QAAQ,OAAO,CAAC;AAAA,EACpH;AAEA,iBAAe,KAAK,MAAc,OAAa,CAAC,GAAsB;AACpE,QAAI,CAAC,QAAQ,OAAQ,OAAM,IAAI,aAAa,aAAa,eAAe,kCAAkC,EAAE,QAAQ,IAAI,CAAC;AACzH,aAAS,MAAM;AACf,UAAM,SAAS,KAAK,UAAU;AAC9B,QAAI;AACJ,QAAI;AACF,YAAM,MAAM,QAAQ,GAAG,IAAI,GAAG,IAAI,IAAI;AAAA,QACpC;AAAA,QACA,SAAS,EAAE,eAAe,UAAU,QAAQ,MAAM,IAAI,QAAQ,oBAAoB,GAAI,KAAK,SAAS,SAAY,CAAC,IAAI,EAAE,gBAAgB,mBAAmB,GAAI,GAAG,KAAK,QAAQ;AAAA,QAC9K,MAAM,KAAK,SAAS,SAAY,SAAY,KAAK,UAAU,KAAK,IAAI;AAAA,QACpE,QAAQ,YAAY,QAAQ,SAAS;AAAA,QACrC,GAAG;AAAA,MACL,CAAC;AAAA,IACH,SAAS,OAAO;AACd,eAAS,QAAQ;AACjB,YAAM,WAAW,iBAAiB,UAAU,MAAM,SAAS,kBAAkB,MAAM,SAAS;AAC5F,YAAM,IAAI,aAAa,WAAW,aAAa,UAAU,aAAa,aAAa,WAAW,mCAAmC,0BAA0B,EAAE,QAAQ,IAAI,CAAC;AAAA,IAC5K;AACA,QAAI,IAAI,UAAU,KAAK;AACrB,eAAS,QAAQ;AACjB,YAAM,IAAI,aAAa,aAAa,aAAa,oBAAoB,IAAI,MAAM,OAAO,MAAM,IAAI,KAAK,MAAM,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,gBAAgB,IAAI,QAAQ,QAAQ,IAAI,CAAC;AAAA,IACnK;AACA,aAAS,QAAQ;AACjB,QAAI,CAAC,IAAI,GAAI,OAAM,MAAM,QAAQ,KAAK,QAAQ,IAAI;AAClD,WAAO;AAAA,EACT;AAEA,QAAM,OAAO,CAAC,QAAoC,IAAI,KAAK,EAAE,MAAM,MAAM,MAAS;AAElF,iBAAe,UAA6B;AAC1C,WAAO,mBAAmB,MAAM,KAAK,MAAM,KAAK,+BAA+B,CAAC,CAAC;AAAA,EACnF;AAEA,iBAAe,gBAAgB,QAA+B;AAC5D,QAAI,UAAU,IAAI,MAAM,EAAG;AAC3B,QAAI,EAAE,MAAM,QAAQ,GAAG,SAAS,MAAM,EAAG,OAAM,KAAK,mBAAmB,MAAM,4BAA4B,EAAE,QAAQ,QAAQ,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC;AACjJ,cAAU,IAAI,MAAM;AAAA,EACtB;AAEA,QAAM,aAAa,CAAC,UAAkB;AACpC,QAAI,CAAC,OAAO,KAAK,KAAK,EAAG,OAAM,IAAI,aAAa,aAAa,QAAQ,gBAAgB,EAAE,QAAQ,IAAI,CAAC;AAAA,EACtG;AAEA,iBAAe,OAAO,OAAoC;AACxD,eAAW,KAAK;AAChB,WAAO,SAAS,MAAM,KAAK,MAAM,KAAK,wBAAwB,KAAK,EAAE,CAAC,CAAC;AAAA,EACzE;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM,SAAS,QAAQ,QAAQ,EAAE,eAAe,IAAI,CAAC,GAAG;AACtD,UAAI,CAAC,WAAW,KAAK,MAAM,EAAG,OAAM,IAAI,aAAa,aAAa,OAAO,oBAAoB,EAAE,QAAQ,IAAI,CAAC;AAC5G,UAAI,mBAAmB,UAAa,CAAC,gBAAgB,KAAK,cAAc,EAAG,OAAM,IAAI,aAAa,aAAa,OAAO,uDAAuD,EAAE,QAAQ,IAAI,CAAC;AAC5L,UAAI,QAAQ,gBAAgB,MAAO,OAAM,gBAAgB,MAAM;AAC/D,YAAM,MAAM,MAAM,KAAK,mBAAmB,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,EAAE,OAAO,GAAG,SAAS,iBAAiB,EAAE,mBAAmB,eAAe,IAAI,CAAC,EAAE,CAAC;AACnK,aAAO,EAAE,KAAK,SAAS,MAAM,KAAK,GAAG,CAAC,GAAG,UAAU,IAAI,QAAQ,IAAI,qBAAqB,MAAM,OAAO;AAAA,IACvG;AAAA,IACA,MAAM,WAAW,OAAO,EAAE,aAAa,0BAA0B,WAAW,SAAS,wBAAwB,IAAI,CAAC,GAAG;AACnH,YAAM,WAAW,gBAAgB,QAAQ,MAAM,IAAI,GAAG,MAAM;AAC5D,iBAAS;AACP,cAAM,MAAM,MAAM,OAAO,KAAK;AAC9B,YAAI,WAAW,GAAG,EAAG,QAAO;AAC5B,YAAI,QAAQ,QAAQ,MAAM,IAAI,GAAG,QAAQ,EAAG,OAAM,IAAI,aAAa,aAAa,aAAa,oBAAoB,IAAI,MAAM,UAAU,MAAM,OAAO,EAAE,QAAQ,IAAI,CAAC;AACjK,cAAM,MAAM,UAAU;AAAA,MACxB;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,6 +1,59 @@
 {
   "name": "@krizaka/orazaka-client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "One Orazaka client for the TypeScript products: start a Studio run (safe to retry with an idempotency key), read its status and outputs, wait for it, with typed errors with stable codes, a time limit and a circuit breaker. Base URL, key and clock are parameters; no environment, no framework.",
+  "keywords": [
+    "krizaka",
+    "orazaka",
+    "client",
+    "studio",
+    "runs"
+  ],
+  "homepage": "https://github.com/krizaka/krizaka-ts/tree/main/packages/orazaka-client",
+  "bugs": "https://github.com/krizaka/krizaka-ts/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/krizaka/krizaka-ts.git",
+    "directory": "packages/orazaka-client"
+  },
+  "license": "Apache-2.0",
+  "author": "Krizaka (https://www.krizaka.com)",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "dependencies": {
+    "date-fns": "^4.4.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "eslint": "^9.39.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.11",
+    "@krizaka/config": "^0.8.0"
+  },
+  "scripts": {
+    "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsup",
+    "lint": "eslint . --max-warnings 0 && tsc --noEmit",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "check": "pnpm run lint && pnpm run test && pnpm run build"
+  }
 }