zapier-platform-cli 15.16.0 → 15.17.0

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

@@ -1,11 +1,6 @@
-import { Bundle, ZObject } from 'zapier-platform-core';
+import { Create, PerformFunction } from 'zapier-platform-core';
 
-// You can optionally add add the shape of the inputData in bundle, which will pass that
-// info down into the function and tests
-const perform = async (
-  z: ZObject,
-  bundle: Bundle<{ title: string; year: number }>
-) => {
+const perform: PerformFunction = async (z, bundle) => {
   const response = await z.request({
     method: 'POST',
     url: 'https://auth-json-server.zapier-staging.com/movies',
@@ -37,4 +32,4 @@ export default {
       title: 'example',
     },
   },
-};
+} satisfies Create;

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

@@ -1,16 +1,12 @@
-import { Bundle, HttpRequestOptions, ZObject } from 'zapier-platform-core';
+import type { App, BeforeRequestMiddleware } from 'zapier-platform-core';
 
 import MovieCreate from './creates/movie';
 import MovieTrigger from './triggers/movie';
 import { version as platformVersion } from 'zapier-platform-core';
 
-const { version } = require('../package.json');
+import packageJson from '../package.json';
 
-const addApiKeyHeader = (
-  req: HttpRequestOptions,
-  z: ZObject,
-  bundle: Bundle
-) => {
+const addApiKeyHeader: BeforeRequestMiddleware = (req, z, bundle) => {
   // Hard-coded api key just to demo. DON'T do auth like this for your production app!
   req.headers = req.headers || {};
   req.headers['X-Api-Key'] = 'secret';
@@ -18,7 +14,7 @@ const addApiKeyHeader = (
 };
 
 export default {
-  version,
+  version: packageJson.version,
   platformVersion,
 
   beforeRequest: [addApiKeyHeader],
@@ -30,4 +26,4 @@ export default {
   creates: {
     [MovieCreate.key]: MovieCreate,
   },
-};
+} satisfies App;

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

@@ -1,6 +1,5 @@
-/* globals describe, expect, test */
-
 import { createAppTester, tools } from 'zapier-platform-core';
+import { describe, test, expect } from 'vitest';
 
 import App from '../index';
 

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

@@ -1,6 +1,5 @@
-/* globals describe, expect, test */
-
-import { Bundle, createAppTester, tools } from 'zapier-platform-core';
+import { createAppTester, tools } from 'zapier-platform-core';
+import { describe, test, expect } from 'vitest';
 
 import App from '../index';
 

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

@@ -1,6 +1,6 @@
-import { Bundle, ZObject } from 'zapier-platform-core';
+import { PerformFunction, Trigger } from 'zapier-platform-core';
 
-const perform = async (z: ZObject, bundle: Bundle) => {
+const perform: PerformFunction = async (z, bundle) => {
   const response = await z.request(
     'https://auth-json-server.zapier-staging.com/movies'
   );
@@ -17,10 +17,11 @@ export default {
   },
 
   operation: {
+    type: 'polling',
     perform,
     sample: {
       id: '1',
       title: 'example',
     },
   },
-};
+} satisfies Trigger;

package/src/generators/templates/typescript/tsconfig.json

@@ -1,11 +1,16 @@
 {
   "compilerOptions": {
-    "target": "es2019",
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "lib": ["esnext"],
-    "outDir": "./lib",
+    "target": "ESNext",
+    "module": "CommonJS",
+    "moduleResolution": "Node",
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "skipLibCheck": true,
+    "outDir": "./dist",
     "rootDir": "./src",
     "strict": true
-  }
+  },
+  "include": ["./src/**/*.ts"],
+  "exclude": ["./**/*.test.ts"]
 }

package/src/oclif/ZapierBaseCommand.js

@@ -15,6 +15,7 @@ const DATA_FORMATS = ['json', 'raw'];
 
 class ZapierBaseCommand extends Command {
   run() {
+    this._initPromptModules();
     this._parseFlags();
 
     if (this.flags.debug) {
@@ -59,6 +60,13 @@ class ZapierBaseCommand extends Command {
     return Object.getPrototypeOf(this).constructor;
   }
 
+  _initPromptModules() {
+    this._stdoutPrompt = inquirer.prompt;
+    this._stderrPrompt = inquirer.createPromptModule({
+      output: process.stderr,
+    });
+  }
+
   _parseFlags() {
     const { flags, args } = this.parse(this._staticClassReference);
 
@@ -205,7 +213,8 @@ class ZapierBaseCommand extends Command {
     if (Object.keys(opts).length) {
       opts.validate = this._getCustomValidatation(opts);
     }
-    const { ans } = await inquirer.prompt({
+    const prompt = opts.useStderr ? this._stderrPrompt : this._stdoutPrompt;
+    const { ans } = await prompt({
       type: 'string',
       ...opts,
       name: 'ans',
@@ -214,18 +223,23 @@ class ZapierBaseCommand extends Command {
     return ans;
   }
 
-  promptHidden(question) {
+  promptHidden(question, useStderr = false) {
     return this.prompt(question, {
       type: 'password',
       mask: true,
+      useStderr,
     });
   }
 
-  confirm(message, defaultAns = false, showCtrlC = false) {
+  confirm(message, defaultAns = false, showCtrlC = false, useStderr = false) {
     if (showCtrlC) {
       message += ' (Ctrl-C to cancel)';
     }
-    return this.prompt(message, { default: defaultAns, type: 'confirm' });
+    return this.prompt(message, {
+      default: defaultAns,
+      type: 'confirm',
+      useStderr,
+    });
   }
 
   // see here for options for choices: https://github.com/SBoudrias/Inquirer.js/#question
@@ -290,7 +304,7 @@ class ZapierBaseCommand extends Command {
         )
         .filter(Boolean);
 
-    const descriptionParts = this.description.split('\n').filter(Boolean);
+    const descriptionParts = this.description.split('\n\n').filter(Boolean);
     const blurb = descriptionParts[0];
     const lengthyDescription = colors.stripColors(
       descriptionParts.length > 1 ? descriptionParts.slice(1).join('\n\n') : ''