roicai 0.0.1 → 0.1.0

package/LICENSE

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

package/README.md

@@ -1,5 +1,97 @@
-# roicai
+# ROIC.ai Node.js SDK
 
-The official Node.js SDK for the [ROIC.ai](https://roic.ai) financial data API is coming soon.
+TypeScript and JavaScript client for the [ROIC.ai](https://roic.ai) financial data API: tickers, prices, fundamentals, ratios, earnings calls, company events and bulk downloads.
 
-Until then, see the API documentation at [roic.ai](https://roic.ai).
+## Install
+
+```sh
+npm install roicai
+```
+
+Requires Node.js 20 or later. It also runs in Bun.
+
+## Usage
+
+```ts
+import { createClient } from 'roicai';
+
+const roicai = createClient({ token: process.env.ROICAI_API_KEY! });
+
+const ticker = await roicai.tickers.retrieve({ identifier: 'NASDAQ:AAPL' });
+
+const statements = await roicai.fundamentals.incomeStatements.list({
+  identifier: 'NASDAQ:AAPL',
+  periodType: 'annual',
+  limit: 5,
+});
+
+const latest = await roicai.stockPrices.latest.retrieve({ identifier: 'NASDAQ:AAPL' });
+```
+
+Methods are grouped the way the API's URLs are: `/v3.0.0/fundamental/ratios/credit/{identifier}` is `roicai.fundamentals.ratios.credit.list(...)`. Each group has `list`, `retrieve` or `search`.
+
+Identifiers are an exchange and symbol separated by a colon (`NASDAQ:AAPL`), a ticker ID (`tkr_...`) or a FIGI.
+
+### Fields and dates
+
+Fields are camelCase (`periodEndDate`), where the API's JSON is snake_case (`period_end_date`). Dates and timestamps are ISO 8601 strings; pass them to `new Date()` when you need a `Date`.
+
+### Errors
+
+A request that fails throws an `ApiError` with the HTTP `status` and the API's error in `details`:
+
+```ts
+import { ApiError } from 'roicai';
+
+try {
+  await roicai.tickers.retrieve({ identifier: 'NASDAQ:NOPE' });
+} catch (err) {
+  if (err instanceof ApiError && err.status === 404) {
+    // no such ticker
+  }
+}
+```
+
+### Options
+
+| Option | Default | |
+|---|---|---|
+| `token` | required | Your API key, sent as `Authorization: Bearer <token>`. |
+| `baseUrl` | `https://api.roic.ai` | |
+| `fetch` | global `fetch` | |
+| `headers` | | Sent with every request. |
+
+Each method also takes `RequestOptions` as its last argument, such as an `AbortSignal`.
+
+## Development
+
+The client in `src/generated` is generated from the API's OpenAPI document with [forge](https://github.com/cloudflare/forge). Don't edit it by hand: CI regenerates it from `openapi.json` and fails on any difference.
+
+```sh
+npm ci
+npm run build
+npm test                          # set ROICAI_API_KEY to also run the live tests
+```
+
+To regenerate, install jq and forge at the pinned commit, then run the script:
+
+```sh
+cargo install --git https://github.com/cloudflare/forge --rev "$(cat .forge-version)" forge
+npm run generate                  # from https://api.roic.ai/openapi.json
+npm run generate -- ./spec.json   # from another document
+```
+
+The **Codegen** workflow does this after every API deploy and opens a pull request when the SDK changed. Review the `openapi.json` diff in that pull request: a removed or renamed method, group or field is a breaking change (see [Releasing](#releasing)).
+
+`src/index.ts` is the only hand-written source. It sets the default `baseUrl` and re-exports the generated client.
+
+## Releasing
+
+1. Open a pull request that sets `version` in `package.json` (and `package-lock.json`, with `npm version <version> --no-git-tag-version`). The SDK follows semver: while it is `0.x`, a breaking change needs a new minor version.
+2. After it merges, publish a GitHub release whose tag is `v` plus that version, such as `v0.1.0`. Mark it as a pre-release to publish under the `next` tag instead of `latest`.
+
+The **Release** workflow then builds, tests and publishes to npm with a provenance attestation. npm trusts that workflow as the package's publisher, so there is no npm token to rotate.
+
+## License
+
+[MIT](LICENSE)

package/dist/generated/_/codec.d.ts

@@ -0,0 +1,93 @@
+/**
+ * A codec converts a value between its wire form, as JSON has it, and its
+ * TypeScript form. A value whose shape does not match the codec is kept as
+ * it is.
+ */
+export interface Codec {
+    /**
+     * Converts a wire value. `source` is the source text of a number whose
+     * value JSON.parse could not hold exactly.
+     */
+    decode(value: unknown, source?: string): unknown;
+    /**
+     * Converts a TypeScript value to its wire form.
+     */
+    encode(value: unknown): unknown;
+}
+/**
+ * A codec, or a function that returns one, so codecs can form cycles.
+ */
+export type CodecRef = Codec | (() => Codec);
+/**
+ * An entry of an object codec: the wire name of a key, its field name when
+ * it is renamed, and the codec of its value when the value is converted.
+ */
+export type Entry = readonly [wire: string, field: string] | readonly [wire: string, field: string | null, codec: CodecRef];
+type Record = {
+    [key: string]: unknown;
+};
+/**
+ * Reports whether value is a plain object, as JSON.parse creates them.
+ */
+export declare function isRecord(value: unknown): value is Record;
+/**
+ * Sets a key of a new object, including one named `__proto__`.
+ */
+export declare function set(target: Record, key: string, value: unknown): void;
+/**
+ * Parses JSON, and keeps the source text of integers too large for a number,
+ * so that `int64` decodes them exactly.
+ */
+export declare function parse(text: string): unknown;
+/**
+ * Returns the codec of an object, with an entry for each key that is renamed
+ * or whose value is converted. Other keys are kept as they are.
+ */
+export declare function object(entries: readonly Entry[]): Codec;
+/**
+ * Returns the codec of an array, which converts its items.
+ */
+export declare function array(items: CodecRef): Codec;
+/**
+ * Returns the codec of a map, which converts its values and keeps its keys.
+ */
+export declare function map(values: CodecRef): Codec;
+/**
+ * Returns the codec of a union. Each member's codec converts the parts of
+ * the value it knows, and keeps the rest.
+ */
+export declare function union(members: readonly CodecRef[]): Codec;
+/**
+ * Returns the codec of an intersection, which converts the value with the
+ * codec of each member.
+ */
+export declare function intersection(members: readonly CodecRef[]): Codec;
+/**
+ * Returns the codec of a union that a property discriminates: the codec of
+ * the member that the property's value names. `wire` and `field` are the
+ * property's names, with `field` null when it is not renamed.
+ */
+export declare function discriminated(wire: string, field: string | null, cases: {
+    readonly [value: string]: CodecRef;
+}): Codec;
+/**
+ * Converts a `date-time` string and a Temporal.Instant.
+ */
+export declare const instant: Codec;
+/**
+ * Converts a `date` string and a Temporal.PlainDate.
+ */
+export declare const date: Codec;
+/**
+ * Returns the base64 encoding of bytes.
+ */
+export declare function toBase64(bytes: Uint8Array): string;
+/**
+ * Converts a `byte` string, in base64, and a Uint8Array.
+ */
+export declare const bytes: Codec;
+/**
+ * Converts an `int64` number and a bigint, without losing digits.
+ */
+export declare const int64: Codec;
+export {};

package/dist/generated/_/codec.js

@@ -0,0 +1,299 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+function resolve(ref) {
+    return typeof ref === 'function' ? ref() : ref;
+}
+/**
+ * Reports whether value is a plain object, as JSON.parse creates them.
+ */
+export function isRecord(value) {
+    if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+        return false;
+    }
+    const proto = Object.getPrototypeOf(value);
+    return proto === Object.prototype || proto === null;
+}
+/**
+ * Sets a key of a new object, including one named `__proto__`.
+ */
+export function set(target, key, value) {
+    if (key === '__proto__') {
+        Object.defineProperty(target, key, {
+            value,
+            enumerable: true,
+            writable: true,
+            configurable: true,
+        });
+    }
+    else {
+        target[key] = value;
+    }
+}
+// The source text of the numbers that JSON.parse could not hold exactly, by
+// the object or array they are in and their key.
+const sources = new WeakMap();
+function sourceOf(holder, key) {
+    return sources.get(holder)?.get(key);
+}
+const recordSource = function (key, value, context) {
+    const source = context?.source;
+    if (typeof value === 'number' && !Number.isSafeInteger(value) && source !== undefined && /^-?\d+$/.test(source)) {
+        const holder = this;
+        let keys = sources.get(holder);
+        if (keys === undefined) {
+            keys = new Map();
+            sources.set(holder, keys);
+        }
+        keys.set(key, source);
+    }
+    return value;
+};
+const parseWithReviver = JSON.parse;
+/**
+ * Parses JSON, and keeps the source text of integers too large for a number,
+ * so that `int64` decodes them exactly.
+ */
+export function parse(text) {
+    // An integer that a number cannot hold has at least 16 digits.
+    if (!/\d{16}/.test(text)) {
+        return JSON.parse(text);
+    }
+    return parseWithReviver(text, recordSource);
+}
+class ObjectCodec {
+    #entries;
+    #decodeTable;
+    #encodeTable;
+    constructor(entries) {
+        this.#entries = entries;
+    }
+    #table(decode) {
+        const table = new Map();
+        for (const [wire, field, codec] of this.#entries) {
+            const resolved = codec === undefined ? undefined : resolve(codec);
+            if (decode) {
+                table.set(wire, [field ?? wire, resolved]);
+            }
+            else {
+                table.set(field ?? wire, [wire, resolved]);
+            }
+        }
+        return table;
+    }
+    decode(value) {
+        if (!isRecord(value)) {
+            return value;
+        }
+        this.#decodeTable ??= this.#table(true);
+        return convert(value, this.#decodeTable, true);
+    }
+    encode(value) {
+        if (!isRecord(value)) {
+            return value;
+        }
+        this.#encodeTable ??= this.#table(false);
+        return convert(value, this.#encodeTable, false);
+    }
+}
+function convert(value, table, decode) {
+    const out = {};
+    for (const key of Object.keys(value)) {
+        const item = value[key];
+        const entry = table.get(key);
+        if (entry === undefined) {
+            set(out, key, item);
+            continue;
+        }
+        const [name, codec] = entry;
+        if (codec === undefined || item === undefined || item === null) {
+            set(out, name, item);
+        }
+        else if (decode) {
+            set(out, name, codec.decode(item, sourceOf(value, key)));
+        }
+        else {
+            set(out, name, codec.encode(item));
+        }
+    }
+    return out;
+}
+/**
+ * Returns the codec of an object, with an entry for each key that is renamed
+ * or whose value is converted. Other keys are kept as they are.
+ */
+export function object(entries) {
+    return new ObjectCodec(entries);
+}
+/**
+ * Returns the codec of an array, which converts its items.
+ */
+export function array(items) {
+    return {
+        decode(value) {
+            if (!Array.isArray(value)) {
+                return value;
+            }
+            const codec = resolve(items);
+            return value.map((item, i) => (item === null ? item : codec.decode(item, sourceOf(value, String(i)))));
+        },
+        encode(value) {
+            if (!Array.isArray(value)) {
+                return value;
+            }
+            const codec = resolve(items);
+            return value.map((item) => (item === null || item === undefined ? item : codec.encode(item)));
+        },
+    };
+}
+/**
+ * Returns the codec of a map, which converts its values and keeps its keys.
+ */
+export function map(values) {
+    return {
+        decode(value) {
+            if (!isRecord(value)) {
+                return value;
+            }
+            const codec = resolve(values);
+            const out = {};
+            for (const key of Object.keys(value)) {
+                const item = value[key];
+                set(out, key, item === null ? item : codec.decode(item, sourceOf(value, key)));
+            }
+            return out;
+        },
+        encode(value) {
+            if (!isRecord(value)) {
+                return value;
+            }
+            const codec = resolve(values);
+            const out = {};
+            for (const key of Object.keys(value)) {
+                const item = value[key];
+                set(out, key, item === null || item === undefined ? item : codec.encode(item));
+            }
+            return out;
+        },
+    };
+}
+function every(members) {
+    return {
+        decode(value, source) {
+            for (const member of members) {
+                value = resolve(member).decode(value, source);
+            }
+            return value;
+        },
+        encode(value) {
+            for (const member of members) {
+                value = resolve(member).encode(value);
+            }
+            return value;
+        },
+    };
+}
+/**
+ * Returns the codec of a union. Each member's codec converts the parts of
+ * the value it knows, and keeps the rest.
+ */
+export function union(members) {
+    return every(members);
+}
+/**
+ * Returns the codec of an intersection, which converts the value with the
+ * codec of each member.
+ */
+export function intersection(members) {
+    return every(members);
+}
+/**
+ * Returns the codec of a union that a property discriminates: the codec of
+ * the member that the property's value names. `wire` and `field` are the
+ * property's names, with `field` null when it is not renamed.
+ */
+export function discriminated(wire, field, cases) {
+    const pick = (value) => {
+        const key = String(value);
+        return Object.hasOwn(cases, key) ? resolve(cases[key]) : undefined;
+    };
+    return {
+        decode(value, source) {
+            if (!isRecord(value)) {
+                return value;
+            }
+            const codec = pick(value[wire]);
+            return codec === undefined ? value : codec.decode(value, source);
+        },
+        encode(value) {
+            if (!isRecord(value)) {
+                return value;
+            }
+            const codec = pick(value[field ?? wire]);
+            return codec === undefined ? value : codec.encode(value);
+        },
+    };
+}
+// attempt returns the result of fn, or fallback when the value is not in the
+// form fn expects. A missing global, such as Temporal, is still thrown.
+function attempt(fn, fallback) {
+    try {
+        return fn();
+    }
+    catch (e) {
+        if (e instanceof ReferenceError) {
+            throw e;
+        }
+        return fallback;
+    }
+}
+function toText(value) {
+    return typeof value === 'object' && value !== null ? String(value) : value;
+}
+/**
+ * Converts a `date-time` string and a Temporal.Instant.
+ */
+export const instant = {
+    decode: (value) => (typeof value === 'string' ? attempt(() => Temporal.Instant.from(value), value) : value),
+    encode: toText,
+};
+/**
+ * Converts a `date` string and a Temporal.PlainDate.
+ */
+export const date = {
+    decode: (value) => (typeof value === 'string' ? attempt(() => Temporal.PlainDate.from(value), value) : value),
+    encode: toText,
+};
+/**
+ * Returns the base64 encoding of bytes.
+ */
+export function toBase64(bytes) {
+    let binary = '';
+    for (let i = 0; i < bytes.length; i += 0x8000) {
+        binary += String.fromCharCode(...bytes.subarray(i, i + 0x8000));
+    }
+    return btoa(binary);
+}
+function fromBase64(text) {
+    const binary = atob(text);
+    const bytes = new Uint8Array(binary.length);
+    for (let i = 0; i < binary.length; i++) {
+        bytes[i] = binary.charCodeAt(i);
+    }
+    return bytes;
+}
+/**
+ * Converts a `byte` string, in base64, and a Uint8Array.
+ */
+export const bytes = {
+    decode: (value) => (typeof value === 'string' ? attempt(() => fromBase64(value), value) : value),
+    encode: (value) => (value instanceof Uint8Array ? toBase64(value) : value),
+};
+const rawJSON = JSON.rawJSON;
+/**
+ * Converts an `int64` number and a bigint, without losing digits.
+ */
+export const int64 = {
+    decode: (value, source) => (typeof value === 'number' && Number.isInteger(value) ? BigInt(source ?? value) : value),
+    encode: (value) => (typeof value === 'bigint' ? rawJSON(value.toString()) : value),
+};
+//# sourceMappingURL=codec.js.map

package/dist/generated/_/codec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codec.js","sourceRoot":"","sources":["../../../src/generated/_/codec.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAgCpB,SAAS,OAAO,CAAC,GAAa;IAC5B,OAAO,OAAO,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;AACjD,CAAC;AAID;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,KAAK,GAAY,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO,KAAK,KAAK,MAAM,CAAC,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;AACtD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,GAAW,EAAE,KAAc;IAC7D,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;QACxB,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE;YACjC,KAAK;YACL,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC;AACH,CAAC;AAED,4EAA4E;AAC5E,iDAAiD;AACjD,MAAM,OAAO,GAAG,IAAI,OAAO,EAA+B,CAAC;AAE3D,SAAS,QAAQ,CAAC,MAAc,EAAE,GAAW;IAC3C,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;AACvC,CAAC;AAID,MAAM,YAAY,GAAY,UAAU,GAAG,EAAE,KAAK,EAAE,OAAO;IACzD,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,MAAM,KAAK,SAAS,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAChH,MAAM,MAAM,GAAG,IAAc,CAAC;QAC9B,IAAI,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;YACjB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAoD,CAAC;AAEnF;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAC,IAAY;IAChC,+DAA+D;IAC/D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,gBAAgB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAC9C,CAAC;AAID,MAAM,WAAW;IACN,QAAQ,CAAmB;IACpC,YAAY,CAAoB;IAChC,YAAY,CAAoB;IAEhC,YAAY,OAAyB;QACnC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,MAAe;QACpB,MAAM,KAAK,GAAU,IAAI,GAAG,EAAE,CAAC;QAC/B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjD,MAAM,QAAQ,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClE,IAAI,MAAM,EAAE,CAAC;gBACX,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC7C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,KAAc;QACnB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,CAAC,KAAc;QACnB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;CACF;AAED,SAAS,OAAO,CAAC,KAAa,EAAE,KAAY,EAAE,MAAe;IAC3D,MAAM,GAAG,GAAW,EAAE,CAAC;IACvB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACxB,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YACpB,SAAS;QACX,CAAC;QACD,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC;QAC5B,IAAI,KAAK,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAC/D,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACvB,CAAC;aAAM,IAAI,MAAM,EAAE,CAAC;YAClB,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAC,OAAyB;IAC9C,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,KAAK,CAAC,KAAe;IACnC,OAAO;QACL,MAAM,CAAC,KAAK;YACV,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;YAC7B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAa,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClH,CAAC;QACD,MAAM,CAAC,KAAK;YACV,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;YAC7B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAa,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzG,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,GAAG,CAAC,MAAgB;IAClC,OAAO;QACL,MAAM,CAAC,KAAK;YACV,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YAC9B,MAAM,GAAG,GAAW,EAAE,CAAC;YACvB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;gBACxB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;YACjF,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,CAAC,KAAK;YACV,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YAC9B,MAAM,GAAG,GAAW,EAAE,CAAC;YACvB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;gBACxB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YACjF,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,KAAK,CAAC,OAA4B;IACzC,OAAO;QACL,MAAM,CAAC,KAAK,EAAE,MAAM;YAClB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAChD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,CAAC,KAAK;YACV,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACxC,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAC,OAA4B;IAChD,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,OAA4B;IACvD,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC;AACxB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAY,EACZ,KAAoB,EACpB,KAA6C;IAE7C,MAAM,IAAI,GAAG,CAAC,KAAc,EAAqB,EAAE;QACjD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACtE,CAAC,CAAC;IACF,OAAO;QACL,MAAM,CAAC,KAAK,EAAE,MAAM;YAClB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAChC,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACnE,CAAC;QACD,MAAM,CAAC,KAAK;YACV,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC;YACzC,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3D,CAAC;KACF,CAAC;AACJ,CAAC;AAED,6EAA6E;AAC7E,wEAAwE;AACxE,SAAS,OAAO,CAAI,EAAW,EAAE,QAAiB;IAChD,IAAI,CAAC;QACH,OAAO,EAAE,EAAE,CAAC;IACd,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,CAAC,YAAY,cAAc,EAAE,CAAC;YAChC,MAAM,CAAC,CAAC;QACV,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;AACH,CAAC;AAED,SAAS,MAAM,CAAC,KAAc;IAC5B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC7E,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAU;IAC5B,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3G,MAAM,EAAE,MAAM;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,IAAI,GAAU;IACzB,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7G,MAAM,EAAE,MAAM;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAiB;IACxC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,MAAM,EAAE,CAAC;QAC9C,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;AACtB,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAU;IAC1B,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAChG,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;CAC3E,CAAC;AAGF,MAAM,OAAO,GAAI,IAA+B,CAAC,OAAO,CAAC;AAEzD;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAU;IAC1B,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACnH,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;CACnF,CAAC"}

package/dist/generated/_/error.d.ts

@@ -0,0 +1,27 @@
+/**
+ * An error response from the API, or a success response whose body is not
+ * valid JSON.
+ */
+export declare class ApiError extends Error {
+    /**
+     * The status of the response.
+     */
+    readonly status: number;
+    /**
+     * The response, whose body has been read.
+     */
+    readonly response: Response;
+    /**
+     * The body decoded as the error the API declares for the status, or the
+     * body as text when it declares none or the body does not parse, or
+     * undefined when the body is empty.
+     */
+    readonly details: unknown;
+    constructor(message: string, response: Response, details: unknown, options?: ErrorOptions);
+}
+/**
+ * Returns the message of a JSON error body: a string `message`, `error`,
+ * `detail` or `title`, then `error.message` or `error.detail`, then the
+ * messages of an `errors` array.
+ */
+export declare function errorMessage(body: unknown): string | undefined;

package/dist/generated/_/error.js

@@ -0,0 +1,69 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { isRecord } from './codec.js';
+/**
+ * An error response from the API, or a success response whose body is not
+ * valid JSON.
+ */
+export class ApiError extends Error {
+    /**
+     * The status of the response.
+     */
+    status;
+    /**
+     * The response, whose body has been read.
+     */
+    response;
+    /**
+     * The body decoded as the error the API declares for the status, or the
+     * body as text when it declares none or the body does not parse, or
+     * undefined when the body is empty.
+     */
+    details;
+    constructor(message, response, details, options) {
+        super(message, options);
+        this.name = 'ApiError';
+        this.status = response.status;
+        this.response = response;
+        this.details = details;
+    }
+}
+function text(value) {
+    return typeof value === 'string' && value !== '' ? value : undefined;
+}
+/**
+ * Returns the message of a JSON error body: a string `message`, `error`,
+ * `detail` or `title`, then `error.message` or `error.detail`, then the
+ * messages of an `errors` array.
+ */
+export function errorMessage(body) {
+    if (!isRecord(body)) {
+        return undefined;
+    }
+    const message = text(body['message']) ?? text(body['error']) ?? text(body['detail']) ?? text(body['title']);
+    if (message !== undefined) {
+        return message;
+    }
+    const error = body['error'];
+    if (isRecord(error)) {
+        const nested = text(error['message']) ?? text(error['detail']);
+        if (nested !== undefined) {
+            return nested;
+        }
+    }
+    const errors = body['errors'];
+    if (Array.isArray(errors)) {
+        const messages = [];
+        for (const item of errors) {
+            const m = isRecord(item) ? text(item['message']) : text(item);
+            if (m !== undefined) {
+                messages.push(m);
+            }
+        }
+        if (messages.length > 0) {
+            return messages.join('; ');
+        }
+    }
+    return undefined;
+}
+//# sourceMappingURL=error.js.map

package/dist/generated/_/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/generated/_/error.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,KAAK;IACjC;;OAEG;IACM,MAAM,CAAS;IACxB;;OAEG;IACM,QAAQ,CAAW;IAC5B;;;;OAIG;IACM,OAAO,CAAU;IAE1B,YAAY,OAAe,EAAE,QAAkB,EAAE,OAAgB,EAAE,OAAsB;QACvF,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,SAAS,IAAI,CAAC,KAAc;IAC1B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,IAAa;IACxC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5G,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5B,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/D,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9D,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACpB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/generated/_/hooks/envelope.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Returns the body a client decodes from a success response, given the
+ * response and its JSON body. It runs for every 2XX response with a JSON
+ * body, before the body is decoded or paginated.
+ *
+ * This implementation returns the body as it is. An SDK whose API wraps its
+ * payloads in an envelope can replace this file in the generated `_/hooks/`
+ * directory with one that returns the part of the envelope that the
+ * description declares.
+ */
+export declare function unwrapEnvelope(_response: Response, body: unknown): unknown;

package/dist/generated/_/hooks/envelope.js

@@ -0,0 +1,16 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+/**
+ * Returns the body a client decodes from a success response, given the
+ * response and its JSON body. It runs for every 2XX response with a JSON
+ * body, before the body is decoded or paginated.
+ *
+ * This implementation returns the body as it is. An SDK whose API wraps its
+ * payloads in an envelope can replace this file in the generated `_/hooks/`
+ * directory with one that returns the part of the envelope that the
+ * description declares.
+ */
+export function unwrapEnvelope(_response, body) {
+    return body;
+}
+//# sourceMappingURL=envelope.js.map

package/dist/generated/_/hooks/envelope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"envelope.js","sourceRoot":"","sources":["../../../../src/generated/_/hooks/envelope.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAAC,SAAmB,EAAE,IAAa;IAC/D,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/generated/_/index.d.ts

@@ -0,0 +1,3 @@
+export { array, bytes, type Codec, type CodecRef, date, discriminated, type Entry, instant, int64, intersection, map, object, union, } from './codec.js';
+export { ApiError } from './error.js';
+export { type BaseClientOptions, type Operation, type Pagination, type RequestOptions, Transport, } from './transport.js';