@boxline/sdk 1.1.0

package/dist/errors.js

@@ -0,0 +1,403 @@
+/**
+ * Errors. Every failed call throws a BoxlineError (or a subclass) with the HTTP status, the API's stable
+ * snake_case `code`, a message for people, the API's `requestId` to quote when asking for support, and your own
+ * `clientRequestId` if you sent one.
+ */
+/** Stable error codes the SDK gives its own class to (docs/CONTRACT.md "Errors"). */
+export const ErrorCode = {
+    rateLimited: "rate_limited",
+    concurrencyLimit: "concurrency_limit",
+    featureNotInPlan: "feature_not_in_plan",
+    projectSuspended: "project_suspended",
+    idempotencyMismatch: "idempotency_mismatch",
+    idempotencyInProgress: "idempotency_in_progress",
+    invalidCursor: "invalid_cursor",
+    captchaTimeout: "captcha_timeout",
+    pageUnreachable: "page_unreachable",
+    pageTimeout: "page_timeout",
+    notAWebPage: "not_a_web_page",
+    modelRefused: "model_refused",
+    searchUnavailable: "search_unavailable",
+    outOfViewport: "out_of_viewport",
+    webhookUrlNotAllowed: "webhook_url_not_allowed",
+    webhooksUnavailable: "webhooks_unavailable",
+    webhookDisabled: "webhook_disabled",
+    payloadExpired: "payload_expired",
+    /** A delivery's errorCode (never an HTTP error): the project already had 10,000 deliveries waiting. */
+    queueFull: "queue_full",
+    invalidSignature: "invalid_signature",
+    variablesWithExtensions: "variables_with_extensions",
+    extensionDenied: "extension_denied",
+    crossSiteRequest: "cross_site_request",
+    invalidExtension: "invalid_extension",
+    payloadTooLarge: "payload_too_large",
+    limitReached: "limit_reached",
+    missingVariables: "missing_variables",
+    planLimit: "plan_limit",
+    tooManySecretValues: "too_many_secret_values",
+    secretExists: "secret_exists",
+    secretNotForAi: "secret_not_for_ai",
+    secretNotForShell: "secret_not_for_shell",
+    machineTooOld: "machine_too_old",
+    /**
+     * An agent or task run's errorCode (never an HTTP error): the answer did not match the run's output schema after the
+     * repair try (the run's `error` lists the problems).
+     */
+    outputInvalid: "output_invalid",
+    /**
+     * Agent-run errorCodes (never HTTP errors) for a run that stopped at one of its limits and can be continued
+     * (agent.continueRun) while its `continuable` is set: its maxSteps, its maxCostUsd, maxConsecutiveErrors tool errors in
+     * a row, or the same call with the same result 5 times in a row.
+     */
+    maxSteps: "max_steps",
+    maxCost: "max_cost",
+    tooManyErrors: "too_many_errors",
+    noProgress: "no_progress",
+    /**
+     * Agent-run errorCode (continuable like the limits): the API server running the loop stopped (a restart, a deploy)
+     * while its session went on; agent.continueRun picks it up in the same browser.
+     */
+    serverRestarted: "server_restarted",
+    /** Agent-run errorCodes: its session reached its time limit, or ended another way, while it worked (not continuable). */
+    sessionTimeout: "session_timeout",
+    sessionEnded: "session_ended",
+    /** 409: agent.continueRun on a run that did not stop at a limit, was continued already, or whose window passed. */
+    notContinuable: "not_continuable",
+    /** 409: agent.sendMessage after 50 messages to one run. */
+    tooManyMessages: "too_many_messages",
+    /** 409: takeover, handBack or sendMessage on a run whose server stopped (continue it instead). */
+    runNotLive: "run_not_live",
+    /** 400: project.setModelKey when the provider does not accept the key (nothing is saved). */
+    invalidModelKey: "invalid_model_key",
+    /** 400: a call on the project's own model key was refused by the provider (a run ends with this errorCode); never falls back to Boxline's key. */
+    modelKeyRejected: "model_key_rejected",
+    /** 502: another failure of a call on the project's own model key (the provider's text, key scrubbed). */
+    modelError: "model_error",
+    /** 413: contexts.create({fromSession}) when the session's cookies and site storage exceed 16 MB. */
+    contextTooLarge: "context_too_large",
+    /** 409: the session has ended (e.g. an agent run or continueRun in it). */
+    sessionNotRunning: "session_not_running",
+    unauthorized: "unauthorized",
+    notFound: "not_found",
+    connectionError: "connection_error",
+    timeout: "timeout",
+};
+/**
+ * 5xx answers that are not the platform's own trouble, so they are not retried by themselves: configuration (a model
+ * provider, proxies or webhook delivery not set up), and a page that could not be loaded (fix the address; a page_timeout may be worth
+ * one more try of your own, with a longer timeoutMs).
+ */
+const NOT_RETRYABLE = new Set(["provider_unavailable", "proxy_unavailable", "webhooks_unavailable", "page_unreachable", "page_timeout", "not_a_web_page"]);
+export class BoxlineError extends Error {
+    status;
+    code;
+    /** The API's id for the request: quote it when asking for support. */
+    requestId;
+    /** Your own id for the request, if you sent one (RequestOptions.clientRequestId). */
+    clientRequestId;
+    /** Response headers (RateLimit-*, Retry-After, …); undefined when no response came back. */
+    headers;
+    body;
+    constructor(status, code, message, details = {}) {
+        super(message, details.cause === undefined ? undefined : { cause: details.cause });
+        this.name = "BoxlineError";
+        this.status = status;
+        this.code = code;
+        this.requestId = details.requestId ?? null;
+        this.clientRequestId = details.clientRequestId ?? null;
+        this.headers = details.headers;
+        this.body = details.body;
+    }
+    /** Whether trying the same call again later can succeed (rate limits, server errors, network trouble). */
+    get retryable() {
+        if (this.code === ErrorCode.idempotencyInProgress)
+            return true;
+        // Search not set up is for good; the provider rate limiting the platform says when to come back.
+        if (this.code === ErrorCode.searchUnavailable)
+            return retryAfterSeconds(this.headers) !== null;
+        if (NOT_RETRYABLE.has(this.code))
+            return false;
+        return this.status === 429 || (this.status >= 500 && this.status !== 501);
+    }
+}
+/** 429: too many requests (`rate_limited`) or all of the plan's concurrent sessions in use (`concurrency_limit`). */
+export class RateLimitError extends BoxlineError {
+    /** Seconds the server asked to wait (Retry-After), when it said. */
+    retryAfter;
+    constructor(status, code, message, details = {}) {
+        super(status, code, message, details);
+        this.name = "RateLimitError";
+        this.retryAfter = retryAfterSeconds(details.headers);
+    }
+}
+/** 402 `feature_not_in_plan`: the project's plan does not include this. */
+export class FeatureNotInPlanError extends BoxlineError {
+    name = "FeatureNotInPlanError";
+}
+/** 403 `project_suspended`: an admin suspended the project; the message says why. */
+export class ProjectSuspendedError extends BoxlineError {
+    name = "ProjectSuspendedError";
+}
+/**
+ * 422 `idempotency_mismatch`: this Idempotency-Key was already used for a different request (another body or route),
+ * or, for a new API key, by another caller (another API key or console login).
+ */
+export class IdempotencyMismatchError extends BoxlineError {
+    name = "IdempotencyMismatchError";
+}
+/** 409 `idempotency_in_progress`: the first request with this key is still being answered (retried automatically). */
+export class IdempotencyInProgressError extends BoxlineError {
+    name = "IdempotencyInProgressError";
+}
+/** 400 `invalid_cursor`: `after` is not a `next` value of that list. */
+export class InvalidCursorError extends BoxlineError {
+    name = "InvalidCursorError";
+}
+/** `captcha_timeout`: a CAPTCHA kept waiting for a person (a plain-English step, or waitForHuman). */
+export class CaptchaTimeoutError extends BoxlineError {
+    name = "CaptchaTimeoutError";
+}
+/** 502 `page_unreachable` (fetch, screenshot, pdf, extract): the page could not be loaded; the message says why. */
+export class PageUnreachableError extends BoxlineError {
+    name = "PageUnreachableError";
+}
+/** 504 `page_timeout` (fetch, screenshot, pdf, extract): the page did not finish loading within `timeoutMs`. */
+export class PageTimeoutError extends BoxlineError {
+    name = "PageTimeoutError";
+}
+/** 422 `not_a_web_page` (fetch, extract, search, crawl): the address is a file Chrome only displays (a PDF), with no page text. */
+export class NotAWebPageError extends BoxlineError {
+    name = "NotAWebPageError";
+}
+/** 422 `model_refused` (extract): the model declined to extract from these pages. */
+export class ModelRefusedError extends BoxlineError {
+    name = "ModelRefusedError";
+}
+/**
+ * 503 `search_unavailable`: web search is not set up on this server, or its provider did not answer or is limiting
+ * the platform (then `retryable`, with Retry-After).
+ */
+export class SearchUnavailableError extends BoxlineError {
+    name = "SearchUnavailableError";
+}
+/** 400 `out_of_viewport`: a mouse action's point is outside the page (or the computer-use screenshot). */
+export class OutOfViewportError extends BoxlineError {
+    name = "OutOfViewportError";
+}
+/** 400 `webhook_url_not_allowed`: webhook endpoints must be public HTTPS addresses (the message says what is wrong). */
+export class WebhookUrlNotAllowedError extends BoxlineError {
+    name = "WebhookUrlNotAllowedError";
+}
+/** 503 `webhooks_unavailable`: webhook delivery is not set up on this server. */
+export class WebhooksUnavailableError extends BoxlineError {
+    name = "WebhooksUnavailableError";
+}
+/** 409 `webhook_disabled`: the endpoint is switched off; turn it on (update enabled: true) first. */
+export class WebhookDisabledError extends BoxlineError {
+    name = "WebhookDisabledError";
+}
+/** 409 `payload_expired`: the event's body is kept 7 days; that delivery can no longer be sent again. */
+export class PayloadExpiredError extends BoxlineError {
+    name = "PayloadExpiredError";
+}
+/** 400 `variables_with_extensions`: an agent run with variables in a session with extensions (see allowWithExtensions). */
+export class VariablesWithExtensionsError extends BoxlineError {
+    name = "VariablesWithExtensionsError";
+}
+/** 403 `extension_denied`: the operator does not allow this extension. */
+export class ExtensionDeniedError extends BoxlineError {
+    name = "ExtensionDeniedError";
+}
+/** 403 `cross_site_request`: a console-login upload that did not come from the platform's own sites. */
+export class CrossSiteRequestError extends BoxlineError {
+    name = "CrossSiteRequestError";
+}
+/** 400 `invalid_extension`: the zip is not an acceptable Manifest V3 extension (the message says why). */
+export class InvalidExtensionError extends BoxlineError {
+    name = "InvalidExtensionError";
+}
+/** 413 `payload_too_large`: the body is larger than the route allows (an extension zip: 10 MB). */
+export class PayloadTooLargeError extends BoxlineError {
+    name = "PayloadTooLargeError";
+}
+/** 409 `limit_reached`: the project has as many as it may (e.g. 100 extensions). */
+export class LimitReachedError extends BoxlineError {
+    name = "LimitReachedError";
+}
+/** 400 `missing_variables`: a task run (or its schedule) has no value for a variable without a default; the message names them. */
+export class MissingVariablesError extends BoxlineError {
+    name = "MissingVariablesError";
+}
+/**
+ * `plan_limit`: the plan allows no more of this (402: tasks, schedules switched on, searches on Free, project
+ * secrets beyond `maxSecrets`, a session longer than the plan allows); the message says the limit.
+ */
+export class PlanLimitError extends BoxlineError {
+    name = "PlanLimitError";
+}
+/**
+ * 409 `too_many_secret_values`: the session already hides as many earlier secret values in its output as it can (256
+ * values or 256 KB); a session create, exec, agent run or step adding more is refused. Start a new session.
+ */
+export class TooManySecretValuesError extends BoxlineError {
+    name = "TooManySecretValuesError";
+}
+/** 409 `secret_exists`: the project has a secret with that name; change it with secrets.update. */
+export class SecretExistsError extends BoxlineError {
+    name = "SecretExistsError";
+}
+/**
+ * 400 `secret_not_for_ai` / `secret_not_for_shell`: the secret's scope does not allow this use (scope "shell" is not for
+ * the AI; a secret goes into a shell only with scope "shell" or "all", or shell: true).
+ */
+export class SecretNotAllowedError extends BoxlineError {
+    name = "SecretNotAllowedError";
+}
+/**
+ * 409 `machine_too_old`: the session's machine comes from an image older than the API (during a deploy) and cannot take
+ * `env` or `secrets`; start a new session.
+ */
+export class MachineTooOldError extends BoxlineError {
+    name = "MachineTooOldError";
+}
+/**
+ * 409 `not_continuable`: agent.continueRun on a run that did not stop at one of its limits, was already continued (the
+ * message names the run that did), or whose continue window has passed.
+ */
+export class NotContinuableError extends BoxlineError {
+    name = "NotContinuableError";
+}
+/** 409 `too_many_messages`: a run takes at most 50 messages (agent.sendMessage). */
+export class TooManyMessagesError extends BoxlineError {
+    name = "TooManyMessagesError";
+}
+/**
+ * 409 `run_not_live`: agent.takeover, handBack or sendMessage on a run whose API server stopped (a restart, a deploy):
+ * no loop is left to act on it. Continue it (agent.continueRun) once it shows as failed with `server_restarted`.
+ */
+export class RunNotLiveError extends BoxlineError {
+    name = "RunNotLiveError";
+}
+/** 409 `session_not_running`: the session has ended (an agent run started or continued in it, a command, …). */
+export class SessionNotRunningError extends BoxlineError {
+    name = "SessionNotRunningError";
+}
+/**
+ * verifyWebhook refused a delivery (not an API error: answer the sender 400). `reason`: the Boxline-Signature header
+ * is missing or malformed, its timestamp is too far from now (a replay), or no signature matches the secret(s).
+ */
+export class WebhookSignatureError extends BoxlineError {
+    reason;
+    constructor(reason, message) {
+        super(400, ErrorCode.invalidSignature, message);
+        this.name = "WebhookSignatureError";
+        this.reason = reason;
+    }
+    get retryable() {
+        return false;
+    }
+}
+/** 401: missing or invalid API key. */
+export class AuthenticationError extends BoxlineError {
+    name = "AuthenticationError";
+}
+/** 404: no such thing in this project. */
+export class NotFoundError extends BoxlineError {
+    name = "NotFoundError";
+}
+/** No response: the network failed or the server went away (retried automatically where safe). */
+export class BoxlineConnectionError extends BoxlineError {
+    constructor(message, details = {}) {
+        super(0, ErrorCode.connectionError, message, details);
+        this.name = "BoxlineConnectionError";
+    }
+    get retryable() {
+        return true;
+    }
+}
+/** The request took longer than its time limit (`timeoutMs`). */
+export class BoxlineTimeoutError extends BoxlineConnectionError {
+    constructor(message, details = {}) {
+        super(message, details);
+        this.code = ErrorCode.timeout;
+        this.name = "BoxlineTimeoutError";
+    }
+}
+const BY_CODE = {
+    [ErrorCode.rateLimited]: RateLimitError,
+    [ErrorCode.concurrencyLimit]: RateLimitError,
+    [ErrorCode.featureNotInPlan]: FeatureNotInPlanError,
+    [ErrorCode.projectSuspended]: ProjectSuspendedError,
+    [ErrorCode.idempotencyMismatch]: IdempotencyMismatchError,
+    [ErrorCode.idempotencyInProgress]: IdempotencyInProgressError,
+    [ErrorCode.invalidCursor]: InvalidCursorError,
+    [ErrorCode.captchaTimeout]: CaptchaTimeoutError,
+    [ErrorCode.pageUnreachable]: PageUnreachableError,
+    [ErrorCode.pageTimeout]: PageTimeoutError,
+    [ErrorCode.notAWebPage]: NotAWebPageError,
+    [ErrorCode.modelRefused]: ModelRefusedError,
+    [ErrorCode.searchUnavailable]: SearchUnavailableError,
+    [ErrorCode.outOfViewport]: OutOfViewportError,
+    [ErrorCode.webhookUrlNotAllowed]: WebhookUrlNotAllowedError,
+    [ErrorCode.webhooksUnavailable]: WebhooksUnavailableError,
+    [ErrorCode.webhookDisabled]: WebhookDisabledError,
+    [ErrorCode.payloadExpired]: PayloadExpiredError,
+    [ErrorCode.variablesWithExtensions]: VariablesWithExtensionsError,
+    [ErrorCode.extensionDenied]: ExtensionDeniedError,
+    [ErrorCode.crossSiteRequest]: CrossSiteRequestError,
+    [ErrorCode.invalidExtension]: InvalidExtensionError,
+    [ErrorCode.payloadTooLarge]: PayloadTooLargeError,
+    [ErrorCode.limitReached]: LimitReachedError,
+    [ErrorCode.missingVariables]: MissingVariablesError,
+    [ErrorCode.planLimit]: PlanLimitError,
+    [ErrorCode.tooManySecretValues]: TooManySecretValuesError,
+    [ErrorCode.secretExists]: SecretExistsError,
+    [ErrorCode.secretNotForAi]: SecretNotAllowedError,
+    [ErrorCode.secretNotForShell]: SecretNotAllowedError,
+    [ErrorCode.machineTooOld]: MachineTooOldError,
+    [ErrorCode.notContinuable]: NotContinuableError,
+    [ErrorCode.tooManyMessages]: TooManyMessagesError,
+    [ErrorCode.runNotLive]: RunNotLiveError,
+    [ErrorCode.sessionNotRunning]: SessionNotRunningError,
+};
+const BY_STATUS = { 401: AuthenticationError, 404: NotFoundError, 429: RateLimitError };
+/** The error class for an API error: by its code first, then by its status. */
+export function makeError(status, code, message, details = {}) {
+    const Cls = BY_CODE[code] ?? BY_STATUS[status] ?? BoxlineError;
+    return new Cls(status, code, message, details);
+}
+/** Retry-After in seconds (a number of seconds or an HTTP date); null when absent or unreadable. */
+export function retryAfterSeconds(headers) {
+    const v = headers?.get("retry-after");
+    if (v === null || v === undefined || v.trim() === "")
+        return null;
+    const n = Number(v);
+    if (Number.isFinite(n))
+        return Math.max(0, n);
+    const at = Date.parse(v);
+    return Number.isNaN(at) ? null : Math.max(0, (at - Date.now()) / 1000);
+}
+/** Turns an error response into a typed error. The body is read here (it is small JSON); this never throws. */
+export async function errorFromResponse(res, method, path, sentClientId) {
+    let body;
+    let code = "http_error";
+    let message = `${method} ${path.split("?")[0]} failed with ${res.status}`;
+    let requestId = res.headers.get("x-request-id");
+    try {
+        const text = await res.text();
+        body = text ? JSON.parse(text) : undefined;
+        const err = body?.error;
+        if (typeof err?.code === "string")
+            code = err.code;
+        if (typeof err?.message === "string")
+            message = err.message;
+        if (typeof err?.requestId === "string")
+            requestId = err.requestId;
+    }
+    catch {
+        /* not JSON (a proxy's error page), or the body could not be read: keep the generic message */
+    }
+    const clientRequestId = res.headers.get("x-client-request-id") ?? sentClientId ?? null;
+    return makeError(res.status, code, message, { requestId, clientRequestId, headers: res.headers, body });
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,qFAAqF;AACrF,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,WAAW,EAAE,cAAc;IAC3B,gBAAgB,EAAE,mBAAmB;IACrC,gBAAgB,EAAE,qBAAqB;IACvC,gBAAgB,EAAE,mBAAmB;IACrC,mBAAmB,EAAE,sBAAsB;IAC3C,qBAAqB,EAAE,yBAAyB;IAChD,aAAa,EAAE,gBAAgB;IAC/B,cAAc,EAAE,iBAAiB;IACjC,eAAe,EAAE,kBAAkB;IACnC,WAAW,EAAE,cAAc;IAC3B,WAAW,EAAE,gBAAgB;IAC7B,YAAY,EAAE,eAAe;IAC7B,iBAAiB,EAAE,oBAAoB;IACvC,aAAa,EAAE,iBAAiB;IAChC,oBAAoB,EAAE,yBAAyB;IAC/C,mBAAmB,EAAE,sBAAsB;IAC3C,eAAe,EAAE,kBAAkB;IACnC,cAAc,EAAE,iBAAiB;IACjC,uGAAuG;IACvG,SAAS,EAAE,YAAY;IACvB,gBAAgB,EAAE,mBAAmB;IACrC,uBAAuB,EAAE,2BAA2B;IACpD,eAAe,EAAE,kBAAkB;IACnC,gBAAgB,EAAE,oBAAoB;IACtC,gBAAgB,EAAE,mBAAmB;IACrC,eAAe,EAAE,mBAAmB;IACpC,YAAY,EAAE,eAAe;IAC7B,gBAAgB,EAAE,mBAAmB;IACrC,SAAS,EAAE,YAAY;IACvB,mBAAmB,EAAE,wBAAwB;IAC7C,YAAY,EAAE,eAAe;IAC7B,cAAc,EAAE,mBAAmB;IACnC,iBAAiB,EAAE,sBAAsB;IACzC,aAAa,EAAE,iBAAiB;IAChC;;;OAGG;IACH,aAAa,EAAE,gBAAgB;IAC/B;;;;OAIG;IACH,QAAQ,EAAE,WAAW;IACrB,OAAO,EAAE,UAAU;IACnB,aAAa,EAAE,iBAAiB;IAChC,UAAU,EAAE,aAAa;IACzB;;;OAGG;IACH,eAAe,EAAE,kBAAkB;IACnC,yHAAyH;IACzH,cAAc,EAAE,iBAAiB;IACjC,YAAY,EAAE,eAAe;IAC7B,mHAAmH;IACnH,cAAc,EAAE,iBAAiB;IACjC,2DAA2D;IAC3D,eAAe,EAAE,mBAAmB;IACpC,kGAAkG;IAClG,UAAU,EAAE,cAAc;IAC1B,6FAA6F;IAC7F,eAAe,EAAE,mBAAmB;IACpC,kJAAkJ;IAClJ,gBAAgB,EAAE,oBAAoB;IACtC,yGAAyG;IACzG,UAAU,EAAE,aAAa;IACzB,oGAAoG;IACpG,eAAe,EAAE,mBAAmB;IACpC,2EAA2E;IAC3E,iBAAiB,EAAE,qBAAqB;IACxC,YAAY,EAAE,cAAc;IAC5B,QAAQ,EAAE,WAAW;IACrB,eAAe,EAAE,kBAAkB;IACnC,OAAO,EAAE,SAAS;CACV,CAAC;AAaX;;;;GAIG;AACH,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,sBAAsB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAE3J,MAAM,OAAO,YAAa,SAAQ,KAAK;IAC5B,MAAM,CAAS;IACf,IAAI,CAAS;IACtB,sEAAsE;IAC7D,SAAS,CAAgB;IAClC,qFAAqF;IAC5E,eAAe,CAAgB;IACxC,4FAA4F;IACnF,OAAO,CAAW;IAClB,IAAI,CAAW;IAExB,YAAY,MAAc,EAAE,IAAY,EAAE,OAAe,EAAE,UAAwB,EAAE;QACnF,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC;QAC3C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,IAAI,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,0GAA0G;IAC1G,IAAI,SAAS;QACX,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,qBAAqB;YAAE,OAAO,IAAI,CAAC;QAC/D,iGAAiG;QACjG,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,iBAAiB;YAAE,OAAO,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;QAC/F,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QAC/C,OAAO,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC;IAC5E,CAAC;CACF;AAED,qHAAqH;AACrH,MAAM,OAAO,cAAe,SAAQ,YAAY;IAC9C,oEAAoE;IAC3D,UAAU,CAAgB;IACnC,YAAY,MAAc,EAAE,IAAY,EAAE,OAAe,EAAE,UAAwB,EAAE;QACnF,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AACD,2EAA2E;AAC3E,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IAC5C,IAAI,GAAG,uBAAuB,CAAC;CACzC;AACD,qFAAqF;AACrF,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IAC5C,IAAI,GAAG,uBAAuB,CAAC;CACzC;AACD;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,YAAY;IAC/C,IAAI,GAAG,0BAA0B,CAAC;CAC5C;AACD,sHAAsH;AACtH,MAAM,OAAO,0BAA2B,SAAQ,YAAY;IACjD,IAAI,GAAG,4BAA4B,CAAC;CAC9C;AACD,wEAAwE;AACxE,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IACzC,IAAI,GAAG,oBAAoB,CAAC;CACtC;AACD,sGAAsG;AACtG,MAAM,OAAO,mBAAoB,SAAQ,YAAY;IAC1C,IAAI,GAAG,qBAAqB,CAAC;CACvC;AACD,oHAAoH;AACpH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IAC3C,IAAI,GAAG,sBAAsB,CAAC;CACxC;AACD,gHAAgH;AAChH,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IACvC,IAAI,GAAG,kBAAkB,CAAC;CACpC;AACD,mIAAmI;AACnI,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IACvC,IAAI,GAAG,kBAAkB,CAAC;CACpC;AACD,qFAAqF;AACrF,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACxC,IAAI,GAAG,mBAAmB,CAAC;CACrC;AACD;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,YAAY;IAC7C,IAAI,GAAG,wBAAwB,CAAC;CAC1C;AACD,0GAA0G;AAC1G,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IACzC,IAAI,GAAG,oBAAoB,CAAC;CACtC;AACD,wHAAwH;AACxH,MAAM,OAAO,yBAA0B,SAAQ,YAAY;IAChD,IAAI,GAAG,2BAA2B,CAAC;CAC7C;AACD,iFAAiF;AACjF,MAAM,OAAO,wBAAyB,SAAQ,YAAY;IAC/C,IAAI,GAAG,0BAA0B,CAAC;CAC5C;AACD,qGAAqG;AACrG,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IAC3C,IAAI,GAAG,sBAAsB,CAAC;CACxC;AACD,yGAAyG;AACzG,MAAM,OAAO,mBAAoB,SAAQ,YAAY;IAC1C,IAAI,GAAG,qBAAqB,CAAC;CACvC;AAED,2HAA2H;AAC3H,MAAM,OAAO,4BAA6B,SAAQ,YAAY;IACnD,IAAI,GAAG,8BAA8B,CAAC;CAChD;AACD,0EAA0E;AAC1E,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IAC3C,IAAI,GAAG,sBAAsB,CAAC;CACxC;AACD,wGAAwG;AACxG,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IAC5C,IAAI,GAAG,uBAAuB,CAAC;CACzC;AACD,0GAA0G;AAC1G,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IAC5C,IAAI,GAAG,uBAAuB,CAAC;CACzC;AACD,mGAAmG;AACnG,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IAC3C,IAAI,GAAG,sBAAsB,CAAC;CACxC;AACD,oFAAoF;AACpF,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACxC,IAAI,GAAG,mBAAmB,CAAC;CACrC;AACD,mIAAmI;AACnI,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IAC5C,IAAI,GAAG,uBAAuB,CAAC;CACzC;AACD;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,YAAY;IACrC,IAAI,GAAG,gBAAgB,CAAC;CAClC;AACD;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,YAAY;IAC/C,IAAI,GAAG,0BAA0B,CAAC;CAC5C;AACD,mGAAmG;AACnG,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACxC,IAAI,GAAG,mBAAmB,CAAC;CACrC;AACD;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IAC5C,IAAI,GAAG,uBAAuB,CAAC;CACzC;AACD;;;GAGG;AACH,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IACzC,IAAI,GAAG,oBAAoB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,YAAY;IAC1C,IAAI,GAAG,qBAAqB,CAAC;CACvC;AACD,oFAAoF;AACpF,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IAC3C,IAAI,GAAG,sBAAsB,CAAC;CACxC;AACD;;;GAGG;AACH,MAAM,OAAO,eAAgB,SAAQ,YAAY;IACtC,IAAI,GAAG,iBAAiB,CAAC;CACnC;AACD,gHAAgH;AAChH,MAAM,OAAO,sBAAuB,SAAQ,YAAY;IAC7C,IAAI,GAAG,wBAAwB,CAAC;CAC1C;AAKD;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IAC5C,MAAM,CAA0B;IACzC,YAAY,MAA+B,EAAE,OAAe;QAC1D,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACD,IAAa,SAAS;QACpB,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AACD,uCAAuC;AACvC,MAAM,OAAO,mBAAoB,SAAQ,YAAY;IAC1C,IAAI,GAAG,qBAAqB,CAAC;CACvC;AACD,0CAA0C;AAC1C,MAAM,OAAO,aAAc,SAAQ,YAAY;IACpC,IAAI,GAAG,eAAe,CAAC;CACjC;AACD,kGAAkG;AAClG,MAAM,OAAO,sBAAuB,SAAQ,YAAY;IACtD,YAAY,OAAe,EAAE,UAAwB,EAAE;QACrD,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,eAAe,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACvC,CAAC;IACD,IAAa,SAAS;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AACD,iEAAiE;AACjE,MAAM,OAAO,mBAAoB,SAAQ,sBAAsB;IAC7D,YAAY,OAAe,EAAE,UAAwB,EAAE;QACrD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACvB,IAAyB,CAAC,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED,MAAM,OAAO,GAAwC;IACnD,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,cAAc;IACvC,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,cAAc;IAC5C,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,qBAAqB;IACnD,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,qBAAqB;IACnD,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,wBAAwB;IACzD,CAAC,SAAS,CAAC,qBAAqB,CAAC,EAAE,0BAA0B;IAC7D,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,kBAAkB;IAC7C,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,mBAAmB;IAC/C,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,oBAAoB;IACjD,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,gBAAgB;IACzC,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,gBAAgB;IACzC,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,iBAAiB;IAC3C,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,sBAAsB;IACrD,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,kBAAkB;IAC7C,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,yBAAyB;IAC3D,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,wBAAwB;IACzD,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,oBAAoB;IACjD,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,mBAAmB;IAC/C,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,4BAA4B;IACjE,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,oBAAoB;IACjD,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,qBAAqB;IACnD,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,qBAAqB;IACnD,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,oBAAoB;IACjD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,iBAAiB;IAC3C,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,qBAAqB;IACnD,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,cAAc;IACrC,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,wBAAwB;IACzD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,iBAAiB;IAC3C,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,qBAAqB;IACjD,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,qBAAqB;IACpD,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,kBAAkB;IAC7C,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,mBAAmB;IAC/C,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,oBAAoB;IACjD,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,eAAe;IACvC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,sBAAsB;CACtD,CAAC;AACF,MAAM,SAAS,GAAwC,EAAE,GAAG,EAAE,mBAAmB,EAAE,GAAG,EAAE,aAAa,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC;AAE7H,+EAA+E;AAC/E,MAAM,UAAU,SAAS,CAAC,MAAc,EAAE,IAAY,EAAE,OAAe,EAAE,UAAwB,EAAE;IACjG,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC;IAC/D,OAAO,IAAI,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AACjD,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,iBAAiB,CAAC,OAAiB;IACjD,MAAM,CAAC,GAAG,OAAO,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC;IACtC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAClE,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACpB,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9C,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACzB,OAAO,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;AACzE,CAAC;AAED,+GAA+G;AAC/G,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,GAAa,EAAE,MAAc,EAAE,IAAY,EAAE,YAAqB;IACxG,IAAI,IAAa,CAAC;IAClB,IAAI,IAAI,GAAG,YAAY,CAAC;IACxB,IAAI,OAAO,GAAG,GAAG,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAgB,GAAG,CAAC,MAAM,EAAE,CAAC;IAC1E,IAAI,SAAS,GAAkB,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC/D,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3C,MAAM,GAAG,GAAI,IAA2F,EAAE,KAAK,CAAC;QAChH,IAAI,OAAO,GAAG,EAAE,IAAI,KAAK,QAAQ;YAAE,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACnD,IAAI,OAAO,GAAG,EAAE,OAAO,KAAK,QAAQ;YAAE,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC5D,IAAI,OAAO,GAAG,EAAE,SAAS,KAAK,QAAQ;YAAE,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IACpE,CAAC;IAAC,MAAM,CAAC;QACP,8FAA8F;IAChG,CAAC;IACD,MAAM,eAAe,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,IAAI,YAAY,IAAI,IAAI,CAAC;IACvF,OAAO,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1G,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * TypeScript SDK for Boxline: isolated cloud sessions with a Chrome browser, a bash shell and a shared disk, plus
+ * web APIs (fetch, screenshot, pdf, extract, crawl, search), computer use, an AI agent and saved tasks. Works in Node 18+ and modern browsers (it
+ * uses the global fetch). The wire format is docs/CONTRACT.md and docs/openapi.yaml.
+ */
+export { Boxline, Auth, ProjectSettings, ApiKeys, Sessions, SessionFiles, Contexts, Crawl, Agent, Tasks, Secrets, Webhooks, Extensions, DEFAULT_BASE_URL, type BoxlineOptions, type SessionPage, type WaitOptions, } from "./client.js";
+export { Session, type ClickOptions, type DragOptions } from "./session.js";
+export { Page, PagePromise } from "./pagination.js";
+export { IDEMPOTENT_POSTS, isIdempotentPost, RETRY, retryDelayMs, type RequestOptions } from "./core.js";
+export { BoxlineError, RateLimitError, FeatureNotInPlanError, ProjectSuspendedError, IdempotencyMismatchError, IdempotencyInProgressError, InvalidCursorError, CaptchaTimeoutError, PageUnreachableError, PageTimeoutError, NotAWebPageError, ModelRefusedError, SearchUnavailableError, OutOfViewportError, WebhookUrlNotAllowedError, WebhooksUnavailableError, WebhookDisabledError, PayloadExpiredError, WebhookSignatureError, VariablesWithExtensionsError, ExtensionDeniedError, CrossSiteRequestError, InvalidExtensionError, PayloadTooLargeError, LimitReachedError, MissingVariablesError, PlanLimitError, TooManySecretValuesError, SecretExistsError, SecretNotAllowedError, MachineTooOldError, NotContinuableError, TooManyMessagesError, RunNotLiveError, SessionNotRunningError, type WebhookSignatureFailure, AuthenticationError, NotFoundError, BoxlineConnectionError, BoxlineTimeoutError, ErrorCode, makeError, } from "./errors.js";
+export { verifyWebhook, webhookSignatureHeader, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TOLERANCE_SECONDS, type VerifyWebhookOptions } from "./webhooks.js";
+export { VERSION } from "./version.js";
+export type * from "./types.js";
+export { Boxline as default } from "./client.js";

package/dist/index.js

@@ -0,0 +1,14 @@
+/**
+ * TypeScript SDK for Boxline: isolated cloud sessions with a Chrome browser, a bash shell and a shared disk, plus
+ * web APIs (fetch, screenshot, pdf, extract, crawl, search), computer use, an AI agent and saved tasks. Works in Node 18+ and modern browsers (it
+ * uses the global fetch). The wire format is docs/CONTRACT.md and docs/openapi.yaml.
+ */
+export { Boxline, Auth, ProjectSettings, ApiKeys, Sessions, SessionFiles, Contexts, Crawl, Agent, Tasks, Secrets, Webhooks, Extensions, DEFAULT_BASE_URL, } from "./client.js";
+export { Session } from "./session.js";
+export { Page, PagePromise } from "./pagination.js";
+export { IDEMPOTENT_POSTS, isIdempotentPost, RETRY, retryDelayMs } from "./core.js";
+export { BoxlineError, RateLimitError, FeatureNotInPlanError, ProjectSuspendedError, IdempotencyMismatchError, IdempotencyInProgressError, InvalidCursorError, CaptchaTimeoutError, PageUnreachableError, PageTimeoutError, NotAWebPageError, ModelRefusedError, SearchUnavailableError, OutOfViewportError, WebhookUrlNotAllowedError, WebhooksUnavailableError, WebhookDisabledError, PayloadExpiredError, WebhookSignatureError, VariablesWithExtensionsError, ExtensionDeniedError, CrossSiteRequestError, InvalidExtensionError, PayloadTooLargeError, LimitReachedError, MissingVariablesError, PlanLimitError, TooManySecretValuesError, SecretExistsError, SecretNotAllowedError, MachineTooOldError, NotContinuableError, TooManyMessagesError, RunNotLiveError, SessionNotRunningError, AuthenticationError, NotFoundError, BoxlineConnectionError, BoxlineTimeoutError, ErrorCode, makeError, } from "./errors.js";
+export { verifyWebhook, webhookSignatureHeader, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TOLERANCE_SECONDS } from "./webhooks.js";
+export { VERSION } from "./version.js";
+export { Boxline as default } from "./client.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EACL,OAAO,EACP,IAAI,EACJ,eAAe,EACf,OAAO,EACP,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,KAAK,EACL,KAAK,EACL,KAAK,EACL,OAAO,EACP,QAAQ,EACR,UAAU,EACV,gBAAgB,GAIjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,OAAO,EAAuC,MAAM,cAAc,CAAC;AAC5E,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,KAAK,EAAE,YAAY,EAAuB,MAAM,WAAW,CAAC;AACzG,OAAO,EACL,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACrB,wBAAwB,EACxB,0BAA0B,EAC1B,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,kBAAkB,EAClB,yBAAyB,EACzB,wBAAwB,EACxB,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,eAAe,EACf,sBAAsB,EAEtB,mBAAmB,EACnB,aAAa,EACb,sBAAsB,EACtB,mBAAmB,EACnB,SAAS,EACT,SAAS,GACV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,yBAAyB,EAA6B,MAAM,eAAe,CAAC;AACtJ,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC"}

