@arbol-ai/sdk 0.0.0-stage → 1.20261017.200040

package/LICENSE

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

package/README.md

@@ -1,3 +1,69 @@
-# Temporary Holding Version
+# @arbol-ai/sdk
 
-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.
+The Arbol API for TypeScript and JavaScript, generated by
+[Cloudflare Forge](https://github.com/cloudflare/forge) from the platform's public OpenAPI,
+[`https://api.getarbol.com/openapi.json`](https://api.getarbol.com/openapi.json). Everything in `src/`
+is Forge's TypeScript output, unedited, and the package's version is the API release it was generated
+from (`1.YYYYMMDD.n`).
+
+```sh
+npm install @arbol-ai/sdk
+```
+
+```ts
+import { ApiError, createClient } from '@arbol-ai/sdk';
+
+const arbol = createClient({ baseUrl: 'https://api.getarbol.com', token });
+
+const { data } = await arbol.agenda.appointments.get({ id: 'apt_…' });
+data.startsAt; // Temporal.Instant
+```
+
+Every operation is `client.<service>.<resource>.<verb>(request, options?)`, with its request and
+response types beside it (`agenda/appointments`: `GetRequest`, `GetResponse`, …).
+
+## Credentials
+
+`token` is sent as `Authorization: Bearer <token>`. It is one of:
+
+- an Arbol API key, created in Arbol Account. Keep it in a secret manager and never ship it to a
+  browser;
+- an access token for the audience `https://api.getarbol.com`, from any OAuth client, such as a
+  person's session in your app.
+
+The SDK holds no OAuth logic: sign people in however your application does, and create a client with
+the token you have.
+
+## Responses and errors
+
+A method resolves with the response the API declares: `{ success: true, data, error: null, metadata }`.
+Any other status throws `ApiError`, with `status`, the `response`, and its declared body in `details`
+(`{ success: false, error: { code, message, retryable, data }, metadata }`).
+
+Each call sends one request and is never retried. Pass `fetch` to send requests through your own
+function, `headers` or `query` to add to every request, and `signal` to abort a call.
+
+The server authorizes every call: a method in the client is not a grant.
+
+## Requirements
+
+`date-time` fields are `Temporal.Instant` and `date` fields `Temporal.PlainDate`, so the runtime needs
+`fetch` and `Temporal` (Node.js 26, Bun 1.4, current browsers), and TypeScript needs `"lib": ["ESNext"]`.
+
+## Development
+
+```sh
+bun install
+bun run forge       # build the pinned Cloudflare Forge with cargo into .forge/ (once; needs Rust)
+bun run openapi     # download https://api.getarbol.com/openapi.json
+bun run generate    # src/ from openapi.json with `forge --target ts`; the version from its info.version
+bun run verify      # typecheck and build dist/
+```
+
+`openapi.json` is downloaded at generation time and not committed; `package.json`'s version is the
+OpenAPI version `src/` was generated from. Forge is pinned to its commit
+`7f86447210b7bea3779bfdab3cd5655eade0eadb` (0.1.0) in the `forge` script.
+
+## License
+
+[Apache License 2.0](LICENSE)

package/dist/_/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/_/codec.js

@@ -0,0 +1,298 @@
+// 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),
+};

package/dist/_/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;