zapier-platform-cli 16.5.0 → 17.0.0

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/oclif/commands/versions.js

@@ -1,29 +1,10 @@
 const colors = require('colors/safe');
-
+const { Flags } = require('@oclif/core');
 const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
 
 const { listVersions } = require('../../utils/api');
 
-const deploymentToLifecycleState = (deployment) => {
-  switch (deployment) {
-    case 'non-production':
-      return 'private';
-    case 'production':
-      return 'promoted';
-    case 'demoted':
-      return 'available';
-    case 'legacy':
-      return 'legacy';
-    case 'deprecating':
-      return 'deprecating';
-    case 'deprecated':
-      return 'deprecated';
-    default:
-      return deployment;
-  }
-};
-
 class VersionCommand extends BaseCommand {
   async perform() {
     this.startSpinner('Loading versions');
@@ -31,11 +12,15 @@ class VersionCommand extends BaseCommand {
     this.stopSpinner();
     const rows = versions.map((v) => ({
       ...v,
-      state: deploymentToLifecycleState(v.lifecycle.status),
+      state: v.lifecycle.status,
     }));
 
+    const visibleVersions = this.flags.all
+      ? rows
+      : rows.filter((v) => v.state !== 'deprecated');
+
     this.logTable({
-      rows,
+      rows: visibleVersions,
       headers: [
         ['Version', 'version'],
         ['Platform', 'platform_version'],
@@ -81,7 +66,15 @@ class VersionCommand extends BaseCommand {
 }
 
 VersionCommand.skipValidInstallCheck = true;
-VersionCommand.flags = buildFlags({ opts: { format: true } });
+VersionCommand.flags = buildFlags({
+  commandFlags: {
+    all: Flags.boolean({
+      char: 'a',
+      description: `List all versions, including deprecated versions.`,
+    }),
+  },
+  opts: { format: true },
+});
 VersionCommand.description = `List the versions of your integration available for use in Zapier automations.`;
 
 module.exports = VersionCommand;