@zapier/zapier-sdk-cli 0.39.1 → 0.39.3

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @zapier/zapier-sdk-cli
 
+## 0.39.3
+
+### Patch Changes
+
+- b250545: Connections - Replace isExpired with expired
+- Updated dependencies [b250545]
+  - @zapier/zapier-sdk@0.40.3
+  - @zapier/zapier-sdk-mcp@0.10.9
+
+## 0.39.2
+
+### Patch Changes
+
+- 362bc56: Make sure CLI only shows non-deprecated positional parameters.
+- Updated dependencies [362bc56]
+  - @zapier/zapier-sdk@0.40.2
+  - @zapier/zapier-sdk-mcp@0.10.8
+
 ## 0.39.1
 
 ### Patch Changes

package/README.md

@@ -409,18 +409,18 @@ Find the first connection matching the criteria
 
 | Option             | Type      | Required | Default | Possible Values | Description                                                                                                                                         |
 | ------------------ | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `[app]`            | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')                                                                          |
 | `--search`         | `string`  | ❌       | —       | —               | Search term to filter connections by title                                                                                                          |
 | `--title`          | `string`  | ❌       | —       | —               | Filter connections by exact title match (searches first, then filters locally)                                                                      |
 | `--owner`          | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own connections or a specific user ID                                                                                |
-| `--app`            | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')                                                                          |
 | `--account`        | `string`  | ❌       | —       | —               | Account to filter by                                                                                                                                |
 | `--include-shared` | `boolean` | ❌       | —       | —               | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
-| `--is-expired`     | `boolean` | ❌       | —       | —               | Filter by expired status                                                                                                                            |
+| `--expired`        | `boolean` | ❌       | —       | —               | Show only expired connections (default: only non-expired connections are returned)                                                                  |
 
 **Usage:**
 
 ```bash
-npx zapier-sdk find-first-connection [--search] [--title] [--owner] [--app] [--account] [--include-shared] [--is-expired]
+npx zapier-sdk find-first-connection [app] [--search] [--title] [--owner] [--account] [--include-shared] [--expired]
 ```
 
 #### `find-unique-connection`
@@ -431,18 +431,18 @@ Find a unique connection matching the criteria
 
 | Option             | Type      | Required | Default | Possible Values | Description                                                                                                                                         |
 | ------------------ | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `[app]`            | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')                                                                          |
 | `--search`         | `string`  | ❌       | —       | —               | Search term to filter connections by title                                                                                                          |
 | `--title`          | `string`  | ❌       | —       | —               | Filter connections by exact title match (searches first, then filters locally)                                                                      |
 | `--owner`          | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own connections or a specific user ID                                                                                |
-| `--app`            | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')                                                                          |
 | `--account`        | `string`  | ❌       | —       | —               | Account to filter by                                                                                                                                |
 | `--include-shared` | `boolean` | ❌       | —       | —               | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
-| `--is-expired`     | `boolean` | ❌       | —       | —               | Filter by expired status                                                                                                                            |
+| `--expired`        | `boolean` | ❌       | —       | —               | Show only expired connections (default: only non-expired connections are returned)                                                                  |
 
 **Usage:**
 
 ```bash
-npx zapier-sdk find-unique-connection [--search] [--title] [--owner] [--app] [--account] [--include-shared] [--is-expired]
+npx zapier-sdk find-unique-connection [app] [--search] [--title] [--owner] [--account] [--include-shared] [--expired]
 ```
 
 #### `get-connection`
@@ -469,14 +469,14 @@ List available connections with optional filtering
 
 | Option             | Type      | Required | Default | Possible Values | Description                                                                                                                                         |
 | ------------------ | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `[app]`            | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')                                                                          |
 | `--search`         | `string`  | ❌       | —       | —               | Search term to filter connections by title                                                                                                          |
 | `--title`          | `string`  | ❌       | —       | —               | Filter connections by exact title match (searches first, then filters locally)                                                                      |
 | `--owner`          | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own connections or a specific user ID                                                                                |
-| `--app`            | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')                                                                          |
 | `--connections`    | `array`   | ❌       | —       | —               | List of connection IDs to filter by                                                                                                                 |
 | `--account`        | `string`  | ❌       | —       | —               | Account to filter by                                                                                                                                |
 | `--include-shared` | `boolean` | ❌       | —       | —               | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
