zapier-platform-cli 15.18.1 → 16.0.0

package/src/oclif/commands/logs.js

@@ -1,5 +1,5 @@
+const { Flags } = require('@oclif/core');
 const BaseCommand = require('../ZapierBaseCommand');
-const { flags } = require('@oclif/command');
 const { buildFlags } = require('../buildFlags');
 const { grey } = require('colors/safe');
 const { pick } = require('lodash');
@@ -8,32 +8,32 @@ const { listLogs } = require('../../utils/api');
 
 // pulled out so we can pull these explicitly to send to the server
 const commandFlags = {
-  version: flags.string({
+  version: Flags.string({
     char: 'v',
     description: 'Filter logs to the specified version.',
   }),
-  status: flags.string({
+  status: Flags.string({
     char: 's',
     description: 'Filter logs to only see errors or successes',
     options: ['any', 'success', 'error'],
     default: 'any', // this doesn't really need to be a status
   }),
-  type: flags.string({
+  type: Flags.string({
     char: 't',
     description: 'See logs of the specified type',
     options: ['console', 'bundle', 'http'],
     default: 'console',
   }),
-  detailed: flags.boolean({
+  detailed: Flags.boolean({
     // no char since it conflicts with --debug
     description: 'See extra info, like request/response body and headers.',
   }),
-  user: flags.string({
+  user: Flags.string({
     char: 'u',
     description: 'Only show logs for this user. Defaults to your account.',
     default: 'me',
   }),
-  limit: flags.integer({
+  limit: Flags.integer({
     description:
       'Cap the number of logs returned. Max is 50 (also the default)',
     default: 50,
@@ -102,8 +102,8 @@ class LogsCommand extends BaseCommand {
       if (this.flags.type === 'http' && !this.flags.detailed) {
         this.log(
           grey(
-            '  TIP: Use `zapier logs --type=http --detailed` to include response information.'
-          )
+            '  TIP: Use `zapier logs --type=http --detailed` to include response information.',
+          ),
         );
       }
     }

package/src/oclif/commands/migrate.js

@@ -1,4 +1,4 @@
-const { flags } = require('@oclif/command');
+const { Args, Flags } = require('@oclif/core');
 
 const BaseCommand = require('../ZapierBaseCommand');
 const PromoteCommand = require('./promote');
@@ -24,13 +24,13 @@ class MigrateCommand extends BaseCommand {
 
     if (user && account) {
       this.error(
-        'Cannot specify both `--user` and `--account`. Use only one or the other.'
+        'Cannot specify both `--user` and `--account`. Use only one or the other.',
       );
     }
 
     if ((user || account) && percent !== 100) {
       this.error(
-        `Cannot specify both \`PERCENT\` and \`--${flagType}\`. Use only one or the other.`
+        `Cannot specify both \`PERCENT\` and \`--${flagType}\`. Use only one or the other.`,
       );
     }
 
@@ -45,12 +45,12 @@ class MigrateCommand extends BaseCommand {
       toVersion !== app.latest_version
     ) {
       this.log(
-        `You're trying to migrate all the users to ${toVersion}, which is not the current production version.`
+        `You're trying to migrate all the users to ${toVersion}, which is not the current production version.`,
       );
       promoteFirst = await this.confirm(
         `Do you want to promote ${toVersion} to production first?`,
         true,
-        true
+        true,
       );
     }
 
@@ -71,11 +71,11 @@ class MigrateCommand extends BaseCommand {
       this.startSpinner(
         `Starting migration from ${fromVersion} to ${toVersion} for ${
           user || account
-        }`
+        }`,
       );
     } else {
       this.startSpinner(
-        `Starting migration from ${fromVersion} to ${toVersion} for ${percent}%`
+        `Starting migration from ${fromVersion} to ${toVersion} for ${percent}%`,
       );
     }
     if (percent) {
@@ -91,42 +91,39 @@ class MigrateCommand extends BaseCommand {
     }
 
     this.log(
-      '\nMigration successfully queued, please check `zapier jobs` to track the status. Migrations usually take between 5-10 minutes.'
+      '\nMigration successfully queued, please check `zapier jobs` to track the status. Migrations usually take between 5-10 minutes.',
     );
   }
 }
 
 MigrateCommand.flags = buildFlags({
   commandFlags: {
-    user: flags.string({
+    user: Flags.string({
       description:
         "Migrates all of a users' Private Zaps within all accounts for which the specified user is a member",
     }),
-    account: flags.string({
+    account: Flags.string({
       description:
         "Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member",
     }),
   },
 });
 
-MigrateCommand.args = [
-  {
-    name: 'fromVersion',
+MigrateCommand.args = {
+  fromVersion: Args.string({
     required: true,
     description: 'The version FROM which to migrate users.',
-  },
-  {
-    name: 'toVersion',
+  }),
+  toVersion: Args.string({
     required: true,
     description: 'The version TO which to migrate users.',
-  },
-  {
-    name: 'percent',
+  }),
+  percent: Args.string({
     default: 100,
     description: 'Percentage (between 1 and 100) of users to migrate.',
-    parse: (input) => parseInt(input, 10),
-  },
-];
+    parse: async (input) => parseInt(input, 10),
+  }),
+};
 
 MigrateCommand.skipValidInstallCheck = true;
 MigrateCommand.examples = [

package/src/oclif/commands/promote.js

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const colors = require('colors/safe');
-const { flags } = require('@oclif/command');
+const { Args, Flags } = require('@oclif/core');
 
 const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
@@ -37,8 +37,8 @@ const hasAppChangeType = (metadata, changeType) => {
     metadata?.some(
       // Existing property name
       // eslint-disable-next-line camelcase
-      ({ app_change_type }) => app_change_type === changeType
-    )
+      ({ app_change_type }) => app_change_type === changeType,
+    ),
   );
 };
 
@@ -52,19 +52,18 @@ class PromoteCommand extends BaseCommand {
     const assumeYes = 'yes' in this.flags;
 
     let shouldContinue;
-    const { changelog, appMetadata, issueMetadata } = await getVersionChangelog(
-      version
-    );
+    const { changelog, appMetadata, issueMetadata } =
+      await getVersionChangelog(version);
 
     const metadataPromptHelper = `Issues are indicated by ${colors.bold.underline(
-      '#<issueId>'
+      '#<issueId>',
     )}, and actions by ${colors.bold.underline(
-      '<trigger|create|search>/<key>'
+      '<trigger|create|search>/<key>',
     )}. Note issue IDs must be numeric and action identifiers are case sensitive.`;
 
     if (!changelog) {
       this.error(`${colors.yellow(
-        'Warning!'
+        'Warning!',
       )} Changelog not found. Please create a CHANGELOG.md file with user-facing descriptions. Example:
 ${colors.cyan(EXAMPLE_CHANGELOG)}
 If bugfixes or updates to actions are present, then should be marked on a line that begins with "Update" or "Fix" (case insensitive) and information that contains the identifier.
@@ -81,7 +80,7 @@ ${metadataPromptHelper}`);
           .filter(({ app_change_type }) => app_change_type === 'FEATURE_UPDATE')
           .map(
             ({ action_type, action_key }) =>
-              `${action_key}/${ACTION_TYPE_MAPPING[action_type]}`
+              `${action_key}/${ACTION_TYPE_MAPPING[action_type]}`,
           );
 
       const issueFeatureUpdates =
@@ -95,7 +94,7 @@ ${metadataPromptHelper}`);
           `Feature updates: ${[
             ...(appFeatureUpdates ?? []),
             ...(issueFeatureUpdates ?? []),
-          ].join(', ')}`
+          ].join(', ')}`,
         );
       }
 
@@ -105,7 +104,7 @@ ${metadataPromptHelper}`);
           .filter(({ app_change_type }) => app_change_type === 'BUGFIX')
           .map(
             ({ action_type, action_key }) =>
-              `${action_key}/${ACTION_TYPE_MAPPING[action_type]}`
+              `${action_key}/${ACTION_TYPE_MAPPING[action_type]}`,
           );
       const issueBugfixes =
         issueMetadata &&
@@ -116,8 +115,8 @@ ${metadataPromptHelper}`);
       if (appBugfixes || issueBugfixes) {
         this.log(
           `Bug fixes: ${[...(appBugfixes ?? []), ...(issueBugfixes ?? [])].join(
-            ', '
-          )}`
+            ', ',
+          )}`,
         );
       }
 
@@ -128,7 +127,7 @@ ${metadataPromptHelper}`);
         !issueBugfixes
       ) {
         this.log(
-          `No metadata was found in the changelog. Remember, you can associate the changelog with issues or triggers/actions.\n\n${metadataPromptHelper}`
+          `No metadata was found in the changelog. Remember, you can associate the changelog with issues or triggers/actions.\n\n${metadataPromptHelper}`,
         );
       }
       this.log();
@@ -137,7 +136,7 @@ ${metadataPromptHelper}`);
       shouldContinue =
         assumeYes ||
         (await this.confirm(
-          'Would you like to continue promoting with this changelog?'
+          'Would you like to continue promoting with this changelog?',
         ));
     }
 
@@ -146,7 +145,7 @@ ${metadataPromptHelper}`);
     }
 
     this.log(
-      `Preparing to promote version ${version} of your integration "${app.title}".`
+      `Preparing to promote version ${version} of your integration "${app.title}".`,
     );
 
     const isFeatureUpdate =
@@ -178,7 +177,7 @@ ${metadataPromptHelper}`);
           method: 'POST',
           body,
         },
-        true
+        true,
       );
     } catch (response) {
       const activationUrl = _.get(response, ['json', 'activationInfo', 'url']);
@@ -187,8 +186,8 @@ ${metadataPromptHelper}`);
         this.log('\nGood news! Your integration passes validation.');
         this.log(
           `The next step is to visit ${colors.cyan(
-            activationUrl
-          )} to request to publish your integration.`
+            activationUrl,
+          )} to request to publish your integration.`,
         );
       } else {
         this.stopSpinner({ success: false });
@@ -211,7 +210,7 @@ ${metadataPromptHelper}`);
     this.log('  Promotion successful!');
     if (!this.flags.invokedFromAnotherCommand) {
       this.log(
-        'Optionally, run the `zapier migrate` command to move users to this version.'
+        'Optionally, run the `zapier migrate` command to move users to this version.',
       );
     }
   }
@@ -219,7 +218,7 @@ ${metadataPromptHelper}`);
 
 PromoteCommand.flags = buildFlags({
   commandFlags: {
-    yes: flags.boolean({
+    yes: Flags.boolean({
       char: 'y',
       description:
         'Automatically answer "yes" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.',
@@ -227,13 +226,12 @@ PromoteCommand.flags = buildFlags({
   },
 });
 
-PromoteCommand.args = [
-  {
-    name: 'version',
+PromoteCommand.args = {
+  version: Args.string({
     required: true,
     description: 'The version you want to promote.',
-  },
-];
+  }),
+};
 
 PromoteCommand.skipValidInstallCheck = true;
 PromoteCommand.examples = ['zapier promote 1.0.0'];

package/src/oclif/commands/push.js

@@ -13,10 +13,10 @@ class PushCommand extends ZapierBaseCommand {
         skipNpmInstall: this.flags['skip-npm-install'],
         disableDependencyDetection: this.flags['disable-dependency-detection'],
         skipValidation: this.flags['skip-validation'],
-      }
+      },
     );
     this.log(
-      `\nPush complete! Built ${BUILD_PATH} and ${SOURCE_PATH} and uploaded them to Zapier.`
+      `\nPush complete! Built ${BUILD_PATH} and ${SOURCE_PATH} and uploaded them to Zapier.`,
     );
   }
 }

package/src/oclif/commands/register.js

@@ -1,5 +1,5 @@
 const colors = require('colors/safe');
-const { flags } = require('@oclif/command');
+const { Args, Flags } = require('@oclif/core');
 
 const ZapierBaseCommand = require('../ZapierBaseCommand');
 const {
@@ -29,7 +29,7 @@ class RegisterCommand extends ZapierBaseCommand {
       this.flags.desc.length > MAX_DESCRIPTION_LENGTH
     ) {
       throw new Error(
-        `Please provide a description that is ${MAX_DESCRIPTION_LENGTH} characters or less.`
+        `Please provide a description that is ${MAX_DESCRIPTION_LENGTH} characters or less.`,
       );
     }
 
@@ -38,7 +38,7 @@ class RegisterCommand extends ZapierBaseCommand {
       this.args.title.length < MIN_TITLE_LENGTH
     ) {
       throw new Error(
-        `Please provide a title that is ${MIN_TITLE_LENGTH} characters or more.`
+        `Please provide a title that is ${MIN_TITLE_LENGTH} characters or more.`,
       );
     }
 
@@ -47,7 +47,7 @@ class RegisterCommand extends ZapierBaseCommand {
     switch (action) {
       case 'update': {
         this.startSpinner(
-          `Updating your existing integration "${appMeta.title}"`
+          `Updating your existing integration "${appMeta.title}"`,
         );
         await callAPI(`/apps/${this.app.id}`, {
           method: 'PUT',
@@ -60,7 +60,7 @@ class RegisterCommand extends ZapierBaseCommand {
 
       case 'register': {
         this.startSpinner(
-          `Registering your new integration "${appMeta.title}"`
+          `Registering your new integration "${appMeta.title}"`,
         );
         const app = await callAPI('/apps?formId=create', {
           method: 'POST',
@@ -68,12 +68,12 @@ class RegisterCommand extends ZapierBaseCommand {
         });
         this.stopSpinner();
         this.startSpinner(
-          `Linking app to current directory with \`${CURRENT_APP_FILE}\``
+          `Linking app to current directory with \`${CURRENT_APP_FILE}\``,
         );
         await writeLinkedAppConfig(app, process.cwd());
         this.stopSpinner();
         this.log(
-          '\nFinished! Now that your integration is registered with Zapier, you can `zapier push`!'
+          '\nFinished! Now that your integration is registered with Zapier, you can `zapier push`!',
         );
         break;
       }
@@ -104,7 +104,7 @@ class RegisterCommand extends ZapierBaseCommand {
         throw new Error(
           `${flagValue} is not a valid value for ${flag}. Must be one of the following: ${enumFieldChoices
             .map((option) => option.value)
-            .join(', ')}`
+            .join(', ')}`,
         );
       }
     }
@@ -131,14 +131,14 @@ class RegisterCommand extends ZapierBaseCommand {
       if (this.flags.yes) {
         console.info(
           colors.yellow(
-            `-y/--yes flag passed, updating current integration (ID: ${linkedAppId}).`
-          )
+            `-y/--yes flag passed, updating current integration (ID: ${linkedAppId}).`,
+          ),
         );
         action = actionChoices[0].value;
       } else {
         action = await this.promptWithList(
           `Would you like to update your current integration (ID: ${linkedAppId})?`,
-          actionChoices
+          actionChoices,
         );
       }
     }
@@ -151,7 +151,7 @@ class RegisterCommand extends ZapierBaseCommand {
       // Block published apps from updating settings
       if (this.app?.status && isPublished(this.app.status)) {
         throw new Error(
-          "You can't edit settings for this integration. To edit your integration details on Zapier's public app directory, email partners@zapier.com."
+          "You can't edit settings for this integration. To edit your integration details on Zapier's public app directory, email partners@zapier.com.",
         );
       }
     }
@@ -164,7 +164,7 @@ class RegisterCommand extends ZapierBaseCommand {
           required: true,
           charMinimum: MIN_TITLE_LENGTH,
           default: this.app?.title,
-        }
+        },
       );
     }
 
@@ -176,7 +176,7 @@ class RegisterCommand extends ZapierBaseCommand {
           required: true,
           charLimit: MAX_DESCRIPTION_LENGTH,
           default: this.app?.description,
-        }
+        },
       );
     }
 
@@ -184,7 +184,7 @@ class RegisterCommand extends ZapierBaseCommand {
     if (!appMeta.homepage_url) {
       appMeta.homepage_url = await this.prompt(
         'What is the homepage URL of your app? (optional)',
-        { default: this.app?.homepage_url }
+        { default: this.app?.homepage_url },
       );
     }
 
@@ -193,7 +193,7 @@ class RegisterCommand extends ZapierBaseCommand {
       appMeta.intention = await this.promptWithList(
         'Are you building a public or private integration?',
         this.config.enumFieldChoices.intention,
-        { default: this.app?.intention }
+        { default: this.app?.intention },
       );
     }
 
@@ -203,9 +203,9 @@ class RegisterCommand extends ZapierBaseCommand {
         "What is your relationship with the app you're integrating with Zapier?",
         this._getRoleChoicesWithAppTitle(
           appMeta.title,
-          this.config.enumFieldChoices.role
+          this.config.enumFieldChoices.role,
         ),
-        { default: this.app?.role }
+        { default: this.app?.role },
       );
     }
 
@@ -214,7 +214,7 @@ class RegisterCommand extends ZapierBaseCommand {
       appMeta.app_category = await this.promptWithList(
         'How would you categorize your app?',
         this.config.enumFieldChoices.app_category,
-        { default: this.app?.app_category }
+        { default: this.app?.app_category },
       );
     }
 
@@ -229,7 +229,7 @@ class RegisterCommand extends ZapierBaseCommand {
           [
             { name: 'Yes', value: true },
             { name: 'No', value: false },
-          ]
+          ],
         );
       }
     }
@@ -252,45 +252,44 @@ class RegisterCommand extends ZapierBaseCommand {
 }
 
 RegisterCommand.skipValidInstallCheck = true;
-RegisterCommand.args = [
-  {
-    name: 'title',
+RegisterCommand.args = {
+  title: Args.string({
     description:
       "Your integration's public title. Asked interactively if not present.",
-  },
-];
+  }),
+};
 
 RegisterCommand.flags = buildFlags({
   commandFlags: {
-    desc: flags.string({
+    desc: Flags.string({
       char: 'D',
       description: `A sentence describing your app in ${MAX_DESCRIPTION_LENGTH} characters or less, e.g. "Trello is a team collaboration tool to organize tasks and keep projects on track."`,
     }),
-    url: flags.string({
+    url: Flags.string({
       char: 'u',
       description: 'The homepage URL of your app, e.g., https://example.com.',
     }),
-    audience: flags.string({
+    audience: Flags.string({
       char: 'a',
       description: 'Are you building a public or private integration?',
     }),
-    role: flags.string({
+    role: Flags.string({
       char: 'r',
       description:
         "What is your relationship with the app you're integrating with Zapier?",
     }),
-    category: flags.string({
+    category: Flags.string({
       char: 'c',
       description:
         "How would you categorize your app? Choose the most appropriate option for your app's core features.",
     }),
-    subscribe: flags.boolean({
+    subscribe: Flags.boolean({
       char: 's',
       description:
         'Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.',
       allowNo: true,
     }),
-    yes: flags.boolean({
+    yes: Flags.boolean({
       char: 'y',
       description:
         'Assume yes for all yes/no prompts. This flag will also update an existing integration (as opposed to registering a new one) if a .zapierapprc file is found.',