@zapier/zapier-sdk 0.117.0 → 0.119.0

package/dist/{chunk-FDR2QEZI.cjs → chunk-TJXDMXEE.cjs}

@@ -119,6 +119,9 @@ var ActionTimeoutSecondsPropertySchema = zod.z.number().min(1).optional().descri
 var ActionTimeoutMillisecondsPropertySchema = zod.z.number().min(1e3).optional().describe(
   `Maximum time to wait for action completion in milliseconds (default: ${DEFAULT_ACTION_TIMEOUT_MILLISECONDS})`
 );
+var ActionIdempotencyKeyPropertySchema = zod.z.string().min(1).max(255).optional().describe(
+  "Key that makes retrying a run safe. Another run with the same key within 72 hours returns the original run instead of starting a new one, even if its inputs differ, so use a fresh key per distinct run. A paged run is sent with a key derived from this key and the page, so one key covers every page and retrying a page replays that page's run."
+);
 var TablePropertySchema = kitcore.withPositional(
   zod.z.string().regex(/^[A-Z0-9]{26}$/, "Table ID must be a valid ULID").describe("The unique identifier of the table")
 );
@@ -532,7 +535,8 @@ var ActionExecutionInputSchema = zod.z.object({
   /** @deprecated Use `timeoutSeconds` instead. */
   timeoutMs: ActionTimeoutMillisecondsPropertySchema.meta({
     deprecated: true
-  })
+  }),
+  idempotencyKey: ActionIdempotencyKeyPropertySchema
 }).describe(
   "Execute an action with the given inputs for the bound app, as an alternative to runAction"
 ).meta({
@@ -2824,7 +2828,7 @@ function logRouteOverride({
 }
 
 // src/sdk-version.ts
-var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.117.0" : void 0) || "unknown";
+var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.119.0" : void 0) || "unknown";
 
 // src/utils/open-url.ts
 var nodePrefix = "node:";
@@ -5499,6 +5503,7 @@ var RunActionBaseSchema = zod.z.object({
   timeoutSeconds: ActionTimeoutSecondsPropertySchema,
   /** @deprecated Use `timeoutSeconds` instead. */
   timeoutMs: ActionTimeoutMillisecondsPropertySchema.meta({ deprecated: true }),
+  idempotencyKey: ActionIdempotencyKeyPropertySchema,
   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")
@@ -7248,7 +7253,8 @@ var CreateActionRunSchema = zod.z.object({
   ),
   callbackUrl: zod.z.string().url().optional().describe(
     "URL Zapier posts the finished run to, so you do not have to poll for it. Must use HTTPS and resolve to a public host, so a local receiver needs a tunnel. The body matches what `getActionRun` returns. Verify the `Zapier-Callback-Signature` header, and expect the same run to arrive more than once."
-  ).meta({ valueHint: "url" })
+  ).meta({ valueHint: "url" }),
+  idempotencyKey: ActionIdempotencyKeyPropertySchema
 }).describe(
   "Start an action run and return its ID without waiting for the result. Running an action is asynchronous: this hands back a run ID immediately, and `getActionRun` fetches the outcome. Reach for this pair when you want to start work and collect it later (fan out many runs, hand the ID to another process, survive a restart). `runAction` is the one-call form that starts a run and waits for its result."
 );
@@ -7260,6 +7266,38 @@ var ActionRunStartedItemSchema = zod.z.object({
     "Versioned implementation ID the run was started against (e.g. 'SlackCLIAPI@1.21.1'). The versionless app key is the part before the `@`."
   )
 });
+
+// src/utils/action-run-wire.ts
+var PAGE_IDEMPOTENCY_KEY_PREFIX = "sdk-page:";
+function actionRunPath(run) {
+  return `${ACTION_RUNS_PATH}/${encodeURIComponent(run)}`;
+}
+function actionRunPayload(body) {
+  return body?.data;
+}
+function isActionRunPending(body) {
+  return actionRunPayload(body)?.status === "waiting";
+}
+async function derivePageIdempotencyKey({
+  key,
+  page
+}) {
+  const subtle = globalThis.crypto?.subtle;
+  if (!subtle) {
+    throw new ZapierConfigurationError(
+      "Paging an action run with an idempotencyKey requires Web Crypto (`crypto.subtle`): Node.js 19+, or a browser page served over HTTPS or localhost."
+    );
+  }
+  const digest = await subtle.digest(
+    "SHA-256",
+    new TextEncoder().encode(`${key}\0${page}`)
+  );
+  const hex = Array.from(
+    new Uint8Array(digest),
+    (byte) => byte.toString(16).padStart(2, "0")
+  ).join("");
+  return `${PAGE_IDEMPOTENCY_KEY_PREFIX}${hex}`;
+}
 var CONTEXT_CACHE_TTL_MILLISECONDS = 6e4;
 var CONTEXT_CACHE_MAX_SIZE = 500;
 var createActionRunPlugin = kitcore.defineMethod({
@@ -7359,7 +7397,8 @@ var createActionRunPlugin = kitcore.defineMethod({
       connection,
       inputs = {},
       page,
-      callbackUrl
+      callbackUrl,
+      idempotencyKey
     } = input;
     const connectionId = await resolveConnectionId({
       connection,
@@ -7390,6 +7429,9 @@ var createActionRunPlugin = kitcore.defineMethod({
     if (callbackUrl) {
       runRequestData.callback_url = callbackUrl;
     }
+    if (idempotencyKey) {
+      runRequestData.idempotency_id = page ? await derivePageIdempotencyKey({ key: idempotencyKey, page }) : idempotencyKey;
+    }
     const runData = await api.post(
       ACTION_RUNS_PATH,
       { data: runRequestData },
@@ -7415,17 +7457,6 @@ var createActionRunPlugin = kitcore.defineMethod({
   }
 });
 
-// src/utils/action-run-wire.ts
-function actionRunPath(run) {
-  return `${ACTION_RUNS_PATH}/${encodeURIComponent(run)}`;
-}
-function actionRunPayload(body) {
-  return body?.data;
-}
-function isActionRunPending(body) {
-  return actionRunPayload(body)?.status === "waiting";
-}
-
 // src/plugins/runAction/index.ts
 var runActionPlugin = kitcore.defineMethod({
   name: "runAction",
@@ -7455,7 +7486,8 @@ var runActionPlugin = kitcore.defineMethod({
       connection,
       authenticationId,
       inputs = {},
-      cursor
+      cursor,
+      idempotencyKey
     } = input;
     const timeoutMilliseconds = (input.timeoutSeconds != null ? input.timeoutSeconds * 1e3 : input.timeoutMs) ?? DEFAULT_ACTION_TIMEOUT_MILLISECONDS;
     const resolvedConnectionId = await resolveConnectionId({
@@ -7470,7 +7502,8 @@ var runActionPlugin = kitcore.defineMethod({
       action: actionKey,
       connection: resolvedConnectionId,
       inputs,
-      page: cursor
+      page: cursor,
+      idempotencyKey
     });
     annotate({ selectedApi: started.implementation_id });
     const run = await imports.api.poll(
@@ -7545,7 +7578,8 @@ function createActionFunction(appKey, actionType, actionKey, imports, pinnedAuth
       connection: providedConnection,
       authenticationId: providedAuthenticationId,
       timeoutSeconds,
-      timeoutMs
+      timeoutMs,
+      idempotencyKey
     } = actionOptions;
     const { connectionId, connection } = resolveProxyConnection({
       providedConnectionId,
@@ -7561,7 +7595,8 @@ function createActionFunction(appKey, actionType, actionKey, imports, pinnedAuth
       inputs,
       connection: connectionId ?? connection,
       timeoutSeconds,
-      timeoutMs
+      timeoutMs,
+      idempotencyKey
     });
   };
 }
@@ -13667,6 +13702,7 @@ Object.defineProperty(exports, "toTitleCase", {
 });
 exports.ACTION_RUNS_PATH = ACTION_RUNS_PATH;
 exports.API_ID = API_ID;
+exports.ActionIdempotencyKeyPropertySchema = ActionIdempotencyKeyPropertySchema;
 exports.ActionKeyPropertySchema = ActionKeyPropertySchema;
 exports.ActionPropertySchema = ActionPropertySchema;
 exports.ActionTimeoutMillisecondsPropertySchema = ActionTimeoutMillisecondsPropertySchema;
@@ -13882,6 +13918,7 @@ exports.resolveCredentialsPluginRef = resolveCredentialsPluginRef;
 exports.runActionPlugin = runActionPlugin;
 exports.runWithCallerContext = runWithCallerContext;
 exports.sdkOptionsPluginRef = sdkOptionsPluginRef;
+exports.sleep = sleep;
 exports.tableFieldIdsResolver = tableFieldIdsResolver;
 exports.tableFieldsResolver = tableFieldsResolver;
 exports.tableFiltersResolver = tableFiltersResolver;