@inboxychat/sdk 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,23 @@
-# Temporary Holding Version
+# @inboxychat/sdk — read-only client for the Inboxy public API v1
 
-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.
+Used by `@inboxychat/mcp` and `@inboxychat/cli`. Local package, not published.
+
+- `InboxyClient`: one GET method per route in `PUBLIC_ROUTES` (the same list as
+  `PUBLIC_API_V1_ROUTES` in `apps/api/src/modules/api-public/api-public.contract.ts`).
+  No write methods, no company parameter, HTTPS only (http for localhost),
+  redirects refused, per-request timeout and `AbortSignal`.
+- `InboxyError`: `kind` (`auth`, `forbidden`, `not_found`, `rate_limited`,
+  `invalid_request`, `server`, `timeout`, `cancelled`, `network`,
+  `invalid_response`, `config`), `status`, `code`, `details`,
+  `retryAfterSeconds`; the message is redacted when the error is created.
+- `resolveCredentials`: `INBOXY_API_KEY` → OS keychain → `0600` config file.
+- `collectPages`: follows `meta.nextCursor` up to a page cap.
+
+Types in `src/types.ts` are written by hand to match the zod contract.
+`test/contract-drift.test.ts` imports the server's zod schemas and checks the
+route list, the query enums, the query field names and the test fixtures
+against them, so a change on either side fails a test.
+
+```bash
+pnpm --filter @inboxychat/sdk test
+```

package/dist/capabilities.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The public capabilities the MCP server and the CLI offer, as this SDK knows
+ * them. The API's capability registry is the authority
+ * (apps/api/src/lib/capabilities/public-capabilities.ts); this is its mirror
+ * for processes that run outside the API, and `test/capabilities-parity.test.ts`
+ * fails when the two differ (id, path, scope, MCP tool, CLI command).
+ *
+ * The MCP server derives each tool's required scope from here, and the CLI
+ * derives the scopes `doctor` checks: neither keeps its own copy.
+ */
+import { type PublicRoutePath } from './routes.js';
+export interface PublicCapability {
+    id: string;
+    kind: 'read';
+    path: PublicRoutePath;
+    /** Scope the key / OAuth grant must carry; null = any valid credential. */
+    scope: string | null;
+    mcpTool?: string;
+    cliCommand?: string;
+}
+export declare const PUBLIC_CAPABILITIES: readonly PublicCapability[];
+export declare function capabilityForMcpTool(tool: string): PublicCapability | undefined;
+export declare function capabilityForCliCommand(command: string): PublicCapability | undefined;
+//# sourceMappingURL=capabilities.d.ts.map

package/dist/capabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../src/capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAY,KAAK,eAAe,EAAE,MAAM,aAAa,CAAC;AAE7D,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,eAAe,CAAC;IACtB,2EAA2E;IAC3E,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAUD,eAAO,MAAM,mBAAmB,EAAE,SAAS,gBAAgB,EAiB1D,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAE/E;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAErF"}

package/dist/capabilities.js

@@ -0,0 +1,39 @@
+/**
+ * The public capabilities the MCP server and the CLI offer, as this SDK knows
+ * them. The API's capability registry is the authority
+ * (apps/api/src/lib/capabilities/public-capabilities.ts); this is its mirror
+ * for processes that run outside the API, and `test/capabilities-parity.test.ts`
+ * fails when the two differ (id, path, scope, MCP tool, CLI command).
+ *
+ * The MCP server derives each tool's required scope from here, and the CLI
+ * derives the scopes `doctor` checks: neither keeps its own copy.
+ */
+import { scopeFor } from './routes.js';
+function cap(id, path, adapters) {
+    return { id, kind: 'read', path, scope: scopeFor(path), ...adapters };
+}
+export const PUBLIC_CAPABILITIES = [
+    cap('public.company.get', '/company', { mcpTool: 'company_get', cliCommand: 'whoami' }),
+    cap('public.usage.get', '/usage', { mcpTool: 'usage_get', cliCommand: 'usage' }),
+    // No stores route exists: `stores list` is the connected-store COUNT from usage.
+    cap('public.stores.count', '/usage', { cliCommand: 'stores list' }),
+    cap('public.orders.list', '/orders', { mcpTool: 'orders_list', cliCommand: 'orders list' }),
+    cap('public.orders.get', '/orders/:id', { mcpTool: 'order_get', cliCommand: 'orders get' }),
+    cap('public.contacts.search', '/contacts', {
+        mcpTool: 'contacts_search',
+        cliCommand: 'contacts search',
+    }),
+    cap('public.contacts.get', '/contacts/:id', { mcpTool: 'contact_get' }),
+    cap('public.conversations.list', '/conversations', { mcpTool: 'conversations_list' }),
+    cap('public.conversations.get', '/conversations/:id', { mcpTool: 'conversation_get' }),
+    cap('public.messages.list', '/conversations/:id/messages', { mcpTool: 'conversation_messages' }),
+    cap('public.products.search', '/products', { mcpTool: 'products_search' }),
+    cap('public.products.get', '/products/:id', { mcpTool: 'product_get' }),
+];
+export function capabilityForMcpTool(tool) {
+    return PUBLIC_CAPABILITIES.find((c) => c.mcpTool === tool);
+}
+export function capabilityForCliCommand(command) {
+    return PUBLIC_CAPABILITIES.find((c) => c.cliCommand === command);
+}
+//# sourceMappingURL=capabilities.js.map

