@zapier/zapier-sdk 0.72.0 → 0.73.1

package/dist/plugins/codeSubstrate/runDurable/schemas.js

@@ -1,26 +1,5 @@
 import { z } from "zod";
-// Local schemas (not imported from ../shared-schemas): runDurable enforces
-// `.min(1)` on implementation_name at the input boundary. The shared schema
-// is response-side and intentionally looser.
-const ConnectionMapEntrySchema = z.object({
-    connection_id: z
-        .union([
-        z.string().regex(/^[1-9][0-9]*$/, "must be a positive integer string"),
-        z.string().uuid("must be a UUID"),
-        z.number().int().positive(),
-    ])
-        .describe("Zapier connection ID. Accepts a positive integer (legacy) or a UUID string (newer connections)."),
-});
-const AppVersionMapEntrySchema = z.object({
-    implementation_name: z
-        .string()
-        .min(1)
-        .describe("Zapier app implementation name (e.g. `SlackCLIAPI`)"),
-    version: z
-        .string()
-        .optional()
-        .describe("Pinned app version (e.g. `1.27.1`). Latest if omitted."),
-});
+import { AppVersionBindingSchema, ConnectionBindingSchema, SourceFilesSchema, } from "../shared";
 const RunNotificationEventSchema = z
     .enum(["started", "progress", "completed", "error", "cancelled"])
     .describe("Run lifecycle event this notification subscribes to");
@@ -47,31 +26,33 @@ const RunNotificationSchema = z
         .describe("One or more lifecycle events to subscribe this URL to."),
 })
     .describe("Webhook subscriber for run lifecycle events. Server POSTs `{run_id, event}` on each subscribed transition.");
