zapier-platform-cli 17.7.0 → 17.7.1

package/oclif.manifest.json

@@ -1157,7 +1157,7 @@
     "pull": {
       "aliases": [],
       "args": {},
-      "description": "Retrieve and update your local integration files with the latest version.\n\nThis command updates your local integration files with the latest version. You will be prompted with a confirmation dialog before continuing if there any destructive file changes.\n\nZapier may release new versions of your integration with bug fixes or new features. In the event this occurs, you will be unable to do the following until your local files are updated by running `zapier pull`:\n\n* push to the promoted version\n* promote a new version\n* migrate users from one version to another",
+      "description": "Retrieve and update your local integration files with the promoted version (or latest version if not public).\n\nThis command updates your local integration files with the promoted version (or latest version if not public). You will be prompted with a confirmation dialog before continuing if there any destructive file changes.\n\nZapier may release new versions of your integration with bug fixes or new features. In the event this occurs, you will be unable to do the following until your local files are updated by running `zapier pull`:\n\n* push to the promoted version\n* promote a new version\n* migrate users from one version to another",
       "flags": {
         "debug": {
           "char": "d",
@@ -1549,6 +1549,7 @@
       "examples": [
         "zapier validate",
         "zapier validate --without-style",
+        "zapier validate --skip-build",
         "zapier validate --format json"
       ],
       "flags": {
@@ -1558,6 +1559,12 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "skip-build": {
+          "description": "Skip running the _zapier-build script before validation.",
+          "name": "skip-build",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1900,6 +1907,88 @@
         "list.js"
       ]
     },
+    "delete:integration": {
+      "aliases": [
+        "delete:app"
+      ],
+      "args": {},
+      "description": "Delete your integration (including all versions).\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.",
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "delete:integration",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "delete",
+        "integration.js"
+      ]
+    },
+    "delete:version": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "description": "Specify the version to delete. It must have no users or Zaps.",
+          "name": "version",
+          "required": true
+        }
+      },
+      "description": "Delete a specific version of your integration.\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier migrate` and `zapier deprecate` before this command will work.",
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "delete:version",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "delete",
+        "version.js"
+      ]
+    },
     "env:get": {
       "aliases": [],
       "args": {
@@ -2076,88 +2165,6 @@
         "unset.js"
       ]
     },
-    "delete:integration": {
-      "aliases": [
-        "delete:app"
-      ],
-      "args": {},
-      "description": "Delete your integration (including all versions).\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.",
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "delete:integration",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "delete",
-        "integration.js"
-      ]
-    },
-    "delete:version": {
-      "aliases": [],
-      "args": {
-        "version": {
-          "description": "Specify the version to delete. It must have no users or Zaps.",
-          "name": "version",
-          "required": true
-        }
-      },
-      "description": "Delete a specific version of your integration.\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier migrate` and `zapier deprecate` before this command will work.",
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "delete:version",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "delete",
-        "version.js"
-      ]
-    },
     "team:add": {
       "aliases": [
         "team:invite"
@@ -2537,5 +2544,5 @@
       ]
     }
   },
-  "version": "17.7.0"
+  "version": "17.7.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "17.7.0",
+  "version": "17.7.1",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",

package/src/generators/index.js