package/dist/capabilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilities.js","sourceRoot":"","sources":["../src/capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,QAAQ,EAAwB,MAAM,aAAa,CAAC;AAY7D,SAAS,GAAG,CACV,EAAU,EACV,IAAqB,EACrB,QAAmD;IAEnD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,QAAQ,EAAE,CAAC;AACxE,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAgC;IAC9D,GAAG,CAAC,oBAAoB,EAAE,UAAU,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvF,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;IAChF,iFAAiF;IACjF,GAAG,CAAC,qBAAqB,EAAE,QAAQ,EAAE,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;IACnE,GAAG,CAAC,oBAAoB,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;IAC3F,GAAG,CAAC,mBAAmB,EAAE,aAAa,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC;IAC3F,GAAG,CAAC,wBAAwB,EAAE,WAAW,EAAE;QACzC,OAAO,EAAE,iBAAiB;QAC1B,UAAU,EAAE,iBAAiB;KAC9B,CAAC;IACF,GAAG,CAAC,qBAAqB,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;IACvE,GAAG,CAAC,2BAA2B,EAAE,gBAAgB,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;IACrF,GAAG,CAAC,0BAA0B,EAAE,oBAAoB,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;IACtF,GAAG,CAAC,sBAAsB,EAAE,6BAA6B,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;IAChG,GAAG,CAAC,wBAAwB,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAC1E,GAAG,CAAC,qBAAqB,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;CACxE,CAAC;AAEF,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,OAAe;IACrD,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,OAAO,CAAC,CAAC;AACnE,CAAC"}

package/dist/client.d.ts

