zapier-platform-cli 15.19.0 → 16.1.0

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;

package/src/oclif/commands/convert.js

@@ -1,3 +1,5 @@
+const { Args, Flags } = require('@oclif/core');
+
 const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
 
@@ -6,8 +8,6 @@ const { convertApp } = require('../../utils/convert');
 const { isExistingEmptyDir } = require('../../utils/files');
 const { initApp } = require('../../utils/init');
 
-const { flags } = require('@oclif/command');
-
 class ConvertCommand extends BaseCommand {
   generateCreateFunc(appId, version) {
     return async (tempAppDir) => {
@@ -23,7 +23,7 @@ class ConvertCommand extends BaseCommand {
 
         if (!versionInfo.definition_override) {
           this.error(
-            `Integration ${appId} @ ${version} is already a CLI integration and can't be converted. Instead, pick a version that was created using the Visual Builder.`
+            `Integration ${appId} @ ${version} is already a CLI integration and can't be converted. Instead, pick a version that was created using the Visual Builder.`,
           );
         }
         this.stopSpinner();
@@ -32,7 +32,7 @@ class ConvertCommand extends BaseCommand {
       } catch (e) {
         if (e.status === 404) {
           this.error(
-            `Visual Builder integration ${appId} @ ${version} not found. Double check the integration id and version.`
+            `Visual Builder integration ${appId} @ ${version} not found. Double check the integration id and version.`,
           );
         }
         this.error(e.json.errors[0]);
@@ -45,7 +45,7 @@ class ConvertCommand extends BaseCommand {
     const { version } = this.flags;
     if (!appId) {
       this.error(
-        'You must provide an integrationId. See zapier convert --help for more info.'
+        'You must provide an integrationId. See zapier convert --help for more info.',
       );
     }
 
@@ -60,23 +60,22 @@ class ConvertCommand extends BaseCommand {
   }
 }
 
-ConvertCommand.args = [
-  {
-    name: 'integrationId',
-    required: true,
+ConvertCommand.args = {
+  integrationId: Args.string({
     description: `To get the integration/app ID, go to "https://developer.zapier.com", click on an integration, and copy the number directly after "/app/" in the URL.`,
-    parse: (input) => Number(input),
-  },
-  {
-    name: 'path',
     required: true,
+    parse: (input) => Number(input),
+  }),
+  path: Args.string({
     description:
       'Relative to your current path - IE: `.` for current directory.',
-  },
-];
+    required: true,
+  }),
+};
+
 ConvertCommand.flags = buildFlags({
   commandFlags: {
-    version: flags.string({
+    version: Flags.string({
       char: 'v',
       description:
         'Convert a specific version. Required when converting a Visual Builder integration.',
@@ -84,6 +83,7 @@ ConvertCommand.flags = buildFlags({
     }),
   },
 });
+
 ConvertCommand.description = `Convert a Visual Builder integration to a CLI integration.
 
 The resulting CLI integration will be identical to its Visual Builder version and ready to push and use immediately!

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

@@ -1,4 +1,5 @@
 const BaseCommand = require('../../ZapierBaseCommand');
+const { Args } = require('@oclif/core');
 const { buildFlags } = require('../../buildFlags');
 const { callAPI } = require('../../../utils/api');
 
@@ -17,13 +18,12 @@ class DeleteVersionCommand extends BaseCommand {
   }
 }
 
-DeleteVersionCommand.args = [
-  {
-    name: 'version',
-    required: true,
+DeleteVersionCommand.args = {
+  version: Args.string({
     description: `Specify the version to delete. It must have no users or Zaps.`,
-  },
-];
+    required: true,
+  }),
+};
 DeleteVersionCommand.flags = buildFlags();
 DeleteVersionCommand.skipValidInstallCheck = true;
 DeleteVersionCommand.description = `Delete a specific version of your integration.

package/src/oclif/commands/deprecate.js

@@ -1,4 +1,5 @@
 const BaseCommand = require('../ZapierBaseCommand');
+const { Args } = require('@oclif/core');
 const { buildFlags } = require('../buildFlags');
 
 const { callAPI } = require('../../utils/api');
@@ -8,7 +9,7 @@ class DeprecateCommand extends BaseCommand {
     const app = await this.getWritableApp();
     const { version, date } = this.args;
     this.log(
-      `Preparing to deprecate version ${version} your app "${app.title}".\n`
+      `Preparing to deprecate version ${version} your app "${app.title}".\n`,
     );
     const url = `/apps/${app.id}/versions/${version}/deprecate`;
     this.startSpinner(`Deprecating ${version}`);
@@ -20,25 +21,23 @@ class DeprecateCommand extends BaseCommand {
     });
     this.stopSpinner();
     this.log(
-      `\nWe'll let users know that this version is no longer recommended and will cease to work on ${date}.`
+      `\nWe'll let users know that this version is no longer recommended and will cease to work on ${date}.`,
     );
   }
 }
 
 DeprecateCommand.flags = buildFlags();
-DeprecateCommand.args = [
-  {
-    name: 'version',
+DeprecateCommand.args = {
+  version: Args.string({
     description: 'The version to deprecate.',
     required: true,
-  },
-  {
-    name: 'date',
-    required: true,
+  }),
+  date: Args.string({
     description:
       'The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.',
-  },
-];
+    required: true,
+  }),
+};
 DeprecateCommand.examples = ['zapier deprecate 1.2.3 2011-10-01'];
 DeprecateCommand.description = `Mark a non-production version of your integration as deprecated, with removal by a certain date.
 

package/src/oclif/commands/describe.js

@@ -95,7 +95,7 @@ class DescribeCommand extends BaseCommand {
           authentication.redirect_uri = version.oauth_redirect_uri;
         } else {
           authentication.redirect_uri = grey(
-            'Run `zapier push` to see the redirect_uri.'
+            'Run `zapier push` to see the redirect_uri.',
           );
         }
       }
@@ -134,7 +134,7 @@ class DescribeCommand extends BaseCommand {
           .map((method) => method({ key: resource.key }))
           .filter((path) => _.has(definition, path))
           .join('\n'),
-      })
+      }),
     );
     this.logTitle('Resources');
     this.logTable({
@@ -153,7 +153,7 @@ class DescribeCommand extends BaseCommand {
       const rows = _.values(definition[type]).map((row) => {
         // add possible action paths
         let paths = actionTemplates.map((method) =>
-          method({ type, key: row.key })
+          method({ type, key: row.key }),
         );
 
         // add possible resource paths
@@ -161,7 +161,7 @@ class DescribeCommand extends BaseCommand {
           const key = row.operation.resource.split('.')[0];
           const resourceTemplates = makeResourceTemplates(typeMap[type]);
           paths = paths.concat(
-            resourceTemplates.map((method) => method({ key }))
+            resourceTemplates.map((method) => method({ key })),
           );
         }
 
@@ -182,7 +182,7 @@ class DescribeCommand extends BaseCommand {
           ['Available Methods', 'paths', grey('n/a')],
         ],
         emptyMessage: grey(
-          `Nothing found for ${type}. Use the \`zapier scaffold\` command to add one.`
+          `Nothing found for ${type}. Use the \`zapier scaffold\` command to add one.`,
         ),
       });
 

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

@@ -1,4 +1,5 @@
 const BaseCommand = require('../../ZapierBaseCommand');
+const { Args } = require('@oclif/core');
 const { buildFlags } = require('../../buildFlags');
 const { listEnv } = require('../../../utils/api');
 
@@ -22,13 +23,12 @@ class GetEnvCommand extends BaseCommand {
   }
 }
 
-GetEnvCommand.args = [
-  {
-    name: 'version',
+GetEnvCommand.args = {
+  version: Args.string({
     description: 'The version to get the environment for.',
     required: true,
-  },
-];
+  }),
+};
 GetEnvCommand.flags = buildFlags({ opts: { format: true } });
 GetEnvCommand.description = `Get environment variables for a version.`;
 GetEnvCommand.examples = [`zapier env:get 1.2.3`];

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

@@ -1,3 +1,4 @@
+const { Args } = require('@oclif/core');
 const { cyan } = require('colors/safe');
 const { omit } = require('lodash');
 
@@ -7,7 +8,7 @@ const { callAPI } = require('../../../utils/api');
 
 const successMessage = (version) =>
   `Successfully wrote the following to the environment of version ${cyan(
-    version
+    version,
   )}:`;
 
 class SetEnvCommand extends BaseCommand {
@@ -19,7 +20,7 @@ class SetEnvCommand extends BaseCommand {
 
     if (!valuesToSet.length) {
       this.error(
-        'Must specify at least one key-value pair to set (like `SOME_KEY=1234`)'
+        'Must specify at least one key-value pair to set (like `SOME_KEY=1234`)',
       );
     }
 
@@ -39,7 +40,7 @@ class SetEnvCommand extends BaseCommand {
     const app = await this.getWritableApp();
     if (!app.all_versions.includes(version)) {
       this.error(
-        `Version ${version} doesn't exist on integration "${app.title}"`
+        `Version ${version} doesn't exist on integration "${app.title}"`,
       );
     }
 
@@ -53,7 +54,7 @@ class SetEnvCommand extends BaseCommand {
           body: payload,
           method: 'POST',
         },
-        true
+        true,
       );
 
       this.log(successMessage(version));
@@ -73,19 +74,17 @@ class SetEnvCommand extends BaseCommand {
   }
 }
 
-SetEnvCommand.args = [
-  {
-    name: 'version',
+SetEnvCommand.args = {
+  version: Args.string({
     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.',
     required: true,
-  },
-  {
-    name: 'key-value pairs...',
+  }),
+  'key-value pairs...': Args.string({
     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`',
-  },
-];
+  }),
+};
 SetEnvCommand.flags = buildFlags();
 SetEnvCommand.description = `Set environment variables for a version.`;
 SetEnvCommand.examples = [`zapier env:set 1.2.3 SECRET=12345 OTHER=4321`];

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

@@ -1,3 +1,4 @@
+const { Args } = require('@oclif/core');
 const { cyan } = require('colors/safe');
 
 const BaseCommand = require('../../ZapierBaseCommand');
@@ -6,7 +7,7 @@ const { callAPI } = require('../../../utils/api');
 
 const successMessage = (version) =>
   `Successfully unset the following keys in the environment of version ${cyan(
-    version
+    version,
   )} (if they existed):`;
 
 class UnsetEnvCommand extends BaseCommand {
@@ -36,7 +37,7 @@ class UnsetEnvCommand extends BaseCommand {
     const app = await this.getWritableApp();
     if (!app.all_versions.includes(version)) {
       this.error(
-        `Version ${version} doesn't exist on integration "${app.title}"`
+        `Version ${version} doesn't exist on integration "${app.title}"`,
       );
     }
 
@@ -54,17 +55,15 @@ class UnsetEnvCommand extends BaseCommand {
   }
 }
 
-UnsetEnvCommand.args = [
-  {
-    name: 'version',
+UnsetEnvCommand.args = {
+  version: Args.string({
     description: 'The version to set the environment for.',
     required: true,
-  },
-  {
-    name: 'keys...',
+  }),
+  'keys...': Args.string({
     description: 'The keys to unset. Keys are case-insensitive.',
-  },
-];
+  }),
+};
 UnsetEnvCommand.flags = buildFlags();
 UnsetEnvCommand.description = `Unset environment variables for a version.`;
 UnsetEnvCommand.examples = [`zapier env:unset 1.2.3 SECRET OTHER`];

package/src/oclif/commands/history.js

@@ -15,6 +15,7 @@ class HistoryCommand extends BaseCommand {
         ['What', 'action'],
         ['Message', 'message'],
         ['Who', 'customuser'],
+        ['Version', 'version'],
         ['Timestamp', 'date'],
       ],
       emptyMessage: 'No historical actions found',