zapier-platform-cli 15.19.0 → 16.1.0

package/src/oclif/commands/team/add.js

@@ -1,5 +1,5 @@
 const ZapierBaseCommand = require('../../ZapierBaseCommand');
-// const { flags } = require('@oclif/command');
+const { Args } = require('@oclif/core');
 const { cyan } = require('colors/safe');
 const { buildFlags } = require('../../buildFlags');
 const { callAPI } = require('../../../utils/api');
@@ -29,7 +29,7 @@ class TeamAddCommand extends ZapierBaseCommand {
         `About to invite ${cyan(this.args.email)} to as a team member at the ${
           this.args.role
         } level. An email will be sent with the following message:\n\n"${message}"\n\nIs that ok?`,
-        true
+        true,
       ))
     ) {
       this.log('\ncancelled');
@@ -42,8 +42,8 @@ class TeamAddCommand extends ZapierBaseCommand {
       role === 'admin'
         ? `/apps/${id}/collaborators`
         : role === 'subscriber'
-        ? `${BASE_ENDPOINT}/api/platform/v3/integrations/${id}/subscribers`
-        : `/apps/${id}/limited_collaborators`;
+          ? `${BASE_ENDPOINT}/api/platform/v3/integrations/${id}/subscribers`
+          : `/apps/${id}/limited_collaborators`;
 
     await callAPI(url, {
       url: url.startsWith('http') ? url : undefined,
@@ -54,26 +54,23 @@ class TeamAddCommand extends ZapierBaseCommand {
   }
 }
 
-TeamAddCommand.args = [
-  {
-    name: 'email',
+TeamAddCommand.args = {
+  email: Args.string({
     description:
       "The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.",
     required: true,
-  },
-  {
-    name: 'role',
+  }),
+  role: Args.string({
     description:
       'The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.',
     options: ['admin', 'collaborator', 'subscriber'],
     required: true,
-  },
-  {
-    name: 'message',
+  }),
+  message: Args.string({
     description:
       'A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved.',
-  },
-];
+  }),
+};
 TeamAddCommand.flags = buildFlags();
 TeamAddCommand.description = `Add a team member to your integration.
 

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

@@ -34,8 +34,8 @@ class TeamListCommand extends ZapierBaseCommand {
 
     this.log(
       `To invite more team members, use the \`${cyan(
-        'zapier team:add'
-      )}\` command.`
+        'zapier team:add',
+      )}\` command.`,
     );
   }
 }

package/src/oclif/commands/team/remove.js

@@ -17,7 +17,7 @@ class TeamRemoveCommand extends ZapierBaseCommand {
         value: { id, email, role: transformUserRole(role) },
         name: `${email} (${transformUserRole(role)})`,
         short: email,
-      })
+      }),
     );
 
     this.stopSpinner();
