zapier-platform-cli 16.5.1 → 17.0.1

package/oclif.manifest.json

@@ -55,7 +55,7 @@
     "build": {
       "aliases": [],
       "args": {},
-      "description": "Build a pushable zip from the current directory.\n\nThis command does the following:\n\n* Creates a temporary folder\n* Copies all code into the temporary folder\n* Adds an entry point: `zapierwrapper.js`\n* Generates and validates app definition.\n* Detects dependencies via browserify (optional, on by default)\n* Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to your `.zapierapprc`.\n* Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder\n\nThis command is typically followed by `zapier upload`.",
+      "description": "Build a pushable zip from the current directory.\n\nThis command does the following:\n\n* Creates a temporary folder\n* Copies all code into the temporary folder\n* Adds an entry point: `zapierwrapper.js`\n* Generates and validates app definition.\n* Detects dependencies via esbuild (optional, on by default)\n* Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to your `.zapierapprc`.\n* Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder\n\nThis command is typically followed by `zapier upload`.",
       "flags": {
         "disable-dependency-detection": {
           "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 `.zapierapprc`. See the docs about `includeInBuild` for more info.",
@@ -337,7 +337,8 @@
       "description": "Initialize a new Zapier integration with a project template.\n\nAfter running this, you'll have a new integration in the specified directory. If you re-run this command on an existing directory, it will prompt before overwriting any existing files.\n\nThis doesn't register or deploy the integration with Zapier - try the `zapier register` and `zapier push` commands for that!",
       "examples": [
         "zapier init myapp",
-        "zapier init ./path/myapp --template oauth2"
+        "zapier init ./path/myapp --template oauth2",
+        "zapier init ./path/myapp --template minimal --module esm"
       ],
       "flags": {
         "template": {
@@ -363,6 +364,18 @@
           ],
           "type": "option"
         },
+        "module": {
+          "char": "m",
+          "description": "Choose module type: CommonJS or ES Modules. Only enabled for Typescript and Minimal templates.",
+          "name": "module",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "commonjs",
+            "esm"
+          ],
+          "type": "option"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -2417,5 +2430,5 @@
       ]
     }
   },
-  "version": "16.5.1"
+  "version": "17.0.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "16.5.1",
+  "version": "17.0.1",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -40,56 +40,56 @@
     "validate": "yarn test && yarn smoke-test && yarn lint"
   },
   "dependencies": {
-    "@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",
+    "@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",
     "adm-zip": "0.5.16",
     "archiver": "7.0.1",
-    "browserify": "17.0.1",
-    "chrono-node": "2.7.7",
+    "chrono-node": "2.8.0",
     "cli-table3": "0.6.5",
     "colors": "1.4.0",
-    "debug": "4.3.7",
-    "dotenv": "16.4.6",
+    "debug": "4.4.0",
+    "dotenv": "16.5.0",
+    "esbuild": "0.25.4",
     "fs-extra": "11.2.0",
     "gulp-filter": "7.0.0",
-    "gulp-prettier": "4.0.0",
+    "gulp-prettier": "5.0.0",
     "ignore": "5.2.4",
     "inquirer": "8.2.5",
-    "jscodeshift": "^17.0.0",
+    "jscodeshift": "^17.3.0",
     "klaw": "4.1.0",
     "lodash": "4.17.21",
-    "luxon": "3.5.0",
+    "luxon": "3.6.1",
     "marked": "14.1.4",
     "marked-terminal": "7.2.1",
     "minimatch": "9.0.3",
     "node-fetch": "2.7.0",
-    "open": "10.1.0",
+    "open": "10.1.2",
     "ora": "5.4.0",
     "parse-gitignore": "0.5.1",
-    "prettier": "3.4.1",
-    "read": "4.0.0",
-    "semver": "7.6.3",
+    "prettier": "3.5.3",
+    "read": "4.1.0",
+    "semver": "7.7.1",
     "string-length": "4.0.2",
     "through2": "4.0.2",
     "tmp": "0.2.3",
-    "traverse": "0.6.10",
+    "traverse": "0.6.11",
     "update-notifier": "5.1.0",
     "yeoman-environment": "3.19.3",
     "yeoman-generator": "5.9.0"
   },
   "devDependencies": {
-    "@oclif/test": "^4.0.9",
+    "@oclif/test": "^4.1.12",
     "@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",
-    "oclif": "^4.15.30",
-    "typescript": "^5.6.3",
+    "mock-fs": "^5.5.0",
+    "nock": "^14.0.4",
+    "oclif": "^4.17.46",
+    "typescript": "^5.8.3",
     "yamljs": "0.3.0"
   },
   "bin": {

package/scaffold/create.template.ts

@@ -1,21 +1,31 @@
-import type { Create, PerformFunction } from 'zapier-platform-core';
+import {
+  defineInputFields,
+  defineCreate,
+  type CreatePerform,
+  type InferInputData,
+} from 'zapier-platform-core';
+
+const inputFields = defineInputFields([
+  { key: 'name', required: true },
+  { key: 'fave_meal', label: 'Favorite Meal', required: false },
+]);
 
 // create a particular <%= LOWER_NOUN %> by name
-const perform: PerformFunction = async (z, bundle) => {
+const perform = (async (z, bundle) => {
   const response = await z.request({
     method: 'POST',
     url: 'https://jsonplaceholder.typicode.com/posts',
     // if `body` is an object, it'll automatically get run through JSON.stringify
     // if you don't want to send JSON, pass a string in your chosen format here instead
     body: {
-      name: bundle.inputData.name
-    }
+      name: bundle.inputData.name,
+    },
   });
   // this should return a single object
   return response.data;
-};
+}) satisfies CreatePerform<InferInputData<typeof inputFields>>;
 
