@glexir/sdk 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Glexir
+
+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,3 +1,293 @@
-# Temporary Holding Version
+# @glexir/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 official TypeScript SDK for the Glexir API. It works with OpenAI's text LLMs, speech-to-text, embeddings, files and batches, and uses the same request and response format as OpenAI's API, so code written for OpenAI's SDK ports over easily.
+
+- No runtime dependencies. Runs on Node 20+, Deno, Bun, edge runtimes and browsers (anywhere with `fetch`).
+- Retries automatically. Every non-GET request sends an `Idempotency-Key`, so a retry is never billed twice.
+- Typed streaming helpers, structured-output parsing, and lists you can page through with `for await`.
+
+## Install
+
+```bash
+pnpm add @glexir/sdk
+```
+
+## Quickstart
+
+```ts
+import Glexir from '@glexir/sdk';
+
+const glexir = new Glexir({
+  apiKey: process.env.GLEXIR_API_KEY, // the default
+  baseURL: 'https://<your-glexir-gateway>/v1', // or set GLEXIR_BASE_URL
+});
+
+const response = await glexir.responses.create({
+  model: 'gpt-6-luna',
+  instructions: 'You are terse.',
+  input: 'Name three planets.',
+});
+console.log(response.output_text);
+```
+
+## Client options
+
+| Option | Default | |
+| --- | --- | --- |
+| `apiKey` | `GLEXIR_API_KEY` | Your Glexir key (`glx_...`). |
+| `baseURL` | `GLEXIR_BASE_URL`, then `https://api.glexir.com/v1` | Gateway URL. For a local gateway, use `http://localhost:8787/v1`. |
+| `timeout` | 10 minutes | Per attempt. Once a stream has started, it has no timeout. |
+| `maxRetries` | 2 | Retries connection errors and 408/409/429/5xx responses. Waits 0.5s, then 1s, 2s and so on up to 8s, with jitter. Uses the server's `retry-after` delay when it is 60s or less. |
+| `fetch` | `globalThis.fetch` | Supply your own (proxies, tests). |
+| `defaultHeaders` | | Sent on every request. |
+
+Every method also takes request options as its last argument: `{ signal, timeout, maxRetries, headers, idempotencyKey }`.
+
+## Responses API (recommended)
+
+```ts
+// Multi-turn without server-side storage: replay the output items yourself.
+const first = await glexir.responses.create({ model: 'gpt-6-luna', input: 'Pick a number', store: false });
+const second = await glexir.responses.create({
+  model: 'gpt-6-luna',
+  store: false,
+  input: [...first.output, { role: 'user', content: 'Double it' }],
+});
+
+// Images and PDFs as input
+await glexir.responses.create({
+  model: 'gpt-6-luna',
+  input: [
+    {
+      role: 'user',
+      content: [
+        { type: 'input_text', text: 'What is in this image?' },
+        { type: 'input_image', detail: 'auto', image_url: 'https://example.com/cat.png' },
+        { type: 'input_file', file_url: 'https://example.com/report.pdf' },
+      ],
+    },
+  ],
+});
+```
+
+### Streaming
+
+```ts
+const stream = glexir.responses.stream({ model: 'gpt-6-luna', input: 'Write a haiku' });
+for await (const event of stream) {
+  if (event.type === 'response.output_text.delta') process.stdout.write(event.delta);
+}
+const final = await stream.finalResponse(); // full Response including usage
+```
+
+Use `glexir.responses.create({ ..., stream: true })` to get the raw event `Stream` instead. If a background response was created with `stream: true`, you can resume its stream with `glexir.responses.stream({ response_id, starting_after })`.
+
+### Function calling
+
+```ts
+const res = await glexir.responses.create({
+  model: 'gpt-6-luna',
+  input: 'Weather in Lagos?',
+  tools: [
+    {
+      type: 'function',
+      name: 'get_weather',
+      parameters: { type: 'object', properties: { city: { type: 'string' } }, required: ['city'], additionalProperties: false },
+      strict: true,
+    },
+  ],
+});
+for (const item of res.output) {
+  if (item.type === 'function_call') console.log(item.name, JSON.parse(item.arguments));
+}
+```
+
+Glexir supports `function`, `custom` and `namespace` tools. The gateway rejects OpenAI-hosted tools: web search, file search, code interpreter, MCP, image generation, shell and computer use.
+
+### Structured outputs
+
+```ts
+import { toStrictJsonSchema } from '@glexir/sdk';
+
+const schema = toStrictJsonSchema({
+  type: 'object',
+  properties: { name: { type: 'string' }, age: { type: ['integer', 'null'] } },
+  required: ['name'],
+});
+
+const res = await glexir.responses.parse(
+  { model: 'gpt-6-luna', input: 'Ada Lovelace, 36', text: { format: { type: 'json_schema', name: 'person', schema, strict: true } } },
+  { validate: (value) => PersonSchema.parse(value) }, // optional, e.g. zod
+);
+res.output_parsed; // { name: 'Ada Lovelace', age: 36 }
+```
+
+`toStrictJsonSchema` applies the strict-mode rules for you:
+
+- It adds `additionalProperties: false` to every object.
+- It makes every property required. If an optional property isn't nullable, it throws instead.
+- It throws on keywords strict mode doesn't support, such as `oneOf`, `if` or `patternProperties`.
+
+`parse()` throws `LengthFinishReasonError` or `ContentFilterFinishReasonError` when the output was cut off.
+
+### Other Responses endpoints
+
+```ts
+await glexir.responses.retrieve('resp_123');
+await glexir.responses.cancel('resp_123'); // background responses
+await glexir.responses.delete('resp_123');
+await glexir.responses.inputTokens.count({ model: 'gpt-6-luna', input: 'How many tokens?' });
+await glexir.responses.compact({ model: 'gpt-6-luna', input: longHistory });
+for await (const item of glexir.responses.inputItems.list('resp_123')) console.log(item.type);
+```
+
+## Conversations
+
+```ts
+const conversation = await glexir.conversations.create({ metadata: { topic: 'support' } });
+await glexir.responses.create({ model: 'gpt-6-luna', conversation: conversation.id, input: 'Hi!' });
+for await (const item of glexir.conversations.items.list(conversation.id, { order: 'asc' })) console.log(item);
+```
+
+## Chat Completions
+
+Chat Completions works the same as on OpenAI. On GPT-5.4 and later it only supports tool calling when `reasoning_effort` is `none`. `gpt-6-astra` and `gpt-6.1-sol` need the Responses API for tool calling.
+
+```ts
+const completion = await glexir.chat.completions.create({
+  model: 'gpt-6-luna',
+  messages: [
+    { role: 'developer', content: 'You are terse.' },
+    { role: 'user', content: 'Hello' },
+  ],
+});
+
+const stream = glexir.chat.completions.stream({ model: 'gpt-6-luna', messages: [{ role: 'user', content: 'Count to 5' }] });
+for await (const chunk of stream) process.stdout.write(chunk.choices[0]?.delta.content ?? '');
+const final = await stream.finalChatCompletion(); // tool-call fragments merged by index
+
+await glexir.chat.completions.parse({
+  model: 'gpt-6-luna',
+  messages: [{ role: 'user', content: 'Extract' }],
+  response_format: { type: 'json_schema', json_schema: { name: 'out', schema, strict: true } },
+});
+```
+
+Completions stored with `store: true` have their own endpoints: `retrieve`, `update`, `list`, `delete` and `messages.list`.
+
+## Transcription
+
+```ts
+import { toFile } from '@glexir/sdk';
+import { readFile } from 'node:fs/promises';
+
+const transcript = await glexir.audio.transcriptions.create({
+  file: await toFile(await readFile('call.m4a'), 'call.m4a'),
+  model: 'gpt-transcribe',
+  languages: ['en'],
+  keywords: ['Glexir'],
+});
+transcript.text;
+
+// Subtitles come back as a string
+const srt = await glexir.audio.transcriptions.create({ file, model: 'whisper-1', response_format: 'srt' });
+
+// Speaker labels
+const diarized = await glexir.audio.transcriptions.create({
+  file,
+  model: 'gpt-4o-transcribe-diarize',
+  response_format: 'diarized_json',
+  chunking_strategy: 'auto',
+});
+diarized.segments.map((s) => `${s.speaker}: ${s.text}`);
+
+// Streaming
+const events = await glexir.audio.transcriptions.create({ file, model: 'gpt-transcribe', stream: true });
+for await (const event of events) if (event.type === 'transcript.text.delta') process.stdout.write(event.delta);
+```
+
+Files can be up to 25 MB, in flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav or webm. OpenAI detects the format from the filename, so pass a `File` or use `toFile(data, 'name.ext')`.
+
+`whisper-1`, the `gpt-4o-*-transcribe` models and `audio.translations` all shut down on **2027-02-26**. Use `gpt-transcribe`.
+
+## Embeddings
+
+```ts
+const { data } = await glexir.embeddings.create({ model: 'text-embedding-3-small', input: ['first', 'second'] });
+data[0].embedding; // number[]
+```
+
+If you leave out `encoding_format`, the SDK requests compact base64 over the wire and decodes it to `number[]` for you.
+
+## Files and batches
+
+Batch jobs cost 50% less and complete within 24 hours.
+
+```ts
+import { toBatchJSONL } from '@glexir/sdk';
+
+const input = await glexir.files.create({
+  purpose: 'batch',
+  file: toBatchJSONL([
+    { custom_id: 'q1', url: '/v1/responses', body: { model: 'gpt-6-luna', input: 'Hello' } },
+    { custom_id: 'q2', url: '/v1/responses', body: { model: 'gpt-6-luna', input: 'Bonjour' } },
+  ]),
+});
+const batch = await glexir.batches.create({ input_file_id: input.id, endpoint: '/v1/responses', completion_window: '24h' });
+
+// later
+const done = await glexir.batches.retrieve(batch.id);
+if (done.output_file_id) {
+  const text = await (await glexir.files.content(done.output_file_id)).text();
+  // one JSON object per line; join on custom_id (order is not preserved)
+}
+```
+
+For PDFs and images used as model input, upload with `purpose: 'user_data'` and reference the file by `file_id`.
+
+## Models
+
+```ts
+for await (const model of glexir.models.list()) console.log(model.id, model.shutdown_date);
+```
+
+## Errors
+
+Every API error is an `APIError` with `status`, `code`, `type`, `param` and `requestID`. Each status code has its own subclass:
+
+| Status | Class |
+| --- | --- |
+| 400 | `BadRequestError` |
+| 401 | `AuthenticationError` |
+| 403 | `PermissionDeniedError` |
+| 404 | `NotFoundError` |
+| 409 | `ConflictError` |
+| 422 | `UnprocessableEntityError` |
+| 429 | `RateLimitError` |
+| 5xx | `InternalServerError` |
+
+Network failures throw `APIConnectionError` or `APIConnectionTimeoutError`, and an aborted request throws `APIUserAbortError`. An error that arrives in the middle of a stream is an `APIError` with `status === undefined`, so check `err.code` rather than the class.
+
+```ts
+import { APIError, RateLimitError } from '@glexir/sdk';
+
+try {
+  await glexir.responses.create({ model: 'gpt-6-luna', input: 'hi' });
+} catch (err) {
+  if (err instanceof RateLimitError) console.log('slow down', err.requestID);
+  else if (err instanceof APIError) console.log(err.status, err.code, err.message);
+  else throw err;
+}
+```
+
+## Raw responses and request IDs
+
+Parsed objects carry the gateway request ID as `_request_id`. To also get the HTTP response, call `.withRawResponse()`:
+
+```ts
+const { data, response, requestId } = await glexir.responses.create({ model: 'gpt-6-luna', input: 'hi' }).withRawResponse();
+```
+
+## Not included
+
+Glexir covers text LLMs and speech-to-text. The SDK doesn't include images, text-to-speech, realtime/WebSocket, video, assistants, fine-tuning, vector stores, uploads or decisions.

