zapier-platform-cli 15.18.1 → 16.0.0

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,12 +1,11 @@
 const chalk = require('chalk');
 const { marked } = require('marked');
 const TerminalRenderer = require('marked-terminal');
-const { stdtermwidth } = require('@oclif/help/lib/screen');
 
 marked.setOptions({
   renderer: new TerminalRenderer({
     tab: 2,
-    width: stdtermwidth - 2,
+    width: process.stdout.getWindowSize()[0] - 2,
     reflowText: true,
     codespan: chalk.underline.bold,
   }),

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

@@ -20,7 +20,7 @@ const shouldSkipAnalytics = (mode) =>
   process.env.DISABLE_ZAPIER_ANALYTICS ||
   mode === ANALYTICS_MODES.disabled;
 
-const recordAnalytics = async (command, isValidCommand, args, flags) => {
+const recordAnalytics = async (command, isValidCommand, argNames, flags) => {
   const analyticsMode = await currentAnalyticsMode();
 
   if (shouldSkipAnalytics(analyticsMode)) {
@@ -34,10 +34,10 @@ const recordAnalytics = async (command, isValidCommand, args, flags) => {
   const analyticsBody = {
     command,
     isValidCommand,
-    numArgs: args.length,
+    numArgs: argNames.length,
     flags: {
       ...flags,
-      ...(command === 'help' ? { helpCommand: args[0] } : {}), // include the beginning of args so we know what they want help on
+      ...(command === 'help' ? { helpCommand: argNames[0] } : {}), // include the beginning of args so we know what they want help on
     },
     cliVersion: pkg.version,
     os: shouldRecordAnonymously ? undefined : process.platform,
@@ -54,7 +54,7 @@ const recordAnalytics = async (command, isValidCommand, args, flags) => {
       skipDeployKey: shouldRecordAnonymously,
     },
     true,
-    false
+    false,
   )
     .then(({ success }) => debug('success:', success))
     .catch(({ errText }) => debug('err:', errText));

package/src/utils/api.js

@@ -32,7 +32,7 @@ const readCredentials = (explodeIfMissing = true) => {
     return Promise.resolve(
       readFile(
         constants.AUTH_LOCATION,
-        `Please run \`${colors.cyan('zapier login')}\`.`
+        `Please run \`${colors.cyan('zapier login')}\`.`,
       )
         .then((buf) => {
           return JSON.parse(buf.toString());
@@ -43,7 +43,7 @@ const readCredentials = (explodeIfMissing = true) => {
           } else {
             return {};
           }
-        })
+        }),
     );
   }
 };
@@ -54,7 +54,7 @@ const callAPI = async (
   options,
   rawError = false,
   credentialsRequired = true,
-  returnStreamBody = false
+  returnStreamBody = false,
 ) => {
   // temp manual enable while we're not all the way moved over
   if (_.get(global, ['argOpts', 'debug'])) {
@@ -149,7 +149,7 @@ const createCredentials = (username, password, totpCode) => {
       },
     },
     // if totp is empty, we want a raw request so we can supress an error. If it's here, we want it to be "non-raw"
-    !totpCode
+    !totpCode,
   );
 };
 
@@ -162,22 +162,19 @@ const createCanary = async (versionFrom, versionTo, percent, duration) => {
       method: 'POST',
       body: {
         percent,
-        duration
-      }
-    }
-  )
-}
+        duration,
+      },
+    },
+  );
+};
 
 const listCanaries = async () => {
   const linkedAppId = (await getLinkedAppConfig(undefined, true))?.id;
 
-  return callAPI(
-    `/apps/${linkedAppId}/canaries`,
-    {
-      method: 'GET',
-    }
-  )
-}
+  return callAPI(`/apps/${linkedAppId}/canaries`, {
+    method: 'GET',
+  });
+};
 
 const deleteCanary = async (versionFrom, versionTo) => {
   const linkedAppId = (await getLinkedAppConfig(undefined, true))?.id;
@@ -186,9 +183,9 @@ const deleteCanary = async (versionFrom, versionTo) => {
     `/apps/${linkedAppId}/versions/${versionFrom}/canary-to/${versionTo}`,
     {
       method: 'DELETE',
-    }
-  )
-}
+    },
+  );
+};
 
 /**
  * read local `apprc` file
@@ -242,10 +239,10 @@ const getWritableApp = async () => {
   if (!linkedAppConfig.id) {
     throw new Error(
       `This project hasn't yet been associated with an existing Zapier integration.\n\nIf it's a brand new integration, run \`${colors.cyan(
-        'zapier register'
+        'zapier register',
       )}\`.\n\nIf this project already exists in your Zapier account, run \`${colors.cyan(
-        'zapier link'
-      )}\` instead.`
+        'zapier link',
+      )}\` instead.`,
     );
   }
 
@@ -261,7 +258,7 @@ const getWritableApp = async () => {
       throw new Error(
         `Your credentials are present, but invalid${
           process.env.ZAPIER_BASE_ENDPOINT ? ' in this environment' : ''
-        }. Please run \`${colors.cyan('zapier login')}\` to resolve.`
+        }. Please run \`${colors.cyan('zapier login')}\` to resolve.`,
       );
     } else if (errOrRejectedResponse.status === 404) {
       // if this fails, we know the issue is they can't see this app
@@ -272,9 +269,9 @@ const getWritableApp = async () => {
       }). Try running \`${colors.cyan('zapier link')}\` to correct that.${
         process.env.ZAPIER_BASE_ENDPOINT
           ? `\n\nFor local dev: make sure you've run  \`${colors.cyan(
-              'zapier login'
+              'zapier login',
             )}\` and \`${colors.cyan(
-              'zapier register'
+              'zapier register',
             )}\` while providing ZAPIER_BASE_ENDPOINT.`
           : ''
       }`;
@@ -399,10 +396,10 @@ const downloadSourceZip = async (dst) => {
   if (!linkedAppConfig.id) {
     throw new Error(
       `This project hasn't yet been associated with an existing Zapier integration.\n\nIf it's a brand new integration, run \`${colors.cyan(
-        'zapier register'
+        'zapier register',
       )}\`.\n\nIf this project already exists in your Zapier account, run \`${colors.cyan(
-        'zapier link'
-      )}\` instead.`
+        'zapier link',
+      )}\` instead.`,
     );
   }
 
@@ -434,7 +431,7 @@ const upload = async (app, { skipValidation = false } = {}) => {
 
   if (!fs.existsSync(fullZipPath)) {
     throw new Error(
-      'Missing a built integration. Try running `zapier build` first.\nAlternatively, run `zapier push`, which will build and upload in one command.'
+      'Missing a built integration. Try running `zapier build` first.\nAlternatively, run `zapier push`, which will build and upload in one command.',
     );
   }
 

package/src/utils/ast.js

@@ -1,6 +1,9 @@
-// tools for modifiyng an AST
+// @ts-check
+
+// tools for modifying an AST
 
 const j = require('jscodeshift');
+const ts = j.withParser('ts');
 
 // simple helper functions used for searching for nodes
 // can't use j.identifier(name) because it has extra properties and we have to have no extras to find nodes
@@ -21,7 +24,7 @@ const typeHelpers = {
 /**
  * adds a `const verName = require(path)` to the root of a codeStr
  */
