zapier-platform-cli 15.19.0 → 16.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "15.19.0",
+  "version": "16.0.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -19,12 +19,12 @@
     "/oclif.manifest.json"
   ],
   "engines": {
-    "node": ">=16"
+    "node": ">=18.18"
   },
   "scripts": {
     "docs": "ZAPIER_BASE_ENDPOINT='' node scripts/docs.js",
     "preversion": "git pull && yarn validate",
-    "prepack": "oclif-dev manifest",
+    "prepack": "oclif manifest",
     "postpack": "rm -f oclif.manifest.json",
     "precommit": "yarn docs && git add docs",
     "version": "yarn docs && git add docs/*",
@@ -40,20 +40,20 @@
     "validate": "yarn test && yarn smoke-test && yarn lint"
   },
   "dependencies": {
-    "@oclif/command": "1.8.27",
-    "@oclif/config": "1.18.10",
-    "@oclif/plugin-autocomplete": "0.3.0",
-    "@oclif/plugin-help": "3.2.20",
-    "@oclif/plugin-not-found": "1.2.4",
-    "adm-zip": "0.5.10",
-    "archiver": "5.3.1",
-    "browserify": "17.0.0",
+    "@oclif/core": "4.0.34",
+    "@oclif/plugin-autocomplete": "3.2.11",
+    "@oclif/plugin-help": "6.2.18",
+    "@oclif/plugin-not-found": "3.2.29",
+    "@oclif/plugin-version": "2.2.16",
+    "adm-zip": "0.5.16",
+    "archiver": "7.0.1",
+    "browserify": "17.0.1",
     "chrono-node": "2.7.7",
-    "cli-table3": "0.6.3",
+    "cli-table3": "0.6.5",
     "colors": "1.4.0",
-    "debug": "4.3.4",
-    "dotenv": "16.4.5",
-    "fs-extra": "11.1.1",
+    "debug": "4.3.7",
+    "dotenv": "16.4.6",
+    "fs-extra": "11.2.0",
     "gulp-filter": "7.0.0",
     "gulp-prettier": "4.0.0",
     "ignore": "5.2.4",
@@ -62,34 +62,33 @@
     "klaw": "4.1.0",
     "lodash": "4.17.21",
     "luxon": "3.5.0",
-    "marked": "4.2.12",
-    "marked-terminal": "5.2.0",
+    "marked": "14.1.4",
+    "marked-terminal": "7.2.1",
     "minimatch": "9.0.3",
-    "node-fetch": "2.6.7",
+    "node-fetch": "2.7.0",
     "open": "10.1.0",
     "ora": "5.4.0",
     "parse-gitignore": "0.5.1",
-    "prettier": "2.8.8",
-    "read": "2.1.0",
-    "semver": "7.5.2",
+    "prettier": "3.4.1",
+    "read": "4.0.0",
+    "semver": "7.6.3",
     "string-length": "4.0.2",
     "through2": "4.0.2",
-    "tmp": "0.2.1",
-    "traverse": "0.6.7",
+    "tmp": "0.2.3",
+    "traverse": "0.6.10",
     "update-notifier": "5.1.0",
-    "yeoman-environment": "3.3.0",
+    "yeoman-environment": "3.19.3",
     "yeoman-generator": "5.9.0"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1.26.10",
-    "@oclif/test": "^1.2.9",
+    "@oclif/test": "^4.0.9",
     "@types/jscodeshift": "^0.12.0",
     "@types/mocha": "^10.0.9",
     "chai": "^4.3.7",
     "decompress": "4.2.1",
     "mock-fs": "^5.2.0",
     "nock": "^13.3.1",
-    "stdout-stderr": "0.1.13",
+    "oclif": "^4.15.30",
     "typescript": "^5.6.3",
     "yamljs": "0.3.0"
   },
