zapier-platform-cli 17.7.1 → 17.8.0

package/oclif.manifest.json

@@ -1051,14 +1051,14 @@
       ],
       "flags": {
         "user": {
-          "description": "Migrates all of a users' Private Zaps within all accounts for which the specified user is a member",
+          "description": "Migrates a user's private Zaps under the user's individual account, excluding organization accounts",
           "name": "user",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "account": {
-          "description": "Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member",
+          "description": "Migrates a user's private and shared Zaps under the user's individual and organization accounts",
           "name": "account",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -1194,6 +1194,10 @@
       "aliases": [],
       "args": {},
       "description": "Build and upload the current integration.\n\nThis command is the same as running `zapier build` and `zapier upload` in sequence. See those for more info.",
+      "examples": [
+        "zapier push",
+        "zapier push --snapshot MY-LABEL"
+      ],
       "flags": {
         "disable-dependency-detection": {
           "description": "Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.",
@@ -1233,6 +1237,13 @@
           "name": "overwrite-partner-changes",
           "allowNo": false,
           "type": "boolean"
+        },
+        "snapshot": {
+          "description": "Pass in a label to create a snapshot version of this integration for development and testing purposes. The version will be created as: 0.0.0-MY-LABEL",
+          "name": "snapshot",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -1719,6 +1730,182 @@
         "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": {
@@ -1989,182 +2176,6 @@
         "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"
@@ -2544,5 +2555,5 @@
       ]
     }
   },
-  "version": "17.7.1"
+  "version": "17.8.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "17.7.1",
+  "version": "17.8.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -64,7 +64,6 @@
     "luxon": "3.6.1",
     "marked": "14.1.4",
     "marked-terminal": "7.2.1",
-    "node-fetch": "2.7.0",
     "open": "10.1.2",
     "ora": "5.4.0",
     "parse-gitignore": "0.5.1",

package/src/oclif/commands/delete/version.js

@@ -6,7 +6,6 @@ const { callAPI } = require('../../../utils/api');
 class DeleteVersionCommand extends BaseCommand {
   async perform() {
     const { version } = this.args;
-    this.throwForInvalidVersion(version);
 
     const { id, title } = await this.getWritableApp();
 

package/src/oclif/commands/migrate.js

@@ -152,11 +152,11 @@ MigrateCommand.flags = buildFlags({
   commandFlags: {
     user: Flags.string({
       description:
-        "Migrates all of a users' Private Zaps within all accounts for which the specified user is a member",
+        "Migrates a user's private Zaps under the user's individual account, excluding organization accounts",
     }),
     account: Flags.string({
       description:
-        "Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member",
+        "Migrates a user's private and shared Zaps under the user's individual and organization accounts",
     }),
     yes: Flags.boolean({
       char: 'y',

package/src/oclif/commands/push.js

@@ -6,10 +6,23 @@ 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');
+    }
+
+    const version = snapshotLabel
+      ? `0.0.0-${snapshotLabel}`
+      : definition.version;
+    this.throwForInvalidVersion(version);
+
     await buildAndOrUpload(
       { build: true, upload: true },
       {
@@ -18,6 +31,7 @@ class PushCommand extends ZapierBaseCommand {
         skipValidation: this.flags['skip-validation'],
         overwritePartnerChanges: this.flags['overwrite-partner-changes'],
       },
+      version,
     );
     this.log(
       `\nPush complete! Built ${BUILD_PATH} and ${SOURCE_PATH} and uploaded them to Zapier.`,
@@ -38,7 +52,12 @@ PushCommand.flags = {
       '(Internal Use Only) Allows Zapier Staff to push changes to integrations in certain situations.',
     hidden: true,
   }),
+  snapshot: Flags.string({
+    description:
+      'Pass in a label to create a snapshot version of this integration for development and testing purposes. The version will be created as: 0.0.0-MY-LABEL',
+  }),
 };
+PushCommand.examples = ['zapier push', 'zapier push --snapshot MY-LABEL'];
 PushCommand.description = `Build and upload the current integration.
 
 This command is the same as running \`zapier build\` and \`zapier upload\` in sequence. See those for more info.`;

package/src/oclif/commands/validate.js

@@ -62,10 +62,18 @@ class ValidateCommand extends BaseCommand {
       checkResult = await validateApp(rawDefinition);
     }
 
-    const doneMessage = checkResult.passes
-      ? `Running integration checks ... ${checkResult.passes.length} checks passed`
-      : undefined;
-    this.stopSpinner({ message: doneMessage });
+    const success = !checkResult.errors.total_failures;
+    const message = 'Integration checks complete';
+    this.stopSpinner({ success, message });
+
+    this.log(`    - ${checkResult.passes.length} checks passed`);
+    this.log(`    - ${checkResult.errors.total_failures} checks failed`);
+    this.log(
+      `    - ${checkResult.warnings.total_failures} checks with publishing warning`,
+    );
+    this.log(
+      `    - ${checkResult.suggestions.total_failures} checks with general warning`,
+    );
 
     const checkIssues = flattenCheckResult(checkResult);
 

package/src/utils/api.js

@@ -11,7 +11,6 @@ const qs = require('querystring');
 
 const fs = require('fs');
 const AdmZip = require('adm-zip');
-const fetch = require('node-fetch');
 const path = require('path');
 
 const { writeFile, readFile } = require('./files');
@@ -429,6 +428,7 @@ const downloadSourceZip = async (dst) => {
 const upload = async (
   app,
   { skipValidation = false, overwritePartnerChanges = false } = {},
+  versionOverride,
 ) => {
   const zipPath = constants.BUILD_PATH;
   const sourceZipPath = constants.SOURCE_PATH;
@@ -461,10 +461,11 @@ const upload = async (
     headers['X-Overwrite-Partner-Changes'] = 'true';
   }
 
-  startSpinner(`Uploading version ${definition.version}`);
+  const version = versionOverride ?? definition.version;
+  startSpinner(`Uploading version ${version}`);
   try {
     await callAPI(
-      `/apps/${app.id}/versions/${definition.version}`,
+      `/apps/${app.id}/versions/${version}`,
       {
         method: 'PUT',
         body: {

package/src/utils/build.js

@@ -761,6 +761,7 @@ const _buildFunc = async ({
 const buildAndOrUpload = async (
   { build = false, upload = false } = {},
   buildOpts,
+  versionOverride,
 ) => {
   if (!(build || upload)) {
     throw new Error('must either build or upload');
@@ -777,7 +778,7 @@ const buildAndOrUpload = async (
     await _buildFunc(buildOpts);
   }
   if (upload) {
-    await _uploadFunc(app, buildOpts);
+    await _uploadFunc(app, buildOpts, versionOverride);
   }
 };
 

package/src/utils/credentials.js

@@ -1,4 +1,3 @@
-const fetch = require('node-fetch');
 const { BASE_ENDPOINT } = require('../constants');
 
 const isSamlEmail = async (email) => {

package/src/utils/npm.js

@@ -1,5 +1,3 @@
-const fetch = require('node-fetch');
-
 const BASE_URL = 'https://registry.npmjs.org';
 
 const getPackageLatestVersion = async (name) => {

package/src/utils/example-apps.js

@@ -1,89 +0,0 @@
-const fetch = require('node-fetch');
-const path = require('path');
-const fse = require('fs-extra');
-const AdmZip = require('adm-zip');
-const debug = require('debug')('zapier:example-apps');
-
-const xdg = require('./xdg');
-const { copyDir } = require('./files');
-const { PACKAGE_VERSION } = require('../constants');
-
-const REPO_ZIP_URL = `https://codeload.github.com/zapier/zapier-platform/zip/zapier-platform-cli%40${PACKAGE_VERSION}`;
-const zipName = `zapier-platform-zapier-platform-cli-${PACKAGE_VERSION}`;
-const folderName = `zapier-platform-cached`; // version independant
-
-const checkCacheUpToDate = async (repoDir) => {
-  const etagPath = path.join(repoDir, 'etag');
-  let currentEtag;
-  try {
-    currentEtag = await fse.readFile(etagPath, { encoding: 'utf8' });
-  } catch (err) {
-    currentEtag = '';
-  }
-  const res = await fetch(REPO_ZIP_URL, { method: 'HEAD' });
-  const latestEtag = res.headers.get('etag');
-
-  return currentEtag === latestEtag;
-};
-
-const downloadRepo = async (destDir) => {
-  const destZipPath = path.join(destDir, `${zipName}.zip`);
-
-  const res = await fetch(REPO_ZIP_URL);
-  const dest = fse.createWriteStream(destZipPath);
-  res.body.pipe(dest);
-
-  await new Promise((resolve, reject) => {
-    dest.on('finish', () => {
-      resolve();
-    });
-    dest.on('error', reject);
-  });
-
-  const zip = new AdmZip(destZipPath);
-  zip.extractAllTo(destDir, true);
-
-  // Save etag for cache validation
-  // this could probably just be cli version, but this is fine too
-  const etagPath = path.join(destDir, zipName, 'etag');
-  fse.writeFileSync(etagPath, res.headers.get('etag'));
-
-  fse.removeSync(destZipPath);
-  fse.renameSync(path.join(destDir, zipName), path.join(destDir, folderName));
-
-  return destZipPath;
-};
-
-const ensureRepoCached = async () => {
-  const cacheDir = xdg.ensureCacheDir();
-  const repoDir = path.join(cacheDir, folderName);
-
-  if (fse.existsSync(repoDir)) {
-    debug('repo exists');
-    if (!(await checkCacheUpToDate(repoDir))) {
-      debug('cached repo is stale, re-downloading');
-      await fse.remove(repoDir);
-      await downloadRepo(cacheDir);
-    }
-  } else {
-    debug('no cached repo, downloading');
-    await downloadRepo(cacheDir);
-  }
-
-  return repoDir;
-};
-
-const downloadExampleAppTo = async (exampleName, destDir) => {
-  const repoDir = await ensureRepoCached();
-  const cachedExampleDir = path.join(repoDir, 'example-apps', exampleName);
-  await copyDir(cachedExampleDir, destDir);
-};
-
-const removeReadme = (dir) => {
-  return fse.remove(path.join(dir, 'README.md'));
-};
-
-module.exports = {
-  downloadExampleAppTo,
-  removeReadme,
-};

package/src/utils/xdg.js

@@ -1,59 +0,0 @@
-// XDG Base Directory Specification
-// See: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
-
-const fse = require('fs-extra');
-const os = require('os');
-const path = require('path');
-
-const ensureDir = (envVarName, defaultDir, extraPath = []) => {
-  const baseDir = process.env[envVarName] || defaultDir;
-  let appDir = path.join(baseDir, 'zapier');
-  fse.ensureDirSync(appDir, 0o700);
-
-  if (extraPath.length > 0) {
-    const dirParts = [appDir].concat(extraPath);
-    appDir = path.join.apply(null, dirParts);
-    fse.ensureDirSync(appDir);
-  }
-
-  return appDir;
-};
-
-const HOME_DIR = os.homedir();
-
-let ensureDataDir, ensureCacheDir, ensureConfigDir;
-
-if (process.platform === 'win32') {
-  const defaultAppDir = path.join(HOME_DIR, 'AppData', 'Local');
-
-  // NOTE: LOCALAPPDATA is not available on Windows XP
-  ensureDataDir = ensureDir.bind(null, 'LOCALAPPDATA', defaultAppDir, ['data']);
-  ensureCacheDir = ensureDir.bind(null, 'LOCALAPPDATA', defaultAppDir, [
-    'cache',
-  ]);
-  ensureConfigDir = ensureDir.bind(null, 'LOCALAPPDATA', defaultAppDir, [
-    'config',
-  ]);
-} else {
-  ensureDataDir = ensureDir.bind(
-    null,
-    'XDG_DATA_HOME',
-    path.join(HOME_DIR, '.local', 'share'),
-  );
-  ensureCacheDir = ensureDir.bind(
-    null,
-    'XDG_CACHE_HOME',
-    path.join(HOME_DIR, '.cache'),
-  );
-  ensureConfigDir = ensureDir.bind(
-    null,
-    'XDG_CONFIG_HOME',
-    path.join(HOME_DIR, '.config'),
-  );
-}
-
-module.exports = {
-  ensureDataDir,
-  ensureCacheDir,
-  ensureConfigDir,
-};