@zapier/zapier-sdk 0.8.2 → 0.8.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @zapier/zapier-sdk
 
+## 0.8.3
+
+### Patch Changes
+
+- ed235b6: Adds improved backoff logic to the API polling
+
 ## 0.8.2
 
 ### Patch Changes

package/dist/api/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAGjB,MAAM,SAAS,CAAC;AA4bjB,eAAO,MAAM,eAAe,GAAI,SAAS,gBAAgB,KAAG,SAqB3D,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAGjB,MAAM,SAAS,CAAC;AA6bjB,eAAO,MAAM,eAAe,GAAI,SAAS,gBAAgB,KAAG,SAqB3D,CAAC"}

package/dist/api/client.js

@@ -40,9 +40,8 @@ class ZapierApiClient {
                     searchParams: options.searchParams,
                     authRequired: options.authRequired,
                 }),
-                maxAttempts: options.maxAttempts,
                 initialDelay: options.initialDelay,
-                maxDelay: options.maxDelay,
+                timeoutMs: options.timeoutMs,
                 successStatus: options.successStatus,
                 pendingStatus: options.pendingStatus,
                 resultExtractor: options.resultExtractor,

package/dist/api/polling.d.ts

@@ -4,13 +4,43 @@
  * This module provides utilities for polling HTTP endpoints until completion,
  * with configurable retry logic and exponential backoff.
  */
-export declare function pollUntilComplete(options: {
+/**
+ * Options for the polling function
+ */
+export interface PollOptions<TResult = unknown> {
+    /** Function that performs the HTTP request */
     fetchPoll: () => Promise<Response>;
-    maxAttempts?: number;
-    initialDelay?: number;
-    maxDelay?: number;
+    /** Maximum time to wait for completion (in milliseconds) */
+    timeoutMs?: number;
+    /** HTTP status code indicating successful completion */
     successStatus?: number;
+    /** HTTP status code indicating the operation is still pending */
     pendingStatus?: number;
-    resultExtractor?: (response: any) => any;
-}): Promise<any>;
+    /** Function to extract the result from the response */
+    resultExtractor?: (response: unknown) => TResult;
+    /** Initial delay before the first poll attempt (in milliseconds) */
+    initialDelay?: number;
+}
+declare const enum PollStatus {
+    Success = "success",
+    Continue = "continue"
+}
+/**
+ * Result of a poll operation
+ */
+export type PollResult<TResult = unknown> = {
+    result?: TResult;
+    status: PollStatus;
+    errorCount: number;
+};
+/**
+ * Polls an endpoint until completion, timeout, or error
+ * @param options Configuration options for polling
+ * @returns The extracted result from the successful response
+ * @throws {ZapierValidationError} When the input parameters are invalid
+ * @throws {ZapierTimeoutError} When the operation times out
+ * @throws {ZapierApiError} When the API returns consecutive errors
+ */
+export declare function pollUntilComplete<TResult = unknown>(options: PollOptions<TResult>): Promise<TResult>;
+export {};
 //# sourceMappingURL=polling.d.ts.map