@@ -28,15 +28,15 @@ class TeamRemoveCommand extends ZapierBaseCommand {
       id: invitationId,
     } = await this.promptWithList(
       'Which team member do you want to remove?',
-      choices
+      choices,
     );
     this.log();
     if (
       !(await this.confirm(
         `About to revoke ${cyan(role)}-level access from ${cyan(
-          email
+          email,
         )}. Are you sure?`,
-        true
+        true,
       ))
     ) {
       this.log('\ncancelled');
@@ -49,8 +49,8 @@ class TeamRemoveCommand extends ZapierBaseCommand {
       role === 'admin'
         ? `/apps/${appId}/collaborators/${invitationId}`
         : role === 'subscriber'
-        ? `${BASE_ENDPOINT}/api/platform/v3/integrations/${appId}/subscribers/${invitationId}`
-        : `/apps/${appId}/limited_collaborators`;
+          ? `${BASE_ENDPOINT}/api/platform/v3/integrations/${appId}/subscribers/${invitationId}`
+          : `/apps/${appId}/limited_collaborators`;
 
     await callAPI(url, {
       url: url.startsWith('http') ? url : undefined,

package/src/oclif/commands/test.js

@@ -1,4 +1,4 @@
-const { flags } = require('@oclif/command');
+const { Flags } = require('@oclif/core');
 const chalk = require('chalk');
 
 const BaseCommand = require('../ZapierBaseCommand');
@@ -27,7 +27,7 @@ class TestCommand extends BaseCommand {
     const credentials = await readCredentials(false);
     if (credentials.deployKey) {
       this.log(
-        `Adding ${constants.AUTH_LOCATION} to environment as ZAPIER_DEPLOY_KEY...`
+        `Adding ${constants.AUTH_LOCATION} to environment as ZAPIER_DEPLOY_KEY...`,
       );
       extraEnv.ZAPIER_DEPLOY_KEY = credentials.deployKey;
     }
@@ -53,10 +53,10 @@ class TestCommand extends BaseCommand {
     // but the space-joined array made that unclear
     this.log(
       `\n  ${chalk.cyanBright.bold(
-        packageManager.executable
+        packageManager.executable,
       )} ${chalk.cyanBright(
-        argv.map((a) => (a.includes(' ') ? `"${a}"` : a)).join(' ')
-      )}\n`
+        argv.map((a) => (a.includes(' ') ? `"${a}"` : a)).join(' '),
+      )}\n`,
     );
 
     const output = await runCommand(packageManager.executable, argv, {
@@ -71,15 +71,15 @@ class TestCommand extends BaseCommand {
 
 TestCommand.flags = buildFlags({
   commandFlags: {
-    'skip-validate': flags.boolean({
+    'skip-validate': Flags.boolean({
       description:
         "Forgo running `zapier validate` before tests are run. This will speed up tests if you're modifying functionality of an existing integration rather than adding new actions.",
     }),
-    yarn: flags.boolean({
+    yarn: Flags.boolean({
       description:
         "Use `yarn` instead of `npm`. This happens automatically if there's a `yarn.lock` file, but you can manually force `yarn` if you run tests from a sub-directory.",
     }),
-    pnpm: flags.boolean({
+    pnpm: Flags.boolean({
       description:
         "Use `pnpm` instead of `npm`. This happens automatically if there's a `pnpm-lock.yaml` file, but you can manually force `pnpm` if you run tests from a sub-directory.",
     }),

package/src/oclif/commands/upload.js

@@ -10,7 +10,7 @@ class UploadCommand extends BaseCommand {
     // it would be cool if we differentiated between new/updated here
     await buildAndOrUpload({ upload: true });
     this.log(
-      `\nUpload complete! Uploaded ${BUILD_PATH} and ${SOURCE_PATH} to Zapier. If it's a new version, it should now be available in the Zap editor.`
+      `\nUpload complete! Uploaded ${BUILD_PATH} and ${SOURCE_PATH} to Zapier. If it's a new version, it should now be available in the Zap editor.`,
     );
   }
 }

package/src/oclif/commands/users/add.js

@@ -1,5 +1,5 @@
 const ZapierBaseCommand = require('../../ZapierBaseCommand');
-const { flags } = require('@oclif/command');
+const { Args, Flags } = require('@oclif/core');
 const { cyan } = require('colors/safe');
 const { buildFlags } = require('../../buildFlags');
 const { callAPI } = require('../../../utils/api');
@@ -12,7 +12,7 @@ class UsersAddCommand extends ZapierBaseCommand {
         `About to invite ${cyan(this.args.email)} to ${
           this.args.version ? `version ${this.args.version}` : 'all versions'
         } of your integration. An invite email will be sent. Is that ok?`,
-        true
+        true,
       ))
     ) {
       this.log('\ncancelled');
@@ -29,22 +29,20 @@ class UsersAddCommand extends ZapierBaseCommand {
   }
 }
 
