zapier-platform-cli 17.9.1 → 18.0.0

package/oclif.manifest.json

@@ -2555,5 +2555,5 @@
       ]
     }
   },
-  "version": "17.9.1"
+  "version": "18.0.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "17.9.1",
+  "version": "18.0.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -40,58 +40,59 @@
     "validate": "yarn test && yarn smoke-test && yarn lint"
   },
   "dependencies": {
-    "@oclif/core": "4.3.0",
-    "@oclif/plugin-autocomplete": "3.2.28",
-    "@oclif/plugin-help": "6.2.28",
-    "@oclif/plugin-not-found": "3.2.51",
-    "@oclif/plugin-version": "2.2.28",
+    "@oclif/core": "4.5.2",
+    "@oclif/plugin-autocomplete": "3.2.34",
+    "@oclif/plugin-help": "6.2.32",
+    "@oclif/plugin-not-found": "3.2.62",
+    "@oclif/plugin-version": "2.2.32",
     "adm-zip": "0.5.16",
     "archiver": "7.0.1",
-    "chrono-node": "2.8.0",
+    "chrono-node": "2.8.3",
     "cli-table3": "0.6.5",
     "colors": "1.4.0",
-    "debug": "4.4.0",
+    "debug": "4.4.1",
     "decompress": "4.2.1",
-    "dotenv": "16.5.0",
-    "esbuild": "0.25.4",
-    "fs-extra": "11.2.0",
+    "dotenv": "17.2.1",
+    "esbuild": "0.25.8",
+    "fs-extra": "11.3.1",
     "gulp-filter": "7.0.0",
     "gulp-prettier": "5.0.0",
-    "ignore": "5.2.4",
+    "ignore": "7.0.5",
     "inquirer": "8.2.5",
     "jscodeshift": "^17.3.0",
     "lodash": "4.17.21",
-    "luxon": "3.6.1",
-    "marked": "14.1.4",
-    "marked-terminal": "7.2.1",
-    "open": "10.1.2",
+    "luxon": "3.7.1",
+    "marked": "15.0.12",
+    "marked-terminal": "7.3.0",
+    "open": "10.2.0",
     "ora": "5.4.0",
     "parse-gitignore": "0.5.1",
-    "prettier": "3.5.3",
+    "prettier": "3.6.2",
     "read": "4.1.0",
-    "semver": "7.7.1",
+    "semver": "7.7.2",
     "string-length": "4.0.2",
     "through2": "4.0.2",
     "tmp": "0.2.4",
     "traverse": "0.6.11",
-    "update-notifier": "5.1.0",
-    "yeoman-environment": "3.19.3",
-    "yeoman-generator": "5.9.0"
+    "update-notifier": "7.3.1",
+    "yeoman-environment": "4.4.3",
+    "yeoman-generator": "7.5.1"
   },
   "devDependencies": {
-    "@oclif/test": "^4.1.12",
+    "@oclif/test": "^4.1.13",
     "@types/jscodeshift": "^0.12.0",
     "@types/mocha": "^10.0.9",
     "chai": "^4.3.7",
     "mock-fs": "^5.5.0",
-    "nock": "^14.0.4",
-    "oclif": "^4.17.46",
+    "nock": "^14.0.7",
+    "oclif": "^4.22.5",
     "rimraf": "^5.0.10",
     "typescript": "^5.8.3",
     "yamljs": "0.3.0"
   },
   "bin": {
-    "zapier": "./src/bin/run"
+    "zapier": "./src/bin/run-deprecated",
+    "zapier-platform": "./src/bin/run"
   },
   "oclif": {
     "commands": "src/oclif/commands",

package/src/bin/run-deprecated

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+const path = require('node:path');
+
+(async () => {
+  const oclif = await import('@oclif/core');
+  await oclif.execute({ development: false, dir: __dirname });
+
+  console.warn(
+    '[DEPRECATION WARNING] ' +
+      'The executable name "zapier" is deprecated and will be removed in a future version. ' +
+      'Please use "zapier-platform" instead.',
+  );
+})();

package/src/constants.js

@@ -20,7 +20,7 @@ const BUILD_PATH = `${BUILD_DIR}/build.zip`;
 const SOURCE_PATH = `${BUILD_DIR}/source.zip`;
 const NODE_VERSION = versionStore[versionStore.length - 1].nodeVersion;
 const LAMBDA_VERSION = `v${NODE_VERSION}`;
-const NODE_VERSION_CLI_REQUIRES = '>=18'; // should be the oldest non-ETL version
+const NODE_VERSION_CLI_REQUIRES = '>=22'; // should be the oldest non-ETL version
 const AUTH_KEY = 'deployKey';
 const ANALYTICS_KEY = 'analyticsMode';
 const ANALYTICS_MODES = {

package/src/generators/index.js

@@ -2,12 +2,12 @@ const path = require('path');
 
 const { merge } = require('lodash');
 const filter = require('gulp-filter');
-const Generator = require('yeoman-generator');
+const { createGeneratorClass } = require('../utils/esm-wrapper');
 const prettier = require('gulp-prettier');
 
 const { PACKAGE_VERSION, PLATFORM_PACKAGE } = require('../constants');
 const authFilesCodegen = require('../utils/auth-files-codegen');
-const { PullGenerator } = require('./pull');
+const PullGeneratorPromise = require('./pull');
 
 const writeGenericReadme = (gen) => {
   gen.fs.copyTpl(
@@ -133,6 +133,7 @@ const writeGenericAuth = (gen) => {
   const content = authFilesCodegen[authType](gen.options.language);
   const destPath = (key) =>
     gen.options.language === 'typescript' ? `src/${key}.ts` : `${key}.js`;
+
   Object.entries(content).forEach(([key, value]) => {
     gen.fs.write(gen.destinationPath(destPath(key)), value);
   });
@@ -238,104 +239,107 @@ const TS_SUPPORTED_TEMPLATES = [
 
 const TEMPLATE_CHOICES = Object.keys(TEMPLATE_ROUTES);
 
-class ProjectGenerator extends Generator {
-  initializing() {
-    this.sourceRoot(path.resolve(__dirname, 'templates'));
-    this.destinationRoot(path.resolve(this.options.path));
-
-    const jsFilter = filter(['*.js', '*.json', '*.ts'], { restore: true });
-    this.queueTransformStream([
-      jsFilter,
-      prettier({ singleQuote: true }),
-      jsFilter.restore,
-    ]);
-  }
-
-  async prompting() {
-    if (!this.options.template) {
-      // Filter template choices based on language and module type
-      let templateChoices = TEMPLATE_CHOICES;
-      let defaultTemplate = 'minimal';
-
-      // TypeScript filtering takes precedence over ESM filtering
-      if (this.options.language === 'typescript') {
-        templateChoices = TS_SUPPORTED_TEMPLATES;
-        defaultTemplate = 'basic-auth';
-      } else if (this.options.module === 'esm') {
-        templateChoices = ESM_SUPPORTED_TEMPLATES;
-        defaultTemplate = 'minimal'; // minimal is the only ESM template
-      }
-
-      this.answers = await this.prompt([
-        {
-          type: 'list',
-          name: 'template',
-          choices: templateChoices,
-          message: 'Choose a project template to start with:',
-          default: defaultTemplate,
-        },
+const ProjectGeneratorPromise = createGeneratorClass((Generator) => {
+  return class ProjectGenerator extends Generator {
+    initializing() {
+      this.sourceRoot(path.resolve(__dirname, 'templates'));
+      this.destinationRoot(path.resolve(this.options.path));
+
+      const jsFilter = filter(['*.js', '*.json', '*.ts'], { restore: true });
+      this.queueTransformStream([
+        { disabled: true },
+        jsFilter,
+        prettier({ singleQuote: true }),
+        jsFilter.restore,
       ]);
-      this.options.template = this.answers.template;
     }
 
-    if (
-      ESM_SUPPORTED_TEMPLATES.includes(this.options.template) &&
-      !this.options.module
-    ) {
-      this.answers = await this.prompt([
-        {
-          type: 'list',
-          name: 'module',
-          choices: ['esm', 'commonjs'],
-          message: 'Choose module type:',
-          default: 'esm',
-        },
-      ]);
-      this.options.module = this.answers.module;
-    }
+    async prompting() {
+      if (!this.options.template) {
+        // Filter template choices based on language and module type
+        let templateChoices = TEMPLATE_CHOICES;
+        let defaultTemplate = 'minimal';
+
+        // TypeScript filtering takes precedence over ESM filtering
+        if (this.options.language === 'typescript') {
+          templateChoices = TS_SUPPORTED_TEMPLATES;
+          defaultTemplate = 'basic-auth';
+        } else if (this.options.module === 'esm') {
+          templateChoices = ESM_SUPPORTED_TEMPLATES;
+          defaultTemplate = 'minimal'; // minimal is the only ESM template
+        }
 
-    if (this.options.language) {
-      if (this.options.language === 'typescript') {
-        // check if the template supports typescript
-        if (!TS_SUPPORTED_TEMPLATES.includes(this.options.template)) {
-          throw new Error(
-            'Typescript is not supported for this template, please use a different template or set the language to javascript. Supported templates: ' +
-              TS_SUPPORTED_TEMPLATES.join(', '),
-          );
+        this.answers = await this.prompt([
+          {
+            type: 'list',
+            name: 'template',
+            choices: templateChoices,
+            message: 'Choose a project template to start with:',
+            default: defaultTemplate,
+          },
+        ]);
+        this.options.template = this.answers.template;
+      }
+
+      if (
+        ESM_SUPPORTED_TEMPLATES.includes(this.options.template) &&
+        !this.options.module
+      ) {
+        this.answers = await this.prompt([
+          {
+            type: 'list',
+            name: 'module',
+            choices: ['esm', 'commonjs'],
+            message: 'Choose module type:',
+            default: 'esm',
+          },
+        ]);
+        this.options.module = this.answers.module;
+      }
+
+      if (this.options.language) {
+        if (this.options.language === 'typescript') {
+          // check if the template supports typescript
+          if (!TS_SUPPORTED_TEMPLATES.includes(this.options.template)) {
+            throw new Error(
+              'Typescript is not supported for this template, please use a different template or set the language to javascript. Supported templates: ' +
+                TS_SUPPORTED_TEMPLATES.join(', '),
+            );
+          }
+          // if they try to combine typescript with commonjs, throw an error
+          if (this.options.module === 'commonjs') {
+            throw new Error('Typescript is not supported for commonjs');
+          } // esm is supported for typescript templates
         }
-        // if they try to combine typescript with commonjs, throw an error
-        if (this.options.module === 'commonjs') {
-          throw new Error('Typescript is not supported for commonjs');
-        } // esm is supported for typescript templates
+      } else {
+        // default to javascript for the language if it's not set
+        this.options.language = 'javascript';
       }
-    } else {
-      // default to javascript for the language if it's not set
-      this.options.language = 'javascript';
-    }
 
-    if (
-      !ESM_SUPPORTED_TEMPLATES.includes(this.options.template) &&
-      this.options.module === 'esm' &&
-      this.options.language === 'javascript'
-    ) {
-      throw new Error(
-        'ESM is not supported for this template, please use a different template, set the module to commonjs, or try setting the language to Typescript',
-      );
+      if (
+        !ESM_SUPPORTED_TEMPLATES.includes(this.options.template) &&
+        this.options.module === 'esm' &&
+        this.options.language === 'javascript'
+      ) {
+        throw new Error(
+          'ESM is not supported for this template, please use a different template, set the module to commonjs, or try setting the language to Typescript',
+        );
+      }
     }
-  }
 
-  writing() {
-    this.options.packageName = path.basename(this.options.path);
+    writing() {
+      this.options.packageName = path.basename(this.options.path);
 
-    const writeFunc = TEMPLATE_ROUTES[this.options.template];
-    writeFunc(this);
-  }
-}
+      const writeFunc = TEMPLATE_ROUTES[this.options.template];
+      writeFunc(this);
+    }
+  };
+});
 
 module.exports = {
   TEMPLATE_CHOICES,
   ESM_SUPPORTED_TEMPLATES,
   TS_SUPPORTED_TEMPLATES,
-  PullGenerator,
-  ProjectGenerator,
+  PullGenerator: PullGeneratorPromise,
+  ProjectGenerator: ProjectGeneratorPromise,
 };

package/src/generators/pull.js

@@ -2,7 +2,7 @@ const colors = require('colors/safe');
 const debug = require('debug')('zapier:pull');
 const inquirer = require('inquirer');
 const path = require('path');
-const Generator = require('yeoman-generator');
+const { createGeneratorClass } = require('../utils/esm-wrapper');
 
 const maybeOverwriteFiles = async (gen) => {
   const dstDir = gen.options.dstDir;
@@ -12,17 +12,19 @@ const maybeOverwriteFiles = async (gen) => {
   }
 };
 
-module.exports = class PullGenerator extends Generator {
-  initializing() {
-    debug('SRC', this.options.sourceFiles);
-  }
+// Export a factory function that creates the PullGenerator class
+module.exports = createGeneratorClass((Generator) => {
+  return class PullGenerator extends Generator {
+    initializing() {
+      debug('SRC', this.options.sourceFiles);
+    }
 
-  prompting() {
-    const prompts = [
-      {
-        type: 'confirm',
-        name: 'confirm',
-        message: `Warning: You are about to overwrite existing files.
+    prompting() {
+      const prompts = [
+        {
+          type: 'confirm',
+          name: 'confirm',
+          message: `Warning: You are about to overwrite existing files.
 
 Before proceeding, please make sure you have saved your work. Consider creating a backup or saving your current state in a git branch.
 
@@ -30,23 +32,24 @@ If presented with a series of options ('ynarxdeiH'), you may
 press Enter to view more details about each option. For example, 'x' will abort the process.
 
 Do you want to continue?`,
-        default: false,
-      },
-    ];
-
-    return inquirer.prompt(prompts).then((answers) => {
-      if (!answers.confirm) {
-        this.log(colors.green('zapier pull cancelled'));
-        process.exit(1);
-      }
-    });
-  }
-
-  writing() {
-    maybeOverwriteFiles(this);
-  }
-
-  end() {
-    this.log(colors.green('zapier pull completed successfully'));
-  }
-};
+          default: false,
+        },
+      ];
+
+      return inquirer.prompt(prompts).then((answers) => {
+        if (!answers.confirm) {
+          this.log(colors.green('zapier pull cancelled'));
+          process.exit(1);
+        }
+      });
+    }
+
+    writing() {
+      maybeOverwriteFiles(this);
+    }
+
+    end() {
+      this.log(colors.green('zapier pull completed successfully'));
+    }
+  };
+});

package/src/oclif/commands/init.js

@@ -1,18 +1,22 @@
 const { join } = require('path');
 
 const { Args, Flags } = require('@oclif/core');
-const yeoman = require('yeoman-environment');
+const { createEnv } = require('../../utils/esm-wrapper');
 
 const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
-const { TEMPLATE_CHOICES, ProjectGenerator } = require('../../generators');
+const {
+  TEMPLATE_CHOICES,
+  ProjectGenerator: ProjectGeneratorPromise,
+} = require('../../generators');
 
 class InitCommand extends BaseCommand {
   async perform() {
     const { path } = this.args;
     const { template, module, language } = this.flags;
 
-    const env = yeoman.createEnv();
+    const env = await createEnv(); // await needed because createEnv() uses dynamic import() for ESM-only yeoman-environment
+    const ProjectGenerator = await ProjectGeneratorPromise; // await needed because generator classes are now created via ESM dynamic import
     env.registerStub(ProjectGenerator, 'zapier:integration');
 
     await env.run('zapier:integration', { path, template, module, language });

package/src/oclif/commands/invoke.js

@@ -1086,7 +1086,7 @@ class InvokeCommand extends BaseCommand {
   async perform() {
     let authId = this.flags['authentication-id'];
 
-    const dotenvResult = dotenv.config({ override: true });
+    const dotenvResult = dotenv.config({ override: true, quiet: true });
     if (!authId && _.isEmpty(dotenvResult.parsed)) {
       console.warn(
         'The .env file does not exist or is empty. ' +

package/src/oclif/commands/pull.js

@@ -1,14 +1,14 @@
 const AdmZip = require('adm-zip');
 const { ensureFileSync } = require('fs-extra');
 const path = require('path');
-const yeoman = require('yeoman-environment');
+const { createEnv } = require('../../utils/esm-wrapper');
 
 const ZapierBaseCommand = require('../ZapierBaseCommand');
 const { downloadSourceZip } = require('../../utils/api');
 const { ensureDir, makeTempDir, removeDirSync } = require('../../utils/files');
 const { walkDirWithPresetBlocklist } = require('../../utils/build');
 const { buildFlags } = require('../buildFlags');
-const PullGenerator = require('../../generators/pull');
+const PullGeneratorPromise = require('../../generators/pull');
 
 const listFiles = (dir) => {
   const relPaths = [];
@@ -38,7 +38,8 @@ class PullCommand extends ZapierBaseCommand {
       const currentDir = process.cwd();
       const sourceFiles = listFiles(srcDst);
 
-      const env = yeoman.createEnv();
+      const env = await createEnv(); // await needed because createEnv() uses dynamic import() for ESM-only yeoman-environment
+      const PullGenerator = await PullGeneratorPromise; // await needed because generator classes are now created via ESM dynamic import
       const namespace = 'zapier:pull';
       env.registerStub(PullGenerator, namespace);
       await env.run(namespace, {

package/src/oclif/hooks/updateNotifier.js

@@ -1,10 +1,12 @@
-const updateNotifier = require('update-notifier');
+const { createUpdateNotifier } = require('../../utils/esm-wrapper');
 const pkg = require('../../../package.json');
 const { UPDATE_NOTIFICATION_INTERVAL } = require('../../constants');
 
 // can't be fat arrow because it inherits `this` from commands
-module.exports = function (options) {
-  const notifier = updateNotifier({
+// Made async because createUpdateNotifier() uses dynamic import() to load ESM-only update-notifier package
+module.exports = async function (options) {
+  const notifier = await createUpdateNotifier({
+    // await needed for ESM dynamic import
     pkg,
     updateCheckInterval: UPDATE_NOTIFICATION_INTERVAL,
   });

package/src/utils/build.js

@@ -11,7 +11,7 @@ const archiver = require('archiver');
 const colors = require('colors/safe');
 const esbuild = require('esbuild');
 const fse = require('fs-extra');
-const updateNotifier = require('update-notifier');
+const { createUpdateNotifier } = require('./esm-wrapper');
 const decompress = require('decompress');
 
 const {
@@ -468,7 +468,8 @@ const makeSourceZip = async (workingDir, zipPath) => {
   await zip.finish();
 };
 
-const maybeNotifyAboutOutdated = () => {
+const maybeNotifyAboutOutdated = async () => {
+  // Made async because createUpdateNotifier() uses dynamic import() to load ESM-only update-notifier package
   // find a package.json for the app and notify on the core dep
   // `build` won't run if package.json isn't there, so if we get to here we're good
   const requiredVersion = _.get(
@@ -477,7 +478,7 @@ const maybeNotifyAboutOutdated = () => {
   );
 
   if (requiredVersion) {
-    const notifier = updateNotifier({
+    const notifier = await createUpdateNotifier({
       pkg: { name: PLATFORM_PACKAGE, version: requiredVersion },
       updateCheckInterval: UPDATE_NOTIFICATION_INTERVAL,
     });
@@ -603,7 +604,7 @@ const _buildFunc = async (
   const maybeEndSpinner = printProgress ? endSpinner : () => {};
 
   if (checkOutdated) {
-    maybeNotifyAboutOutdated();
+    await maybeNotifyAboutOutdated(); // await needed because function is now async due to ESM import
   }
   const appDir = process.cwd();
 

package/src/utils/esm-wrapper.js

@@ -0,0 +1,86 @@
+/**
+ * CommonJS wrapper for ESM-only modules
+ * This allows us to use yeoman-environment v4+, yeoman-generator v7+, and update-notifier v7+ from CommonJS code without downgrading
+ */
+
+let yeomanEnvironment = null;
+let yeomanGenerator = null;
+let updateNotifier = null;
+
+/**
+ * Lazy-load yeoman-environment using dynamic import
+ * @returns {Promise<Object>} The yeoman-environment module
+ */
+async function getYeomanEnvironment() {
+  if (!yeomanEnvironment) {
+    yeomanEnvironment = await import('yeoman-environment');
+  }
+  return yeomanEnvironment;
+}
+
+/**
+ * Lazy-load yeoman-generator using dynamic import
+ * @returns {Promise<Object>} The yeoman-generator module
+ */
+async function getYeomanGenerator() {
+  if (!yeomanGenerator) {
+    yeomanGenerator = await import('yeoman-generator');
+  }
+  return yeomanGenerator;
+}
+
+/**
+ * Lazy-load update-notifier using dynamic import
+ * @returns {Promise<Object>} The update-notifier module
+ */
+async function getUpdateNotifier() {
+  if (!updateNotifier) {
+    updateNotifier = await import('update-notifier');
+  }
+  return updateNotifier;
+}
+
+/**
+ * Create a yeoman environment (async version of yeoman.createEnv())
+ * @param {Object} options - Environment options
+ * @returns {Promise<Object>} Environment instance
+ */
+async function createEnv(options) {
+  const yeoman = await getYeomanEnvironment();
+  return yeoman.createEnv(options);
+}
+
+/**
+ * Get the Generator class (async version of require('yeoman-generator'))
+ * @returns {Promise<Function>} The Generator class
+ */
+async function getGenerator() {
+  const yeomanGen = await getYeomanGenerator();
+  return yeomanGen.default;
+}
+
+/**
+ * Create a generator class factory that extends the yeoman Generator
+ * @param {Function} generatorFactory - A function that takes Generator class and returns a class extending it
+ * @returns {Promise<Function>} The generated class
+ */
+async function createGeneratorClass(generatorFactory) {
+  const Generator = await getGenerator();
+  return generatorFactory(Generator);
+}
+
+/**
+ * Create an update notifier (async version of require('update-notifier'))
+ * @param {Object} options - Update notifier options (pkg, updateCheckInterval, etc.)
+ * @returns {Promise<Object>} Update notifier instance
+ */
+async function createUpdateNotifier(options) {
+  const updateNotifierModule = await getUpdateNotifier();
+  return updateNotifierModule.default(options);
+}
+
+module.exports = {
+  createEnv,
+  createGeneratorClass,
+  createUpdateNotifier,
+};

package/src/version-store.js

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

package/src/bin/run.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node "%~dp0\run" %*