@@ -0,0 +1,75 @@
+import type { CompanyContext, Contact, ContactsQuery, Conversation, ConversationsQuery, CursorMeta, CursorQuery, ItemEnvelope, ListEnvelope, Message, MessagesQuery, Order, OrdersQuery, Product, ProductsQuery, Usage } from './types.js';
+export declare const DEFAULT_API_URL = "https://api.inboxy.chat";
+export declare const DEFAULT_TIMEOUT_MS = 20000;
+export declare const SDK_VERSION = "0.1.0";
+export interface InboxyClientOptions {
+    apiKey: string;
+    /** Origin of the Inboxy API, e.g. https://api.inboxy.chat. */
+    baseUrl?: string;
+    /** Per-request timeout. Default 20 s. */
+    timeoutMs?: number;
+    /** Injected for tests; defaults to the global fetch. */
+    fetch?: typeof fetch;
+    userAgent?: string;
+}
+export interface RequestOptions {
+    /** Aborts the request (MCP cancellation, Ctrl-C). */
+    signal?: AbortSignal;
+}
+export interface ResponseInfo {
+    status: number;
+    /** The server's Date header, used by `inboxy doctor` for clock skew. */
+    date: string | null;
+    retryAfterSeconds: number | null;
+    rateLimit: {
+        limit: number | null;
+        remaining: number | null;
+        reset: number | null;
+    };
+    latencyMs: number;
+}
+/**
+ * Validates and normalizes the API origin. Throws a `config` error; nothing is
+ * sent with a URL that fails here.
+ */
+export declare function normalizeBaseUrl(raw: string): string;
+export declare class InboxyClient {
+    #private;
+    readonly baseUrl: string;
+    readonly timeoutMs: number;
+    constructor(options: InboxyClientOptions);
+    /** Never reveal the key through inspection or JSON.stringify. */
+    toJSON(): {
+        baseUrl: string;
+        timeoutMs: number;
+    };
+    /**
+     * One GET under `/api/v1/public`, returning the parsed envelope and the
+     * response metadata. `path` must already be encoded.
+     */
+    request<T>(path: string, query?: object, options?: RequestOptions): Promise<{
+        body: T;
+        info: ResponseInfo;
+    }>;
+    getCompany(options?: RequestOptions): Promise<ItemEnvelope<CompanyContext>>;
+    getUsage(options?: RequestOptions): Promise<ItemEnvelope<Usage>>;
+    listContacts(query?: ContactsQuery, options?: RequestOptions): Promise<ListEnvelope<Contact>>;
+    getContact(id: string, options?: RequestOptions): Promise<ItemEnvelope<Contact>>;
+    listConversations(query?: ConversationsQuery, options?: RequestOptions): Promise<ListEnvelope<Conversation>>;
+    getConversation(id: string, options?: RequestOptions): Promise<ItemEnvelope<Conversation>>;
+    listMessages(conversationId: string, query?: MessagesQuery, options?: RequestOptions): Promise<ListEnvelope<Message>>;
+    listOrders(query?: OrdersQuery, options?: RequestOptions): Promise<ListEnvelope<Order>>;
+    getOrder(id: string, options?: RequestOptions): Promise<ItemEnvelope<Order>>;
+    listProducts(query?: ProductsQuery, options?: RequestOptions): Promise<ListEnvelope<Product>>;
+    getProduct(id: string, options?: RequestOptions): Promise<ItemEnvelope<Product>>;
+}
+/**
+ * Walks a cursor-paginated list. Stops at the last page or after `maxPages`
+ * (default 10), whichever comes first, and reports whether more remained.
+ */
+export declare function collectPages<T, Q extends CursorQuery>(fetchPage: (query: Q) => Promise<ListEnvelope<T>>, query: Q, maxPages?: number): Promise<{
+    items: T[];
+    pages: number;
+    meta: CursorMeta;
+}>;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,cAAc,EACd,OAAO,EACP,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,aAAa,EACb,KAAK,EACL,WAAW,EACX,OAAO,EACP,aAAa,EACb,KAAK,EACN,MAAM,YAAY,CAAC;AAEpB,eAAO,MAAM,eAAe,4BAA4B,CAAC;AACzD,eAAO,MAAM,kBAAkB,QAAS,CAAC;AACzC,eAAO,MAAM,WAAW,UAAU,CAAC;AAEnC,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wDAAwD;IACxD,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,qDAAqD;IACrD,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,wEAAwE;IACxE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IACpF,SAAS,EAAE,MAAM,CAAC;CACnB;AASD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAwCpD;AAiCD,qBAAa,YAAY;;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;gBAKf,OAAO,EAAE,mBAAmB;IAwBxC,iEAAiE;IACjE,MAAM;;;;IAIN;;;OAGG;IACG,OAAO,CAAC,CAAC,EACb,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,IAAI,EAAE,YAAY,CAAA;KAAE,CAAC;IAiHrC,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc;IAInC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc;IAIjC,YAAY,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc;IAI5D,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAQ/C,iBAAiB,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc;IAItE,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAQpD,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc;IAQpF,UAAU,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc;IAIxD,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAQ7C,YAAY,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc;IAI5D,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;CAOtD;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,EACzD,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EACjD,KAAK,EAAE,CAAC,EACR,QAAQ,SAAK,GACZ,OAAO,CAAC;IAAE,KAAK,EAAE,CAAC,EAAE,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAc1D"}

package/dist/client.js