-UsersAddCommand.args = [
-  {
-    name: 'email',
+UsersAddCommand.args = {
+  email: Args.string({
     description:
       "The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.",
     required: true,
-  },
-  {
-    name: 'version',
+  }),
+  version: Args.string({
     description:
       'A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.',
-  },
-];
+  }),
+};
 UsersAddCommand.flags = buildFlags({
   commandFlags: {
-    force: flags.boolean({
+    force: Flags.boolean({
       char: 'f',
       description: 'Skip confirmation. Useful for running programatically.',
     }),

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

@@ -17,8 +17,8 @@ class UsersListCommand extends ZapierBaseCommand {
 
     this.log(
       `\n${yellow(
-        'Note'
-      )} that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the \`users:add EMAIL\` command or the web UI).\n`
+        'Note',
+      )} that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the \`users:add EMAIL\` command or the web UI).\n`,
     );
 
     this.logTable({
@@ -33,10 +33,10 @@ class UsersListCommand extends ZapierBaseCommand {
 
     this.log(
       `\nTo invite users via a link, use the \`${cyan(
-        'zapier users:links'
+        'zapier users:links',
       )}\` command. To invite a specific user by email, use the \`${cyan(
-        'zapier users:add'
-      )}\` command.`
+        'zapier users:add',
+      )}\` command.`,
     );
   }
 }
@@ -45,9 +45,9 @@ UsersListCommand.flags = buildFlags({ opts: { format: true } });
 UsersListCommand.description = `Get a list of users who have been invited to your integration.
 
 Note that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the \`${cyan(
-  'zapier users:add'
+  'zapier users:add',
 )}\` command or the web UI). Users who joined by clicking links generated using the \`${cyan(
-  'zapier user:links'
+  'zapier user:links',
 )}\` command won't show up here.`;
 UsersListCommand.aliases = ['users:list'];
 UsersListCommand.skipValidInstallCheck = true;

package/src/oclif/commands/users/links.js

@@ -13,13 +13,13 @@ class UsersLinksCommand extends ZapierBaseCommand {
 
     this.log(
       `\nYou can invite users to ${bold(
-        'all'
-      )} versions of your integration using the following link:`
+        'all',
+      )} versions of your integration using the following link:`,
     );
     this.log(`\n${cyan(inviteUrl)}\n`);
 
     this.log(
-      'You can invite users to a specific integration version using the following links:'
+      'You can invite users to a specific integration version using the following links:',
     );
     this.logTable({
       rows: Object.entries(versionInviteUrls).map(([version, url]) => ({
@@ -33,7 +33,7 @@ class UsersLinksCommand extends ZapierBaseCommand {
     });
 
     this.log(
-      '\nTo invite a specific user by email, use the `zapier users:add` command.'
+      '\nTo invite a specific user by email, use the `zapier users:add` command.',
     );
   }
 }

package/src/oclif/commands/users/remove.js

@@ -1,5 +1,5 @@
 const ZapierBaseCommand = require('../../ZapierBaseCommand');
-const { flags } = require('@oclif/command');
+const { Args, Flags } = require('@oclif/core');
 const { cyan } = require('colors/safe');
 const { buildFlags } = require('../../buildFlags');
 const { callAPI } = require('../../../utils/api');
@@ -10,9 +10,9 @@ class UsersRemoveCommand extends ZapierBaseCommand {
       !this.flags.force &&
       !(await this.confirm(
         `About to revoke access to ${cyan(
-          this.args.email
+          this.args.email,
         )}. They won't be able to see your app in the editor and their Zaps will stop working. Are you sure?`,
-        true
+        true,
       ))
     ) {
       this.log('\ncancelled');
@@ -27,16 +27,15 @@ class UsersRemoveCommand extends ZapierBaseCommand {
   }
 }
 
