zapier-platform-cli 17.8.0 → 17.9.1

package/oclif.manifest.json

@@ -1730,182 +1730,6 @@
         "clear.js"
       ]
     },
-    "env:get": {
-      "aliases": [],
-      "args": {
-        "version": {
-          "description": "The version to get the environment for.",
-          "name": "version",
-          "required": true
-        }
-      },
-      "description": "Get environment variables for a version.",
-      "examples": [
-        "zapier env:get 1.2.3"
-      ],
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "format": {
-          "char": "f",
-          "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
-          "name": "format",
-          "default": "table",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "plain",
-            "json",
-            "raw",
-            "row",
-            "table"
-          ],
-          "type": "option"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "env:get",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "env",
-        "get.js"
-      ]
-    },
-    "env:set": {
-      "aliases": [],
-      "args": {
-        "version": {
-          "description": "The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.",
-          "name": "version",
-          "required": true
-        },
-        "key-value pairs...": {
-          "description": "The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`",
-          "name": "key-value pairs..."
-        }
-      },
-      "description": "Set environment variables for a version.",
-      "examples": [
-        "zapier env:set 1.2.3 SECRET=12345 OTHER=4321"
-      ],
-      "flags": {
-        "force": {
-          "char": "f",
-          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "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": "env:set",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": false,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "env",
-        "set.js"
-      ]
-    },
-    "env:unset": {
-      "aliases": [],
-      "args": {
-        "version": {
-          "description": "The version to set the environment for.",
-          "name": "version",
-          "required": true
-        },
-        "keys...": {
-          "description": "The keys to unset. Keys are case-insensitive.",
-          "name": "keys..."
-        }
-      },
-      "description": "Unset environment variables for a version.",
-      "examples": [
-        "zapier env:unset 1.2.3 SECRET OTHER"
-      ],
-      "flags": {
-        "force": {
-          "char": "f",
-          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "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": "env:unset",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": false,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "env",
-        "unset.js"
-      ]
-    },
     "canary:create": {
       "aliases": [],
       "args": {
@@ -2176,6 +2000,182 @@
         "version.js"
       ]
     },
+    "env:get": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "description": "The version to get the environment for.",
+          "name": "version",
+          "required": true
+        }
+      },
+      "description": "Get environment variables for a version.",
+      "examples": [
+        "zapier env:get 1.2.3"
+      ],
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "format": {
+          "char": "f",
+          "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "plain",
+            "json",
+            "raw",
+            "row",
+            "table"
+          ],
+          "type": "option"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "env:get",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "env",
+        "get.js"
+      ]
+    },
+    "env:set": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "description": "The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.",
+          "name": "version",
+          "required": true
+        },
+        "key-value pairs...": {
+          "description": "The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`",
+          "name": "key-value pairs..."
+        }
+      },
+      "description": "Set environment variables for a version.",
+      "examples": [
+        "zapier env:set 1.2.3 SECRET=12345 OTHER=4321"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "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": "env:set",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": false,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "env",
+        "set.js"
+      ]
+    },
+    "env:unset": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "description": "The version to set the environment for.",
+          "name": "version",
+          "required": true
+        },
+        "keys...": {
+          "description": "The keys to unset. Keys are case-insensitive.",
+          "name": "keys..."
+        }
+      },
+      "description": "Unset environment variables for a version.",
+      "examples": [
+        "zapier env:unset 1.2.3 SECRET OTHER"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "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": "env:unset",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": false,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "env",
+        "unset.js"
+      ]
+    },
     "team:add": {
       "aliases": [
         "team:invite"
@@ -2555,5 +2555,5 @@
       ]
     }
   },
-  "version": "17.8.0"
+  "version": "17.9.1"
 }

package/package.json

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

package/src/oclif/ZapierBaseCommand.js

@@ -8,6 +8,7 @@ const { recordAnalytics } = require('../utils/analytics');
 const { getWritableApp } = require('../utils/api');
 
 const inquirer = require('inquirer');
+const { throwForInvalidVersion } = require('../utils/version');
 
 const DATA_FORMATS = ['json', 'raw'];
 
@@ -90,16 +91,7 @@ class ZapierBaseCommand extends Command {
 
   // validate that user input looks like a semver version
   throwForInvalidVersion(version) {
-    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\` or \`0.0.0-TICKET\``,
-      );
-    }
+    return throwForInvalidVersion(version);
   }
 
   async getWritableApp() {

package/src/oclif/commands/env/set.js

@@ -73,12 +73,12 @@ class SetEnvCommand extends BaseCommand {
       const failedKeys = e.json.errors[0].split('update: ')[1].split(', ');
       const successfulResult = omit(payload, failedKeys);
       if (!Object.keys(successfulResult).length) {
-        this.error(e.json.errors[0]);
+        this.error(e.json.errors.join('\nError: '));
       }
 
       this.warn(successMessage(version));
       this.logJSON(successfulResult);
-      this.warn(`However, these keys failed to update: ${failedKeys}`);
+      this.warn(e.json.errors.join('\nWarning: '));
     }
   }
 }

package/src/oclif/commands/push.js

@@ -6,22 +6,18 @@ const colors = require('colors/safe');
 const BuildCommand = require('./build');
 
 const { buildAndOrUpload } = require('../../utils/build');
