zapier-platform-cli 12.2.1 → 14.0.0

package/src/oclif/commands/convert.js

@@ -5,72 +5,37 @@ const { callAPI } = require('../../utils/api');
 const { convertApp } = require('../../utils/convert');
 const { isExistingEmptyDir } = require('../../utils/files');
 const { initApp } = require('../../utils/init');
-const { BASE_ENDPOINT } = require('../../constants');
 
 const { flags } = require('@oclif/command');
 
 class ConvertCommand extends BaseCommand {
-  generateCreateFunc(isVisual, appId, version) {
+  generateCreateFunc(appId, version) {
     return async (tempAppDir) => {
-      if (isVisual) {
-        // has info about the app, such as title
-        // has a CLI version of the actual app implementation
-        this.throwForInvalidVersion(version);
-        this.startSpinner('Downloading integration from Zapier');
-        try {
-          const [appInfo, versionInfo] = await Promise.all([
-            callAPI(`/apps/${appId}`, undefined, true),
-            callAPI(`/apps/${appId}/versions/${version}`, undefined, true),
-          ]);
-
-          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.`
-            );
-          }
-          this.stopSpinner();
-
-          return convertApp(
-            appInfo,
-            versionInfo.definition_override,
-            tempAppDir
+      // has info about the app, such as title
+      // has a CLI version of the actual app implementation
+      this.throwForInvalidVersion(version);
+      this.startSpinner('Downloading integration from Zapier');
+      try {
+        const [appInfo, versionInfo] = await Promise.all([
+          callAPI(`/apps/${appId}`, undefined, true),
+          callAPI(`/apps/${appId}/versions/${version}`, undefined, true),
+        ]);
+
+        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.`
           );
-        } catch (e) {
-          if (e.status === 404) {
-            this.error(
-              `Visual Builder integration ${appId} @ ${version} not found. If you want to convert a Legacy Web Builder app, don't pass a \`--version\` option. Otherwise, double check the integration id and version.`
-            );
-          }
-          this.error(e);
         }
-      } else {
-        // has info about the app, such as title
-        const legacyDumpUrl = `${BASE_ENDPOINT}/api/developer/v1/apps/${appId}/dump`;
-        // has a CLI version of the actual app implementation
-        const cliDumpUrl = `${BASE_ENDPOINT}/api/developer/v1/apps/${appId}/cli-dump`;
-
-        this.startSpinner('Downloading integration from Zapier');
-
-        try {
-          const [legacyApp, appDefinition] = await Promise.all([
-            // these have weird call signatures because we're not calling the platform api
-            callAPI(null, { url: legacyDumpUrl }, true),
-            callAPI(null, { url: cliDumpUrl }, true),
-          ]);
-          // The JSON dump of the app doesn't have app ID, let's add it here
-          legacyApp.general.app_id = appId;
+        this.stopSpinner();
 
-          this.stopSpinner();
-
-          return convertApp(legacyApp, appDefinition, tempAppDir);
-        } catch (e) {
-          if (e.status === 404) {
-            this.error(
-              `Legacy Web Builder app ${appId} not found. If you want to convert a Visual Builder integration, make sure to pass a \`--version\` option.`
-            );
-          }
-          this.error(e);
+        return convertApp(appInfo, versionInfo.definition_override, tempAppDir);
+      } catch (e) {
+        if (e.status === 404) {
+          this.error(
+            `Visual Builder integration ${appId} @ ${version} not found. Double check the integration id and version.`
+          );
         }
+        this.error(e.json.errors[0]);
       }
     };
   }
@@ -83,7 +48,6 @@ class ConvertCommand extends BaseCommand {
         'You must provide an integrationId. See zapier convert --help for more info.'
       );
     }
-    const isVisual = Boolean(this.flags.version);
 
     if (
       (await isExistingEmptyDir(path)) &&
@@ -92,7 +56,7 @@ class ConvertCommand extends BaseCommand {
       this.exit();
     }
 
-    await initApp(path, this.generateCreateFunc(isVisual, appId, version));
+    await initApp(path, this.generateCreateFunc(appId, version));
   }
 }
 