-export const RunDurableOptionsSchema = z
-    .object({
-    source_files: z
-        .record(z.string(), z.string())
-        .refine((files) => Object.keys(files).length > 0, {
-        message: "source_files must contain at least one file",
-    })
-        .describe("Source files keyed by filename → contents"),
+// Shared, non-renamed properties. Lives in its own object so the canonical
+// and deprecated `sourceFiles` variants can merge it without repetition.
+const RunDurableBaseSchema = z.object({
     input: z.unknown().optional().describe("Input data passed to the run"),
     dependencies: z
         .record(z.string(), z.string())
         .optional()
         .describe("Optional npm package dependencies"),
-    zapier_durable_version: z
+    zapierDurableVersion: z
         .string()
         .optional()
         .describe('Exact semver of @zapier/zapier-durable to use (e.g. "1.2.3"). Defaults to server-configured version if omitted.'),
+    /** @deprecated Use `zapierDurableVersion` instead. */
+    zapier_durable_version: z.string().optional().meta({ deprecated: true }),
     connections: z
-        .record(z.string(), ConnectionMapEntrySchema)
+        .record(z.string(), ConnectionBindingSchema)
         .optional()
-        .describe('Named connection aliases. Maps each alias to an object holding its Zapier connection ID, e.g. `{ "slack": { "connection_id": "123" } }`.'),
-    app_versions: z
-        .record(z.string(), AppVersionMapEntrySchema)
+        .describe('Named connection aliases. Maps each alias to an object holding its Zapier connection ID, e.g. `{ "slack": { "connectionId": "123" } }`.'),
+    appVersions: z
+        .record(z.string(), AppVersionBindingSchema)
         .optional()
         .describe("Pinned app versions. Maps app keys (slugs) to implementation names and versions."),
+    /** @deprecated Use `appVersions` instead. */
+    app_versions: z
+        .record(z.string(), AppVersionBindingSchema)
+        .optional()
+        .meta({ deprecated: true }),
     private: z
         .boolean()
         .optional()
@@ -80,8 +61,28 @@ export const RunDurableOptionsSchema = z
         .array(RunNotificationSchema)
         .optional()
         .describe("Webhook subscribers for run lifecycle events. Each entry specifies a URL and the events it subscribes to."),
-})
-    .describe("Run a workflow source file as a run-once durable run on sdkdurableapi (no deployed workflow required). Returns the run ID immediately; poll via getDurableRun for terminal status.");
+});
+const RunDurableDescription = "Run a workflow source file as a run-once durable run on sdkdurableapi (no deployed workflow required). Returns the run ID immediately; poll via getDurableRun for terminal status.";
+// Canonical schema (new names only) — drives docs, CLI help, and the registry.
+export const RunDurableSchema = z
+    .object({ sourceFiles: SourceFilesSchema })
+    .merge(RunDurableBaseSchema)
+    .describe(RunDurableDescription)
+    .meta({
+    aliases: {
+        source_files: "sourceFiles",
+        zapier_durable_version: "zapierDurableVersion",
+        app_versions: "appVersions",
+    },
+});
+// Deprecated schema (backward compat) — keeps the old `source_files` name valid.
+const RunDurableSchemaDeprecated = z
+    .object({ source_files: SourceFilesSchema })
+    .merge(RunDurableBaseSchema);
+// Union for runtime validation: accepts either the canonical or the old name.
+export const RunDurableOptionsSchema = z
+    .union([RunDurableSchema, RunDurableSchemaDeprecated])
+    .describe(RunDurableDescription);
 export const RunDurableResponseSchema = z.object({
     id: z.string().describe("Run ID (UUID) — server-generated, time-sortable"),
     status: z

package/dist/plugins/codeSubstrate/shared.d.ts

@@ -1,3 +1,4 @@
+import { z } from "zod";
 /**
  * Method-meta defaults shared across every workflow plugin. Each plugin
  * spreads `...codeSubstrateDefaults` into its `createPluginMethod` /
@@ -13,4 +14,59 @@ export declare const codeSubstrateDefaults: {
     categories: string[];
     experimental: true;
 };
+/**
+ * Source files map, shared by `runDurable` and `publishWorkflowVersion`.
+ * Both require at least one file.
+ */
+export declare const SourceFilesSchema: z.ZodRecord<z.ZodString, z.ZodString>;
+/**
+ * A Zapier connection ID accepted on the wire: a positive integer (legacy)
+ * or a UUID string (newer connections). Split into three union members so a
+ * bad value produces a precise message at the input boundary.
+ */
+export declare const ConnectionIdValueSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString, z.ZodNumber]>;
+/**
+ * Connection binding: maps a single alias to a concrete connection. The
+ * locator is camelCase (`connectionId`) per SDK convention; the snake_case
+ * `connection_id` is a deprecated alias. Both are optional in the schema so
+ * `.shape` stays introspectable for docs — the wire mapper enforces that one
+ * is present (see {@link toWireConnections}).
+ */
+export declare const ConnectionBindingSchema: z.ZodObject<{
+    connectionId: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodString, z.ZodNumber]>>;
+    connection_id: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodString, z.ZodNumber]>>;
+}, z.core.$strip>;
+/**
+ * App-version binding: maps an app key to a pinned implementation/version.
+ * `implementationName` is the camelCase locator; `implementation_name` is a
+ * deprecated alias. Required-ness of the name is enforced by the wire mapper
+ * (see {@link toWireAppVersions}).
+ */
+export declare const AppVersionBindingSchema: z.ZodObject<{
+    implementationName: z.ZodOptional<z.ZodString>;
+    implementation_name: z.ZodOptional<z.ZodString>;
+    version: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type ConnectionEntryInput = z.infer<typeof ConnectionBindingSchema>;
+type AppVersionEntryInput = z.infer<typeof AppVersionBindingSchema>;
+/**
+ * Reshape a caller's `connections` map into the wire body. The nested
+ * locator is camelCase (`connectionId`) per SDK convention but the API
+ * expects `connection_id`; the deprecated snake_case alias is still
+ * accepted. The connection ID itself is required, so a missing one is a
+ * client-side validation error rather than a malformed request.
+ */
+export declare function toWireConnections(connections: Record<string, ConnectionEntryInput>): Record<string, {
+    connection_id: string | number;
+}>;
+/**
+ * Reshape a caller's `appVersions` map into the wire body, mapping the
+ * camelCase `implementationName` locator (and its deprecated snake_case
+ * alias) onto the API's `implementation_name`.
+ */
+export declare function toWireAppVersions(appVersions: Record<string, AppVersionEntryInput>): Record<string, {
+    implementation_name: string;
+    version?: string;
+}>;
+export {};
 //# sourceMappingURL=shared.d.ts.map

package/dist/plugins/codeSubstrate/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../src/plugins/codeSubstrate/shared.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB;;;CAGH,CAAC"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../src/plugins/codeSubstrate/shared.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB;;;CAGH,CAAC;AAEhC;;;GAGG;AACH,eAAO,MAAM,iBAAiB,uCAK0B,CAAC;AAYzD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,8DAQjC,CAAC;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;iBAIlC,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;;;;iBAYlC,CAAC;AAEH,KAAK,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACpE,KAAK,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAEpE;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,GAChD,MAAM,CAAC,MAAM,EAAE;IAAE,aAAa,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC,CAYpD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,GAChD,MAAM,CAAC,MAAM,EAAE;IAAE,mBAAmB,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAmBnE"}

package/dist/plugins/codeSubstrate/shared.js

