zapier-platform-cli 15.18.1 → 16.0.0

package/src/oclif/commands/scaffold.js

@@ -1,13 +1,16 @@
+/* eslint-disable camelcase */
+// @ts-check
+
 const path = require('path');
+const fs = require('fs');
 
-const { flags } = require('@oclif/command');
+const { Args, Flags } = require('@oclif/core');
 
 const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
 
 const {
-  createTemplateContext,
-  getRelativeRequirePath,
+  createScaffoldingContext,
   plural,
   updateEntryFile,
   isValidEntryFileUpdate,
@@ -18,127 +21,90 @@ const { isValidAppInstall } = require('../../utils/misc');
 const { writeFile } = require('../../utils/files');
 const { ISSUES_URL } = require('../../constants');
 
-const getNewFileDirectory = (action, test = false) =>
-  path.join(test ? 'test/' : '', plural(action));
-
-const getLocalFilePath = (directory, actionKey) =>
-  path.join(directory, actionKey);
-/**
- * both the string to `require` and later, the filepath to write to
- */
-const getFullActionFilePath = (directory, actionKey) =>
-  path.join(process.cwd(), getLocalFilePath(directory, actionKey));
-
-const getFullActionFilePathWithExtension = (directory, actionKey, isTest) =>
-  `${getFullActionFilePath(directory, actionKey)}${isTest ? '.test' : ''}.js`;
-
 class ScaffoldCommand extends BaseCommand {
   async perform() {
     const { actionType, noun } = this.args;
-
-    // TODO: interactive portion here?
+    const indexFileLocal = this.flags.entry ?? this.defaultIndexFileLocal();
     const {
-      dest: newActionDir = getNewFileDirectory(actionType),
-      testDest: newTestActionDir = getNewFileDirectory(actionType, true),
-      entry = 'index.js',
+      dest: actionDirLocal = this.defaultActionDirLocal(indexFileLocal),
+      'test-dest': testDirLocal = this.defaultTestDirLocal(indexFileLocal),
       force,
     } = this.flags;
 
-    // this is possible, just extra work that's out of scope
-    // const tsParser = j.withParser('ts')
-    // tsParser(codeStr)
-    // will have to change logic probably though
-    if (entry.endsWith('ts')) {
-      this.error(
-        `Typescript isn't supported for scaffolding yet. Instead, try copying the example code at https://github.com/zapier/zapier-platform/blob/b8224ec9855be91c66c924b731199a068b1e913a/example-apps/typescript/src/resources/recipe.ts`
-      );
-    }
+    const language = indexFileLocal.endsWith('.ts') ? 'ts' : 'js';
 
-    const shouldIncludeComments = !this.flags['no-help']; // when called from other commands (namely `init`) this will be false
-    const templateContext = createTemplateContext(
+    const context = createScaffoldingContext({
       actionType,
       noun,
-      shouldIncludeComments
-    );
-
-    const actionKey = templateContext.KEY;
+      language,
+      indexFileLocal,
+      actionDirLocal,
+      testDirLocal,
+      includeIntroComments: !this.flags['no-help'],
+      preventOverwrite: !force,
+    });
 
-    const preventOverwrite = !force;
     // TODO: read from config file?
 
-    this.startSpinner(
-      `Creating new file: ${getLocalFilePath(newActionDir, actionKey)}.js`
-    );
-    await writeTemplateFile(
-      actionType,
-      templateContext,
-      getFullActionFilePathWithExtension(newActionDir, actionKey),
-      preventOverwrite
-    );
+    this.startSpinner(`Creating new file: ${context.actionFileLocal}`);
+
+    await writeTemplateFile({
+      destinationPath: context.actionFileResolved,
+      templateType: context.actionType,
+      language: context.language,
+      preventOverwrite: context.preventOverwrite,
+      templateContext: context.templateContext,
+    });
     this.stopSpinner();
 
-    this.startSpinner(
-      `Creating new test file: ${getLocalFilePath(
-        newTestActionDir,
-        actionKey
-      )}.js`
-    );
-    await writeTemplateFile(
-      'test',
-      templateContext,
-      getFullActionFilePathWithExtension(newTestActionDir, actionKey, true),
-      preventOverwrite
-    );
+    this.startSpinner(`Creating new test file: ${context.testFileLocal}`);
+    await writeTemplateFile({
+      destinationPath: context.testFileResolved,
+      templateType: 'test',
+      language: context.language,
+      preventOverwrite: context.preventOverwrite,
+      templateContext: context.templateContext,
+    });
     this.stopSpinner();
 
     // * rewire the index.js to point to the new file
-    this.startSpinner(`Rewriting your ${entry}`);
-
-    const entryFilePath = path.join(process.cwd(), entry);
+    this.startSpinner(`Rewriting your ${context.indexFileLocal}`);
 
-    const originalContents = await updateEntryFile(
-      entryFilePath,
-      templateContext.VARIABLE,
-      getFullActionFilePath(newActionDir, actionKey),
-      actionType,
-      templateContext.KEY
-    );
+    const originalContents = await updateEntryFile({
+      language: context.language,
+      indexFileResolved: context.indexFileResolved,
+      actionRelativeImportPath: context.actionRelativeImportPath,
+      actionImportName: context.templateContext.VARIABLE,
+      actionType: context.actionType,
+    });
 
     if (isValidAppInstall().valid) {
       const success = isValidEntryFileUpdate(
-        entryFilePath,
-        actionType,
-        templateContext.KEY
+        context.language,
+        context.indexFileResolved,
+        context.actionType,
+        context.templateContext.KEY,
       );
 
       this.stopSpinner({ success });
 
       if (!success) {
-        const entryName = splitFileFromPath(entryFilePath)[1];
+        const entryName = splitFileFromPath(context.indexFileResolved)[1];
 
         this.startSpinner(
-          `Unable to successfully rewrite your ${entryName}. Rolling back...`
+          `Unable to successfully rewrite your ${entryName}. Rolling back...`,
         );
-        await writeFile(entryFilePath, originalContents);
+        await writeFile(context.indexFileResolved, originalContents);
         this.stopSpinner();
 
         this.error(
           [
-            `\nPlease add the following lines to ${entryFilePath}:`,
-            ` * \`const ${
-              templateContext.VARIABLE
-            } = require('./${getRelativeRequirePath(
-              entryFilePath,
-              getFullActionFilePath(newActionDir, actionKey)
-            )}');\` at the top-level`,
-            ` * \`[${templateContext.VARIABLE}.key]: ${
-              templateContext.VARIABLE
-            }\` in the "${plural(
-              actionType
-            )}" object in your exported integration definition.`,
+            `\nPlease add the following lines to ${context.indexFileResolved}:`,
+            ` * \`const ${context.templateContext.VARIABLE} = require('./${context.actionRelativeImportPath}');\` at the top-level`,
+            ` * \`[${context.templateContext.VARIABLE}.key]: ${context.templateContext.VARIABLE}\` in the "${context.actionTypePlural}" object in your exported integration definition.`,
             '',
-            `Also, please file an issue at ${ISSUES_URL} with the contents of your ${entryFilePath}.`,
-          ].join('\n')
+            `Also, please file an issue at ${ISSUES_URL} with the contents of your ${context.indexFileResolved}.`,
+          ].join('\n'),
         );
       }
     }
@@ -146,49 +112,89 @@ class ScaffoldCommand extends BaseCommand {
     this.stopSpinner();
 
     if (!this.flags.invokedFromAnotherCommand) {
-      this.log(`\nAll done! Your new ${actionType} is ready to use.`);
+      this.log(`\nAll done! Your new ${context.actionType} is ready to use.`);
     }
   }
+
+  /**
+   * If `--entry` is not provided, this will determine the path to the
+   * root index file. Notably, we'll look for tsconfig.json and
+   * src/index.ts first, because even TS apps have a root level plain
+   * index.js that we should ignore.
+   *
+   * @returns {string}
+   */
+  defaultIndexFileLocal() {
+    const tsConfigPath = path.join(process.cwd(), 'tsconfig.json');
+    const srcIndexTsPath = path.join(process.cwd(), 'src', 'index.ts');
+    if (fs.existsSync(tsConfigPath) && fs.existsSync(srcIndexTsPath)) {
+      this.log('Automatically detected TypeScript project');
+      return 'src/index.ts';
+    }
+
+    return 'index.js';
+  }
+
+  /**
+   * If `--dest` is not provided, this will determine the directory for
+   * the new action file to be created in.
+   *
+   * @param {string} indexFileLocal - The path to the index file
+   * @returns {string}
+   */
+  defaultActionDirLocal(indexFileLocal) {
+    const parent = path.dirname(indexFileLocal);
+    return path.join(parent, plural(this.args.actionType));
+  }
+
+  /**
+   * If `--test-dest` is not provided, this will determine the directory
+   * for the new test file to be created in.
+   *
+   * @param {string} indexFileLocal - The path to the index file
+   * @returns {string}
+   */
+  defaultTestDirLocal(indexFileLocal) {
+    const parent = path.dirname(indexFileLocal);
+    return path.join(parent, 'test', plural(this.args.actionType));
+  }
 }
 
-ScaffoldCommand.args = [
-  {
-    name: 'actionType',
+ScaffoldCommand.args = {
+  actionType: Args.string({
     help: 'What type of step type are you creating?',
     required: true,
     options: ['trigger', 'search', 'create', 'resource'],
-  },
-  {
-    name: 'noun',
+  }),
+  noun: Args.string({
     help: 'What sort of object this action acts on. For example, the name of the new thing to create',
     required: true,
-  },
-];
+  }),
+};
 
 ScaffoldCommand.flags = buildFlags({
   commandFlags: {
-    dest: flags.string({
+    dest: Flags.string({
       char: 'd',
       description:
         "Specify the new file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `[triggers|searches|creates]/{noun}`.",
     }),
-    'test-dest': flags.string({
+    'test-dest': Flags.string({
       description:
         "Specify the new test file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `test/[triggers|searches|creates]/{noun}`.",
     }),
-    entry: flags.string({
+    entry: Flags.string({
       char: 'e',
       description:
-        "Supply the path to your integration's root (`index.js`). Only needed if your `index.js` is in a subfolder, like `src`.",
-      default: 'index.js',
+        "Supply the path to your integration's entry point (`index.js` or `src/index.ts`). This will try to automatically detect the correct file if not provided.",
     }),
-    force: flags.boolean({
+    force: Flags.boolean({
       char: 'f',
       description:
-        'Should we overwrite an exisiting trigger/search/create file?',
+        'Should we overwrite an existing trigger/search/create file?',
       default: false,
     }),
-    'no-help': flags.boolean({
+    'no-help': Flags.boolean({
       description:
         "When scaffolding, should we skip adding helpful intro comments? Useful if this isn't your first rodeo.",
       default: false,

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.',
     }),