@@ -100,7 +64,7 @@ ConvertCommand.args = [
   {
     name: 'integrationId',
     required: true,
-    description: `To get the integration/app ID, go to "${BASE_ENDPOINT}/app/developer", click on an integration, and copy the number directly after "/app/" in the URL.`,
+    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),
   },
   {
@@ -116,14 +80,13 @@ ConvertCommand.flags = buildFlags({
       char: 'v',
       description:
         'Convert a specific version. Required when converting a Visual Builder integration.',
+      required: true,
     }),
   },
 });
-ConvertCommand.description = `Convert a Legacy Web Builder app or Visual Builder integration to a CLI integration.
-
-If you're converting a **Legacy Web Builder** app: the new integration will have a dependency named zapier-platform-legacy-scripting-runner, a shim used to simulate behaviors that are specific to Legacy Web Builder. There could be differences on how the shim simulates and how Legacy Web Builder actually behaves on some edge cases, especially you have custom scripting code.
+ConvertCommand.description = `Convert a Visual Builder integration to a CLI integration.
 
-If you're converting a **Visual Builder** app, then it will be identical and ready to push and use immediately!
+The resulting CLI integration will be identical to its Visual Builder version and ready to push and use immediately!
 
 If you re-run this command on an existing directory it will leave existing files alone and not clobber them.
 

package/src/oclif/commands/link.js

@@ -31,7 +31,7 @@ class LinkCommand extends BaseCommand {
         })),
         (app) => app.name.toLowerCase()
       ),
-      15
+      { pageSize: 15 }
     );
 
     this.startSpinner(`Setting up ${CURRENT_APP_FILE}`);

package/src/oclif/commands/promote.js

@@ -7,6 +7,7 @@ const { buildFlags } = require('../buildFlags');
 const { callAPI } = require('../../utils/api');
 const { flattenCheckResult } = require('../../utils/display');
 const { getVersionChangelog } = require('../../utils/changelog');
