@zapier/zapier-sdk 0.23.2 → 0.25.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @zapier/zapier-sdk
 
+## 0.25.0
+
+### Minor Changes
+
+- b0b7eb3: Add timeoutMs for setting the timeout for polling action results.
+
+## 0.24.0
+
+### Minor Changes
+
+- d72cda1: Deprecates request() in favor of self-contained fetch(). The fetch plugin now handles URL-to-relay transformation, header normalization,
+  and body content-type inference directly instead of delegating to request. The request plugin is preserved as a backward-compatible
+  shim that forwards to fetch. CLI and MCP now expose a fetch command via a new inputParameters registry concept for
+  multi-positional-argument functions.
+
 ## 0.23.2
 
 ### Patch Changes

package/README.md

@@ -30,7 +30,6 @@
   - [`listClientCredentials`](#listclientcredentials)
 - [HTTP Requests](#http-requests)
   - [`fetch`](#fetch)
-  - [`request`](#request)
 
 ## Installation
 
@@ -454,17 +453,18 @@ Execute an action with the given inputs
 
 **Parameters:**
 
-| Name                 | Type             | Required | Default | Possible Values                                                                                | Description                                         |
-| -------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------- |
-| `options`            | `object`         | ✅       | —       | —                                                                                              |                                                     |
-| ↳ `appKey`           | `string`         | ✅       | —       | —                                                                                              | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
-| ↳ `actionType`       | `string`         | ✅       | —       | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type  |
-| ↳ `actionKey`        | `string`         | ✅       | —       | —                                                                                              | Action key to execute                               |
-| ↳ `authenticationId` | `string, number` | ❌       | —       | —                                                                                              | Authentication ID to use for this action            |
-| ↳ `inputs`           | `object`         | ❌       | —       | —                                                                                              | Input parameters for the action                     |
-| ↳ `pageSize`         | `number`         | ❌       | —       | —                                                                                              | Number of results per page                          |
-| ↳ `maxItems`         | `number`         | ❌       | —       | —                                                                                              | Maximum total items to return across all pages      |
-| ↳ `cursor`           | `string`         | ❌       | —       | —                                                                                              | Cursor to start from                                |
+| Name                 | Type             | Required | Default | Possible Values                                                                                | Description                                                                  |
+| -------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `options`            | `object`         | ✅       | —       | —                                                                                              |                                                                              |
+| ↳ `appKey`           | `string`         | ✅       | —       | —                                                                                              | App key (e.g., 'SlackCLIAPI' or slug like 'github')                          |
+| ↳ `actionType`       | `string`         | ✅       | —       | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type                           |
+| ↳ `actionKey`        | `string`         | ✅       | —       | —                                                                                              | Action key to execute                                                        |
+| ↳ `authenticationId` | `string, number` | ❌       | —       | —                                                                                              | Authentication ID to use for this action                                     |
+| ↳ `inputs`           | `object`         | ❌       | —       | —                                                                                              | Input parameters for the action                                              |
+| ↳ `timeoutMs`        | `number`         | ❌       | —       | —                                                                                              | Maximum time to wait for action completion in milliseconds (default: 180000) |
+| ↳ `pageSize`         | `number`         | ❌       | —       | —                                                                                              | Number of results per page                                                   |
+| ↳ `maxItems`         | `number`         | ❌       | —       | —                                                                                              | Maximum total items to return across all pages                               |
+| ↳ `cursor`           | `string`         | ❌       | —       | —                                                                                              | Cursor to start from                                                         |
 
 **Returns:** `Promise<PaginatedResult<ActionResultItem>>`
 
@@ -528,11 +528,12 @@ Execute an action with the given inputs for the bound app, as an alternative to
 
 **Parameters:**
 
-| Name                 | Type             | Required | Default | Possible Values | Description                              |
-| -------------------- | ---------------- | -------- | ------- | --------------- | ---------------------------------------- |
-| `options`            | `object`         | ✅       | —       | —               |                                          |
-| ↳ `inputs`           | `object`         | ❌       | —       | —               |                                          |
-| ↳ `authenticationId` | `string, number` | ❌       | —       | —               | Authentication ID to use for this action |
+| Name                 | Type             | Required | Default | Possible Values | Description                                                                  |
+| -------------------- | ---------------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------- |
+| `options`            | `object`         | ✅       | —       | —               |                                                                              |
+| ↳ `inputs`           | `object`         | ❌       | —       | —               |                                                                              |
+| ↳ `authenticationId` | `string, number` | ❌       | —       | —               | Authentication ID to use for this action                                     |
+| ↳ `timeoutMs`        | `number`         | ❌       | —       | —               | Maximum time to wait for action completion in milliseconds (default: 180000) |
 
 **Returns:** `Promise<PaginatedResult<ActionResultItem>>`
 
@@ -803,20 +804,20 @@ for await (const clientCredentials of sdk.listClientCredentials().items()) {
 
 #### `fetch`
 
-Execute fetch
+Make authenticated HTTP requests to any API through Zapier's Relay service. Pass an authenticationId to automatically inject the user's stored credentials (OAuth tokens, API keys, etc.) into the outgoing request. Mirrors the native fetch(url, init?) signature with additional Zapier-specific options.
 
 **Parameters:**
 
-| Name                       | Type                     | Required | Default | Possible Values                                            | Description                                                          |
-| -------------------------- | ------------------------ | -------- | ------- | ---------------------------------------------------------- | -------------------------------------------------------------------- |
-| `url`                      | `string, custom`         | ✅       | —       | —                                                          | The URL to fetch                                                     |
-| `init`                     | `object`                 | ❌       | —       | —                                                          | Fetch options including authentication                               |
-| ↳ `method`                 | `string`                 | ❌       | —       | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` |                                                                      |
-| ↳ `headers`                | `object`                 | ❌       | —       | —                                                          |                                                                      |
-| ↳ `body`                   | `string, custom, custom` | ❌       | —       | —                                                          |                                                                      |
-| ↳ `authenticationId`       | `string, number`         | ❌       | —       | —                                                          | Authentication ID to use for this action                             |
-| ↳ `callbackUrl`            | `string`                 | ❌       | —       | —                                                          | URL to send async response to (makes request async)                  |
-| ↳ `authenticationTemplate` | `string`                 | ❌       | —       | —                                                          | Optional JSON string authentication template to bypass Notary lookup |
+| Name                       | Type                     | Required | Default | Possible Values                                            | Description                                                                       |
+| -------------------------- | ------------------------ | -------- | ------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| `url`                      | `string, custom`         | ✅       | —       | —                                                          | The full URL of the API endpoint to call (proxied through Zapier's Relay service) |
+| `init`                     | `object`                 | ❌       | —       | —                                                          | Request options including method, headers, body, and authentication               |
+| ↳ `method`                 | `string`                 | ❌       | —       | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method for the request (defaults to GET)                                     |
+| ↳ `headers`                | `object`                 | ❌       | —       | —                                                          | HTTP headers to include in the request                                            |
+| ↳ `body`                   | `string, custom, custom` | ❌       | —       | —                                                          | Request body — JSON strings are auto-detected and Content-Type is set accordingly |
+| ↳ `authenticationId`       | `string, number`         | ❌       | —       | —                                                          | Authentication ID to use for this action                                          |
+| ↳ `callbackUrl`            | `string`                 | ❌       | —       | —                                                          | URL to send async response to (makes request async)                               |
+| ↳ `authenticationTemplate` | `string`                 | ❌       | —       | —                                                          | Optional JSON string authentication template to bypass Notary lookup              |
 
 **Returns:** `Promise<Response>`
 
@@ -825,31 +826,3 @@ Execute fetch
 ```typescript
 const result = await sdk.fetch("example-value", { key: "value" });
 ```
-
-#### `request`
-
-Make authenticated HTTP requests through Zapier's Relay service
-
-**Parameters:**
-
-| Name                       | Type                    | Required | Default | Possible Values                                            | Description                                                          |
-| -------------------------- | ----------------------- | -------- | ------- | ---------------------------------------------------------- | -------------------------------------------------------------------- |
-| `options`                  | `object`                | ✅       | —       | —                                                          |                                                                      |
-| ↳ `url`                    | `string`                | ✅       | —       | —                                                          | The URL to request (will be proxied through Relay)                   |
-| ↳ `method`                 | `string`                | ❌       | —       | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method                                                          |
-| ↳ `body`                   | `string`                | ❌       | —       | —                                                          | Request body as a string                                             |
-| ↳ `authenticationId`       | `string, number`        | ❌       | —       | —                                                          | Authentication ID to use for this action                             |
-| ↳ `callbackUrl`            | `string`                | ❌       | —       | —                                                          | URL to send async response to (makes request async)                  |
-| ↳ `authenticationTemplate` | `string`                | ❌       | —       | —                                                          | Optional JSON string authentication template to bypass Notary lookup |
-| ↳ `headers`                | `record, custom, array` | ❌       | —       | —                                                          | Request headers                                                      |
-| ↳ `relayBaseUrl`           | `string`                | ❌       | —       | —                                                          | Base URL for Relay service                                           |
-
-**Returns:** `Promise<Response>`
-
-**Example:**
-
-```typescript
-const result = await sdk.request({
-  url: "https://example.com",
-});
-```

package/dist/api/polling.d.ts

@@ -4,6 +4,13 @@
  * This module provides utilities for polling HTTP endpoints until completion,
  * with configurable retry logic and exponential backoff.
  */
+/**
+ * Get the appropriate polling interval based on elapsed time.
+ * Starts with frequent polling and backs off as time passes.
+ * @param elapsedMs Time elapsed since polling started (in milliseconds)
+ * @returns The polling interval to use (in milliseconds)
+ */
+export declare function getPollingInterval(elapsedMs: number): number;
 /**
  * Options for the polling function
  */

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;AAgCH;;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,uGAAuG;IACvG,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;IAC3C,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;AAgEF;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,GAAG,OAAO,EACvD,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,GAC5B,OAAO,CAAC,OAAO,CAAC,CA2GlB"}
+{"version":3,"file":"polling.d.ts","sourceRoot":"","sources":["../../src/api/polling.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAgCH;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAG5D;AAED;;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,uGAAuG;IACvG,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;IAC3C,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;AAgEF;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,GAAG,OAAO,EACvD,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,GAC5B,OAAO,CAAC,OAAO,CAAC,CAgGlB"}

package/dist/api/polling.js

@@ -12,18 +12,28 @@ 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_TIMEOUT_BUFFER_MS = 10000;
-// Polling stages: [threshold_ms, interval_ms]
-// Note: These are default stages, actual hard timeout is enforced separately below
-const DEFAULT_POLLING_STAGES = [
+const DEFAULT_MAX_POLLING_INTERVAL_MS = 60000;
+// Polling stages: [elapsed_time_threshold_ms, poll_interval_ms]
+const 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
+    [180000, 10000], // Up to 3min: poll every 10s
+    // Beyond 3min: use DEFAULT_MAX_POLLING_INTERVAL_MS (60s)
 ];
+/**
+ * Get the appropriate polling interval based on elapsed time.
+ * Starts with frequent polling and backs off as time passes.
+ * @param elapsedMs Time elapsed since polling started (in milliseconds)
+ * @returns The polling interval to use (in milliseconds)
+ */
+export function getPollingInterval(elapsedMs) {
+    const stage = POLLING_STAGES.find(([threshold]) => elapsedMs < threshold);
+    return stage ? stage[1] : DEFAULT_MAX_POLLING_INTERVAL_MS;
+}
 const processResponse = async (response, successStatus, pendingStatus, isPending, resultExtractor, errorCount) => {
     // Handle other error responses
     if (!response.ok) {
@@ -93,33 +103,25 @@ export async function pollUntilComplete(options) {
     const startTime = Date.now();
     let attempts = 0;
     let errorCount = 0;
-    // 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) {
+        // Check if we've exceeded the timeout
+        if (elapsedTime >= timeoutMs) {
             throw new ZapierTimeoutError(`Operation timed out after ${Math.floor(elapsedTime / 1000)}s (${attempts} attempts)`, {
                 attempts,
             });
         }
         // Wait before polling (except on first attempt)
-        if (attempts > 1) {
-            const waitTime = calculateWaitTime(pollingInterval[1], errorCount);
+        if (attempts > 0) {
+            const interval = getPollingInterval(elapsedTime);
+            const waitTime = calculateWaitTime(interval, errorCount);
             await setTimeout(waitTime);
         }
+        attempts++;
         // Perform the poll request
         try {
             const response = await fetchPoll();

package/dist/api/polling.test.js

@@ -1,5 +1,5 @@
 import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
-import { pollUntilComplete } from "./polling";
+import { pollUntilComplete, getPollingInterval } from "./polling";
 import { ZapierTimeoutError, ZapierApiError, ZapierValidationError, } from "../types/errors";
 // Mock the timers/promises module
 vi.mock("timers/promises", () => ({
@@ -316,3 +316,45 @@ describe("pollUntilComplete", () => {
         });
     });
 });
+describe("getPollingInterval", () => {
+    it("should return 125ms for elapsed time under 125ms", () => {
+        expect(getPollingInterval(0)).toBe(125);
+        expect(getPollingInterval(50)).toBe(125);
+        expect(getPollingInterval(124)).toBe(125);
+    });
+    it("should return 250ms for elapsed time 125-375ms", () => {
+        expect(getPollingInterval(125)).toBe(250);
+        expect(getPollingInterval(200)).toBe(250);
+        expect(getPollingInterval(374)).toBe(250);
+    });
+    it("should return 500ms for elapsed time 375-875ms", () => {
+        expect(getPollingInterval(375)).toBe(500);
+        expect(getPollingInterval(600)).toBe(500);
+        expect(getPollingInterval(874)).toBe(500);
+    });
+    it("should return 1000ms for elapsed time 875ms-10s", () => {
+        expect(getPollingInterval(875)).toBe(1000);
+        expect(getPollingInterval(5000)).toBe(1000);
+        expect(getPollingInterval(9999)).toBe(1000);
+    });
+    it("should return 2500ms for elapsed time 10s-30s", () => {
+        expect(getPollingInterval(10000)).toBe(2500);
+        expect(getPollingInterval(20000)).toBe(2500);
+        expect(getPollingInterval(29999)).toBe(2500);
+    });
+    it("should return 5000ms for elapsed time 30s-60s", () => {
+        expect(getPollingInterval(30000)).toBe(5000);
+        expect(getPollingInterval(45000)).toBe(5000);
+        expect(getPollingInterval(59999)).toBe(5000);
+    });
+    it("should return 10000ms for elapsed time 60s-180s", () => {
+        expect(getPollingInterval(60000)).toBe(10000);
+        expect(getPollingInterval(120000)).toBe(10000);
+        expect(getPollingInterval(179999)).toBe(10000);
+    });
+    it("should return 60000ms (max interval) for elapsed time beyond 180s", () => {
+        expect(getPollingInterval(180000)).toBe(60000);
+        expect(getPollingInterval(300000)).toBe(60000);
+        expect(getPollingInterval(600000)).toBe(60000);
+    });
+});

package/dist/constants.d.ts

@@ -11,6 +11,10 @@ export declare const ZAPIER_BASE_URL: string;
  * Maximum number of items that can be requested per page across all paginated functions
  */
 export declare const MAX_PAGE_LIMIT = 10000;
+/**
+ * Default timeout for action execution (in milliseconds)
+ */
+export declare const DEFAULT_ACTION_TIMEOUT_MS = 180000;
 /**
  * Credentials from environment variables
  */

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,eAAe,QACyB,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,cAAc,QAAQ,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,kBAAkB,oBAAiC,CAAC;AACjE,eAAO,MAAM,4BAA4B,oBACC,CAAC;AAC3C,eAAO,MAAM,gCAAgC,oBACC,CAAC;AAC/C,eAAO,MAAM,2BAA2B,oBACC,CAAC;AAC1C,eAAO,MAAM,wBAAwB,oBAAuC,CAAC;AAE7E;;GAEG;AACH,eAAO,MAAM,YAAY,oBAA2B,CAAC;AACrD,eAAO,MAAM,oBAAoB,oBAAmC,CAAC;AACrE,eAAO,MAAM,qBAAqB,oBAAoC,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,eAAe,QACyB,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,cAAc,QAAQ,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,yBAAyB,SAAU,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,kBAAkB,oBAAiC,CAAC;AACjE,eAAO,MAAM,4BAA4B,oBACC,CAAC;AAC3C,eAAO,MAAM,gCAAgC,oBACC,CAAC;AAC/C,eAAO,MAAM,2BAA2B,oBACC,CAAC;AAC1C,eAAO,MAAM,wBAAwB,oBAAuC,CAAC;AAE7E;;GAEG;AACH,eAAO,MAAM,YAAY,oBAA2B,CAAC;AACrD,eAAO,MAAM,oBAAoB,oBAAmC,CAAC;AACrE,eAAO,MAAM,qBAAqB,oBAAoC,CAAC"}

package/dist/constants.js

@@ -11,6 +11,10 @@ export const ZAPIER_BASE_URL = process.env.ZAPIER_BASE_URL || "https://zapier.co
  * Maximum number of items that can be requested per page across all paginated functions
  */
 export const MAX_PAGE_LIMIT = 10000;
+/**
+ * Default timeout for action execution (in milliseconds)
+ */
+export const DEFAULT_ACTION_TIMEOUT_MS = 180000;
 /**
  * Credentials from environment variables
  */