package/dist/pagination.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Cursor pages (docs/CONTRACT.md "Pagination"): every list returns `{data, next}`, and `next` goes back as `after`
+ * until it is null.
+ *
+ *   const page = await bx.sessions.list({ limit: 50 });  // one page: page.data, page.next
+ *   for await (const s of bx.sessions.list()) { … }       // every session, page after page
+ */
+export declare class Page<T> implements AsyncIterable<T> {
+    #private;
+    /** The items on this page. */
+    readonly data: T[];
+    /** The cursor of the following page (pass it as `after`), or null on the last page. */
+    readonly next: string | null;
+    constructor(body: {
+        data: T[];
+        next?: string | null;
+    } & Record<string, unknown>, load: (after: string) => Promise<Page<T>>);
+    hasNextPage(): boolean;
+    /** The following page (same filters). Throws on the last page: check hasNextPage() first. */
+    getNextPage(): Promise<this>;
+    /** This page and every page after it. */
+    iterPages(): AsyncGenerator<this>;
+    /** Every item from this page on, fetching the following pages as needed. */
+    [Symbol.asyncIterator](): AsyncGenerator<T>;
+}
+/**
+ * What list methods return: await it for the first page, or iterate it with `for await` for every item.
+ * The first page is requested right away.
+ */
+export declare class PagePromise<T, P extends Page<T> = Page<T>> extends Promise<P> implements AsyncIterable<T> {
+    static get [Symbol.species](): PromiseConstructor;
+    constructor(load: () => Promise<P>);
+    [Symbol.asyncIterator](): AsyncGenerator<T>;
+}