-| `--is-expired`     | `boolean` | ❌       | —       | —               | Filter by expired status                                                                                                                            |
+| `--expired`        | `boolean` | ❌       | —       | —               | Show only expired connections (default: only non-expired connections are returned)                                                                  |
 | `--page-size`      | `number`  | ❌       | —       | —               | Number of connections per page                                                                                                                      |
 | `--max-items`      | `number`  | ❌       | —       | —               | Maximum total items to return across all pages                                                                                                      |
 | `--cursor`         | `string`  | ❌       | —       | —               | Cursor to start from                                                                                                                                |
@@ -484,7 +484,7 @@ List available connections with optional filtering
 **Usage:**
 
 ```bash
-npx zapier-sdk list-connections [--search] [--title] [--owner] [--app] [--connections] [--account] [--include-shared] [--is-expired] [--page-size] [--max-items] [--cursor]
+npx zapier-sdk list-connections [app] [--search] [--title] [--owner] [--connections] [--account] [--include-shared] [--expired] [--page-size] [--max-items] [--cursor]
 ```
 
 ### HTTP Requests
@@ -695,9 +695,9 @@ List records in a table with optional filtering and sorting
 | Option          | Type     | Required | Default   | Possible Values | Description                                                                                                                       |
 | --------------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
 | `<table>`       | `string` | ✅       | —         | —               | The unique identifier of the table                                                                                                |
+| ↳ `<field-key>` | `string` | ✅       | —         | —               | The field key to sort by                                                                                                          |
 | `--filters`     | `array`  | ❌       | —         | —               | Filter conditions for the query                                                                                                   |
 | `--sort`        | `object` | ❌       | —         | —               | Sort records by a field                                                                                                           |
-| ↳ `<field-key>` | `string` | ✅       | —         | —               | The field key to sort by                                                                                                          |
 | ↳ `--direction` | `string` | ❌       | `"asc"`   | —               | Sort direction                                                                                                                    |
 | `--page-size`   | `number` | ❌       | —         | —               | Number of records per page (max 1000)                                                                                             |
 | `--max-items`   | `number` | ❌       | —         | —               | Maximum total items to return across all pages                                                                                    |

package/dist/cli.cjs