@@ -0,0 +1,291 @@
+/**
+ * InboxyClient — a small, read-only client for `/api/v1/public`.
+ *
+ * Safety properties (tested in test/client.test.ts):
+ *  - GET only. There is no method that writes, so nothing built on this client
+ *    (the MCP server, the CLI) can change merchant data.
+ *  - The company is decided by the key. No method takes a company id; ids are
+ *    validated and percent-encoded into one path segment, so `../usage` or
+ *    `a/b` cannot reach another route.
+ *  - The key is sent only in the Authorization header, only over HTTPS (plain
+ *    HTTP is accepted for localhost alone), and redirects are refused so the
+ *    header never follows a redirect to another host.
+ *  - Every error is an `InboxyError` with a redacted message.
+ */
+import { InboxyError, kindForStatus } from './errors.js';
+import { PUBLIC_API_PREFIX } from './routes.js';
+export const DEFAULT_API_URL = 'https://api.inboxy.chat';
+export const DEFAULT_TIMEOUT_MS = 20_000;
+export const SDK_VERSION = '0.1.0';
+const LOCAL_HOSTS = new Set(['localhost', '127.0.0.1', '[::1]', '::1']);
+const ID_PATTERN = /^[A-Za-z0-9_-]{1,64}$/;
+function isLocalHost(hostname) {
+    return LOCAL_HOSTS.has(hostname) || hostname.endsWith('.localhost');
+}
+/**
+ * Validates and normalizes the API origin. Throws a `config` error; nothing is
+ * sent with a URL that fails here.
+ */
+export function normalizeBaseUrl(raw) {
+    let url;
+    try {
+        url = new URL(raw);
+    }
+    catch {
+        throw new InboxyError({
+            kind: 'config',
+            code: 'INVALID_API_URL',
+            message: `INBOXY_API_URL is not a valid URL.`,
+        });
+    }
+    if (url.username || url.password) {
+        throw new InboxyError({
+            kind: 'config',
+            code: 'INVALID_API_URL',
+            message: 'INBOXY_API_URL must not contain credentials.',
+        });
+    }
+    if (url.search || url.hash) {
+        throw new InboxyError({
+            kind: 'config',
+            code: 'INVALID_API_URL',
+            message: 'INBOXY_API_URL must not contain a query string or fragment.',
+        });
+    }
+    if (url.protocol === 'http:' && !isLocalHost(url.hostname)) {
+        throw new InboxyError({
+            kind: 'config',
+            code: 'INSECURE_API_URL',
+            message: 'INBOXY_API_URL must use https:// (plain http is allowed for localhost only).',
+        });
+    }
+    if (url.protocol !== 'https:' && url.protocol !== 'http:') {
+        throw new InboxyError({
+            kind: 'config',
+            code: 'INVALID_API_URL',
+            message: 'INBOXY_API_URL must be an http(s) URL.',
+        });
+    }
+    return `${url.origin}${url.pathname.replace(/\/+$/, '')}`;
+}
+function idSegment(id, label) {
+    if (typeof id !== 'string' || !ID_PATTERN.test(id)) {
+        throw new InboxyError({
+            kind: 'invalid_request',
+            code: 'INVALID_ID',
+            message: `${label} must be 1-64 characters of letters, digits, "_" or "-".`,
+        });
+    }
+    return encodeURIComponent(id);
+}
+function toSearchParams(query) {
+    if (!query)
+        return '';
+    const params = new URLSearchParams();
+    for (const [key, value] of Object.entries(query)) {
+        if (value === undefined || value === null || value === '')
+            continue;
+        params.set(key, String(value));
+    }
+    const s = params.toString();
+    return s ? `?${s}` : '';
+}
+function intHeader(headers, name) {
+    const raw = headers.get(name);
+    if (raw === null)
+        return null;
+    const n = Number(raw);
+    return Number.isFinite(n) ? n : null;
+}
+export class InboxyClient {
+    baseUrl;
+    timeoutMs;
+    #apiKey;
+    #fetch;
+    #userAgent;
+    constructor(options) {
+        if (!options.apiKey || typeof options.apiKey !== 'string') {
+            throw new InboxyError({
+                kind: 'config',
+                code: 'API_KEY_MISSING',
+                message: 'No Inboxy API key. Set INBOXY_API_KEY or run `inboxy auth login` to store one in the OS keychain.',
+            });
+        }
+        if (/\s/.test(options.apiKey)) {
+            throw new InboxyError({
+                kind: 'config',
+                code: 'API_KEY_INVALID_FORMAT',
+                message: 'The Inboxy API key contains whitespace; copy it again from the dashboard.',
+            });
+        }
+        this.#apiKey = options.apiKey;
+        this.baseUrl = normalizeBaseUrl(options.baseUrl ?? DEFAULT_API_URL);
+        const timeout = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+        this.timeoutMs = Math.min(Math.max(Math.trunc(timeout) || DEFAULT_TIMEOUT_MS, 100), 120_000);
+        this.#fetch = options.fetch ?? globalThis.fetch.bind(globalThis);
+        this.#userAgent = options.userAgent ?? `inboxy-sdk/${SDK_VERSION}`;
+    }
+    /** Never reveal the key through inspection or JSON.stringify. */
+    toJSON() {
+        return { baseUrl: this.baseUrl, timeoutMs: this.timeoutMs };
+    }
+    /**
+     * One GET under `/api/v1/public`, returning the parsed envelope and the
+     * response metadata. `path` must already be encoded.
+     */
+    async request(path, query, options = {}) {
+        const url = `${this.baseUrl}${PUBLIC_API_PREFIX}${path}${toSearchParams(query)}`;
+        const timeoutSignal = AbortSignal.timeout(this.timeoutMs);
+        const signal = options.signal
+            ? AbortSignal.any([options.signal, timeoutSignal])
+            : timeoutSignal;
+        if (options.signal?.aborted) {
+            throw new InboxyError({
+                kind: 'cancelled',
+                code: 'CANCELLED',
+                message: 'Request cancelled.',
+            });
+        }
+        const started = Date.now();
+        let response;
+        let text;
+        try {
+            response = await this.#fetch(url, {
+                method: 'GET',
+                headers: {
+                    Authorization: `Bearer ${this.#apiKey}`,
+                    Accept: 'application/json',
+                    'User-Agent': this.#userAgent,
+                },
+                redirect: 'error',
+                signal,
+            });
+            text = await response.text();
+        }
+        catch (cause) {
+            if (options.signal?.aborted) {
+                throw new InboxyError({
+                    kind: 'cancelled',
+                    code: 'CANCELLED',
+                    message: 'Request cancelled.',
+                });
+            }
+            if (timeoutSignal.aborted) {
+                throw new InboxyError({
+                    kind: 'timeout',
+                    code: 'TIMEOUT',
+                    message: `no response within ${this.timeoutMs} ms`,
+                });
+            }
+            const reason = cause instanceof Error
+                ? [cause.message, cause.cause?.code]
+                    .filter(Boolean)
+                    .join(': ')
+                : 'request failed';
+            throw new InboxyError({ kind: 'network', code: 'NETWORK_ERROR', message: reason });
+        }
+        const info = {
+            status: response.status,
+            date: response.headers.get('date'),
+            retryAfterSeconds: intHeader(response.headers, 'retry-after'),
+            rateLimit: {
+                limit: intHeader(response.headers, 'x-ratelimit-limit'),
+                remaining: intHeader(response.headers, 'x-ratelimit-remaining'),
+                reset: intHeader(response.headers, 'x-ratelimit-reset'),
+            },
+            latencyMs: Date.now() - started,
+        };
+        let body;
+        try {
+            body = text ? JSON.parse(text) : undefined;
+        }
+        catch {
+            body = undefined;
+        }
+        if (!response.ok) {
+            const envelope = body;
+            const err = envelope && envelope.success === false ? envelope.error : undefined;
+            throw new InboxyError({
+                kind: kindForStatus(response.status),
+                status: response.status,
+                code: typeof err?.code === 'string' ? err.code : `HTTP_${response.status}`,
+                message: typeof err?.message === 'string'
+                    ? err.message
+                    : `Inboxy answered HTTP ${response.status}`,
+                details: err?.details && typeof err.details === 'object'
+                    ? err.details
+                    : {},
+                retryAfterSeconds: info.retryAfterSeconds,
+            });
+        }
+        if (!body || typeof body !== 'object' || body.success !== true) {
+            throw new InboxyError({
+                kind: 'invalid_response',
+                status: response.status,
+                code: 'INVALID_RESPONSE',
+                message: 'Inboxy answered with something that is not the public API envelope.',
+            });
+        }
+        return { body: body, info };
+    }
+    async #get(path, query, options) {
+        return (await this.request(path, query, options)).body;
+    }
+    // ------------------------------------------------------------------
+    // Resources — one method per route in PUBLIC_ROUTES
+    // ------------------------------------------------------------------
+    async getCompany(options) {
+        return this.#get('/company', undefined, options);
+    }
+    async getUsage(options) {
+        return this.#get('/usage', undefined, options);
+    }
+    async listContacts(query, options) {
+        return this.#get('/contacts', query, options);
+    }
+    async getContact(id, options) {
+        return this.#get(`/contacts/${idSegment(id, 'Contact id')}`, undefined, options);
+    }
+    async listConversations(query, options) {
+        return this.#get('/conversations', query, options);
+    }
+    async getConversation(id, options) {
+        return this.#get(`/conversations/${idSegment(id, 'Conversation id')}`, undefined, options);
+    }
+    async listMessages(conversationId, query, options) {
+        return this.#get(`/conversations/${idSegment(conversationId, 'Conversation id')}/messages`, query, options);
+    }
+    async listOrders(query, options) {
+        return this.#get('/orders', query, options);
+    }
+    async getOrder(id, options) {
+        return this.#get(`/orders/${idSegment(id, 'Order id')}`, undefined, options);
+    }
+    async listProducts(query, options) {
+        return this.#get('/products', query, options);
+    }
+    async getProduct(id, options) {
+        return this.#get(`/products/${idSegment(id, 'Product id')}`, undefined, options);
+    }
+}
+/**
+ * Walks a cursor-paginated list. Stops at the last page or after `maxPages`
+ * (default 10), whichever comes first, and reports whether more remained.
+ */
+export async function collectPages(fetchPage, query, maxPages = 10) {
+    const items = [];
+    let cursor = query.cursor;
+    let pages = 0;
+    let meta = { limit: 0, hasMore: false, nextCursor: null };
+    while (pages < Math.max(1, maxPages)) {
+        const page = await fetchPage({ ...query, cursor });
+        pages += 1;
+        items.push(...page.data);
+        meta = page.meta;
+        if (!page.meta.hasMore || !page.meta.nextCursor)
+            break;
+        cursor = page.meta.nextCursor;
+    }
+    return { items, pages, meta };
+}
+//# 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;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAoBhD,MAAM,CAAC,MAAM,eAAe,GAAG,yBAAyB,CAAC;AACzD,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACzC,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC;AA2BnC,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;AACxE,MAAM,UAAU,GAAG,uBAAuB,CAAC;AAE3C,SAAS,WAAW,CAAC,QAAgB;IACnC,OAAO,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;AACtE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,IAAI,GAAQ,CAAC;IACb,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,WAAW,CAAC;YACpB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE,oCAAoC;SAC9C,CAAC,CAAC;IACL,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACjC,MAAM,IAAI,WAAW,CAAC;YACpB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE,8CAA8C;SACxD,CAAC,CAAC;IACL,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QAC3B,MAAM,IAAI,WAAW,CAAC;YACpB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE,6DAA6D;SACvE,CAAC,CAAC;IACL,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3D,MAAM,IAAI,WAAW,CAAC;YACpB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,8EAA8E;SACxF,CAAC,CAAC;IACL,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QAC1D,MAAM,IAAI,WAAW,CAAC;YACpB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE,wCAAwC;SAClD,CAAC,CAAC;IACL,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;AAC5D,CAAC;AAED,SAAS,SAAS,CAAC,EAAU,EAAE,KAAa;IAC1C,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QACnD,MAAM,IAAI,WAAW,CAAC;YACpB,IAAI,EAAE,iBAAiB;YACvB,IAAI,EAAE,YAAY;YAClB,OAAO,EAAE,GAAG,KAAK,0DAA0D;SAC5E,CAAC,CAAC;IACL,CAAC;IACD,OAAO,kBAAkB,CAAC,EAAE,CAAC,CAAC;AAChC,CAAC;AAID,SAAS,cAAc,CAAC,KAAyB;IAC/C,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAmC,CAAC,EAAE,CAAC;QAC/E,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE;YAAE,SAAS;QACpE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC5B,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1B,CAAC;AAED,SAAS,SAAS,CAAC,OAAgB,EAAE,IAAY;IAC/C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC9B,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC9B,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACvC,CAAC;AAED,MAAM,OAAO,YAAY;IACd,OAAO,CAAS;IAChB,SAAS,CAAS;IAClB,OAAO,CAAS;IAChB,MAAM,CAAe;IACrB,UAAU,CAAS;IAE5B,YAAY,OAA4B;QACtC,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC1D,MAAM,IAAI,WAAW,CAAC;gBACpB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EACL,mGAAmG;aACtG,CAAC,CAAC;QACL,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,WAAW,CAAC;gBACpB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,wBAAwB;gBAC9B,OAAO,EAAE,2EAA2E;aACrF,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC,OAAO,IAAI,eAAe,CAAC,CAAC;QACpE,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,IAAI,kBAAkB,CAAC;QACxD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,kBAAkB,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;QAC7F,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,IAAI,cAAc,WAAW,EAAE,CAAC;IACrE,CAAC;IAED,iEAAiE;IACjE,MAAM;QACJ,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CACX,IAAY,EACZ,KAAc,EACd,UAA0B,EAAE;QAE5B,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,GAAG,iBAAiB,GAAG,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;YAC3B,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;YAClD,CAAC,CAAC,aAAa,CAAC;QAElB,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,WAAW,CAAC;gBACpB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,oBAAoB;aAC9B,CAAC,CAAC;QACL,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,IAAI,QAAkB,CAAC;QACvB,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;gBAChC,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,IAAI,CAAC,OAAO,EAAE;oBACvC,MAAM,EAAE,kBAAkB;oBAC1B,YAAY,EAAE,IAAI,CAAC,UAAU;iBAC9B;gBACD,QAAQ,EAAE,OAAO;gBACjB,MAAM;aACP,CAAC,CAAC;YACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;gBAC5B,MAAM,IAAI,WAAW,CAAC;oBACpB,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,oBAAoB;iBAC9B,CAAC,CAAC;YACL,CAAC;YACD,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;gBAC1B,MAAM,IAAI,WAAW,CAAC;oBACpB,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,sBAAsB,IAAI,CAAC,SAAS,KAAK;iBACnD,CAAC,CAAC;YACL,CAAC;YACD,MAAM,MAAM,GACV,KAAK,YAAY,KAAK;gBACpB,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAG,KAAuC,CAAC,KAAK,EAAE,IAAI,CAAC;qBAClE,MAAM,CAAC,OAAO,CAAC;qBACf,IAAI,CAAC,IAAI,CAAC;gBACf,CAAC,CAAC,gBAAgB,CAAC;YACvB,MAAM,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QACrF,CAAC;QAED,MAAM,IAAI,GAAiB;YACzB,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;YAClC,iBAAiB,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;YAC7D,SAAS,EAAE;gBACT,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;gBACvD,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;gBAC/D,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;aACxD;YACD,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO;SAChC,CAAC;QAEF,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7C,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,GAAG,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,QAAQ,GAAG,IAEJ,CAAC;YACd,MAAM,GAAG,GAAG,QAAQ,IAAI,QAAQ,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,MAAM,IAAI,WAAW,CAAC;gBACpB,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACpC,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EAAE,OAAO,GAAG,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,QAAQ,CAAC,MAAM,EAAE;gBAC1E,OAAO,EACL,OAAO,GAAG,EAAE,OAAO,KAAK,QAAQ;oBAC9B,CAAC,CAAC,GAAG,CAAC,OAAO;oBACb,CAAC,CAAC,wBAAwB,QAAQ,CAAC,MAAM,EAAE;gBAC/C,OAAO,EACL,GAAG,EAAE,OAAO,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ;oBAC7C,CAAC,CAAE,GAAG,CAAC,OAAmC;oBAC1C,CAAC,CAAC,EAAE;gBACR,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;aAC1C,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAK,IAA8B,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YAC1F,MAAM,IAAI,WAAW,CAAC;gBACpB,IAAI,EAAE,kBAAkB;gBACxB,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,qEAAqE;aAC/E,CAAC,CAAC;QACL,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,IAAS,EAAE,IAAI,EAAE,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,IAAI,CAAI,IAAY,EAAE,KAAc,EAAE,OAAwB;QAClE,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAI,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5D,CAAC;IAED,qEAAqE;IACrE,oDAAoD;IACpD,qEAAqE;IAErE,KAAK,CAAC,UAAU,CAAC,OAAwB;QACvC,OAAO,IAAI,CAAC,IAAI,CAA+B,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAwB;QACrC,OAAO,IAAI,CAAC,IAAI,CAAsB,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,KAAqB,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,IAAI,CAAwB,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,IAAI,CACd,aAAa,SAAS,CAAC,EAAE,EAAE,YAAY,CAAC,EAAE,EAC1C,SAAS,EACT,OAAO,CACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,KAA0B,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,IAAI,CAA6B,gBAAgB,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,EAAU,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,IAAI,CACd,kBAAkB,SAAS,CAAC,EAAE,EAAE,iBAAiB,CAAC,EAAE,EACpD,SAAS,EACT,OAAO,CACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,cAAsB,EAAE,KAAqB,EAAE,OAAwB;QACxF,OAAO,IAAI,CAAC,IAAI,CACd,kBAAkB,SAAS,CAAC,cAAc,EAAE,iBAAiB,CAAC,WAAW,EACzE,KAAK,EACL,OAAO,CACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAmB,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,IAAI,CAAsB,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,IAAI,CACd,WAAW,SAAS,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,EACtC,SAAS,EACT,OAAO,CACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,KAAqB,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,IAAI,CAAwB,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,IAAI,CACd,aAAa,SAAS,CAAC,EAAE,EAAE,YAAY,CAAC,EAAE,EAC1C,SAAS,EACT,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,SAAiD,EACjD,KAAQ,EACR,QAAQ,GAAG,EAAE;IAEb,MAAM,KAAK,GAAQ,EAAE,CAAC;IACtB,IAAI,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC1B,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,IAAI,GAAe,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IACtE,OAAO,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QACnD,KAAK,IAAI,CAAC,CAAC;QACX,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,MAAM;QACvD,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;IAChC,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAChC,CAAC"}