-const { localAppCommand } = require('../../utils/local');
-
 class PushCommand extends ZapierBaseCommand {
   async perform() {
     const skipNpmInstall = this.flags['skip-npm-install'];
-    const definition = await localAppCommand({ command: 'definition' });
 
     const snapshotLabel = this.flags.snapshot;
-    if (snapshotLabel && snapshotLabel.length > 18) {
-      throw new Error('Snapshot label cannot exceed 18 characters');
+    if (snapshotLabel && snapshotLabel.length > 12) {
+      throw new Error('Snapshot label cannot exceed 12 characters');
     }
 
-    const version = snapshotLabel
+    const snapshotVersion = snapshotLabel
       ? `0.0.0-${snapshotLabel}`
-      : definition.version;
-    this.throwForInvalidVersion(version);
+      : undefined;
 
     await buildAndOrUpload(
       { build: true, upload: true },
@@ -31,7 +27,7 @@ class PushCommand extends ZapierBaseCommand {
         skipValidation: this.flags['skip-validation'],
         overwritePartnerChanges: this.flags['overwrite-partner-changes'],
       },
-      version,
+      snapshotVersion,
     );
     this.log(
       `\nPush complete! Built ${BUILD_PATH} and ${SOURCE_PATH} and uploaded them to Zapier.`,

package/src/utils/api.js

@@ -428,7 +428,7 @@ const downloadSourceZip = async (dst) => {
 const upload = async (
   app,
   { skipValidation = false, overwritePartnerChanges = false } = {},
-  versionOverride,
+  snapshotVersion,
 ) => {
   const zipPath = constants.BUILD_PATH;
   const sourceZipPath = constants.SOURCE_PATH;
@@ -461,7 +461,7 @@ const upload = async (
     headers['X-Overwrite-Partner-Changes'] = 'true';
   }
 
-  const version = versionOverride ?? definition.version;
+  const version = snapshotVersion ?? definition.version;
   startSpinner(`Uploading version ${version}`);
   try {
     await callAPI(

package/src/utils/build.js

@@ -45,6 +45,7 @@ const checkMissingAppInfo = require('./check-missing-app-info');
 const { findCorePackageDir, isWindows, runCommand } = require('./misc');
 const { isBlocklisted, respectGitIgnore } = require('./ignore');
 const { localAppCommand } = require('./local');
+const { throwForInvalidVersion } = require('./version');
 
 const debug = require('debug')('zapier:build');
 
@@ -588,13 +589,16 @@ const testBuildZip = async (zipPath) => {
   }
 };
 
-const _buildFunc = async ({
-  skipNpmInstall = false,
-  disableDependencyDetection = false,
-  skipValidation = false,
-  printProgress = true,
-  checkOutdated = true,
-} = {}) => {
+const _buildFunc = async (
+  {
+    skipNpmInstall = false,
+    disableDependencyDetection = false,
+    skipValidation = false,
+    printProgress = true,
+    checkOutdated = true,
+  } = {},
+  snapshotVersion,
+) => {
   const maybeStartSpinner = printProgress ? startSpinner : () => {};
   const maybeEndSpinner = printProgress ? endSpinner : () => {};
 
@@ -659,6 +663,9 @@ const _buildFunc = async ({
     false,
   );
 
+  const version = snapshotVersion ?? rawDefinition.version;
+  throwForInvalidVersion(version);
+
   try {
     fs.writeFileSync(
       path.join(workingDir, 'definition.json'),
@@ -761,7 +768,7 @@ const _buildFunc = async ({
 const buildAndOrUpload = async (
   { build = false, upload = false } = {},
   buildOpts,
-  versionOverride,
+  snapshotVersion,
 ) => {
   if (!(build || upload)) {
     throw new Error('must either build or upload');
@@ -775,10 +782,10 @@ const buildAndOrUpload = async (
   }
 
   if (build) {
-    await _buildFunc(buildOpts);
+    await _buildFunc(buildOpts, snapshotVersion);
   }
   if (upload) {
-    await _uploadFunc(app, buildOpts, versionOverride);
+    await _uploadFunc(app, buildOpts, snapshotVersion);
   }
 };
 

package/src/utils/local.js

@@ -282,13 +282,21 @@ const getLocalAppHandler = async ({
     appRaw = loadAppRawUsingRequire(appDir);
   } catch (err) {
     if (err.code === 'MODULE_NOT_FOUND' || err.code === 'ERR_REQUIRE_ESM') {
-      appRaw = await loadAppRawUsingImport(
-        appDir,
-        corePackageDir,
-        shouldDeleteWrapper,
-      );
+      try {
+        appRaw = await loadAppRawUsingImport(
+          appDir,
+          corePackageDir,
+          shouldDeleteWrapper,
+        );
+      } catch (err) {
+        err.message =
+          'Your ESM integration requires a compiled `dist/` directory. Run `zapier build` to compile your code first.\n\n' +
+          err.message;
+        throw err;
+      }
     } else {
       // err.name === 'SyntaxError' or others
+
       throw err;
     }
   }

package/src/utils/version.js

@@ -0,0 +1,16 @@
+const throwForInvalidVersion = (version) => {
+  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\` or \`0.0.0-TICKET\``,
+    );
+  }
+};
+
+module.exports = {
+  throwForInvalidVersion,
+};