@zapier/zapier-sdk-cli 0.38.1 → 0.39.0

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { Command, CommanderError } from 'commander';
+import { Command, CommanderError, Option } from 'commander';
 import { z } from 'zod';
 import { createFunction, OutputPropertySchema, DEFAULT_CONFIG_PATH, injectCliLogin, BaseSdkOptionsSchema, createZapierSdkWithoutRegistry, registryPlugin, ZapierError, ZapierValidationError, ZapierUnknownError, batch, toSnakeCase, buildApplicationLifecycleEvent, isCredentialsObject, isPositional, runWithTelemetryContext, buildCapabilityMessage, formatErrorMessage, getOsInfo, getPlatformVersions, getCiPlatform, isCi, getReleaseId, getCurrentTimestamp, generateEventId } from '@zapier/zapier-sdk';
 import inquirer from 'inquirer';
@@ -797,11 +797,11 @@ Optional fields${pathContext}:`));
       );
       this.startSpinner();
       const page = await context.sdk.listInputFieldChoices({
-        appKey: context.resolvedParams.appKey,
-        actionKey: context.resolvedParams.actionKey,
+        app: context.resolvedParams.app,
+        action: context.resolvedParams.action,
         actionType: context.resolvedParams.actionType,
-        connectionId: context.resolvedParams.connectionId,
-        inputFieldKey: fieldMeta.key,
+        connection: context.resolvedParams.connection,
+        inputField: fieldMeta.key,
         inputs,
         ...cursor && { cursor }
       });
@@ -1065,7 +1065,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
 
 // package.json
 var package_default = {
-  version: "0.38.1"};
+  version: "0.39.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -1621,13 +1621,15 @@ function analyzeZodSchema(schema, functionInfo) {
   return parameters;
 }
 function analyzeZodField(name, schema, functionInfo) {
-  if (functionInfo?.deprecatedParameters?.includes(name)) {
-    return null;
-  }
   let baseSchema = schema;
   let required = true;
   let defaultValue = void 0;
+  let isDeprecated = false;
   while (true) {
+    const meta = baseSchema.meta?.();
+    if (meta?.deprecated) {
+      isDeprecated = true;
+    }
     if (baseSchema instanceof z.ZodOptional) {
       required = false;
       baseSchema = baseSchema._zod.def.innerType;
@@ -1683,7 +1685,8 @@ function analyzeZodField(name, schema, functionInfo) {
     choices,
     hasResolver: paramHasResolver,
     isPositional: isPositional(schema),
-    elementType
+    elementType,
+    hidden: isDeprecated
   };
 }
 function analyzeInputParameters(inputParameters, functionInfo) {
@@ -1698,9 +1701,6 @@ function analyzeInputParameters(inputParameters, functionInfo) {
     if (schema instanceof z.ZodObject) {
       const shape = schema.shape;
       for (const [key, fieldSchema] of Object.entries(shape)) {
-        if (functionInfo?.deprecatedParameters?.includes(key)) {
-          continue;
-        }
         const analyzed = analyzeZodField(
           key,
           fieldSchema,
@@ -1863,6 +1863,15 @@ function createCommandConfig(cliCommandName, functionInfo, sdk2) {
         args.slice(0, -1),
         options2
       );
+      const schemaAliases = schema?.meta?.()?.aliases;
+      if (schemaAliases) {
+        for (const [oldName, newName] of Object.entries(schemaAliases)) {
+          if (oldName in rawParams && !(newName in rawParams)) {
+            rawParams[newName] = rawParams[oldName];
+            delete rawParams[oldName];
+          }
+        }
+      }
       if (schema && !usesInputParameters) {
         const resolver = new SchemaParameterResolver();
         resolvedParams = await resolver.resolveParameters(
@@ -1980,7 +1989,7 @@ ${confirmMessageAfter}`));
             cli_arguments: sanitizeCliArguments(process.argv.slice(2))
           },
           context: {
-            selected_api: resolvedParams.appKey ?? null
+            selected_api: resolvedParams.app ?? null
           }
         });
         sdk2.getContext().eventEmission.emit(CLI_COMMAND_EXECUTED_EVENT_SUBJECT, event);
@@ -2044,17 +2053,26 @@ function addCommand(program2, commandName, config) {
       }
       flags.push(`--${kebabName}`);
       if (param.type === "boolean") {
-        command.option(flags.join(", "), param.description);
+        const opt = new Option(flags.join(", "), param.description);
+        if (param.hidden) opt.hideHelp();
+        command.addOption(opt);
       } else if (param.type === "array") {
         const flagSignature = flags.join(", ") + ` <value>`;
-        command.option(flagSignature, param.description || "", collect, []);
+        const opt = new Option(flagSignature, param.description || "");
+        opt.default([]);
+        opt.argParser(
+          (value, previous) => (previous || []).concat([value])
+        );
+        if (param.hidden) opt.hideHelp();
+        command.addOption(opt);
       } else {
         const flagSignature = flags.join(", ") + ` <${param.type}>`;
-        command.option(
-          flagSignature,
-          param.description || "",
-          param.default
-        );
+        const opt = new Option(flagSignature, param.description || "");
+        if (param.default !== void 0) {
+          opt.default(param.default);
+        }
+        if (param.hidden) opt.hideHelp();
+        command.addOption(opt);
       }
     }
   });
