zapier-platform-cli 17.3.0 → 17.4.0

package/oclif.manifest.json

@@ -402,7 +402,8 @@
       "examples": [
         "zapier init myapp",
         "zapier init ./path/myapp --template oauth2",
-        "zapier init ./path/myapp --template minimal --module esm"
+        "zapier init ./path/myapp --template minimal --module esm",
+        "zapier init ./path/myapp --template oauth2 --language typescript"
       ],
       "flags": {
         "template": {
@@ -423,8 +424,7 @@
             "oauth2",
             "openai",
             "search-or-create",
-            "session-auth",
-            "typescript"
+            "session-auth"
           ],
           "type": "option"
         },
@@ -440,6 +440,18 @@
           ],
           "type": "option"
         },
+        "language": {
+          "char": "l",
+          "description": "Choose the language to use for your new integration. Defaults to JavaScript.",
+          "name": "language",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "javascript",
+            "typescript"
+          ],
+          "type": "option"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -2493,5 +2505,5 @@
       ]
     }
   },
-  "version": "17.3.0"
+  "version": "17.4.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "17.3.0",
+  "version": "17.4.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",

package/scaffold/resource.template.ts

@@ -1,18 +1,34 @@
-import type { PerformFunction, Resource } from 'zapier-platform-core';
+import {
+  defineInputFields,
+  type CreatePerform,
+  type InferInputData,
+  type PollingTriggerPerform,
+  type Resource,
+  type SearchPerform,
+} from 'zapier-platform-core';
 
 // get a list of <%= LOWER_NOUN %>s
-const performList: PerformFunction = async (z, bundle) => {
+const performList = (async (z, bundle) => {
   const response = await z.request({
     url: 'https://jsonplaceholder.typicode.com/posts',
     params: {
       order_by: 'id desc',
+      tag: bundle.inputData.tagName,
     },
   });
   return response.data;
-};
+}) satisfies PollingTriggerPerform;
+
+const searchInputFields = defineInputFields([
+  {
+    key: 'name',
+    required: true,
+    helpText: 'Find the <%= NOUN %> with this name.',
+  },
+]);
 
 // find a particular <%= LOWER_NOUN %> by name (or other search criteria)
-const performSearch: PerformFunction = async (z, bundle) => {
+const performSearch = (async (z, bundle) => {
   const response = await z.request({
     url: 'https://jsonplaceholder.typicode.com/posts',
     params: {
@@ -20,10 +36,15 @@ const performSearch: PerformFunction = async (z, bundle) => {
     },
   });
   return response.data;
-};
+}) satisfies SearchPerform<InferInputData<typeof searchInputFields>>;
+
+const createInputFields = defineInputFields([
+  { key: 'name', required: true },
+  { key: 'fave_meal', label: 'Favorite Meal', required: false },
+]);
 
 // creates a new <%= LOWER_NOUN %>
-const performCreate: PerformFunction = async (z, bundle) => {
+const performCreate = (async (z, bundle) => {
   const response = await z.request({
     method: 'POST',
     url: 'https://jsonplaceholder.typicode.com/posts',
@@ -32,7 +53,7 @@ const performCreate: PerformFunction = async (z, bundle) => {
     },
   });
   return response.data;
-};
+}) satisfies CreatePerform<InferInputData<typeof createInputFields>>;
 
 export default {
   // see here for a full list of available properties:
@@ -78,7 +99,7 @@ export default {
       description: 'Finds a <%= LOWER_NOUN %> give.',
     },
     operation: {
-      inputFields: [{ key: 'name', required: true }],
+      inputFields: searchInputFields,
       perform: performSearch,
     },
   },
@@ -89,7 +110,7 @@ export default {
       description: 'Creates a new <%= LOWER_NOUN %>.',
     },
     operation: {
-      inputFields: [{ key: 'name', required: true }],
+      inputFields: createInputFields,
       perform: performCreate,
     },
   },

package/src/generators/index.js

@@ -67,19 +67,7 @@ const writeGenericPackageJson = (gen, packageJsonExtension) => {
   );
 };
 
