@zapier/zapier-sdk-cli 0.31.2 → 0.32.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @zapier/zapier-sdk-cli
 
+## 0.32.0
+
+### Minor Changes
+
+- 4a874c6: Add Zod schema for base SDK options, autodoc generation for SDK factory options and CLI base command options
+
+### Patch Changes
+
+- Updated dependencies [4a874c6]
+  - @zapier/zapier-sdk@0.31.0
+  - @zapier/zapier-sdk-mcp@0.9.6
+
 ## 0.31.2
 
 ### Patch Changes

package/README.md

@@ -83,20 +83,20 @@ npx zapier-sdk fetch "https://gmail.googleapis.com/gmail/v1/users/me/labels" --c
 
 These options are available for all commands:
 
-| Option                                 | Short | Description                                        |
-| -------------------------------------- | ----- | -------------------------------------------------- |
-| `--version`                            | `-V`  | Display version number                             |
-| `--help`                               | `-h`  | Display help for command                           |
-| `--debug`                              |       | Enable debug logging                               |
-| `--json`                               |       | Output raw JSON instead of formatted results       |
-| `--base-url <url>`                     |       | Base URL for Zapier API endpoints                  |
-| `--credentials <token>`                |       | Authentication token                               |
-| `--credentials-client-id <id>`         |       | OAuth client ID for authentication                 |
-| `--credentials-client-secret <secret>` |       | OAuth client secret for authentication             |
-| `--credentials-base-url <url>`         |       | Base URL for authentication endpoints              |
-| `--tracking-base-url <url>`            |       | Base URL for Zapier tracking endpoints             |
-| `--max-network-retries <count>`        |       | Max retries for rate-limited requests (default: 3) |
-| `--max-network-retry-delay-ms <ms>`    |       | Max delay in ms to wait for retry (default: 60000) |
+| Option                                 | Short | Description                                         |
+| -------------------------------------- | ----- | --------------------------------------------------- |
+| `--version`                            | `-V`  | Display version number                              |
+| `--help`                               | `-h`  | Display help for command                            |
+| `--credentials <token>`                |       | Authentication token.                               |
+| `--credentials-client-id <id>`         |       | OAuth client ID for authentication.                 |
+| `--credentials-client-secret <secret>` |       | OAuth client secret for authentication.             |
+| `--credentials-base-url <url>`         |       | Override authentication base URL.                   |
+| `--debug`                              |       | Enable debug logging.                               |
+| `--base-url <url>`                     |       | Base URL for Zapier API endpoints.                  |
+| `--tracking-base-url <url>`            |       | Base URL for Zapier tracking endpoints.             |
+| `--max-network-retries <count>`        |       | Max retries for rate-limited requests (default: 3). |
+| `--max-network-retry-delay-ms <ms>`    |       | Max delay in ms to wait for retry (default: 60000). |
+| `--json`                               |       | Output raw JSON instead of formatted results        |
 
 ## Available Commands
 

package/dist/cli.cjs

@@ -876,6 +876,36 @@ function formatItemsGeneric(items, startingNumber = 0) {
     formatSingleItem(formatted, startingNumber + index);
   });
 }
+
+// src/utils/cli-options.ts
+var RESERVED_CLI_OPTIONS = [
+  {
+    name: "version" /* Version */,
+    flag: "--version",
+    short: "-V",
+    description: "Display version number"
+  },
+  {
+    name: "help" /* Help */,
+    flag: "--help",
+    short: "-h",
+    description: "Display help for command"
+  }
+];
+function getReservedCliOption(name) {
+  const option = RESERVED_CLI_OPTIONS.find((opt) => opt.name === name);
+  if (!option) throw new Error(`Reserved CLI option not found: ${name}`);
+  return option;
+}
+var SHARED_COMMAND_CLI_OPTIONS = [
+  {
+    name: "json",
+    flag: "--json",
+    description: "Output raw JSON instead of formatted results"
+  }
+];
+
+// src/utils/cli-generator.ts
 var CONFIRM_MESSAGES = {
   "create-secret": {
     messageBefore: "You are about to create a sensitive secret that will be displayed as plain text.\nOnce created, you cannot retrieve it again.",
@@ -1343,10 +1373,12 @@ function addCommand(program2, commandName, config2) {
       }
     }
   });