package/dist/credentials.d.ts

@@ -0,0 +1,76 @@
+export declare const KEYCHAIN_SERVICE = "inboxy-cli";
+export declare const CONFIG_FILE_NAME = "config.json";
+export type KeySource = 'env' | 'keychain' | 'config-file' | 'none';
+export type UrlSource = 'env' | 'config' | 'default';
+export interface ProfileConfig {
+    apiUrl?: string;
+    /** Where `inboxy auth login` stored the key. */
+    keyStorage?: 'keychain' | 'file';
+    /** Only with keyStorage "file" (no keychain on this machine). */
+    apiKey?: string;
+}
+export interface InboxyConfigFile {
+    version: 1;
+    defaultProfile?: string;
+    profiles: Record<string, ProfileConfig>;
+}
+export interface ResolvedCredentials {
+    profile: string;
+    apiKey: string | null;
+    keySource: KeySource;
+    apiUrl: string;
+    urlSource: UrlSource;
+    configPath: string;
+    /** Non-fatal observations for `inboxy doctor` (never contain the key). */
+    warnings: string[];
+}
+export declare function validateProfileName(profile: string): string;
+export declare function configDir(env?: NodeJS.ProcessEnv): string;
+export declare function configPath(env?: NodeJS.ProcessEnv): string;
+export interface LoadedConfig {
+    path: string;
+    exists: boolean;
+    /** File mode bits (e.g. 0o600); null when missing or on Windows. */
+    mode: number | null;
+    config: InboxyConfigFile;
+}
+export declare function loadConfig(env?: NodeJS.ProcessEnv): Promise<LoadedConfig>;
+/** True when group or others have any access to the file. */
+export declare function isModeTooOpen(mode: number | null): boolean;
+/**
+ * Writes the config with 0700 on the directory and 0600 on the file. The
+ * temporary file is created 0600 before any byte is written, then renamed, so
+ * there is no moment where the content is world-readable.
+ */
+export declare function saveConfig(config: InboxyConfigFile, env?: NodeJS.ProcessEnv): Promise<string>;
+export interface CommandResult {
+    code: number | null;
+    stdout: string;
+    stderr: string;
+}
+/** Runs a program with an argument array — never through a shell. */
+export type CommandRunner = (command: string, args: readonly string[], input?: string) => Promise<CommandResult>;
+export declare const spawnRunner: CommandRunner;
+export interface Keychain {
+    readonly name: string;
+    get(account: string): Promise<string | null>;
+    set(account: string, secret: string): Promise<void>;
+    delete(account: string): Promise<boolean>;
+}
+/** macOS Keychain through /usr/bin/security. */
+export declare function macosKeychain(run?: CommandRunner): Keychain;
+/** Linux Secret Service (GNOME Keyring, KWallet) through `secret-tool`. */
+export declare function secretServiceKeychain(run?: CommandRunner): Keychain;
+/**
+ * The keychain for this machine, or null when there is none (Windows, a Linux
+ * box without secret-tool, or INBOXY_KEYCHAIN=off).
+ */
+export declare function systemKeychain(env?: NodeJS.ProcessEnv, platform?: NodeJS.Platform, run?: CommandRunner): Promise<Keychain | null>;
+export interface ResolveOptions {
+    env?: NodeJS.ProcessEnv;
+    profile?: string;
+    /** Pass `null` to skip the keychain; omit to detect it. */
+    keychain?: Keychain | null;
+}
+export declare function resolveCredentials(options?: ResolveOptions): Promise<ResolvedCredentials>;
+//# sourceMappingURL=credentials.d.ts.map

