PDE-3732 feat(cli): Implement individual field flags for register command

docs/cli.html

@@ -893,6 +893,12 @@ <h2 id="register">register</h2>
 </blockquote><p><strong>Usage</strong>: <code>zapier register [TITLE]</code></p><p>After running this, you can run <code>zapier push</code> to build and upload your integration for use in the Zapier editor.</p><p>This will change the  <code>./.zapierapprc</code> (which identifies this directory as holding code for a specific integration).</p><p><strong>Arguments</strong></p><ul>
 <li><code>title</code> | Your integrations&apos;s public title. Asked interactively if not present.</li>
 </ul><p><strong>Flags</strong></p><ul>
+<li><code>-D, --desc</code> | A sentence describing your app in 140 characters or less, e.g. &quot;Trello is a team collaboration tool to organize tasks and keep projects on track.&quot;</li>
+<li><code>-u, --url</code> | The homepage URL of your app, e.g., <a href="https://example.com">https://example.com</a>.</li>
+<li><code>-a, --audience</code> | Are you building a public or private integration?</li>
+<li><code>-r, --role</code> | What is your relationship with the app you&apos;re integrating with Zapier?</li>
+<li><code>-c, --category</code> | How would you categorize your app? Choose the most appropriate option for your app&apos;s core features.</li>
+<li><code>-s, --subscribe</code> | Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.</li>
 <li><code>-d, --debug</code> | Show extra debugging output.</li>
 </ul><p><strong>Examples</strong></p><ul>
 <li><code>zapier register</code></li>

docs/cli.md