@@ -79,6 +79,7 @@ const writeGenericTypeScriptPackageJson = (gen, packageJsonExtension) => {
           test: 'npm run build && vitest --run',
           clean: 'rimraf ./dist ./build',
           build: 'npm run clean && tsc',
+          dev: 'npm run build -- --watch',
           '_zapier-build': 'npm run build',
         },
         dependencies: {
@@ -252,13 +253,26 @@ class ProjectGenerator extends Generator {
 
   async prompting() {
     if (!this.options.template) {
+      // Filter template choices based on language and module type
+      let templateChoices = TEMPLATE_CHOICES;
+      let defaultTemplate = 'minimal';
+
+      // TypeScript filtering takes precedence over ESM filtering
+      if (this.options.language === 'typescript') {
+        templateChoices = TS_SUPPORTED_TEMPLATES;
+        defaultTemplate = 'basic-auth';
+      } else if (this.options.module === 'esm') {
+        templateChoices = ESM_SUPPORTED_TEMPLATES;
+        defaultTemplate = 'minimal'; // minimal is the only ESM template
+      }
+
       this.answers = await this.prompt([
         {
           type: 'list',
           name: 'template',
-          choices: TEMPLATE_CHOICES,
+          choices: templateChoices,
           message: 'Choose a project template to start with:',
-          default: 'minimal',
+          default: defaultTemplate,
         },
       ]);
       this.options.template = this.answers.template;
@@ -320,6 +334,8 @@ class ProjectGenerator extends Generator {
 
 module.exports = {
   TEMPLATE_CHOICES,
+  ESM_SUPPORTED_TEMPLATES,
+  TS_SUPPORTED_TEMPLATES,
   PullGenerator,
   ProjectGenerator,
 };

package/src/oclif/ZapierBaseCommand.js

@@ -90,9 +90,14 @@ class ZapierBaseCommand extends Command {
 
   // validate that user input looks like a semver version
   throwForInvalidVersion(version) {
-    if (!version.match(/^\d+\.\d+\.\d+$/g)) {
+    if (
+      !version.match(
+        // this is mirrored in schemas/VersionSchema.js and developer_cli/constants.py
+        /^(?:0|[1-9]\d{0,2})\.(?:0|[1-9]\d{0,2})\.(?:0|[1-9]\d{0,2})(?:-(?=.{1,12}$)[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*)?$/g,
+      )
+    ) {
       throw new Error(
-        `${version} is an invalid version str. Try something like \`1.2.3\``,
+        `${version} is an invalid version str. Try something like \`1.2.3\` or \`0.0.0-TICKET\``,
       );
     }
   }

package/src/oclif/commands/invoke.js

@@ -240,15 +240,26 @@ const resolveInputDataTypes = (inputData, inputFields, timezone) => {
 };
 
 const appendEnv = async (vars, prefix = '') => {
-  await fs.appendFile(
-    '.env',
-    Object.entries(vars)
-      .filter(([k, v]) => v !== undefined)
-      .map(
-        ([k, v]) =>
-          `${prefix}${k}='${typeof v === 'object' && v !== null ? JSON.stringify(v) : v || ''}'\n`,
-      ),
-  );
+  const envFile = '.env';
+  let content = Object.entries(vars)
+    .filter(([k, v]) => v !== undefined)
+    .map(
+      ([k, v]) =>
+        `${prefix}${k}='${typeof v === 'object' && v !== null ? JSON.stringify(v) : v || ''}'\n`,
+    )
+    .join('');
+
+  // Check if .env file exists and doesn't end with newline
+  try {
+    const existingContent = await fs.readFile(envFile, 'utf8');
+    if (existingContent.length > 0 && !existingContent.endsWith('\n')) {
+      content = '\n' + content;
+    }
+  } catch (error) {
+    // File doesn't exist or can't be read, proceed as normal
+  }
+
+  await fs.appendFile(envFile, content);
 };
 
 const replaceDoubleCurlies = async (request) => {

package/src/oclif/commands/migrate.js

@@ -1,6 +1,7 @@
 const _ = require('lodash');
 const debug = require('debug')('zapier:migrate');
 const { Args, Flags } = require('@oclif/core');
+const colors = require('colors/safe');
 
 const BaseCommand = require('../ZapierBaseCommand');
 const PromoteCommand = require('./promote');
@@ -118,17 +119,15 @@ class MigrateCommand extends BaseCommand {
 
     await this.run_require_confirmation_pre_checks(app, body);
 
+    let message;
     if (user || account) {
-      this.startSpinner(
-        `Starting migration from ${fromVersion} to ${toVersion} for ${
-          user || account
-        }`,
-      );
+      message = `Requesting migration from ${fromVersion} to ${toVersion} for ${user || account}`;
     } else {
-      this.startSpinner(
-        `Starting migration from ${fromVersion} to ${toVersion} for ${percent}%`,
-      );
+      message = `Requesting migration from ${fromVersion} to ${toVersion} for ${percent}%`;
     }
+
+    this.startSpinner(message);
+
     if (percent) {
       body.job.percent_human = percent;
     }
@@ -137,12 +136,14 @@ class MigrateCommand extends BaseCommand {
 
     try {
       await callAPI(url, { method: 'POST', body });
-    } finally {
-      this.stopSpinner();
+    } catch (err) {
+      this.stopSpinner({ success: false });
+      throw err;
     }
+    this.stopSpinner();
 
     this.log(
-      '\nMigration successfully queued, please check `zapier jobs` to track the status. Migrations usually take between 5-10 minutes.',
+      `\nMigration successfully queued, check ${colors.bold.underline('zapier jobs')} to track the status. Migrations usually take between 5-10 minutes.`,
     );
   }
 }

package/src/oclif/commands/pull.js

@@ -53,9 +53,9 @@ class PullCommand extends ZapierBaseCommand {
 }
 
 PullCommand.flags = buildFlags();
-PullCommand.description = `Retrieve and update your local integration files with the latest version.
+PullCommand.description = `Retrieve and update your local integration files with the promoted version (or latest version if not public).
 
-This command updates your local integration files with the latest version. You will be prompted with a confirmation dialog before continuing if there any destructive file changes.
+This command updates your local integration files with the promoted version (or latest version if not public). You will be prompted with a confirmation dialog before continuing if there any destructive file changes.
 
 Zapier may release new versions of your integration with bug fixes or new features. In the event this occurs, you will be unable to do the following until your local files are updated by running \`zapier pull\`:
 

package/src/oclif/commands/scaffold.js

@@ -1,4 +1,3 @@
-/* eslint-disable camelcase */
 // @ts-check
 
 const path = require('path');

package/src/oclif/commands/validate.js

@@ -6,9 +6,14 @@ const { buildFlags } = require('../buildFlags');
 const { flattenCheckResult } = require('../../utils/display');
 const { localAppCommand } = require('../../utils/local');
 const { validateApp } = require('../../utils/api');
+const { maybeRunBuildScript } = require('../../utils/build');
 
 class ValidateCommand extends BaseCommand {
   async perform() {
+    if (!this.flags['skip-build']) {
+      await maybeRunBuildScript({ printProgress: true });
+    }
+
     this.log('Validating project locally');
 
     const errors = await localAppCommand({ command: 'validate' });
@@ -121,6 +126,9 @@ ValidateCommand.flags = buildFlags({
     'without-style': Flags.boolean({
       description: 'Forgo pinging the Zapier server to run further checks.',
     }),
+    'skip-build': Flags.boolean({
+      description: 'Skip running the _zapier-build script before validation.',
+    }),
   },
   opts: {
     format: true,
@@ -130,6 +138,7 @@ ValidateCommand.flags = buildFlags({
 ValidateCommand.examples = [
   'zapier validate',
   'zapier validate --without-style',
+  'zapier validate --skip-build',
   'zapier validate --format json',
 ];
 ValidateCommand.description = `Validate your integration.

package/src/utils/analytics.js

@@ -51,7 +51,7 @@ const recordAnalytics = async (command, isValidCommand, args, flags) => {
     numArgs: argKeys.length,
     appId: linkedAppId,
     argsKeys: argKeys,
-    flagKeys: flagKeys,
+    flagKeys,
     cliVersion: pkg.version,
     os: shouldRecordAnonymously ? undefined : process.platform,
   };

package/src/utils/ast.js

@@ -115,17 +115,23 @@ const registerActionInJsApp = (codeStr, property, varName) => {
 
   // check if this object already has the property at the top level
   const existingProp = objToModify.properties.find(
-    (props) => props.key.name === property,
+    (props) => props.key && props.key.name === property,
   );
   if (existingProp) {
-    // `triggers: myTriggers` means we shouldn't bother
     const value = existingProp.value;
-    if (value.type !== 'ObjectExpression') {
+    if (value.type === 'Identifier') {
+      // Handle shorthand syntax like `creates` instead of `creates: { ... }`
+      // Transform it into an object with spread operator: `creates: { ...creates, [newAction.key]: newAction }`
+      const spreadProperty = j.spreadElement(j.identifier(value.name));
+      existingProp.value = j.objectExpression([spreadProperty, newProperty]);
+      existingProp.shorthand = false; // Disable shorthand since we're changing the value
+    } else if (value.type === 'ObjectExpression') {
+      value.properties.push(newProperty);
+    } else {
       throw new Error(
         `Tried to edit the ${property} key, but the value wasn't an object`,
       );
     }
-    value.properties.push(newProperty);
   } else {
     objToModify.properties.push(
       j.property(
@@ -209,16 +215,23 @@ const registerActionInTsApp = (codeStr, actionTypePlural, identifierName) => {
 
   // Check if this object already has the actionType group inside it.
   const existingProp = appObj.properties.find(
-    (props) => props.key.name === actionTypePlural,
+    (props) => props.key && props.key.name === actionTypePlural,
   );
   if (existingProp) {
     const value = existingProp.value;
-    if (value.type !== 'ObjectExpression') {
+    if (value.type === 'Identifier') {
+      // Handle shorthand syntax like `creates` instead of `creates: { ... }`
+      // Transform it into an object with spread operator: `creates: { ...creates, [newAction.key]: newAction }`
+      const spreadProperty = j.spreadElement(j.identifier(value.name));
+      existingProp.value = j.objectExpression([spreadProperty, newProperty]);
+      existingProp.shorthand = false; // Disable shorthand since we're changing the value
+    } else if (value.type === 'ObjectExpression') {
+      value.properties.push(newProperty);
+    } else {
       throw new Error(
         `Tried to edit the ${actionTypePlural} key, but the value wasn't an object`,
       );
     }
-    value.properties.push(newProperty);
   } else {
     appObj.properties.push(
       j.property(

package/src/utils/scaffold.js

@@ -126,6 +126,16 @@ const writeTemplateFile = async ({
 const getRelativeRequirePath = (entryFilePath, newFilePath) =>
   path.relative(path.dirname(entryFilePath), newFilePath);
 
+/**
+ * Detect if a JavaScript file uses ES Module syntax (export default) vs CommonJS (module.exports)
+ * @param {string} codeStr - The JavaScript code to check
+ * @returns {boolean} - True if the file uses ESM syntax
+ */
+const isEsmJavaScript = (codeStr) => {
+  // Look for export default statement
+  return /^\s*export\s+default\s/m.test(codeStr);
+};
+
 const isValidEntryFileUpdate = (
   language,
   indexFileResolved,
@@ -193,16 +203,32 @@ const updateEntryFileJs = async ({
   let codeStr = (await readFile(indexFileResolved)).toString();
   const originalCodeStr = codeStr; // untouched copy in case we need to bail
 
-  codeStr = importActionInJsApp(
-    codeStr,
-    actionImportName,
-    actionRelativeImportPath,
-  );
-  codeStr = registerActionInJsApp(
-    codeStr,
-    plural(actionType),
-    actionImportName,
-  );
+  // Check if this JavaScript file uses ESM syntax (export default)
+  // If so, use the TypeScript functions which handle ESM correctly
+  if (isEsmJavaScript(codeStr)) {
+    codeStr = importActionInTsApp(
+      codeStr,
+      actionImportName,
+      actionRelativeImportPath,
+    );
+    codeStr = registerActionInTsApp(
+      codeStr,
+      plural(actionType),
+      actionImportName,
+    );
+  } else {
+    // Use traditional CommonJS functions for module.exports
+    codeStr = importActionInJsApp(
+      codeStr,
+      actionImportName,
+      actionRelativeImportPath,
+    );
+    codeStr = registerActionInJsApp(
+      codeStr,
+      plural(actionType),
+      actionImportName,
+    );
+  }
   await writeFile(indexFileResolved, codeStr);
   return originalCodeStr;
 };
@@ -283,11 +309,22 @@ const createScaffoldingContext = ({
   )}.test.${language}`;
   const testFileLocal = `${path.join(testDirLocal, key)}.${language}`;
   const testFileLocalStem = path.join(testDirLocal, key);
-  const actionRelativeImportPath = `./${getRelativeRequirePath(
+
+  // Generate the relative import path
+  let actionRelativeImportPath = `./${getRelativeRequirePath(
     indexFileResolved,
     actionFileResolvedStem,
   )}`;
 
+  // Normalize path separators to forward slashes for import statements
+  // (ES modules always use forward slashes, regardless of OS)
+  actionRelativeImportPath = actionRelativeImportPath.replace(/\\/g, '/');
+
+  // For TypeScript with ESM, imports must use .js extension
+  if (language === 'ts') {
+    actionRelativeImportPath += '.js';
+  }
+
   return {
     actionType,
     actionTypePlural: plural(actionType),
@@ -324,6 +361,7 @@ module.exports = {
   updateEntryFile,
   isValidEntryFileUpdate,
   writeTemplateFile,
+  isEsmJavaScript,
 };
 
 /**