package/dist/client.d.ts

@@ -0,0 +1,61 @@
+import { APIPromise, type APIResponseProps } from './core/api-promise.js';
+import { PagePromise, type CursorStrategy } from './core/pagination.js';
+import type { FinalRequestOptions, RequestOptions } from './core/request-options.js';
+import { Audio } from './resources/audio.js';
+import { Batches } from './resources/batches.js';
+import { Chat } from './resources/chat.js';
+import { Conversations } from './resources/conversations.js';
+import { Embeddings } from './resources/embeddings.js';
+import { Files } from './resources/files.js';
+import { Models } from './resources/models.js';
+import { Responses } from './resources/responses.js';
+export declare const DEFAULT_BASE_URL = "https://api.glexir.com/v1";
+export interface ClientOptions {
+    /** Defaults to `process.env.GLEXIR_API_KEY`. */
+    apiKey?: string;
+    /** Defaults to `process.env.GLEXIR_BASE_URL`, then the production gateway at `https://api.glexir.com/v1`. */
+    baseURL?: string;
+    /** Per-attempt timeout in milliseconds. Default 10 minutes. */
+    timeout?: number;
+    /** Retries for connection errors and 408/409/429/5xx responses. Default 2. */
+    maxRetries?: number;
+    /** Custom `fetch` implementation (e.g. for proxies or tests). */
+    fetch?: typeof fetch;
+    /** Headers sent with every request. */
+    defaultHeaders?: Record<string, string>;
+    /** @internal Override the retry sleep (tests). */
+    sleep?: (ms: number, signal?: AbortSignal | null) => Promise<void>;
+}
+/**
+ * The Glexir API client. Wire-compatible with OpenAI's API for text LLMs, transcription,
+ * embeddings, files and batches.
+ */
+export declare class Glexir {
+    readonly apiKey: string;
+    readonly baseURL: string;
+    readonly timeout: number;
+    readonly maxRetries: number;
+    readonly responses: Responses;
+    readonly conversations: Conversations;
+    readonly chat: Chat;
+    readonly audio: Audio;
+    readonly embeddings: Embeddings;
+    readonly files: Files;
+    readonly batches: Batches;
+    readonly models: Models;
+    private readonly fetchImpl;
+    private readonly defaultHeaders;
+    private readonly sleep;
+    constructor(options?: ClientOptions);
+    get<T>(path: string, options?: Partial<FinalRequestOptions>): APIPromise<T>;
+    post<T>(path: string, options?: Partial<FinalRequestOptions>): APIPromise<T>;
+    delete<T>(path: string, options?: Partial<FinalRequestOptions>): APIPromise<T>;
+    request<T>(options: FinalRequestOptions, parse?: (props: APIResponseProps) => Promise<T>): APIPromise<T>;
+    /** @internal */
+    requestAPIList<Item>(options: FinalRequestOptions, cursor: CursorStrategy): PagePromise<Item>;
+    buildURL(path: string, query?: Record<string, unknown>): string;
+    private buildHeaders;
+    private sleepOrAbort;
+    private makeRequest;
+}
+export type { RequestOptions };