package/dist/pagination.js

@@ -0,0 +1,67 @@
+/**
+ * Cursor pages (docs/CONTRACT.md "Pagination"): every list returns `{data, next}`, and `next` goes back as `after`
+ * until it is null.
+ *
+ *   const page = await bx.sessions.list({ limit: 50 });  // one page: page.data, page.next
+ *   for await (const s of bx.sessions.list()) { … }       // every session, page after page
+ */
+export class Page {
+    /** The items on this page. */
+    data;
+    /** The cursor of the following page (pass it as `after`), or null on the last page. */
+    next;
+    #load;
+    constructor(body, load) {
+        // Other fields of the list (total, limit, offset, nextAfter) are kept as they are.
+        Object.assign(this, body);
+        this.data = body.data;
+        this.next = typeof body.next === "string" && body.next !== "" ? body.next : null;
+        this.#load = load;
+    }
+    hasNextPage() {
+        return this.next !== null;
+    }
+    /** The following page (same filters). Throws on the last page: check hasNextPage() first. */
+    async getNextPage() {
+        if (this.next === null)
+            throw new Error("this is the last page (next is null)");
+        return (await this.#load(this.next));
+    }
+    /** This page and every page after it. */
+    async *iterPages() {
+        let page = this;
+        yield page;
+        while (page.hasNextPage()) {
+            page = await page.getNextPage();
+            yield page;
+        }
+    }
+    /** Every item from this page on, fetching the following pages as needed. */
+    async *[Symbol.asyncIterator]() {
+        for await (const page of this.iterPages())
+            yield* page.data;
+    }
+}
+/**
+ * What list methods return: await it for the first page, or iterate it with `for await` for every item.
+ * The first page is requested right away.
+ */
+export class PagePromise extends Promise {
+    // then/catch/finally make plain promises, not PagePromises (whose constructor takes a loader).
+    static get [Symbol.species]() {
+        return Promise;
+    }
+    constructor(load) {
+        let resolve;
+        let reject;
+        super((res, rej) => {
+            resolve = res;
+            reject = rej;
+        });
+        load().then(resolve, reject);
+    }
+    async *[Symbol.asyncIterator]() {
+        yield* await this;
+    }
+}
+//# sourceMappingURL=pagination.js.map

package/dist/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,OAAO,IAAI;IACf,8BAA8B;IACrB,IAAI,CAAM;IACnB,uFAAuF;IAC9E,IAAI,CAAgB;IACpB,KAAK,CAAsC;IAEpD,YAAY,IAAmE,EAAE,IAAyC;QACxH,mFAAmF;QACnF,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QACjF,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC;IAC5B,CAAC;IAED,6FAA6F;IAC7F,KAAK,CAAC,WAAW;QACf,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAChF,OAAO,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAS,CAAC;IAC/C,CAAC;IAED,yCAAyC;IACzC,KAAK,CAAC,CAAC,SAAS;QACd,IAAI,IAAI,GAAS,IAAI,CAAC;QACtB,MAAM,IAAI,CAAC;QACX,OAAO,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1B,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC;QACb,CAAC;IACH,CAAC;IAED,4EAA4E;IAC5E,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE;YAAE,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IAC9D,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,WAA4C,SAAQ,OAAU;IACzE,+FAA+F;IAC/F,MAAM,KAAc,CAAC,MAAM,CAAC,OAAO,CAAC;QAClC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,YAAY,IAAsB;QAChC,IAAI,OAA2B,CAAC;QAChC,IAAI,MAA+B,CAAC;QACpC,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjB,OAAO,GAAG,GAAG,CAAC;YACd,MAAM,GAAG,GAAG,CAAC;QACf,CAAC,CAAC,CAAC;QACH,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC;IACpB,CAAC;CACF"}