@@ -98,20 +97,28 @@
   },
   "oclif": {
     "commands": "src/oclif/commands",
+    "additionalHelpFlags": [
+      "-h"
+    ],
+    "additionalVersionFlags": [
+      "-v"
+    ],
     "bin": "zapier",
+    "dirname": "zapier",
     "plugins": [
+      "@oclif/plugin-autocomplete",
       "@oclif/plugin-help",
       "@oclif/plugin-not-found",
-      "@oclif/plugin-autocomplete"
+      "@oclif/plugin-version"
     ],
     "hooks": {
       "init": [
-        "./src/oclif/hooks/versionInfo",
-        "./src/oclif/hooks/deprecated",
-        "./src/oclif/hooks/updateNotifier",
         "./src/oclif/hooks/checkValidNodeVersion",
+        "./src/oclif/hooks/deprecated",
+        "./src/oclif/hooks/getAppRegistrationFieldChoices",
         "./src/oclif/hooks/renderMarkdownHelp",
-        "./src/oclif/hooks/getAppRegistrationFieldChoices"
+        "./src/oclif/hooks/updateNotifier",
+        "./src/oclif/hooks/versionInfo"
       ]
     },
     "topics": {

package/src/bin/run

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-require('@oclif/command')
-  .run() // this looks through the directory to find all the commands
-  .then(require('@oclif/command/flush'))
-  .catch(require('@oclif/errors/handle'));
+(async () => {
+  const oclif = await import('@oclif/core');
+  await oclif.execute({ development: false, dir: __dirname });
+})();

package/src/bin/run.cmd

@@ -1,6 +1,3 @@
-REM this is created by the oclif generator and is similar to a file that npm creates on install
-REM see https://stackoverflow.com/a/28415646/1825390
-
 @echo off
 
 node "%~dp0\run" %*

package/src/generators/index.js

@@ -13,14 +13,14 @@ const writeGenericReadme = (gen) => {
   gen.fs.copyTpl(
     gen.templatePath('README.template.md'),
     gen.destinationPath('README.md'),
-    { name: gen.options.packageName }
+    { name: gen.options.packageName },
   );
 };
 
 const appendReadme = (gen) => {
   const content = gen.fs.read(
     gen.templatePath(gen.options.template, 'README.md'),
-    { defaults: '' }
+    { defaults: '' },
   );
   if (content) {
     gen.fs.append(gen.destinationPath('README.md'), '\n' + content);
@@ -51,8 +51,8 @@ const writeGenericPackageJson = (gen, packageJsonExtension) => {
         },
         private: true,
       },
-      packageJsonExtension
-    )
+      packageJsonExtension,
+    ),
   );
 };
 
@@ -76,8 +76,8 @@ const writeTypeScriptPackageJson = (gen, packageJsonExtension) => {
         },
         private: true,
       },
-      packageJsonExtension
-    )
+      packageJsonExtension,
+    ),
   );
 };
 
@@ -85,7 +85,7 @@ const writeGenericIndex = (gen, hasAuth) => {
   gen.fs.copyTpl(
     gen.templatePath('index.template.js'),
     gen.destinationPath('index.js'),
-    { corePackageName: PLATFORM_PACKAGE, hasAuth }
+    { corePackageName: PLATFORM_PACKAGE, hasAuth },
   );
 };
 
@@ -108,14 +108,14 @@ const writeGenericAuthTest = (gen) => {
   const authType = authTypes[gen.options.template];
   gen.fs.copyTpl(
     gen.templatePath(`authTests/${authType || 'generic'}.test.js`),
-    gen.destinationPath('test/authentication.test.js')
+    gen.destinationPath('test/authentication.test.js'),
   );
 };
 
 const writeGenericTest = (gen) => {
   gen.fs.copyTpl(
     gen.templatePath('authTests/generic.test.js'),
-    gen.destinationPath('test/example.test.js')
+    gen.destinationPath('test/example.test.js'),
   );
 };
 
@@ -158,7 +158,7 @@ const writeForStandaloneTemplate = (gen) => {
 
   gen.fs.copy(
     gen.templatePath(gen.options.template, '**', '*.{js,json,ts}'),
-    gen.destinationPath()
+    gen.destinationPath(),
   );
 };
 
