@zapier/zapier-sdk-cli 0.13.1 → 0.13.3

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @zapier/zapier-sdk-cli
 
+## 0.13.3
+
+### Patch Changes
+
+- 53fa85e: Show id and key properties when listing actions. Allow getAction to use an id or key. Make runAction pass action_id to API to ensure it always works.
+- Updated dependencies [53fa85e]
+  - @zapier/zapier-sdk@0.13.3
+  - @zapier/zapier-sdk-mcp@0.3.16
+
+## 0.13.2
+
+### Patch Changes
+
+- 325d5c2: Fix bug where adding apps with dashed slugs would create types with syntax errors. All valid keys are now valid properties on the apps interface.
+- Updated dependencies [325d5c2]
+  - @zapier/zapier-sdk@0.13.2
+  - @zapier/zapier-sdk-mcp@0.3.15
+
 ## 0.13.1
 
 ### Patch Changes

package/dist/cli.cjs

@@ -626,12 +626,18 @@ function formatItemsFromSchema(functionInfo, items, startingNumber = 0) {
 }
 function formatSingleItem(formatted, itemNumber) {
   let titleLine = `${chalk3__default.default.gray(`${itemNumber + 1}.`)} ${chalk3__default.default.cyan(formatted.title)}`;
-  if (formatted.id) {
-    titleLine += ` ${chalk3__default.default.gray(`(ID: ${formatted.id})`)}`;
-  } else if (formatted.keys) {
-    titleLine += ` ${chalk3__default.default.gray(`(${formatted.keys.join(", ")})`)}`;
+  const subtitleParts = [];
+  if (formatted.keys) {
+    subtitleParts.push(...formatted.keys);
   } else if (formatted.key) {
-    titleLine += ` ${chalk3__default.default.gray(`(${formatted.key})`)}`;
+    subtitleParts.push(formatted.key);
+  }
+  if (formatted.id) {
+    subtitleParts.push(formatted.id);
+  }
+  const uniqueParts = [...new Set(subtitleParts)];
+  if (uniqueParts.length > 0) {
+    titleLine += ` ${chalk3__default.default.gray(`(${uniqueParts.join(", ")})`)}`;
   }
   console.log(titleLine);
   if (formatted.description) {
@@ -1604,21 +1610,17 @@ var AstTypeGenerator = class {
    * Generate TypeScript types using AST for a specific app
    */
   async generateTypes(options) {
-    const { appKey, authenticationId, sdk: sdk2 } = options;
-    const { app, version } = this.parseAppIdentifier(appKey);
+    const { app, authenticationId, sdk: sdk2 } = options;
     const actionsResult = await sdk2.listActions({
-      appKey: app
+      appKey: app.implementation_id
     });
     const actions = actionsResult.data;
-    if (actions.length === 0) {
-      return this.generateEmptyTypesFile(app, version);
-    }
     const actionsWithFields = [];
     if (authenticationId) {
       for (const action of actions) {
         try {
           const fieldsResult = await sdk2.listInputFields({
-            appKey,
+            appKey: app.implementation_id,
             actionKey: action.key,
             actionType: action.action_type,
             authenticationId
@@ -1644,7 +1646,7 @@ var AstTypeGenerator = class {
             ...action,
             inputFields: [],
             name: action.title || action.key,
-            app_key: action.app_key || appKey,
+            app_key: action.app_key || app.implementation_id,
             action_type: action.action_type || "write",
             title: action.title || action.key,
             type: "action",
@@ -1653,20 +1655,15 @@ var AstTypeGenerator = class {
         }
       );
     }
-    const sourceFile = this.createSourceFile(app, actionsWithFields, version);
+    const sourceFile = this.createSourceFile(app, actionsWithFields);
     return this.printer.printFile(sourceFile);
   }
-  parseAppIdentifier(identifier) {
-    const parts = identifier.split("@");
-    return {
-      app: parts[0],
-      version: parts[1]
-    };
-  }
-  createSourceFile(appKey, actions, version) {
-    const appName = this.capitalize(appKey);
-    const versionComment = version ? ` * Generated for ${appKey}@${version}` : ` * Generated for ${appKey}`;
-    const headerComment = `Auto-generated TypeScript types for Zapier ${appKey} actions
+  createSourceFile(app, actions) {
+    const appName = this.getPreferredAppName(app);
+    const versionComment = ` * Generated for ${app.implementation_id}`;
+    const preferredKey = this.getPreferredProgrammaticKey(app);
+    const myVariableName = `my${appName}`;
+    const headerComment = `Auto-generated TypeScript types for Zapier ${app.key} actions
 ${versionComment.slice(3)}
 Generated on: ${(/* @__PURE__ */ new Date()).toISOString()}
 
@@ -1678,11 +1675,11 @@ Usage:
   
   const zapier = createZapierSdk();
   // Types are automatically available:
-  await zapier.apps.${appKey}.search.user_by_email({ authenticationId: 123, inputs: { email } })
+  await zapier.apps.${preferredKey}.search.user_by_email({ authenticationId: 123, inputs: { email } })
   
   // Factory usage (pinned auth):
-  const my${appName} = zapier.apps.${appKey}({ authenticationId: 123 })
-  await my${appName}.search.user_by_email({ inputs: { email } })`;
+  const ${myVariableName} = zapier.apps.${preferredKey}({ authenticationId: 123 })
+  await ${myVariableName}.search.user_by_email({ inputs: { email } })`;
     const statements = [
       // Import the SDK to activate module augmentation
       this.createImportStatement(["@zapier/zapier-sdk"]),
@@ -1720,7 +1717,8 @@ Usage:
     statements.push(appFactoryInterface);
     const appWithFactoryType = this.createAppWithFactoryType(appName);
     statements.push(appWithFactoryType);
-    const moduleAugmentation = this.createModuleAugmentation(appKey, appName);
+    const allKeys = this.getAllKeys(app);
+    const moduleAugmentation = this.createModuleAugmentation(allKeys, appName);
     statements.push(moduleAugmentation);
     statements.push(
       this.factory.createExportDeclaration(
@@ -2046,7 +2044,15 @@ Usage:
       ])
     );
   }
-  createModuleAugmentation(appKey, appName) {
+  createModuleAugmentation(appKeys, appName) {
+    const properties = appKeys.map(
+      (appKey) => this.factory.createPropertySignature(
+        void 0,
+        this.createPropertyName(appKey),
+        void 0,
+        this.factory.createTypeReferenceNode(`${appName}AppWithFactory`)
+      )
+    );
     return this.factory.createModuleDeclaration(
       [this.factory.createToken(ts__namespace.SyntaxKind.DeclareKeyword)],
       this.factory.createStringLiteral("@zapier/zapier-sdk"),
@@ -2056,14 +2062,7 @@ Usage:
           "ZapierSdkApps",
           void 0,
           void 0,
-          [
-            this.factory.createPropertySignature(
-              void 0,
-              appKey,
-              void 0,
-              this.factory.createTypeReferenceNode(`${appName}AppWithFactory`)
-            )
-          ]
+          properties
         )
       ])
     );
@@ -2101,38 +2100,6 @@ Usage:
         ]);
     }
   }
-  generateEmptyTypesFile(appKey, version) {
-    const appName = this.capitalize(appKey);
-    const versionComment = version ? ` * Generated for ${appKey}@${version}` : ` * Generated for ${appKey}`;
-    return `/* eslint-disable @typescript-eslint/naming-convention, @typescript-eslint/no-explicit-any */
-/**
- * Auto-generated TypeScript types for Zapier ${appKey} actions
-${versionComment}
- * Generated on: ${(/* @__PURE__ */ new Date()).toISOString()}
- * 
- * No actions found for this app.
- */
-
-import type { ActionExecutionOptions, ActionExecutionResult, ZapierFetchInitOptions } from '@zapier/zapier-sdk'
-
-interface ${appName}AppProxy {
-  /** Make authenticated HTTP requests through Zapier's Relay service */
-  fetch: (url: string | URL, init?: ZapierFetchInitOptions) => Promise<Response>
-}
-
-interface ${appName}AppFactory {
-  (options: { authenticationId: number }): ${appName}AppProxy
-}
-
-type ${appName}AppWithFactory = ${appName}AppFactory & ${appName}AppProxy
-
-declare module "@zapier/zapier-sdk" {
-  interface ZapierSdkApps {
-    ${appKey}: ${appName}AppWithFactory
-  }
-}
-`;
-  }
   capitalize(str) {
     return str.charAt(0).toUpperCase() + str.slice(1).replace(/[-_]/g, "");
   }
@@ -2153,6 +2120,50 @@ declare module "@zapier/zapier-sdk" {
   escapeComment(comment) {
     return comment.replace(/\*\//g, "*\\/").replace(/\r?\n/g, " ");
   }
+  createPropertyName(name) {
+    if (this.isValidIdentifier(name)) {
+      return this.factory.createIdentifier(name);
+    } else {
+      return this.factory.createStringLiteral(name);
+    }
+  }
+  isValidIdentifier(name) {
+    return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name);
+  }
+  getPreferredProgrammaticKey(app) {
+    if (app.slug) {
+      const snakeCaseSlug = zapierSdk.toSnakeCase(app.slug);
+      if (this.isValidIdentifier(snakeCaseSlug)) {
+        return snakeCaseSlug;
+      }
+    }
+    if (this.isValidIdentifier(app.key)) {
+      return app.key;
+    }
+    return this.sanitizeToIdentifier(app.key);
+  }
+  getPreferredAppName(app) {
+    const preferredKey = this.getPreferredProgrammaticKey(app);
+    if (preferredKey.includes("_")) {
+      return preferredKey.split("_").map((word) => this.capitalize(word.toLowerCase())).join("");
+    }
+    return this.capitalize(preferredKey);
+  }
+  sanitizeToIdentifier(name) {
+    let sanitized = name.replace(/[^a-zA-Z0-9_$]/g, "_");
+    if (/^[0-9]/.test(sanitized)) {
+      sanitized = "_" + sanitized;
+    }
+    return sanitized;
+  }
+  getAllKeys(app) {
+    const allKeys = /* @__PURE__ */ new Set([app.key]);
+    if (app.slug) {
+      allKeys.add(app.slug);
+      allKeys.add(zapierSdk.toSnakeCase(app.slug));
+    }
+    return Array.from(allKeys);
+  }
 };
 async function detectTypesOutputDirectory() {
   const candidates = ["src", "lib"];
@@ -2237,7 +2248,7 @@ var addPlugin = ({ sdk: sdk2, context }) => {
         try {
           const generator = new AstTypeGenerator();
           const typeDefinitions = await generator.generateTypes({
-            appKey: manifestKey,
+            app,
             authenticationId,
             sdk: sdk2
           });
@@ -2284,7 +2295,7 @@ function createZapierCliSdk(options = {}) {
 
 // package.json
 var package_default = {
-  version: "0.13.1"};
+  version: "0.13.3"};
 
 // src/cli.ts
 var program = new commander.Command();

package/dist/cli.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { Command } from 'commander';
 import { z } from 'zod';
-import { createFunction, OutputPropertySchema, DEFAULT_CONFIG_PATH, createZapierSdkWithoutRegistry, registryPlugin, ZapierError, formatErrorMessage, isPositional } from '@zapier/zapier-sdk';
+import { createFunction, OutputPropertySchema, DEFAULT_CONFIG_PATH, createZapierSdkWithoutRegistry, registryPlugin, toSnakeCase, ZapierError, formatErrorMessage, isPositional } from '@zapier/zapier-sdk';
 import inquirer from 'inquirer';
 import chalk3 from 'chalk';
 import util from 'util';
@@ -593,12 +593,18 @@ function formatItemsFromSchema(functionInfo, items, startingNumber = 0) {
 }
 function formatSingleItem(formatted, itemNumber) {
   let titleLine = `${chalk3.gray(`${itemNumber + 1}.`)} ${chalk3.cyan(formatted.title)}`;
-  if (formatted.id) {
-    titleLine += ` ${chalk3.gray(`(ID: ${formatted.id})`)}`;
-  } else if (formatted.keys) {
-    titleLine += ` ${chalk3.gray(`(${formatted.keys.join(", ")})`)}`;
+  const subtitleParts = [];
+  if (formatted.keys) {
+    subtitleParts.push(...formatted.keys);
   } else if (formatted.key) {
-    titleLine += ` ${chalk3.gray(`(${formatted.key})`)}`;
+    subtitleParts.push(formatted.key);
+  }
+  if (formatted.id) {
+    subtitleParts.push(formatted.id);
+  }
+  const uniqueParts = [...new Set(subtitleParts)];
+  if (uniqueParts.length > 0) {
+    titleLine += ` ${chalk3.gray(`(${uniqueParts.join(", ")})`)}`;
   }
   console.log(titleLine);
   if (formatted.description) {
@@ -1571,21 +1577,17 @@ var AstTypeGenerator = class {
    * Generate TypeScript types using AST for a specific app
    */
   async generateTypes(options) {
-    const { appKey, authenticationId, sdk: sdk2 } = options;
-    const { app, version } = this.parseAppIdentifier(appKey);
+    const { app, authenticationId, sdk: sdk2 } = options;
     const actionsResult = await sdk2.listActions({
-      appKey: app
+      appKey: app.implementation_id
     });
     const actions = actionsResult.data;
-    if (actions.length === 0) {
-      return this.generateEmptyTypesFile(app, version);
-    }
     const actionsWithFields = [];
     if (authenticationId) {
       for (const action of actions) {
         try {
           const fieldsResult = await sdk2.listInputFields({
-            appKey,
+            appKey: app.implementation_id,
             actionKey: action.key,
             actionType: action.action_type,
             authenticationId
@@ -1611,7 +1613,7 @@ var AstTypeGenerator = class {
             ...action,
             inputFields: [],
             name: action.title || action.key,
-            app_key: action.app_key || appKey,
+            app_key: action.app_key || app.implementation_id,
             action_type: action.action_type || "write",
             title: action.title || action.key,
             type: "action",
@@ -1620,20 +1622,15 @@ var AstTypeGenerator = class {
         }
       );
     }
-    const sourceFile = this.createSourceFile(app, actionsWithFields, version);
+    const sourceFile = this.createSourceFile(app, actionsWithFields);
     return this.printer.printFile(sourceFile);
   }
-  parseAppIdentifier(identifier) {
-    const parts = identifier.split("@");
-    return {
-      app: parts[0],
-      version: parts[1]
-    };
-  }
-  createSourceFile(appKey, actions, version) {
-    const appName = this.capitalize(appKey);
-    const versionComment = version ? ` * Generated for ${appKey}@${version}` : ` * Generated for ${appKey}`;
-    const headerComment = `Auto-generated TypeScript types for Zapier ${appKey} actions
+  createSourceFile(app, actions) {
+    const appName = this.getPreferredAppName(app);
+    const versionComment = ` * Generated for ${app.implementation_id}`;
+    const preferredKey = this.getPreferredProgrammaticKey(app);
+    const myVariableName = `my${appName}`;
+    const headerComment = `Auto-generated TypeScript types for Zapier ${app.key} actions
 ${versionComment.slice(3)}
 Generated on: ${(/* @__PURE__ */ new Date()).toISOString()}
 
@@ -1645,11 +1642,11 @@ Usage:
   
   const zapier = createZapierSdk();
   // Types are automatically available:
-  await zapier.apps.${appKey}.search.user_by_email({ authenticationId: 123, inputs: { email } })
+  await zapier.apps.${preferredKey}.search.user_by_email({ authenticationId: 123, inputs: { email } })
   
   // Factory usage (pinned auth):
-  const my${appName} = zapier.apps.${appKey}({ authenticationId: 123 })
-  await my${appName}.search.user_by_email({ inputs: { email } })`;
+  const ${myVariableName} = zapier.apps.${preferredKey}({ authenticationId: 123 })
+  await ${myVariableName}.search.user_by_email({ inputs: { email } })`;
     const statements = [
       // Import the SDK to activate module augmentation
       this.createImportStatement(["@zapier/zapier-sdk"]),
@@ -1687,7 +1684,8 @@ Usage:
     statements.push(appFactoryInterface);
     const appWithFactoryType = this.createAppWithFactoryType(appName);
     statements.push(appWithFactoryType);
-    const moduleAugmentation = this.createModuleAugmentation(appKey, appName);
+    const allKeys = this.getAllKeys(app);
+    const moduleAugmentation = this.createModuleAugmentation(allKeys, appName);
     statements.push(moduleAugmentation);
     statements.push(
       this.factory.createExportDeclaration(
@@ -2013,7 +2011,15 @@ Usage:
       ])
     );
   }
-  createModuleAugmentation(appKey, appName) {
+  createModuleAugmentation(appKeys, appName) {
+    const properties = appKeys.map(
+      (appKey) => this.factory.createPropertySignature(
+        void 0,
+        this.createPropertyName(appKey),
+        void 0,
+        this.factory.createTypeReferenceNode(`${appName}AppWithFactory`)
+      )
+    );
     return this.factory.createModuleDeclaration(
       [this.factory.createToken(ts.SyntaxKind.DeclareKeyword)],
       this.factory.createStringLiteral("@zapier/zapier-sdk"),
@@ -2023,14 +2029,7 @@ Usage:
           "ZapierSdkApps",
           void 0,
           void 0,
-          [
-            this.factory.createPropertySignature(
-              void 0,
-              appKey,
-              void 0,
-              this.factory.createTypeReferenceNode(`${appName}AppWithFactory`)
-            )
-          ]
+          properties
         )
       ])
     );
@@ -2068,38 +2067,6 @@ Usage:
         ]);
     }
   }
-  generateEmptyTypesFile(appKey, version) {
-    const appName = this.capitalize(appKey);
-    const versionComment = version ? ` * Generated for ${appKey}@${version}` : ` * Generated for ${appKey}`;
-    return `/* eslint-disable @typescript-eslint/naming-convention, @typescript-eslint/no-explicit-any */
-/**
- * Auto-generated TypeScript types for Zapier ${appKey} actions
-${versionComment}
- * Generated on: ${(/* @__PURE__ */ new Date()).toISOString()}
- * 
- * No actions found for this app.
- */
-
-import type { ActionExecutionOptions, ActionExecutionResult, ZapierFetchInitOptions } from '@zapier/zapier-sdk'
-
-interface ${appName}AppProxy {
-  /** Make authenticated HTTP requests through Zapier's Relay service */
-  fetch: (url: string | URL, init?: ZapierFetchInitOptions) => Promise<Response>
-}
-
-interface ${appName}AppFactory {
-  (options: { authenticationId: number }): ${appName}AppProxy
-}
-
-type ${appName}AppWithFactory = ${appName}AppFactory & ${appName}AppProxy
-
-declare module "@zapier/zapier-sdk" {
-  interface ZapierSdkApps {
-    ${appKey}: ${appName}AppWithFactory
-  }
-}
-`;
-  }
   capitalize(str) {
     return str.charAt(0).toUpperCase() + str.slice(1).replace(/[-_]/g, "");
   }
@@ -2120,6 +2087,50 @@ declare module "@zapier/zapier-sdk" {
   escapeComment(comment) {
     return comment.replace(/\*\//g, "*\\/").replace(/\r?\n/g, " ");
   }
+  createPropertyName(name) {
+    if (this.isValidIdentifier(name)) {
+      return this.factory.createIdentifier(name);
+    } else {
+      return this.factory.createStringLiteral(name);
+    }
+  }
+  isValidIdentifier(name) {
+    return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name);
+  }
+  getPreferredProgrammaticKey(app) {
+    if (app.slug) {
+      const snakeCaseSlug = toSnakeCase(app.slug);
+      if (this.isValidIdentifier(snakeCaseSlug)) {
+        return snakeCaseSlug;
+      }
+    }
+    if (this.isValidIdentifier(app.key)) {
+      return app.key;
+    }
+    return this.sanitizeToIdentifier(app.key);
+  }
+  getPreferredAppName(app) {
+    const preferredKey = this.getPreferredProgrammaticKey(app);
+    if (preferredKey.includes("_")) {
+      return preferredKey.split("_").map((word) => this.capitalize(word.toLowerCase())).join("");
+    }
+    return this.capitalize(preferredKey);
+  }
+  sanitizeToIdentifier(name) {
+    let sanitized = name.replace(/[^a-zA-Z0-9_$]/g, "_");
+    if (/^[0-9]/.test(sanitized)) {
+      sanitized = "_" + sanitized;
+    }
+    return sanitized;
+  }
+  getAllKeys(app) {
+    const allKeys = /* @__PURE__ */ new Set([app.key]);
+    if (app.slug) {
+      allKeys.add(app.slug);
+      allKeys.add(toSnakeCase(app.slug));
+    }
+    return Array.from(allKeys);
+  }
 };
 async function detectTypesOutputDirectory() {
   const candidates = ["src", "lib"];
@@ -2204,7 +2215,7 @@ var addPlugin = ({ sdk: sdk2, context }) => {
         try {
           const generator = new AstTypeGenerator();
           const typeDefinitions = await generator.generateTypes({
-            appKey: manifestKey,
+            app,
             authenticationId,
             sdk: sdk2
           });
@@ -2251,7 +2262,7 @@ function createZapierCliSdk(options = {}) {
 
 // package.json
 var package_default = {
-  version: "0.13.1"};
+  version: "0.13.3"};
 
 // src/cli.ts
 var program = new Command();