-  const hasJsonParam = config2.parameters.some((p) => p.name === "json");
-  if (!hasJsonParam) {
-    command.option("--json", "Output raw JSON instead of formatted results");
-  }
+  const paramNames = new Set(config2.parameters.map((p) => p.name));
+  SHARED_COMMAND_CLI_OPTIONS.forEach((opt) => {
+    if (!paramNames.has(opt.name)) {
+      command.option(opt.flag, opt.description);
+    }
+  });
   command.action(config2.handler);
 }
 function convertCliArgsToSdkParams(parameters, positionalArgs, options) {
@@ -1804,7 +1836,7 @@ var LoginSchema = zod.z.object({
 
 // package.json
 var package_default = {
-  version: "0.31.2"};
+  version: "0.32.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -3583,7 +3615,7 @@ function createZapierCliSdk(options = {}) {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.31.2"};
+  version: "0.32.0"};
 function detectPackageManager(cwd = process.cwd()) {
   const ua = process.env.npm_config_user_agent;
   if (ua) {
@@ -3786,7 +3818,13 @@ async function checkAndNotifyUpdates({
 
 // src/cli.ts
 var program = new commander.Command();
-program.name("zapier-sdk").description("CLI for Zapier SDK").version(package_default2.version, void 0, "Display version number").option("--debug", "Enable debug logging").option("--base-url <url>", "Base URL for Zapier API endpoints").option("--credentials <token>", "Authentication token").option("--credentials-client-id <id>", "OAuth client ID for authentication").option(
+var versionOption = getReservedCliOption("version" /* Version */);
+var helpOption = getReservedCliOption("help" /* Help */);
+program.name("zapier-sdk").description("CLI for Zapier SDK").version(
+  package_default2.version,
+  `${versionOption.short}, ${versionOption.flag}`,
+  versionOption.description
+).option("--debug", "Enable debug logging").option("--base-url <url>", "Base URL for Zapier API endpoints").option("--credentials <token>", "Authentication token").option("--credentials-client-id <id>", "OAuth client ID for authentication").option(
   "--credentials-client-secret <secret>",
   "OAuth client secret for authentication"
 ).option(
@@ -3798,7 +3836,10 @@ program.name("zapier-sdk").description("CLI for Zapier SDK").version(package_def
 ).option(
   "--max-network-retry-delay-ms <ms>",
   "Max delay in ms to wait for rate limit retry (default: 60000)"
-).helpOption("-h, --help", "Display help for command");
+).helpOption(
+  `${helpOption.short}, ${helpOption.flag}`,
+  helpOption.description
+);
 var isDebugMode = process.env.DEBUG === "true" || process.argv.includes("--debug");
 function getFlagValue(flagName) {
   const index = process.argv.indexOf(flagName);

package/dist/cli.mjs

@@ -840,6 +840,36 @@ function formatItemsGeneric(items, startingNumber = 0) {
     formatSingleItem(formatted, startingNumber + index);
   });
 }
+
+// src/utils/cli-options.ts
+var RESERVED_CLI_OPTIONS = [
+  {
+    name: "version" /* Version */,
+    flag: "--version",
+    short: "-V",
+    description: "Display version number"
+  },
+  {
+    name: "help" /* Help */,
+    flag: "--help",
+    short: "-h",
+    description: "Display help for command"
+  }
+];
+function getReservedCliOption(name) {
+  const option = RESERVED_CLI_OPTIONS.find((opt) => opt.name === name);
+  if (!option) throw new Error(`Reserved CLI option not found: ${name}`);
+  return option;
+}
+var SHARED_COMMAND_CLI_OPTIONS = [
+  {
+    name: "json",
+    flag: "--json",
+    description: "Output raw JSON instead of formatted results"
+  }
+];
+
+// src/utils/cli-generator.ts
 var CONFIRM_MESSAGES = {
   "create-secret": {
     messageBefore: "You are about to create a sensitive secret that will be displayed as plain text.\nOnce created, you cannot retrieve it again.",
@@ -1307,10 +1337,12 @@ function addCommand(program2, commandName, config2) {
       }
     }
   });
-  const hasJsonParam = config2.parameters.some((p) => p.name === "json");
-  if (!hasJsonParam) {
-    command.option("--json", "Output raw JSON instead of formatted results");
-  }
+  const paramNames = new Set(config2.parameters.map((p) => p.name));
+  SHARED_COMMAND_CLI_OPTIONS.forEach((opt) => {
+    if (!paramNames.has(opt.name)) {
+      command.option(opt.flag, opt.description);
+    }
+  });
   command.action(config2.handler);
 }
 function convertCliArgsToSdkParams(parameters, positionalArgs, options) {
@@ -1768,7 +1800,7 @@ var LoginSchema = z.object({
 
 // package.json
 var package_default = {
-  version: "0.31.2"};
+  version: "0.32.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -3547,7 +3579,7 @@ function createZapierCliSdk(options = {}) {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.31.2"};
+  version: "0.32.0"};
 function detectPackageManager(cwd = process.cwd()) {
   const ua = process.env.npm_config_user_agent;
   if (ua) {
@@ -3750,7 +3782,13 @@ async function checkAndNotifyUpdates({
 
 // src/cli.ts
 var program = new Command();
-program.name("zapier-sdk").description("CLI for Zapier SDK").version(package_default2.version, void 0, "Display version number").option("--debug", "Enable debug logging").option("--base-url <url>", "Base URL for Zapier API endpoints").option("--credentials <token>", "Authentication token").option("--credentials-client-id <id>", "OAuth client ID for authentication").option(
+var versionOption = getReservedCliOption("version" /* Version */);
+var helpOption = getReservedCliOption("help" /* Help */);
+program.name("zapier-sdk").description("CLI for Zapier SDK").version(
+  package_default2.version,
+  `${versionOption.short}, ${versionOption.flag}`,
+  versionOption.description
+).option("--debug", "Enable debug logging").option("--base-url <url>", "Base URL for Zapier API endpoints").option("--credentials <token>", "Authentication token").option("--credentials-client-id <id>", "OAuth client ID for authentication").option(
   "--credentials-client-secret <secret>",
   "OAuth client secret for authentication"
 ).option(
@@ -3762,7 +3800,10 @@ program.name("zapier-sdk").description("CLI for Zapier SDK").version(package_def
 ).option(
   "--max-network-retry-delay-ms <ms>",
   "Max delay in ms to wait for rate limit retry (default: 60000)"
-).helpOption("-h, --help", "Display help for command");
+).helpOption(
+  `${helpOption.short}, ${helpOption.flag}`,
+  helpOption.description
+);
 var isDebugMode = process.env.DEBUG === "true" || process.argv.includes("--debug");
 function getFlagValue(flagName) {
   const index = process.argv.indexOf(flagName);

package/dist/index.cjs

@@ -302,7 +302,7 @@ var LoginSchema = zod.z.object({
 
 // package.json
 var package_default = {
-  version: "0.31.2"};
+  version: "0.32.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -2078,5 +2078,42 @@ function createZapierCliSdk(options = {}) {
   }).addPlugin(generateAppTypesPlugin).addPlugin(buildManifestPlugin).addPlugin(bundleCodePlugin).addPlugin(getLoginConfigPathPlugin).addPlugin(addPlugin).addPlugin(feedbackPlugin).addPlugin(curlPlugin).addPlugin(mcpPlugin).addPlugin(loginPlugin).addPlugin(logoutPlugin).addPlugin(cliOverridesPlugin).addPlugin(zapierSdk.registryPlugin);
 }
 
+// src/utils/cli-options.ts
+var ReservedCliParameter = /* @__PURE__ */ ((ReservedCliParameter2) => {
+  ReservedCliParameter2["Version"] = "version";
+  ReservedCliParameter2["Help"] = "help";
+  return ReservedCliParameter2;
+})(ReservedCliParameter || {});
+var RESERVED_CLI_OPTIONS = [
+  {
+    name: "version" /* Version */,
+    flag: "--version",
+    short: "-V",
+    description: "Display version number"
+  },
+  {
+    name: "help" /* Help */,
+    flag: "--help",
+    short: "-h",
+    description: "Display help for command"
+  }
+];
+function getReservedCliOption(name) {
+  const option = RESERVED_CLI_OPTIONS.find((opt) => opt.name === name);
+  if (!option) throw new Error(`Reserved CLI option not found: ${name}`);
+  return option;
+}
+var SHARED_COMMAND_CLI_OPTIONS = [
+  {
+    name: "json",
+    flag: "--json",
+    description: "Output raw JSON instead of formatted results"
+  }
+];
+
+exports.RESERVED_CLI_OPTIONS = RESERVED_CLI_OPTIONS;
+exports.ReservedCliParameter = ReservedCliParameter;
+exports.SHARED_COMMAND_CLI_OPTIONS = SHARED_COMMAND_CLI_OPTIONS;
 exports.buildCliCommandExecutedEvent = buildCliCommandExecutedEvent;
 exports.createZapierCliSdk = createZapierCliSdk;
+exports.getReservedCliOption = getReservedCliOption;

package/dist/index.d.mts

@@ -231,4 +231,20 @@ declare function buildCliCommandExecutedEvent({ data, context, cliVersion, }: {
     cliVersion?: string;
 }): CliCommandExecutedEvent;
 
-export { type CliCommandExecutedEvent, type CliCommandExecutedEventData, type CliEventContext, type ZapierCliSdkOptions, buildCliCommandExecutedEvent, createZapierCliSdk };
+interface CliOption {
+    name: string;
+    flag: string;
+    short?: string;
+    description: string;
+}
+declare enum ReservedCliParameter {
+    Version = "version",
+    Help = "help"
+}
+/** CLI options at the framework level, not defined by any SDK command. */
+declare const RESERVED_CLI_OPTIONS: readonly Readonly<CliOption>[];
+declare function getReservedCliOption(name: ReservedCliParameter): Readonly<CliOption>;
+/** CLI options automatically added to every SDK-generated command. */
+declare const SHARED_COMMAND_CLI_OPTIONS: readonly Readonly<CliOption>[];
+
+export { type CliCommandExecutedEvent, type CliCommandExecutedEventData, type CliEventContext, RESERVED_CLI_OPTIONS, ReservedCliParameter, SHARED_COMMAND_CLI_OPTIONS, type ZapierCliSdkOptions, buildCliCommandExecutedEvent, createZapierCliSdk, getReservedCliOption };

package/dist/index.d.ts

@@ -231,4 +231,20 @@ declare function buildCliCommandExecutedEvent({ data, context, cliVersion, }: {
     cliVersion?: string;
 }): CliCommandExecutedEvent;
 
-export { type CliCommandExecutedEvent, type CliCommandExecutedEventData, type CliEventContext, type ZapierCliSdkOptions, buildCliCommandExecutedEvent, createZapierCliSdk };
+interface CliOption {
+    name: string;
+    flag: string;
+    short?: string;
+    description: string;
+}
+declare enum ReservedCliParameter {
+    Version = "version",
+    Help = "help"
+}
+/** CLI options at the framework level, not defined by any SDK command. */
+declare const RESERVED_CLI_OPTIONS: readonly Readonly<CliOption>[];
+declare function getReservedCliOption(name: ReservedCliParameter): Readonly<CliOption>;
+/** CLI options automatically added to every SDK-generated command. */
+declare const SHARED_COMMAND_CLI_OPTIONS: readonly Readonly<CliOption>[];
+
+export { type CliCommandExecutedEvent, type CliCommandExecutedEventData, type CliEventContext, RESERVED_CLI_OPTIONS, ReservedCliParameter, SHARED_COMMAND_CLI_OPTIONS, type ZapierCliSdkOptions, buildCliCommandExecutedEvent, createZapierCliSdk, getReservedCliOption };

package/dist/index.mjs

@@ -272,7 +272,7 @@ var LoginSchema = z.object({
 
 // package.json
 var package_default = {
-  version: "0.31.2"};
+  version: "0.32.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -2048,4 +2048,37 @@ function createZapierCliSdk(options = {}) {
   }).addPlugin(generateAppTypesPlugin).addPlugin(buildManifestPlugin).addPlugin(bundleCodePlugin).addPlugin(getLoginConfigPathPlugin).addPlugin(addPlugin).addPlugin(feedbackPlugin).addPlugin(curlPlugin).addPlugin(mcpPlugin).addPlugin(loginPlugin).addPlugin(logoutPlugin).addPlugin(cliOverridesPlugin).addPlugin(registryPlugin);
 }
 
-export { buildCliCommandExecutedEvent, createZapierCliSdk };
+// src/utils/cli-options.ts
+var ReservedCliParameter = /* @__PURE__ */ ((ReservedCliParameter2) => {
+  ReservedCliParameter2["Version"] = "version";
+  ReservedCliParameter2["Help"] = "help";
+  return ReservedCliParameter2;
+})(ReservedCliParameter || {});
+var RESERVED_CLI_OPTIONS = [
+  {
+    name: "version" /* Version */,
+    flag: "--version",
+    short: "-V",
+    description: "Display version number"
+  },
+  {
+    name: "help" /* Help */,
+    flag: "--help",
+    short: "-h",
+    description: "Display help for command"
+  }
+];
+function getReservedCliOption(name) {
+  const option = RESERVED_CLI_OPTIONS.find((opt) => opt.name === name);
+  if (!option) throw new Error(`Reserved CLI option not found: ${name}`);
+  return option;
+}
+var SHARED_COMMAND_CLI_OPTIONS = [
+  {
+    name: "json",
+    flag: "--json",
+    description: "Output raw JSON instead of formatted results"
+  }
+];
+
+export { RESERVED_CLI_OPTIONS, ReservedCliParameter, SHARED_COMMAND_CLI_OPTIONS, buildCliCommandExecutedEvent, createZapierCliSdk, getReservedCliOption };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zapier/zapier-sdk-cli",
-    "version": "0.31.2",
+    "version": "0.32.0",
     "description": "Command line interface for Zapier SDK",
     "main": "dist/index.cjs",
     "module": "dist/index.mjs",

package/dist/src/cli.js

@@ -5,11 +5,14 @@ import { createZapierCliSdk } from "./sdk";
 import packageJson from "../package.json" with { type: "json" };
 import { ZapierCliError } from "./utils/errors";
 import { checkAndNotifyUpdates } from "./utils/version-checker";
+import { ReservedCliParameter, getReservedCliOption, } from "./utils/cli-options";
 const program = new Command();
+const versionOption = getReservedCliOption(ReservedCliParameter.Version);
+const helpOption = getReservedCliOption(ReservedCliParameter.Help);
 program
     .name("zapier-sdk")
     .description("CLI for Zapier SDK")
-    .version(packageJson.version, undefined, "Display version number")
+    .version(packageJson.version, `${versionOption.short}, ${versionOption.flag}`, versionOption.description)
     .option("--debug", "Enable debug logging")
     .option("--base-url <url>", "Base URL for Zapier API endpoints")
     .option("--credentials <token>", "Authentication token")
@@ -19,7 +22,7 @@ program
     .option("--tracking-base-url <url>", "Base URL for Zapier tracking endpoints")
     .option("--max-network-retries <count>", "Max retries for rate-limited requests (default: 3)")
     .option("--max-network-retry-delay-ms <ms>", "Max delay in ms to wait for rate limit retry (default: 60000)")
-    .helpOption("-h, --help", "Display help for command");
+    .helpOption(`${helpOption.short}, ${helpOption.flag}`, helpOption.description);
 // Check for debug flag early (support both flag and env var)
 const isDebugMode = process.env.DEBUG === "true" || process.argv.includes("--debug");
 // Helper to get flag value from argv

package/dist/src/index.d.ts

@@ -2,3 +2,4 @@ export { createZapierCliSdk, type ZapierCliSdkOptions } from "./sdk";
 export type { CliEventContext, CliCommandExecutedEventData, } from "./telemetry/builders";
 export { buildCliCommandExecutedEvent } from "./telemetry/builders";
 export type { CliCommandExecutedEvent } from "./telemetry/events";
+export { RESERVED_CLI_OPTIONS, SHARED_COMMAND_CLI_OPTIONS, ReservedCliParameter, getReservedCliOption, } from "./utils/cli-options";

package/dist/src/index.js

@@ -2,3 +2,4 @@
 export { createZapierCliSdk } from "./sdk";
 export { buildCliCommandExecutedEvent } from "./telemetry/builders";
 // All CLI functionality is now schema-driven via generateCLICommands
+export { RESERVED_CLI_OPTIONS, SHARED_COMMAND_CLI_OPTIONS, ReservedCliParameter, getReservedCliOption, } from "./utils/cli-options";

package/dist/src/utils/cli-generator.js

@@ -5,6 +5,7 @@ import { formatItemsFromSchema, formatJsonOutput } from "./schema-formatter";
 import chalk from "chalk";
 import inquirer from "inquirer";
 import { ZapierCliError, ZapierCliExitError } from "./errors";
+import { SHARED_COMMAND_CLI_OPTIONS } from "./cli-options";
 const CONFIRM_MESSAGES = {
     "create-secret": {
         messageBefore: "You are about to create a sensitive secret that will be displayed as plain text.\n" +
@@ -507,11 +508,13 @@ function addCommand(program, commandName, config) {
             }
         }
     });
-    // Add formatting options for all commands (skip if schema already defines json)
-    const hasJsonParam = config.parameters.some((p) => p.name === "json");
-    if (!hasJsonParam) {
-        command.option("--json", "Output raw JSON instead of formatted results");
-    }
+    // Add shared command options (if not already included)
+    const paramNames = new Set(config.parameters.map((p) => p.name));
+    SHARED_COMMAND_CLI_OPTIONS.forEach((opt) => {
+        if (!paramNames.has(opt.name)) {
+            command.option(opt.flag, opt.description);
+        }
+    });
     command.action(config.handler);
 }
 // ============================================================================

package/dist/src/utils/cli-options.d.ts

@@ -0,0 +1,16 @@
+interface CliOption {
+    name: string;
+    flag: string;
+    short?: string;
+    description: string;
+}
+export declare enum ReservedCliParameter {
+    Version = "version",
+    Help = "help"
+}
+/** CLI options at the framework level, not defined by any SDK command. */
+export declare const RESERVED_CLI_OPTIONS: readonly Readonly<CliOption>[];
+export declare function getReservedCliOption(name: ReservedCliParameter): Readonly<CliOption>;
+/** CLI options automatically added to every SDK-generated command. */
+export declare const SHARED_COMMAND_CLI_OPTIONS: readonly Readonly<CliOption>[];
+export {};

package/dist/src/utils/cli-options.js

@@ -0,0 +1,34 @@
+export var ReservedCliParameter;
+(function (ReservedCliParameter) {
+    ReservedCliParameter["Version"] = "version";
+    ReservedCliParameter["Help"] = "help";
+})(ReservedCliParameter || (ReservedCliParameter = {}));
+/** CLI options at the framework level, not defined by any SDK command. */
+export const RESERVED_CLI_OPTIONS = [
+    {
+        name: ReservedCliParameter.Version,
+        flag: "--version",
+        short: "-V",
+        description: "Display version number",
+    },
+    {
+        name: ReservedCliParameter.Help,
+        flag: "--help",
+        short: "-h",
+        description: "Display help for command",
+    },
+];
+export function getReservedCliOption(name) {
+    const option = RESERVED_CLI_OPTIONS.find((opt) => opt.name === name);
+    if (!option)
+        throw new Error(`Reserved CLI option not found: ${name}`);
+    return option;
+}
+/** CLI options automatically added to every SDK-generated command. */
+export const SHARED_COMMAND_CLI_OPTIONS = [
+    {
+        name: "json",
+        flag: "--json",
+        description: "Output raw JSON instead of formatted results",
+    },
+];