@@ -187,7 +187,7 @@ const writeForStandaloneTypeScriptTemplate = (gen) => {
 
   gen.fs.copy(
     gen.templatePath(gen.options.template, '**', '*.{js,json,ts}'),
-    gen.destinationPath()
+    gen.destinationPath(),
   );
 };
 

package/src/index.js

@@ -1,3 +1,3 @@
 // for now, requiring this file has no real effect
 
-module.exports = require('@oclif/command');
+module.exports = require('@oclif/core');

package/src/oclif/ZapierBaseCommand.js

@@ -1,6 +1,4 @@
-const { Command } = require('@oclif/command');
-const { stdtermwidth } = require('@oclif/help/lib/screen');
-const { renderList } = require('@oclif/help/lib/list');
+const { Command } = require('@oclif/core');
 const colors = require('colors/safe');
 
 const { startSpinner, endSpinner, formatStyles } = require('../utils/display');
@@ -14,9 +12,9 @@ const inquirer = require('inquirer');
 const DATA_FORMATS = ['json', 'raw'];
 
 class ZapierBaseCommand extends Command {
-  run() {
+  async run() {
     this._initPromptModules();
-    this._parseFlags();
+    await this._parseCommand();
 
     if (this.flags.debug) {
       this.debug.enabled = true; // enables this.debug on the command
@@ -47,7 +45,7 @@ class ZapierBaseCommand extends Command {
 
         if (!this.flags.debug && !this.flags.invokedFromAnotherCommand) {
           errTextLines.push(
-            colors.gray('re-run this command with `--debug` for more info')
+            colors.gray('re-run this command with `--debug` for more info'),
           );
         }
 
@@ -67,11 +65,12 @@ class ZapierBaseCommand extends Command {
     });
   }
 
-  _parseFlags() {
-    const { flags, args } = this.parse(this._staticClassReference);
+  async _parseCommand() {
+    const { flags, args, argv } = await this.parse(this._staticClassReference);
 
     this.flags = flags;
     this.args = args;
+    this.argv = argv;
   }
 
   perform() {
@@ -93,7 +92,7 @@ class ZapierBaseCommand extends Command {
   throwForInvalidVersion(version) {
     if (!version.match(/^\d+\.\d+\.\d+$/g)) {
       throw new Error(
-        `${version} is an invalid version str. Try something like \`1.2.3\``
+        `${version} is an invalid version str. Try something like \`1.2.3\``,
       );
     }
   }
@@ -137,6 +136,9 @@ class ZapierBaseCommand extends Command {
     headers = [],
     emptyMessage = '',
     formatOverride = '',
+    hasBorder = true,
+    showHeaders = true,
+    style = undefined,
   } = {}) {
     const formatter = formatOverride
       ? formatStyles[formatOverride]
@@ -149,18 +151,10 @@ class ZapierBaseCommand extends Command {
       this.log(colors.gray(emptyMessage));
     } else {
       // data comes out of the formatter ready to be printed (and it's always in the type to match the format) so we don't need to do anything special with it
-      console.log(formatter(rows, headers));
+      console.log(formatter(rows, headers, showHeaders, hasBorder, style));
     }
   }
 
-  /**
-   * Print text in a list style.
-   * @param {string[][]} items
-   */
-  logList(items) {
-    this.log(renderList(items, { spacer: '\n', maxWidth: stdtermwidth }));
-  }
-
   /**
    *
    * @param {Object} opts options object (as expected for this.prompt())
@@ -270,44 +264,53 @@ class ZapierBaseCommand extends Command {
       return arg.required ? argName : `[${argName}]`;
     };
 
-    return [
-      'zapier',
-      name,
-      ...(this.args || []).filter((a) => !a.hidden).map((a) => formatArg(a)),
-    ].join(' ');
+    const argv = Object.entries(this.args ?? {}).map(([argName, argValue]) => ({
+      name: argName,
+      ...argValue,
+    }));
+    const visibleArgv = argv.filter((arg) => !arg.hidden);
+
+    return ['zapier', name, ...visibleArgv.map(formatArg)].join(' ');
   }
 
   // this is fine for now but we'll want to hack into https://github.com/oclif/plugin-help/blob/master/src/command.ts at some point
   // the presentation is wrapped into the formatting, so it's a little tough to pull out
   static markdownHelp(name) {
-    const formattedArgs = () =>
-      this.args.map((arg) =>
-        arg.hidden
+    const getFormattedArgs = () =>
+      Object.keys(this.args ?? {}).map((argName) => {
+        const arg = this.args[argName];
+        return arg.hidden
           ? null
-          : `* ${arg.required ? '(required) ' : ''}\`${arg.name}\` | ${
+          : `* ${arg.required ? '(required) ' : ''}\`${argName}\` | ${
               arg.description
-            }`
-      );
-    const formattedFlags = () =>
+            }`;
+      });
+    const getFormattedFlags = () =>
       Object.entries(this.flags)
-        .map(([longName, flag]) =>
-          flag.hidden
+        .map(([flagName, flagValue]) =>
+          flagValue.hidden
             ? null
-            : `* ${flag.required ? '(required) ' : ''}\`${
-                flag.char ? `-${flag.char}, ` : ''
-              }--${longName}\` |${
-                flag.description ? ` ${flag.description}` : ''
+            : `* ${flagValue.required ? '(required) ' : ''}\`${
+                flagValue.char ? `-${flagValue.char}, ` : ''
+              }--${flagName}\` |${
+                flagValue.description ? ` ${flagValue.description}` : ''
               } ${
-                flag.options ? `One of \`[${flag.options.join(' | ')}]\`.` : ''
-              }${flag.default ? ` Defaults to \`${flag.default}\`.` : ''}
-      `.trim()
+                flagValue.options
+                  ? `One of \`[${flagValue.options.join(' | ')}]\`.`
+                  : ''
+              }${
+                flagValue.default
+                  ? ` Defaults to \`${flagValue.default}\`.`
+                  : ''
+              }
+      `.trim(),
         )
         .filter(Boolean);
 
     const descriptionParts = this.description.split('\n\n').filter(Boolean);
     const blurb = descriptionParts[0];
     const lengthyDescription = colors.stripColors(
-      descriptionParts.length > 1 ? descriptionParts.slice(1).join('\n\n') : ''
+      descriptionParts.length > 1 ? descriptionParts.slice(1).join('\n\n') : '',
     );
 
     return [
@@ -317,16 +320,20 @@ class ZapierBaseCommand extends Command {
       '',
       `**Usage**: \`${this.zUsage(name)}\``,
       ...(lengthyDescription ? ['', lengthyDescription] : []),
-      ...(this.args ? ['', '**Arguments**', ...formattedArgs()] : []),
-      ...(this.flags ? ['', '**Flags**', ...formattedFlags()] : []),
-      ...(this.examples
+      ...(Object.keys(this.args ?? {}).length
+        ? ['', '**Arguments**', ...getFormattedArgs()]
+        : []),
+      ...(Object.keys(this.flags ?? {}).length
+        ? ['', '**Flags**', ...getFormattedFlags()]
+        : []),
+      ...((this.examples ?? []).length
         ? [
             '',
             '**Examples**',
             this.examples.map((e) => `* \`${e}\``).join('\n'),
           ]
         : []),
-      ...(this.aliases.length
+      ...((this.aliases ?? []).length
         ? ['', '**Aliases**', this.aliases.map((e) => `* \`${e}\``).join('\n')]
         : []),
     ]

package/src/oclif/buildFlags.js

@@ -1,25 +1,24 @@
-const { flags } = require('@oclif/command');
+const { Flags } = require('@oclif/core');
 const { pickBy } = require('lodash');
 
 const { formatStyles } = require('../utils/display');
 
 const baseFlags = {
-  format: flags.string({
+  debug: Flags.boolean({
+    char: 'd',
+    description: 'Show extra debugging output.',
+    // pull from env?
+  }),
+  format: Flags.string({
     char: 'f',
     options: Object.keys(formatStyles),
     default: 'table',
     description:
       'Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq.',
   }),
-  debug: flags.boolean({
-    char: 'd',
-    description: 'Show extra debugging output.',
-    // pull from env?
-  }),
-
   // Indicates we're calling a command from another command so we know when not
   // to print duplicate messages.
-  invokedFromAnotherCommand: flags.boolean({
+  invokedFromAnotherCommand: Flags.boolean({
     hidden: true,
   }),
 };
@@ -32,14 +31,13 @@ const defaultOpts = {
 };
 
 /**
- * pass in flag objects, plus whether or not to include debug and format
+ * pass in flag objects, plus whether or not to include debug, format, and
+ * invokedFormatAnotherCommand.
  */
 const buildFlags = ({ commandFlags = {}, opts = {} } = {}) => {
-  const selectedBaseFlags = Object.assign({}, defaultOpts, opts);
-  return Object.assign(
-    {},
-    commandFlags,
-    pickBy(baseFlags, (v, k) => selectedBaseFlags[k])
-  );
+  const options = { ...defaultOpts, ...opts };
+  const pickedFlags = pickBy(baseFlags, (_v, k) => options[k]);
+  return { ...commandFlags, ...pickedFlags };
 };
+
 module.exports = { buildFlags };

package/src/oclif/commands/analytics.js

@@ -1,5 +1,5 @@
 const BaseCommand = require('../ZapierBaseCommand');
-const { flags } = require('@oclif/command');
+const { Flags } = require('@oclif/core');
 const { buildFlags } = require('../buildFlags');
 const {
   currentAnalyticsMode,
@@ -13,8 +13,8 @@ class AnalyticsCommand extends BaseCommand {
     const currentMode = await currentAnalyticsMode();
     this.log(
       `The current analytics mode is ${colors.cyan(
-        currentMode
-      )}. Analytics may be skipped anyway if you've got DISABLE_ZAPIER_ANALYTICS set to a truthy value.`
+        currentMode,
+      )}. Analytics may be skipped anyway if you've got DISABLE_ZAPIER_ANALYTICS set to a truthy value.`,
     );
 
     if (this.flags.mode) {
@@ -23,8 +23,8 @@ class AnalyticsCommand extends BaseCommand {
     } else {
       this.log(
         `You can see what data is sent by running \`${colors.yellow(
-          'DEBUG=zapier:analytics zapier someCommand'
-        )}\`.\n\nYou can change your analytics preferences by re-running this command with the \`--mode\` flag.\n\nThe data collected is as generic as we can make it while still getting useful input. No specific information about your filesystem is collected. Your Zapier user id is collected so that we can better debug issues. We will never use this data for any advertising puposes.`
+          'DEBUG=zapier:analytics zapier someCommand',
+        )}\`.\n\nYou can change your analytics preferences by re-running this command with the \`--mode\` flag.\n\nThe data collected is as generic as we can make it while still getting useful input. No specific information about your filesystem is collected. Your Zapier user id is collected so that we can better debug issues. We will never use this data for any advertising puposes.`,
       );
     }
   }
@@ -32,7 +32,7 @@ class AnalyticsCommand extends BaseCommand {
 
 AnalyticsCommand.flags = buildFlags({
   commandFlags: {
-    mode: flags.string({
+    mode: Flags.string({
       char: 'm',
       options: Object.keys(modes),
       description:

package/src/oclif/commands/build.js

@@ -1,6 +1,6 @@
 const BaseCommand = require('../ZapierBaseCommand');
+const { Flags } = require('@oclif/core');
 const { buildFlags } = require('../buildFlags');
-const { flags } = require('@oclif/command');
 const {
   BUILD_PATH,
   SOURCE_PATH,
@@ -17,26 +17,26 @@ class BuildCommand extends BaseCommand {
         skipNpmInstall: this.flags['skip-npm-install'],
         disableDependencyDetection: this.flags['disable-dependency-detection'],
         skipValidation: this.flags['skip-validation'],
-      }
+      },
     );
 
     this.log(
-      `\nBuild complete! Created ${BUILD_PATH} and ${SOURCE_PATH}. Try the \`zapier upload\` command now.`
+      `\nBuild complete! Created ${BUILD_PATH} and ${SOURCE_PATH}. Try the \`zapier upload\` command now.`,
     );
   }
 }
 
 BuildCommand.flags = buildFlags({
   commandFlags: {
-    'disable-dependency-detection': flags.boolean({
+    'disable-dependency-detection': Flags.boolean({
       description: `Disable "smart" file inclusion. By default, Zapier only includes files that are required by \`index.js\`. If you (or your dependencies) require files dynamically (such as with \`require(someVar)\`), then you may see "Cannot find module" errors. Disabling this may make your \`build.zip\` too large. If that's the case, try using the \`includeInBuild\` option in your \`${CURRENT_APP_FILE}\`. See the docs about \`includeInBuild\` for more info.`,
     }),
-    'skip-npm-install': flags.boolean({
+    'skip-npm-install': Flags.boolean({
       description:
         'Skips installing a fresh copy of npm dependencies on build. Helpful for using `yarn` or local copies of dependencies.',
       hidden: true,
     }),
-    'skip-validation': flags.boolean({
+    'skip-validation': Flags.boolean({
       description:
         "Skips local pre-push validation checks, and remote validation check of the CLI app's schema and AppVersion integrity.",
       hidden: true,

package/src/oclif/commands/cache/clear.js

@@ -1,4 +1,5 @@
 const BaseCommand = require('../../ZapierBaseCommand');
+const { Args } = require('@oclif/core');
 const { buildFlags } = require('../../buildFlags');
 const { listVersions, getWritableApp, callAPI } = require('../../../utils/api');
 const { cyan } = require('colors/safe');
@@ -14,13 +15,13 @@ class ClearCacheCommand extends BaseCommand {
     let selectedMajorVersion = majorVersion ? Number(majorVersion) : null;
     if (Number.isNaN(selectedMajorVersion)) {
       throw new Error(
-        `Invalid major version '${majorVersion}'. Must be a number.`
+        `Invalid major version '${majorVersion}'. Must be a number.`,
       );
     }
 
     const majorVersions = [
       ...new Set(
-        versions.map((appVersion) => Number(appVersion.version.split('.')[0]))
+        versions.map((appVersion) => Number(appVersion.version.split('.')[0])),
       ),
     ];
     // Finds the current version in package.json.
@@ -30,14 +31,14 @@ class ClearCacheCommand extends BaseCommand {
     if (selectedMajorVersion === null) {
       selectedMajorVersion = await this._promptForMajorVersionSelection(
         majorVersions,
-        currentVersion
+        currentVersion,
       );
     } else {
       if (!majorVersions.includes(selectedMajorVersion)) {
         throw new Error(
           `This integration does not have any versions on major version '${selectedMajorVersion}'. Valid versions are: ${majorVersions.join(
-            ', '
-          )}`
+            ', ',
+          )}`,
         );
       }
     }
@@ -45,9 +46,9 @@ class ClearCacheCommand extends BaseCommand {
     if (
       !(await this.confirm(
         `Are you sure you want to clear all cache data for major version '${cyan(
-          selectedMajorVersion
+          selectedMajorVersion,
         )}'?`,
-        true
+        true,
       ))
     ) {
       this.log('\ncancelled');
@@ -86,19 +87,18 @@ class ClearCacheCommand extends BaseCommand {
     return await this.promptWithList(
       "Which major version's cache data would you like to delete?",
       majorVersionChoices,
-      { default: currentMajorVersion }
+      { default: currentMajorVersion },
     );
   }
 }
 
-ClearCacheCommand.args = [
-  {
-    name: 'majorVersion',
+ClearCacheCommand.args = {
+  majorVersion: Args.string({
     description:
       '(Optional) The cache data will be deleted for this major version. If not provided, you must pick from a list of major versions for this integration.',
     required: false,
-  },
-];
+  }),
+};
 ClearCacheCommand.flags = buildFlags();
 ClearCacheCommand.description = `Clear the cache data for a major version.