package/dist/client.js

@@ -0,0 +1,245 @@
+import { APIPromise } from './core/api-promise.js';
+import { APIConnectionError, APIConnectionTimeoutError, APIError, APIUserAbortError, GlexirError, } from './core/errors.js';
+import { buildMultipartForm } from './core/multipart.js';
+import { PagePromise } from './core/pagination.js';
+import { defaultBackoffMs, retryDelayMs, shouldRetryResponse, sleep, uuid4 } from './core/retry.js';
+import { Stream } from './core/streaming.js';
+import { Audio } from './resources/audio.js';
+import { Batches } from './resources/batches.js';
+import { Chat } from './resources/chat.js';
+import { Conversations } from './resources/conversations.js';
+import { Embeddings } from './resources/embeddings.js';
+import { Files } from './resources/files.js';
+import { Models } from './resources/models.js';
+import { Responses } from './resources/responses.js';
+import { VERSION } from './version.js';
+export const DEFAULT_BASE_URL = 'https://api.glexir.com/v1';
+const DEFAULT_TIMEOUT_MS = 10 * 60 * 1000;
+const DEFAULT_MAX_RETRIES = 2;
+function readEnv(name) {
+    const env = globalThis.process?.env;
+    return env?.[name]?.trim() || undefined;
+}
+function appendQuery(params, key, value) {
+    if (value === undefined || value === null)
+        return;
+    if (Array.isArray(value)) {
+        for (const entry of value)
+            appendQuery(params, `${key}[]`, entry);
+    }
+    else if (typeof value === 'object') {
+        for (const [sub, entry] of Object.entries(value))
+            appendQuery(params, `${key}[${sub}]`, entry);
+    }
+    else {
+        params.append(key, String(value));
+    }
+}
+/** Attaches the `x-request-id` header as a non-enumerable `_request_id` property. */
+function addRequestID(value, response) {
+    if (value && typeof value === 'object' && !Array.isArray(value)) {
+        Object.defineProperty(value, '_request_id', {
+            value: response.headers.get('x-request-id'),
+            enumerable: false,
+            configurable: true,
+            writable: true,
+        });
+    }
+    return value;
+}
+async function defaultParseResponse(props) {
+    const { response, options, controller } = props;
+    if (options.stream)
+        return Stream.fromSSEResponse(response, controller);
+    if (options.binary)
+        return response;
+    if (response.status === 204)
+        return undefined;
+    const contentType = response.headers.get('content-type') ?? '';
+    if (contentType.includes('application/json') || contentType.includes('+json')) {
+        const text = await response.text();
+        if (!text)
+            return undefined;
+        return addRequestID(JSON.parse(text), response);
+    }
+    return (await response.text());
+}
+/** Buffers a body inside the timeout window so slow bodies count against `timeout`. */
+async function bufferResponse(response) {
+    const nullBody = response.status === 204 || response.status === 205 || response.status === 304;
+    const body = nullBody ? null : await response.arrayBuffer();
+    return new Response(body, { status: response.status, statusText: response.statusText, headers: response.headers });
+}
+/**
+ * The Glexir API client. Wire-compatible with OpenAI's API for text LLMs, transcription,
+ * embeddings, files and batches.
+ */
+export class Glexir {
+    apiKey;
+    baseURL;
+    timeout;
+    maxRetries;
+    responses = new Responses(this);
+    conversations = new Conversations(this);
+    chat = new Chat(this);
+    audio = new Audio(this);
+    embeddings = new Embeddings(this);
+    files = new Files(this);
+    batches = new Batches(this);
+    models = new Models(this);
+    fetchImpl;
+    defaultHeaders;
+    sleep;
+    constructor(options = {}) {
+        const apiKey = options.apiKey ?? readEnv('GLEXIR_API_KEY');
+        if (!apiKey) {
+            throw new GlexirError('Missing API key. Pass `new Glexir({ apiKey })` or set the GLEXIR_API_KEY environment variable.');
+        }
+        this.apiKey = apiKey;
+        this.baseURL = (options.baseURL ?? readEnv('GLEXIR_BASE_URL') ?? DEFAULT_BASE_URL).replace(/\/+$/, '');
+        this.timeout = options.timeout ?? DEFAULT_TIMEOUT_MS;
+        this.maxRetries = options.maxRetries ?? DEFAULT_MAX_RETRIES;
+        this.fetchImpl = options.fetch ?? globalThis.fetch.bind(globalThis);
+        this.defaultHeaders = options.defaultHeaders ?? {};
+        this.sleep = options.sleep ?? sleep;
+    }
+    get(path, options) {
+        return this.request({ ...options, method: 'get', path });
+    }
+    post(path, options) {
+        return this.request({ ...options, method: 'post', path });
+    }
+    delete(path, options) {
+        return this.request({ ...options, method: 'delete', path });
+    }
+    request(options, parse = defaultParseResponse) {
+        return new APIPromise(this.makeRequest(options), parse);
+    }
+    /** @internal */
+    requestAPIList(options, cursor) {
+        return new PagePromise(this, this.makeRequest(options), (props) => defaultParseResponse(props), cursor);
+    }
+    buildURL(path, query) {
+        const url = new URL(this.baseURL + (path.startsWith('/') ? path : `/${path}`));
+        if (query) {
+            const params = new URLSearchParams();
+            for (const [key, value] of Object.entries(query))
+                appendQuery(params, key, value);
+            const search = params.toString();
+            if (search)
+                url.search = search;
+        }
+        return url.toString();
+    }
+    buildHeaders(options, retryCount, idempotencyKey, isJSON) {
+        const headers = new Headers();
+        headers.set('accept', options.stream ? 'text/event-stream' : 'application/json');
+        headers.set('authorization', `Bearer ${this.apiKey}`);
+        headers.set('x-glexir-sdk', `js/${VERSION}`);
+        headers.set('x-glexir-retry-count', String(retryCount));
+        if (isJSON)
+            headers.set('content-type', 'application/json');
+        if (idempotencyKey)
+            headers.set('idempotency-key', idempotencyKey);
+        for (const [key, value] of Object.entries(this.defaultHeaders))
+            headers.set(key, value);
+        for (const [key, value] of Object.entries(options.headers ?? {})) {
+            if (value === null)
+                headers.delete(key);
+            else if (value !== undefined)
+                headers.set(key, value);
+        }
+        return headers;
+    }
+    async sleepOrAbort(ms, signal) {
+        try {
+            await this.sleep(ms, signal);
+        }
+        catch {
+            throw new APIUserAbortError();
+        }
+    }
+    async makeRequest(options) {
+        const maxRetries = options.maxRetries ?? this.maxRetries;
+        const idempotencyKey = options.method === 'get' ? undefined : (options.idempotencyKey ?? uuid4());
+        const url = this.buildURL(options.path, options.query);
+        let body;
+        let isJSON = false;
+        if (options.multipart) {
+            body = await buildMultipartForm((options.body ?? {}));
+        }
+        else if (options.body !== undefined) {
+            body = JSON.stringify(options.body);
+            isJSON = true;
+        }
+        // Bodies we cannot replay are never retried.
+        const canRetryBody = !(typeof ReadableStream !== 'undefined' && body instanceof ReadableStream);
+        const userSignal = options.signal ?? undefined;
+        for (let attempt = 0;; attempt++) {
+            const retriesRemaining = maxRetries - attempt;
+            if (userSignal?.aborted)
+                throw new APIUserAbortError();
+            const controller = new AbortController();
+            const onUserAbort = () => controller.abort(userSignal?.reason);
+            userSignal?.addEventListener('abort', onUserAbort, { once: true });
+            let timedOut = false;
+            const timer = setTimeout(() => {
+                timedOut = true;
+                controller.abort();
+            }, options.timeout ?? this.timeout);
+            const cleanup = () => {
+                clearTimeout(timer);
+                userSignal?.removeEventListener('abort', onUserAbort);
+            };
+            let response;
+            try {
+                response = await this.fetchImpl(url, {
+                    method: options.method.toUpperCase(),
+                    headers: this.buildHeaders(options, attempt, idempotencyKey, isJSON),
+                    body,
+                    signal: controller.signal,
+                });
+                if (response.ok && !options.stream && !options.binary) {
+                    response = await bufferResponse(response);
+                }
+            }
+            catch (err) {
+                cleanup();
+                if (userSignal?.aborted)
+                    throw new APIUserAbortError();
+                if (retriesRemaining > 0 && canRetryBody) {
+                    await this.sleepOrAbort(defaultBackoffMs(attempt), userSignal);
+                    continue;
+                }
+                if (timedOut)
+                    throw new APIConnectionTimeoutError();
+                throw new APIConnectionError({ cause: err });
+            }
+            if (!response.ok) {
+                if (retriesRemaining > 0 && canRetryBody && shouldRetryResponse(response)) {
+                    await response.body?.cancel().catch(() => { });
+                    cleanup();
+                    await this.sleepOrAbort(retryDelayMs(response.headers, attempt), userSignal);
+                    continue;
+                }
+                const text = await response.text().catch(() => '');
+                cleanup();
+                let json;
+                try {
+                    json = text ? JSON.parse(text) : undefined;
+                }
+                catch {
+                    json = undefined;
+                }
+                throw APIError.generate(response.status, json, json === undefined ? text || undefined : undefined, response.headers);
+            }
+            // Streams have no overall timeout once headers arrive; the user's signal still cancels them.
+            if (options.stream || options.binary)
+                clearTimeout(timer);
+            else
+                cleanup();
+            return { response, controller, options, retryCount: attempt };
+        }
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAyB,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,QAAQ,EACR,iBAAiB,EACjB,WAAW,GACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,WAAW,EAA0C,MAAM,sBAAsB,CAAC;AAE3F,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,mBAAmB,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACpG,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,CAAC,MAAM,gBAAgB,GAAG,2BAA2B,CAAC;AAC5D,MAAM,kBAAkB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAC1C,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAmB9B,SAAS,OAAO,CAAC,IAAY;IAC3B,MAAM,GAAG,GAAI,UAAyE,CAAC,OAAO,EAAE,GAAG,CAAC;IACpG,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,SAAS,CAAC;AAC1C,CAAC;AAED,SAAS,WAAW,CAAC,MAAuB,EAAE,GAAW,EAAE,KAAc;IACvE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO;IAClD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,KAAK;YAAE,WAAW,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,WAAW,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;IACjG,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACpC,CAAC;AACH,CAAC;AAED,qFAAqF;AACrF,SAAS,YAAY,CAAI,KAAQ,EAAE,QAAkB;IACnD,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChE,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,aAAa,EAAE;YAC1C,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;YAC3C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,IAAI;SACf,CAAC,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAI,KAAuB;IAC5D,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;IAChD,IAAI,OAAO,CAAC,MAAM;QAAE,OAAO,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,UAAU,CAAM,CAAC;IAC7E,IAAI,OAAO,CAAC,MAAM;QAAE,OAAO,QAAa,CAAC;IACzC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,SAAc,CAAC;IAEnD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;IAC/D,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9E,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,IAAI;YAAE,OAAO,SAAc,CAAC;QACjC,OAAO,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAM,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;AACtC,CAAC;AAED,uFAAuF;AACvF,KAAK,UAAU,cAAc,CAAC,QAAkB;IAC9C,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;IAC/F,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC5D,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;AACrH,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,MAAM;IACR,MAAM,CAAS;IACf,OAAO,CAAS;IAChB,OAAO,CAAS;IAChB,UAAU,CAAS;IAEnB,SAAS,GAAc,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3C,aAAa,GAAkB,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;IACvD,IAAI,GAAS,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,KAAK,GAAU,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,UAAU,GAAe,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9C,KAAK,GAAU,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,GAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,GAAW,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAE1B,SAAS,CAAe;IACxB,cAAc,CAAyB;IACvC,KAAK,CAA6D;IAEnF,YAAY,UAAyB,EAAE;QACrC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,WAAW,CAAC,gGAAgG,CAAC,CAAC;QAC1H,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,iBAAiB,CAAC,IAAI,gBAAgB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACvG,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,mBAAmB,CAAC;QAC5D,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,EAAE,CAAC;QACnD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;IACtC,CAAC;IAED,GAAG,CAAI,IAAY,EAAE,OAAsC;QACzD,OAAO,IAAI,CAAC,OAAO,CAAI,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAI,IAAY,EAAE,OAAsC;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAI,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,CAAI,IAAY,EAAE,OAAsC;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAI,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,CAAI,OAA4B,EAAE,QAAiD,oBAAoB;QAC5G,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED,gBAAgB;IAChB,cAAc,CAAO,OAA4B,EAAE,MAAsB;QACvE,OAAO,IAAI,WAAW,CAAO,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,oBAAoB,CAAqB,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IACpI,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,KAA+B;QACpD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/E,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;gBAAE,WAAW,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YAClF,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YACjC,IAAI,MAAM;gBAAE,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;QAClC,CAAC;QACD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAEO,YAAY,CAAC,OAA4B,EAAE,UAAkB,EAAE,cAAkC,EAAE,MAAe;QACxH,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;QAC9B,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC;QACjF,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACtD,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,OAAO,EAAE,CAAC,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACxD,IAAI,MAAM;YAAE,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC5D,IAAI,cAAc;YAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QACnE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACxF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;YACjE,IAAI,KAAK,KAAK,IAAI;gBAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;iBACnC,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,EAAU,EAAE,MAAsC;QAC3E,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,iBAAiB,EAAE,CAAC;QAChC,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,OAA4B;QACpD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC;QACzD,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,IAAI,KAAK,EAAE,CAAC,CAAC;QAClG,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAEvD,IAAI,IAA0B,CAAC;QAC/B,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACtB,IAAI,GAAG,MAAM,kBAAkB,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAA4B,CAAC,CAAC;QACnF,CAAC;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACpC,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;QACD,6CAA6C;QAC7C,MAAM,YAAY,GAAG,CAAC,CAAC,OAAO,cAAc,KAAK,WAAW,IAAI,IAAI,YAAY,cAAc,CAAC,CAAC;QAChG,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,IAAI,SAAS,CAAC;QAE/C,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;YAClC,MAAM,gBAAgB,GAAG,UAAU,GAAG,OAAO,CAAC;YAC9C,IAAI,UAAU,EAAE,OAAO;gBAAE,MAAM,IAAI,iBAAiB,EAAE,CAAC;YAEvD,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;YACzC,MAAM,WAAW,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC/D,UAAU,EAAE,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACnE,IAAI,QAAQ,GAAG,KAAK,CAAC;YACrB,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,QAAQ,GAAG,IAAI,CAAC;gBAChB,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;YACpC,MAAM,OAAO,GAAG,GAAG,EAAE;gBACnB,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpB,UAAU,EAAE,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YACxD,CAAC,CAAC;YAEF,IAAI,QAAkB,CAAC;YACvB,IAAI,CAAC;gBACH,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;oBACnC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE;oBACpC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,CAAC;oBACpE,IAAI;oBACJ,MAAM,EAAE,UAAU,CAAC,MAAM;iBAC1B,CAAC,CAAC;gBACH,IAAI,QAAQ,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;oBACtD,QAAQ,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;gBAC5C,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,EAAE,CAAC;gBACV,IAAI,UAAU,EAAE,OAAO;oBAAE,MAAM,IAAI,iBAAiB,EAAE,CAAC;gBACvD,IAAI,gBAAgB,GAAG,CAAC,IAAI,YAAY,EAAE,CAAC;oBACzC,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC;oBAC/D,SAAS;gBACX,CAAC;gBACD,IAAI,QAAQ;oBAAE,MAAM,IAAI,yBAAyB,EAAE,CAAC;gBACpD,MAAM,IAAI,kBAAkB,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YAC/C,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,IAAI,gBAAgB,GAAG,CAAC,IAAI,YAAY,IAAI,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC1E,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;oBAC9C,OAAO,EAAE,CAAC;oBACV,MAAM,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC;oBAC7E,SAAS;gBACX,CAAC;gBACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;gBACnD,OAAO,EAAE,CAAC;gBACV,IAAI,IAAa,CAAC;gBAClB,IAAI,CAAC;oBACH,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC7C,CAAC;gBAAC,MAAM,CAAC;oBACP,IAAI,GAAG,SAAS,CAAC;gBACnB,CAAC;gBACD,MAAM,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;YACvH,CAAC;YAED,6FAA6F;YAC7F,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM;gBAAE,YAAY,CAAC,KAAK,CAAC,CAAC;;gBACrD,OAAO,EAAE,CAAC;YACf,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;QAChE,CAAC;IACH,CAAC;CACF"}

package/dist/core/api-promise.d.ts

@@ -0,0 +1,31 @@
+import type { FinalRequestOptions } from './request-options.js';
+export interface APIResponseProps {
+    response: Response;
+    controller: AbortController;
+    options: FinalRequestOptions;
+    retryCount: number;
+}
+export interface WithRawResponse<T> {
+    data: T;
+    response: Response;
+    /** The `x-request-id` header; quote it in support requests. */
+    requestId: string | null;
+}
+/**
+ * The value returned by every API method. Await it for the parsed body, or call
+ * `.withRawResponse()` to also get the HTTP response and request ID.
+ */
+export declare class APIPromise<T> implements PromiseLike<T> {
+    protected readonly responsePromise: Promise<APIResponseProps>;
+    protected readonly parseResponse: (props: APIResponseProps) => Promise<T>;
+    private parsed;
+    constructor(responsePromise: Promise<APIResponseProps>, parseResponse: (props: APIResponseProps) => Promise<T>);
+    /** Returns a new promise that transforms the parsed body. */
+    _thenUnwrap<U>(transform: (data: T, props: APIResponseProps) => U): APIPromise<U>;
+    withRawResponse(): Promise<WithRawResponse<T>>;
+    /** The raw HTTP response, without parsing the body. */
+    asResponse(): Promise<Response>;
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
+    finally(onfinally?: (() => void) | null): Promise<T>;
+}