@zapier/zapier-sdk 0.119.6 → 0.121.0

package/dist/{chunk-2XVA36IO.mjs → chunk-UGG7545M.mjs}

@@ -1,4 +1,4 @@
-import { taxonomy, DEFAULT_PAGE_SIZE, apiPluginRef, workflowIdResolver, extractErrorDetail, ZapierApiError, durableRunIdResolver, ZapierConflictError, workflowVersionIdResolver, workflowDraftIdResolver, workflowRunIdResolver, workflowDraftRevisionResolver, isZapierNotFoundError, ZapierTimeoutError, zapierSdkPlugin, SDK_VERSION, ZapierValidationError, sleep, zapierCoreOptions, SDK_OPTIONS_ID } from './chunk-CQ3C7UWQ.mjs';
+import { taxonomy, DEFAULT_PAGE_SIZE, apiPluginRef, workflowIdResolver, extractErrorDetail, ZapierApiError, durableRunIdResolver, ZapierConflictError, workflowVersionIdResolver, workflowDraftIdResolver, workflowRunIdResolver, workflowDraftRevisionResolver, isZapierNotFoundError, ZapierTimeoutError, zapierSdkPlugin, SDK_VERSION, ZapierValidationError, sleep, zapierCoreOptions, SDK_OPTIONS_ID } from './chunk-FEGI2THT.mjs';
 import { defineMethod, openEnum, defineResolver, definePlugin, createSdk, CORE_OPTIONS_ID } from '@zapier/kitcore';
 import { z } from 'zod';
 