package/dist/api/polling.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"polling.d.ts","sourceRoot":"","sources":["../../src/api/polling.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,wBAAsB,iBAAiB,CAAC,OAAO,EAAE;IAC/C,SAAS,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,GAAG,CAAC;CAC1C,GAAG,OAAO,CAAC,GAAG,CAAC,CAuDf"}
+{"version":3,"file":"polling.d.ts","sourceRoot":"","sources":["../../src/api/polling.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA+BH;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,OAAO,GAAG,OAAO;IAC5C,8CAA8C;IAC9C,SAAS,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wDAAwD;IACxD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uDAAuD;IACvD,eAAe,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;IACjD,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,mBAAW,UAAU;IACnB,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,OAAO,GAAG,OAAO,IAAI;IAC1C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAuEF;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,GAAG,OAAO,EACvD,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,GAC5B,OAAO,CAAC,OAAO,CAAC,CAyGlB"}

package/dist/api/polling.js

@@ -4,42 +4,146 @@
  * This module provides utilities for polling HTTP endpoints until completion,
  * with configurable retry logic and exponential backoff.
  */
-import { ZapierTimeoutError, ZapierApiError } from "../types/errors";
+import { ZapierTimeoutError, ZapierApiError, ZapierValidationError, } from "../types/errors";
+import { setTimeout } from "timers/promises";
+// Constants
+const DEFAULT_TIMEOUT_MS = 180000;
+const DEFAULT_SUCCESS_STATUS = 200;
+const DEFAULT_PENDING_STATUS = 202;
+const DEFAULT_INITIAL_DELAY_MS = 50;
+const DEFAULT_MAX_POLLING_INTERVAL_MS = 10000;
+const MAX_CONSECUTIVE_ERRORS = 3;
+const MAX_TIMEOUT_BUFFER_MS = 10000;
+const BASE_ERROR_BACKOFF_MS = 1000;
+const JITTER_FACTOR = 0.5;
+// Polling stages: [threshold_ms, interval_ms]
+// Note: These are default stages, actual hard timeout is enforced separately below
+const DEFAULT_POLLING_STAGES = [
+    [125, 125], // Up to 125ms: poll every 125ms
+    [375, 250], // Up to 375ms: poll every 250ms
+    [875, 500], // Up to 875ms: poll every 500ms
+    [10000, 1000], // Up to 10s: poll every 1s
+    [30000, 2500], // Up to 30s: poll every 2.5s
+    [60000, 5000], // Up to 60s: poll every 5s
+];
+// Helper to calculate wait time with jitter and error backoff
+const calculateWaitTime = (baseInterval, errorCount) => {
+    // Jitter to avoid thundering herd
+    const jitter = Math.random() * JITTER_FACTOR * baseInterval;
+    // More backoff added if errors are seen
+    const errorBackoff = Math.min(BASE_ERROR_BACKOFF_MS * (errorCount / 2), baseInterval * 2);
+    return Math.floor(baseInterval + jitter + errorBackoff);
+};
+const processResponse = async (response, successStatus, pendingStatus, resultExtractor, errorCount) => {
+    // Handle other error responses
+    if (!response.ok) {
+        return {
+            status: "continue" /* PollStatus.Continue */,
+            // If for some reason the status is pending, we don't want to increment the error count
+            errorCount: response.status === pendingStatus ? errorCount : errorCount + 1,
+        };
+    }
+    // Check for successful completion
+    if (response.status === successStatus) {
+        try {
+            const resultJson = await response.json();
+            return {
+                result: resultExtractor(resultJson),
+                status: "success" /* PollStatus.Success */,
+                errorCount: 0,
+            };
+        }
+        catch (error) {
+            throw new ZapierApiError("Result extractor failed to parse successful response as JSON", {
+                statusCode: response.status,
+                cause: error,
+            });
+        }
+    }
+    // If it's not pending, it's unexpected
+    if (response.status !== pendingStatus) {
+        throw new ZapierApiError(`Unexpected response status during polling: ${response.status}`, {
+            statusCode: response.status,
+        });
+    }
+    // It's still pending, so we continue polling
+    return {
+        status: "continue" /* PollStatus.Continue */,
+        errorCount: 0,
+    };
+};
+/**
+ * Polls an endpoint until completion, timeout, or error
+ * @param options Configuration options for polling
+ * @returns The extracted result from the successful response
+ * @throws {ZapierValidationError} When the input parameters are invalid
+ * @throws {ZapierTimeoutError} When the operation times out
+ * @throws {ZapierApiError} When the API returns consecutive errors
+ */
 export async function pollUntilComplete(options) {
-    const { fetchPoll, maxAttempts = 30, initialDelay = 50, maxDelay = 1000, successStatus = 200, pendingStatus = 202, resultExtractor = (response) => response, } = options;
-    let delay = initialDelay;
+    const { fetchPoll, timeoutMs = DEFAULT_TIMEOUT_MS, initialDelay = DEFAULT_INITIAL_DELAY_MS, successStatus = DEFAULT_SUCCESS_STATUS, pendingStatus = DEFAULT_PENDING_STATUS, resultExtractor = (response) => response, } = options;
+    // Validate input parameters
+    if (timeoutMs <= 0) {
+        throw new ZapierValidationError("Timeout must be greater than 0", {
+            details: { timeoutMs },
+        });
+    }
+    if (initialDelay < 0) {
+        throw new ZapierValidationError("Initial delay must be non-negative", {
+            details: { initialDelay },
+        });
+    }
+    const startTime = Date.now();
+    let attempts = 0;
     let errorCount = 0;
-    for (let attempt = 0; attempt < maxAttempts; attempt++) {
-        const response = await fetchPoll();
-        if (response.status === successStatus) {
-            // Success - reset error count and return results
-            errorCount = 0;
-            const result = await response.json();
-            return resultExtractor(result);
+    // Build polling stages with the actual timeout appended
+    const pollingStages = [
+        ...DEFAULT_POLLING_STAGES,
+        [timeoutMs + MAX_TIMEOUT_BUFFER_MS, DEFAULT_MAX_POLLING_INTERVAL_MS], // Up to timeout + 10s: poll every 10s
+    ];
+    // Apply initial delay if specified
+    if (initialDelay > 0) {
+        await setTimeout(initialDelay);
+    }
+    while (true) {
+        attempts++;
+        const elapsedTime = Date.now() - startTime;
+        // Find the current polling stage
+        const pollingInterval = pollingStages.find(([maxTimeForStage, _interval]) => {
+            return elapsedTime < maxTimeForStage;
+        });
+        // If there isn't a current stage, throw timeout error
+        if (!pollingInterval) {
+            throw new ZapierTimeoutError(`Operation timed out after ${Math.floor(elapsedTime / 1000)}s (${attempts} attempts)`, {
+                attempts,
+            });
         }
-        else if (response.status === pendingStatus) {
-            // Still processing - reset error count and wait and retry
-            errorCount = 0;
-            if (attempt < maxAttempts - 1) {
-                await new Promise((resolve) => setTimeout(resolve, delay));
-                delay = Math.min(delay * 2, maxDelay); // Exponential backoff
-                continue;
-            }
+        // Wait before polling (except on first attempt)
+        if (attempts > 1) {
+            const waitTime = calculateWaitTime(pollingInterval[1], errorCount);
+            await setTimeout(waitTime);
         }
-        else {
-            // Error occurred - increment error count
-            errorCount++;
-            if (errorCount >= 3) {
+        // Perform the poll request
+        try {
+            const response = await fetchPoll();
+            const { result, errorCount: newErrorCount, status, } = await processResponse(response, successStatus, pendingStatus, resultExtractor, errorCount);
+            errorCount = newErrorCount;
+            if (status === "success" /* PollStatus.Success */) {
+                return result;
+            }
+            if (errorCount >= MAX_CONSECUTIVE_ERRORS) {
                 // Too many consecutive errors, fail
                 throw new ZapierApiError(`Poll request failed: ${response.status} ${response.statusText}`, { statusCode: response.status });
             }
-            // Treat as pending for up to 3 errors - wait and retry
-            if (attempt < maxAttempts - 1) {
-                await new Promise((resolve) => setTimeout(resolve, delay));
-                delay = Math.min(delay * 2, maxDelay); // Exponential backoff
-                continue;
+        }
+        catch (error) {
+            errorCount++;
+            if (errorCount >= MAX_CONSECUTIVE_ERRORS) {
+                throw new ZapierApiError(`Failed to poll after ${errorCount} consecutive errors: ${error instanceof Error ? error.message : String(error)}`, {
+                    cause: error,
+                });
             }
         }
+        // Continue polling if status is pending
     }
-    throw new ZapierTimeoutError(`Operation timed out after ${maxAttempts} attempts`, { attempts: maxAttempts, maxAttempts: maxAttempts });
 }

package/dist/api/polling.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=polling.test.d.ts.map

package/dist/api/polling.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polling.test.d.ts","sourceRoot":"","sources":["../../src/api/polling.test.ts"],"names":[],"mappings":""}

package/dist/api/polling.test.js

@@ -0,0 +1,318 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import { pollUntilComplete } from "./polling";
+import { ZapierTimeoutError, ZapierApiError, ZapierValidationError, } from "../types/errors";
+// Mock the timers/promises module
+vi.mock("timers/promises", () => ({
+    setTimeout: vi.fn(() => Promise.resolve()),
+}));
+describe("pollUntilComplete", () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+    afterEach(() => {
+        vi.clearAllMocks();
+    });
+    describe("successful polling", () => {
+        it("should return immediately on first successful response", async () => {
+            const mockResponse = {
+                ok: true,
+                status: 200,
+                json: vi.fn().mockResolvedValue({ data: "success" }),
+            };
+            const fetchPoll = vi.fn().mockResolvedValue(mockResponse);
+            const result = await pollUntilComplete({ fetchPoll });
+            expect(result).toEqual({ data: "success" });
+            expect(fetchPoll).toHaveBeenCalledTimes(1);
+        });
+        it("should poll until success status is received", async () => {
+            const pendingResponse = {
+                ok: true,
+                status: 202,
+            };
+            const successResponse = {
+                ok: true,
+                status: 200,
+                json: vi.fn().mockResolvedValue({ data: "complete" }),
+            };
+            const fetchPoll = vi
+                .fn()
+                .mockResolvedValueOnce(pendingResponse)
+                .mockResolvedValueOnce(pendingResponse)
+                .mockResolvedValueOnce(successResponse);
+            const result = await pollUntilComplete({ fetchPoll });
+            expect(result).toEqual({ data: "complete" });
+            expect(fetchPoll).toHaveBeenCalledTimes(3);
+        });
+        it("should use custom success and pending status codes", async () => {
+            const pendingResponse = {
+                ok: true,
+                status: 301,
+            };
+            const successResponse = {
+                ok: true,
+                status: 204,
+                json: vi.fn().mockResolvedValue({ done: true }),
+            };
+            const fetchPoll = vi
+                .fn()
+                .mockResolvedValueOnce(pendingResponse)
+                .mockResolvedValueOnce(successResponse);
+            const result = await pollUntilComplete({
+                fetchPoll,
+                successStatus: 204,
+                pendingStatus: 301,
+            });
+            expect(result).toEqual({ done: true });
+            expect(fetchPoll).toHaveBeenCalledTimes(2);
+        });
+        it("should apply result extractor function", async () => {
+            const mockResponse = {
+                ok: true,
+                status: 200,
+                json: vi.fn().mockResolvedValue({
+                    nested: { data: { value: "extracted" } },
+                }),
+            };
+            const fetchPoll = vi.fn().mockResolvedValue(mockResponse);
+            const resultExtractor = (response) => response.nested.data.value;
+            const result = await pollUntilComplete({
+                fetchPoll,
+                resultExtractor,
+            });
+            expect(result).toBe("extracted");
+        });
+    });
+    describe("initial delay", () => {
+        it("should wait for initial delay before first poll", async () => {
+            const mockResponse = {
+                ok: true,
+                status: 200,
+                json: vi.fn().mockResolvedValue({ data: "success" }),
+            };
+            const fetchPoll = vi.fn().mockResolvedValue(mockResponse);
+            const { setTimeout: mockSetTimeout } = await import("timers/promises");
+            const result = await pollUntilComplete({
+                fetchPoll,
+                initialDelay: 500,
+            });
+            expect(result).toEqual({ data: "success" });
+            expect(fetchPoll).toHaveBeenCalledTimes(1);
+            // Verify setTimeout was called with the initial delay
+            expect(mockSetTimeout).toHaveBeenCalledWith(500);
+        });
+    });
+    describe("error handling", () => {
+        it("should retry on transient network errors", async () => {
+            const successResponse = {
+                ok: true,
+                status: 200,
+                json: vi.fn().mockResolvedValue({ data: "recovered" }),
+            };
+            const fetchPoll = vi
+                .fn()
+                .mockRejectedValueOnce(new Error("Network error"))
+                .mockRejectedValueOnce(new Error("Network error"))
+                .mockResolvedValueOnce(successResponse);
+            const result = await pollUntilComplete({ fetchPoll });
+            expect(result).toEqual({ data: "recovered" });
+            expect(fetchPoll).toHaveBeenCalledTimes(3);
+        });
+        it("should fail after MAX_CONSECUTIVE_ERRORS network failures", async () => {
+            const fetchPoll = vi
+                .fn()
+                .mockRejectedValue(new Error("Persistent network error"));
+            await expect(pollUntilComplete({ fetchPoll })).rejects.toThrow(ZapierApiError);
+            expect(fetchPoll).toHaveBeenCalledTimes(3);
+        });
+        it("should retry on HTTP error responses", async () => {
+            const errorResponse = {
+                ok: false,
+                status: 500,
+                statusText: "Internal Server Error",
+            };
+            const successResponse = {
+                ok: true,
+                status: 200,
+                json: vi.fn().mockResolvedValue({ data: "recovered" }),
+            };
+            const fetchPoll = vi
+                .fn()
+                .mockResolvedValueOnce(errorResponse)
+                .mockResolvedValueOnce(errorResponse)
+                .mockResolvedValueOnce(successResponse);
+            const result = await pollUntilComplete({ fetchPoll });
+            expect(result).toEqual({ data: "recovered" });
+            expect(fetchPoll).toHaveBeenCalledTimes(3);
+        });
+        it("should fail after MAX_CONSECUTIVE_ERRORS HTTP failures", async () => {
+            const errorResponse = {
+                ok: false,
+                status: 503,
+                statusText: "Service Unavailable",
+            };
+            const fetchPoll = vi.fn().mockResolvedValue(errorResponse);
+            await expect(pollUntilComplete({ fetchPoll })).rejects.toThrow(ZapierApiError);
+            expect(fetchPoll).toHaveBeenCalledTimes(3);
+        });
+        it("should throw error for unexpected response status", async () => {
+            const unexpectedResponse = {
+                ok: true,
+                status: 301, // Not success (200) or pending (202)
+            };
+            const fetchPoll = vi.fn().mockResolvedValue(unexpectedResponse);
+            await expect(pollUntilComplete({ fetchPoll })).rejects.toThrow("Unexpected response status");
+            // Will retry 3 times before failing
+            expect(fetchPoll).toHaveBeenCalledTimes(3);
+        });
+        it("should throw error if successful response is not valid JSON", async () => {
+            const mockResponse = {
+                ok: true,
+                status: 200,
+                json: vi.fn().mockRejectedValue(new Error("Invalid JSON")),
+            };
+            const fetchPoll = vi.fn().mockResolvedValue(mockResponse);
+            await expect(pollUntilComplete({ fetchPoll })).rejects.toThrow("Failed to poll after 3 consecutive errors");
+            // Will retry 3 times before failing
+            expect(fetchPoll).toHaveBeenCalledTimes(3);
+        });
+    });
+    describe("timeout behavior", () => {
+        it("should timeout after specified duration", async () => {
+            // Mock Date.now to simulate time passing
+            const originalDateNow = Date.now;
+            let currentTime = 1000;
+            Date.now = vi.fn(() => currentTime);
+            const pendingResponse = {
+                ok: true,
+                status: 202,
+            };
+            const fetchPoll = vi.fn().mockImplementation(() => {
+                // Simulate time passing with each poll
+                currentTime += 500;
+                return Promise.resolve(pendingResponse);
+            });
+            try {
+                await expect(pollUntilComplete({
+                    fetchPoll,
+                    timeoutMs: 1000,
+                    initialDelay: 0,
+                })).rejects.toThrow(ZapierTimeoutError);
+            }
+            finally {
+                Date.now = originalDateNow;
+            }
+        });
+        it("should use default timeout when not specified", async () => {
+            // Mock Date.now to simulate time passing beyond default timeout
+            const originalDateNow = Date.now;
+            let currentTime = 1000;
+            Date.now = vi.fn(() => currentTime);
+            const pendingResponse = {
+                ok: true,
+                status: 202,
+            };
+            const fetchPoll = vi.fn().mockImplementation(() => {
+                // Simulate time passing beyond default timeout (180 seconds + buffer)
+                currentTime += 50000;
+                return Promise.resolve(pendingResponse);
+            });
+            try {
+                await expect(pollUntilComplete({
+                    fetchPoll,
+                    initialDelay: 0,
+                })).rejects.toThrow(ZapierTimeoutError);
+            }
+            finally {
+                Date.now = originalDateNow;
+            }
+        });
+    });
+    describe("input validation", () => {
+        it("should throw error for invalid timeout", async () => {
+            const fetchPoll = vi.fn();
+            await expect(pollUntilComplete({
+                fetchPoll,
+                timeoutMs: 0,
+            })).rejects.toThrow(ZapierValidationError);
+            await expect(pollUntilComplete({
+                fetchPoll,
+                timeoutMs: -1000,
+            })).rejects.toThrow(/Timeout must be greater than 0/);
+        });
+        it("should throw error for negative initial delay", async () => {
+            const fetchPoll = vi.fn();
+            await expect(pollUntilComplete({
+                fetchPoll,
+                initialDelay: -100,
+            })).rejects.toThrow(ZapierValidationError);
+            await expect(pollUntilComplete({
+                fetchPoll,
+                initialDelay: -1,
+            })).rejects.toThrow(/Initial delay must be non-negative/);
+        });
+    });
+    describe("edge cases", () => {
+        it("should handle rapid status changes", async () => {
+            const responses = [
+                { ok: true, status: 202 },
+                { ok: false, status: 500 },
+                { ok: true, status: 202 },
+                {
+                    ok: true,
+                    status: 200,
+                    json: vi.fn().mockResolvedValue({ data: "success" }),
+                },
+            ];
+            let index = 0;
+            const fetchPoll = vi.fn().mockImplementation(() => {
+                const response = responses[index];
+                index++;
+                return Promise.resolve(response);
+            });
+            const result = await pollUntilComplete({ fetchPoll });
+            expect(result).toEqual({ data: "success" });
+            expect(fetchPoll).toHaveBeenCalledTimes(4);
+        });
+        it("should handle immediate success with no initial delay", async () => {
+            const mockResponse = {
+                ok: true,
+                status: 200,
+                json: vi.fn().mockResolvedValue({ instant: true }),
+            };
+            const fetchPoll = vi.fn().mockResolvedValue(mockResponse);
+            const result = await pollUntilComplete({
+                fetchPoll,
+                initialDelay: 0,
+            });
+            expect(result).toEqual({ instant: true });
+            expect(fetchPoll).toHaveBeenCalledTimes(1);
+        });
+        it("should handle very short timeout", async () => {
+            // Mock Date.now to simulate time passing
+            const originalDateNow = Date.now;
+            let currentTime = 1000;
+            Date.now = vi.fn(() => currentTime);
+            const pendingResponse = {
+                ok: true,
+                status: 202,
+            };
+            const fetchPoll = vi.fn().mockImplementation(() => {
+                // Simulate time passing beyond the short timeout
+                currentTime += 200;
+                return Promise.resolve(pendingResponse);
+            });
+            try {
+                await expect(pollUntilComplete({
+                    fetchPoll,
+                    timeoutMs: 100,
+                    initialDelay: 0,
+                })).rejects.toThrow(ZapierTimeoutError);
+                // Should have made at least 1 attempt before timing out
+                expect(fetchPoll.mock.calls.length).toBeGreaterThanOrEqual(1);
+            }
+            finally {
+                Date.now = originalDateNow;
+            }
+        });
+    });
+});

package/dist/api/types.d.ts

@@ -41,9 +41,8 @@ export interface RequestOptions {
     }) => Error | undefined;
 }
 export interface PollOptions extends RequestOptions {
-    maxAttempts?: number;
     initialDelay?: number;
-    maxDelay?: number;
+    timeoutMs?: number;
     successStatus?: number;
     pendingStatus?: number;
     resultExtractor?: (response: unknown) => unknown;

package/dist/api/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/api/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EACV,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,uBAAuB,EACvB,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,2BAA2B,EAC3B,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EACpB,6BAA6B,EAC7B,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,6BAA6B,EAC7B,wBAAwB,EACxB,iCAAiC,EACjC,aAAa,EACb,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EACzB,6BAA6B,EAC7B,8BAA8B,EAC/B,MAAM,WAAW,CAAC;AAMnB,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAChC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IACzE,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,cAAc,KACrB,OAAO,CAAC,CAAC,CAAC,CAAC;IAChB,GAAG,EAAE,CAAC,CAAC,GAAG,OAAO,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,cAAc,KACrB,OAAO,CAAC,CAAC,CAAC,CAAC;IAChB,MAAM,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5E,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IACvE,KAAK,EAAE,CACL,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,WAAW,GAAG;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtC,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,KACE,OAAO,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAAE;QAC/B,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,EAAE,OAAO,CAAC;KACf,KAAK,KAAK,GAAG,SAAS,CAAC;CACzB;AAED,MAAM,WAAW,WAAY,SAAQ,cAAc;IACjD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;CAClD;AAED,MAAM,WAAW,WAAW;IAC1B,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzC;AAOD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAC9C,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAClD,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAClD,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAG5D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAC5C,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAGtE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAGhE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,iCAAiC,CACzC,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAC5C,OAAO,8BAA8B,CACtC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/api/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EACV,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,uBAAuB,EACvB,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,2BAA2B,EAC3B,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EACpB,6BAA6B,EAC7B,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,6BAA6B,EAC7B,wBAAwB,EACxB,iCAAiC,EACjC,aAAa,EACb,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EACzB,6BAA6B,EAC7B,8BAA8B,EAC/B,MAAM,WAAW,CAAC;AAMnB,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAChC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IACzE,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,cAAc,KACrB,OAAO,CAAC,CAAC,CAAC,CAAC;IAChB,GAAG,EAAE,CAAC,CAAC,GAAG,OAAO,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,cAAc,KACrB,OAAO,CAAC,CAAC,CAAC,CAAC;IAChB,MAAM,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5E,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IACvE,KAAK,EAAE,CACL,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,WAAW,GAAG;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtC,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,KACE,OAAO,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAAE;QAC/B,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,EAAE,OAAO,CAAC;KACf,KAAK,KAAK,GAAG,SAAS,CAAC;CACzB;AAED,MAAM,WAAW,WAAY,SAAQ,cAAc;IACjD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;CAClD;AAED,MAAM,WAAW,WAAW;IAC1B,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzC;AAOD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAC9C,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAClD,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAClD,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAG5D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAC5C,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAGtE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAGhE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,iCAAiC,CACzC,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAC5C,OAAO,8BAA8B,CACtC,CAAC"}