@@ -445,6 +445,12 @@ This will change the  `./.zapierapprc` (which identifies this directory as holdi
 * `title` | Your integrations's public title. Asked interactively if not present.
 
 **Flags**
+* `-D, --desc` | A sentence describing your app in 140 characters or less, e.g. "Trello is a team collaboration tool to organize tasks and keep projects on track."
+* `-u, --url` | The homepage URL of your app, e.g., https://example.com.
+* `-a, --audience` | Are you building a public or private integration?
+* `-r, --role` | What is your relationship with the app you're integrating with Zapier?
+* `-c, --category` | How would you categorize your app? Choose the most appropriate option for your app's core features.
+* `-s, --subscribe` | Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.
 * `-d, --debug` | Show extra debugging output.
 
 **Examples**

packages/cli/docs/cli.html

@@ -893,6 +893,12 @@ <h2 id="register">register</h2>
 </blockquote><p><strong>Usage</strong>: <code>zapier register [TITLE]</code></p><p>After running this, you can run <code>zapier push</code> to build and upload your integration for use in the Zapier editor.</p><p>This will change the  <code>./.zapierapprc</code> (which identifies this directory as holding code for a specific integration).</p><p><strong>Arguments</strong></p><ul>
 <li><code>title</code> | Your integrations&apos;s public title. Asked interactively if not present.</li>
 </ul><p><strong>Flags</strong></p><ul>
+<li><code>-D, --desc</code> | A sentence describing your app in 140 characters or less, e.g. &quot;Trello is a team collaboration tool to organize tasks and keep projects on track.&quot;</li>
+<li><code>-u, --url</code> | The homepage URL of your app, e.g., <a href="https://example.com">https://example.com</a>.</li>
+<li><code>-a, --audience</code> | Are you building a public or private integration?</li>
+<li><code>-r, --role</code> | What is your relationship with the app you&apos;re integrating with Zapier?</li>
+<li><code>-c, --category</code> | How would you categorize your app? Choose the most appropriate option for your app&apos;s core features.</li>
+<li><code>-s, --subscribe</code> | Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.</li>
 <li><code>-d, --debug</code> | Show extra debugging output.</li>
 </ul><p><strong>Examples</strong></p><ul>
 <li><code>zapier register</code></li>

packages/cli/docs/cli.md

@@ -445,6 +445,12 @@ This will change the  `./.zapierapprc` (which identifies this directory as holdi
 * `title` | Your integrations's public title. Asked interactively if not present.
 
 **Flags**
+* `-D, --desc` | A sentence describing your app in 140 characters or less, e.g. "Trello is a team collaboration tool to organize tasks and keep projects on track."
+* `-u, --url` | The homepage URL of your app, e.g., https://example.com.
+* `-a, --audience` | Are you building a public or private integration?
+* `-r, --role` | What is your relationship with the app you're integrating with Zapier?
+* `-c, --category` | How would you categorize your app? Choose the most appropriate option for your app's core features.
+* `-s, --subscribe` | Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.
 * `-d, --debug` | Show extra debugging output.
 
 **Examples**

packages/cli/package.json

@@ -59,6 +59,7 @@
     "lodash": "4.17.21",
     "marked": "4.2.12",
     "marked-terminal": "5.1.1",
+    "nock": "^13.3.0",
     "node-fetch": "2.6.7",
     "ora": "5.4.0",
     "parse-gitignore": "0.5.1",
@@ -78,7 +79,6 @@
     "litdoc": "1.5.6",
     "markdown-toc": "^1",
     "mock-fs": "^5.2.0",
-    "nock": "^13.3.0",
     "stdout-stderr": "0.1.13",
     "yamljs": "0.3.0"
   },

packages/cli/src/oclif/ZapierBaseCommand.js

@@ -159,6 +159,10 @@ class ZapierBaseCommand extends Command {
    * @param {object} opts `inquierer.js` opts ([read more](https://github.com/SBoudrias/Inquirer.js/#question))
    */
   async prompt(question, opts = {}) {
+    if (typeof opts.required !== 'undefined' && opts.required) {
+      opts.validate = (input) =>
+        input.trim() === '' ? 'This field is required.' : true;
+    }
     const { ans } = await inquirer.prompt({
       type: 'string',
       ...opts,

packages/cli/src/oclif/commands/register.js

@@ -3,15 +3,15 @@ const { CURRENT_APP_FILE } = require('../../constants');
 const { buildFlags } = require('../buildFlags');
 const { callAPI, writeLinkedAppConfig } = require('../../utils/api');
 
+const { flags } = require('@oclif/command');
+
 class RegisterCommand extends ZapierBaseCommand {
   async perform() {
-    let title = this.args.title;
-    if (!title) {
-      title = await this.prompt('What is the title of your integration?');
-    }
+    this._validateEnumFlags();
+    const appMeta = await this._promptForAppMeta();
 
-    this.startSpinner(`Registering your new integration "${title}"`);
-    const app = await callAPI('/apps', { method: 'POST', body: { title } });
+    this.startSpinner(`Registering your new integration "${appMeta.title}"`);
+    const app = await callAPI('/apps', { method: 'POST', body: appMeta });
     this.stopSpinner();
     this.startSpinner(
       `Linking app to current directory with \`${CURRENT_APP_FILE}\``
@@ -22,6 +22,112 @@ class RegisterCommand extends ZapierBaseCommand {
       '\nFinished! Now that your integration is registered with Zapier, you can `zapier push`!'
     );
   }
+
+  _validateEnumFlags() {
+    const flagFieldMappings = {
+      audience: 'intention',
+      role: 'role',
+      category: 'app_category',
+    };
+
+    for (const flag of Object.keys(this.flags)) {
+      // Only validate user input for enum flags (in flagFieldMappings)
+      if (!Object.prototype.hasOwnProperty.call(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 === this.flags[flag])
+      ) {
+        throw new Error(
+          `${
+            this.flags[flag]
+          } is not a valid value for ${flag}. Must be one of the following: ${enumFieldChoices
+            .map((option) => option.value)
+            .join(', ')}`
+        );
+      }
+    }
+  }
+
+  async _promptForAppMeta() {
+    const appMeta = {};
+
+    appMeta.title = this.args.title?.trim();
+    if (!appMeta.title) {
+      appMeta.title = await this.prompt(
+        'What is the title of your integration?',
+        { required: true }
+      );
+    }
+
+    appMeta.description = this.flags.desc?.trim();
+    if (!appMeta.description) {
+      appMeta.description = await this.prompt(
+        'Please provide a sentence describing your app in 140 characters or less.',
+        { required: true }
+      );
+    }
+
+    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)'
+      );
+    }
+
+    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
+      );
+    }
+
+    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
+        )
+      );
+    }
+
+    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
+      );
+    }
+
+    appMeta.subscription = this.flags.subscribe;
+    // boolean field, so using `typeof` === `undefined`
+    if (typeof appMeta.subscription === 'undefined') {
+      appMeta.subscription = await this.promptWithList(
+        'Subscribe to Updates about your Integration',
+        [
+          { name: 'Yes', value: true },
+          { name: 'No', value: false },
+        ]
+      );
+    }
+
+    return appMeta;
+  }
+
+  _getRoleChoicesWithAppTitle(title, choices) {
+    return choices.map((choice) => ({
+      value: choice.value,
+      name: choice.name.replace('[app_title]', title),
+    }));
+  }
 }
 
 RegisterCommand.skipValidInstallCheck = true;
@@ -32,7 +138,42 @@ 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 140 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,
+    }),
+  },
+});
 RegisterCommand.examples = [
   'zapier register',
   'zapier register "My Cool Integration"',