zapier-platform-cli 16.5.1 → 17.0.0

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.",
@@ -1780,88 +1793,6 @@
         "list.js"
       ]
     },
-    "delete:integration": {
-      "aliases": [
-        "delete:app"
-      ],
-      "args": {},
-      "description": "Delete your integration (including all versions).\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.",
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "delete:integration",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "delete",
-        "integration.js"
-      ]
-    },
-    "delete:version": {
-      "aliases": [],
-      "args": {
-        "version": {
-          "description": "Specify the version to delete. It must have no users or Zaps.",
-          "name": "version",
-          "required": true
-        }
-      },
-      "description": "Delete a specific version of your integration.\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier migrate` and `zapier deprecate` before this command will work.",
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "delete:version",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "delete",
-        "version.js"
-      ]
-    },
     "env:get": {
       "aliases": [],
       "args": {
@@ -2038,6 +1969,88 @@
         "unset.js"
       ]
     },
+    "delete:integration": {
+      "aliases": [
+        "delete:app"
+      ],
+      "args": {},
+      "description": "Delete your integration (including all versions).\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.",
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "delete:integration",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "delete",
+        "integration.js"
+      ]
+    },
+    "delete:version": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "description": "Specify the version to delete. It must have no users or Zaps.",
+          "name": "version",
+          "required": true
+        }
+      },
+      "description": "Delete a specific version of your integration.\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier migrate` and `zapier deprecate` before this command will work.",
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "delete:version",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "delete",
+        "version.js"
+      ]
+    },
     "team:add": {
       "aliases": [
         "team:invite"
@@ -2417,5 +2430,5 @@
       ]
     }
   },
-  "version": "16.5.1"
+  "version": "17.0.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "16.5.1",
+  "version": "17.0.0",
   "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,
+  },
+});