-export default {
+export default defineCreate({
   // see here for a full list of available properties:
   // https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#createschema
   key: '<%= KEY %>',
@@ -34,10 +44,7 @@ export default {
       '// Zapier will pass them in as `bundle.inputData` later. They\'re optional.',
       '// End-users will map data into these fields. In general, they should have any fields that the API can accept. Be sure to accurately mark which fields are required!'
     ].join('\n    ') : '' %>
-    inputFields: [
-      {key: 'name', required: true},
-      {key: 'fave_meal', label: 'Favorite Meal', required: false}
-    ],
+    inputFields,
 
     <%= INCLUDE_INTRO_COMMENTS ? [
       '// In cases where Zapier needs to show an example record to the user, but we are unable to get a live example',
@@ -46,7 +53,7 @@ export default {
     ].join('\n    ') : '' %>
     sample: {
       id: 1,
-      name: 'Test'
+      name: 'Test',
     },
 
     <%= INCLUDE_INTRO_COMMENTS ? [
@@ -59,6 +66,6 @@ export default {
       // these are placeholders to match the example `perform` above
       // {key: 'id', label: 'Person ID'},
       // {key: 'name', label: 'Person Name'}
-    ]
-  }
-} satisfies Create;
+    ],
+  },
+});

package/scaffold/search.template.ts

@@ -1,7 +1,20 @@
-import type { PerformFunction, Search } from 'zapier-platform-core';
+import {
+  defineInputFields,
+  defineSearch,
+  type SearchPerform,
+  type InferInputData,
+} from 'zapier-platform-core';
+
+const inputFields = defineInputFields([
+  {
+    key: 'name',
+    required: true,
+    helpText: 'Find the <%= NOUN %> with this name.',
+  },
+]);
 
 // find a particular <%= LOWER_NOUN %> by name