@@ -2607,10 +2625,10 @@ var getLoginConfigPathPlugin = () => {
   };
 };
 var AddSchema = z.object({
-  appKeys: z.array(z.string().min(1, "App key cannot be empty")).min(1, "At least one app key is required").describe(
+  apps: z.array(z.string().min(1, "App key cannot be empty")).min(1, "At least one app key is required").describe(
     "One or more app keys to add (e.g., 'slack', 'github', 'trello')"
   ),
-  connectionIds: z.array(z.string()).optional().describe(
+  connections: z.array(z.string()).optional().describe(
     "Connection IDs to use for type generation (e.g., ['123', '456'])"
   ),
   configPath: z.string().optional().describe(
@@ -2636,8 +2654,8 @@ async function detectTypesOutputDirectory() {
 var addPlugin = ({ sdk: sdk2 }) => {
   const add = createFunction(async function add2(options) {
     const {
-      appKeys,
-      connectionIds,
+      apps: appKeys,
+      connections: connectionIds,
       configPath,
       typesOutput = await detectTypesOutputDirectory()
     } = options;
@@ -2659,17 +2677,17 @@ var addPlugin = ({ sdk: sdk2 }) => {
           }
           break;
         case "app_processing_start":
-          const appName = event.slug ? `${event.slug} (${event.appKey})` : event.appKey;
+          const appName = event.slug ? `${event.slug} (${event.app})` : event.app;
           console.log(`\u{1F4E6} Adding ${appName}...`);
           break;
         case "manifest_updated":
-          const appDisplay = appSlugAndKeyMap.get(event.appKey) || event.appKey;
+          const appDisplay = appSlugAndKeyMap.get(event.app) || event.app;
           console.log(
-            `\u{1F4DD} Locked ${appDisplay} to ${event.appKey}@${event.version} using key '${event.manifestKey}'`
+            `\u{1F4DD} Locked ${appDisplay} to ${event.app}@${event.version} using key '${event.manifestKey}'`
           );
           break;
         case "app_processing_error":
-          const errorApp = appSlugAndKeyMap.get(event.appKey) || event.appKey;
+          const errorApp = appSlugAndKeyMap.get(event.app) || event.app;
           console.warn(`\u26A0\uFE0F ${event.error} for ${errorApp}`);
           break;
       }
@@ -2683,13 +2701,13 @@ var addPlugin = ({ sdk: sdk2 }) => {
           console.log(`\u{1F510} Found ${event.count} connection(s)`);
           break;
         case "connection_matched":
-          const appWithConnection = appSlugAndKeyMap.get(event.appKey) || event.appKey;
+          const appWithConnection = appSlugAndKeyMap.get(event.app) || event.app;
           console.log(
             `\u{1F510} Using connection ${event.connectionId} (${event.connectionTitle}) for ${appWithConnection}`
           );
           break;
         case "connection_not_matched":
-          const appWithoutConnection = appSlugAndKeyMap.get(event.appKey) || event.appKey;
+          const appWithoutConnection = appSlugAndKeyMap.get(event.app) || event.app;
           console.warn(
             `\u26A0\uFE0F No matching connection found for ${appWithoutConnection}`
           );
@@ -2700,20 +2718,20 @@ var addPlugin = ({ sdk: sdk2 }) => {
           );
           break;
         case "app_processing_error":
-          const errorApp = appSlugAndKeyMap.get(event.appKey) || event.appKey;
+          const errorApp = appSlugAndKeyMap.get(event.app) || event.app;
           console.warn(`\u26A0\uFE0F ${event.error} for ${errorApp}`);
           break;
       }
     };
     const manifestResult = await sdk2.buildManifest({
-      appKeys,
+      apps: appKeys,
       skipWrite: false,
       configPath,
       onProgress: handleManifestProgress
     });
     const typesResult = await sdk2.generateAppTypes({
-      appKeys,
-      connectionIds,
+      apps: appKeys,
+      connections: connectionIds,
       skipWrite: false,
       typesOutputDirectory: resolvedTypesOutput,
       onProgress: handleTypesProgress
@@ -2739,10 +2757,10 @@ var addPlugin = ({ sdk: sdk2 }) => {
   };
 };
 var GenerateAppTypesSchema = z.object({
-  appKeys: z.array(z.string().min(1, "App key cannot be empty")).min(1, "At least one app key is required").describe(
+  apps: z.array(z.string().min(1, "App key cannot be empty")).min(1, "At least one app key is required").describe(
     "One or more app keys to generate types for (e.g., 'slack', 'github', 'trello')"
   ),
-  connectionIds: z.array(z.string()).optional().describe(
+  connections: z.array(z.string()).optional().describe(
     "Connection IDs to use for type generation (e.g., ['123', '456'])"
   ),
   skipWrite: z.boolean().optional().describe(
@@ -2844,10 +2862,10 @@ Usage:
   
   const zapier = createZapierSdk();
   // Types are automatically available:
-  await zapier.apps.${preferredKey}.search.user_by_email({ connectionId: 123, inputs: { email } })
+  await zapier.apps.${preferredKey}.search.user_by_email({ connection: 123, inputs: { email } })
 
   // Factory usage (pinned connection):
-  const ${myVariableName} = zapier.apps.${preferredKey}({ connectionId: 123 })
+  const ${myVariableName} = zapier.apps.${preferredKey}({ connection: 123 })
   await ${myVariableName}.search.user_by_email({ inputs: { email } })`;
     const statements = [
       // Import the SDK to activate module augmentation
@@ -2857,6 +2875,7 @@ Usage:
         [
           "ActionExecutionOptions",
           "ActionExecutionResult",
+          "AppFactoryInput",
           "ZapierFetchInitOptions"
         ],
         "@zapier/zapier-sdk"
@@ -3182,17 +3201,7 @@ Usage:
           void 0,
           "options",
           void 0,
-          this.factory.createTypeLiteralNode([
-            this.factory.createPropertySignature(
-              void 0,
-              "connectionId",
-              void 0,
-              this.factory.createUnionTypeNode([
-                this.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
-                this.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)
-              ])
-            )
-          ])
+          this.factory.createTypeReferenceNode("AppFactoryInput")
         )
       ],
       this.factory.createTypeReferenceNode(`${appName}AppProxy`)
@@ -3356,8 +3365,8 @@ function createManifestEntry(app) {
 var generateAppTypesPlugin = ({ sdk: sdk2 }) => {
   const generateAppTypes = createFunction(async function generateAppTypes2(options) {
     const {
-      appKeys,
-      connectionIds,
+      apps: appKeys,
+      connections: connectionIds,
       skipWrite = false,
       typesOutputDirectory = await detectTypesOutputDirectory(),
       onProgress
@@ -3367,7 +3376,7 @@ var generateAppTypesPlugin = ({ sdk: sdk2 }) => {
       typeDefinitions: {}
     };
     onProgress?.({ type: "apps_lookup_start", count: appKeys.length });
-    const appsIterable = sdk2.listApps({ appKeys }).items();
+    const appsIterable = sdk2.listApps({ apps: appKeys }).items();
     const apps = [];
     for await (const app of appsIterable) {
       apps.push(app);
@@ -3383,7 +3392,7 @@ var generateAppTypesPlugin = ({ sdk: sdk2 }) => {
         type: "connections_lookup_start",
         count: connectionIds.length
       });
-      const connectionsIterable = sdk2.listConnections({ connectionIds }).items();
+      const connectionsIterable = sdk2.listConnections({ connections: connectionIds }).items();
       for await (const connection of connectionsIterable) {
         connections.push(connection);
       }
@@ -3401,7 +3410,7 @@ var generateAppTypesPlugin = ({ sdk: sdk2 }) => {
     for (const app of apps) {
       onProgress?.({
         type: "app_processing_start",
-        appKey: app.key,
+        app: app.key,
         slug: app.slug
       });
       try {
@@ -3409,7 +3418,7 @@ var generateAppTypesPlugin = ({ sdk: sdk2 }) => {
           const errorMessage = `Invalid implementation ID format: ${app.implementation_id}. Expected format: <implementationName>@<version>`;
           onProgress?.({
             type: "app_processing_error",
-            appKey: app.key,
+            app: app.key,
             error: errorMessage
           });
           throw new ZapierValidationError(errorMessage, {
@@ -3428,14 +3437,14 @@ var generateAppTypesPlugin = ({ sdk: sdk2 }) => {
             connectionId = matchingConnection.id;
             onProgress?.({
               type: "connection_matched",
-              appKey: app.key,
+              app: app.key,
               connectionId: matchingConnection.id,
               connectionTitle: matchingConnection.title || ""
             });
           } else {
             onProgress?.({
               type: "connection_not_matched",
-              appKey: app.key
+              app: app.key
             });
           }
         }
@@ -3464,13 +3473,13 @@ var generateAppTypesPlugin = ({ sdk: sdk2 }) => {
         }
         onProgress?.({
           type: "app_processing_complete",
-          appKey: app.key
+          app: app.key
         });
       } catch (error) {
         const errorMessage = `Failed to process app ${app.key}: ${error instanceof Error ? error.message : String(error)}`;
         onProgress?.({
           type: "app_processing_error",
-          appKey: app.key,
+          app: app.key,
           error: errorMessage
         });
         if (error instanceof ZapierValidationError) {
@@ -3498,7 +3507,7 @@ var generateAppTypesPlugin = ({ sdk: sdk2 }) => {
   };
 };
 var BuildManifestSchema = z.object({
-  appKeys: z.array(z.string().min(1, "App key cannot be empty")).min(1, "At least one app key is required").describe(
+  apps: z.array(z.string().min(1, "App key cannot be empty")).min(1, "At least one app key is required").describe(
     "One or more app keys to build manifest entries for (e.g., 'slack', 'github', 'trello')"
   ),
   skipWrite: z.boolean().optional().describe(
@@ -3514,9 +3523,14 @@ var BuildManifestSchema = z.object({
 // src/plugins/buildManifest/index.ts
 var buildManifestPlugin = ({ sdk: sdk2, context }) => {
   const buildManifest = createFunction(async function buildManifest2(options) {
-    const { appKeys, skipWrite = false, configPath, onProgress } = options;
+    const {
+      apps: appKeys,
+      skipWrite = false,
+      configPath,
+      onProgress
+    } = options;
     onProgress?.({ type: "apps_lookup_start", count: appKeys.length });
-    const appsIterable = sdk2.listApps({ appKeys }).items();
+    const appsIterable = sdk2.listApps({ apps: appKeys }).items();
     const apps = [];
     for await (const app of appsIterable) {
       apps.push(app);
@@ -3530,14 +3544,14 @@ var buildManifestPlugin = ({ sdk: sdk2, context }) => {
     for (const app of apps) {
       onProgress?.({
         type: "app_processing_start",
-        appKey: app.key,
+        app: app.key,
         slug: app.slug
       });
       try {
         const manifestEntry = createManifestEntry(app);
         onProgress?.({
           type: "manifest_entry_built",
-          appKey: app.key,
+          app: app.key,
           manifestKey: manifestEntry.implementationName,
           version: manifestEntry.version || ""
         });
@@ -3551,16 +3565,16 @@ var buildManifestPlugin = ({ sdk: sdk2, context }) => {
         updatedManifest = manifest;
         onProgress?.({
           type: "manifest_updated",
-          appKey: app.key,
+          app: app.key,
           manifestKey: updatedManifestKey,
           version: manifestEntry.version || ""
         });
-        onProgress?.({ type: "app_processing_complete", appKey: app.key });
+        onProgress?.({ type: "app_processing_complete", app: app.key });
       } catch (error) {
         const errorMessage = `Failed to process app ${app.key}: ${error instanceof Error ? error.message : String(error)}`;
         onProgress?.({
           type: "app_processing_error",
-          appKey: app.key,
+          app: app.key,
           error: errorMessage
         });
         if (error instanceof ZapierValidationError) {
@@ -3680,7 +3694,9 @@ var CurlSchema = z.object({
   maxTime: z.number().optional().describe("Maximum time in seconds for the request"),
   user: z.string().optional().describe("Basic auth credentials as 'user:password'"),
   compressed: z.boolean().optional().describe("Request compressed response (sends Accept-Encoding header)"),
-  connectionId: z.union([z.string(), z.number()]).optional().describe("Zapier connection ID for authentication")
+  connection: z.union([z.string(), z.number()]).optional().describe("Zapier connection ID or alias for authentication"),
+  /** @deprecated Use `connection` instead. */
+  connectionId: z.union([z.string(), z.number()]).optional().meta({ deprecated: true })
 }).describe("Make HTTP requests through Zapier Relay with curl-like options");
 var CurlExitError = class extends Error {
   constructor(message, exitCode) {
@@ -3855,8 +3871,10 @@ var curlPlugin = ({
       maxTime,
       user,
       compressed,
+      connection: connectionParam,
       connectionId
     } = options;
+    const connection = connectionParam ?? connectionId;
     const parsedUrl = new URL(rawUrl);
     const headers = {};
     for (const h of header) {
@@ -3964,7 +3982,7 @@ var curlPlugin = ({
       body,
       redirect,
       signal,
-      connectionId
+      connection
     });
     const timeTotalSeconds = (performance.now() - start) / 1e3;
     if (verbose && !silent) {
@@ -4600,7 +4618,7 @@ function createZapierCliSdk(options = {}) {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.38.1"};
+  version: "0.39.0"};
 var ONE_DAY_MS = 24 * 60 * 60 * 1e3;
 var CACHE_RESET_INTERVAL_MS = (() => {
   const { ZAPIER_SDK_UPDATE_CHECK_INTERVAL_MS = `${ONE_DAY_MS}` } = process.env;