@seamapi/http 2.18.0 → 2.20.0

package/lib/seam-http-error.js

@@ -1,7 +1,20 @@
+/**
+ * Error thrown when the Seam API returns an error response.
+ */
 export class SeamHttpApiError extends Error {
+    /**
+     * Error type returned by the Seam API, e.g., `invalid_input`.
+     */
     code;
     statusCode;
+    /**
+     * Unique identifier of the request that failed.
+     * Provide this to Seam support when reporting an issue.
+     */
     requestId;
+    /**
+     * Additional error-specific data returned by the Seam API, if any.
+     */
     data;
     constructor(error, statusCode, requestId) {
         const { type, message, data } = error;
@@ -14,9 +27,15 @@ export class SeamHttpApiError extends Error {
             this.data = data;
     }
 }
+/**
+ * Returns true if the error is a {@link SeamHttpApiError}.
+ */
 export const isSeamHttpApiError = (error) => {
     return error instanceof SeamHttpApiError;
 };
+/**
+ * Error thrown when the Seam API returns a 401 Unauthorized error response.
+ */
 export class SeamHttpUnauthorizedError extends SeamHttpApiError {
     code;
     statusCode;
@@ -30,9 +49,15 @@ export class SeamHttpUnauthorizedError extends SeamHttpApiError {
         this.requestId = requestId;
     }
 }
+/**
+ * Returns true if the error is a {@link SeamHttpUnauthorizedError}.
+ */
 export const isSeamHttpUnauthorizedError = (error) => {
     return error instanceof SeamHttpUnauthorizedError;
 };
+/**
+ * Error thrown when the Seam API returns an `invalid_input` error response.
+ */
 export class SeamHttpInvalidInputError extends SeamHttpApiError {
     code;
     #validationErrors;
@@ -42,10 +67,19 @@ export class SeamHttpInvalidInputError extends SeamHttpApiError {
         this.code = 'invalid_input';
         this.#validationErrors = error.validation_errors ?? {};
     }
+    /**
+     * Returns the validation error messages for the request parameter,
+     * or an empty array if the parameter had no validation errors.
+     *
+     * @param paramName - Name of the request parameter.
+     */
     getValidationErrorMessages(paramName) {
         return this.#validationErrors[paramName]?._errors ?? [];
     }
 }
+/**
+ * Returns true if the error is a {@link SeamHttpInvalidInputError}.
+ */
 export const isSeamHttpInvalidInputError = (error) => {
     return error instanceof SeamHttpInvalidInputError;
 };

package/lib/seam-http-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"seam-http-error.js","sourceRoot":"","sources":["../src/lib/seam-http-error.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,IAAI,CAAQ;IACZ,UAAU,CAAQ;IAClB,SAAS,CAAQ;IACjB,IAAI,CAAU;IAEd,YAAY,KAAe,EAAE,UAAkB,EAAE,SAAiB;QAChE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;QACrC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,IAAI,IAAI,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IACpC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAc,EACa,EAAE;IAC7B,OAAO,KAAK,YAAY,gBAAgB,CAAA;AAC1C,CAAC,CAAA;AAED,MAAM,OAAO,yBAA0B,SAAQ,gBAAgB;IACpD,IAAI,CAAgB;IACpB,UAAU,CAAK;IAExB,YAAY,SAAiB;QAC3B,MAAM,IAAI,GAAG,cAAc,CAAA;QAC3B,MAAM,MAAM,GAAG,GAAG,CAAA;QAClB,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,CAAA;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAA;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CACF;AAED,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,KAAc,EACsB,EAAE;IACtC,OAAO,KAAK,YAAY,yBAAyB,CAAA;AACnD,CAAC,CAAA;AAED,MAAM,OAAO,yBAA0B,SAAQ,gBAAgB;IACpD,IAAI,CAAiB;IACrB,iBAAiB,CAA4C;IAEtE,YAAY,KAAe,EAAE,UAAkB,EAAE,SAAiB;QAChE,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAA;QAC3B,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,EAAE,CAAA;IACxD,CAAC;IAED,0BAA0B,CAAC,SAAiB;QAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,OAAO,IAAI,EAAE,CAAA;IACzD,CAAC;CACF;AAED,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,KAAc,EACsB,EAAE;IACtC,OAAO,KAAK,YAAY,yBAAyB,CAAA;AACnD,CAAC,CAAA"}
+{"version":3,"file":"seam-http-error.js","sourceRoot":"","sources":["../src/lib/seam-http-error.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC;;OAEG;IACH,IAAI,CAAQ;IAEZ,UAAU,CAAQ;IAElB;;;OAGG;IACH,SAAS,CAAQ;IAEjB;;OAEG;IACH,IAAI,CAAU;IAEd,YAAY,KAAe,EAAE,UAAkB,EAAE,SAAiB;QAChE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;QACrC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,IAAI,IAAI,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IACpC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAc,EACa,EAAE;IAC7B,OAAO,KAAK,YAAY,gBAAgB,CAAA;AAC1C,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,gBAAgB;IACpD,IAAI,CAAgB;IACpB,UAAU,CAAK;IAExB,YAAY,SAAiB;QAC3B,MAAM,IAAI,GAAG,cAAc,CAAA;QAC3B,MAAM,MAAM,GAAG,GAAG,CAAA;QAClB,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,CAAA;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAA;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,KAAc,EACsB,EAAE;IACtC,OAAO,KAAK,YAAY,yBAAyB,CAAA;AACnD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,gBAAgB;IACpD,IAAI,CAAiB;IAErB,iBAAiB,CAA4C;IAEtE,YAAY,KAAe,EAAE,UAAkB,EAAE,SAAiB;QAChE,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAA;QAC3B,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,EAAE,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CAAC,SAAiB;QAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,OAAO,IAAI,EAAE,CAAA;IACzD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,KAAc,EACsB,EAAE;IACtC,OAAO,KAAK,YAAY,yBAAyB,CAAA;AACnD,CAAC,CAAA"}

package/lib/seam-http-request.d.ts

@@ -19,18 +19,49 @@ interface SeamHttpRequestConfig<TResponseKey> {
     readonly hasRequiredParameters?: boolean;
     readonly requiredParameterNames?: readonly string[];
 }
+/**
+ * A lazy request to the Seam API.
+ *
+ * Creating a SeamHttpRequest does not send anything over the network.
+ * The request is sent once `execute` is called,
+ * or when the request is awaited like a Promise,
+ * e.g., with `await`, `then`, `catch`, or `finally`.
+ * When the response contains an action attempt,
+ * awaiting the request also waits for the action attempt to resolve
+ * according to the `waitForActionAttempt` option.
+ *
+ * Before sending, the request may be inspected
+ * with `url`, `pathname`, `method`, `params`, and `body`.
+ */
 export declare class SeamHttpRequest<const TResponse, const TResponseKey extends keyof TResponse | undefined> implements Promise<TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined> {
     #private;
     readonly [Symbol.toStringTag]: string;
     constructor(parent: SeamHttpRequestParent, config: SeamHttpRequestConfig<TResponseKey>);
+    /**
+     * The key of the API response object containing the response data,
+     * or undefined if the endpoint returns an empty response.
+     */
     get responseKey(): TResponseKey;
     get hasPagination(): boolean;
+    /**
+     * The full request URL including any serialized query parameters.
+     */
     get url(): URL;
     get pathname(): string;
     get method(): Method;
     get params(): undefined | Record<string, unknown>;
     get body(): unknown;
+    /**
+     * Sends the request and returns the response data.
+     * If the response contains an action attempt,
+     * waits for the action attempt to resolve
+     * according to the `waitForActionAttempt` option.
+     */
     execute(): Promise<TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined>;
+    /**
+     * Sends the request and returns the entire response body
+     * without waiting for any action attempt to resolve.
+     */
     fetchResponse(): Promise<TResponse>;
     then<TResult1 = TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined, TResult2 = never>(onfulfilled?: ((value: TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
     catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null | undefined): Promise<(TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined) | TResult>;

package/lib/seam-http-request.js

@@ -1,6 +1,20 @@
 import { assertValidRequestParameters } from './request-parameters.js';
 import { resolveActionAttempt, } from './resolve-action-attempt.js';
 import { serializeUrlSearchParams } from './url-search-params-serializer.js';
+/**
+ * A lazy request to the Seam API.
+ *
+ * Creating a SeamHttpRequest does not send anything over the network.
+ * The request is sent once `execute` is called,
+ * or when the request is awaited like a Promise,
+ * e.g., with `await`, `then`, `catch`, or `finally`.
+ * When the response contains an action attempt,
+ * awaiting the request also waits for the action attempt to resolve
+ * according to the `waitForActionAttempt` option.
+ *
+ * Before sending, the request may be inspected
+ * with `url`, `pathname`, `method`, `params`, and `body`.
+ */
 export class SeamHttpRequest {
     [Symbol.toStringTag] = 'SeamHttpRequest';
     #parent;
@@ -9,12 +23,19 @@ export class SeamHttpRequest {
         this.#parent = parent;
         this.#config = config;
     }
+    /**
+     * The key of the API response object containing the response data,
+     * or undefined if the endpoint returns an empty response.
+     */
     get responseKey() {
         return this.#config.responseKey;
     }
     get hasPagination() {
         return this.#config.hasPagination ?? false;
     }
+    /**
+     * The full request URL including any serialized query parameters.
+     */
     get url() {
         const { client } = this.#parent;
         const serializer = typeof client.defaults.paramsSerializer === 'function'
@@ -40,6 +61,12 @@ export class SeamHttpRequest {
     get body() {
         return this.#config.body;
     }
+    /**
+     * Sends the request and returns the response data.
+     * If the response contains an action attempt,
+     * waits for the action attempt to resolve
+     * according to the `waitForActionAttempt` option.
+     */
     async execute() {
         const response = await this.fetchResponse();
         if (this.responseKey === undefined) {
@@ -59,6 +86,10 @@ export class SeamHttpRequest {
         }
         return data;
     }
+    /**
+     * Sends the request and returns the entire response body
+     * without waiting for any action attempt to resolve.
+     */
     async fetchResponse() {
         assertValidRequestParameters(this.#config.parameters, this.pathname, this.#config.hasRequiredParameters ?? false, this.#config.requiredParameterNames ?? []);
         const { client } = this.#parent;

package/lib/seam-http-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"seam-http-request.js","sourceRoot":"","sources":["../src/lib/seam-http-request.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAA;AACtE,OAAO,EAEL,oBAAoB,GACrB,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAqB5E,MAAM,OAAO,eAAe;IAMjB,CAAC,MAAM,CAAC,WAAW,CAAC,GAAW,iBAAiB,CAAA;IAEhD,OAAO,CAAuB;IAC9B,OAAO,CAAqC;IAErD,YACE,MAA6B,EAC7B,MAA2C;QAE3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACvB,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAA;IACjC,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,KAAK,CAAA;IAC5C,CAAC;IAED,IAAW,GAAG;QACZ,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAE/B,MAAM,UAAU,GACd,OAAO,MAAM,CAAC,QAAQ,CAAC,gBAAgB,KAAK,UAAU;YACpD,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB;YAClC,CAAC,CAAC,wBAAwB,CAAA;QAE9B,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAA;QAE1D,MAAM,IAAI,GACR,IAAI,CAAC,MAAM,IAAI,IAAI;YACjB,CAAC,CAAC,IAAI,CAAC,QAAQ;YACf,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAA;QAEnD,OAAO,IAAI,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC,CAAA;IACpC,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;YAC1C,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ;YACvB,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAA;IACjC,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;IAC1B,CAAC;IAED,KAAK,CAAC,OAAO;QAGX,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QAM3C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,SAAqB,CAAA;QAC9B,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAwB,CAAA;QAE9D,IAAI,IAAI,CAAC,WAAW,KAAK,gBAAgB,EAAE,CAAC;YAC1C,MAAM,oBAAoB,GACxB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,oBAAoB;gBAC1C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAA;YAE5C,IAAI,oBAAoB,KAAK,KAAK,EAAE,CAAC;gBACnC,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,IAAI,EAAE,CAAC;oBACxC,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAA;gBACH,CAAC;gBACD,MAAM,aAAa,GAAG,MAAM,oBAAoB,CAC9C,IAAgC,EAChC,IAAI,CAAC,OAAO,CAAC,cAAc,EAC3B,OAAO,oBAAoB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CACtE,CAAA;gBACD,OAAO,aAAyB,CAAA;YAClC,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,4BAA4B,CAC1B,IAAI,CAAC,OAAO,CAAC,UAAU,EACvB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,OAAO,CAAC,qBAAqB,IAAI,KAAK,EAC3C,IAAI,CAAC,OAAO,CAAC,sBAAsB,IAAI,EAAE,CAC1C,CAAA;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAC/B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACpC,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAA;QACF,OAAO,QAAQ,CAAC,IAA4B,CAAA;IAC9C,CAAC;IAED,KAAK,CAAC,IAAI,CAMR,WAOa,EACb,UAGa;QAEb,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;IAC3D,CAAC;IAED,KAAK,CAAC,KAAK,CACT,UAC0E;QAO1E,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IAC/C,CAAC;IAED,KAAK,CAAC,OAAO,CACX,SAA2C;QAI3C,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAChD,CAAC;CACF;AAED,MAAM,YAAY,GAAG,CAAC,KAAa,EAAU,EAAE;IAC7C,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAA;QACrC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC9C,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,IAAI,UAAU,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAA;QAC5D,OAAO,IAAI,GAAG,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;aACvD,QAAQ,EAAE;aACV,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACvB,CAAC;IACD,MAAM,IAAI,KAAK,CACb,8BAA8B,KAAK,+BAA+B,CACnE,CAAA;AACH,CAAC,CAAA;AAED,2DAA2D;AAC3D,kDAAkD;AAClD,MAAM,WAAW,GAAG,CAAC,KAAa,EAAW,EAAE;IAC7C,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAA;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA"}
+{"version":3,"file":"seam-http-request.js","sourceRoot":"","sources":["../src/lib/seam-http-request.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAA;AACtE,OAAO,EAEL,oBAAoB,GACrB,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAqB5E;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,eAAe;IAMjB,CAAC,MAAM,CAAC,WAAW,CAAC,GAAW,iBAAiB,CAAA;IAEhD,OAAO,CAAuB;IAC9B,OAAO,CAAqC;IAErD,YACE,MAA6B,EAC7B,MAA2C;QAE3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACvB,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAA;IACjC,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,KAAK,CAAA;IAC5C,CAAC;IAED;;OAEG;IACH,IAAW,GAAG;QACZ,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAE/B,MAAM,UAAU,GACd,OAAO,MAAM,CAAC,QAAQ,CAAC,gBAAgB,KAAK,UAAU;YACpD,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB;YAClC,CAAC,CAAC,wBAAwB,CAAA;QAE9B,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAA;QAE1D,MAAM,IAAI,GACR,IAAI,CAAC,MAAM,IAAI,IAAI;YACjB,CAAC,CAAC,IAAI,CAAC,QAAQ;YACf,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAA;QAEnD,OAAO,IAAI,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC,CAAA;IACpC,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;YAC1C,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ;YACvB,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAA;IACjC,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO;QAGX,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QAM3C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,SAAqB,CAAA;QAC9B,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAwB,CAAA;QAE9D,IAAI,IAAI,CAAC,WAAW,KAAK,gBAAgB,EAAE,CAAC;YAC1C,MAAM,oBAAoB,GACxB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,oBAAoB;gBAC1C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAA;YAE5C,IAAI,oBAAoB,KAAK,KAAK,EAAE,CAAC;gBACnC,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,IAAI,EAAE,CAAC;oBACxC,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAA;gBACH,CAAC;gBACD,MAAM,aAAa,GAAG,MAAM,oBAAoB,CAC9C,IAAgC,EAChC,IAAI,CAAC,OAAO,CAAC,cAAc,EAC3B,OAAO,oBAAoB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CACtE,CAAA;gBACD,OAAO,aAAyB,CAAA;YAClC,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa;QACjB,4BAA4B,CAC1B,IAAI,CAAC,OAAO,CAAC,UAAU,EACvB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,OAAO,CAAC,qBAAqB,IAAI,KAAK,EAC3C,IAAI,CAAC,OAAO,CAAC,sBAAsB,IAAI,EAAE,CAC1C,CAAA;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAC/B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACpC,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAA;QACF,OAAO,QAAQ,CAAC,IAA4B,CAAA;IAC9C,CAAC;IAED,KAAK,CAAC,IAAI,CAMR,WAOa,EACb,UAGa;QAEb,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;IAC3D,CAAC;IAED,KAAK,CAAC,KAAK,CACT,UAC0E;QAO1E,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IAC/C,CAAC;IAED,KAAK,CAAC,OAAO,CACX,SAA2C;QAI3C,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAChD,CAAC;CACF;AAED,MAAM,YAAY,GAAG,CAAC,KAAa,EAAU,EAAE;IAC7C,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAA;QACrC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC9C,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,IAAI,UAAU,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAA;QAC5D,OAAO,IAAI,GAAG,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;aACvD,QAAQ,EAAE;aACV,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACvB,CAAC;IACD,MAAM,IAAI,KAAK,CACb,8BAA8B,KAAK,+BAA+B,CACnE,CAAA;AACH,CAAC,CAAA;AAED,2DAA2D;AAC3D,kDAAkD;AAClD,MAAM,WAAW,GAAG,CAAC,KAAa,EAAW,EAAE;IAC7C,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAA;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA"}

package/lib/seam-paginator.d.ts

@@ -6,6 +6,9 @@ interface SeamPaginatorParent {
     readonly defaults: Required<SeamHttpRequestOptions>;
 }
 declare const $brand: unique symbol;
+/**
+ * Opaque cursor identifying a page of results returned by the Seam API.
+ */
 export type SeamPageCursor = string & {
     [$brand]: 'SeamPageCursor';
 };
@@ -14,16 +17,41 @@ interface Pagination {
     readonly nextPageCursor: SeamPageCursor | null;
     readonly nextPageUrl: string | null;
 }
+/**
+ * Iterates over paginated results from Seam API list endpoints.
+ *
+ * Create a SeamPaginator with the client's `createPaginator` method.
+ * Fetch pages manually with `firstPage` and `nextPage`,
+ * iterate over pages with `for await`,
+ * iterate over items across all pages with `flatten`,
+ * or collect every item into a single array with `flattenToArray`.
+ */
 export declare class SeamPaginator<const TResponse, const TResponseKey extends keyof TResponse> implements AsyncIterable<EnsureReadonlyArray<TResponse[TResponseKey]>> {
     #private;
     constructor(parent: SeamPaginatorParent, request: SeamHttpRequest<TResponse, TResponseKey>);
+    /**
+     * Fetches the first page of results along with the pagination state.
+     */
     firstPage(): Promise<[
         EnsureReadonlyArray<TResponse[TResponseKey]>,
         Pagination
     ]>;
+    /**
+     * Fetches the next page of results
+     * using the nextPageCursor returned with a previous page.
+     */
     nextPage(nextPageCursor: Pagination['nextPageCursor']): Promise<[EnsureReadonlyArray<TResponse[TResponseKey]>, Pagination]>;
+    /**
+     * Fetches every page and returns all items in a single array.
+     */
     flattenToArray(): Promise<EnsureReadonlyArray<TResponse[TResponseKey]>>;
+    /**
+     * Yields each item across all pages, fetching the next page as needed.
+     */
     flatten(): AsyncGenerator<EnsureReadonlyArray<TResponse[TResponseKey]>>;
+    /**
+     * Yields each page of items, fetching the next page as needed.
+     */
     [Symbol.asyncIterator](): AsyncGenerator<EnsureReadonlyArray<TResponse[TResponseKey]>>;
 }
 type EnsureReadonlyArray<T> = T extends readonly any[] ? T : never;

package/lib/seam-paginator.js

@@ -1,4 +1,13 @@
 import { SeamHttpRequest } from './seam-http-request.js';
+/**
+ * Iterates over paginated results from Seam API list endpoints.
+ *
+ * Create a SeamPaginator with the client's `createPaginator` method.
+ * Fetch pages manually with `firstPage` and `nextPage`,
+ * iterate over pages with `for await`,
+ * iterate over items across all pages with `flatten`,
+ * or collect every item into a single array with `flattenToArray`.
+ */
 export class SeamPaginator {
     #request;
     #parent;
@@ -9,9 +18,16 @@ export class SeamPaginator {
         this.#parent = parent;
         this.#request = request;
     }
+    /**
+     * Fetches the first page of results along with the pagination state.
+     */
     async firstPage() {
         return await this.#fetch();
     }
+    /**
+     * Fetches the next page of results
+     * using the nextPageCursor returned with a previous page.
+     */
     async nextPage(nextPageCursor) {
         if (nextPageCursor == null) {
             throw new Error('Cannot get the next page with a null nextPageCursor');
@@ -54,6 +70,9 @@ export class SeamPaginator {
             pagination,
         ];
     }
+    /**
+     * Fetches every page and returns all items in a single array.
+     */
     async flattenToArray() {
         const items = [];
         let [current, pagination] = await this.firstPage();
@@ -65,6 +84,9 @@ export class SeamPaginator {
         }
         return items;
     }
+    /**
+     * Yields each item across all pages, fetching the next page as needed.
+     */
     async *flatten() {
         let [current, pagination] = await this.firstPage();
         for (const item of current) {
@@ -78,6 +100,9 @@ export class SeamPaginator {
             }
         }
     }
+    /**
+     * Yields each page of items, fetching the next page as needed.
+     */
     async *[Symbol.asyncIterator]() {
         let [current, pagination] = await this.firstPage();
         yield current;

package/lib/seam-paginator.js.map

@@ -1 +1 @@
-{"version":3,"file":"seam-paginator.js","sourceRoot":"","sources":["../src/lib/seam-paginator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAiBxD,MAAM,OAAO,aAAa;IAIf,QAAQ,CAA0C;IAClD,OAAO,CAAqB;IAErC,YACE,MAA2B,EAC3B,OAAiD;QAEjD,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,OAAO,OAAO,CAAC,QAAQ,uCAAuC,CAC/D,CAAA;QACH,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;IACzB,CAAC;IAED,KAAK,CAAC,SAAS;QAGb,OAAO,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;IAC5B,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,cAA4C;QAE5C,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;QACxE,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,MAAM,CACV,cAA6C;QAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAA;QAE7C,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QACrE,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,eAAe,CAA0B,IAAI,CAAC,OAAO,EAAE;YACzE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ;YAChC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,WAAW;YACX,MAAM,EACJ,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI;gBAC1B,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE;gBAC1D,CAAC,CAAC,SAAS;YACf,IAAI,EACF,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI;gBACxB,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,cAAc,EAAE;gBACxD,CAAC,CAAC,SAAS;SAChB,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;QAC9C,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAA;QAElC,MAAM,cAAc,GAClB,QAAQ,IAAI,IAAI;YAChB,OAAO,QAAQ,KAAK,QAAQ;YAC5B,YAAY,IAAI,QAAQ;YACtB,CAAC,CAAE,QAAQ,CAAC,UAA6B;YACzC,CAAC,CAAC,IAAI,CAAA;QAEV,MAAM,UAAU,GAAe;YAC7B,WAAW,EAAE,cAAc,EAAE,aAAa,IAAI,KAAK;YACnD,cAAc,EAAE,cAAc,EAAE,gBAAgB,IAAI,IAAI;YACxD,WAAW,EAAE,cAAc,EAAE,aAAa,IAAI,IAAI;SACnD,CAAA;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,kCAAkC,MAAM,CAAC,WAAW,CAAC,YAAY,MAAM,CAAC,OAAO,IAAI,CAAC,EAAE,CACvF,CAAA;QACH,CAAC;QAED,OAAO;YACL,IAAoD;YACpD,UAAU;SACF,CAAA;IACZ,CAAC;IAED,KAAK,CAAC,cAAc;QAGlB,MAAM,KAAK,GAAG,EAAiD,CAAA;QAC/D,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACtB,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,CAAC;QACD,OAAO,KAAqD,CAAA;IAC9D,CAAC;IAED,KAAK,CAAC,CAAC,OAAO;QAGZ,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,CAAA;QACZ,CAAC;QACD,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;gBAC3B,MAAM,IAAI,CAAA;YACZ,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAG3B,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,MAAM,OAAO,CAAA;QACb,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,MAAM,OAAO,CAAA;QACf,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"seam-paginator.js","sourceRoot":"","sources":["../src/lib/seam-paginator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAoBxD;;;;;;;;GAQG;AACH,MAAM,OAAO,aAAa;IAIf,QAAQ,CAA0C;IAClD,OAAO,CAAqB;IAErC,YACE,MAA2B,EAC3B,OAAiD;QAEjD,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,OAAO,OAAO,CAAC,QAAQ,uCAAuC,CAC/D,CAAA;QACH,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;IACzB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS;QAGb,OAAO,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CACZ,cAA4C;QAE5C,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;QACxE,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,MAAM,CACV,cAA6C;QAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAA;QAE7C,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QACrE,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,eAAe,CAA0B,IAAI,CAAC,OAAO,EAAE;YACzE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ;YAChC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,WAAW;YACX,MAAM,EACJ,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI;gBAC1B,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE;gBAC1D,CAAC,CAAC,SAAS;YACf,IAAI,EACF,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI;gBACxB,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,cAAc,EAAE;gBACxD,CAAC,CAAC,SAAS;SAChB,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;QAC9C,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAA;QAElC,MAAM,cAAc,GAClB,QAAQ,IAAI,IAAI;YAChB,OAAO,QAAQ,KAAK,QAAQ;YAC5B,YAAY,IAAI,QAAQ;YACtB,CAAC,CAAE,QAAQ,CAAC,UAA6B;YACzC,CAAC,CAAC,IAAI,CAAA;QAEV,MAAM,UAAU,GAAe;YAC7B,WAAW,EAAE,cAAc,EAAE,aAAa,IAAI,KAAK;YACnD,cAAc,EAAE,cAAc,EAAE,gBAAgB,IAAI,IAAI;YACxD,WAAW,EAAE,cAAc,EAAE,aAAa,IAAI,IAAI;SACnD,CAAA;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,kCAAkC,MAAM,CAAC,WAAW,CAAC,YAAY,MAAM,CAAC,OAAO,IAAI,CAAC,EAAE,CACvF,CAAA;QACH,CAAC;QAED,OAAO;YACL,IAAoD;YACpD,UAAU;SACF,CAAA;IACZ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc;QAGlB,MAAM,KAAK,GAAG,EAAiD,CAAA;QAC/D,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACtB,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,CAAC;QACD,OAAO,KAAqD,CAAA;IAC9D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,CAAC,OAAO;QAGZ,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,CAAA;QACZ,CAAC;QACD,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;gBAC3B,MAAM,IAAI,CAAA;YACZ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAG3B,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,MAAM,OAAO,CAAA;QACb,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,MAAM,OAAO,CAAA;QACf,CAAC;IACH,CAAC;CACF"}

package/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const seamapiJavascriptHttpVersion = "2.18.0";
+declare const seamapiJavascriptHttpVersion = "2.20.0";
 export default seamapiJavascriptHttpVersion;

package/lib/version.js

@@ -1,3 +1,3 @@
-const seamapiJavascriptHttpVersion = '2.18.0';
+const seamapiJavascriptHttpVersion = '2.20.0';
 export default seamapiJavascriptHttpVersion;
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/http",
-  "version": "2.18.0",
+  "version": "2.20.0",
   "description": "JavaScript HTTP client for the Seam API written in TypeScript.",
   "type": "module",
   "main": "index.js",
@@ -87,7 +87,7 @@
     "@seamapi/blueprint": "^1.8.0",
     "@seamapi/fake-seam-connect": "^2.0.4",
     "@seamapi/smith": "^1.1.0",
-    "@seamapi/types": "1.1028.0",
+    "@seamapi/types": "1.1030.0",
     "@types/jsonwebtoken": "^9.0.6",
     "@types/node": "^24.10.9",
     "ava": "^8.0.1",
@@ -97,6 +97,7 @@
     "eslint": "^9.31.0",
     "eslint-import-resolver-typescript": "^4.4.5",
     "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsdoc": "^64.1.0",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unused-imports": "^4.1.4",
     "execa": "^10.0.0",

package/src/index.ts

@@ -1 +1,6 @@
+/**
+ * JavaScript HTTP client for the Seam API written in TypeScript.
+ *
+ * @packageDocumentation
+ */
 export * from './lib/index.js'

package/src/lib/client.ts

@@ -13,8 +13,22 @@ export type Client = AxiosInstance
 export const defaultTimeout = 30_000
 
 export interface ClientOptions {
+  /**
+   * Request timeout in milliseconds, applied per attempt.
+   * Set to 0 to disable the timeout. Defaults to 30 seconds.
+   */
   timeout?: number
+
+  /**
+   * Options passed to the underlying Axios client.
+   */
   axiosOptions?: AxiosRequestConfig
+
+  /**
+   * Options passed to axios-retry,
+   * which retries idempotent requests that fail
+   * because of a transport error, timeout, or HTTP 429 response.
+   */
   axiosRetryOptions?: AxiosRetryConfig
 }
 

package/src/lib/index.ts

@@ -3,12 +3,15 @@ export * from './error-interceptor.js'
 export * from './openapi.js'
 export * from './options.js'
 export {
+  type FailedActionAttempt,
   isSeamActionAttemptError,
   isSeamActionAttemptFailedError,
   isSeamActionAttemptTimeoutError,
+  type ResolveActionAttemptOptions,
   SeamActionAttemptError,
   SeamActionAttemptFailedError,
   SeamActionAttemptTimeoutError,
+  type SucceededActionAttempt,
 } from './resolve-action-attempt.js'
 export * from './resources/index.js'
 export * from './routes/index.js'

package/src/lib/options.ts

@@ -6,12 +6,19 @@ import {
 
 export type { SeamHttpRequestOptions } from './request-options.js'
 
+/**
+ * Options for creating a SeamHttpWithoutWorkspace client,
+ * which is not scoped to a single workspace.
+ */
 export type SeamHttpWithoutWorkspaceOptions =
   | SeamHttpWithoutWorkspaceOptionsFromEnv
   | SeamHttpWithoutWorkspaceOptionsWithClient
   | SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken
   | SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken
 
+/**
+ * Options for creating a SeamHttp client.
+ */
 export type SeamHttpOptions =
   | SeamHttpOptionsFromEnv
   | SeamHttpOptionsWithClient
@@ -21,28 +28,62 @@ export type SeamHttpOptions =
   | SeamHttpOptionsWithPersonalAccessToken
 
 interface SeamHttpCommonOptions extends ClientOptions, SeamHttpRequestOptions {
+  /**
+   * The Seam API endpoint, e.g., `https://connect.getseam.com`.
+   * Defaults to the SEAM_ENDPOINT or SEAM_API_URL environment variable, if set.
+   */
   endpoint?: string
 }
 
+/**
+ * Options for creating a SeamHttp client with `SeamHttp.fromPublishableKey`.
+ */
 export interface SeamHttpFromPublishableKeyOptions extends SeamHttpCommonOptions {}
 
+/**
+ * Options for creating a SeamHttp client that reads its configuration
+ * from the environment, e.g., the SEAM_API_KEY environment variable.
+ */
 export interface SeamHttpOptionsFromEnv extends SeamHttpCommonOptions {}
 
+/**
+ * Options for creating a SeamHttpWithoutWorkspace client that reads
+ * its configuration from the environment,
+ * e.g., the SEAM_PERSONAL_ACCESS_TOKEN environment variable.
+ */
 export interface SeamHttpWithoutWorkspaceOptionsFromEnv extends SeamHttpCommonOptions {}
 
+/**
+ * Options for creating a SeamHttpWithoutWorkspace client from an existing client.
+ */
 export interface SeamHttpWithoutWorkspaceOptionsWithClient extends SeamHttpCommonOptions {
   client: Client
 }
 
+/**
+ * Returns true if the options include a client.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the client option
+ * is used with any other option.
+ */
 export const isSeamHttpWithoutWorkspaceOptionsWithClient = (
   options: SeamHttpOptions,
 ): options is SeamHttpWithoutWorkspaceOptionsWithClient =>
   isSeamHttpOptionsWithClient(options)
 
+/**
+ * Options for creating a SeamHttp client from an existing client.
+ */
 export interface SeamHttpOptionsWithClient extends SeamHttpRequestOptions {
   client: Client
 }
 
+/**
+ * Returns true if the options include a client.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the client option
+ * is used with any other option.
+ */
 export const isSeamHttpOptionsWithClient = (
   options: SeamHttpOptions,
 ): options is SeamHttpOptionsWithClient => {
@@ -61,10 +102,19 @@ export const isSeamHttpOptionsWithClient = (
   return true
 }
 
+/**
+ * Options for creating a SeamHttp client authenticated with an API key.
+ */
 export interface SeamHttpOptionsWithApiKey extends SeamHttpCommonOptions {
   apiKey: string
 }
 
+/**
+ * Returns true if the options include an apiKey.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the apiKey option
+ * is used with another authentication option.
+ */
 export const isSeamHttpOptionsWithApiKey = (
   options: SeamHttpOptions,
 ): options is SeamHttpOptionsWithApiKey => {
@@ -92,10 +142,19 @@ export const isSeamHttpOptionsWithApiKey = (
   return true
 }
 
+/**
+ * Options for creating a SeamHttp client authenticated with a client session token.
+ */
 export interface SeamHttpOptionsWithClientSessionToken extends SeamHttpCommonOptions {
   clientSessionToken: string
 }
 
+/**
+ * Returns true if the options include a clientSessionToken.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the clientSessionToken option
+ * is used with another authentication option.
+ */
 export const isSeamHttpOptionsWithClientSessionToken = (
   options: SeamHttpOptions,
 ): options is SeamHttpOptionsWithClientSessionToken => {
@@ -123,10 +182,20 @@ export const isSeamHttpOptionsWithClientSessionToken = (
   return true
 }
 
+/**
+ * Options for creating a SeamHttpWithoutWorkspace client
+ * authenticated with a console session token.
+ */
 export interface SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken extends SeamHttpCommonOptions {
   consoleSessionToken: string
 }
 
+/**
+ * Returns true if the options include a consoleSessionToken.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the consoleSessionToken option
+ * is used with another authentication option.
+ */
 export const isSeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken = (
   options: SeamHttpOptions,
 ): options is SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken => {
@@ -154,11 +223,21 @@ export const isSeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken = (
   return true
 }
 
+/**
+ * Options for creating a SeamHttp client
+ * authenticated with a console session token and scoped to a workspace.
+ */
 export interface SeamHttpOptionsWithConsoleSessionToken extends SeamHttpCommonOptions {
   consoleSessionToken: string
   workspaceId: string
 }
 
+/**
+ * Returns true if the options include a consoleSessionToken and a workspaceId.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the consoleSessionToken option
+ * is used with another authentication option or without the workspaceId option.
+ */
 export const isSeamHttpOptionsWithConsoleSessionToken = (
   options: SeamHttpOptions,
 ): options is SeamHttpOptionsWithConsoleSessionToken => {
@@ -175,10 +254,20 @@ export const isSeamHttpOptionsWithConsoleSessionToken = (
   return true
 }
 
+/**
+ * Options for creating a SeamHttpWithoutWorkspace client
+ * authenticated with a personal access token.
+ */
 export interface SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken extends SeamHttpCommonOptions {
   personalAccessToken: string
 }
 
+/**
+ * Returns true if the options include a personalAccessToken.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the personalAccessToken option
+ * is used with another authentication option.
+ */
 export const isSeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken = (
   options: SeamHttpOptions,
 ): options is SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken => {
@@ -206,11 +295,21 @@ export const isSeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken = (
   return true
 }
 
+/**
+ * Options for creating a SeamHttp client
+ * authenticated with a personal access token and scoped to a workspace.
+ */
 export interface SeamHttpOptionsWithPersonalAccessToken extends SeamHttpCommonOptions {
   personalAccessToken: string
   workspaceId: string
 }
 
+/**
+ * Returns true if the options include a personalAccessToken and a workspaceId.
+ *
+ * @throws {@link SeamHttpInvalidOptionsError} if the personalAccessToken option
+ * is used with another authentication option or without the workspaceId option.
+ */
 export const isSeamHttpOptionsWithPersonalAccessToken = (
   options: SeamHttpOptions,
 ): options is SeamHttpOptionsWithPersonalAccessToken => {
@@ -227,6 +326,9 @@ export const isSeamHttpOptionsWithPersonalAccessToken = (
   return true
 }
 
+/**
+ * Error thrown when a SeamHttp client is created with invalid options.
+ */
 export class SeamHttpInvalidOptionsError extends Error {
   constructor(message: string) {
     super(`SeamHttp received invalid options: ${message}`)
@@ -234,6 +336,9 @@ export class SeamHttpInvalidOptionsError extends Error {
   }
 }
 
+/**
+ * Error thrown when a SeamHttpWithoutWorkspace client is created with invalid options.
+ */
 export class SeamHttpWithoutWorkspaceInvalidOptionsError extends Error {
   constructor(message: string) {
     super(`SeamHttpWithoutWorkspace received invalid options: ${message}`)