@krizaka/orazaka-client 0.0.0-stage → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,20 @@
1
- # Temporary Holding Version
1
+ # @krizaka/orazaka-client
2
2
 
3
- 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.
3
+ 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.
4
+
5
+ ```ts
6
+ import { createOrazakaClient, outputOf } from "@krizaka/orazaka-client";
7
+
8
+ const orazaka = createOrazakaClient({ baseUrl: "https://api.orazaka.com", apiKey: env.AI_API_KEY, clock: { now: () => new Date() } });
9
+
10
+ const { run } = await orazaka.startRun("compliance-check", { document: text }, { idempotencyKey: `doc-${documentId}-v${version}` });
11
+ const done = await orazaka.waitForRun(run.id); // or poll `getRun` yourself
12
+ if (done.status === "SUCCEEDED") use(outputOf(done, "report"));
13
+ ```
14
+
15
+ - **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`.
16
+ - **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`.
17
+ - **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.
18
+ - **Contract-tested** against the edge's answers kept as fixtures (`test/fixtures`): when the edge changes a shape, the fixture changes first.
19
+
20
+ Run events as a stream (Server-Sent Events, `GET /api/v1/studios/runs/{id}/events`) come in a later minor; `waitForRun` polls until then.
@@ -0,0 +1,231 @@
1
+ /** The checks a product may ask for: `POST /api/v1/checks/{purpose}`. Identity checks are not offered to products. */
2
+ declare const CHECK_PURPOSE: {
3
+ readonly courtRecords: "court-records";
4
+ readonly credit: "credit";
5
+ };
6
+ type CheckPurposeKey = (typeof CHECK_PURPOSE)[keyof typeof CHECK_PURPOSE];
7
+ declare const CHECK_OUTCOME: readonly ["MATCH", "NO_MATCH", "PENDING", "PROVIDER_ERROR", "TIMEOUT", "REFUSED"];
8
+ type CheckOutcome = (typeof CHECK_OUTCOME)[number];
9
+ /** Why a check was refused; present exactly when the outcome is `REFUSED`. `NOT_CONFIGURED` means Orazaka has no provider, key or pepper for it: never a result. */
10
+ declare const CHECK_REFUSAL: readonly ["NO_CONSENT", "NO_KEY", "BUDGET_EXHAUSTED", "NOT_CONFIGURED"];
11
+ type CheckRefusal = (typeof CHECK_REFUSAL)[number];
12
+ /** The closed court category of a match; `NONE` for everything else. Never free text, never a record. */
13
+ declare const CHECK_CATEGORY: readonly ["TAL_NON_PAYMENT", "TAL_OTHER", "CRIMINAL", "CIVIL", "NONE"];
14
+ type CheckCategory = (typeof CHECK_CATEGORY)[number];
15
+ interface CheckSubject {
16
+ /** The opaque id of the subject on the product's side: consent and the audit are keyed on it, the names never are. */
17
+ subjectId: string;
18
+ lastName: string;
19
+ firstName: string;
20
+ /** ISO date, optional. */
21
+ birthDate?: string;
22
+ address?: string;
23
+ /** For example `QC`: routes Québec court records to the Québec provider. */
24
+ region?: string;
25
+ }
26
+ interface StartCheckInput {
27
+ subject: CheckSubject;
28
+ /** The product's statement that the subject consented to this purpose. Without it Orazaka answers `REFUSED / NO_CONSENT` and asks nobody. */
29
+ consented: boolean;
30
+ /** The product's run this check belongs to, kept on the audit line. */
31
+ runId?: string;
32
+ }
33
+ interface CollectCheckInput {
34
+ /** The subject the check was for. */
35
+ subjectId: string;
36
+ /** The consent must still stand: it is checked again at every poll. */
37
+ consented: boolean;
38
+ }
39
+ /** The closed answer of a check, as Orazaka's `CheckResult`: an outcome and a category, no record. A refusal is an answer, not an exception. */
40
+ interface CheckResult {
41
+ purpose: "COURT_RECORDS" | "CREDIT" | "IDENTITY";
42
+ outcome: CheckOutcome;
43
+ refusal: CheckRefusal | null;
44
+ category: CheckCategory;
45
+ /** The provider's opaque reference: collect a `PENDING` check with it. */
46
+ providerRef: string | null;
47
+ runId: string | null;
48
+ }
49
+ /** Reads a check's answer from the edge's JSON; anything else is `ORAZAKA_SHAPE`. */
50
+ declare function parseCheck(body: unknown): CheckResult;
51
+
52
+ interface Clock {
53
+ now(): Date;
54
+ }
55
+ interface CircuitOptions {
56
+ /** Consecutive failures (no answer, timeout, 5xx) that open the circuit. */
57
+ failureThreshold: number;
58
+ /** How long it stays open before one call is let through to probe. */
59
+ openSeconds: number;
60
+ }
61
+ /**
62
+ * A circuit breaker over a dependency that may be down: after `failureThreshold` failures in a row it refuses at once (no waiting on
63
+ * a timeout, no load on a struggling service) for `openSeconds`, then lets ONE call through; its success closes the circuit, its
64
+ * failure opens it again. A refusal of the edge (401, 402, 404…) is an answer, not a failure: only the caller reports failures.
65
+ */
66
+ declare function createCircuit(options: CircuitOptions, clock: Clock): {
67
+ /** Throws `ORAZAKA_CIRCUIT_OPEN` while the circuit is open (or its probe is in flight). */
68
+ check(): void;
69
+ success(): void;
70
+ failure(): void;
71
+ /** Test and diagnostics: is it refusing now? */
72
+ readonly isOpen: boolean;
73
+ };
74
+ type Circuit = ReturnType<typeof createCircuit>;
75
+
76
+ /** One output of a run (orazaka-studio `RunArtefactResponse`): `type` is a rendering hint (`TEXT`, `IMAGE`, `VIDEO`…). */
77
+ interface RunOutput {
78
+ key: string;
79
+ label: string | null;
80
+ type: string;
81
+ value: string | null;
82
+ }
83
+ /** Where a run sits (orazaka-studio `RunStatus`). The client keeps the string the edge sent, so a new status is not a failure. */
84
+ declare const RUN_STATUS: {
85
+ readonly pendingApproval: "PENDING_APPROVAL";
86
+ readonly running: "RUNNING";
87
+ readonly awaitingInput: "AWAITING_INPUT";
88
+ readonly succeeded: "SUCCEEDED";
89
+ readonly failed: "FAILED";
90
+ readonly cancelled: "CANCELLED";
91
+ readonly compensating: "COMPENSATING";
92
+ };
93
+ /** A run, as the edge answers it (`GET /api/v1/studios/runs/{id}`). Only what a product reads. */
94
+ interface OrazakaRun {
95
+ id: string;
96
+ studioKey: string;
97
+ blueprintVersion: string | null;
98
+ status: string;
99
+ outputs: RunOutput[];
100
+ errorMessage: string | null;
101
+ startedAt: string | null;
102
+ finishedAt: string | null;
103
+ }
104
+ /** The run is over, green or not: nothing more will change. */
105
+ declare const isTerminal: (run: Pick<OrazakaRun, "status">) => boolean;
106
+ /** The value of one output, or null when the run did not produce it (yet). */
107
+ declare const outputOf: (run: Pick<OrazakaRun, "outputs">, key: string) => string | null;
108
+ /** Reads a run from the edge's JSON; anything else is `ORAZAKA_SHAPE`. */
109
+ declare function parseRun(body: unknown): OrazakaRun;
110
+ /** The Studios an account installed: `GET /api/v1/studios/installations`. */
111
+ declare function parseInstallations(body: unknown): string[];
112
+
113
+ type Fetch = typeof fetch;
114
+ interface OrazakaClientOptions {
115
+ /** `https://api.orazaka.com` — the edge. A parameter: this package reads no environment. */
116
+ baseUrl: string;
117
+ /** The product's service key (`oz_…`). Without one every call throws `ORAZAKA_NOT_CONFIGURED`. */
118
+ apiKey: string | undefined;
119
+ /** Time is injected: the circuit and `waitForRun` read it from here. */
120
+ clock: Clock;
121
+ fetch?: Fetch;
122
+ /** One call's time limit, in milliseconds (default 20 000). */
123
+ timeoutMs?: number;
124
+ /** The breaker: `false` for none; default 5 failures in a row open it for 30 seconds. */
125
+ circuit?: CircuitOptions | false;
126
+ /** Install the Studio on the account before its first run (default true: the edge asks for it). */
127
+ autoInstall?: boolean;
128
+ /** How `waitForRun` waits between two reads (default `setTimeout`); tests give their own. */
129
+ sleep?: (milliseconds: number) => Promise<void>;
130
+ }
131
+ interface StartRunOptions {
132
+ /** Retrying with the same key (and the same inputs) answers the run already started instead of paying for a second one. */
133
+ idempotencyKey?: string;
134
+ }
135
+ interface StartedRun {
136
+ run: OrazakaRun;
137
+ /** The edge answered a run it had already started for this key (`Idempotent-Replayed`). */
138
+ replayed: boolean;
139
+ }
140
+ interface WaitOptions {
141
+ /** Between two reads, in milliseconds (default 2 000). */
142
+ intervalMs?: number;
143
+ /** Give up after this long, in milliseconds (default 120 000): `ORAZAKA_WAIT_EXPIRED`. */
144
+ timeoutMs?: number;
145
+ }
146
+ interface OrazakaClient {
147
+ /** Starts a Studio run (`POST /api/v1/studios/{studio}/runs`, 202). Pass an idempotency key to make the retry safe. */
148
+ startRun(studio: string, inputs: Record<string, unknown>, options?: StartRunOptions): Promise<StartedRun>;
149
+ /** The run, its status and its outputs (`GET /api/v1/studios/runs/{id}`). */
150
+ getRun(runId: string): Promise<OrazakaRun>;
151
+ /** Reads the run until it is over (succeeded, failed or cancelled) and answers it; a failed run is returned, not thrown. */
152
+ waitForRun(runId: string, options?: WaitOptions): Promise<OrazakaRun>;
153
+ /**
154
+ * Starts an external check (`POST /api/v1/checks/{purpose}`): court records or credit, through Orazaka's one door.
155
+ * Orazaka, not the product, decides consent, key, budget and provider; a refusal (`NO_CONSENT`, `NO_KEY`,
156
+ * `BUDGET_EXHAUSTED`, `NOT_CONFIGURED`) is the answer, with outcome `REFUSED`. Answers `PENDING` with a `providerRef` when the provider replies later.
157
+ */
158
+ startCheck(purpose: CheckPurposeKey, input: StartCheckInput): Promise<CheckResult>;
159
+ /** Collects a `PENDING` check by its provider reference (`GET /api/v1/checks/{providerRef}`); `PENDING` again while the provider works. */
160
+ collectCheck(providerRef: string, input: CollectCheckInput): Promise<CheckResult>;
161
+ /** The Studios this key has installed — also the cheapest call that proves the key and the connection. */
162
+ studios(): Promise<string[]>;
163
+ /** The circuit breaker, for diagnostics. */
164
+ readonly circuit: Circuit | null;
165
+ }
166
+ /** Orazaka's edge, for every TypeScript product: one client instead of one copy per product. */
167
+ declare function createOrazakaClient(options: OrazakaClientOptions): OrazakaClient;
168
+
169
+ /** The stable codes of a refusal or a failure of Orazaka's edge — a product translates them; none is a sentence. */
170
+ declare const ORAZAKA_CODE: {
171
+ /** No API key was given. */
172
+ readonly notConfigured: "ORAZAKA_NOT_CONFIGURED";
173
+ /** 401/403: the key is wrong, revoked or lacks the right. */
174
+ readonly key: "ORAZAKA_KEY";
175
+ /** 402: the run is not affordable now. */
176
+ readonly credits: "ORAZAKA_CREDITS";
177
+ /** 409: the Studio is locked (to buy, or already installed). */
178
+ readonly locked: "ORAZAKA_LOCKED";
179
+ /** 400/422: the inputs are not what the Studio asks for. */
180
+ readonly input: "ORAZAKA_INPUT";
181
+ /** 404: no such Studio or run (or not the caller's). */
182
+ readonly notFound: "ORAZAKA_NOT_FOUND";
183
+ /** 429: too many runs at once; `retryAfterSeconds` says when to come back. Not a failure of the document. */
184
+ readonly busy: "ORAZAKA_BUSY";
185
+ /** 422 `idempotency_key_reused`: the key already started a different request. */
186
+ readonly keyReused: "ORAZAKA_KEY_REUSED";
187
+ /** 451: a consent is to be agreed to first. */
188
+ readonly consent: "ORAZAKA_CONSENT";
189
+ /** The edge did not answer, or answered 5xx. */
190
+ readonly unavailable: "ORAZAKA_UNAVAILABLE";
191
+ /** The edge did not answer within the time given. */
192
+ readonly timeout: "ORAZAKA_TIMEOUT";
193
+ /** The edge answered something that is not a run (or a list of installations). */
194
+ readonly shape: "ORAZAKA_SHAPE";
195
+ /** Too many failures in a row: the client does not call until the pause is over. */
196
+ readonly circuitOpen: "ORAZAKA_CIRCUIT_OPEN";
197
+ /** A run id that is not one: refused before any call. */
198
+ readonly badRun: "ORAZAKA_BAD_RUN";
199
+ /** `waitForRun` gave up: the run was still going. */
200
+ readonly waitExpired: "ORAZAKA_WAIT_EXPIRED";
201
+ };
202
+ type OrazakaCode = (typeof ORAZAKA_CODE)[keyof typeof ORAZAKA_CODE];
203
+ /** What the edge's status means for a product that answers its own caller: the status to send back and the code. */
204
+ declare function orazakaRefusal(status: number): {
205
+ status: number;
206
+ code: OrazakaCode;
207
+ };
208
+ declare class OrazakaError extends Error {
209
+ readonly code: OrazakaCode;
210
+ readonly details: {
211
+ /** What the edge answered, when it answered. */
212
+ upstreamStatus?: number;
213
+ /** The status a product should answer its own caller with. */
214
+ status?: number;
215
+ /** For `ORAZAKA_BUSY` and `ORAZAKA_CIRCUIT_OPEN`: seconds to wait. */
216
+ retryAfterSeconds?: number;
217
+ };
218
+ constructor(code: OrazakaCode, message: string, details?: {
219
+ /** What the edge answered, when it answered. */
220
+ upstreamStatus?: number;
221
+ /** The status a product should answer its own caller with. */
222
+ status?: number;
223
+ /** For `ORAZAKA_BUSY` and `ORAZAKA_CIRCUIT_OPEN`: seconds to wait. */
224
+ retryAfterSeconds?: number;
225
+ });
226
+ /** The HTTP status a product answers its own caller with (502 for a failure upstream, 429 when busy). */
227
+ get status(): number;
228
+ get retryAfterSeconds(): number | undefined;
229
+ }
230
+
231
+ export { CHECK_CATEGORY, CHECK_OUTCOME, CHECK_PURPOSE, CHECK_REFUSAL, type CheckCategory, type CheckOutcome, type CheckPurposeKey, type CheckRefusal, type CheckResult, type CheckSubject, type Circuit, type CircuitOptions, type Clock, type CollectCheckInput, ORAZAKA_CODE, type OrazakaClient, type OrazakaClientOptions, type OrazakaCode, OrazakaError, type OrazakaRun, RUN_STATUS, type RunOutput, type StartCheckInput, type StartRunOptions, type StartedRun, type WaitOptions, createCircuit, createOrazakaClient, isTerminal, orazakaRefusal, outputOf, parseCheck, parseInstallations, parseRun };
package/dist/index.js ADDED
@@ -0,0 +1,292 @@
1
+ // src/errors.ts
2
+ var ORAZAKA_CODE = {
3
+ /** No API key was given. */
4
+ notConfigured: "ORAZAKA_NOT_CONFIGURED",
5
+ /** 401/403: the key is wrong, revoked or lacks the right. */
6
+ key: "ORAZAKA_KEY",
7
+ /** 402: the run is not affordable now. */
8
+ credits: "ORAZAKA_CREDITS",
9
+ /** 409: the Studio is locked (to buy, or already installed). */
10
+ locked: "ORAZAKA_LOCKED",
11
+ /** 400/422: the inputs are not what the Studio asks for. */
12
+ input: "ORAZAKA_INPUT",
13
+ /** 404: no such Studio or run (or not the caller's). */
14
+ notFound: "ORAZAKA_NOT_FOUND",
15
+ /** 429: too many runs at once; `retryAfterSeconds` says when to come back. Not a failure of the document. */
16
+ busy: "ORAZAKA_BUSY",
17
+ /** 422 `idempotency_key_reused`: the key already started a different request. */
18
+ keyReused: "ORAZAKA_KEY_REUSED",
19
+ /** 451: a consent is to be agreed to first. */
20
+ consent: "ORAZAKA_CONSENT",
21
+ /** The edge did not answer, or answered 5xx. */
22
+ unavailable: "ORAZAKA_UNAVAILABLE",
23
+ /** The edge did not answer within the time given. */
24
+ timeout: "ORAZAKA_TIMEOUT",
25
+ /** The edge answered something that is not a run (or a list of installations). */
26
+ shape: "ORAZAKA_SHAPE",
27
+ /** Too many failures in a row: the client does not call until the pause is over. */
28
+ circuitOpen: "ORAZAKA_CIRCUIT_OPEN",
29
+ /** A run id that is not one: refused before any call. */
30
+ badRun: "ORAZAKA_BAD_RUN",
31
+ /** `waitForRun` gave up: the run was still going. */
32
+ waitExpired: "ORAZAKA_WAIT_EXPIRED"
33
+ };
34
+ function orazakaRefusal(status) {
35
+ if (status === 401 || status === 403) return { status: 502, code: ORAZAKA_CODE.key };
36
+ if (status === 402) return { status: 502, code: ORAZAKA_CODE.credits };
37
+ if (status === 409) return { status: 502, code: ORAZAKA_CODE.locked };
38
+ if (status === 400 || status === 422) return { status: 422, code: ORAZAKA_CODE.input };
39
+ if (status === 404) return { status: 502, code: ORAZAKA_CODE.notFound };
40
+ if (status === 429) return { status: 429, code: ORAZAKA_CODE.busy };
41
+ if (status === 451) return { status: 502, code: ORAZAKA_CODE.consent };
42
+ return { status: 502, code: ORAZAKA_CODE.unavailable };
43
+ }
44
+ var OrazakaError = class extends Error {
45
+ constructor(code, message, details = {}) {
46
+ super(message);
47
+ this.code = code;
48
+ this.details = details;
49
+ this.name = "OrazakaError";
50
+ }
51
+ code;
52
+ details;
53
+ /** The HTTP status a product answers its own caller with (502 for a failure upstream, 429 when busy). */
54
+ get status() {
55
+ return this.details.status ?? 502;
56
+ }
57
+ get retryAfterSeconds() {
58
+ return this.details.retryAfterSeconds;
59
+ }
60
+ };
61
+
62
+ // src/checks.ts
63
+ var CHECK_PURPOSE = { courtRecords: "court-records", credit: "credit" };
64
+ var CHECK_OUTCOME = ["MATCH", "NO_MATCH", "PENDING", "PROVIDER_ERROR", "TIMEOUT", "REFUSED"];
65
+ var CHECK_REFUSAL = ["NO_CONSENT", "NO_KEY", "BUDGET_EXHAUSTED", "NOT_CONFIGURED"];
66
+ var CHECK_CATEGORY = ["TAL_NON_PAYMENT", "TAL_OTHER", "CRIMINAL", "CIVIL", "NONE"];
67
+ var PURPOSES = ["COURT_RECORDS", "CREDIT", "IDENTITY"];
68
+ var shape = (what) => new OrazakaError(ORAZAKA_CODE.shape, `Orazaka's answer has an unexpected shape: ${what}`);
69
+ var text = (v) => typeof v === "string" ? v : null;
70
+ var oneOf = (list, v) => list.includes(v) ? v : null;
71
+ function parseCheck(body) {
72
+ const o = body ?? {};
73
+ const purpose = oneOf(PURPOSES, o.purpose);
74
+ const outcome = oneOf(CHECK_OUTCOME, o.outcome);
75
+ const category = oneOf(CHECK_CATEGORY, o.category ?? "NONE");
76
+ if (!purpose || !outcome || !category) throw shape("a check needs a known purpose, outcome and category");
77
+ const refusal = o.refusal === void 0 || o.refusal === null ? null : oneOf(CHECK_REFUSAL, o.refusal);
78
+ if (outcome === "REFUSED" !== (refusal !== null)) throw shape("a refusal comes with REFUSED, and REFUSED with a refusal");
79
+ return { purpose, outcome, refusal, category, providerRef: text(o.providerRef), runId: text(o.runId) };
80
+ }
81
+
82
+ // src/circuit.ts
83
+ import { addSeconds, differenceInSeconds, isBefore } from "date-fns";
84
+ function createCircuit(options, clock) {
85
+ let failures = 0;
86
+ let openUntil = null;
87
+ let probing = false;
88
+ return {
89
+ /** Throws `ORAZAKA_CIRCUIT_OPEN` while the circuit is open (or its probe is in flight). */
90
+ check() {
91
+ if (openUntil === null) return;
92
+ const now = clock.now();
93
+ if (isBefore(now, openUntil)) throw open(Math.max(1, differenceInSeconds(openUntil, now)));
94
+ if (probing) throw open(1);
95
+ probing = true;
96
+ },
97
+ success() {
98
+ failures = 0;
99
+ openUntil = null;
100
+ probing = false;
101
+ },
102
+ failure() {
103
+ failures += 1;
104
+ if (probing || failures >= options.failureThreshold) {
105
+ openUntil = addSeconds(clock.now(), options.openSeconds);
106
+ probing = false;
107
+ }
108
+ },
109
+ /** Test and diagnostics: is it refusing now? */
110
+ get isOpen() {
111
+ return openUntil !== null;
112
+ }
113
+ };
114
+ }
115
+ var open = (retryAfterSeconds) => new OrazakaError(ORAZAKA_CODE.circuitOpen, "Orazaka failed several times in a row: not calling it for a moment", { retryAfterSeconds, status: 502 });
116
+
117
+ // src/client.ts
118
+ import { addMilliseconds, isAfter } from "date-fns";
119
+
120
+ // src/run.ts
121
+ var RUN_STATUS = {
122
+ pendingApproval: "PENDING_APPROVAL",
123
+ running: "RUNNING",
124
+ awaitingInput: "AWAITING_INPUT",
125
+ succeeded: "SUCCEEDED",
126
+ failed: "FAILED",
127
+ cancelled: "CANCELLED",
128
+ compensating: "COMPENSATING"
129
+ };
130
+ var TERMINAL = [RUN_STATUS.succeeded, RUN_STATUS.failed, RUN_STATUS.cancelled];
131
+ var isTerminal = (run) => TERMINAL.includes(run.status);
132
+ var outputOf = (run, key) => run.outputs.find((o) => o.key === key)?.value ?? null;
133
+ var shape2 = (what) => new OrazakaError(ORAZAKA_CODE.shape, `Orazaka's answer has an unexpected shape: ${what}`);
134
+ var text2 = (v) => typeof v === "string" ? v : null;
135
+ var parseOutput = (raw) => {
136
+ const o = raw ?? {};
137
+ if (typeof o.key !== "string" || typeof o.type !== "string") throw shape2("an output without key and type");
138
+ return { key: o.key, label: text2(o.label), type: o.type, value: text2(o.value) };
139
+ };
140
+ function parseRun(body) {
141
+ const o = body ?? {};
142
+ if (typeof o.id !== "string" || typeof o.studioKey !== "string" || typeof o.status !== "string") throw shape2("a run needs id, studioKey and status");
143
+ if (o.outputs !== void 0 && o.outputs !== null && !Array.isArray(o.outputs)) throw shape2("outputs is not a list");
144
+ return {
145
+ id: o.id,
146
+ studioKey: o.studioKey,
147
+ blueprintVersion: text2(o.blueprintVersion),
148
+ status: o.status,
149
+ outputs: (o.outputs ?? []).map(parseOutput),
150
+ errorMessage: text2(o.errorMessage),
151
+ startedAt: text2(o.startedAt),
152
+ finishedAt: text2(o.finishedAt)
153
+ };
154
+ }
155
+ function parseInstallations(body) {
156
+ if (!Array.isArray(body)) throw shape2("installations is not a list");
157
+ return body.map((i) => {
158
+ const key = i?.studioKey;
159
+ if (typeof key !== "string") throw shape2("an installation without studioKey");
160
+ return key;
161
+ });
162
+ }
163
+
164
+ // src/client.ts
165
+ var STUDIO_KEY = /^[a-z0-9][a-z0-9-]{0,79}$/i;
166
+ var RUN_ID = /^[0-9a-f-]{36}$/i;
167
+ var CHECK_PURPOSES = ["court-records", "credit"];
168
+ var PROVIDER_REF = /^[A-Za-z0-9._:~-]{1,120}$/;
169
+ var IDEMPOTENCY_KEY = /^[!-~]{1,255}$/;
170
+ var KEY_REUSED = "idempotency_key_reused";
171
+ var DEFAULT_TIMEOUT_MS = 2e4;
172
+ var DEFAULT_CIRCUIT = { failureThreshold: 5, openSeconds: 30 };
173
+ var DEFAULT_WAIT_INTERVAL_MS = 2e3;
174
+ var DEFAULT_WAIT_TIMEOUT_MS = 12e4;
175
+ var BUSY_MIN_SECONDS = 1;
176
+ var BUSY_MAX_SECONDS = 300;
177
+ var BUSY_DEFAULT_SECONDS = 15;
178
+ var NO_STORE = { cache: "no-store" };
179
+ var sleepFor = (milliseconds) => new Promise((resolve) => setTimeout(resolve, milliseconds));
180
+ function createOrazakaClient(options) {
181
+ const doFetch = options.fetch ?? fetch;
182
+ const base = options.baseUrl.replace(/\/+$/, "");
183
+ const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
184
+ const circuit = options.circuit === false ? null : createCircuit(options.circuit ?? DEFAULT_CIRCUIT, options.clock);
185
+ const sleep = options.sleep ?? sleepFor;
186
+ const installed = /* @__PURE__ */ new Set();
187
+ async function refusal(res, method, path) {
188
+ const where = `${method} ${path.split("?")[0]}`;
189
+ const body = await res.json().catch(() => null);
190
+ if (res.status === 429) {
191
+ const asked = Number(res.headers.get("retry-after") ?? body?.retryAfterSeconds);
192
+ const wait = Math.min(BUSY_MAX_SECONDS, Math.max(BUSY_MIN_SECONDS, asked || BUSY_DEFAULT_SECONDS));
193
+ return new OrazakaError(ORAZAKA_CODE.busy, `Orazaka is busy on ${where}`, { upstreamStatus: 429, status: 429, retryAfterSeconds: wait });
194
+ }
195
+ if (res.status === 422 && (body?.status === KEY_REUSED || body?.code === KEY_REUSED)) {
196
+ return new OrazakaError(ORAZAKA_CODE.keyReused, `The idempotency key already started a different request on ${where}`, { upstreamStatus: 422, status: 409 });
197
+ }
198
+ const { status, code } = orazakaRefusal(res.status);
199
+ return new OrazakaError(code, `Orazaka answered ${res.status} on ${where}`, { upstreamStatus: res.status, status });
200
+ }
201
+ async function call(path, init = {}) {
202
+ if (!options.apiKey) throw new OrazakaError(ORAZAKA_CODE.notConfigured, "The Orazaka API key is not set", { status: 503 });
203
+ circuit?.check();
204
+ const method = init.method ?? "GET";
205
+ let res;
206
+ try {
207
+ res = await doFetch(`${base}${path}`, {
208
+ method,
209
+ headers: { authorization: `Bearer ${options.apiKey}`, accept: "application/json", ...init.body === void 0 ? {} : { "content-type": "application/json" }, ...init.headers },
210
+ body: init.body === void 0 ? void 0 : JSON.stringify(init.body),
211
+ signal: AbortSignal.timeout(timeoutMs),
212
+ ...NO_STORE
213
+ });
214
+ } catch (cause) {
215
+ circuit?.failure();
216
+ const timedOut = cause instanceof Error && (cause.name === "TimeoutError" || cause.name === "AbortError");
217
+ throw new OrazakaError(timedOut ? ORAZAKA_CODE.timeout : ORAZAKA_CODE.unavailable, timedOut ? "Orazaka did not answer in time" : "Orazaka did not answer", { status: 502 });
218
+ }
219
+ if (res.status >= 500) {
220
+ circuit?.failure();
221
+ throw new OrazakaError(ORAZAKA_CODE.unavailable, `Orazaka answered ${res.status} on ${method} ${path.split("?")[0]}`, { upstreamStatus: res.status, status: 502 });
222
+ }
223
+ circuit?.success();
224
+ if (!res.ok) throw await refusal(res, method, path);
225
+ return res;
226
+ }
227
+ const json = (res) => res.json().catch(() => void 0);
228
+ async function studios() {
229
+ return parseInstallations(await json(await call("/api/v1/studios/installations")));
230
+ }
231
+ async function ensureInstalled(studio) {
232
+ if (installed.has(studio)) return;
233
+ if (!(await studios()).includes(studio)) await call(`/api/v1/studios/${studio}/installations?locale=en`, { method: "POST", body: { config: {} } });
234
+ installed.add(studio);
235
+ }
236
+ const checkRunId = (runId) => {
237
+ if (!RUN_ID.test(runId)) throw new OrazakaError(ORAZAKA_CODE.badRun, "Not a run id", { status: 400 });
238
+ };
239
+ async function getRun(runId) {
240
+ checkRunId(runId);
241
+ return parseRun(await json(await call(`/api/v1/studios/runs/${runId}`)));
242
+ }
243
+ return {
244
+ circuit,
245
+ studios,
246
+ getRun,
247
+ async startRun(studio, inputs, { idempotencyKey } = {}) {
248
+ if (!STUDIO_KEY.test(studio)) throw new OrazakaError(ORAZAKA_CODE.input, "Not a Studio key", { status: 422 });
249
+ 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 });
250
+ if (options.autoInstall !== false) await ensureInstalled(studio);
251
+ const res = await call(`/api/v1/studios/${studio}/runs`, { method: "POST", body: { inputs }, headers: idempotencyKey ? { "idempotency-key": idempotencyKey } : {} });
252
+ return { run: parseRun(await json(res)), replayed: res.headers.get("idempotent-replayed") === "true" };
253
+ },
254
+ async startCheck(purpose, { subject, consented, runId }) {
255
+ if (!CHECK_PURPOSES.includes(purpose)) throw new OrazakaError(ORAZAKA_CODE.input, "Not a check purpose", { status: 422 });
256
+ const res = await call(`/api/v1/checks/${purpose}`, { method: "POST", body: { ...subject, runId, consented } });
257
+ return parseCheck(await json(res));
258
+ },
259
+ async collectCheck(providerRef, { subjectId, consented }) {
260
+ if (!PROVIDER_REF.test(providerRef)) throw new OrazakaError(ORAZAKA_CODE.input, "Not a provider reference", { status: 422 });
261
+ const query = new URLSearchParams({ subjectId, consented: String(consented) });
262
+ return parseCheck(await json(await call(`/api/v1/checks/${providerRef}?${query}`)));
263
+ },
264
+ async waitForRun(runId, { intervalMs = DEFAULT_WAIT_INTERVAL_MS, timeoutMs: waitMs = DEFAULT_WAIT_TIMEOUT_MS } = {}) {
265
+ const deadline = addMilliseconds(options.clock.now(), waitMs);
266
+ for (; ; ) {
267
+ const run = await getRun(runId);
268
+ if (isTerminal(run)) return run;
269
+ if (isAfter(options.clock.now(), deadline)) throw new OrazakaError(ORAZAKA_CODE.waitExpired, `The run is still ${run.status} after ${waitMs} ms`, { status: 504 });
270
+ await sleep(intervalMs);
271
+ }
272
+ }
273
+ };
274
+ }
275
+ export {
276
+ CHECK_CATEGORY,
277
+ CHECK_OUTCOME,
278
+ CHECK_PURPOSE,
279
+ CHECK_REFUSAL,
280
+ ORAZAKA_CODE,
281
+ OrazakaError,
282
+ RUN_STATUS,
283
+ createCircuit,
284
+ createOrazakaClient,
285
+ isTerminal,
286
+ orazakaRefusal,
287
+ outputOf,
288
+ parseCheck,
289
+ parseInstallations,
290
+ parseRun
291
+ };
292
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/errors.ts","../src/checks.ts","../src/circuit.ts","../src/client.ts","../src/run.ts"],"sourcesContent":["/** 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 { ORAZAKA_CODE, OrazakaError } from \"./errors\";\n\n/** The checks a product may ask for: `POST /api/v1/checks/{purpose}`. Identity checks are not offered to products. */\nexport const CHECK_PURPOSE = { courtRecords: \"court-records\", credit: \"credit\" } as const;\nexport type CheckPurposeKey = (typeof CHECK_PURPOSE)[keyof typeof CHECK_PURPOSE];\n\nexport const CHECK_OUTCOME = [\"MATCH\", \"NO_MATCH\", \"PENDING\", \"PROVIDER_ERROR\", \"TIMEOUT\", \"REFUSED\"] as const;\nexport type CheckOutcome = (typeof CHECK_OUTCOME)[number];\n\n/** Why a check was refused; present exactly when the outcome is `REFUSED`. `NOT_CONFIGURED` means Orazaka has no provider, key or pepper for it: never a result. */\nexport const CHECK_REFUSAL = [\"NO_CONSENT\", \"NO_KEY\", \"BUDGET_EXHAUSTED\", \"NOT_CONFIGURED\"] as const;\nexport type CheckRefusal = (typeof CHECK_REFUSAL)[number];\n\n/** The closed court category of a match; `NONE` for everything else. Never free text, never a record. */\nexport const CHECK_CATEGORY = [\"TAL_NON_PAYMENT\", \"TAL_OTHER\", \"CRIMINAL\", \"CIVIL\", \"NONE\"] as const;\nexport type CheckCategory = (typeof CHECK_CATEGORY)[number];\n\nexport interface CheckSubject {\n /** The opaque id of the subject on the product's side: consent and the audit are keyed on it, the names never are. */\n subjectId: string;\n lastName: string;\n firstName: string;\n /** ISO date, optional. */\n birthDate?: string;\n address?: string;\n /** For example `QC`: routes Québec court records to the Québec provider. */\n region?: string;\n}\n\nexport interface StartCheckInput {\n subject: CheckSubject;\n /** The product's statement that the subject consented to this purpose. Without it Orazaka answers `REFUSED / NO_CONSENT` and asks nobody. */\n consented: boolean;\n /** The product's run this check belongs to, kept on the audit line. */\n runId?: string;\n}\n\nexport interface CollectCheckInput {\n /** The subject the check was for. */\n subjectId: string;\n /** The consent must still stand: it is checked again at every poll. */\n consented: boolean;\n}\n\n/** The closed answer of a check, as Orazaka's `CheckResult`: an outcome and a category, no record. A refusal is an answer, not an exception. */\nexport interface CheckResult {\n purpose: \"COURT_RECORDS\" | \"CREDIT\" | \"IDENTITY\";\n outcome: CheckOutcome;\n refusal: CheckRefusal | null;\n category: CheckCategory;\n /** The provider's opaque reference: collect a `PENDING` check with it. */\n providerRef: string | null;\n runId: string | null;\n}\n\nconst PURPOSES = [\"COURT_RECORDS\", \"CREDIT\", \"IDENTITY\"] as const;\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);\nconst oneOf = <T extends string>(list: readonly T[], v: unknown): T | null => (list as readonly unknown[]).includes(v) ? (v as T) : null;\n\n/** Reads a check's answer from the edge's JSON; anything else is `ORAZAKA_SHAPE`. */\nexport function parseCheck(body: unknown): CheckResult {\n const o = (body ?? {}) as Record<string, unknown>;\n const purpose = oneOf(PURPOSES, o.purpose);\n const outcome = oneOf(CHECK_OUTCOME, o.outcome);\n const category = oneOf(CHECK_CATEGORY, o.category ?? \"NONE\");\n if (!purpose || !outcome || !category) throw shape(\"a check needs a known purpose, outcome and category\");\n const refusal = o.refusal === undefined || o.refusal === null ? null : oneOf(CHECK_REFUSAL, o.refusal);\n if ((outcome === \"REFUSED\") !== (refusal !== null)) throw shape(\"a refusal comes with REFUSED, and REFUSED with a refusal\");\n return { purpose, outcome, refusal, category, providerRef: text(o.providerRef), runId: text(o.runId) };\n}\n","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","import { addMilliseconds, isAfter } from \"date-fns\";\n\nimport { type CheckPurposeKey, type CheckResult, type CollectCheckInput, parseCheck, type StartCheckInput } from \"./checks\";\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 /**\n * Starts an external check (`POST /api/v1/checks/{purpose}`): court records or credit, through Orazaka's one door.\n * Orazaka, not the product, decides consent, key, budget and provider; a refusal (`NO_CONSENT`, `NO_KEY`,\n * `BUDGET_EXHAUSTED`, `NOT_CONFIGURED`) is the answer, with outcome `REFUSED`. Answers `PENDING` with a `providerRef` when the provider replies later.\n */\n startCheck(purpose: CheckPurposeKey, input: StartCheckInput): Promise<CheckResult>;\n /** Collects a `PENDING` check by its provider reference (`GET /api/v1/checks/{providerRef}`); `PENDING` again while the provider works. */\n collectCheck(providerRef: string, input: CollectCheckInput): Promise<CheckResult>;\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 CHECK_PURPOSES: readonly string[] = [\"court-records\", \"credit\"];\n/** A provider's opaque reference: printable, no slash, so it cannot change the path. */\nconst PROVIDER_REF = /^[A-Za-z0-9._:~-]{1,120}$/;\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 startCheck(purpose, { subject, consented, runId }) {\n if (!CHECK_PURPOSES.includes(purpose)) throw new OrazakaError(ORAZAKA_CODE.input, \"Not a check purpose\", { status: 422 });\n const res = await call(`/api/v1/checks/${purpose}`, { method: \"POST\", body: { ...subject, runId, consented } });\n return parseCheck(await json(res));\n },\n async collectCheck(providerRef, { subjectId, consented }) {\n if (!PROVIDER_REF.test(providerRef)) throw new OrazakaError(ORAZAKA_CODE.input, \"Not a provider reference\", { status: 422 });\n const query = new URLSearchParams({ subjectId, consented: String(consented) });\n return parseCheck(await json(await call(`/api/v1/checks/${providerRef}?${query}`)));\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":";AACO,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;;;ACrEO,IAAM,gBAAgB,EAAE,cAAc,iBAAiB,QAAQ,SAAS;AAGxE,IAAM,gBAAgB,CAAC,SAAS,YAAY,WAAW,kBAAkB,WAAW,SAAS;AAI7F,IAAM,gBAAgB,CAAC,cAAc,UAAU,oBAAoB,gBAAgB;AAInF,IAAM,iBAAiB,CAAC,mBAAmB,aAAa,YAAY,SAAS,MAAM;AAyC1F,IAAM,WAAW,CAAC,iBAAiB,UAAU,UAAU;AACvD,IAAM,QAAQ,CAAC,SAAiB,IAAI,aAAa,aAAa,OAAO,6CAA6C,IAAI,EAAE;AACxH,IAAM,OAAO,CAAC,MAA+B,OAAO,MAAM,WAAW,IAAI;AACzE,IAAM,QAAQ,CAAmB,MAAoB,MAA0B,KAA4B,SAAS,CAAC,IAAK,IAAU;AAG7H,SAAS,WAAW,MAA4B;AACrD,QAAM,IAAK,QAAQ,CAAC;AACpB,QAAM,UAAU,MAAM,UAAU,EAAE,OAAO;AACzC,QAAM,UAAU,MAAM,eAAe,EAAE,OAAO;AAC9C,QAAM,WAAW,MAAM,gBAAgB,EAAE,YAAY,MAAM;AAC3D,MAAI,CAAC,WAAW,CAAC,WAAW,CAAC,SAAU,OAAM,MAAM,qDAAqD;AACxG,QAAM,UAAU,EAAE,YAAY,UAAa,EAAE,YAAY,OAAO,OAAO,MAAM,eAAe,EAAE,OAAO;AACrG,MAAK,YAAY,eAAgB,YAAY,MAAO,OAAM,MAAM,0DAA0D;AAC1H,SAAO,EAAE,SAAS,SAAS,SAAS,UAAU,aAAa,KAAK,EAAE,WAAW,GAAG,OAAO,KAAK,EAAE,KAAK,EAAE;AACvG;;;ACtEA,SAAS,YAAY,qBAAqB,gBAAgB;AAoBnD,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;;;ACtD/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,IAAMA,SAAQ,CAAC,SAAiB,IAAI,aAAa,aAAa,OAAO,6CAA6C,IAAI,EAAE;AACxH,IAAMC,QAAO,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,OAAMD,OAAM,gCAAgC;AACzG,SAAO,EAAE,KAAK,EAAE,KAAK,OAAOC,MAAK,EAAE,KAAK,GAAG,MAAM,EAAE,MAAM,OAAOA,MAAK,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,OAAMD,OAAM,sCAAsC;AACnJ,MAAI,EAAE,YAAY,UAAa,EAAE,YAAY,QAAQ,CAAC,MAAM,QAAQ,EAAE,OAAO,EAAG,OAAMA,OAAM,uBAAuB;AACnH,SAAO;AAAA,IACL,IAAI,EAAE;AAAA,IACN,WAAW,EAAE;AAAA,IACb,kBAAkBC,MAAK,EAAE,gBAAgB;AAAA,IACzC,QAAQ,EAAE;AAAA,IACV,UAAW,EAAE,WAA4C,CAAC,GAAG,IAAI,WAAW;AAAA,IAC5E,cAAcA,MAAK,EAAE,YAAY;AAAA,IACjC,WAAWA,MAAK,EAAE,SAAS;AAAA,IAC3B,YAAYA,MAAK,EAAE,UAAU;AAAA,EAC/B;AACF;AAGO,SAAS,mBAAmB,MAAyB;AAC1D,MAAI,CAAC,MAAM,QAAQ,IAAI,EAAG,OAAMD,OAAM,6BAA6B;AACnE,SAAO,KAAK,IAAI,CAAC,MAAM;AACrB,UAAM,MAAO,GAAsC;AACnD,QAAI,OAAO,QAAQ,SAAU,OAAMA,OAAM,mCAAmC;AAC5E,WAAO;AAAA,EACT,CAAC;AACH;;;ADTA,IAAM,aAAa;AACnB,IAAM,SAAS;AACf,IAAM,iBAAoC,CAAC,iBAAiB,QAAQ;AAEpE,IAAM,eAAe;AACrB,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,SAAS,EAAE,SAAS,WAAW,MAAM,GAAG;AACvD,UAAI,CAAC,eAAe,SAAS,OAAO,EAAG,OAAM,IAAI,aAAa,aAAa,OAAO,uBAAuB,EAAE,QAAQ,IAAI,CAAC;AACxH,YAAM,MAAM,MAAM,KAAK,kBAAkB,OAAO,IAAI,EAAE,QAAQ,QAAQ,MAAM,EAAE,GAAG,SAAS,OAAO,UAAU,EAAE,CAAC;AAC9G,aAAO,WAAW,MAAM,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,IACA,MAAM,aAAa,aAAa,EAAE,WAAW,UAAU,GAAG;AACxD,UAAI,CAAC,aAAa,KAAK,WAAW,EAAG,OAAM,IAAI,aAAa,aAAa,OAAO,4BAA4B,EAAE,QAAQ,IAAI,CAAC;AAC3H,YAAM,QAAQ,IAAI,gBAAgB,EAAE,WAAW,WAAW,OAAO,SAAS,EAAE,CAAC;AAC7E,aAAO,WAAW,MAAM,KAAK,MAAM,KAAK,kBAAkB,WAAW,IAAI,KAAK,EAAE,CAAC,CAAC;AAAA,IACpF;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":["shape","text"]}
package/package.json CHANGED
@@ -1,6 +1,59 @@
1
1
  {
2
2
  "name": "@krizaka/orazaka-client",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "version": "0.2.0",
4
+ "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.",
5
+ "keywords": [
6
+ "krizaka",
7
+ "orazaka",
8
+ "client",
9
+ "studio",
10
+ "runs"
11
+ ],
12
+ "homepage": "https://github.com/krizaka/krizaka-ts/tree/main/packages/orazaka-client",
13
+ "bugs": "https://github.com/krizaka/krizaka-ts/issues",
14
+ "repository": {
15
+ "type": "git",
16
+ "url": "git+https://github.com/krizaka/krizaka-ts.git",
17
+ "directory": "packages/orazaka-client"
18
+ },
19
+ "license": "Apache-2.0",
20
+ "author": "Krizaka (https://www.krizaka.com)",
21
+ "type": "module",
22
+ "main": "./dist/index.js",
23
+ "module": "./dist/index.js",
24
+ "types": "./dist/index.d.ts",
25
+ "exports": {
26
+ ".": {
27
+ "types": "./dist/index.d.ts",
28
+ "import": "./dist/index.js"
29
+ },
30
+ "./package.json": "./package.json"
31
+ },
32
+ "files": [
33
+ "dist",
34
+ "README.md",
35
+ "LICENSE"
36
+ ],
37
+ "sideEffects": false,
38
+ "engines": {
39
+ "node": ">=22"
40
+ },
41
+ "dependencies": {
42
+ "date-fns": "^4.4.0"
43
+ },
44
+ "devDependencies": {
45
+ "@types/node": "^22.10.0",
46
+ "eslint": "^9.39.0",
47
+ "tsup": "^8.5.0",
48
+ "typescript": "^5.9.3",
49
+ "vitest": "^4.1.11",
50
+ "@krizaka/config": "^0.10.0"
51
+ },
52
+ "scripts": {
53
+ "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsup",
54
+ "lint": "eslint . --max-warnings 0 && tsc --noEmit",
55
+ "typecheck": "tsc --noEmit",
56
+ "test": "vitest run",
57
+ "check": "pnpm run lint && pnpm run test && pnpm run build"
58
+ }
6
59
  }