-UsersRemoveCommand.args = [
-  {
-    name: 'email',
+UsersRemoveCommand.args = {
+  email: Args.string({
     description: 'The user to be removed.',
     required: true,
-  },
-];
+  }),
+};
 UsersRemoveCommand.flags = buildFlags({
   commandFlags: {
-    force: flags.boolean({
+    force: Flags.boolean({
       char: 'f',
       description: 'Skips confirmation. Useful for running programatically.',
     }),

package/src/oclif/commands/validate.js

@@ -1,5 +1,5 @@
 const colors = require('colors/safe');
-const { flags } = require('@oclif/command');
+const { Flags } = require('@oclif/core');
 
 const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
@@ -29,7 +29,7 @@ class ValidateCommand extends BaseCommand {
 
     if (newErrors.length) {
       this.log(
-        'Your integration is structurally invalid. Address concerns and run this command again.'
+        'Your integration is structurally invalid. Address concerns and run this command again.',
       );
       process.exitCode = 1;
     } else {
@@ -41,8 +41,8 @@ class ValidateCommand extends BaseCommand {
       if (process.exitCode === 1) {
         this.log(
           colors.grey(
-            '\nSkipping integration checks because schema did not validate.'
-          )
+            '\nSkipping integration checks because schema did not validate.',
+          ),
         );
       }
       return;
@@ -85,24 +85,32 @@ class ValidateCommand extends BaseCommand {
     const suggestionDisplay = checkResult.suggestions.display_label;
 
     if (checkIssues.length) {
-      this.logList([
-        [
-          `- ${colors.bold(errorDisplay)}`,
-          'Issues that will prevent your integration from functioning ' +
-            'properly. They block you from pushing.',
+      this.logTable({
+        headers: [
+          ['', 'type'],
+          ['', 'description'],
         ],
-        [
-          `- ${colors.bold(warningDisplay)}`,
-          'To-dos that must be addressed before your integration can be ' +
-            'included in the App Directory. They block you from promoting and ' +
-            'publishing.',
+        rows: [
+          {
+            type: `- ${colors.bold(errorDisplay)}`,
+            description:
+              'Issues that will prevent your integration from functioning properly. They block you from pushing.',
+          },
+          {
+            type: `- ${colors.bold(warningDisplay)}`,
+            description:
+              'To-dos that must be addressed before your integration can be included in the App Directory. They block you from promoting and publishing.',
+          },
+          {
+            type: `- ${colors.bold(suggestionDisplay)}`,
+            description:
+              "Issues and recommendations that need human reviews by Zapier before publishing your integration. They don't block.",
+          },
         ],
-        [
-          `- ${colors.bold(suggestionDisplay)}`,
-          'Issues and recommendations that need human reviews by Zapier before ' +
-            "publishing your integration. They don't block.",
-        ],
-      ]);
+        hasBorder: false,
+        showHeaders: false,
+        style: { head: [], 'padding-left': 0, 'padding-right': 0 },
+      });
     }
     this.log();
   }
@@ -110,7 +118,7 @@ class ValidateCommand extends BaseCommand {
 
 ValidateCommand.flags = buildFlags({
   commandFlags: {
-    'without-style': flags.boolean({
+    'without-style': Flags.boolean({
       description: 'Forgo pinging the Zapier server to run further checks.',
     }),
   },

package/src/oclif/commands/versions.js

@@ -1,3 +1,5 @@
+const colors = require('colors/safe');
+
 const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
 
@@ -23,9 +25,32 @@ class VersionCommand extends BaseCommand {
         'No versions to show. Try adding one with the `zapier push` command',
     });
 
+    this.logTable({
+      headers: [],
+      rows: [
+        {
+          version: `- ${colors.bold('Errors')}`,
+          platform_version:
+            'Issues that will prevent your integration from functioning properly. They block you from pushing.',
+        },
+        {
+          version: `- ${colors.bold('Publishing Tasks')}`,
+          platform_version:
+            'To-dos that must be addressed before your integration can be included in the App Directory. They block you from promoting and publishing.',
+        },
+        {
+          version: `- ${colors.bold('Warnings')}`,
+          platform_version:
+            "Issues and recommendations that need human reviews by Zapier before publishing your integration. They don't block.",
+        },
+      ],
+      hasBorder: false,
+      style: { head: [], 'padding-left': 0, 'padding-right': 0 },
+    });
+
     if (versions.map((v) => v.user_count).filter((c) => c === null).length) {
       this.warn(
-        'Some user counts are still being calculated - run this command again in ~10 seconds (or longer if your integration has lots of users).'
+        'Some user counts are still being calculated - run this command again in ~10 seconds (or longer if your integration has lots of users).',
       );
     }
   }

package/src/oclif/hooks/checkValidNodeVersion.js

@@ -5,7 +5,7 @@ const { LAMBDA_VERSION } = require('../../constants');
 module.exports = function () {
   if (!isValidNodeVersion()) {
     this.error(
-      `Requires node version >= ${LAMBDA_VERSION}, found ${process.versions.node}. Please upgrade Node.js.`
+      `Requires node version >= ${LAMBDA_VERSION}, found ${process.versions.node}. Please upgrade Node.js.`,
     );
   }
 };

package/src/oclif/hooks/deprecated.js

@@ -11,7 +11,7 @@ module.exports = function (options) {
     this.warn(
       `The \`${options.id}\` command is deprecated. Use the \`${
         deprecatedCommands[options.id]
-      }\` command instead.`
+      }\` command instead.`,
     );
     console.log();
   }

package/src/oclif/hooks/getAppRegistrationFieldChoices.js

@@ -13,7 +13,7 @@ module.exports = async function (options) {
     formFields = await callAPI('/apps/fields-choices', { skipDeployKey: true });
   } catch (e) {
     this.error(
-      `Unable to connect to Zapier API. Please check your connection and try again. ${e}`
+      `Unable to connect to Zapier API. Please check your connection and try again. ${e}`,
     );
   }
 
@@ -28,17 +28,17 @@ module.exports = async function (options) {
   if (cmd && cmd.flags) {
     if (cmd.flags.audience) {
       cmd.flags.audience.options = formFields.intention.map(
-        (audienceOption) => audienceOption.value
+        (audienceOption) => audienceOption.value,
       );
     }
     if (cmd.flags.role) {
       cmd.flags.role.options = formFields.role.map(
-        (roleOption) => roleOption.value
+        (roleOption) => roleOption.value,
       );
     }
     if (cmd.flags.category) {
       cmd.flags.category.options = formFields.app_category.map(
-        (categoryOption) => categoryOption.value
+        (categoryOption) => categoryOption.value,
       );
     }
   }

package/src/oclif/hooks/renderMarkdownHelp.js

@@ -1,23 +1,22 @@
 const chalk = require('chalk');
 const { marked } = require('marked');
-const TerminalRenderer = require('marked-terminal');
-const { stdtermwidth } = require('@oclif/help/lib/screen');
+const { markedTerminal } = require('marked-terminal');
 
-marked.setOptions({
-  renderer: new TerminalRenderer({
+marked.use(
+  markedTerminal({
     tab: 2,
-    width: stdtermwidth - 2,
+    width: process.stdout.getWindowSize()[0] - 2,
     reflowText: true,
     codespan: chalk.underline.bold,
   }),
-});
+);
 
 module.exports = (options) => {
   const cmdId = options.id === 'help' ? options.argv[0] : options.id;
   const cmd = options.config.findCommand(cmdId);
   if (cmd) {
     if (cmd.description) {
-      cmd.description = marked(cmd.description).trim();
+      cmd.description = marked.parse(cmd.description).trim();
     }
     // TODO: Do the same for flag descriptions?
   }

package/src/oclif/hooks/versionInfo.js

@@ -18,7 +18,7 @@ module.exports = (options) => {
       `* CLI version: ${options.config.version}`,
       `* Node.js version: ${process.version}`,
       `* OS info: ${options.config.platform}-${options.config.arch}`,
-    ].join('\n')
+    ].join('\n'),
   );
 
   try {
@@ -28,7 +28,7 @@ module.exports = (options) => {
     const maybeCoreDepVersion = get(pJson, ['dependencies', PLATFORM_PACKAGE]);
     if (maybeCoreDepVersion) {
       console.log(
-        `* \`${PLATFORM_PACKAGE}\` dependency: ${maybeCoreDepVersion}`
+        `* \`${PLATFORM_PACKAGE}\` dependency: ${maybeCoreDepVersion}`,
       );
     }
   } catch {}

package/src/utils/analytics.js

@@ -2,6 +2,7 @@ const { callAPI } = require('./api');
 // const { readFile } = require('./files');
 const debug = require('debug')('zapier:analytics');
 const pkg = require('../../package.json');
+const { getLinkedAppConfig } = require('../utils/api');
 const { ANALYTICS_KEY, ANALYTICS_MODES, IS_TESTING } = require('../constants');
 const { readUserConfig, writeUserConfig } = require('./userConfig');
 
@@ -27,18 +28,30 @@ const recordAnalytics = async (command, isValidCommand, args, flags) => {
     debug('skipping analytics');
     return;
   }
-
+  const argKeys = Object.keys(args);
+  const flagKeys = Object.keys(flags);
   const shouldRecordAnonymously = analyticsMode === ANALYTICS_MODES.anonymous;
 
+  const integrationIDKey = argKeys.find(
+    (key) => key.toLowerCase() === 'integrationid',
+  );
+  const integrationID = integrationIDKey ? args[integrationIDKey] : undefined;
+
+  // Some commands ( like "zapier convert" ) won't have an app directory when called.
+  // Instead, having the app ID in the arguments.
+  // In this case, we fallback to using "integrationid" in arguments ( if it's there )
+  // and don't want to "explode" if appID is missing
+  const linkedAppId =
+    (await getLinkedAppConfig(undefined, false))?.id || integrationID;
+
   // to make this more testable, we should split this out into its own function
   const analyticsBody = {
     command,
     isValidCommand,
-    numArgs: args.length,
-    flags: {
-      ...flags,
-      ...(command === 'help' ? { helpCommand: args[0] } : {}), // include the beginning of args so we know what they want help on
-    },
+    numArgs: argKeys.length,
+    appId: linkedAppId,
+    argsKeys: argKeys,
+    flagKeys: flagKeys,
     cliVersion: pkg.version,
     os: shouldRecordAnonymously ? undefined : process.platform,
   };
@@ -54,7 +67,7 @@ const recordAnalytics = async (command, isValidCommand, args, flags) => {
       skipDeployKey: shouldRecordAnonymously,
     },
     true,
-    false
+    false,
   )
     .then(({ success }) => debug('success:', success))
     .catch(({ errText }) => debug('err:', errText));