@@ -1,3 +1,5 @@
+import { z } from "zod";
+import { ZapierValidationError } from "../../types/errors";
 /**
  * Method-meta defaults shared across every workflow plugin. Each plugin
  * spreads `...codeSubstrateDefaults` into its `createPluginMethod` /
@@ -13,3 +15,101 @@ export const codeSubstrateDefaults = {
     categories: ["code-workflow"],
     experimental: true,
 };
+/**
+ * Source files map, shared by `runDurable` and `publishWorkflowVersion`.
+ * Both require at least one file.
+ */
+export const SourceFilesSchema = z
+    .record(z.string(), z.string())
+    .refine((files) => Object.keys(files).length > 0, {
+    message: "sourceFiles must contain at least one file",
+})
+    .describe("Source files keyed by filename → contents");
+// Structural UUID match (8-4-4-4-12 hex), not `z.uuid()`. Both backends
+// validate `connection_id` with this same structural regex and intentionally
+// do NOT enforce RFC version/variant nibbles:
+//   - durableworkflowzaps `CreateWorkflowVersionRequest` (publishWorkflowVersion)
+//   - sdkdurableapi `StartRunRequest` (runDurable)
+// `z.uuid()` is stricter — it rejects non-RFC variants — so it would reject IDs
+// these backends accept. The SDK boundary must not be stricter than the wire.
+const UUID_PATTERN = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/;
+/**
+ * A Zapier connection ID accepted on the wire: a positive integer (legacy)
+ * or a UUID string (newer connections). Split into three union members so a
+ * bad value produces a precise message at the input boundary.
+ */
+export const ConnectionIdValueSchema = z
+    .union([
+    z.string().regex(/^[1-9][0-9]*$/, "must be a positive integer string"),
+    z.string().regex(UUID_PATTERN, "must be a UUID"),
+    z.number().int().positive(),
+])
+    .describe("Zapier connection ID. Accepts a positive integer (legacy) or a UUID string (newer connections).");
+/**
+ * Connection binding: maps a single alias to a concrete connection. The
+ * locator is camelCase (`connectionId`) per SDK convention; the snake_case
+ * `connection_id` is a deprecated alias. Both are optional in the schema so
+ * `.shape` stays introspectable for docs — the wire mapper enforces that one
+ * is present (see {@link toWireConnections}).
+ */
+export const ConnectionBindingSchema = z.object({
+    connectionId: ConnectionIdValueSchema.optional(),
+    /** @deprecated Use `connectionId` instead. */
+    connection_id: ConnectionIdValueSchema.optional().meta({ deprecated: true }),
+});
+/**
+ * App-version binding: maps an app key to a pinned implementation/version.
+ * `implementationName` is the camelCase locator; `implementation_name` is a
+ * deprecated alias. Required-ness of the name is enforced by the wire mapper
+ * (see {@link toWireAppVersions}).
+ */
+export const AppVersionBindingSchema = z.object({
+    implementationName: z
+        .string()
+        .min(1)
+        .optional()
+        .describe("Zapier app implementation name (e.g. `SlackCLIAPI`)"),
+    /** @deprecated Use `implementationName` instead. */
+    implementation_name: z.string().min(1).optional().meta({ deprecated: true }),
+    version: z
+        .string()
+        .optional()
+        .describe("Pinned app version (e.g. `1.27.1`). Latest if omitted."),
+});
+/**
+ * Reshape a caller's `connections` map into the wire body. The nested
+ * locator is camelCase (`connectionId`) per SDK convention but the API
+ * expects `connection_id`; the deprecated snake_case alias is still
+ * accepted. The connection ID itself is required, so a missing one is a
+ * client-side validation error rather than a malformed request.
+ */
+export function toWireConnections(connections) {
+    const wire = {};
+    for (const [alias, entry] of Object.entries(connections)) {
+        const connectionId = entry.connectionId ?? entry.connection_id;
+        if (connectionId === undefined) {
+            throw new ZapierValidationError(`connections["${alias}"] is missing connectionId`);
+        }
+        wire[alias] = { connection_id: connectionId };
+    }
+    return wire;
+}
+/**
+ * Reshape a caller's `appVersions` map into the wire body, mapping the
+ * camelCase `implementationName` locator (and its deprecated snake_case
+ * alias) onto the API's `implementation_name`.
+ */
+export function toWireAppVersions(appVersions) {
+    const wire = {};
+    for (const [key, entry] of Object.entries(appVersions)) {
+        const implementationName = entry.implementationName ?? entry.implementation_name;
+        if (implementationName === undefined) {
+            throw new ZapierValidationError(`appVersions["${key}"] is missing implementationName`);
+        }
+        wire[key] = {
+            implementation_name: implementationName,
+            ...(entry.version !== undefined ? { version: entry.version } : {}),
+        };
+    }
+    return wire;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapier/zapier-sdk",
-  "version": "0.72.0",
+  "version": "0.73.1",
   "description": "Complete Zapier SDK - combines all Zapier SDK packages",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",