@@ -282,8 +282,12 @@ var WorkflowItemSchema = z.object({
   disabled_reason: WorkflowDisabledReasonSchema.nullable().optional().describe(
     "Why the workflow is off, when system-disabled. Null when not system-disabled."
   ),
-  is_private: z.boolean().describe(
-    "Whether the workflow is private to the creating user. False means account-visible."
+  // No `.meta({ deprecated: true })`: that flag drops a field from the
+  // generated README, and the API still returns this one, so it stays
+  // documented while deprecated.
+  /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
+  is_private: z.boolean().nullish().describe(
+    "Whether the workflow is private to the creating user. False means account-visible. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
   ),
   created_by_user_id: z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
   current_version_id: z.string().nullable().describe(
@@ -383,8 +387,12 @@ var GetWorkflowResponseSchema = z.object({
   disabled_reason: WorkflowDisabledReasonSchema.nullable().optional().describe(
     "Why the workflow is off, when system-disabled. Null when not system-disabled. Independent of per-trigger claim status: an enabled workflow can still have a failed trigger."
   ),
-  is_private: z.boolean().describe(
-    "Whether the workflow is private to the creating user. False means account-visible."
+  // No `.meta({ deprecated: true })`: that flag drops a field from the
+  // generated README, and the API still returns this one, so it stays
+  // documented while deprecated.
+  /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
+  is_private: z.boolean().nullish().describe(
+    "Whether the workflow is private to the creating user. False means account-visible. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
   ),
   created_by_user_id: z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
   current_version: WorkflowVersionSchema2.optional().describe(
@@ -444,8 +452,12 @@ var CreateWorkflowResponseSchema = z.object({
   enabled: z.boolean().describe(
     "Whether the workflow currently accepts triggers. Always false on a new workflow until enabled."
   ),
-  is_private: z.boolean().describe(
-    "Whether the workflow is private to the creating user. False means account-visible."
+  // No `.meta({ deprecated: true })`: that flag drops a field from the
+  // generated README, and the API still returns this one, so it stays
+  // documented while deprecated.
+  /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
+  is_private: z.boolean().nullish().describe(
+    "Whether the workflow is private to the creating user. False means account-visible. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
   ),
   created_by_user_id: z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
   created_at: z.string().describe("When the workflow was created (ISO-8601)"),
@@ -525,8 +537,12 @@ var ImportedWorkflowSchema = z.object({
     "Whether the workflow accepts triggers. An import always lands disabled."
   ),
   disabled_reason: WorkflowDisabledReasonSchema.nullable().optional().describe("Why the workflow is off, when system-disabled."),
-  is_private: z.boolean().describe(
-    "Whether the workflow is private to the creating user. False means account-visible."
+  // No `.meta({ deprecated: true })`: that flag drops a field from the
+  // generated README, and the API still returns this one, so it stays
+  // documented while deprecated.
+  /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
+  is_private: z.boolean().nullish().describe(
+    "Whether the workflow is private to the creating user. False means account-visible. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
   ),
   source_zap_id: z.string().nullable().optional().describe("The Zap this workflow was imported from."),
   created_by_user_id: z.string(),
@@ -611,8 +627,12 @@ var UpdateWorkflowResponseSchema = z.object({
   trigger_url: WorkflowTriggerUrlSchema,
   editor_url: WorkflowEditorUrlSchema,
   enabled: z.boolean().describe("Whether the workflow currently accepts triggers"),
-  is_private: z.boolean().describe(
-    "Whether the workflow is private to the creating user. False means account-visible."
+  // No `.meta({ deprecated: true })`: that flag drops a field from the
+  // generated README, and the API still returns this one, so it stays
+  // documented while deprecated.
+  /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
+  is_private: z.boolean().nullish().describe(
+    "Whether the workflow is private to the creating user. False means account-visible. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
   ),
   created_by_user_id: z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
   created_at: z.string().describe("When the workflow was created (ISO-8601)"),
@@ -775,8 +795,12 @@ var RunItemSchema = z.object({
   execution_id: z.string().nullable().describe(
     "Linked execution ID. Null until the run leaves the `initialized` state."
   ),
-  is_private: z.boolean().describe(
-    "When true, the run is visible only to the creating user; otherwise visible across the account."
+  // No `.meta({ deprecated: true })`: that flag drops a field from the
+  // generated README, and the API still returns this one, so it stays
+  // documented while deprecated.
+  /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
+  is_private: z.boolean().nullish().describe(
+    "When true, the run is visible only to the creating user; when false, it is visible across the account. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
   ),
   created_at: z.string().describe("When the run was created (ISO-8601)"),
   updated_at: z.string().describe("When the run was last updated (ISO-8601)")
@@ -918,8 +942,12 @@ var GetDurableRunResponseSchema = z.object({
   execution: ExecutionSummarySchema.nullable().describe(
     "Linked execution, including the operations journal. Null while the run is still in `initialized` state."
   ),
-  is_private: z.boolean().describe(
-    "When true, the run is visible only to the creating user; otherwise visible across the account."
+  // No `.meta({ deprecated: true })`: that flag drops a field from the
+  // generated README, and the API still returns this one, so it stays
+  // documented while deprecated.
+  /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
+  is_private: z.boolean().nullish().describe(
+    "When true, the run is visible only to the creating user; when false, it is visible across the account. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
   ),
   created_at: z.string().describe("When the run was created (ISO-8601)"),
   updated_at: z.string().describe("When the run was last updated (ISO-8601)")
@@ -1001,8 +1029,12 @@ var RunDurableResponseSchema = z.object({
   status: z.literal("initialized").describe(
     "Always `initialized` on creation. Poll via getDurableRun to observe the run advancing to `started` / `finished` / `failed` / `cancelled`."
   ),
-  is_private: z.boolean().describe(
-    "When true, the run is visible only to the creating user; otherwise visible across the account."
+  // No `.meta({ deprecated: true })`: that flag drops a field from the
+  // generated README, and the API still returns this one, so it stays
+  // documented while deprecated.
+  /** @deprecated May be removed from the API in a future release. No replacement; do not rely on this value. */
+  is_private: z.boolean().nullish().describe(
+    "When true, the run is visible only to the creating user; when false, it is visible across the account. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false."
   ),
   created_at: z.string().describe("When the run was created (ISO-8601)")
 });
@@ -2283,7 +2315,10 @@ var runWorkflowPlugin = defineMethod({
 });
 var MAX_SOURCE_FILES_COUNT = 50;
 var MAX_SOURCE_FILE_LENGTH = 2e5;
+var MAX_TRIGGER_CONFIGURATIONS_COUNT = 20;
+var MAX_CONNECTIONS_COUNT = 100;
 var DEFAULT_ENTRYPOINT_FILE = "/workflow.ts";
+var TRIGGER_NODE_ID_PATTERN = /^workflow-trigger-[0-9]+$/;
 var EXAMPLE_SOURCE_FILES = {
   [DEFAULT_ENTRYPOINT_FILE]: 'import { defineDurable } from "@zapier/zapier-durable"; export default defineDurable({ name: "hello-world", run: async (ctx) => { return ctx.step("greet", async () => "Hello, world!"); } });'
 };
@@ -2295,10 +2330,65 @@ var WorkflowValidationSourceFilesSchema = z.record(
 }).refine((files) => Object.keys(files).length <= MAX_SOURCE_FILES_COUNT, {
   message: `sourceFiles must contain at most ${MAX_SOURCE_FILES_COUNT} files`
 }).describe("Exact TypeScript sources keyed by absolute logical path.").meta({ example: EXAMPLE_SOURCE_FILES });
+var WorkflowCheckGroupSchema = z.enum(["source", "access"]).describe(
+  "`source` runs checks that read only the request. `access` looks up the app, action, connection, and trigger references against Zapier and the caller's account."
+);
+var WorkflowIssueSeveritySchema = z.enum(["error", "warning", "info", "hint"]).describe("Diagnostic severity.");
+var WorkflowValidationTriggerSchema = z.object({
+  selectedApi: z.string().optional().describe(
+    "Zapier implementation id the trigger is published with, e.g. `ScheduleCLIAPI@1.6.0`. Checked for a version pin and, with `action`, that the trigger exists."
+  ),
+  app: z.string().optional().describe("Key of the app the trigger belongs to."),
+  appTitle: z.string().optional().describe("Display name of the app the trigger belongs to."),
+  action: z.string().optional().describe("Trigger action key on the app."),
+  actionTitle: z.string().optional().describe("Display name of the trigger action."),
+  params: z.record(z.string(), z.unknown()).optional().describe(
+    "Trigger settings keyed by field key. When set, checked against the trigger's fields."
+  )
+}).describe("Trigger configuration for one trigger node.");
 var ValidateWorkflowOptionsSchema = z.object({
   sourceFiles: WorkflowValidationSourceFilesSchema,
   entrypointFile: z.string().regex(/^\//, "entrypointFile must start with /").optional().describe(
     "Absolute logical path of the entry file in sourceFiles. Defaults to /workflow.ts."
+  ),
+  zapierDurableVersion: z.string().min(1).optional().describe(
+    'Version of @zapier/zapier-durable the workflow will run on, e.g. "1.2.3". Version checks are skipped when omitted or "latest".'
+  ),
+  dependencies: z.record(z.string(), z.string()).optional().describe(
+    "npm package dependencies keyed by package name. Dependency checks are skipped when omitted."
+  ),
+  checkGroups: z.array(WorkflowCheckGroupSchema).min(1).refine((groups) => new Set(groups).size === groups.length, {
+    message: "checkGroups must not repeat a group"
+  }).optional().describe(
+    "Check groups to run. Runs every group when omitted. Pass only `source` to skip the account lookups, e.g. while code is being edited."
+  ),
+  severity: WorkflowIssueSeveritySchema.optional().describe(
+    "Return only issues with exactly this severity, and skip checks that only report other severities. Returns every issue when omitted."
+  ),
+  triggerConfigurations: z.record(z.string(), WorkflowValidationTriggerSchema).superRefine((triggers, ctx) => {
+    for (const key of Object.keys(triggers)) {
+      if (!TRIGGER_NODE_ID_PATTERN.test(key)) {
+        ctx.addIssue({
+          code: "custom",
+          message: `triggerConfigurations keys must be trigger node ids like workflow-trigger-0; got '${key}'`
+        });
+      }
+    }
+  }).refine(
+    (triggers) => Object.keys(triggers).length <= MAX_TRIGGER_CONFIGURATIONS_COUNT,
+    {
+      message: `triggerConfigurations must contain at most ${MAX_TRIGGER_CONFIGURATIONS_COUNT} triggers`
+    }
+  ).optional().describe(
+    'Trigger configurations keyed by trigger node id (`workflow-trigger-{i}`). The trigger isn\'t in the source, so it\'s only checked when sent, e.g. `{ "workflow-trigger-0": { "selectedApi": "ScheduleCLIAPI@1.6.0", "action": "everyDay" } }`.'
+  ),
+  connections: z.record(z.string(), ConnectionBindingSchema).refine(
+    (connections) => Object.keys(connections).length <= MAX_CONNECTIONS_COUNT,
+    {
+      message: `connections must contain at most ${MAX_CONNECTIONS_COUNT} aliases`
+    }
+  ).optional().describe(
+    'Named connection aliases the source uses. Maps each alias to its Zapier connection ID, e.g. `{ "slack": { "connectionId": 123 } }`. Aliases are only checked when sent.'
   )
 }).refine(
   ({ sourceFiles, entrypointFile }) => (entrypointFile ?? DEFAULT_ENTRYPOINT_FILE) in sourceFiles,
@@ -2321,11 +2411,29 @@ var WorkflowValidationIssueSchema = z.object({
     "Extensible diagnostic category; clients must accept unfamiliar values."
   ),
   message: z.string().describe("Safe human-readable explanation."),
-  // Unlike `kind`, severity is a closed vocabulary on the analyzer side: a
-  // new value requires a new API version, and every issue carries one, so
-  // callers can rank findings without a missing-severity branch.
-  severity: z.enum(["error", "warning", "info", "hint"]).describe("Diagnostic severity."),
+  title: z.string().optional().describe(
+    "Short label for the issue, safe to show in place of `message` where space is short. Omitted for kinds with no title yet; fall back to `message`."
+  ),
+  severity: WorkflowIssueSeveritySchema,
   suggestion: z.string().optional().describe("Actionable fix hint."),
+  fix: z.string().optional().describe(
+    "Extensible: what resolves the issue. Known values are `agent` (change the source), `upgrade` (change the account's plan) and `retry` (a lookup failed; validate again). Omitted or unknown means `agent`."
+  ),
+  incomplete: z.boolean().optional().describe(
+    "`true` when the issue means the workflow isn't finished yet rather than wrong, e.g. no steps yet. Still blocks publish."
+  ),
+  app_key: z.string().optional().describe(
+    "Implementation id of the app the issue is about, e.g. `SlackCLIAPI`. Set on `admin-restricted-app`."
+  ),
+  connection_id: z.string().optional().describe(
+    "Zapier connection id the issue is about, as a string. Set on connection issues."
+  ),
+  connection_alias: z.string().optional().describe(
+    "Connection alias the source used, a key of the request's `connections`. Set on connection issues when the source named the connection by alias."
+  ),
+  unchecked_kind: z.string().optional().describe(
+    "On `check-unavailable`, the issue kind whose check couldn't run because a lookup failed. Validating again retries it."
+  ),
   source: WorkflowValidationSourceLocationSchema.optional().describe(
     "Affected source location."
   ),
@@ -2334,6 +2442,19 @@ var WorkflowValidationIssueSchema = z.object({
   ),
   syntax_kind: z.string().optional().describe(
     "TypeScript AST node kind the diagnostic was raised against (e.g. `CallExpression`)."
+  ),
+  state_path: z.string().optional().describe("Workflow state path the issue is about."),
+  projection_node_id: z.string().optional().describe(
+    "Diagram node the issue is about. Validation sets it only on trigger issues, to the trigger node id (`workflow-trigger-{i}`)."
+  ),
+  configuration_id: z.string().optional().describe(
+    "Canonical configuration reference. Validation currently leaves it unset."
+  ),
+  operation_id: z.string().optional().describe(
+    "Canonical operation that owns the issue, when unambiguous. Match against diagram nodes' `operation_ids` for the same source."
+  ),
+  region_id: z.string().optional().describe(
+    "Immediate canonical parent region of the owning operation. May have no visible container in the diagram."
   )
 });
 var ValidateWorkflowResponseSchema = z.object({
@@ -2341,6 +2462,24 @@ var ValidateWorkflowResponseSchema = z.object({
 });
 
 // src/plugins/codeSubstrate/validateWorkflow/index.ts
+function toWireTriggerConfigurations(triggers) {
+  return Object.fromEntries(
+    Object.entries(triggers).map(([nodeId, trigger]) => {
+      const wire = {};
+      if (trigger.selectedApi !== void 0) {
+        wire.selected_api = trigger.selectedApi;
+      }
+      if (trigger.app !== void 0) wire.app_key = trigger.app;
+      if (trigger.appTitle !== void 0) wire.app_title = trigger.appTitle;
+      if (trigger.action !== void 0) wire.action_key = trigger.action;
+      if (trigger.actionTitle !== void 0) {
+        wire.action_title = trigger.actionTitle;
+      }
+      if (trigger.params !== void 0) wire.params = trigger.params;
+      return [nodeId, wire];
+    })
+  );
+}
 var validateWorkflowPlugin = defineMethod({
   ...codeSubstrateDefaults,
   name: "validateWorkflow",
@@ -2358,10 +2497,31 @@ var validateWorkflowPlugin = defineMethod({
     if (input.entrypointFile !== void 0) {
       body.entrypoint_file = input.entrypointFile;
     }
+    if (input.zapierDurableVersion !== void 0) {
+      body.zapier_durable_version = input.zapierDurableVersion;
+    }
+    if (input.dependencies !== void 0) {
+      body.dependencies = input.dependencies;
+    }
+    if (input.checkGroups !== void 0) {
+      body.check_groups = input.checkGroups;
+    }
+    if (input.triggerConfigurations !== void 0) {
+      body.trigger_configurations = toWireTriggerConfigurations(
+        input.triggerConfigurations
+      );
+    }
+    if (input.connections !== void 0) {
+      body.connections = toWireConnections(input.connections);
+    }
     const raw = await imports.api.post(
       `${CODE_SUBSTRATE_ANALYZER_API}/validations`,
       body,
-      { authRequired: true }
+      {
+        authRequired: true,
+        // The analyzer rejects `severity` in the body; it is a query parameter.
+        ...input.severity === void 0 ? {} : { searchParams: { severity: input.severity } }
+      }
     );
     return { data: ValidateWorkflowResponseSchema.parse(raw) };
   }