-const writeTypeScriptPackageJson = (gen, packageJsonExtension) => {
-  const moduleExtension =
-    gen.options.module === 'esm'
-      ? {
-          exports: './dist/index.js',
-          type: 'module',
-        }
-      : {
-          main: 'index.js',
-        };
-
-  const fullExtension = merge(moduleExtension, packageJsonExtension);
-
+const writeGenericTypeScriptPackageJson = (gen, packageJsonExtension) => {
   gen.fs.writeJSON(
     gen.destinationPath('package.json'),
     merge(
@@ -88,17 +76,24 @@ const writeTypeScriptPackageJson = (gen, packageJsonExtension) => {
         version: '1.0.0',
         description: '',
         scripts: {
-          test: 'vitest',
+          test: 'npm run build && vitest --run',
+          clean: 'rimraf ./dist ./build',
+          build: 'npm run clean && tsc',
+          '_zapier-build': 'npm run build',
         },
         dependencies: {
           [PLATFORM_PACKAGE]: PACKAGE_VERSION,
         },
         devDependencies: {
+          rimraf: '^5.0.10',
+          typescript: '5.6.2',
           vitest: '^2.1.2',
         },
         private: true,
+        exports: './dist/index.js',
+        type: 'module',
       },
-      fullExtension,
+      packageJsonExtension,
     ),
   );
 };
@@ -115,21 +110,12 @@ const writeGenericIndex = (gen, hasAuth) => {
   );
 };
 
