@zapier/zapier-sdk 0.23.2 → 0.25.0

package/dist/index.cjs

@@ -59,6 +59,7 @@ function isPositional(schema) {
 // src/constants.ts
 var ZAPIER_BASE_URL = process.env.ZAPIER_BASE_URL || "https://zapier.com";
 var MAX_PAGE_LIMIT = 1e4;
+var DEFAULT_ACTION_TIMEOUT_MS = 18e4;
 var ZAPIER_CREDENTIALS = process.env.ZAPIER_CREDENTIALS;
 var ZAPIER_CREDENTIALS_CLIENT_ID = process.env.ZAPIER_CREDENTIALS_CLIENT_ID;
 var ZAPIER_CREDENTIALS_CLIENT_SECRET = process.env.ZAPIER_CREDENTIALS_CLIENT_SECRET;
@@ -90,6 +91,9 @@ var OffsetPropertySchema = zod.z.number().int().min(0).default(0).describe("Numb
 var OutputPropertySchema = zod.z.string().describe("Output file path");
 var DebugPropertySchema = zod.z.boolean().default(false).describe("Enable debug logging");
 var ParamsPropertySchema = zod.z.record(zod.z.string(), zod.z.unknown()).describe("Additional parameters");
+var ActionTimeoutMsPropertySchema = zod.z.number().min(1e3).optional().describe(
+  `Maximum time to wait for action completion in milliseconds (default: ${DEFAULT_ACTION_TIMEOUT_MS})`
+);
 
 // src/types/errors.ts
 var ZapierError = class extends Error {
@@ -227,7 +231,8 @@ HTTP Status: ${error.statusCode}`;
 }
 var ActionExecutionInputSchema = zod.z.object({
   inputs: zod.z.record(zod.z.string(), zod.z.unknown()).optional(),
-  authenticationId: AuthenticationIdPropertySchema.optional()
+  authenticationId: AuthenticationIdPropertySchema.optional(),
+  timeoutMs: ActionTimeoutMsPropertySchema
 }).describe(
   "Execute an action with the given inputs for the bound app, as an alternative to runAction"
 );
@@ -264,7 +269,11 @@ var ActionResultItemSchema = withFormatter(
 function createActionFunction(appKey, actionType, actionKey, options, pinnedAuthId) {
   return (actionOptions = {}) => {
     const { sdk } = options;
-    const { inputs, authenticationId: providedAuthenticationId } = actionOptions;
+    const {
+      inputs,
+      authenticationId: providedAuthenticationId,
+      timeoutMs
+    } = actionOptions;
     const authenticationId = pinnedAuthId ?? providedAuthenticationId;
     if (!authenticationId) {
       throw new ZapierValidationError(
@@ -276,7 +285,8 @@ function createActionFunction(appKey, actionType, actionKey, options, pinnedAuth
       actionType,
       actionKey,
       inputs,
-      authenticationId
+      authenticationId,
+      timeoutMs
     });
   };
 }
@@ -384,71 +394,136 @@ var appsPlugin = ({ sdk }) => {
     }
   };
 };
-var FetchUrlSchema = zod.z.union([zod.z.string(), zod.z.instanceof(URL)]).describe("The URL to fetch");
+var FetchUrlSchema = zod.z.union([zod.z.string(), zod.z.instanceof(URL)]).describe(
+  "The full URL of the API endpoint to call (proxied through Zapier's Relay service)"
+);
 var FetchInitSchema = zod.z.object({
-  method: zod.z.enum(["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"]).optional(),
-  headers: zod.z.record(zod.z.string(), zod.z.string()).optional(),
+  method: zod.z.enum(["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"]).optional().describe("HTTP method for the request (defaults to GET)"),
+  headers: zod.z.record(zod.z.string(), zod.z.string()).optional().describe("HTTP headers to include in the request"),
   body: zod.z.union([
     zod.z.string(),
     zod.z.instanceof(FormData),
     zod.z.instanceof(URLSearchParams)
-  ]).optional(),
+  ]).optional().describe(
+    "Request body \u2014 JSON strings are auto-detected and Content-Type is set accordingly"
+  ),
   authenticationId: AuthenticationIdPropertySchema.optional(),
   callbackUrl: zod.z.string().optional().describe("URL to send async response to (makes request async)"),
   authenticationTemplate: zod.z.string().optional().describe(
     "Optional JSON string authentication template to bypass Notary lookup"
   )
-}).optional().describe("Fetch options including authentication");
+}).optional().describe(
+  "Request options including method, headers, body, and authentication"
+);
+
+// src/utils/id-utils.ts
+function coerceToNumericId(fieldName, value) {
+  if (value === "") {
+    throw new ZapierValidationError(`The ${fieldName} cannot be empty`);
+  }
+  const numericValue = typeof value === "number" ? value : Number(value);
+  if (!Number.isFinite(numericValue)) {
+    throw new ZapierValidationError(
+      `The ${fieldName} "${value}" could not be converted to a number`
+    );
+  }
+  return numericValue;
+}
 
 // src/plugins/fetch/index.ts
-var fetchPlugin = ({ sdk, context }) => {
+function transformUrlToRelayPath(url) {
+  const targetUrl = new URL(url);
+  return `/relay/${targetUrl.host}${targetUrl.pathname}${targetUrl.search}${targetUrl.hash}`;
+}
+function normalizeHeaders(optionsHeaders) {
+  const headers = {};
+  if (!optionsHeaders) {
+    return headers;
+  }
+  const headerEntries = optionsHeaders instanceof Headers ? Array.from(optionsHeaders.entries()) : Array.isArray(optionsHeaders) ? optionsHeaders : Object.entries(optionsHeaders);
+  for (const [key, value] of headerEntries) {
+    headers[key] = value;
+  }
+  return headers;
+}
+var fetchPlugin = ({ context }) => {
   return {
     fetch: async function fetch2(url, init) {
+      const { api } = context;
       const startTime = Date.now();
+      const isNested = init?._telemetry?.isNested === true;
       try {
         const {
           authenticationId,
           callbackUrl,
           authenticationTemplate,
+          _telemetry,
           ...fetchInit
         } = init || {};
-        const result = await sdk.request({
-          url: url.toString(),
-          method: fetchInit.method,
+        const relayPath = transformUrlToRelayPath(url);
+        const headers = normalizeHeaders(
+          fetchInit.headers
+        );
+        const hasContentType = Object.keys(headers).some(
+          (k) => k.toLowerCase() === "content-type"
+        );
+        if (fetchInit.body && !hasContentType) {
+          const bodyStr = typeof fetchInit.body === "string" ? fetchInit.body : JSON.stringify(fetchInit.body);
+          const trimmed = bodyStr.trimStart();
+          if (trimmed.startsWith("{") || trimmed.startsWith("[")) {
+            headers["Content-Type"] = "application/json; charset=utf-8";
+          }
+        }
+        if (authenticationId) {
+          headers["X-Relay-Authentication-Id"] = coerceToNumericId(
+            "authenticationId",
+            authenticationId
+          ).toString();
+        }
+        if (callbackUrl) {
+          headers["X-Relay-Callback-Url"] = callbackUrl;
+        }
+        if (authenticationTemplate) {
+          headers["X-Authentication-Template"] = authenticationTemplate;
+        }
+        const result = await api.fetch(relayPath, {
+          method: fetchInit.method ?? "GET",
           body: fetchInit.body,
-          headers: fetchInit.headers,
-          authenticationId,
-          callbackUrl,
-          authenticationTemplate,
-          _telemetry: { isNested: true }
-        });
-        context.eventEmission.emitMethodCalled({
-          method_name: "fetch",
-          execution_duration_ms: Date.now() - startTime,
-          success_flag: true,
-          error_message: null,
-          error_type: null,
-          argument_count: init ? 2 : 1,
-          is_paginated: false
+          headers,
+          authRequired: true
         });
+        if (!isNested) {
+          context.eventEmission.emitMethodCalled({
+            method_name: "fetch",
+            execution_duration_ms: Date.now() - startTime,
+            success_flag: true,
+            error_message: null,
+            error_type: null,
+            argument_count: init ? 2 : 1,
+            is_paginated: false
+          });
+        }
         return result;
       } catch (error) {
-        context.eventEmission.emitMethodCalled({
-          method_name: "fetch",
-          execution_duration_ms: Date.now() - startTime,
-          success_flag: false,
-          error_message: error instanceof Error ? error.message : String(error),
-          error_type: error instanceof Error ? error.constructor.name : "Unknown",
-          argument_count: init ? 2 : 1,
-          is_paginated: false
-        });
+        if (!isNested) {
+          context.eventEmission.emitMethodCalled({
+            method_name: "fetch",
+            execution_duration_ms: Date.now() - startTime,
+            success_flag: false,
+            error_message: error instanceof Error ? error.message : String(error),
+            error_type: error instanceof Error ? error.constructor.name : "Unknown",
+            argument_count: init ? 2 : 1,
+            is_paginated: false
+          });
+        }
         throw error;
       }
     },
     context: {
       meta: {
         fetch: {
-          packages: ["sdk"],
+          description: "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.",
+          packages: ["sdk", "cli", "mcp"],
           categories: ["http"],
           returnType: "Response",
           inputParameters: [
@@ -1827,20 +1902,6 @@ var RootFieldItemSchema = zod.z.union([
   FieldsetItemSchema
 ]);
 
-// src/utils/id-utils.ts
-function coerceToNumericId(fieldName, value) {
-  if (value === "") {
-    throw new ZapierValidationError(`The ${fieldName} cannot be empty`);
-  }
-  const numericValue = typeof value === "number" ? value : Number(value);
-  if (!Number.isFinite(numericValue)) {
-    throw new ZapierValidationError(
-      `The ${fieldName} "${value}" could not be converted to a number`
-    );
-  }
-  return numericValue;
-}
-
 // src/services/implementations.ts
 async function fetchImplementationNeeds({
   api,
@@ -2680,6 +2741,7 @@ var RunActionSchema = zod.z.object({
   inputs: InputsPropertySchema.optional().describe(
     "Input parameters for the action"
   ),
+  timeoutMs: ActionTimeoutMsPropertySchema,
   pageSize: zod.z.number().min(1).optional().describe("Number of results per page"),
   maxItems: zod.z.number().min(1).optional().describe("Maximum total items to return across all pages"),
   cursor: zod.z.string().optional().describe("Cursor to start from")
@@ -2695,7 +2757,8 @@ async function executeAction(actionOptions) {
     actionKey,
     actionType,
     executionOptions,
-    authenticationId
+    authenticationId,
+    timeoutMs
   } = actionOptions;
   const selectedApi = await context.getVersionedImplementationId(appKey);
   if (!selectedApi) {
@@ -2725,6 +2788,7 @@ async function executeAction(actionOptions) {
   return await api.poll(`/zapier/api/actions/v1/runs/${runId}`, {
     successStatus: 200,
     pendingStatus: 202,
+    timeoutMs: timeoutMs ?? DEFAULT_ACTION_TIMEOUT_MS,
     isPending: (result) => {
       const data = result?.data;
       return data?.status === "waiting";
@@ -2740,7 +2804,8 @@ var runActionPlugin = ({ sdk, context }) => {
       actionKey,
       actionType,
       authenticationId,
-      inputs = {}
+      inputs = {},
+      timeoutMs
     } = options;
     const actionData = await sdk.getAction({
       appKey,
@@ -2764,7 +2829,9 @@ var runActionPlugin = ({ sdk, context }) => {
       actionKey,
       actionType,
       executionOptions: { inputs },
-      authenticationId});
+      authenticationId,
+      timeoutMs
+    });
     if (result.errors && result.errors.length > 0) {
       const errorMessage = result.errors.map(
         (error) => error.detail || error.title || "Unknown error"
@@ -2823,64 +2890,41 @@ var RelayRequestSchema = zod.z.object({
     zod.z.instanceof(Headers),
     zod.z.array(zod.z.tuple([zod.z.string(), zod.z.string()]))
   ]).optional().describe("Request headers")
-}).extend({
-  relayBaseUrl: zod.z.string().optional().describe("Base URL for Relay service")
 }).merge(TelemetryMarkerSchema).describe("Make authenticated HTTP requests through Zapier's Relay service");
 var RelayFetchSchema = RelayRequestSchema;
 
-// src/plugins/request/index.ts
-function transformUrlToRelayPath(url) {
-  const targetUrl = new URL(url);
-  const relayPath = `/relay/${targetUrl.host}${targetUrl.pathname}${targetUrl.search}${targetUrl.hash}`;
-  return relayPath;
+// src/utils/logging.ts
+var loggedDeprecations = /* @__PURE__ */ new Set();
+function logDeprecation(message) {
+  if (loggedDeprecations.has(message)) return;
+  loggedDeprecations.add(message);
+  console.warn(`[zapier-sdk] Deprecation: ${message}`);
+}
+function resetDeprecationWarnings() {
+  loggedDeprecations.clear();
 }
-var requestPlugin = ({ context }) => {
+
+// src/plugins/request/index.ts
+var requestPlugin = ({ sdk, context }) => {
   async function request(options) {
-    const { api } = context;
+    logDeprecation("request() is deprecated. Use fetch() instead.");
     const {
       url,
-      method = "GET",
+      method,
       body,
-      headers: optionsHeaders,
+      headers,
       authenticationId,
       callbackUrl,
       authenticationTemplate
     } = options;
-    const relayPath = transformUrlToRelayPath(url);
-    const headers = {};
-    if (optionsHeaders) {
-      const headerEntries = optionsHeaders instanceof Headers ? Array.from(optionsHeaders.entries()) : Array.isArray(optionsHeaders) ? optionsHeaders : Object.entries(optionsHeaders);
-      for (const [key, value] of headerEntries) {
-        headers[key] = value;
-      }
-    }
-    const hasContentType = Object.keys(headers).some(
-      (k) => k.toLowerCase() === "content-type"
-    );
-    if (body && !hasContentType) {
-      const bodyStr = typeof body === "string" ? body : JSON.stringify(body);
-      const trimmed = bodyStr.trimStart();
-      if (trimmed.startsWith("{") || trimmed.startsWith("[")) {
-        headers["Content-Type"] = "application/json; charset=utf-8";
-      }
-    }
-    if (authenticationId) {
-      headers["X-Relay-Authentication-Id"] = coerceToNumericId(
-        "authenticationId",
-        authenticationId
-      ).toString();
-    }
-    if (callbackUrl) {
-      headers["X-Relay-Callback-Url"] = callbackUrl;
-    }
-    if (authenticationTemplate) {
-      headers["X-Authentication-Template"] = authenticationTemplate;
-    }
-    return await api.fetch(relayPath, {
+    return sdk.fetch(url, {
       method,
       body,
       headers,
-      authRequired: true
+      authenticationId,
+      callbackUrl,
+      authenticationTemplate,
+      _telemetry: { isNested: true }
     });
   }
   const requestDefinition = createFunction(
@@ -2896,7 +2940,8 @@ var requestPlugin = ({ context }) => {
     context: {
       meta: {
         request: {
-          categories: ["http"],
+          packages: ["cli", "mcp"],
+          categories: ["http", "deprecated"],
           returnType: "Response",
           inputSchema: RelayRequestSchema
         }
@@ -3605,9 +3650,8 @@ var DEFAULT_TIMEOUT_MS = 18e4;
 var DEFAULT_SUCCESS_STATUS = 200;
 var DEFAULT_PENDING_STATUS = 202;
 var DEFAULT_INITIAL_DELAY_MS = 50;
-var DEFAULT_MAX_POLLING_INTERVAL_MS = 1e4;
-var MAX_TIMEOUT_BUFFER_MS = 1e4;
-var DEFAULT_POLLING_STAGES = [
+var DEFAULT_MAX_POLLING_INTERVAL_MS = 6e4;
+var POLLING_STAGES = [
   [125, 125],
   // Up to 125ms: poll every 125ms
   [375, 250],
@@ -3618,9 +3662,16 @@ var DEFAULT_POLLING_STAGES = [
   // Up to 10s: poll every 1s
   [3e4, 2500],
   // Up to 30s: poll every 2.5s
-  [6e4, 5e3]
+  [6e4, 5e3],
   // Up to 60s: poll every 5s
+  [18e4, 1e4]
+  // Up to 3min: poll every 10s
+  // Beyond 3min: use DEFAULT_MAX_POLLING_INTERVAL_MS (60s)
 ];
+function getPollingInterval(elapsedMs) {
+  const stage = POLLING_STAGES.find(([threshold]) => elapsedMs < threshold);
+  return stage ? stage[1] : DEFAULT_MAX_POLLING_INTERVAL_MS;
+}
 var processResponse = async (response, successStatus, pendingStatus, isPending, resultExtractor, errorCount) => {
   if (!response.ok) {
     return {
@@ -3689,23 +3740,12 @@ async function pollUntilComplete(options) {
   const startTime = Date.now();
   let attempts = 0;
   let errorCount = 0;
-  const pollingStages = [
-    ...DEFAULT_POLLING_STAGES,
-    [timeoutMs + MAX_TIMEOUT_BUFFER_MS, DEFAULT_MAX_POLLING_INTERVAL_MS]
-    // Up to timeout + 10s: poll every 10s
-  ];
   if (initialDelay > 0) {
     await promises.setTimeout(initialDelay);
   }
   while (true) {
-    attempts++;
     const elapsedTime = Date.now() - startTime;
-    const pollingInterval = pollingStages.find(
-      ([maxTimeForStage, _interval]) => {
-        return elapsedTime < maxTimeForStage;
-      }
-    );
-    if (!pollingInterval) {
+    if (elapsedTime >= timeoutMs) {
       throw new ZapierTimeoutError(
         `Operation timed out after ${Math.floor(elapsedTime / 1e3)}s (${attempts} attempts)`,
         {
@@ -3713,10 +3753,12 @@ async function pollUntilComplete(options) {
         }
       );
     }
-    if (attempts > 1) {
-      const waitTime = calculateWaitTime(pollingInterval[1], errorCount);
+    if (attempts > 0) {
+      const interval = getPollingInterval(elapsedTime);
+      const waitTime = calculateWaitTime(interval, errorCount);
       await promises.setTimeout(waitTime);
     }
+    attempts++;
     try {
       const response = await fetchPoll();
       const {
@@ -3769,17 +3811,6 @@ function isCredentialsFunction(credentials) {
   return typeof credentials === "function";
 }
 
-// src/utils/logging.ts
-var loggedDeprecations = /* @__PURE__ */ new Set();
-function logDeprecation(message) {
-  if (loggedDeprecations.has(message)) return;
-  loggedDeprecations.add(message);
-  console.warn(`[zapier-sdk] Deprecation: ${message}`);
-}
-function resetDeprecationWarnings() {
-  loggedDeprecations.clear();
-}
-
 // src/utils/url-utils.ts
 function getZapierBaseUrl(baseUrl) {
   if (!baseUrl) {
@@ -4637,6 +4668,7 @@ var registryPlugin = ({ sdk, context }) => {
     const meta = context.meta[key];
     return {
       name: key,
+      description: meta.description,
       type: meta.type,
       itemType: meta.itemType,
       returnType: meta.returnType,
@@ -5097,7 +5129,7 @@ function getCpuTime() {
 
 // package.json
 var package_default = {
-  version: "0.23.2"};
+  version: "0.25.0"};
 
 // src/plugins/eventEmission/builders.ts
 function createBaseEvent(context = {}) {
@@ -5551,16 +5583,18 @@ function createSdk(options = {}, initialSdk = {}, initialContext = { meta: {} })
   };
 }
 function createZapierSdkWithoutRegistry(options = {}) {
-  return createSdk(options).addPlugin(eventEmissionPlugin).addPlugin(apiPlugin).addPlugin(manifestPlugin).addPlugin(listAppsPlugin).addPlugin(getAppPlugin).addPlugin(listActionsPlugin).addPlugin(getActionPlugin).addPlugin(listInputFieldsPlugin).addPlugin(getInputFieldsSchemaPlugin).addPlugin(listInputFieldChoicesPlugin).addPlugin(runActionPlugin).addPlugin(listAuthenticationsPlugin).addPlugin(getAuthenticationPlugin).addPlugin(findFirstAuthenticationPlugin).addPlugin(findUniqueAuthenticationPlugin).addPlugin(listClientCredentialsPlugin).addPlugin(createClientCredentialsPlugin).addPlugin(deleteClientCredentialsPlugin).addPlugin(requestPlugin).addPlugin(fetchPlugin).addPlugin(appsPlugin).addPlugin(getProfilePlugin);
+  return createSdk(options).addPlugin(eventEmissionPlugin).addPlugin(apiPlugin).addPlugin(manifestPlugin).addPlugin(listAppsPlugin).addPlugin(getAppPlugin).addPlugin(listActionsPlugin).addPlugin(getActionPlugin).addPlugin(listInputFieldsPlugin).addPlugin(getInputFieldsSchemaPlugin).addPlugin(listInputFieldChoicesPlugin).addPlugin(runActionPlugin).addPlugin(listAuthenticationsPlugin).addPlugin(getAuthenticationPlugin).addPlugin(findFirstAuthenticationPlugin).addPlugin(findUniqueAuthenticationPlugin).addPlugin(listClientCredentialsPlugin).addPlugin(createClientCredentialsPlugin).addPlugin(deleteClientCredentialsPlugin).addPlugin(fetchPlugin).addPlugin(requestPlugin).addPlugin(appsPlugin).addPlugin(getProfilePlugin);
 }
 function createZapierSdk(options = {}) {
   return createZapierSdkWithoutRegistry(options).addPlugin(registryPlugin);
 }
 
 exports.ActionKeyPropertySchema = ActionKeyPropertySchema;
+exports.ActionTimeoutMsPropertySchema = ActionTimeoutMsPropertySchema;
 exports.ActionTypePropertySchema = ActionTypePropertySchema;
 exports.AppKeyPropertySchema = AppKeyPropertySchema;
 exports.AuthenticationIdPropertySchema = AuthenticationIdPropertySchema;
+exports.DEFAULT_ACTION_TIMEOUT_MS = DEFAULT_ACTION_TIMEOUT_MS;
 exports.DEFAULT_CONFIG_PATH = DEFAULT_CONFIG_PATH;
 exports.DebugPropertySchema = DebugPropertySchema;
 exports.InputsPropertySchema = InputsPropertySchema;