package/dist/credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.d.ts","sourceRoot":"","sources":["../src/credentials.ts"],"names":[],"mappings":"AAwBA,eAAO,MAAM,gBAAgB,eAAe,CAAC;AAC7C,eAAO,MAAM,gBAAgB,gBAAgB,CAAC;AAG9C,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,UAAU,GAAG,aAAa,GAAG,MAAM,CAAC;AACpE,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,CAAC;AAErD,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,UAAU,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IACjC,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,CAAC,CAAC;IACX,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAU3D;AAMD,wBAAgB,SAAS,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,GAAG,MAAM,CAItE;AAED,wBAAgB,UAAU,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,GAAG,MAAM,CAEvE;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,oEAAoE;IACpE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAMD,wBAAsB,UAAU,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,GAAG,OAAO,CAAC,YAAY,CAAC,CA2C5F;AAED,6DAA6D;AAC7D,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAE1D;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,gBAAgB,EACxB,GAAG,GAAE,MAAM,CAAC,UAAwB,GACnC,OAAO,CAAC,MAAM,CAAC,CAejB;AAMD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,qEAAqE;AACrE,MAAM,MAAM,aAAa,GAAG,CAC1B,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,KAAK,CAAC,EAAE,MAAM,KACX,OAAO,CAAC,aAAa,CAAC,CAAC;AAE5B,eAAO,MAAM,WAAW,EAAE,aAwBtB,CAAC;AAEL,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC7C,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3C;AAUD,gDAAgD;AAChD,wBAAgB,aAAa,CAAC,GAAG,GAAE,aAA2B,GAAG,QAAQ,CAyCxE;AAED,2EAA2E;AAC3E,wBAAgB,qBAAqB,CAAC,GAAG,GAAE,aAA2B,GAAG,QAAQ,CA2BhF;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAClC,GAAG,GAAE,MAAM,CAAC,UAAwB,EACpC,QAAQ,GAAE,MAAM,CAAC,QAA2B,EAC5C,GAAG,GAAE,aAA2B,GAC/B,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAQ1B;AAMD,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC5B;AAED,wBAAsB,kBAAkB,CACtC,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,mBAAmB,CAAC,CAiF9B"}