-const writeTypeScriptIndex = (gen) => {
-  const templatePath =
-    gen.options.module === 'esm'
-      ? 'index-esm.template.ts'
-      : 'index.template.ts';
+const writeGenericTypescriptIndex = (gen) => {
   gen.fs.copyTpl(
-    gen.templatePath(templatePath),
+    gen.templatePath('index.template.ts'),
     gen.destinationPath('src/index.ts'),
+    { corePackageName: PLATFORM_PACKAGE },
   );
-
-  // 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 = {
@@ -143,15 +129,23 @@ const authTypes = {
 
 const writeGenericAuth = (gen) => {
   const authType = authTypes[gen.options.template];
-  const content = authFilesCodegen[authType]();
-  gen.fs.write(gen.destinationPath('authentication.js'), content);
+  const content = authFilesCodegen[authType](gen.options.language);
+  const destPath =
+    gen.options.language === 'typescript'
+      ? 'src/authentication.ts'
+      : 'authentication.js';
+  gen.fs.write(gen.destinationPath(destPath), content);
 };
 
 const writeGenericAuthTest = (gen) => {
   const authType = authTypes[gen.options.template];
+  const fileExtension = gen.options.language === 'typescript' ? 'ts' : 'js';
+  const destPath = gen.options.language === 'typescript' ? 'src/test' : 'test';
   gen.fs.copyTpl(
-    gen.templatePath(`authTests/${authType || 'generic'}.test.js`),
-    gen.destinationPath('test/authentication.test.js'),
+    gen.templatePath(
+      `authTests/${authType || 'generic'}.test.${fileExtension}`,
+    ),
+    gen.destinationPath(`${destPath}/authentication.test.${fileExtension}`),
   );
 };
 
@@ -166,8 +160,17 @@ const writeGenericTest = (gen) => {
 const writeForAuthTemplate = (gen) => {
   writeGitignore(gen);
   writeGenericReadme(gen);
-  writeGenericPackageJson(gen);
-  writeGenericIndex(gen, true);
+  if (gen.options.language === 'typescript') {
+    writeGenericTypescriptIndex(gen);
+    writeGenericTypeScriptPackageJson(gen);
+    gen.fs.copyTpl(
+      gen.templatePath('tsconfig.template.json'),
+      gen.destinationPath('tsconfig.json'),
+    );
+  } else {
+    writeGenericIndex(gen, true);
+    writeGenericPackageJson(gen);
+  }
   writeGenericAuth(gen);
   writeGenericAuthTest(gen);
 };
@@ -205,36 +208,6 @@ const writeForStandaloneTemplate = (gen) => {
   );
 };
 
-const writeForStandaloneTypeScriptTemplate = (gen) => {
-  writeGitignore(gen);
-  writeGenericReadme(gen);
-  appendReadme(gen);
-
-  const packageJsonExtension = {
-    typescript: {
-      scripts: {
-        test: 'vitest --run',
-        clean: 'rimraf ./dist ./build',
-        build: 'npm run clean && tsc',
-        '_zapier-build': 'npm run build',
-      },
-      devDependencies: {
-        rimraf: '^5.0.10',
-        typescript: '5.6.2',
-        vitest: '^2.1.2',
-      },
-    },
-  }[gen.options.template];
-
-  writeTypeScriptPackageJson(gen, packageJsonExtension);
-
-  gen.fs.copy(
-    gen.templatePath(gen.options.template, '**', '*.{js,json,ts}'),
-    gen.destinationPath(),
-  );
-  writeTypeScriptIndex(gen);
-};
-
 const TEMPLATE_ROUTES = {
   'basic-auth': writeForAuthTemplate,
   callback: writeForStandaloneTemplate,
@@ -248,10 +221,19 @@ const TEMPLATE_ROUTES = {
   openai: writeForStandaloneTemplate,
   'search-or-create': writeForStandaloneTemplate,
   'session-auth': writeForAuthTemplate,
-  typescript: writeForStandaloneTypeScriptTemplate,
 };
 
-const ESM_SUPPORTED_TEMPLATES = ['minimal', 'typescript'];
+const ESM_SUPPORTED_TEMPLATES = ['minimal'];
+
+// Which templates can be used with the --language typescript flag
+const TS_SUPPORTED_TEMPLATES = [
+  'basic-auth',
+  'custom-auth',
+  'digest-auth',
+  'oauth1-trello',
+  'oauth2',
+  'session-auth',
+];
 
 const TEMPLATE_CHOICES = Object.keys(TEMPLATE_ROUTES);
 
@@ -260,7 +242,7 @@ class ProjectGenerator extends Generator {
     this.sourceRoot(path.resolve(__dirname, 'templates'));
     this.destinationRoot(path.resolve(this.options.path));
 
-    const jsFilter = filter(['*.js', '*.json'], { restore: true });
+    const jsFilter = filter(['*.js', '*.json', '*.ts'], { restore: true });
     this.queueTransformStream([
       jsFilter,
       prettier({ singleQuote: true }),
@@ -298,12 +280,32 @@ class ProjectGenerator extends Generator {
       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
+      }
+    } 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.module === 'esm' &&
+      this.options.language === 'javascript'
     ) {
       throw new Error(
-        'ESM is not supported for this template, please use a different template or set the module to commonjs',
+        'ESM is not supported for this template, please use a different template, set the module to commonjs, or try setting the language to Typescript',
       );
     }
   }

package/src/generators/templates/README.template.md

@@ -21,4 +21,14 @@ zapier link
 zapier push
 ```
 
+Then, to add more features, you can use the `zapier scaffold` command, for example:
+
+```bash
+# Add a trigger
+zapier scaffold trigger contact
+
+# Add an action
+zapier scaffold create contact
+``` 
+
 Find out more on the latest docs: https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md.

package/src/generators/templates/authTests/basic.test.ts

@@ -0,0 +1,42 @@
+import { describe, expect, it } from 'vitest';
+import zapier from 'zapier-platform-core';
+
+import App from '../index.js';
+const appTester = zapier.createAppTester(App);
+
+describe('basic auth', () => {
+  it('automatically has Authorize Header add', async () => {
+    const bundle = {
+      authData: {
+        username: 'user',
+        password: 'secret',
+      },
+    };
+
+    const response = await appTester(App.authentication.test, bundle);
+
+    expect(response.status).toBe(200);
+    expect(response.request.headers.Authorization).toBe(
+      'Basic dXNlcjpzZWNyZXQ='
+    );
+  });
+
+  it('fails on bad auth', async () => {
+    const bundle = {
+      authData: {
+        username: 'user',
+        password: 'badpwd',
+      },
+    };
+
+    try {
+      await appTester(App.authentication.test, bundle);
+    } catch (err) {
+      expect(err.message).toContain(
+        'The username and/or password you supplied is incorrect'
+      );
+      return;
+    }
+    throw new Error('appTester should have thrown');
+  });
+});

package/src/generators/templates/authTests/custom.test.ts

@@ -0,0 +1,34 @@
+import { describe, expect, it } from 'vitest';
+import zapier from 'zapier-platform-core';
+
+import App from '../index.js';
+const appTester = zapier.createAppTester(App);
+
+describe('custom auth', () => {
+  it('passes authentication and returns json', async () => {
+    const bundle = {
+      authData: {
+        apiKey: 'secret',
+      },
+    };
+
+    const response = await appTester(App.authentication.test, bundle);
+    expect(response.data).toHaveProperty('username');
+  });
+
+  it('fails on bad auth', async () => {
+    const bundle = {
+      authData: {
+        apiKey: 'bad',
+      },
+    };
+
+    try {
+      await appTester(App.authentication.test, bundle);
+    } catch (error) {
+      expect(error.message).toContain('The API Key you supplied is incorrect');
+      return;
+    }
+    throw new Error('appTester should have thrown');
+  });
+});

package/src/generators/templates/authTests/digest.test.ts

@@ -0,0 +1,43 @@
+import { describe, expect, it } from 'vitest';
+import zapier from 'zapier-platform-core';
+
+import App from '../index.js';
+const appTester = zapier.createAppTester(App);
+
+describe('digest auth', () => {
+  it('correctly authenticates', async () => {
+    // Try changing the values of username or password to see how the test method behaves
+    const bundle = {
+      authData: {
+        username: 'myuser',
+        password: 'mypass',
+      },
+    };
+
+    const response = await appTester(App.authentication.test, bundle);
+
+    expect(response.status).toBe(200);
+    expect(response.data.authorized).toBe(true);
+    expect(response.data.user).toBe('myuser');
+  });
+
+  it('fails on bad auth', async () => {
+    // Try changing the values of username or password to see how the test method behaves
+    const bundle = {
+      authData: {
+        username: 'user',
+        password: 'badpwd',
+      },
+    };
+
+    try {
+      await appTester(App.authentication.test, bundle);
+    } catch (err) {
+      expect(err.message).toContain(
+        'The username and/or password you supplied is incorrect'
+      );
+      return;
+    }
+    throw new Error('appTester should have thrown');
+  });
+});

package/src/generators/templates/authTests/oauth1.test.ts

@@ -0,0 +1,63 @@
+import { describe, expect, it, beforeAll } from 'vitest';
+import zapier from 'zapier-platform-core';
+
+import App from '../index.js';
+const appTester = zapier.createAppTester(App);
+
+// Only defining the env vars here so the tests out of the box.
+// You should create a `.env` file and populate it with your actual Trello
+// client ID and secret (called "API Key" and "API Secret" by Trello), which you
+// can find on https://trello.com/app-key.
+// The `.env` file should look like
+/*
+    CLIENT_ID=<trello_api_key>
+    CLIENT_SECRET=<trello_api_secret>
+*/
+// then you can delete the following 2 lines
+process.env.CLIENT_ID = process.env.CLIENT_ID || '<trello_api_key>';
+process.env.CLIENT_SECRET = process.env.CLIENT_SECRET || '<trello_api_secret>';
+
+describe('oauth1 app', () => {
+  beforeAll(() => {
+    // It's a good idea to store your Client ID and Secret in the environment rather than in code.
+    if (!(process.env.CLIENT_ID && process.env.CLIENT_SECRET)) {
+      throw new Error(
+        `Before running the tests, make sure CLIENT_ID and CLIENT_SECRET are available in the environment.`
+      );
+    }
+  });
+
+  it('fetch a request token', async () => {
+    const bundle = {
+      inputData: {
+        // You should add your redirect URI to https://trello.com/app-key
+        redirect_uri: 'https://zapier.com',
+      },
+    };
+    const tokens = await appTester(
+      App.authentication.oauth1Config.getRequestToken,
+      bundle
+    );
+    expect(tokens).toHaveProperty('oauth_token');
+    expect(tokens).toHaveProperty('oauth_token_secret');
+  });
+
+  it('generates an authorize URL', async () => {
+    const bundle = {
+      // In production, these will be generated by Zapier and set automatically
+      inputData: {
+        oauth_token: '4444',
+        redirect_uri: 'https://zapier.com/',
+      },
+    };
+
+    const authorizeUrl = await appTester(
+      App.authentication.oauth1Config.authorizeUrl,
+      bundle
+    );
+
+    expect(authorizeUrl).toBe(
+      'https://trello.com/1/OAuthAuthorizeToken?oauth_token=4444&name=Zapier%2FTrello%20OAuth1%20Test'
+    );
+  });
+});

package/src/generators/templates/authTests/oauth2.test.ts

@@ -0,0 +1,115 @@
+import { describe, expect, it, beforeAll } from 'vitest';
+import zapier from 'zapier-platform-core';
+
+import App from '../index.js';
+const appTester = zapier.createAppTester(App);
+
+// Only defining the env vars here so the tests out of the box.
+// You should create a `.env` file and populate it with the necessarily configuration
+// it should look like:
+/*
+    CLIENT_ID=1234
+    CLIENT_SECRET=asdf
+*/
+// then you can delete the following 2 lines
+process.env.CLIENT_ID = process.env.CLIENT_ID || '1234';
+process.env.CLIENT_SECRET = process.env.CLIENT_SECRET || 'asdf';
+
+describe('authentication', () => {
+  beforeAll(() => {
+    // It's a good idea to store your Client ID and Secret in the environment rather than in code.
+    if (!(process.env.CLIENT_ID && process.env.CLIENT_SECRET)) {
+      throw new Error(
+        `Before running the tests, make sure CLIENT_ID and CLIENT_SECRET are available in the environment.`,
+      );
+    }
+  });
+
+  it('generates an authorize URL', async () => {
+    const bundle = {
+      // In production, these will be generated by Zapier and set automatically
+      inputData: {
+        state: '4444',
+        redirect_uri: 'https://zapier.com/',
+      },
+      environment: {
+        CLIENT_ID: process.env.CLIENT_ID,
+        CLIENT_SECRET: process.env.CLIENT_SECRET,
+      },
+    };
+
+    const authorizeUrl = await appTester(
+      App.authentication.oauth2Config.authorizeUrl,
+      bundle,
+    );
+
+    expect(authorizeUrl).toBe(
+      'https://auth-json-server.zapier-staging.com/oauth/authorize?client_id=1234&state=4444&redirect_uri=https%3A%2F%2Fzapier.com%2F&response_type=code',
+    );
+  });
+
+  it('can fetch an access token', async () => {
+    const bundle = {
+      inputData: {
+        // In production, Zapier passes along whatever code your API set in the query params when it redirects
+        // the user's browser to the `redirect_uri`
+        code: 'one_time_code',
+      },
+      environment: {
+        CLIENT_ID: process.env.CLIENT_ID,
+        CLIENT_SECRET: process.env.CLIENT_SECRET,
+      },
+      cleanedRequest: {
+        querystring: {
+          accountDomain: 'test-account',
+          code: 'one_time_code',
+        },
+      },
+      rawRequest: {
+        querystring: '?accountDomain=test-account&code=one_time_code',
+      },
+    };
+
+    const result = await appTester(
+      App.authentication.oauth2Config.getAccessToken,
+      bundle,
+    );
+
+    expect(result.access_token).toBe('a_token');
+    expect(result.refresh_token).toBe('a_refresh_token');
+  });
+
+  it('can refresh the access token', async () => {
+    const bundle = {
+      // In production, Zapier provides these. For testing, we have hard-coded them.
+      // When writing tests for your own app, you should consider exporting them and doing process.env.MY_ACCESS_TOKEN
+      authData: {
+        access_token: 'a_token',
+        refresh_token: 'a_refresh_token',
+      },
+      environment: {
+        CLIENT_ID: process.env.CLIENT_ID,
+        CLIENT_SECRET: process.env.CLIENT_SECRET,
+      },
+    };
+
+    const result = await appTester(
+      App.authentication.oauth2Config.refreshAccessToken,
+      bundle,
+    );
+    expect(result.access_token).toBe('a_token');
+  });
+
+  it('includes the access token in future requests', async () => {
+    const bundle = {
+      authData: {
+        access_token: 'a_token',
+        refresh_token: 'a_refresh_token',
+      },
+    };
+
+    const response = await appTester(App.authentication.test, bundle);
+    expect(response.data).toHaveProperty('username');
+    expect(response.data.username).toBe('Bret');
+  });
+});