@tolt/api 0.7.0 → 1.1.0

package/dist/core/fetcher/getResponseBody.js

@@ -9,6 +9,19 @@ function retainResponse(target, response) {
         writable: false,
     });
 }
+const responseBodyErrors = new WeakSet();
+function responseBodyError(error) {
+    const record = { ok: false, error };
+    responseBodyErrors.add(record);
+    return record;
+}
+/**
+ * Returns true when `value` is a failure record created by `getResponseBody` (for example malformed JSON),
+ * as opposed to a parsed JSON body that happens to have the same shape.
+ */
+export function isResponseBodyError(value) {
+    return typeof value === "object" && value != null && responseBodyErrors.has(value);
+}
 export async function getResponseBody(response, responseType) {
     switch (responseType) {
         case "binary-response":
@@ -19,25 +32,19 @@ export async function getResponseBody(response, responseType) {
             return await response.arrayBuffer();
         case "sse":
             if (response.body == null) {
-                return {
-                    ok: false,
-                    error: {
-                        reason: "body-is-null",
-                        statusCode: response.status,
-                    },
-                };
+                return responseBodyError({
+                    reason: "body-is-null",
+                    statusCode: response.status,
+                });
             }
             retainResponse(response.body, response);
             return response.body;
         case "streaming":
             if (response.body == null) {
-                return {
-                    ok: false,
-                    error: {
-                        reason: "body-is-null",
-                        statusCode: response.status,
-                    },
-                };
+                return responseBodyError({
+                    reason: "body-is-null",
+                    statusCode: response.status,
+                });
             }
             retainResponse(response.body, response);
             return response.body;
@@ -52,14 +59,11 @@ export async function getResponseBody(response, responseType) {
             return responseBody;
         }
         catch (_err) {
-            return {
-                ok: false,
-                error: {
-                    reason: "non-json",
-                    statusCode: response.status,
-                    rawBody: text,
-                },
-            };
+            return responseBodyError({
+                reason: "non-json",
+                statusCode: response.status,
+                rawBody: text,
+            });
         }
     }
     return undefined;

package/dist/core/fetcher/makePassthroughRequest.js

@@ -6,6 +6,7 @@ import { makeRequest } from "./makeRequest.js";
 import { redactUrl } from "./redactUrl.js";
 import { requestWithRetries } from "./requestWithRetries.js";
 import { Supplier } from "./Supplier.js";
+import { TIMEOUT } from "./signals.js";
 /**
  * Makes a passthrough HTTP request using the SDK's configuration (auth, retry, logging, etc.)
  * while mimicking the standard `fetch` API.
@@ -109,8 +110,18 @@ export async function makePassthroughRequest(input, init, clientOptions, request
             hasBody: body != null,
         });
     }
-    const response = await requestWithRetries(async () => makeRequest(fetchFn, fullUrl, method, mergedHeaders, body ?? undefined, timeoutMs, abortSignal, effectiveInit?.credentials === "include", undefined, // duplex
-    false), maxRetries);
+    let response;
+    try {
+        response = await requestWithRetries(async () => makeRequest(fetchFn, fullUrl, method, mergedHeaders, body ?? undefined, timeoutMs, abortSignal, effectiveInit?.credentials === "include", undefined, // duplex
+        false), maxRetries, abortSignal);
+    }
+    catch (error) {
+        // Match `fetch`: a timeout rejects with an Error named "TimeoutError", not the bare abort reason.
+        if (error === TIMEOUT) {
+            throw createTimeoutError();
+        }
+        throw error;
+    }
     if (logger.isDebug()) {
         logger.debug("Passthrough HTTP request completed", {
             method,
@@ -120,6 +131,11 @@ export async function makePassthroughRequest(input, init, clientOptions, request
     }
     return response;
 }
+function createTimeoutError() {
+    const error = new Error("The request timed out.");
+    error.name = "TimeoutError";
+    return error;
+}
 /**
  * Returns true when the resolved request URL points at the same origin as the
  * configured base URL. Relative paths are always joined onto the base URL, so

package/dist/core/fetcher/makeRequest.d.ts

@@ -3,4 +3,9 @@ export declare function isCacheNoStoreSupported(): boolean;
  * Reset the cached result of `isCacheNoStoreSupported`. Exposed for testing only.
  */
 export declare function resetCacheNoStoreSupported(): void;
-export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Headers | Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half", disableCache?: boolean) => Promise<Response>;
+/**
+ * Clears the timeout that `makeRequest` kept running (with `keepTimeoutUntilBodyRead`) so that it also
+ * covered reading the response body.
+ */
+export declare function clearResponseTimeout(response: Response): void;
+export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Headers | Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half", disableCache?: boolean, keepTimeoutUntilBodyRead?: boolean) => Promise<Response>;

package/dist/core/fetcher/makeRequest.js

@@ -1,4 +1,4 @@
-import { anySignal, getTimeoutSignal } from "./signals.js";
+import { anySignal, getTimeoutSignal, TIMEOUT } from "./signals.js";
 /**
  * Cached result of checking whether the current runtime supports
  * the `cache` option in `Request`. Some runtimes (e.g. Cloudflare Workers)
@@ -24,30 +24,62 @@ export function isCacheNoStoreSupported() {
 export function resetCacheNoStoreSupported() {
     _cacheNoStoreSupported = undefined;
 }
-export const makeRequest = async (fetchFn, url, method, headers, requestBody, timeoutMs, abortSignal, withCredentials, duplex, disableCache) => {
+const responseTimeouts = new WeakMap();
+/**
+ * Clears the timeout that `makeRequest` kept running (with `keepTimeoutUntilBodyRead`) so that it also
+ * covered reading the response body.
+ */
+export function clearResponseTimeout(response) {
+    const timeoutId = responseTimeouts.get(response);
+    if (timeoutId != null) {
+        clearTimeout(timeoutId);
+        responseTimeouts.delete(response);
+    }
+}
+export const makeRequest = async (fetchFn, url, method, headers, requestBody, timeoutMs, abortSignal, withCredentials, duplex, disableCache, keepTimeoutUntilBodyRead) => {
     const signals = [];
     let timeoutAbortId;
+    let timeoutSignal;
     if (timeoutMs != null) {
         const { signal, abortId } = getTimeoutSignal(timeoutMs);
         timeoutAbortId = abortId;
+        timeoutSignal = signal;
         signals.push(signal);
     }
     if (abortSignal != null) {
         signals.push(abortSignal);
     }
     const newSignals = anySignal(signals);
-    const response = await fetchFn(url, {
-        method: method,
-        headers,
-        body: requestBody,
-        signal: newSignals,
-        credentials: withCredentials ? "include" : undefined,
-        // @ts-ignore
-        duplex,
-        ...(disableCache && isCacheNoStoreSupported() ? { cache: "no-store" } : {}),
-    });
+    let response;
+    try {
+        response = await fetchFn(url, {
+            method: method,
+            headers,
+            body: requestBody,
+            signal: newSignals,
+            credentials: withCredentials ? "include" : undefined,
+            // @ts-ignore
+            duplex,
+            ...(disableCache && isCacheNoStoreSupported() ? { cache: "no-store" } : {}),
+        });
+    }
+    catch (error) {
+        if (timeoutAbortId != null) {
+            clearTimeout(timeoutAbortId);
+        }
+        // Some runtimes (e.g. Node 18) reject with their own error instead of the abort reason.
+        if (timeoutSignal?.aborted && !abortSignal?.aborted) {
+            throw TIMEOUT;
+        }
+        throw error;
+    }
     if (timeoutAbortId != null) {
-        clearTimeout(timeoutAbortId);
+        if (keepTimeoutUntilBodyRead) {
+            responseTimeouts.set(response, timeoutAbortId);
+        }
+        else {
+            clearTimeout(timeoutAbortId);
+        }
     }
     return response;
 };

package/dist/core/fetcher/requestWithRetries.d.ts

@@ -1 +1 @@
-export declare function requestWithRetries(requestFn: () => Promise<Response>, maxRetries?: number): Promise<Response>;
+export declare function requestWithRetries(requestFn: () => Promise<Response>, maxRetries?: number, abortSignal?: AbortSignal): Promise<Response>;

package/dist/core/fetcher/requestWithRetries.js

@@ -40,12 +40,33 @@ function getRetryDelayFromHeaders(response, retryAttempt) {
     }
     return addSymmetricJitter(Math.min(INITIAL_RETRY_DELAY * 2 ** retryAttempt, MAX_RETRY_DELAY));
 }
-export async function requestWithRetries(requestFn, maxRetries = DEFAULT_MAX_RETRIES) {
+/**
+ * Waits `ms` milliseconds, or rejects as soon as `abortSignal` aborts. The timer and
+ * the abort listener are always removed, so a cancelled wait never keeps the process alive.
+ */
+function sleep(ms, abortSignal) {
+    return new Promise((resolve, reject) => {
+        if (abortSignal?.aborted) {
+            reject(abortSignal.reason);
+            return;
+        }
+        const onAbort = () => {
+            clearTimeout(timeoutId);
+            reject(abortSignal?.reason);
+        };
+        const timeoutId = setTimeout(() => {
+            abortSignal?.removeEventListener("abort", onAbort);
+            resolve();
+        }, ms);
+        abortSignal?.addEventListener("abort", onAbort, { once: true });
+    });
+}
+export async function requestWithRetries(requestFn, maxRetries = DEFAULT_MAX_RETRIES, abortSignal) {
     let response = await requestFn();
     for (let i = 0; i < maxRetries; ++i) {
         if (isRetryableStatusCode(response.status)) {
             const delay = getRetryDelayFromHeaders(response, i);
-            await new Promise((resolve) => setTimeout(resolve, delay));
+            await sleep(delay, abortSignal);
             response = await requestFn();
         }
         else {

package/dist/core/fetcher/signals.d.ts

@@ -1,3 +1,4 @@
+export declare const TIMEOUT = "timeout";
 export declare function getTimeoutSignal(timeoutMs: number): {
     signal: AbortSignal;
     abortId: ReturnType<typeof setTimeout>;

package/dist/core/fetcher/signals.js

@@ -1,4 +1,4 @@
-const TIMEOUT = "timeout";
+export const TIMEOUT = "timeout";
 export function getTimeoutSignal(timeoutMs) {
     const controller = new AbortController();
     const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);

package/dist/core/index.d.ts

@@ -2,5 +2,7 @@ export * from "./auth/index.js";
 export * from "./base64.js";
 export * from "./fetcher/index.js";
 export * as logging from "./logging/index.js";
+export * from "./pagination/index.js";
 export * from "./runtime/index.js";
 export * as url from "./url/index.js";
+export * from "./utils/index.js";

package/dist/core/index.js

@@ -2,5 +2,7 @@ export * from "./auth/index.js";
 export * from "./base64.js";
 export * from "./fetcher/index.js";
 export * as logging from "./logging/index.js";
+export * from "./pagination/index.js";
 export * from "./runtime/index.js";
 export * as url from "./url/index.js";
+export * from "./utils/index.js";

package/dist/core/pagination/Page.d.ts

@@ -0,0 +1,33 @@
+import type { HttpResponsePromise, RawResponse } from "../fetcher/index.js";
+/**
+ * A page of results from a paginated API.
+ *
+ * @template T The type of the items in the page.
+ * @template R The type of the API response.
+ */
+export declare class Page<T, R = unknown> implements AsyncIterable<T> {
+    data: T[];
+    rawResponse: RawResponse;
+    response: R;
+    private _hasNextPage;
+    private getItems;
+    private loadNextPage;
+    constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }: {
+        response: R;
+        rawResponse: RawResponse;
+        hasNextPage: (response: R) => boolean;
+        getItems: (response: R) => T[];
+        loadPage: (response: R) => HttpResponsePromise<R>;
+    });
+    /**
+     * Retrieves the next page
+     * @returns this
+     */
+    getNextPage(): Promise<this>;
+    /**
+     * @returns whether there is a next page to load
+     */
+    hasNextPage(): boolean;
+    private iterMessages;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
+}

package/dist/core/pagination/Page.js

@@ -0,0 +1,49 @@
+/**
+ * A page of results from a paginated API.
+ *
+ * @template T The type of the items in the page.
+ * @template R The type of the API response.
+ */
+export class Page {
+    constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }) {
+        this.response = response;
+        this.rawResponse = rawResponse;
+        this.data = getItems(response);
+        this._hasNextPage = hasNextPage;
+        this.getItems = getItems;
+        this.loadNextPage = loadPage;
+    }
+    /**
+     * Retrieves the next page
+     * @returns this
+     */
+    async getNextPage() {
+        const { data, rawResponse } = await this.loadNextPage(this.response).withRawResponse();
+        this.response = data;
+        this.rawResponse = rawResponse;
+        this.data = this.getItems(this.response);
+        return this;
+    }
+    /**
+     * @returns whether there is a next page to load
+     */
+    hasNextPage() {
+        return this._hasNextPage(this.response);
+    }
+    async *iterMessages() {
+        for (const item of this.data) {
+            yield item;
+        }
+        while (this.hasNextPage()) {
+            await this.getNextPage();
+            for (const item of this.data) {
+                yield item;
+            }
+        }
+    }
+    async *[Symbol.asyncIterator]() {
+        for await (const message of this.iterMessages()) {
+            yield message;
+        }
+    }
+}

package/dist/core/pagination/exports.d.ts

@@ -0,0 +1 @@
+export type { Page } from "./Page.js";

package/dist/core/pagination/index.d.ts

@@ -0,0 +1 @@
+export { Page } from "./Page.js";

package/dist/core/pagination/index.js

@@ -0,0 +1 @@
+export { Page } from "./Page.js";

package/dist/core/url/encodePathParam.d.ts

@@ -1 +1,3 @@
-export declare function encodePathParam(param: unknown): string;
+export declare function encodePathParam(param: unknown, InvalidPathParameterError?: new (args: {
+    message: string;
+}) => Error): string;

package/dist/core/url/encodePathParam.js

@@ -1,4 +1,4 @@
-export function encodePathParam(param) {
+export function encodePathParam(param, InvalidPathParameterError) {
     if (param === null) {
         return "null";
     }
@@ -14,5 +14,11 @@ export function encodePathParam(param) {
             param = String(param);
             break;
     }
-    return encodeURIComponent(param);
+    const encoded = encodeURIComponent(param);
+    // "." and ".." are dot segments: URL resolution would remove them and send the request to a different path.
+    if (encoded === "." || encoded === "..") {
+        const message = `Invalid path parameter "${encoded}": "." and ".." are not allowed because they change the request path.`;
+        throw InvalidPathParameterError != null ? new InvalidPathParameterError({ message }) : new Error(message);
+    }
+    return encoded;
 }

package/dist/core/utils/index.d.ts

@@ -0,0 +1 @@
+export { setObjectProperty } from "./setObjectProperty.js";

package/dist/core/utils/index.js

@@ -0,0 +1 @@
+export { setObjectProperty } from "./setObjectProperty.js";

package/dist/core/utils/setObjectProperty.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Returns a copy of object with the value at path set. If a portion of path doesn’t exist it’s created.
+ * Each object along path is shallow-copied, so the original object (and any nested objects it
+ * shares with the copy) is never modified. This is inspired by Lodash's set function, but is
+ * simplified to accommodate our use case. For more details, see https://lodash.com/docs/4.17.15#set.
+ *
+ * @param object The object to copy.
+ * @param path The path of the property to set.
+ * @param value The value to set.
+ * @return Returns the updated copy of object.
+ */
+export declare function setObjectProperty<T extends object>(object: T, path: string, value: any): T;

package/dist/core/utils/setObjectProperty.js

@@ -0,0 +1,45 @@
+/**
+ * Returns a copy of object with the value at path set. If a portion of path doesn’t exist it’s created.
+ * Each object along path is shallow-copied, so the original object (and any nested objects it
+ * shares with the copy) is never modified. This is inspired by Lodash's set function, but is
+ * simplified to accommodate our use case. For more details, see https://lodash.com/docs/4.17.15#set.
+ *
+ * @param object The object to copy.
+ * @param path The path of the property to set.
+ * @param value The value to set.
+ * @return Returns the updated copy of object.
+ */
+export function setObjectProperty(object, path, value) {
+    if (object == null) {
+        return object;
+    }
+    const keys = path.split(".");
+    if (keys.length === 0) {
+        // Invalid path; do nothing.
+        return object;
+    }
+    const result = { ...object };
+    let current = result;
+    for (let i = 0; i < keys.length - 1; i++) {
+        const key = keys[i];
+        if (key == null) {
+            // Unreachable.
+            continue;
+        }
+        const next = current[key];
+        if (Array.isArray(next)) {
+            current[key] = [...next];
+        }
+        else {
+            current[key] = next != null && typeof next === "object" ? { ...next } : {};
+        }
+        current = current[key];
+    }
+    const lastKey = keys[keys.length - 1];
+    if (lastKey == null) {
+        // Unreachable.
+        return result;
+    }
+    current[lastKey] = value;
+    return result;
+}

package/dist/environments.d.ts

@@ -1,4 +1,4 @@
 export declare const ToltApiEnvironment: {
-    readonly Default: "https://platform.tolt.dev";
+    readonly Default: "https://platform.tolt.com";
 };
 export type ToltApiEnvironment = typeof ToltApiEnvironment.Default;

package/dist/environments.js

@@ -1,4 +1,4 @@
 // This file was auto-generated by Fern from our API Definition.
 export const ToltApiEnvironment = {
-    Default: "https://platform.tolt.dev",
+    Default: "https://platform.tolt.com",
 };

package/dist/errors/ToltApiError.js

@@ -16,7 +16,21 @@ export class ToltApiError extends Error {
         }
     }
     get requestId() {
-        return this.rawResponse?.headers?.get("x-request-id") ?? undefined;
+        const headers = this.rawResponse?.headers;
+        if (headers == null) {
+            return undefined;
+        }
+        const requestId = headers.get("X-Request-Id");
+        if (requestId != null) {
+            return requestId;
+        }
+        let fallback;
+        headers.forEach((value, name) => {
+            if (fallback === undefined && /request[-_]?id$/i.test(name)) {
+                fallback = value;
+            }
+        });
+        return fallback;
     }
 }
 function buildMessage({ message, statusCode, body, }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolt/api",
-  "version": "0.7.0",
+  "version": "1.1.0",
   "description": "TypeScript SDK for the Tolt Public API",
   "license": "Apache-2.0",
   "repository": {
@@ -13,6 +13,9 @@
   },
   "type": "module",
   "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -31,11 +34,13 @@
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "test": "node --test test/client.test.mjs"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^7.0.0",
     "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/exec": "^7.1.0",
     "@semantic-release/git": "^11.0.1",
     "@semantic-release/github": "^12.0.9",
     "@semantic-release/npm": "^13.1.5",

package/dist/api/resources/clicks/types/CreateClicksRequest.d.ts

@@ -1 +0,0 @@
-export type CreateClicksRequest = unknown;

package/dist/api/resources/commissions/client/requests/UpdateCommissionsRequest.js

@@ -1,9 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-export var UpdateCommissionsRequest;
-(function (UpdateCommissionsRequest) {
-    UpdateCommissionsRequest.Status = {
-        Pending: "pending",
-        Approved: "approved",
-        Rejected: "rejected",
-    };
-})(UpdateCommissionsRequest || (UpdateCommissionsRequest = {}));

package/dist/api/resources/commissions/types/ApproveCommissionsResponse.d.ts

@@ -1,6 +0,0 @@
-import type * as ToltApi from "../../../index.js";
-export interface ApproveCommissionsResponse {
-    success: boolean;
-    message: string;
-    data: ToltApi.Commission;
-}

package/dist/api/resources/commissions/types/CreateCommissionsRequest.d.ts

@@ -1 +0,0 @@
-export type CreateCommissionsRequest = unknown;

package/dist/api/resources/commissions/types/DeclineCommissionsResponse.d.ts

@@ -1,6 +0,0 @@
-import type * as ToltApi from "../../../index.js";
-export interface DeclineCommissionsResponse {
-    success: boolean;
-    message: string;
-    data: ToltApi.Commission;
-}

package/dist/api/resources/embed/exports.d.ts

@@ -1,2 +0,0 @@
-export { EmbedClient } from "./client/Client.js";
-export * from "./client/index.js";

package/dist/api/resources/embed/types/CreateTokenEmbedRequest.d.ts

@@ -1 +0,0 @@
-export type CreateTokenEmbedRequest = unknown;

package/dist/api/resources/embed/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./CreateTokenEmbedRequest.js";
-export * from "./CreateTokenEmbedResponse.js";

package/dist/api/resources/embed/types/index.js

@@ -1,2 +0,0 @@
-export * from "./CreateTokenEmbedRequest.js";
-export * from "./CreateTokenEmbedResponse.js";

package/dist/api/resources/flows/types/ListFlowsRequestActive.d.ts

@@ -1,6 +0,0 @@
-/** true lists only active flows, false only paused flows, which do not run. */
-export declare const ListFlowsRequestActive: {
-    readonly True: "true";
-    readonly False: "false";
-};
-export type ListFlowsRequestActive = (typeof ListFlowsRequestActive)[keyof typeof ListFlowsRequestActive];

package/dist/api/resources/flows/types/ListFlowsRequestActive.js

@@ -1,6 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-/** true lists only active flows, false only paused flows, which do not run. */
-export const ListFlowsRequestActive = {
-    True: "true",
-    False: "false",
-};

package/dist/api/resources/groups/types/ListGroupsRequestDefault.d.ts

@@ -1,6 +0,0 @@
-/** true lists only default groups, where new partners are placed unless another group is chosen; false lists the others. */
-export declare const ListGroupsRequestDefault: {
-    readonly True: "true";
-    readonly False: "false";
-};
-export type ListGroupsRequestDefault = (typeof ListGroupsRequestDefault)[keyof typeof ListGroupsRequestDefault];

package/dist/api/resources/groups/types/ListGroupsRequestDefault.js

@@ -1,6 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-/** true lists only default groups, where new partners are placed unless another group is chosen; false lists the others. */
-export const ListGroupsRequestDefault = {
-    True: "true",
-    False: "false",
-};

package/dist/api/resources/links/types/GetByParamValueLinksResponse.d.ts

@@ -1,6 +0,0 @@
-import type * as ToltApi from "../../../index.js";
-export interface GetByParamValueLinksResponse {
-    success: boolean;
-    message: string;
-    data: ToltApi.Link;
-}

package/dist/api/resources/transactions/types/UpdateTransactionsResponse.d.ts

@@ -1,6 +0,0 @@
-import type * as ToltApi from "../../../index.js";
-export interface UpdateTransactionsResponse {
-    success: boolean;
-    message: string;
-    data: ToltApi.Transaction;
-}

package/dist/api/resources/transactions/types/UpdateTransactionsResponse.js

@@ -1,2 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-export {};