@@ -1103,7 +1103,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
 
 // package.json
 var package_default = {
-  version: "0.39.1"};
+  version: "0.39.3"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -1628,6 +1628,27 @@ function emitDeprecationWarning({
   console.warn(chalk7__default.default.yellow(`   ${deprecation.message}`));
   console.warn();
 }
+function emitParamDeprecationWarnings({
+  options,
+  parameters
+}) {
+  for (const param of parameters) {
+    if (!param.isDeprecated) continue;
+    const value = options[param.name];
+    if (value === void 0) continue;
+    if (Array.isArray(value) && value.length === 0) continue;
+    console.warn();
+    console.warn(
+      chalk7__default.default.yellow.bold("\u26A0\uFE0F  DEPRECATION WARNING") + chalk7__default.default.yellow(
+        ` - \`${toKebabCase(param.name)}\` is deprecated and may be removed in a future release.`
+      )
+    );
+    if (param.deprecationMessage) {
+      console.warn(chalk7__default.default.yellow(`   ${param.deprecationMessage}`));
+    }
+    console.warn();
+  }
+}
 function resolveOutputMode({
   isListCommand,
   hasPaginationParams,
@@ -1637,6 +1658,9 @@ function resolveOutputMode({
   if (hasUserSpecifiedMaxItems) return "collect";
   return "paginate";
 }
+function getSchemaAliases(schema) {
+  return schema?.meta?.()?.aliases;
+}
 function analyzeZodSchema(schema, functionInfo) {
   const parameters = [];
   const schemaDef = schema._zod?.def;
@@ -1663,11 +1687,15 @@ function analyzeZodField(name, schema, functionInfo) {
   let required = true;
   let defaultValue = void 0;
   let isDeprecated = false;
+  let deprecationMessage;
   while (true) {
     const meta = baseSchema.meta?.();
     if (meta?.deprecated) {
       isDeprecated = true;
     }
+    if (meta?.deprecationMessage && !deprecationMessage) {
+      deprecationMessage = meta.deprecationMessage;
+    }
     if (baseSchema instanceof zod.z.ZodOptional) {
       required = false;
       baseSchema = baseSchema._zod.def.innerType;
@@ -1724,7 +1752,8 @@ function analyzeZodField(name, schema, functionInfo) {
     hasResolver: paramHasResolver,
     isPositional: zapierSdk.isPositional(schema),
     elementType,
-    hidden: isDeprecated
+    deprecationMessage,
+    isDeprecated
   };
 }
 function analyzeInputParameters(inputParameters, functionInfo) {
@@ -1869,6 +1898,15 @@ function createCommandConfig(cliCommandName, functionInfo, sdk2) {
   const usesInputParameters = !functionInfo.inputSchema && !!functionInfo.inputParameters;
   const schema = functionInfo.inputSchema;
   const parameters = usesInputParameters ? analyzeInputParameters(functionInfo.inputParameters, functionInfo) : analyzeZodSchema(schema, functionInfo);
+  const schemaAliases = getSchemaAliases(schema);
+  if (schemaAliases) {
+    const aliasedNames = new Set(Object.keys(schemaAliases));
+    for (const param of parameters) {
+      if (aliasedNames.has(param.name)) {
+        param.isAlias = true;
+      }
+    }
+  }
   const description = functionInfo.description || schema?.description || `${cliCommandName} command`;
   const handler = async (...args) => {
     const startTime = Date.now();
@@ -1880,17 +1918,16 @@ function createCommandConfig(cliCommandName, functionInfo, sdk2) {
     const interactiveMode = !options.json;
     const renderer = interactiveMode ? createInteractiveRenderer() : createJsonRenderer();
     try {
-      const commandObj2 = args[args.length - 1];
-      const options2 = commandObj2.opts();
       emitDeprecationWarning({
         cliCommandName,
         deprecation: functionInfo.deprecation
       });
+      emitParamDeprecationWarnings({ options, parameters });
       const isListCommand = functionInfo.type === "list";
       const hasPaginationParams = parameters.some(
         (p) => PAGINATION_PARAM_NAMES.has(p.name)
       );
-      const hasUserSpecifiedMaxItems = "maxItems" in options2 && options2.maxItems !== void 0;
+      const hasUserSpecifiedMaxItems = "maxItems" in options && options.maxItems !== void 0;
       const outputMode = resolveOutputMode({
         isListCommand,
         hasPaginationParams,
@@ -1899,11 +1936,11 @@ function createCommandConfig(cliCommandName, functionInfo, sdk2) {
       const rawParams = convertCliArgsToSdkParams(
         parameters,
         args.slice(0, -1),
-        options2
+        options
       );
-      const schemaAliases = schema?.meta?.()?.aliases;
-      if (schemaAliases) {
-        for (const [oldName, newName] of Object.entries(schemaAliases)) {
+      const schemaAliases2 = getSchemaAliases(schema);
+      if (schemaAliases2) {
+        for (const [oldName, newName] of Object.entries(schemaAliases2)) {
           if (oldName in rawParams && !(newName in rawParams)) {
             rawParams[newName] = rawParams[oldName];
             delete rawParams[oldName];
@@ -1919,7 +1956,7 @@ function createCommandConfig(cliCommandName, functionInfo, sdk2) {
           functionInfo.name,
           {
             interactiveMode,
-            debug: !!options2.debug || process.env.DEBUG === "true" || process.argv.includes("--debug")
+            debug: !!options.debug || process.env.DEBUG === "true" || process.argv.includes("--debug")
           }
         );
       } else {
@@ -2078,7 +2115,7 @@ function addCommand(program2, commandName, config) {
         `<${kebabName}>`,
         param.description || `${kebabName} parameter`
       );
-    } else if (param.isPositional) {
+    } else if (param.isPositional && !param.isDeprecated && !param.isAlias) {
       command.argument(
         `[${kebabName}]`,
         param.description || `${kebabName} parameter`
@@ -2092,7 +2129,7 @@ function addCommand(program2, commandName, config) {
       flags.push(`--${kebabName}`);
       if (param.type === "boolean") {
         const opt = new commander.Option(flags.join(", "), param.description);
-        if (param.hidden) opt.hideHelp();
+        if (param.isDeprecated) opt.hideHelp();
         command.addOption(opt);
       } else if (param.type === "array") {
         const flagSignature = flags.join(", ") + ` <value>`;
@@ -2101,7 +2138,7 @@ function addCommand(program2, commandName, config) {
         opt.argParser(
           (value, previous) => (previous || []).concat([value])
         );
-        if (param.hidden) opt.hideHelp();
+        if (param.isDeprecated) opt.hideHelp();
         command.addOption(opt);
       } else {
         const flagSignature = flags.join(", ") + ` <${param.type}>`;
@@ -2109,7 +2146,7 @@ function addCommand(program2, commandName, config) {
         if (param.default !== void 0) {
           opt.default(param.default);
         }
-        if (param.hidden) opt.hideHelp();
+        if (param.isDeprecated) opt.hideHelp();
         command.addOption(opt);
       }
     }
@@ -2126,7 +2163,7 @@ function convertCliArgsToSdkParams(parameters, positionalArgs, options) {
   const sdkParams = {};
   let argIndex = 0;
   parameters.forEach((param) => {
-    if ((param.required || param.isPositional) && argIndex < positionalArgs.length) {
+    if ((param.required || param.isPositional && !param.isDeprecated && !param.isAlias) && argIndex < positionalArgs.length) {
       sdkParams[param.name] = convertValue(
         positionalArgs[argIndex],
         param.type,
@@ -4656,7 +4693,7 @@ function createZapierCliSdk(options = {}) {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.39.1"};
+  version: "0.39.3"};
 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;

package/dist/cli.mjs

@@ -1065,7 +1065,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
 
 // package.json
 var package_default = {
-  version: "0.39.1"};
+  version: "0.39.3"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -1590,6 +1590,27 @@ function emitDeprecationWarning({
   console.warn(chalk7.yellow(`   ${deprecation.message}`));
   console.warn();
 }
+function emitParamDeprecationWarnings({
+  options,
+  parameters
+}) {
+  for (const param of parameters) {
+    if (!param.isDeprecated) continue;
+    const value = options[param.name];
+    if (value === void 0) continue;
+    if (Array.isArray(value) && value.length === 0) continue;
+    console.warn();
+    console.warn(
+      chalk7.yellow.bold("\u26A0\uFE0F  DEPRECATION WARNING") + chalk7.yellow(
+        ` - \`${toKebabCase(param.name)}\` is deprecated and may be removed in a future release.`
+      )
+    );
+    if (param.deprecationMessage) {
+      console.warn(chalk7.yellow(`   ${param.deprecationMessage}`));
+    }
+    console.warn();
+  }
+}
 function resolveOutputMode({
   isListCommand,
   hasPaginationParams,
@@ -1599,6 +1620,9 @@ function resolveOutputMode({
   if (hasUserSpecifiedMaxItems) return "collect";
   return "paginate";
 }
+function getSchemaAliases(schema) {
+  return schema?.meta?.()?.aliases;
+}
 function analyzeZodSchema(schema, functionInfo) {
   const parameters = [];
   const schemaDef = schema._zod?.def;
@@ -1625,11 +1649,15 @@ function analyzeZodField(name, schema, functionInfo) {
   let required = true;
   let defaultValue = void 0;
   let isDeprecated = false;
+  let deprecationMessage;
   while (true) {
     const meta = baseSchema.meta?.();
     if (meta?.deprecated) {
       isDeprecated = true;
     }
+    if (meta?.deprecationMessage && !deprecationMessage) {
+      deprecationMessage = meta.deprecationMessage;
+    }
     if (baseSchema instanceof z.ZodOptional) {
       required = false;
       baseSchema = baseSchema._zod.def.innerType;
@@ -1686,7 +1714,8 @@ function analyzeZodField(name, schema, functionInfo) {
     hasResolver: paramHasResolver,
     isPositional: isPositional(schema),
     elementType,
-    hidden: isDeprecated
+    deprecationMessage,
+    isDeprecated
   };
 }
 function analyzeInputParameters(inputParameters, functionInfo) {
@@ -1831,6 +1860,15 @@ function createCommandConfig(cliCommandName, functionInfo, sdk2) {
   const usesInputParameters = !functionInfo.inputSchema && !!functionInfo.inputParameters;
   const schema = functionInfo.inputSchema;
   const parameters = usesInputParameters ? analyzeInputParameters(functionInfo.inputParameters, functionInfo) : analyzeZodSchema(schema, functionInfo);
+  const schemaAliases = getSchemaAliases(schema);
+  if (schemaAliases) {
+    const aliasedNames = new Set(Object.keys(schemaAliases));
+    for (const param of parameters) {
+      if (aliasedNames.has(param.name)) {
+        param.isAlias = true;
+      }
+    }
+  }
   const description = functionInfo.description || schema?.description || `${cliCommandName} command`;
   const handler = async (...args) => {
     const startTime = Date.now();
@@ -1842,17 +1880,16 @@ function createCommandConfig(cliCommandName, functionInfo, sdk2) {
     const interactiveMode = !options.json;
     const renderer = interactiveMode ? createInteractiveRenderer() : createJsonRenderer();
     try {
-      const commandObj2 = args[args.length - 1];
-      const options2 = commandObj2.opts();
       emitDeprecationWarning({
         cliCommandName,
         deprecation: functionInfo.deprecation
       });
+      emitParamDeprecationWarnings({ options, parameters });
       const isListCommand = functionInfo.type === "list";
       const hasPaginationParams = parameters.some(
         (p) => PAGINATION_PARAM_NAMES.has(p.name)
       );
-      const hasUserSpecifiedMaxItems = "maxItems" in options2 && options2.maxItems !== void 0;
+      const hasUserSpecifiedMaxItems = "maxItems" in options && options.maxItems !== void 0;
       const outputMode = resolveOutputMode({
         isListCommand,
         hasPaginationParams,
@@ -1861,11 +1898,11 @@ function createCommandConfig(cliCommandName, functionInfo, sdk2) {
       const rawParams = convertCliArgsToSdkParams(
         parameters,
         args.slice(0, -1),
-        options2
+        options
       );
-      const schemaAliases = schema?.meta?.()?.aliases;
-      if (schemaAliases) {
-        for (const [oldName, newName] of Object.entries(schemaAliases)) {
+      const schemaAliases2 = getSchemaAliases(schema);
+      if (schemaAliases2) {
+        for (const [oldName, newName] of Object.entries(schemaAliases2)) {
           if (oldName in rawParams && !(newName in rawParams)) {
             rawParams[newName] = rawParams[oldName];
             delete rawParams[oldName];
@@ -1881,7 +1918,7 @@ function createCommandConfig(cliCommandName, functionInfo, sdk2) {
           functionInfo.name,
           {
             interactiveMode,
-            debug: !!options2.debug || process.env.DEBUG === "true" || process.argv.includes("--debug")
+            debug: !!options.debug || process.env.DEBUG === "true" || process.argv.includes("--debug")
           }
         );
       } else {
@@ -2040,7 +2077,7 @@ function addCommand(program2, commandName, config) {
         `<${kebabName}>`,
         param.description || `${kebabName} parameter`
       );
-    } else if (param.isPositional) {
+    } else if (param.isPositional && !param.isDeprecated && !param.isAlias) {
       command.argument(
         `[${kebabName}]`,
         param.description || `${kebabName} parameter`
@@ -2054,7 +2091,7 @@ function addCommand(program2, commandName, config) {
       flags.push(`--${kebabName}`);
       if (param.type === "boolean") {
         const opt = new Option(flags.join(", "), param.description);
-        if (param.hidden) opt.hideHelp();
+        if (param.isDeprecated) opt.hideHelp();
         command.addOption(opt);
       } else if (param.type === "array") {
         const flagSignature = flags.join(", ") + ` <value>`;
@@ -2063,7 +2100,7 @@ function addCommand(program2, commandName, config) {
         opt.argParser(
           (value, previous) => (previous || []).concat([value])
         );
-        if (param.hidden) opt.hideHelp();
+        if (param.isDeprecated) opt.hideHelp();
         command.addOption(opt);
       } else {
         const flagSignature = flags.join(", ") + ` <${param.type}>`;
@@ -2071,7 +2108,7 @@ function addCommand(program2, commandName, config) {
         if (param.default !== void 0) {
           opt.default(param.default);
         }
-        if (param.hidden) opt.hideHelp();
+        if (param.isDeprecated) opt.hideHelp();
         command.addOption(opt);
       }
     }
@@ -2088,7 +2125,7 @@ function convertCliArgsToSdkParams(parameters, positionalArgs, options) {
   const sdkParams = {};
   let argIndex = 0;
   parameters.forEach((param) => {
-    if ((param.required || param.isPositional) && argIndex < positionalArgs.length) {
+    if ((param.required || param.isPositional && !param.isDeprecated && !param.isAlias) && argIndex < positionalArgs.length) {
       sdkParams[param.name] = convertValue(
         positionalArgs[argIndex],
         param.type,
@@ -4618,7 +4655,7 @@ function createZapierCliSdk(options = {}) {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.39.1"};
+  version: "0.39.3"};
 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;

package/dist/index.cjs

@@ -2512,7 +2512,7 @@ function createZapierCliSdk(options = {}) {
 
 // package.json
 var package_default = {
-  version: "0.39.1"};
+  version: "0.39.3"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {

package/dist/index.mjs

@@ -2479,7 +2479,7 @@ function createZapierCliSdk(options = {}) {
 
 // package.json
 var package_default = {
-  version: "0.39.1"};
+  version: "0.39.3"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {

package/dist/package.json

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

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

@@ -135,6 +135,24 @@ function emitDeprecationWarning({ cliCommandName, deprecation, }) {
     console.warn(chalk.yellow(`   ${deprecation.message}`));
     console.warn();
 }
+function emitParamDeprecationWarnings({ options, parameters, }) {
+    for (const param of parameters) {
+        if (!param.isDeprecated)
+            continue;
+        const value = options[param.name];
+        if (value === undefined)
+            continue;
+        if (Array.isArray(value) && value.length === 0)
+            continue;
+        console.warn();
+        console.warn(chalk.yellow.bold("⚠️  DEPRECATION WARNING") +
+            chalk.yellow(` - \`${toKebabCase(param.name)}\` is deprecated and may be removed in a future release.`));
+        if (param.deprecationMessage) {
+            console.warn(chalk.yellow(`   ${param.deprecationMessage}`));
+        }
+        console.warn();
+    }
+}
 function resolveOutputMode({ isListCommand, hasPaginationParams, hasUserSpecifiedMaxItems, }) {
     if (!isListCommand || !hasPaginationParams)
         return "single";
@@ -142,6 +160,10 @@ function resolveOutputMode({ isListCommand, hasPaginationParams, hasUserSpecifie
         return "collect";
     return "paginate";
 }
+/** Extract the aliases map from a schema's metadata (e.g., { appKey: "app" }). */
+function getSchemaAliases(schema) {
+    return schema?.meta?.()?.aliases;
+}
 // ============================================================================
 // Schema Analysis
 // ============================================================================
@@ -169,6 +191,7 @@ function analyzeZodField(name, schema, functionInfo) {
     let required = true;
     let defaultValue = undefined;
     let isDeprecated = false;
+    let deprecationMessage;
     // Unwrap optional, default, and nullable wrappers - keep unwrapping until we get to the base type.
     // Check .meta()?.deprecated at each level since it doesn't propagate through wrappers.
     while (true) {
@@ -176,6 +199,9 @@ function analyzeZodField(name, schema, functionInfo) {
         if (meta?.deprecated) {
             isDeprecated = true;
         }
+        if (meta?.deprecationMessage && !deprecationMessage) {
+            deprecationMessage = meta.deprecationMessage;
+        }
         if (baseSchema instanceof z.ZodOptional) {
             required = false;
             baseSchema = baseSchema._zod.def.innerType;
@@ -250,7 +276,8 @@ function analyzeZodField(name, schema, functionInfo) {
         hasResolver: paramHasResolver,
         isPositional: isPositional(schema),
         elementType,
-        hidden: isDeprecated,
+        deprecationMessage,
+        isDeprecated,
     };
 }
 /**
@@ -410,6 +437,16 @@ function createCommandConfig(cliCommandName, functionInfo, sdk) {
     const parameters = usesInputParameters
         ? analyzeInputParameters(functionInfo.inputParameters, functionInfo)
         : analyzeZodSchema(schema, functionInfo);
+    // Mark params that are aliases for other params (e.g., appKey is an alias for app).
+    const schemaAliases = getSchemaAliases(schema);
+    if (schemaAliases) {
+        const aliasedNames = new Set(Object.keys(schemaAliases));
+        for (const param of parameters) {
+            if (aliasedNames.has(param.name)) {
+                param.isAlias = true;
+            }
+        }
+    }
     const description = functionInfo.description ||
         schema?.description ||
         `${cliCommandName} command`;
@@ -418,21 +455,20 @@ function createCommandConfig(cliCommandName, functionInfo, sdk) {
         let success = true;
         let errorMessage = null;
         let resolvedParams = {};
-        // interactiveMode is true by default; --json disables it
+        // The last argument is always the command object with parsed options
         const commandObj = args[args.length - 1];
         const options = commandObj.opts();
+        // interactiveMode is true by default; --json disables it
         const interactiveMode = !options.json;
         const renderer = interactiveMode
             ? createInteractiveRenderer()
             : createJsonRenderer();
         try {
-            // The last argument is always the command object with parsed options
-            const commandObj = args[args.length - 1];
-            const options = commandObj.opts();
             emitDeprecationWarning({
                 cliCommandName,
                 deprecation: functionInfo.deprecation,
             });
+            emitParamDeprecationWarnings({ options, parameters });
             // Check if this is a list command for pagination
             const isListCommand = functionInfo.type === "list";
             const hasPaginationParams = parameters.some((p) => PAGINATION_PARAM_NAMES.has(p.name));
@@ -444,7 +480,7 @@ function createCommandConfig(cliCommandName, functionInfo, sdk) {
             });
             const rawParams = convertCliArgsToSdkParams(parameters, args.slice(0, -1), options);
             // Remap aliased parameter names (e.g., authenticationId → connectionId)
-            const schemaAliases = schema?.meta?.()?.aliases;
+            const schemaAliases = getSchemaAliases(schema);
             if (schemaAliases) {
                 for (const [oldName, newName] of Object.entries(schemaAliases)) {
                     if (oldName in rawParams && !(newName in rawParams)) {
@@ -623,7 +659,7 @@ function addCommand(program, commandName, config) {
             // Required parameters without resolvers become required positional arguments
             command.argument(`<${kebabName}>`, param.description || `${kebabName} parameter`);
         }
-        else if (param.isPositional) {
+        else if (param.isPositional && !param.isDeprecated && !param.isAlias) {
             // Optional parameters marked as positional become optional positional arguments
             command.argument(`[${kebabName}]`, param.description || `${kebabName} parameter`);
         }
@@ -638,7 +674,7 @@ function addCommand(program, commandName, config) {
             flags.push(`--${kebabName}`);
             if (param.type === "boolean") {
                 const opt = new Option(flags.join(", "), param.description);
-                if (param.hidden)
+                if (param.isDeprecated)
                     opt.hideHelp();
                 command.addOption(opt);
             }
@@ -648,7 +684,7 @@ function addCommand(program, commandName, config) {
                 const opt = new Option(flagSignature, param.description || "");
                 opt.default([]);
                 opt.argParser((value, previous) => (previous || []).concat([value]));
-                if (param.hidden)
+                if (param.isDeprecated)
                     opt.hideHelp();
                 command.addOption(opt);
             }
@@ -658,7 +694,7 @@ function addCommand(program, commandName, config) {
                 if (param.default !== undefined) {
                     opt.default(param.default);
                 }
-                if (param.hidden)
+                if (param.isDeprecated)
                     opt.hideHelp();
                 command.addOption(opt);
             }
@@ -683,7 +719,8 @@ function convertCliArgsToSdkParams(parameters, positionalArgs, options) {
     // Handle positional arguments (required parameters or optional positional parameters)
     let argIndex = 0;
     parameters.forEach((param) => {
-        if ((param.required || param.isPositional) &&
+        if ((param.required ||
+            (param.isPositional && !param.isDeprecated && !param.isAlias)) &&
             argIndex < positionalArgs.length) {
             // Use the original camelCase parameter name for the SDK
             sdkParams[param.name] = convertValue(positionalArgs[argIndex], param.type, param.elementType);