-const perform: PerformFunction = async (z, bundle) => {
+const perform = (async (z, bundle) => {
   const response = await z.request({
     url: 'https://jsonplaceholder.typicode.com/posts',
     params: {
@@ -10,9 +23,9 @@ const perform: PerformFunction = async (z, bundle) => {
   });
   // this should return an array of objects (but only the first will be used)
   return response.data;
-};
+}) satisfies SearchPerform<InferInputData<typeof inputFields>>;
 
-export default {
+export default defineSearch({
   // see here for a full list of available properties:
   // https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#searchschema
   key: '<%= KEY %>',
@@ -30,13 +43,7 @@ export default {
       '// `inputFields` defines the fields a user could provide',
       '// Zapier will pass them in as `bundle.inputData` later. Searches need at least one `inputField`.'
     ].join('\n    ') : '' %>
-    inputFields: [
-      {
-        key: 'name',
-        required: true,
-        helpText: 'Find the <%= NOUN %> with this name.',
-      },
-    ],
+    inputFields,
 
     <%= INCLUDE_INTRO_COMMENTS ? [
     '// In cases where Zapier needs to show an example record to the user, but we are unable to get a live example',
@@ -60,4 +67,4 @@ export default {
       // {key: 'name', label: 'Person Name'}
     ],
   },
-} satisfies Search;
+});

package/scaffold/trigger.template.ts

@@ -1,7 +1,10 @@
-import type { PerformFunction, Trigger } from 'zapier-platform-core';
+import {
+  defineTrigger,
+  type PollingTriggerPerform,
+} from 'zapier-platform-core';
 
 // triggers on a new <%= LOWER_NOUN %> with a certain tag
-const perform: PerformFunction = async (z, bundle) => {
+const perform = (async (z, bundle) => {
   const response = await z.request({
     url: 'https://jsonplaceholder.typicode.com/posts',
     params: {
@@ -10,9 +13,9 @@ const perform: PerformFunction = async (z, bundle) => {
   });
   // this should return an array of objects
   return response.data;
-};
+}) satisfies PollingTriggerPerform;
 
-export default {
+export default defineTrigger({
   // see here for a full list of available properties:
   // https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#triggerschema
   key: '<%= KEY %>' as const,
@@ -55,4 +58,4 @@ export default {
       // {key: 'name', label: 'Person Name'}
     ],
   },
-} satisfies Trigger;
+});

package/src/generators/index.js

@@ -32,6 +32,18 @@ const writeGitignore = (gen) => {
 };
 
 const writeGenericPackageJson = (gen, packageJsonExtension) => {
+  const moduleExtension =
+    gen.options.module === 'esm'
+      ? {
+          exports: './index.js',
+          type: 'module',
+        }
+      : {
+          main: 'index.js',
+        };
+
+  const fullExtension = merge(moduleExtension, packageJsonExtension);
+
   gen.fs.writeJSON(
     gen.destinationPath('package.json'),
     merge(
@@ -39,7 +51,6 @@ const writeGenericPackageJson = (gen, packageJsonExtension) => {
         name: gen.options.packageName,
         version: '1.0.0',
         description: '',
-        main: 'index.js',
         scripts: {
           test: 'jest --testTimeout 10000',
         },
@@ -51,12 +62,24 @@ const writeGenericPackageJson = (gen, packageJsonExtension) => {
         },
         private: true,
       },
-      packageJsonExtension,
+      fullExtension,
     ),
   );
 };
 
 const writeTypeScriptPackageJson = (gen, packageJsonExtension) => {
+  const moduleExtension =
+    gen.options.module === 'esm'
+      ? {
+          exports: './dist/index.js',
+          type: 'module',
+        }
+      : {
+          main: 'index.js',
+        };
+
+  const fullExtension = merge(moduleExtension, packageJsonExtension);
+
   gen.fs.writeJSON(
     gen.destinationPath('package.json'),
     merge(
@@ -64,7 +87,6 @@ const writeTypeScriptPackageJson = (gen, packageJsonExtension) => {
         name: gen.options.packageName,
         version: '1.0.0',
         description: '',
-        main: 'src/index.js',
         scripts: {
           test: 'vitest',
         },
@@ -76,19 +98,40 @@ const writeTypeScriptPackageJson = (gen, packageJsonExtension) => {
         },
         private: true,
       },
-      packageJsonExtension,
+      fullExtension,
     ),
   );
 };
 
 const writeGenericIndex = (gen, hasAuth) => {
+  const templatePath =
+    gen.options.module === 'esm'
+      ? 'index-esm.template.js'
+      : 'index.template.js';
   gen.fs.copyTpl(
-    gen.templatePath('index.template.js'),
+    gen.templatePath(templatePath),
     gen.destinationPath('index.js'),
     { corePackageName: PLATFORM_PACKAGE, hasAuth },
   );
 };
 
+const writeTypeScriptIndex = (gen) => {
+  const templatePath =
+    gen.options.module === 'esm'
+      ? 'index-esm.template.ts'
+      : 'index.template.ts';
+  gen.fs.copyTpl(
+    gen.templatePath(templatePath),
+    gen.destinationPath('src/index.ts'),
+  );
+
+  // create root directory index.js if it's commonjs
+  if (gen.options.module === 'commonjs') {
+    const content = `module.exports = require('./dist').default;`;
+    gen.fs.write(gen.destinationPath('index.js'), content);
+  }
+};
+
 const authTypes = {
   'basic-auth': 'basic',
   'custom-auth': 'custom',
@@ -170,7 +213,7 @@ const writeForStandaloneTypeScriptTemplate = (gen) => {
   const packageJsonExtension = {
     typescript: {
       scripts: {
-        test: 'vitest',
+        test: 'vitest --run',
         clean: 'rimraf ./dist ./build',
         build: 'npm run clean && tsc',
         '_zapier-build': 'npm run build',
@@ -189,6 +232,7 @@ const writeForStandaloneTypeScriptTemplate = (gen) => {
     gen.templatePath(gen.options.template, '**', '*.{js,json,ts}'),
     gen.destinationPath(),
   );
+  writeTypeScriptIndex(gen);
 };
 
 const TEMPLATE_ROUTES = {
@@ -207,6 +251,8 @@ const TEMPLATE_ROUTES = {
   typescript: writeForStandaloneTypeScriptTemplate,
 };
 
+const ESM_SUPPORTED_TEMPLATES = ['minimal', 'typescript'];
+
 const TEMPLATE_CHOICES = Object.keys(TEMPLATE_ROUTES);
 
 class ProjectGenerator extends Generator {
@@ -235,6 +281,31 @@ class ProjectGenerator extends Generator {
       ]);
       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: ['commonjs', 'esm'],
+          message: 'Choose module type:',
+          default: 'commonjs',
+        },
+      ]);
+      this.options.module = this.answers.module;
+    }
+
+    if (
+      !ESM_SUPPORTED_TEMPLATES.includes(this.options.template) &&
+      this.options.module === 'esm'
+    ) {
+      throw new Error(
+        'ESM is not supported for this template, please use a different template or set the module to commonjs',
+      );
+    }
   }
 
   writing() {

package/src/generators/templates/index-esm.template.js

@@ -0,0 +1,36 @@
+<% if (hasAuth) { %>
+import {
+    config as authentication,
+    befores = [],
+    afters = [],
+} from './authentication';
+<% } %>
+
+import packageJson from './package.json' with { type: 'json' };
+import zapier from '<%= corePackageName %>';
+
+export default {
+    // This is just shorthand to reference the installed dependencies you have.
+    // Zapier will need to know these before we can upload.
+    version: packageJson.version,
+    platformVersion: zapier.version,
+
+    <% if (hasAuth) { %>
+    authentication,
+
+    beforeRequest: [...befores],
+
+    afterResponse: [...afters],
+    <% } %>
+
+    // If you want your trigger to show up, you better include it here!
+    triggers: {},
+
+    // If you want your searches to show up, you better include it here!
+    searches: {},
+
+    // If you want your creates to show up, you better include it here!
+    creates: {},
+
+    resources: {},
+};

package/src/generators/templates/index-esm.template.ts

@@ -0,0 +1,24 @@
+import zapier, { defineApp } from 'zapier-platform-core';
+
+import packageJson from '../package.json' with { type: 'json' };
+
+import MovieCreate from './creates/movie.js';
+import MovieTrigger from './triggers/movie.js';
+import authentication from './authentication.js';
+import { addBearerHeader } from './middleware.js';
+
+export default defineApp({
+  version: packageJson.version,
+  platformVersion: zapier.version,
+
+  authentication,
+  beforeRequest: [addBearerHeader],
+
+  triggers: {
+    [MovieTrigger.key]: MovieTrigger,
+  },
+
+  creates: {
+    [MovieCreate.key]: MovieCreate,
+  },
+});

package/src/generators/templates/{typescript/src/index.ts → index.template.ts}

@@ -1,5 +1,4 @@
-import type { App } from 'zapier-platform-core';
-import { version as platformVersion } from 'zapier-platform-core';
+import { version as platformVersion, defineApp } from 'zapier-platform-core';
 
 import packageJson from '../package.json';
 
@@ -8,7 +7,7 @@ import MovieTrigger from './triggers/movie';
 import authentication from './authentication';
 import { addBearerHeader } from './middleware';
 
-export default {
+export default defineApp({
   version: packageJson.version,
   platformVersion,
 
@@ -22,4 +21,4 @@ export default {
   creates: {
     [MovieCreate.key]: MovieCreate,
   },
-} satisfies App;
+});

package/src/generators/templates/typescript/src/authentication.ts

@@ -1,6 +1,6 @@
 import type { Authentication } from 'zapier-platform-core';
 
-import { API_URL, SCOPES } from './constants';
+import { API_URL, SCOPES } from './constants.js';
 
 export default {
   type: 'oauth2',

package/src/generators/templates/typescript/src/creates/movie.ts

@@ -1,7 +1,17 @@
-import type { Create, PerformFunction } from 'zapier-platform-core';
-import { API_URL } from '../constants';
+import {
+  defineInputFields,
+  defineCreate,
+  type CreatePerform,
+  type InferInputData,
+} from 'zapier-platform-core';
+import { API_URL } from '../constants.js';
 
-const perform: PerformFunction = async (z, bundle) => {
+const inputFields = defineInputFields([
+  { key: 'title', required: true },
+  { key: 'year', type: 'integer' },
+]);
+
+const perform = (async (z, bundle) => {
   const response = await z.request({
     method: 'POST',
     url: `${API_URL}/movies`,
@@ -11,9 +21,9 @@ const perform: PerformFunction = async (z, bundle) => {
     },
   });
   return response.data;
-};
+}) satisfies CreatePerform<InferInputData<typeof inputFields>>;
 
-export default {
+export default defineCreate({
   key: 'movie',
   noun: 'Movie',
 
@@ -24,13 +34,10 @@ export default {
 
   operation: {
     perform,
-    inputFields: [
-      { key: 'title', required: true },
-      { key: 'year', type: 'integer' },
-    ],
+    inputFields,
     sample: {
       id: '1',
       title: 'example',
     },
   },
-} satisfies Create;
+});

package/src/generators/templates/typescript/src/test/creates.test.ts

@@ -10,7 +10,7 @@ describe('movie', () => {
   test('create a movie', async () => {
     const bundle = {
       inputData: { title: 'hello', year: 2020 },
-      authData: { access_token: 'a_token' }, 
+      authData: { access_token: 'a_token' },
     };
     const result = await appTester(App.creates.movie.operation.perform, bundle);
     expect(result).toMatchObject({

package/src/generators/templates/typescript/src/triggers/movie.ts

@@ -1,12 +1,15 @@
-import type { PerformFunction, Trigger } from 'zapier-platform-core';
-import { API_URL } from '../constants';
+import {
+  defineTrigger,
+  type PollingTriggerPerform,
+} from 'zapier-platform-core';
+import { API_URL } from '../constants.js';
 
-const perform: PerformFunction = async (z, bundle) => {
+const perform = (async (z, bundle) => {
   const response = await z.request(`${API_URL}/movies`);
   return response.data;
-};
+}) satisfies PollingTriggerPerform;
 
-export default {
+export default defineTrigger({
   key: 'movie',
   noun: 'Movie',
 
@@ -23,4 +26,4 @@ export default {
       title: 'example',
     },
   },
-} satisfies Trigger;
+});

package/src/oclif/commands/build.js

@@ -51,7 +51,7 @@ This command does the following:
 * Copies all code into the temporary folder
 * Adds an entry point: \`zapierwrapper.js\`
 * Generates and validates app definition.
-* Detects dependencies via browserify (optional, on by default)
+* Detects dependencies via esbuild (optional, on by default)
 * Zips up all needed \`.js\` files. If you want to include more files, add a "includeInBuild" property (array with strings of regexp paths) to your \`${CURRENT_APP_FILE}\`.
 * Moves the zip to \`${BUILD_PATH}\` and \`${SOURCE_PATH}\` and deletes the temp folder
 

package/src/oclif/commands/init.js

@@ -10,12 +10,12 @@ const { TEMPLATE_CHOICES, ProjectGenerator } = require('../../generators');
 class InitCommand extends BaseCommand {
   async perform() {
     const { path } = this.args;
-    const { template } = this.flags;
+    const { template, module } = this.flags;
 
     const env = yeoman.createEnv();
     env.registerStub(ProjectGenerator, 'zapier:integration');
 
-    await env.run('zapier:integration', { path, template });
+    await env.run('zapier:integration', { path, template, module });
 
     this.log();
     this.log(`A new integration has been created in directory "${path}".`);
@@ -30,6 +30,12 @@ InitCommand.flags = buildFlags({
       description: 'The template to start your integration with.',
       options: TEMPLATE_CHOICES,
     }),
+    module: Flags.string({
+      char: 'm',
+      description:
+        'Choose module type: CommonJS or ES Modules. Only enabled for Typescript and Minimal templates.',
+      options: ['commonjs', 'esm'],
+    }),
   },
 });
 InitCommand.args = {
@@ -42,6 +48,7 @@ InitCommand.args = {
 InitCommand.examples = [
   'zapier init myapp',
   'zapier init ./path/myapp --template oauth2',
+  'zapier init ./path/myapp --template minimal --module esm',
 ];
 InitCommand.description = `Initialize a new Zapier integration with a project template.
 

package/src/oclif/commands/invoke.js

@@ -13,7 +13,7 @@ const { DateTime, IANAZone } = require('luxon');
 
 const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
-const { localAppCommand, getLocalAppHandler } = require('../../utils/local');
+const { localAppCommand } = require('../../utils/local');
 const { startSpinner, endSpinner } = require('../../utils/display');
 const {
   getLinkedAppConfig,
@@ -510,10 +510,6 @@ class InvokeCommand extends BaseCommand {
     }
 
     if (!_.isEmpty(env)) {
-      // process.env changed, so we need to reload the modules that have loaded
-      // the old values of process.env
-      getLocalAppHandler({ reload: true });
-
       // Save envs so the user won't have to re-enter them if the command fails
       await appendEnv(env);
       console.warn('CLIENT_ID and CLIENT_SECRET saved to .env file.');

package/src/utils/build.js

@@ -2,10 +2,9 @@ const crypto = require('crypto');
 const os = require('os');
 const path = require('path');
 
-const browserify = require('browserify');
-const through = require('through2');
 const _ = require('lodash');
 const archiver = require('archiver');
+const esbuild = require('esbuild');
 const fs = require('fs');
 const fse = require('fs-extra');
 const klaw = require('klaw');
@@ -20,13 +19,7 @@ const {
 
 const constants = require('../constants');
 
-const {
-  writeFile,
-  readFile,
-  copyDir,
-  ensureDir,
-  removeDir,
-} = require('./files');
+const { writeFile, copyDir, ensureDir, removeDir } = require('./files');
 
 const {
   prettyJSONstringify,
@@ -42,67 +35,39 @@ const {
   validateApp,
 } = require('./api');
 
+const { copyZapierWrapper } = require('./zapierwrapper');
+
 const checkMissingAppInfo = require('./check-missing-app-info');
 
 const { runCommand, isWindows, findCorePackageDir } = require('./misc');
 const { respectGitIgnore } = require('./ignore');
+const { localAppCommand } = require('./local');
 
 const debug = require('debug')('zapier:build');
 
 const stripPath = (cwd, filePath) => filePath.split(cwd).pop();
 
 // given entry points in a directory, return a list of files that uses
-// could probably be done better with module-deps...
-// TODO: needs to include package.json files too i think
-//   https://github.com/serverless/serverless-optimizer-plugin?
-const requiredFiles = (cwd, entryPoints) => {
+const requiredFiles = async ({ cwd, entryPoints }) => {
   if (!_.endsWith(cwd, path.sep)) {
     cwd += path.sep;
   }
 
-  const argv = {
-    noParse: [undefined],
-    extensions: [],
-    ignoreTransform: [],
-    entries: entryPoints,
-    fullPaths: false,
-    builtins: false,
-    commondir: false,
-    bundleExternal: true,
-    basedir: cwd,
-    browserField: false,
-    detectGlobals: true,
-    insertGlobals: false,
-    insertGlobalVars: {
-      process: undefined,
-      global: undefined,
-      'Buffer.isBuffer': undefined,
-      Buffer: undefined,
-    },
-    ignoreMissing: true,
-    debug: false,
-    standalone: undefined,
-  };
-  const b = browserify(argv);
-
-  return new Promise((resolve, reject) => {
-    b.on('error', reject);
-
-    const paths = [];
-    b.pipeline.get('deps').push(
-      through
-        .obj((row, enc, next) => {
-          const filePath = row.file || row.id;
-          paths.push(stripPath(cwd, filePath));
-          next();
-        })
-        .on('end', () => {
-          paths.sort();
-          resolve(paths);
-        }),
-    );
-    b.bundle();
+  const result = await esbuild.build({
+    entryPoints,
+    outdir: './build',
+    bundle: true,
+    platform: 'node',
+    metafile: true,
+    logLevel: 'warning',
+    external: ['../test/userapp'],
+    format: 'esm',
+    write: false, // no need to write outfile
   });
+
+  return Object.keys(result.metafile.inputs).map((path) =>
+    stripPath(cwd, path),
+  );
 };
 
 const listFiles = (dir) => {
@@ -194,16 +159,21 @@ const writeZipFromPaths = (dir, zipPath, paths) => {
 };
 
 const makeZip = async (dir, zipPath, disableDependencyDetection) => {
-  const entryPoints = [
-    path.resolve(dir, 'zapierwrapper.js'),
-    path.resolve(dir, 'index.js'),
-  ];
+  const entryPoints = [path.resolve(dir, 'zapierwrapper.js')];
+
+  const indexPath = path.resolve(dir, 'index.js');
+  if (fs.existsSync(indexPath)) {
+    // Necessary for CommonJS integrations. The zapierwrapper they use require()
+    // the index.js file using a variable. esbuild can't detect it, so we need
+    // to add it here specifically.
+    entryPoints.push(indexPath);
+  }
 
   let paths;
 
   const [dumbPaths, smartPaths, appConfig] = await Promise.all([
     listFiles(dir),
-    requiredFiles(dir, entryPoints),
+    requiredFiles({ cwd: dir, entryPoints }),
     getLinkedAppConfig(dir).catch(() => ({})),
   ]);
 
@@ -234,24 +204,6 @@ const makeSourceZip = async (dir, zipPath) => {
   await writeZipFromPaths(dir, zipPath, finalPaths);
 };
 
-// Similar to utils.appCommand, but given a ready to go app
-// with a different location and ready to go zapierwrapper.js.
-const _appCommandZapierWrapper = (dir, event) => {
-  const app = require(`${dir}/zapierwrapper.js`);
-  event = Object.assign({}, event, {
-    calledFromCli: true,
-  });
-  return new Promise((resolve, reject) => {
-    app.handler(event, {}, (err, resp) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve(resp);
-      }
-    });
-  });
-};
-
 const maybeNotifyAboutOutdated = () => {
   // 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
@@ -417,35 +369,21 @@ const _buildFunc = async ({
 
   if (printProgress) {
     endSpinner();
-    startSpinner('Applying entry point file');
+    startSpinner('Applying entry point files');
   }
 
-  // TODO: should this routine for include exist elsewhere?
-  const zapierWrapperBuf = await readFile(
-    path.join(
-      tmpDir,
-      'node_modules',
-      constants.PLATFORM_PACKAGE,
-      'include',
-      'zapierwrapper.js',
-    ),
-  );
-  await writeFile(
-    path.join(tmpDir, 'zapierwrapper.js'),
-    zapierWrapperBuf.toString(),
-  );
+  await copyZapierWrapper(corePath, tmpDir);
 
   if (printProgress) {
     endSpinner();
     startSpinner('Building app definition.json');
   }
 
-  const rawDefinition = (
-    await _appCommandZapierWrapper(tmpDir, {
-      command: 'definition',
-    })
-  ).results;
-
+  const rawDefinition = await localAppCommand(
+    { command: 'definition' },
+    tmpDir,
+    false,
+  );
   const fileWriteError = await writeFile(
     path.join(tmpDir, 'definition.json'),
     prettyJSONstringify(rawDefinition),
@@ -472,11 +410,11 @@ const _buildFunc = async ({
     if (printProgress) {
       startSpinner('Validating project schema and style');
     }
-    const validateResponse = await _appCommandZapierWrapper(tmpDir, {
-      command: 'validate',
-    });
-
-    const validationErrors = validateResponse.results;
+    const validationErrors = await localAppCommand(
+      { command: 'validate' },
+      tmpDir,
+      false,
+    );
     if (validationErrors.length) {
       debug('\nErrors:\n', validationErrors, '\n');
       throw new Error(

package/src/utils/local.js

@@ -1,8 +1,8 @@
-const _ = require('lodash');
-const path = require('path');
+const path = require('node:path');
 
-const { findCorePackageDir } = require('./misc');
 const { BASE_ENDPOINT } = require('../constants');
+const { findCorePackageDir, runCommand } = require('./misc');
+const { copyZapierWrapper, deleteZapierWrapper } = require('./zapierwrapper');
 
 /**
  * Wraps Node's http.request() / https.request() so that all requests go via a relay URL.
@@ -218,34 +218,75 @@ function wrapFetchWithRelay(fetchFunc, relayUrl, relayHeaders) {
   };
 }
 
-const getLocalAppHandler = ({
-  reload = false,
-  baseEvent = {},
+const loadAppRawUsingImport = async (
+  appDir,
+  corePackageDir,
+  shouldDeleteWrapper,
+) => {
+  const wrapperPath = await copyZapierWrapper(corePackageDir, appDir);
+  let appRaw;
+  try {
+    // zapierwrapper.mjs is only available since zapier-platform-core v17.
+    // And only zapierwrapper.mjs exposes appRaw just for this use case.
+    appRaw = (await import(wrapperPath)).appRaw;
+  } catch (err) {
+    if (err.name === 'SyntaxError') {
+      // Run a separate process to print the line number of the SyntaxError.
+      // This workaround is needed because `err` doesn't provide the location
+      // info about the SyntaxError. However, if the error is thrown to
+      // Node.js's built-in error handler, it will print the location info.
+      // See: https://github.com/nodejs/node/issues/49441
+      await runCommand(process.execPath, ['zapierwrapper.js'], {
+        cwd: appDir,
+      });
+    }
+    throw err;
+  } finally {
+    if (shouldDeleteWrapper) {
+      await deleteZapierWrapper(appDir);
+    }
+  }
+
+  return appRaw;
+};
+
+const loadAppRawUsingRequire = (appDir) => {
+  let appRaw = require(appDir);
+  if (appRaw && appRaw.default) {
+    // Node.js 22+ supports using require() to import ESM.
+    // For Node.js < 20.17.0, require() will throw an error on ESM.
+    // https://nodejs.org/api/modules.html#loading-ecmascript-modules-using-require
+    appRaw = appRaw.default;
+  }
+  return appRaw;
+};
+
+const getLocalAppHandler = async ({
+  appDir = null,
   appId = null,
   deployKey = null,
   relayAuthenticationId = null,
   beforeRequest = null,
   afterResponse = null,
+  shouldDeleteWrapper = true,
 } = {}) => {
-  const entryPath = `${process.cwd()}/index`;
-  const rootPath = path.dirname(require.resolve(entryPath));
-  const corePackageDir = findCorePackageDir();
+  appDir = path.resolve(appDir || process.cwd());
 
-  if (reload) {
-    Object.keys(require.cache).forEach((cachePath) => {
-      if (cachePath.startsWith(rootPath)) {
-        delete require.cache[cachePath];
-      }
-    });
-  }
-  let appRaw, zapier;
+  const corePackageDir = findCorePackageDir();
+  let appRaw;
   try {
-    appRaw = require(entryPath);
-    zapier = require(corePackageDir);
+    appRaw = loadAppRawUsingRequire(appDir);
   } catch (err) {
-    // this err.stack doesn't give a nice traceback at all :-(
-    // maybe we could do require('syntax-error') in the future
-    return (event, ctx, callback) => callback(err);
+    if (err.code === 'MODULE_NOT_FOUND' || err.code === 'ERR_REQUIRE_ESM') {
+      appRaw = await loadAppRawUsingImport(
+        appDir,
+        corePackageDir,
+        shouldDeleteWrapper,
+      );
+    } else {
+      // err.name === 'SyntaxError' or others
+      throw err;
+    }
   }
 
   if (beforeRequest) {
@@ -282,41 +323,65 @@ const getLocalAppHandler = ({
     global.fetch = wrapFetchWithRelay(global.fetch, relayUrl, relayHeaders);
   }
 
+  // Assumes the entry point of zapier-platform-core is index.js
+  const coreEntryPoint = path.join(corePackageDir, 'index.js');
+  const zapier = (await import(coreEntryPoint)).default;
+
   const handler = zapier.createAppHandler(appRaw);
-  return (event, ctx, callback) => {
-    event = _.merge(
-      {},
-      event,
-      {
+  if (handler.length === 3) {
+    // < v17: function handler(event, ctx, callback)
+    return (event, ctx, callback) => {
+      event = {
+        ...event,
         calledFromCli: true,
-      },
-      baseEvent,
-    );
-    handler(event, _, callback);
-  };
+      };
+      return handler(event, ctx, callback);
+    };
+  } else {
+    // >= v17: async function handler(event, ctx = {})
+    return async (event, ctx = {}) => {
+      event = {
+        ...event,
+        calledFromCli: true,
+      };
+      return await handler(event, ctx);
+    };
+  }
 };
 
 // Runs a local app command (./index.js) like {command: 'validate'};
-const localAppCommand = (event) => {
-  const handler = getLocalAppHandler({
+const localAppCommand = async (event, appDir, shouldDeleteWrapper = true) => {
+  const handler = await getLocalAppHandler({
     appId: event.appId,
     deployKey: event.deployKey,
     relayAuthenticationId: event.relayAuthenticationId,
     beforeRequest: event.beforeRequest,
     afterResponse: event.afterResponse,
+    appDir,
+    shouldDeleteWrapper,
   });
-  return new Promise((resolve, reject) => {
-    handler(event, {}, (err, resp) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve(resp.results);
-      }
+  if (handler.length === 3) {
+    // < 17: function handler(event, ctx, callback)
+    return new Promise((resolve, reject) => {
+      event = {
+        ...event,
+        calledFromCli: true,
+      };
+      handler(event, {}, (err, response) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(response.results);
+        }
+      });
     });
-  });
+  } else {
+    // >= 17: async function handler(event, ctx = {})
+    const response = await handler(event);
+    return response.results;
+  }
 };
 
 module.exports = {
-  getLocalAppHandler,
   localAppCommand,
 };

package/src/utils/zapierwrapper.js

@@ -0,0 +1,55 @@
+// Utility functions that helps you copy and delete the Lambda function entry
+// point zapierwrapper.mjs or zapierwrapper.js to the integration directory.
+
+const { existsSync } = require('node:fs');
+const { readFile, writeFile, rm } = require('node:fs/promises');
+const { join } = require('node:path');
+
+// We have two different versions of zapierwrapper: the .mjs one for ESM and the
+// .js one for CommonJS. To copy the right one, we check the module type in the
+// integration's package.json.
+//
+// For esbuild to perform static analysis, zapierwrapper.mjs can only
+// import('packageName') where the packageName must be a static string literal.
+// It can't import(packageName) where packageName is a variable. So in
+// zapierwrapper.mjs, there's a placeholder {REPLACE_ME_PACKAGE_NAME} that
+// we'll replace with the actual package name.
+const copyZapierWrapper = async (corePackageDir, appDir) => {
+  const appPackageJson = require(join(appDir, 'package.json'));
+  let wrapperFilename;
+  if (appPackageJson.type === 'module') {
+    wrapperFilename = 'zapierwrapper.mjs';
+  } else {
+    wrapperFilename = 'zapierwrapper.js';
+  }
+  const wrapperPath = join(corePackageDir, 'include', wrapperFilename);
+
+  if (appPackageJson.type === 'module' && !existsSync(wrapperPath)) {
+    throw new Error(
+      "Couldn't find zapierwrapper.mjs in zapier-platform-core. Are you trying to run ESM? " +
+        'If so, you need to upgrade zapier-platform-core to at least v17.',
+    );
+  }
+
+  const wrapperText = (await readFile(wrapperPath, 'utf8')).replace(
+    '{REPLACE_ME_PACKAGE_NAME}',
+    appPackageJson.name,
+  );
+  const wrapperDest = join(appDir, 'zapierwrapper.js');
+  await writeFile(wrapperDest, wrapperText);
+  return wrapperDest;
+};
+
+const deleteZapierWrapper = async (appDir) => {
+  const wrapperPath = join(appDir, 'zapierwrapper.js');
+  try {
+    await rm(wrapperPath);
+  } catch (err) {
+    // ignore
+  }
+};
+
+module.exports = {
+  copyZapierWrapper,
+  deleteZapierWrapper,
+};

package/src/version-store.js

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

package/src/generators/templates/typescript/index.js

@@ -1 +0,0 @@
-module.exports = require('./dist').default;