zapier-platform-cli 15.18.1 → 16.0.0

package/src/oclif/ZapierBaseCommand.js

@@ -1,6 +1,4 @@
-const { Command } = require('@oclif/command');
-const { stdtermwidth } = require('@oclif/help/lib/screen');
-const { renderList } = require('@oclif/help/lib/list');
+const { Command } = require('@oclif/core');
 const colors = require('colors/safe');
 
 const { startSpinner, endSpinner, formatStyles } = require('../utils/display');
@@ -14,9 +12,9 @@ const inquirer = require('inquirer');
 const DATA_FORMATS = ['json', 'raw'];
 
 class ZapierBaseCommand extends Command {
-  run() {
+  async run() {
     this._initPromptModules();
-    this._parseFlags();
+    await this._parseCommand();
 
     if (this.flags.debug) {
       this.debug.enabled = true; // enables this.debug on the command
@@ -47,7 +45,7 @@ class ZapierBaseCommand extends Command {
 
         if (!this.flags.debug && !this.flags.invokedFromAnotherCommand) {
           errTextLines.push(
-            colors.gray('re-run this command with `--debug` for more info')
+            colors.gray('re-run this command with `--debug` for more info'),
           );
         }
 
@@ -67,11 +65,12 @@ class ZapierBaseCommand extends Command {
     });
   }
 
-  _parseFlags() {
-    const { flags, args } = this.parse(this._staticClassReference);
+  async _parseCommand() {
+    const { flags, args, argv } = await this.parse(this._staticClassReference);
 
     this.flags = flags;
     this.args = args;
+    this.argv = argv;
   }
 
   perform() {
@@ -93,7 +92,7 @@ class ZapierBaseCommand extends Command {
   throwForInvalidVersion(version) {
     if (!version.match(/^\d+\.\d+\.\d+$/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\``,
       );
     }
   }
@@ -137,6 +136,9 @@ class ZapierBaseCommand extends Command {
     headers = [],
     emptyMessage = '',
     formatOverride = '',
+    hasBorder = true,
+    showHeaders = true,
+    style = undefined,
   } = {}) {
     const formatter = formatOverride
       ? formatStyles[formatOverride]
@@ -149,18 +151,10 @@ class ZapierBaseCommand extends Command {
       this.log(colors.gray(emptyMessage));
     } else {
       // data comes out of the formatter ready to be printed (and it's always in the type to match the format) so we don't need to do anything special with it
-      console.log(formatter(rows, headers));
+      console.log(formatter(rows, headers, showHeaders, hasBorder, style));
     }
   }
 
-  /**
-   * Print text in a list style.
-   * @param {string[][]} items
-   */
-  logList(items) {
-    this.log(renderList(items, { spacer: '\n', maxWidth: stdtermwidth }));
-  }
-
   /**
    *
    * @param {Object} opts options object (as expected for this.prompt())
@@ -270,44 +264,53 @@ class ZapierBaseCommand extends Command {
       return arg.required ? argName : `[${argName}]`;
     };
 
-    return [
-      'zapier',
-      name,
-      ...(this.args || []).filter((a) => !a.hidden).map((a) => formatArg(a)),
-    ].join(' ');
+    const argv = Object.entries(this.args ?? {}).map(([argName, argValue]) => ({
+      name: argName,
+      ...argValue,
+    }));
+    const visibleArgv = argv.filter((arg) => !arg.hidden);
+
+    return ['zapier', name, ...visibleArgv.map(formatArg)].join(' ');
   }
 
   // this is fine for now but we'll want to hack into https://github.com/oclif/plugin-help/blob/master/src/command.ts at some point
   // the presentation is wrapped into the formatting, so it's a little tough to pull out
   static markdownHelp(name) {
-    const formattedArgs = () =>
-      this.args.map((arg) =>
-        arg.hidden
+    const getFormattedArgs = () =>
+      Object.keys(this.args ?? {}).map((argName) => {
+        const arg = this.args[argName];
+        return arg.hidden
           ? null
-          : `* ${arg.required ? '(required) ' : ''}\`${arg.name}\` | ${
+          : `* ${arg.required ? '(required) ' : ''}\`${argName}\` | ${
               arg.description
-            }`
-      );
-    const formattedFlags = () =>
+            }`;
+      });
+    const getFormattedFlags = () =>
       Object.entries(this.flags)
-        .map(([longName, flag]) =>
-          flag.hidden
+        .map(([flagName, flagValue]) =>
+          flagValue.hidden
             ? null
-            : `* ${flag.required ? '(required) ' : ''}\`${
-                flag.char ? `-${flag.char}, ` : ''
-              }--${longName}\` |${
-                flag.description ? ` ${flag.description}` : ''
+            : `* ${flagValue.required ? '(required) ' : ''}\`${
+                flagValue.char ? `-${flagValue.char}, ` : ''
+              }--${flagName}\` |${
+                flagValue.description ? ` ${flagValue.description}` : ''
               } ${
-                flag.options ? `One of \`[${flag.options.join(' | ')}]\`.` : ''
-              }${flag.default ? ` Defaults to \`${flag.default}\`.` : ''}
-      `.trim()
+                flagValue.options
+                  ? `One of \`[${flagValue.options.join(' | ')}]\`.`
+                  : ''
+              }${
+                flagValue.default
+                  ? ` Defaults to \`${flagValue.default}\`.`
+                  : ''
+              }
+      `.trim(),
         )
         .filter(Boolean);
 
     const descriptionParts = this.description.split('\n\n').filter(Boolean);
     const blurb = descriptionParts[0];
     const lengthyDescription = colors.stripColors(
-      descriptionParts.length > 1 ? descriptionParts.slice(1).join('\n\n') : ''
+      descriptionParts.length > 1 ? descriptionParts.slice(1).join('\n\n') : '',
     );
 
     return [
@@ -317,16 +320,20 @@ class ZapierBaseCommand extends Command {
       '',
       `**Usage**: \`${this.zUsage(name)}\``,
       ...(lengthyDescription ? ['', lengthyDescription] : []),
-      ...(this.args ? ['', '**Arguments**', ...formattedArgs()] : []),
-      ...(this.flags ? ['', '**Flags**', ...formattedFlags()] : []),
-      ...(this.examples
+      ...(Object.keys(this.args ?? {}).length
+        ? ['', '**Arguments**', ...getFormattedArgs()]
+        : []),
+      ...(Object.keys(this.flags ?? {}).length
+        ? ['', '**Flags**', ...getFormattedFlags()]
+        : []),
+      ...((this.examples ?? []).length
         ? [
             '',
             '**Examples**',
             this.examples.map((e) => `* \`${e}\``).join('\n'),
           ]
         : []),
-      ...(this.aliases.length
+      ...((this.aliases ?? []).length
         ? ['', '**Aliases**', this.aliases.map((e) => `* \`${e}\``).join('\n')]
         : []),
     ]

package/src/oclif/buildFlags.js

@@ -1,25 +1,24 @@
-const { flags } = require('@oclif/command');
+const { Flags } = require('@oclif/core');
 const { pickBy } = require('lodash');
 
 const { formatStyles } = require('../utils/display');
 
 const baseFlags = {
-  format: flags.string({
+  debug: Flags.boolean({
+    char: 'd',
+    description: 'Show extra debugging output.',
+    // pull from env?
+  }),
+  format: Flags.string({
     char: 'f',
     options: Object.keys(formatStyles),
     default: 'table',
     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.',
   }),
-  debug: flags.boolean({
-    char: 'd',
-    description: 'Show extra debugging output.',
-    // pull from env?
-  }),
-
   // Indicates we're calling a command from another command so we know when not
   // to print duplicate messages.
-  invokedFromAnotherCommand: flags.boolean({
+  invokedFromAnotherCommand: Flags.boolean({
     hidden: true,
   }),
 };
@@ -32,14 +31,13 @@ const defaultOpts = {
 };
 
 /**
- * pass in flag objects, plus whether or not to include debug and format
+ * pass in flag objects, plus whether or not to include debug, format, and
+ * invokedFormatAnotherCommand.
  */
 const buildFlags = ({ commandFlags = {}, opts = {} } = {}) => {
-  const selectedBaseFlags = Object.assign({}, defaultOpts, opts);
-  return Object.assign(
-    {},
-    commandFlags,
-    pickBy(baseFlags, (v, k) => selectedBaseFlags[k])
-  );
+  const options = { ...defaultOpts, ...opts };
+  const pickedFlags = pickBy(baseFlags, (_v, k) => options[k]);
+  return { ...commandFlags, ...pickedFlags };
 };
+
 module.exports = { buildFlags };

package/src/oclif/commands/analytics.js

@@ -1,5 +1,5 @@
 const BaseCommand = require('../ZapierBaseCommand');
-const { flags } = require('@oclif/command');
+const { Flags } = require('@oclif/core');
 const { buildFlags } = require('../buildFlags');
 const {
   currentAnalyticsMode,
@@ -13,8 +13,8 @@ class AnalyticsCommand extends BaseCommand {
     const currentMode = await currentAnalyticsMode();
     this.log(
       `The current analytics mode is ${colors.cyan(
-        currentMode
-      )}. Analytics may be skipped anyway if you've got DISABLE_ZAPIER_ANALYTICS set to a truthy value.`
+        currentMode,
+      )}. Analytics may be skipped anyway if you've got DISABLE_ZAPIER_ANALYTICS set to a truthy value.`,
     );
 
     if (this.flags.mode) {
@@ -23,8 +23,8 @@ class AnalyticsCommand extends BaseCommand {
     } else {
       this.log(
         `You can see what data is sent by running \`${colors.yellow(
-          'DEBUG=zapier:analytics zapier someCommand'
-        )}\`.\n\nYou can change your analytics preferences by re-running this command with the \`--mode\` flag.\n\nThe data collected is as generic as we can make it while still getting useful input. No specific information about your filesystem is collected. Your Zapier user id is collected so that we can better debug issues. We will never use this data for any advertising puposes.`
+          'DEBUG=zapier:analytics zapier someCommand',
+        )}\`.\n\nYou can change your analytics preferences by re-running this command with the \`--mode\` flag.\n\nThe data collected is as generic as we can make it while still getting useful input. No specific information about your filesystem is collected. Your Zapier user id is collected so that we can better debug issues. We will never use this data for any advertising puposes.`,
       );
     }
   }
@@ -32,7 +32,7 @@ class AnalyticsCommand extends BaseCommand {
 
 AnalyticsCommand.flags = buildFlags({
   commandFlags: {
-    mode: flags.string({
+    mode: Flags.string({
       char: 'm',
       options: Object.keys(modes),
       description:

package/src/oclif/commands/build.js

@@ -1,6 +1,6 @@
 const BaseCommand = require('../ZapierBaseCommand');
+const { Flags } = require('@oclif/core');
 const { buildFlags } = require('../buildFlags');
-const { flags } = require('@oclif/command');
 const {
   BUILD_PATH,
   SOURCE_PATH,
@@ -17,26 +17,26 @@ class BuildCommand extends BaseCommand {
         skipNpmInstall: this.flags['skip-npm-install'],
         disableDependencyDetection: this.flags['disable-dependency-detection'],
         skipValidation: this.flags['skip-validation'],
-      }
+      },
     );
 
     this.log(
-      `\nBuild complete! Created ${BUILD_PATH} and ${SOURCE_PATH}. Try the \`zapier upload\` command now.`
+      `\nBuild complete! Created ${BUILD_PATH} and ${SOURCE_PATH}. Try the \`zapier upload\` command now.`,
     );
   }
 }
 
 BuildCommand.flags = buildFlags({
   commandFlags: {
-    'disable-dependency-detection': flags.boolean({
+    'disable-dependency-detection': Flags.boolean({
       description: `Disable "smart" file inclusion. By default, Zapier only includes files that are required by \`index.js\`. 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 \`${CURRENT_APP_FILE}\`. See the docs about \`includeInBuild\` for more info.`,
     }),
-    'skip-npm-install': flags.boolean({
+    'skip-npm-install': Flags.boolean({
       description:
         'Skips installing a fresh copy of npm dependencies on build. Helpful for using `yarn` or local copies of dependencies.',
       hidden: true,
     }),
-    'skip-validation': flags.boolean({
+    'skip-validation': Flags.boolean({
       description:
         "Skips local pre-push validation checks, and remote validation check of the CLI app's schema and AppVersion integrity.",
       hidden: true,

package/src/oclif/commands/cache/clear.js

@@ -1,4 +1,5 @@
 const BaseCommand = require('../../ZapierBaseCommand');
+const { Args } = require('@oclif/core');
 const { buildFlags } = require('../../buildFlags');
 const { listVersions, getWritableApp, callAPI } = require('../../../utils/api');
 const { cyan } = require('colors/safe');
@@ -14,13 +15,13 @@ class ClearCacheCommand extends BaseCommand {
     let selectedMajorVersion = majorVersion ? Number(majorVersion) : null;
     if (Number.isNaN(selectedMajorVersion)) {
       throw new Error(
-        `Invalid major version '${majorVersion}'. Must be a number.`
+        `Invalid major version '${majorVersion}'. Must be a number.`,
       );
     }
 
     const majorVersions = [
       ...new Set(
-        versions.map((appVersion) => Number(appVersion.version.split('.')[0]))
+        versions.map((appVersion) => Number(appVersion.version.split('.')[0])),
       ),
     ];
     // Finds the current version in package.json.
@@ -30,14 +31,14 @@ class ClearCacheCommand extends BaseCommand {
     if (selectedMajorVersion === null) {
       selectedMajorVersion = await this._promptForMajorVersionSelection(
         majorVersions,
-        currentVersion
+        currentVersion,
       );
     } else {
       if (!majorVersions.includes(selectedMajorVersion)) {
         throw new Error(
           `This integration does not have any versions on major version '${selectedMajorVersion}'. Valid versions are: ${majorVersions.join(
-            ', '
-          )}`
+            ', ',
+          )}`,
         );
       }
     }
@@ -45,9 +46,9 @@ class ClearCacheCommand extends BaseCommand {
     if (
       !(await this.confirm(
         `Are you sure you want to clear all cache data for major version '${cyan(
-          selectedMajorVersion
+          selectedMajorVersion,
         )}'?`,
-        true
+        true,
       ))
     ) {
       this.log('\ncancelled');
@@ -86,19 +87,18 @@ class ClearCacheCommand extends BaseCommand {
     return await this.promptWithList(
       "Which major version's cache data would you like to delete?",
       majorVersionChoices,
-      { default: currentMajorVersion }
+      { default: currentMajorVersion },
     );
   }
 }
 
-ClearCacheCommand.args = [
-  {
-    name: 'majorVersion',
+ClearCacheCommand.args = {
+  majorVersion: Args.string({
     description:
       '(Optional) The cache data will be deleted for this major version. If not provided, you must pick from a list of major versions for this integration.',
     required: false,
-  },
-];
+  }),
+};
 ClearCacheCommand.flags = buildFlags();
 ClearCacheCommand.description = `Clear the cache data for a major version. 
 

package/src/oclif/commands/canary/create.js

@@ -1,7 +1,7 @@
 const ZapierBaseCommand = require('../../ZapierBaseCommand');
+const { Args, Flags } = require('@oclif/core');
 const { createCanary, listCanaries } = require('../../../utils/api');
 const { buildFlags } = require('../../buildFlags');
-const { flags } = require('@oclif/command');
 
 class CanaryCreateCommand extends ZapierBaseCommand {
   async perform() {
@@ -16,8 +16,10 @@ class CanaryCreateCommand extends ZapierBaseCommand {
     const activeCanaries = await listCanaries();
     if (activeCanaries.objects.length > 0) {
       const existingCanary = activeCanaries.objects[0];
-      const secondsRemaining = existingCanary.until_timestamp - Math.floor(Date.now() / 1000);
-      this.log(`A canary deployment already exists from version ${existingCanary.from_version} to version ${existingCanary.to_version}, there are ${secondsRemaining} seconds remaining.
+      const secondsRemaining =
+        existingCanary.until_timestamp - Math.floor(Date.now() / 1000);
+      this
+        .log(`A canary deployment already exists from version ${existingCanary.from_version} to version ${existingCanary.to_version}, there are ${secondsRemaining} seconds remaining.
         
 If you would like to stop this canary now, run \`zapier canary:delete ${existingCanary.from_version} ${existingCanary.to_version}\``);
       return;
@@ -27,8 +29,7 @@ If you would like to stop this canary now, run \`zapier canary:delete ${existing
     - From version: ${versionFrom}
     - To version: ${versionTo}
     - Traffic amount: ${percent}%
-    - Duration: ${duration} seconds`
-    );
+    - Duration: ${duration} seconds`);
 
     await createCanary(versionFrom, versionTo, percent, duration);
 
@@ -41,7 +42,7 @@ If you would like to stop this canary now, run \`zapier canary:delete ${existing
     this.throwForInvalidVersion(versionTo);
 
     if (versionFrom === versionTo) {
-      this.error('`VERSIONFROM` and `VERSIONTO` can not be the same')
+      this.error('`VERSIONFROM` and `VERSIONTO` can not be the same');
     }
   }
 
@@ -60,23 +61,29 @@ If you would like to stop this canary now, run \`zapier canary:delete ${existing
 
 CanaryCreateCommand.flags = buildFlags({
   commandFlags: {
-    percent: flags.integer({char: 'p', description: 'Percent of traffic to route to new version', required: true}),
-    duration: flags.integer({char: 'd', description: 'Duration of the canary in seconds', required: true}),
-  }
-})
+    percent: Flags.integer({
+      char: 'p',
+      description: 'Percent of traffic to route to new version',
+      required: true,
+    }),
+    duration: Flags.integer({
+      char: 'd',
+      description: 'Duration of the canary in seconds',
+      required: true,
+    }),
+  },
+});
 
-CanaryCreateCommand.args = [
-  {
-    name: 'versionFrom',
-    required: true,
+CanaryCreateCommand.args = {
+  versionFrom: Args.string({
     description: 'Version to route traffic from',
-  },
-  {
-    name: 'versionTo',
     required: true,
+  }),
+  versionTo: Args.string({
     description: 'Version to canary traffic to',
-  },
-];
+    required: true,
+  }),
+};
 
 CanaryCreateCommand.description = `Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.
 
@@ -88,7 +95,7 @@ Note: this is similar to \`zapier migrate\` but different in that this is tempor
 
 CanaryCreateCommand.examples = [
   'zapier canary:create 1.0.0 1.1.0 -p 25 -d 720',
-  'zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300'
+  'zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300',
 ];
 CanaryCreateCommand.skipValidInstallCheck = true;
 

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

@@ -1,4 +1,5 @@
 const ZapierBaseCommand = require('../../ZapierBaseCommand');
+const { Args } = require('@oclif/core');
 const { deleteCanary, listCanaries } = require('../../../utils/api');
 
 class CanaryDeleteCommand extends ZapierBaseCommand {
@@ -7,19 +8,28 @@ class CanaryDeleteCommand extends ZapierBaseCommand {
 
     this.validateVersions(versionFrom, versionTo);
 
-    const existingCanary = await this.findExistingCanary(versionFrom, versionTo);
+    const existingCanary = await this.findExistingCanary(
+      versionFrom,
+      versionTo,
+    );
     if (!existingCanary) {
-      this.log(`There is no active canary from version ${versionFrom} to version ${versionTo}`);
+      this.log(
+        `There is no active canary from version ${versionFrom} to version ${versionTo}`,
+      );
       return;
     }
 
-    const confirmed = await this.confirm(`Are you sure you want to delete the canary from ${versionFrom} to ${versionTo}?`);
+    const confirmed = await this.confirm(
+      `Are you sure you want to delete the canary from ${versionFrom} to ${versionTo}?`,
+    );
     if (!confirmed) {
       this.log('Canary deletion cancelled.');
       return;
     }
 
-    this.startSpinner(`Deleting active canary from ${versionFrom} to ${versionTo}`);
+    this.startSpinner(
+      `Deleting active canary from ${versionFrom} to ${versionTo}`,
+    );
     await deleteCanary(versionFrom, versionTo);
     this.stopSpinner();
     this.log('Canary deployment deleted successfully.');
@@ -27,7 +37,9 @@ class CanaryDeleteCommand extends ZapierBaseCommand {
 
   async findExistingCanary(versionFrom, versionTo) {
     const activeCanaries = await listCanaries();
-    return activeCanaries.objects.find(c => c.from_version === versionFrom && c.to_version === versionTo);
+    return activeCanaries.objects.find(
+      (c) => c.from_version === versionFrom && c.to_version === versionTo,
+    );
   }
 
   validateVersions(versionFrom, versionTo) {
@@ -35,25 +47,23 @@ class CanaryDeleteCommand extends ZapierBaseCommand {
     this.throwForInvalidVersion(versionTo);
 
     if (versionFrom === versionTo) {
-      this.error('Versions can not be the same')
+      this.error('Versions can not be the same');
     }
   }
 }
 
-CanaryDeleteCommand.args = [
-  {
-    name: 'versionFrom',
-    required: true,
+CanaryDeleteCommand.args = {
+  versionFrom: Args.string({
     description: 'Version to route traffic from',
-  },
-  {
-    name: 'versionTo',
     required: true,
+  }),
+  versionTo: Args.string({
     description: 'Version canary traffic is routed to',
-  },
-];
+    required: true,
+  }),
+};
 CanaryDeleteCommand.description = 'Delete an active canary deployment';
 CanaryDeleteCommand.examples = ['zapier canary:delete 1.0.0 1.1.0'];
 CanaryDeleteCommand.skipValidInstallCheck = true;
 
-module.exports = CanaryDeleteCommand;
+module.exports = CanaryDeleteCommand;

package/src/oclif/commands/canary/list.js

@@ -7,11 +7,11 @@ class CanaryListCommand extends ZapierBaseCommand {
   async perform() {
     const canaries = await listCanaries();
 
-    const formattedCanaries = canaries.objects.map(c => ({
+    const formattedCanaries = canaries.objects.map((c) => ({
       from_version: c.from_version,
       to_version: c.to_version,
       percent: c.percent,
-      seconds_remaining: c.until_timestamp - Math.floor(Date.now() / 1000)
+      seconds_remaining: c.until_timestamp - Math.floor(Date.now() / 1000),
     }));
 
     this.log(bold('Active Canaries') + '\n');
@@ -23,16 +23,14 @@ class CanaryListCommand extends ZapierBaseCommand {
         ['Traffic Amount', 'percent'],
         ['Seconds Remaining', 'seconds_remaining'],
       ],
-      emptyMessage: grey(
-        `No active canary deployments found.`
-      ),
+      emptyMessage: grey(`No active canary deployments found.`),
     });
   }
 }
 
 CanaryListCommand.flags = buildFlags({ opts: { format: true } });
 CanaryListCommand.description = 'List all active canary deployments';
-CanaryListCommand.examples = ['zapier canary:list']
+CanaryListCommand.examples = ['zapier canary:list'];
 CanaryListCommand.skipValidInstallCheck = true;
 
-module.exports = CanaryListCommand;
+module.exports = CanaryListCommand;