+const checkMissingAppInfo = require('../../utils/check-missing-app-info');
 
 const serializeErrors = (errors) => {
   const opener = 'Promotion failed for the following reasons:\n\n';
@@ -15,7 +16,7 @@ const serializeErrors = (errors) => {
     return opener + errors.map((e) => `* ${e}`).join('\n');
   }
 
-  const issues = flattenCheckResult({ errors: errors });
+  const issues = flattenCheckResult({ errors });
   return (
     opener +
     issues
@@ -28,6 +29,8 @@ class PromoteCommand extends BaseCommand {
   async perform() {
     const app = await this.getWritableApp();
 
+    checkMissingAppInfo(app);
+
     const version = this.args.version;
     const assumeYes = 'yes' in this.flags;
 

package/src/oclif/commands/register.js

@@ -1,26 +1,238 @@
+const colors = require('colors/safe');
+const { flags } = require('@oclif/command');
+
 const ZapierBaseCommand = require('../ZapierBaseCommand');
-const { CURRENT_APP_FILE } = require('../../constants');
+const { CURRENT_APP_FILE, MAX_DESCRIPTION_LENGTH } = require('../../constants');
 const { buildFlags } = require('../buildFlags');
-const { callAPI, writeLinkedAppConfig } = require('../../utils/api');
+const {
+  callAPI,
+  getLinkedAppConfig,
+  getWritableApp,
+  isPublished,
+  writeLinkedAppConfig,
+} = require('../../utils/api');
 
 class RegisterCommand extends ZapierBaseCommand {
+  /**
+   * Entry point function that runs when user runs `zapier register`
+   */
   async perform() {
-    let title = this.args.title;
-    if (!title) {
-      title = await this.prompt('What is the title of your integration?');
-    }
-
-    this.startSpinner(`Registering your new integration "${title}"`);
-    const app = await callAPI('/apps', { method: 'POST', body: { title } });
-    this.stopSpinner();
-    this.startSpinner(
-      `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`!'
-    );
+    // Flag validation
+    this._validateEnumFlags();
+    if (
+      'desc' in this.flags &&
+      this.flags.desc.length > MAX_DESCRIPTION_LENGTH
+    ) {
+      throw new Error(
+        `Please provide a description that is ${MAX_DESCRIPTION_LENGTH} characters or less.`
+      );
+    }
+
+    const { appMeta, action } = await this._promptForAppMeta();
+
+    switch (action) {
+      case 'update': {
+        this.startSpinner(
+          `Updating your existing integration "${appMeta.title}"`
+        );
+        await callAPI(`/apps/${this.app.id}`, {
+          method: 'PUT',
+          body: appMeta,
+        });
+        this.stopSpinner();
+        this.log('\nIntegration successfully updated!');
+        break;
+      }
+
+      case 'register': {
+        this.startSpinner(
+          `Registering your new integration "${appMeta.title}"`
+        );
+        const app = await callAPI('/apps?formId=create', {
+          method: 'POST',
+          body: appMeta,
+        });
+        this.stopSpinner();
+        this.startSpinner(
+          `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`!'
+        );
+        break;
+      }
+    }
+  }
+
+  /**
+   * Validates values provided for enum flags against options retrieved from the BE
+   * (see getAppRegistrationFieldChoices hook for more details)
+   */
+  _validateEnumFlags() {
+    const flagFieldMappings = {
+      audience: 'intention',
+      role: 'role',
+      category: 'app_category',
+    };
+
+    for (const [flag, flagValue] of Object.entries(this.flags)) {
+      // Only validate user input for enum flags (in flagFieldMappings)
+      if (!flagFieldMappings[flag]) {
+        continue;
+      }
+
+      // Check user input against this.config.enumFieldChoices (retrieved in getAppRegistrationFieldChoices hook)
+      const enumFieldChoices =
+        this.config.enumFieldChoices[flagFieldMappings[flag]];
+      if (!enumFieldChoices.find((option) => option.value === flagValue)) {
+        throw new Error(
+          `${flagValue} is not a valid value for ${flag}. Must be one of the following: ${enumFieldChoices
+            .map((option) => option.value)
+            .join(', ')}`
+        );
+      }
+    }
+  }
+
+  /**
+   * Prompts user for values that have not been provided
+   * Flags can heavily impact the behavior of this function
+   * @returns { appMeta: {object}, action: string }
+   */
+  async _promptForAppMeta() {
+    const appMeta = {};
+
+    const actionChoices = [
+      { name: 'Yes, update current integration', value: 'update' },
+      { name: 'No, register a new integration', value: 'register' },
+    ];
+
+    let action = actionChoices[1].value; // Default action is register
+
+    const linkedAppId = (await getLinkedAppConfig(undefined, false))?.id;
+    if (linkedAppId) {
+      console.info(colors.yellow(`${CURRENT_APP_FILE} file detected.`));
+      if (this.flags.yes) {
+        console.info(
+          colors.yellow(
+            `-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
+        );
+      }
+    }
+
+    if (action === 'update') {
+      this.startSpinner('Retrieving details for your integration');
+      this.app = await getWritableApp();
+      this.stopSpinner();
+
+      // 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."
+        );
+      }
+    }
+
+    appMeta.title = this.args.title?.trim();
+    if (!appMeta.title) {
+      appMeta.title = await this.prompt(
+        'What is the title of your integration?',
+        {
+          required: true,
+          default: this.app?.title,
+        }
+      );
+    }
+
+    appMeta.description = this.flags.desc?.trim();
+    if (!appMeta.description) {
+      appMeta.description = await this.prompt(
+        `Please provide a sentence describing your app in ${MAX_DESCRIPTION_LENGTH} characters or less.`,
+        {
+          required: true,
+          charLimit: MAX_DESCRIPTION_LENGTH,
+          default: this.app?.description,
+        }
+      );
+    }
+
+    appMeta.homepage_url = this.flags.url;
+    if (!appMeta.homepage_url) {
+      appMeta.homepage_url = await this.prompt(
+        'What is the homepage URL of your app? (optional)',
+        { default: this.app?.homepage_url }
+      );
+    }
+
+    appMeta.intention = this.flags.audience;
+    if (!appMeta.intention) {
+      appMeta.intention = await this.promptWithList(
+        'Are you building a public or private integration?',
+        this.config.enumFieldChoices.intention,
+        { default: this.app?.intention }
+      );
+    }
+
+    appMeta.role = this.flags.role;
+    if (!appMeta.role) {
+      appMeta.role = await this.promptWithList(
+        "What is your relationship with the app you're integrating with Zapier?",
+        this._getRoleChoicesWithAppTitle(
+          appMeta.title,
+          this.config.enumFieldChoices.role
+        ),
+        { default: this.app?.role }
+      );
+    }
+
+    appMeta.app_category = this.flags.category;
+    if (!appMeta.app_category) {
+      appMeta.app_category = await this.promptWithList(
+        'How would you categorize your app?',
+        this.config.enumFieldChoices.app_category,
+        { default: this.app?.app_category }
+      );
+    }
+
+    if (action === 'register') {
+      appMeta.subscription = this.flags.subscribe;
+      if (typeof this.flags.yes !== 'undefined') {
+        appMeta.subscription = true;
+      } else if (typeof appMeta.subscription === 'undefined') {
+        // boolean field, so using `typeof` === `undefined`
+        appMeta.subscription = await this.promptWithList(
+          'Subscribe to Updates about your Integration',
+          [
+            { name: 'Yes', value: true },
+            { name: 'No', value: false },
+          ]
+        );
+      }
+    }
+
+    return { appMeta, action };
+  }
+
+  /**
+   *
+   * @param {string} title title of integration
+   * @param {array} choices retrieved role choices with `[app_title]` tokens
+   * @returns {array} array of choices with integration titles (instead of `[app_title]` tokens)
+   */
+  _getRoleChoicesWithAppTitle(title, choices) {
+    return choices.map((choice) => ({
+      value: choice.value,
+      name: choice.name.replace('[app_title]', title),
+    }));
   }
 }
 
@@ -32,15 +244,55 @@ RegisterCommand.args = [
       "Your integrations's public title. Asked interactively if not present.",
   },
 ];
-RegisterCommand.flags = buildFlags();
+
+RegisterCommand.flags = buildFlags({
+  commandFlags: {
+    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({
+      char: 'u',
+      description: 'The homepage URL of your app, e.g., https://example.com.',
+    }),
+    audience: flags.string({
+      char: 'a',
+      description: 'Are you building a public or private integration?',
+    }),
+    role: flags.string({
+      char: 'r',
+      description:
+        "What is your relationship with the app you're integrating with Zapier?",
+    }),
+    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({
+      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({
+      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.',
+    }),
+  },
+});
 RegisterCommand.examples = [
   'zapier register',
   'zapier register "My Cool Integration"',
+  'zapier register "My Cool Integration" --desc "My Cool Integration helps you integrate your apps with the apps that you need." --no-subscribe',
+  'zapier register "My Cool Integration" --url "https://www.zapier.com" --audience private --role employee --category marketing-automation',
+  'zapier register --subscribe',
 ];
-RegisterCommand.description = `Register a new integration in your account.
+RegisterCommand.description = `Register a new integration in your account, or update the existing one if a \`${CURRENT_APP_FILE}\` file is found.
 
-After running this, you can run \`zapier push\` to build and upload your integration for use in the Zapier editor.
+This command creates a new integration and links it in the \`./${CURRENT_APP_FILE}\` file. If \`${CURRENT_APP_FILE}\` already exists, it will ask you if you want to update the currently-linked integration, as opposed to creating a new one.
 
-This will change the  \`./${CURRENT_APP_FILE}\` (which identifies this directory as holding code for a specific integration).`;
+After registering a new integration, you can run \`zapier push\` to build and upload your integration for use in the Zapier editor. This will change \`${CURRENT_APP_FILE}\`, which identifies this directory as holding code for a specific integration.`;
 
 module.exports = RegisterCommand;

package/src/oclif/hooks/getAppRegistrationFieldChoices.js

@@ -0,0 +1,45 @@
+const { callAPI } = require('../../utils/api');
+
+module.exports = async function (options) {
+  // We only need to run this for the register command
+  if (!options || !options.id || options.id !== 'register') {
+    return null;
+  }
+
+  const enumFieldChoices = {};
+  let formFields;
+
+  try {
+    formFields = await callAPI('/apps/fields-choices');
+  } catch (e) {
+    this.error(
+      `Unable to connect to Zapier API. Please check your connection and try again. ${e}`
+    );
+  }
+
+  for (const fieldName of ['intention', 'role', 'app_category']) {
+    enumFieldChoices[fieldName] = formFields[fieldName];
+  }
+
+  this.config.enumFieldChoices = enumFieldChoices;
+
+  // This enables us to see all available options when running `zapier register --help`
+  const cmd = options.config.findCommand('register');
+  if (cmd && cmd.flags) {
+    if (cmd.flags.audience) {
+      cmd.flags.audience.options = formFields.intention.map(
+        (audienceOption) => audienceOption.value
+      );
+    }
+    if (cmd.flags.role) {
+      cmd.flags.role.options = formFields.role.map(
+        (roleOption) => roleOption.value
+      );
+    }
+    if (cmd.flags.category) {
+      cmd.flags.category.options = formFields.app_category.map(
+        (categoryOption) => categoryOption.value
+      );
+    }
+  }
+};

package/src/utils/api.js

@@ -265,6 +265,12 @@ const getVersionInfo = () => {
   });
 };
 
+// Intended to match logic of https://gitlab.com/zapier/team-developer-platform/dev-platform/-/blob/9fa28d8bacd04ebdad5937bd039c71aede4ede47/web/frontend/assets/app/entities/CliApp/CliApp.ts#L96
+const isPublished = (appStatus) => {
+  const publishedStatuses = ['public', 'beta'];
+  return publishedStatuses.indexOf(appStatus) > -1;
+};
+
 const listApps = async () => {
   let linkedApp;
   try {
@@ -405,6 +411,7 @@ module.exports = {
   getLinkedAppConfig,
   getWritableApp,
   getVersionInfo,
+  isPublished,
   listApps,
   listEndpoint,
   listEndpointMulti,

package/src/utils/build.js

@@ -43,6 +43,8 @@ const {
   validateApp,
 } = require('./api');
 
+const checkMissingAppInfo = require('./check-missing-app-info');
+
 const { runCommand, isWindows } = require('./misc');
 
 const debug = require('debug')('zapier:build');
@@ -167,6 +169,7 @@ const forceIncludeDumbPath = (appConfig, filePath) => {
     // include old async deasync versions so this runs seamlessly across node versions
     filePath.endsWith(path.join('bin', 'linux-x64-node-10', 'deasync.node')) ||
     filePath.endsWith(path.join('bin', 'linux-x64-node-12', 'deasync.node')) ||
+    filePath.endsWith(path.join('bin', 'linux-x64-node-14', 'deasync.node')) ||
     filePath.endsWith(
       // Special, for zapier-platform-legacy-scripting-runner
       path.join('bin', `linux-x64-node-${nodeMajorVersion}`, 'deasync.node')
@@ -497,6 +500,7 @@ const buildAndOrUpload = async (
   let app;
   if (upload) {
     app = await getWritableApp();
+    checkMissingAppInfo(app);
   }
 
   if (build) {

package/src/utils/check-missing-app-info.js

@@ -0,0 +1,26 @@
+const { isPublished } = require('../utils/api');
+
+module.exports = (app) => {
+  if (app.status && isPublished(app.status)) {
+    return false;
+  }
+  const requiredFields = [
+    { apiName: 'title' },
+    { apiName: 'description' },
+    { apiName: 'app_category', cliName: 'category' },
+    { apiName: 'intention', cliName: 'audience' },
+    { apiName: 'role' },
+  ];
+  const missingRequiredFields = requiredFields.filter(
+    (field) => app[field.apiName] == null
+  );
+  if (missingRequiredFields.length) {
+    throw new Error(
+      `Your integration is missing required info (${missingRequiredFields
+        .map((field) => field.cliName ?? field.apiName)
+        .join(', ')}). Please, run "zapier register" to add it.`
+    );
+  }
+
+  return false;
+};

package/src/version-store.js

@@ -15,5 +15,5 @@ module.exports = [
   { nodeVersion: '12', npmVersion: '>=5.6.0' }, // 10.x
   { nodeVersion: '14', npmVersion: '>=5.6.0' }, // 11.x
   { nodeVersion: '14', npmVersion: '>=5.6.0' }, // 12.x
-  // { nodeVersion: '16', npmVersion: '>=5.6.0' }, // 13.x
+  { nodeVersion: '16', npmVersion: '>=5.6.0' }, // 13.x
 ];