zapier-platform-cli 15.19.0 → 16.1.0

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

@@ -12,13 +12,13 @@ module.exports = (app) => {
     { apiName: 'role' },
   ];
   const missingRequiredFields = requiredFields.filter(
-    (field) => app[field.apiName] == null
+    (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.`
+        .join(', ')}). Please, run "zapier register" to add it.`,
     );
   }
 

package/src/utils/convert.js

@@ -40,19 +40,21 @@ const createFile = async (content, filename, dir) => {
   endSpinner();
 };
 
-const prettifyJs = (code) =>
-  prettier.format(code, { singleQuote: true, parser: 'babel' });
+const prettifyJs = async (code) => {
+  return prettier.format(code, { singleQuote: true, parser: 'babel' });
+};
+
 const prettifyJSON = (origString) => JSON.stringify(origString, null, 2);
 
 const renderTemplate = async (
   templateFile,
   templateContext,
-  prettify = true
+  prettify = true,
 ) => {
   const templateBuf = await readFile(templateFile);
   const template = templateBuf.toString();
   let content = _.template(template, { interpolate: /<%=([\s\S]+?)%>/g })(
-    templateContext
+    templateContext,
   );
 
   if (prettify) {
@@ -99,7 +101,7 @@ const getAuthFieldKeys = (appDefinition) => {
 
 const renderPackageJson = async (appInfo, appDefinition) => {
   const name = _.kebabCase(
-    appInfo.title || _.get(appInfo, ['general', 'title'])
+    appInfo.title || _.get(appInfo, ['general', 'title']),
   );
 
   // Not using escapeSpecialChars because we don't want to escape single quotes (not
@@ -180,7 +182,7 @@ const renderSource = (definition, functions = {}) => {
         funcName = `${funcNameBase}${funcNum}`;
       }
       functions[funcName] = `const ${funcName} = async (${args.join(
-        ', '
+        ', ',
       )}) => {\n${source}\n};`;
 
       this.parent.update(makePlaceholder(funcName));
@@ -188,26 +190,28 @@ const renderSource = (definition, functions = {}) => {
   });
 };
 
-const renderDefinitionSlice = (definitionSlice, filename) => {
+const renderDefinitionSlice = async (definitionSlice, filename) => {
   let exportBlock = _.cloneDeep(definitionSlice);
   let functionBlock = {};
 
   renderSource(exportBlock, functionBlock);
 
   exportBlock = `module.exports = ${replacePlaceholders(
-    JSON.stringify(exportBlock)
+    JSON.stringify(exportBlock),
   )};\n`;
 
   functionBlock = Object.values(functionBlock).join('\n\n');
 
   const uglyCode = functionBlock + '\n\n' + exportBlock;
   try {
-    return prettifyJs(uglyCode);
+    const prettyCode = await prettifyJs(uglyCode);
+    return prettyCode;
   } catch (err) {
     console.warn(
       `Warning: Your code has syntax error in ${chalk.underline.bold(
-        filename
-      )}. ` + `It will be left as is and won't be prettified.\n\n${err.message}`
+        filename,
+      )}. ` +
+        `It will be left as is and won't be prettified.\n\n${err.message}`,
     );
     return uglyCode;
   }
@@ -238,7 +242,7 @@ const renderIndex = async (appDefinition) => {
   // replace version and platformVersion with dynamic reference
   exportBlock.version = makePlaceholder("require('./package.json').version");
   exportBlock.platformVersion = makePlaceholder(
-    "require('zapier-platform-core').version"
+    "require('zapier-platform-core').version",
   );
 
   if (appDefinition.authentication) {
@@ -269,7 +273,7 @@ const renderIndex = async (appDefinition) => {
         exportBlock[stepType][makePlaceholder(`[${importName}.key]`)] =
           makePlaceholder(importName);
       });
-    }
+    },
   );
 
   if (!_.isEmpty(appDefinition.hydrators)) {
@@ -282,21 +286,23 @@ const renderIndex = async (appDefinition) => {
   if (appDefinition.legacy && appDefinition.legacy.scriptingSource) {
     importBlock.push("\nconst fs = require('fs');");
     importBlock.push(
-      "const scriptingSource = fs.readFileSync('./scripting.js', { encoding: 'utf8' });"
+      "const scriptingSource = fs.readFileSync('./scripting.js', { encoding: 'utf8' });",
     );
     exportBlock.legacy.scriptingSource = makePlaceholder('scriptingSource');
   }
 
   exportBlock = `module.exports = ${replacePlaceholders(
-    JSON.stringify(exportBlock)
+    JSON.stringify(exportBlock),
   )};`;
 
   importBlock = importBlock.join('\n');
   functionBlock = Object.values(functionBlock).join('\n\n');
 
-  return prettifyJs(
-    importBlock + '\n\n' + functionBlock + '\n\n' + exportBlock
+  const prettyCode = await prettifyJs(
+    importBlock + '\n\n' + functionBlock + '\n\n' + exportBlock,
   );
+
+  return prettyCode;
 };
 
 const renderEnvironment = (appDefinition) => {
@@ -339,7 +345,7 @@ const writeScripting = async (appDefinition, newAppDir) => {
   await createFile(
     appDefinition.legacy.scriptingSource,
     'scripting.js',
-    newAppDir
+    newAppDir,
   );
 };
 
@@ -385,7 +391,7 @@ const convertApp = async (appInfo, appDefinition, newAppDir) => {
     _.each(appDefinition[stepType], (definition, key) => {
       promises.push(
         writeStep(stepType, definition, key, newAppDir),
-        writeStepTest(stepType, definition, key, newAppDir)
+        writeStepTest(stepType, definition, key, newAppDir),
       );
     });
   });
@@ -405,7 +411,7 @@ const convertApp = async (appInfo, appDefinition, newAppDir) => {
     writeIndex(appDefinition, newAppDir),
     writeEnvironment(appDefinition, newAppDir),
     writeGitIgnore(newAppDir),
-    writeZapierAppRc(appInfo, appDefinition, newAppDir)
+    writeZapierAppRc(appInfo, appDefinition, newAppDir),
   );
 
   return Promise.all(promises);

package/src/utils/credentials.js

@@ -3,7 +3,7 @@ const { BASE_ENDPOINT } = require('../constants');
 
 const isSamlEmail = async (email) => {
   const rawResponse = await fetch(
-    `${BASE_ENDPOINT}/api/v4/idp-discovery/?email=${encodeURIComponent(email)}`
+    `${BASE_ENDPOINT}/api/v4/idp-discovery/?email=${encodeURIComponent(email)}`,
   );
   const { results = [], errors = [] } = await rawResponse.json();
   if (errors.length) {

package/src/utils/display.js

@@ -61,16 +61,33 @@ const ansiTrim = (s) =>
     // '\u001b[90m',
   ]);
 
-const CHARS = {
+const TABLE_CHARS_DEFAULT = {
   // 'top': '', 'top-mid': '', 'top-left': '', 'top-right': '',
   // 'bottom': ' ', 'bottom-mid': ' ', 'bottom-left': ' ', 'bottom-right': ' '
 };
+const TABLE_CHARS_NONE = {
+  top: '',
+  'top-mid': '',
+  'top-left': '',
+  'top-right': '',
+  bottom: '',
+  'bottom-mid': '',
+  'bottom-left': '',
+  'bottom-right': '',
+  left: '',
+  'left-mid': '',
+  mid: '',
+  'mid-mid': '',
+  right: '',
+  'right-mid': '',
+  middle: '  ',
+};
 
 // Similar to makeTable, but prints the column headings in the left-hand column
 // and the values in the right-hand column, in rows
 const makeRowBasedTable = (rows, columnDefs, { includeIndex = true } = {}) => {
   const tableOptions = {
-    chars: CHARS,
+    chars: TABLE_CHARS_DEFAULT,
     style: {
       compact: true,
     },
@@ -85,7 +102,7 @@ const makeRowBasedTable = (rows, columnDefs, { includeIndex = true } = {}) => {
       }
       return maxLength;
     },
-    1
+    1,
   );
   const widthForValue = process.stdout.columns - maxLabelLength - 15; // The last bit accounts for some padding and borders
   if (widthForValue < 1) {
@@ -141,13 +158,19 @@ const makeRowBasedTable = (rows, columnDefs, { includeIndex = true } = {}) => {
   return strTable;
 };
 
-// Wraps the cli-table3 library. Rows is an array of objects, columnDefs
+// Wraps the cli-table3 library. Rows is an array of objects, headers
 // an ordered sub-array [[label, key, (optional_default)], ...].
-const makeTable = (rows, columnDefs) => {
+const makeTable = (
+  rows,
+  columnDefs,
+  showHeaders = true,
+  hasBorder = true,
+  style = undefined,
+) => {
   const tableOptions = {
-    head: columnDefs.map(([label]) => label),
-    chars: CHARS,
-    style: {
+    head: showHeaders ? columnDefs.map(([label]) => label) : undefined,
+    chars: hasBorder ? TABLE_CHARS_DEFAULT : TABLE_CHARS_NONE,
+    style: style ?? {
       compact: true,
       head: ['bold'],
     },

package/src/utils/files.js

@@ -33,7 +33,7 @@ const validateFileExists = (fileName, errMsg) => {
 // Returns a promise that reads a file and returns a buffer.
 const readFile = (fileName, errMsg) => {
   return validateFileExists(fileName, errMsg).then(() =>
-    fse.readFile(fixHome(fileName))
+    fse.readFile(fixHome(fileName)),
   );
 };
 
@@ -137,8 +137,8 @@ const copyDir = async (src, dst, options) => {
       if (fse.lstatSync(srcItem).isSymbolicLink()) {
         console.warn(
           colors.yellow(
-            `\n! Warning: symlink "${srcItem}" points to a non-existent file. Skipping!\n`
-          )
+            `\n! Warning: symlink "${srcItem}" points to a non-existent file. Skipping!\n`,
+          ),
         );
         return null;
       }

package/src/utils/ignore.js

@@ -17,8 +17,8 @@ const respectGitIgnore = (dir, paths) => {
     if (!constants.IS_TESTING) {
       console.warn(
         `\n\n\t${colors.yellow(
-          '!! Warning !!'
-        )}\n\nThere is no .gitignore, so we are including all files. This might make the source.zip file too large\n`
+          '!! Warning !!',
+        )}\n\nThere is no .gitignore, so we are including all files. This might make the source.zip file too large\n`,
       );
     }
     return paths;

package/src/utils/local.js

@@ -32,7 +32,7 @@ const getLocalAppHandler = ({ reload = false, baseEvent = {} } = {}) => {
       {
         calledFromCli: true,
       },
-      baseEvent
+      baseEvent,
     );
     handler(event, _, callback);
   };

package/src/utils/metadata.js

@@ -33,7 +33,7 @@ const extractMetadata = (token, context) => {
     };
   }
   const appMetadata = token.match(
-    /(?<actionType>(trigger|create|search))\/(?<actionKey>\w+)/
+    /(?<actionType>(trigger|create|search))\/(?<actionKey>\w+)/,
   );
   if (
     appMetadata?.groups?.actionKey &&

package/src/utils/misc.js

@@ -41,8 +41,8 @@ const runCommand = (command, args, options) => {
   debug('\n');
   debug(
     `Running ${colors.bold(
-      command + ' ' + args.join(' ')
-    )} command in ${colors.bold(options.cwd || process.cwd())}:\n`
+      command + ' ' + args.join(' '),
+    )} command in ${colors.bold(options.cwd || process.cwd())}:\n`,
   );
 
   return new Promise((resolve, reject) => {
@@ -109,7 +109,7 @@ const isValidAppInstall = () => {
       return {
         valid: false,
         reason: `Your app doesn't depend on ${PLATFORM_PACKAGE}. Run \`${colors.cyan(
-          `npm install -E ${PLATFORM_PACKAGE}`
+          `npm install -E ${PLATFORM_PACKAGE}`,
         )}\` to resolve.`,
       };
     } else if (!semver.valid(dependedCoreVersion)) {
@@ -130,20 +130,19 @@ const isValidAppInstall = () => {
     return {
       valid: false,
       reason: `Looks like you're missing a local installation of ${PLATFORM_PACKAGE}. Run \`${colors.cyan(
-        'npm install'
+        'npm install',
       )}\` to resolve.`,
     };
   }
 
-  const installedPackageJson = require(path.join(
-    corePackageDir,
-    'package.json'
-  ));
+  const installedPackageJson = require(
+    path.join(corePackageDir, 'package.json'),
+  );
   const installedCoreVersion = installedPackageJson.version;
 
   if (installedCoreVersion !== dependedCoreVersion) {
     console.warn(
-      `\nYour code depends on v${dependedCoreVersion} of ${PLATFORM_PACKAGE}, but your local copy is v${installedCoreVersion}. You should probably reinstall your dependencies.\n`
+      `\nYour code depends on v${dependedCoreVersion} of ${PLATFORM_PACKAGE}, but your local copy is v${installedCoreVersion}. You should probably reinstall your dependencies.\n`,
     );
   }
 
@@ -181,7 +180,7 @@ const printVersionInfo = (context) => {
   if (fileExistsSync(path.resolve('./package.json'))) {
     let requiredVersion = _.get(
       require(path.resolve('./package.json')),
-      `dependencies.${PLATFORM_PACKAGE}`
+      `dependencies.${PLATFORM_PACKAGE}`,
     );
     if (requiredVersion) {
       // might be a caret, have to coerce for later comparison
@@ -193,34 +192,34 @@ const printVersionInfo = (context) => {
       if (requiredVersion !== PACKAGE_VERSION) {
         versions.push(
           `${colors.yellow('\nWarning!')} "CLI" (${colors.green(
-            PACKAGE_VERSION
+            PACKAGE_VERSION,
           )}) and "core" (${colors.green(
-            requiredVersion
+            requiredVersion,
           )}) versions are out of sync. This is probably fine, but if you're experiencing issues, update the ${colors.cyan(
-            PLATFORM_PACKAGE
+            PLATFORM_PACKAGE,
           )} dependency in your ${colors.cyan(
-            'package.json'
-          )} to ${colors.green(PACKAGE_VERSION)}.`
+            'package.json',
+          )} to ${colors.green(PACKAGE_VERSION)}.`,
         );
       }
 
       if (
         fileExistsSync(
-          path.resolve(`./node_modules/${PLATFORM_PACKAGE}/package.json`)
+          path.resolve(`./node_modules/${PLATFORM_PACKAGE}/package.json`),
         )
       ) {
         // double check they have the right version installed
-        const installedPkgVersion = require(path.resolve(
-          `./node_modules/${PLATFORM_PACKAGE}/package.json`
-        )).version;
+        const installedPkgVersion = require(
+          path.resolve(`./node_modules/${PLATFORM_PACKAGE}/package.json`),
+        ).version;
 
         if (requiredVersion !== installedPkgVersion) {
           versions.push(
             `${colors.yellow('\nWarning!')} Required version (${colors.green(
-              requiredVersion
+              requiredVersion,
             )}) and installed version (${colors.green(
-              installedPkgVersion
-            )}) are out of sync. Run ${colors.cyan('`npm install`')} to fix.\n`
+              installedPkgVersion,
+            )}) are out of sync. Run ${colors.cyan('`npm install`')} to fix.\n`,
           );
         }
       }

package/src/utils/promisify.js

@@ -30,7 +30,7 @@ const promisifyAll = (object, context) => {
       result[name] = method;
       return result;
     },
-    {}
+    {},
   );
 };
 

package/src/utils/scaffold.js

@@ -26,7 +26,7 @@ const getTemplatePath = (templateType, language = 'js') =>
     '..',
     '..',
     'scaffold',
-    `${templateType}.template.${language}`
+    `${templateType}.template.${language}`,
   );
 
 // useful for making sure we don't conflict with other, similarly named things
@@ -104,15 +104,15 @@ const writeTemplateFile = async ({
     throw new Error(
       [
         `File ${colors.bold(filename)} already exists within ${colors.bold(
-          location
+          location,
         )}.`,
         'You can either:',
         '  1. Choose a different filename',
         `  2. Delete ${filename} from ${location}`,
         `  3. Run ${colors.italic('scaffold')} with ${colors.bold(
-          '--force'
+          '--force',
         )} to overwrite the current ${filename}`,
-      ].join('\n')
+      ].join('\n'),
     );
   }
 
@@ -130,7 +130,7 @@ const isValidEntryFileUpdate = (
   language,
   indexFileResolved,
   actionType,
-  newActionKey
+  newActionKey,
 ) => {
   if (language === 'js') {
     // ensure a clean access
@@ -196,12 +196,12 @@ const updateEntryFileJs = async ({
   codeStr = importActionInJsApp(
     codeStr,
     actionImportName,
-    actionRelativeImportPath
+    actionRelativeImportPath,
   );
   codeStr = registerActionInJsApp(
     codeStr,
     plural(actionType),
-    actionImportName
+    actionImportName,
   );
   await writeFile(indexFileResolved, codeStr);
   return originalCodeStr;
@@ -227,12 +227,12 @@ const updateEntryFileTs = async ({
   codeStr = importActionInTsApp(
     codeStr,
     actionImportName,
-    actionRelativeImportPath
+    actionRelativeImportPath,
   );
   codeStr = registerActionInTsApp(
     codeStr,
     plural(actionType),
-    actionImportName
+    actionImportName,
   );
   await writeFile(indexFileResolved, codeStr);
   return originalCodeStr;
@@ -271,7 +271,7 @@ const createScaffoldingContext = ({
   const actionFileResolved = `${path.join(
     cwd,
     actionDirLocal,
-    key
+    key,
   )}.${language}`;
   const actionFileResolvedStem = path.join(cwd, actionDirLocal, key);
   const actionFileLocal = `${path.join(actionDirLocal, key)}.${language}`;
@@ -279,13 +279,13 @@ const createScaffoldingContext = ({
   const testFileResolved = `${path.join(
     cwd,
     testDirLocal,
-    key
+    key,
   )}.test.${language}`;
   const testFileLocal = `${path.join(testDirLocal, key)}.${language}`;
   const testFileLocalStem = path.join(testDirLocal, key);
   const actionRelativeImportPath = `./${getRelativeRequirePath(
     indexFileResolved,
-    actionFileResolvedStem
+    actionFileResolvedStem,
   )}`;
 
   return {

package/src/utils/team.js

@@ -10,8 +10,8 @@ const transformUserRole = (role) =>
   role === 'collaborator'
     ? 'admin'
     : role === 'subscriber'
-    ? 'subscriber'
-    : 'collaborator';
+      ? 'subscriber'
+      : 'collaborator';
 
 const listTeamMembers = async () => {
   return listEndpointMulti(
@@ -24,7 +24,7 @@ const listTeamMembers = async () => {
       endpoint: (app) =>
         `${constants.BASE_ENDPOINT}/api/platform/v3/integrations/${app.id}/subscribers`,
       keyOverride: 'subscribers',
-    }
+    },
   );
 };
 module.exports = {

package/src/utils/xdg.js

@@ -38,17 +38,17 @@ if (process.platform === 'win32') {
   ensureDataDir = ensureDir.bind(
     null,
     'XDG_DATA_HOME',
-    path.join(HOME_DIR, '.local', 'share')
+    path.join(HOME_DIR, '.local', 'share'),
   );
   ensureCacheDir = ensureDir.bind(
     null,
     'XDG_CACHE_HOME',
-    path.join(HOME_DIR, '.cache')
+    path.join(HOME_DIR, '.cache'),
   );
   ensureConfigDir = ensureDir.bind(
     null,
     'XDG_CONFIG_HOME',
-    path.join(HOME_DIR, '.config')
+    path.join(HOME_DIR, '.config'),
   );
 }
 

package/src/version-store.js

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