@zapier/zapier-sdk-cli 0.11.1 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @zapier/zapier-sdk-cli
 
+## 0.12.0
+
+### Minor Changes
+
+- 21d8487: Improved get started README and added more documentation to the add plugin
+
+### Patch Changes
+
+- Updated dependencies [21d8487]
+  - @zapier/zapier-sdk@0.12.0
+  - @zapier/zapier-sdk-mcp@0.3.11
+
+## 0.11.2
+
+### Patch Changes
+
+- 407245e: Add packages to meta so we can document `fetch` for SDK but not CLI/MCP.
+- Updated dependencies [407245e]
+  - @zapier/zapier-sdk-mcp@0.3.10
+  - @zapier/zapier-sdk@0.11.2
+
 ## 0.11.1
 
 ### Patch Changes

package/README.md

@@ -51,7 +51,7 @@ npx zapier-sdk login
 npx zapier-sdk list-apps
 
 # Generate TypeScript types for an app
-npx zapier-sdk generate-types slack --output ./types/slack.ts
+npx zapier-sdk add slack --types-output ./types/slack.ts
 ```
 
 ## Global Options
@@ -315,16 +315,16 @@ List available authentications with optional filtering
 
 **Options:**
 
-| Option                 | Type     | Required | Default | Possible Values | Description                                              |
-| ---------------------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------- |
-| `--app-key`            | `string` | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI') |
-| `--authentication-ids` | `array`  | ❌       | —       | —               | List of authentication IDs to filter by                  |
-| `--search`             | `string` | ❌       | —       | —               | Search term to filter authentications by title           |
-| `--title`              | `string` | ❌       | —       | —               | Filter authentications by exact title match              |
-| `--account-id`         | `string` | ❌       | —       | —               | Filter by account ID                                     |
-| `--owner`              | `string` | ❌       | —       | —               | Filter by owner                                          |
-| `--page-size`          | `number` | ❌       | —       | —               | Number of authentications per page                       |
-| `--max-items`          | `number` | ❌       | —       | —               | Maximum total items to return across all pages           |
+| Option                 | Type     | Required | Default | Possible Values | Description                                                              |
+| ---------------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------ |
+| `--app-key`            | `string` | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI')                 |
+| `--authentication-ids` | `array`  | ❌       | —       | —               | List of authentication IDs to filter by                                  |
+| `--search`             | `string` | ❌       | —       | —               | Search term to filter authentications by title                           |
+| `--title`              | `string` | ❌       | —       | —               | Filter authentications by exact title match                              |
+| `--account-id`         | `string` | ❌       | —       | —               | Filter by account ID                                                     |
+| `--owner`              | `string` | ❌       | —       | —               | Filter by owner, 'me' for your own authentications or a specific user ID |
+| `--page-size`          | `number` | ❌       | —       | —               | Number of authentications per page                                       |
+| `--max-items`          | `number` | ❌       | —       | —               | Maximum total items to return across all pages                           |
 
 **Usage:**
 
@@ -361,16 +361,16 @@ npx zapier-sdk request <url> [--method] [--body] [--authentication-id] [--callba
 
 #### `add`
 
-Execute add
+Add apps with manifest locking and TypeScript type generation - updates .zapierrc with app versions and generates TypeScript definition files
 
 **Options:**
 
-| Option                 | Type     | Required | Default | Possible Values | Description                                           |
-| ---------------------- | -------- | -------- | ------- | --------------- | ----------------------------------------------------- | --- | ---------------- |
-| `<app-keys>`           | `array`  | ✅       | —       | —               |                                                       |
-| `--authentication-ids` | `array`  | ❌       | —       | —               | Authentication IDs to use for type generation         |
-| `--config-path`        | `string` | ❌       | —       | —               | Path to Zapier config file (defaults to '.zapierrc')  |
-| `--types-output`       | `string` | ❌       | —       | —               | Directory for TypeScript type files (defaults to (src | lib | .)/zapier/apps/) |
+| Option                 | Type     | Required | Default | Possible Values | Description                                                                                             |
+| ---------------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------- |
+| `<app-keys>`           | `array`  | ✅       | —       | —               | One or more app keys to add (e.g., 'slack', 'github', 'trello')                                         |
+| `--authentication-ids` | `array`  | ❌       | —       | —               | Authentication IDs to use for type generation (e.g., ['123', '456'])                                    |
+| `--config-path`        | `string` | ❌       | —       | —               | Path to Zapier config file (defaults to '.zapierrc', e.g., './custom/.zapierrc')                        |
+| `--types-output`       | `string` | ❌       | —       | —               | Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/') |
 
 **Usage:**
 

package/dist/cli.cjs

@@ -561,7 +561,7 @@ Optional fields${pathContext}:`));
   }
   hasResolver(paramName, sdk2, functionName) {
     if (functionName && typeof sdk2.getRegistry === "function") {
-      const registry = sdk2.getRegistry();
+      const registry = sdk2.getRegistry({ package: "cli" });
       const functionInfo = registry.functions.find(
         (f) => f.name === functionName
       );
@@ -573,7 +573,7 @@ Optional fields${pathContext}:`));
   }
   getResolver(paramName, sdk2, functionName) {
     if (functionName && typeof sdk2.getRegistry === "function") {
-      const registry = sdk2.getRegistry();
+      const registry = sdk2.getRegistry({ package: "cli" });
       const functionInfo = registry.functions.find(
         (f) => f.name === functionName
       );
@@ -758,7 +758,7 @@ function generateCliCommands(program2, sdk2) {
     console.error("SDK registry not available");
     return;
   }
-  const registry = sdk2.getRegistry();
+  const registry = sdk2.getRegistry({ package: "cli" });
   registry.functions.forEach((fnInfo) => {
     if (!fnInfo.inputSchema) {
       console.warn(`Schema not found for ${fnInfo.name}`);
@@ -1060,8 +1060,12 @@ async function handlePaginatedListWithAsyncIteration(sdkMethodName, sdkResult, f
           )
         );
       }
-      if (functionInfo) {
-        formatItemsFromSchema(functionInfo, items, totalShown);
+      if (functionInfo && functionInfo.inputSchema) {
+        formatItemsFromSchema(
+          functionInfo,
+          items,
+          totalShown
+        );
       } else {
         formatItemsGeneric2(items, totalShown);
       }
@@ -1097,8 +1101,12 @@ async function handlePaginatedListWithAsyncIteration(sdkMethodName, sdkResult, f
         console.log(chalk3__default.default.yellow(`No ${itemName} found.`));
         return;
       }
-      if (functionInfo) {
-        formatItemsFromSchema(functionInfo, items, 0);
+      if (functionInfo && functionInfo.inputSchema) {
+        formatItemsFromSchema(
+          functionInfo,
+          items,
+          0
+        );
       } else {
         formatItemsGeneric2(items, 0);
       }
@@ -1130,8 +1138,11 @@ function formatNonPaginatedResults(result, requestedMaxItems, userSpecifiedMaxIt
   console.log(chalk3__default.default.green(`
 \u2705 Found ${result.length} ${itemName}:
 `));
-  if (functionInfo) {
-    formatItemsFromSchema(functionInfo, result);
+  if (functionInfo && functionInfo.inputSchema) {
+    formatItemsFromSchema(
+      functionInfo,
+      result
+    );
   } else {
     formatItemsGeneric2(result);
   }
@@ -1563,15 +1574,21 @@ var getLoginConfigPathPlugin = () => {
   };
 };
 var AddSchema = zod.z.object({
-  appKeys: zod.z.array(zod.z.string().min(1, "App key cannot be empty")).min(1, "At least one app key is required"),
-  authenticationIds: zod.z.array(zod.z.string()).optional().describe("Authentication IDs to use for type generation"),
+  appKeys: zod.z.array(zod.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')"
+  ),
+  authenticationIds: zod.z.array(zod.z.string()).optional().describe(
+    "Authentication IDs to use for type generation (e.g., ['123', '456'])"
+  ),
   configPath: zod.z.string().optional().describe(
-    `Path to Zapier config file (defaults to '${zapierSdk.DEFAULT_CONFIG_PATH}')`
+    `Path to Zapier config file (defaults to '${zapierSdk.DEFAULT_CONFIG_PATH}', e.g., './custom/.zapierrc')`
   ),
   typesOutput: zod.z.string().optional().describe(
-    "Directory for TypeScript type files (defaults to (src|lib|.)/zapier/apps/)"
+    "Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/')"
   )
-});
+}).describe(
+  "Add apps with manifest locking and TypeScript type generation - updates .zapierrc with app versions and generates TypeScript definition files"
+);
 var AstTypeGenerator = class {
   constructor() {
     this.factory = ts__namespace.factory;
@@ -2287,7 +2304,7 @@ function createZapierCliSdk(options = {}) {
 
 // package.json
 var package_default = {
-  version: "0.11.1"};
+  version: "0.12.0"};
 
 // src/cli.ts
 var program = new commander.Command();

package/dist/cli.mjs

@@ -528,7 +528,7 @@ Optional fields${pathContext}:`));
   }
   hasResolver(paramName, sdk2, functionName) {
     if (functionName && typeof sdk2.getRegistry === "function") {
-      const registry = sdk2.getRegistry();
+      const registry = sdk2.getRegistry({ package: "cli" });
       const functionInfo = registry.functions.find(
         (f) => f.name === functionName
       );
@@ -540,7 +540,7 @@ Optional fields${pathContext}:`));
   }
   getResolver(paramName, sdk2, functionName) {
     if (functionName && typeof sdk2.getRegistry === "function") {
-      const registry = sdk2.getRegistry();
+      const registry = sdk2.getRegistry({ package: "cli" });
       const functionInfo = registry.functions.find(
         (f) => f.name === functionName
       );
@@ -725,7 +725,7 @@ function generateCliCommands(program2, sdk2) {
     console.error("SDK registry not available");
     return;
   }
-  const registry = sdk2.getRegistry();
+  const registry = sdk2.getRegistry({ package: "cli" });
   registry.functions.forEach((fnInfo) => {
     if (!fnInfo.inputSchema) {
       console.warn(`Schema not found for ${fnInfo.name}`);
@@ -1027,8 +1027,12 @@ async function handlePaginatedListWithAsyncIteration(sdkMethodName, sdkResult, f
           )
         );
       }
-      if (functionInfo) {
-        formatItemsFromSchema(functionInfo, items, totalShown);
+      if (functionInfo && functionInfo.inputSchema) {
+        formatItemsFromSchema(
+          functionInfo,
+          items,
+          totalShown
+        );
       } else {
         formatItemsGeneric2(items, totalShown);
       }
@@ -1064,8 +1068,12 @@ async function handlePaginatedListWithAsyncIteration(sdkMethodName, sdkResult, f
         console.log(chalk3.yellow(`No ${itemName} found.`));
         return;
       }
-      if (functionInfo) {
-        formatItemsFromSchema(functionInfo, items, 0);
+      if (functionInfo && functionInfo.inputSchema) {
+        formatItemsFromSchema(
+          functionInfo,
+          items,
+          0
+        );
       } else {
         formatItemsGeneric2(items, 0);
       }
@@ -1097,8 +1105,11 @@ function formatNonPaginatedResults(result, requestedMaxItems, userSpecifiedMaxIt
   console.log(chalk3.green(`
 \u2705 Found ${result.length} ${itemName}:
 `));
-  if (functionInfo) {
-    formatItemsFromSchema(functionInfo, result);
+  if (functionInfo && functionInfo.inputSchema) {
+    formatItemsFromSchema(
+      functionInfo,
+      result
+    );
   } else {
     formatItemsGeneric2(result);
   }
@@ -1530,15 +1541,21 @@ 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"),
-  authenticationIds: z.array(z.string()).optional().describe("Authentication IDs to use for type generation"),
+  appKeys: 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')"
+  ),
+  authenticationIds: z.array(z.string()).optional().describe(
+    "Authentication IDs to use for type generation (e.g., ['123', '456'])"
+  ),
   configPath: z.string().optional().describe(
-    `Path to Zapier config file (defaults to '${DEFAULT_CONFIG_PATH}')`
+    `Path to Zapier config file (defaults to '${DEFAULT_CONFIG_PATH}', e.g., './custom/.zapierrc')`
   ),
   typesOutput: z.string().optional().describe(
-    "Directory for TypeScript type files (defaults to (src|lib|.)/zapier/apps/)"
+    "Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/')"
   )
-});
+}).describe(
+  "Add apps with manifest locking and TypeScript type generation - updates .zapierrc with app versions and generates TypeScript definition files"
+);
 var AstTypeGenerator = class {
   constructor() {
     this.factory = ts.factory;
@@ -2254,7 +2271,7 @@ function createZapierCliSdk(options = {}) {
 
 // package.json
 var package_default = {
-  version: "0.11.1"};
+  version: "0.12.0"};
 
 // src/cli.ts
 var program = new Command();

package/dist/index.cjs

@@ -438,15 +438,21 @@ var getLoginConfigPathPlugin = () => {
   };
 };
 var AddSchema = zod.z.object({
-  appKeys: zod.z.array(zod.z.string().min(1, "App key cannot be empty")).min(1, "At least one app key is required"),
-  authenticationIds: zod.z.array(zod.z.string()).optional().describe("Authentication IDs to use for type generation"),
+  appKeys: zod.z.array(zod.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')"
+  ),
+  authenticationIds: zod.z.array(zod.z.string()).optional().describe(
+    "Authentication IDs to use for type generation (e.g., ['123', '456'])"
+  ),
   configPath: zod.z.string().optional().describe(
-    `Path to Zapier config file (defaults to '${zapierSdk.DEFAULT_CONFIG_PATH}')`
+    `Path to Zapier config file (defaults to '${zapierSdk.DEFAULT_CONFIG_PATH}', e.g., './custom/.zapierrc')`
   ),
   typesOutput: zod.z.string().optional().describe(
-    "Directory for TypeScript type files (defaults to (src|lib|.)/zapier/apps/)"
+    "Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/')"
   )
-});
+}).describe(
+  "Add apps with manifest locking and TypeScript type generation - updates .zapierrc with app versions and generates TypeScript definition files"
+);
 var AstTypeGenerator = class {
   constructor() {
     this.factory = ts__namespace.factory;

package/dist/index.mjs

@@ -407,15 +407,21 @@ 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"),
-  authenticationIds: z.array(z.string()).optional().describe("Authentication IDs to use for type generation"),
+  appKeys: 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')"
+  ),
+  authenticationIds: z.array(z.string()).optional().describe(
+    "Authentication IDs to use for type generation (e.g., ['123', '456'])"
+  ),
   configPath: z.string().optional().describe(
-    `Path to Zapier config file (defaults to '${DEFAULT_CONFIG_PATH}')`
+    `Path to Zapier config file (defaults to '${DEFAULT_CONFIG_PATH}', e.g., './custom/.zapierrc')`
   ),
   typesOutput: z.string().optional().describe(
-    "Directory for TypeScript type files (defaults to (src|lib|.)/zapier/apps/)"
+    "Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/')"
   )
-});
+}).describe(
+  "Add apps with manifest locking and TypeScript type generation - updates .zapierrc with app versions and generates TypeScript definition files"
+);
 var AstTypeGenerator = class {
   constructor() {
     this.factory = ts.factory;

package/dist/package.json

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

package/dist/src/plugins/add/schemas.js

@@ -1,19 +1,22 @@
 import { z } from "zod";
 import { DEFAULT_CONFIG_PATH } from "@zapier/zapier-sdk";
-export const AddSchema = z.object({
+export const AddSchema = z
+    .object({
     appKeys: z
         .array(z.string().min(1, "App key cannot be empty"))
-        .min(1, "At least one app key is required"),
+        .min(1, "At least one app key is required")
+        .describe("One or more app keys to add (e.g., 'slack', 'github', 'trello')"),
     authenticationIds: z
         .array(z.string())
         .optional()
-        .describe("Authentication IDs to use for type generation"),
+        .describe("Authentication IDs to use for type generation (e.g., ['123', '456'])"),
     configPath: z
         .string()
         .optional()
-        .describe(`Path to Zapier config file (defaults to '${DEFAULT_CONFIG_PATH}')`),
+        .describe(`Path to Zapier config file (defaults to '${DEFAULT_CONFIG_PATH}', e.g., './custom/.zapierrc')`),
     typesOutput: z
         .string()
         .optional()
-        .describe("Directory for TypeScript type files (defaults to (src|lib|.)/zapier/apps/)"),
-});
+        .describe("Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/')"),
+})
+    .describe("Add apps with manifest locking and TypeScript type generation - updates .zapierrc with app versions and generates TypeScript definition files");

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

@@ -121,7 +121,7 @@ export function generateCliCommands(program, sdk) {
         console.error("SDK registry not available");
         return;
     }
-    const registry = sdk.getRegistry();
+    const registry = sdk.getRegistry({ package: "cli" });
     // Create all commands first
     registry.functions.forEach((fnInfo) => {
         if (!fnInfo.inputSchema) {
@@ -415,7 +415,7 @@ async function handlePaginatedListWithAsyncIteration(sdkMethodName, sdkResult, f
                 console.log(chalk.blue(`📋 ${getListTitleFromMethod(sdkMethodName, functionInfo)}\n`));
             }
             // Format and display items using function info
-            if (functionInfo) {
+            if (functionInfo && functionInfo.inputSchema) {
                 formatItemsFromSchema(functionInfo, items, totalShown);
             }
             else {
@@ -452,7 +452,7 @@ async function handlePaginatedListWithAsyncIteration(sdkMethodName, sdkResult, f
                 console.log(chalk.yellow(`No ${itemName} found.`));
                 return;
             }
-            if (functionInfo) {
+            if (functionInfo && functionInfo.inputSchema) {
                 formatItemsFromSchema(functionInfo, items, 0);
             }
             else {
@@ -486,7 +486,7 @@ function formatNonPaginatedResults(result, requestedMaxItems, userSpecifiedMaxIt
     }
     console.log(chalk.green(`\n✅ Found ${result.length} ${itemName}:\n`));
     // Use function info for formatting
-    if (functionInfo) {
+    if (functionInfo && functionInfo.inputSchema) {
         formatItemsFromSchema(functionInfo, result);
     }
     else {

package/dist/src/utils/parameter-resolver.js

@@ -506,7 +506,7 @@ export class SchemaParameterResolver {
     hasResolver(paramName, sdk, functionName) {
         // Check plugin-specific resolvers first
         if (functionName && typeof sdk.getRegistry === "function") {
-            const registry = sdk.getRegistry();
+            const registry = sdk.getRegistry({ package: "cli" });
             const functionInfo = registry.functions.find((f) => f.name === functionName);
             if (functionInfo && functionInfo.resolvers?.[paramName]) {
                 return true;
@@ -518,7 +518,7 @@ export class SchemaParameterResolver {
     getResolver(paramName, sdk, functionName) {
         // Check plugin-specific resolvers first
         if (functionName && typeof sdk.getRegistry === "function") {
-            const registry = sdk.getRegistry();
+            const registry = sdk.getRegistry({ package: "cli" });
             const functionInfo = registry.functions.find((f) => f.name === functionName);
             if (functionInfo && functionInfo.resolvers?.[paramName]) {
                 return functionInfo.resolvers[paramName];