-const createRootRequire = (codeStr, varName, path) => {
+const importActionInJsApp = (codeStr, varName, path) => {
   if (codeStr.match(new RegExp(`${varName} ?= ?require`))) {
     // duplicate identifier, no need to re-add
     // this would fail if they used this variable name for something else; we'd keep going and double-declare that variable
@@ -42,7 +45,7 @@ const createRootRequire = (codeStr, varName, path) => {
   const newRequireStatement = j.variableDeclaration('const', [
     j.variableDeclarator(
       j.identifier(varName),
-      j.callExpression(j.identifier('require'), [j.literal(path)])
+      j.callExpression(j.identifier('require'), [j.literal(path)]),
     ),
   ]);
 
@@ -61,7 +64,7 @@ const createRootRequire = (codeStr, varName, path) => {
   return root.toSource();
 };
 
-const addKeyToPropertyOnApp = (codeStr, property, varName) => {
+const registerActionInJsApp = (codeStr, property, varName) => {
   // to play with this, use https://astexplorer.net/#/gist/cb4986b3f1c6eb975339608109a48e7d/0fbf2fabbcf27d0b6ebd8910f979bd5d97dd9404
 
   const root = j(codeStr);
@@ -77,13 +80,13 @@ const addKeyToPropertyOnApp = (codeStr, property, varName) => {
   const exportAssignment = root.find(j.AssignmentExpression, {
     left: typeHelpers.memberExpression(
       typeHelpers.identifier('module'),
-      typeHelpers.identifier('exports')
+      typeHelpers.identifier('exports'),
     ),
   });
 
   if (!exportAssignment.length) {
     throw new Error(
-      'Nothing is exported from this file; unable to find an object to modify'
+      'Nothing is exported from this file; unable to find an object to modify',
     );
   }
 
@@ -112,14 +115,14 @@ const addKeyToPropertyOnApp = (codeStr, property, varName) => {
 
   // check if this object already has the property at the top level
   const existingProp = objToModify.properties.find(
-    (props) => props.key.name === property
+    (props) => props.key.name === property,
   );
   if (existingProp) {
     // `triggers: myTriggers` means we shouldn't bother
     const value = existingProp.value;
     if (value.type !== 'ObjectExpression') {
       throw new Error(
-        `Tried to edit the ${property} key, but the value wasn't an object`
+        `Tried to edit the ${property} key, but the value wasn't an object`,
       );
     }
     value.properties.push(newProperty);
@@ -128,12 +131,110 @@ const addKeyToPropertyOnApp = (codeStr, property, varName) => {
       j.property(
         'init',
         j.identifier(property),
-        j.objectExpression([newProperty])
-      )
+        j.objectExpression([newProperty]),
+      ),
     );
   }
 
   return root.toSource();
 };
 
-module.exports = { createRootRequire, addKeyToPropertyOnApp };
+/**
+ * Adds an import statement to the top of an index.ts file to import a
+ * new action, such as `import some_trigger from './triggers/some_trigger';`
+ *
+ * @param {string} codeStr - The code of the index.ts file to modify.
+ * @param {string} identifierName - The name of imported action used as a variable in the code.
+ * @param {string} actionRelativeImportPath - The relative path to import the action from
+ * @returns {string}
+ */
+const importActionInTsApp = (
+  codeStr,
+  identifierName,
+  actionRelativeImportPath,
+) => {
+  const root = ts(codeStr);
+
+  const imports = root.find(ts.ImportDeclaration);
+
+  const newImportStatement = j.importDeclaration(
+    [j.importDefaultSpecifier(j.identifier(identifierName))],
+    j.literal(actionRelativeImportPath),
+  );
+
+  if (imports.length) {
+    imports.at(-1).insertAfter(newImportStatement);
+  } else {
+    const body = root.find(ts.Program).get().node.body;
+    body.unshift(newImportStatement);
+    // Add newline after import?
+  }
+
+  return root.toSource({ quote: 'single' });
+};
+
+/**
+ *
+ * @param {string} codeStr
+ * @param {'creates' | 'searches' | 'triggers'} actionTypePlural - The type of action to register within the app
+ * @param {string} identifierName - Name of the action imported to be registered
+ * @returns {string}
+ */
+const registerActionInTsApp = (codeStr, actionTypePlural, identifierName) => {
+  const root = ts(codeStr);
+
+  // the `[thing.key]: thing` entry we'd like to insert.
+  const newProperty = ts.property.from({
+    kind: 'init',
+    key: j.memberExpression(j.identifier(identifierName), j.identifier('key')),
+    value: j.identifier(identifierName),
+    computed: true,
+  });
+
+  // Find the top level app Object; the one with the `platformVersion`
+  // key. This is where we'll insert our new property.
+  const appObjectCandidates = root
+    .find(ts.ObjectExpression)
+    .filter((path) =>
+      path.value.properties.some(
+        (prop) => prop.key && prop.key.name === 'platformVersion',
+      ),
+    );
+  if (appObjectCandidates.length !== 1) {
+    throw new Error('Unable to find the app definition to modify');
+  }
+  const appObj = appObjectCandidates.get().node;
+
+  // Now we have an app object to modify.
+
+  // Check if this object already has the actionType group inside it.
+  const existingProp = appObj.properties.find(
+    (props) => props.key.name === actionTypePlural,
+  );
+  if (existingProp) {
+    const value = existingProp.value;
+    if (value.type !== 'ObjectExpression') {
+      throw new Error(
+        `Tried to edit the ${actionTypePlural} key, but the value wasn't an object`,
+      );
+    }
+    value.properties.push(newProperty);
+  } else {
+    appObj.properties.push(
+      j.property(
+        'init',
+        j.identifier(actionTypePlural),
+        j.objectExpression([newProperty]),
+      ),
+    );
+  }
+
+  return root.toSource({ quote: 'single' });
+};
+
+module.exports = {
+  importActionInJsApp,
+  registerActionInJsApp,
+  importActionInTsApp,
+  registerActionInTsApp,
+};