zapier-platform-cli 15.18.1 → 16.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "15.18.1",
+  "version": "16.0.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -19,12 +19,12 @@
     "/oclif.manifest.json"
   ],
   "engines": {
-    "node": ">=16"
+    "node": ">=18.18"
   },
   "scripts": {
     "docs": "ZAPIER_BASE_ENDPOINT='' node scripts/docs.js",
     "preversion": "git pull && yarn validate",
-    "prepack": "oclif-dev manifest",
+    "prepack": "oclif manifest",
     "postpack": "rm -f oclif.manifest.json",
     "precommit": "yarn docs && git add docs",
     "version": "yarn docs && git add docs/*",
@@ -40,54 +40,56 @@
     "validate": "yarn test && yarn smoke-test && yarn lint"
   },
   "dependencies": {
-    "@oclif/command": "1.8.27",
-    "@oclif/config": "1.18.10",
-    "@oclif/plugin-autocomplete": "0.3.0",
-    "@oclif/plugin-help": "3.2.20",
-    "@oclif/plugin-not-found": "1.2.4",
-    "adm-zip": "0.5.10",
-    "archiver": "5.3.1",
-    "browserify": "17.0.0",
+    "@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",
+    "adm-zip": "0.5.16",
+    "archiver": "7.0.1",
+    "browserify": "17.0.1",
     "chrono-node": "2.7.7",
-    "cli-table3": "0.6.3",
+    "cli-table3": "0.6.5",
     "colors": "1.4.0",
-    "debug": "4.3.4",
-    "dotenv": "16.4.5",
-    "fs-extra": "11.1.1",
+    "debug": "4.3.7",
+    "dotenv": "16.4.6",
+    "fs-extra": "11.2.0",
     "gulp-filter": "7.0.0",
     "gulp-prettier": "4.0.0",
     "ignore": "5.2.4",
     "inquirer": "8.2.5",
-    "jscodeshift": "0.15.0",
+    "jscodeshift": "^17.0.0",
     "klaw": "4.1.0",
     "lodash": "4.17.21",
     "luxon": "3.5.0",
-    "marked": "4.2.12",
-    "marked-terminal": "5.2.0",
+    "marked": "14.1.4",
+    "marked-terminal": "7.2.1",
     "minimatch": "9.0.3",
-    "node-fetch": "2.6.7",
+    "node-fetch": "2.7.0",
     "open": "10.1.0",
     "ora": "5.4.0",
     "parse-gitignore": "0.5.1",
-    "prettier": "2.8.8",
-    "read": "2.1.0",
-    "semver": "7.5.2",
+    "prettier": "3.4.1",
+    "read": "4.0.0",
+    "semver": "7.6.3",
     "string-length": "4.0.2",
     "through2": "4.0.2",
-    "tmp": "0.2.1",
-    "traverse": "0.6.7",
+    "tmp": "0.2.3",
+    "traverse": "0.6.10",
     "update-notifier": "5.1.0",
-    "yeoman-environment": "3.3.0",
+    "yeoman-environment": "3.19.3",
     "yeoman-generator": "5.9.0"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1.26.10",
-    "@oclif/test": "^1.2.9",
+    "@oclif/test": "^4.0.9",
+    "@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",
-    "stdout-stderr": "0.1.13",
+    "oclif": "^4.15.30",
+    "typescript": "^5.6.3",
     "yamljs": "0.3.0"
   },
   "bin": {
@@ -95,20 +97,28 @@
   },
   "oclif": {
     "commands": "src/oclif/commands",
+    "additionalHelpFlags": [
+      "-h"
+    ],
+    "additionalVersionFlags": [
+      "-v"
+    ],
     "bin": "zapier",
+    "dirname": "zapier",
     "plugins": [
+      "@oclif/plugin-autocomplete",
       "@oclif/plugin-help",
       "@oclif/plugin-not-found",
-      "@oclif/plugin-autocomplete"
+      "@oclif/plugin-version"
     ],
     "hooks": {
       "init": [
-        "./src/oclif/hooks/versionInfo",
-        "./src/oclif/hooks/deprecated",
-        "./src/oclif/hooks/updateNotifier",
         "./src/oclif/hooks/checkValidNodeVersion",
+        "./src/oclif/hooks/deprecated",
+        "./src/oclif/hooks/getAppRegistrationFieldChoices",
         "./src/oclif/hooks/renderMarkdownHelp",
-        "./src/oclif/hooks/getAppRegistrationFieldChoices"
+        "./src/oclif/hooks/updateNotifier",
+        "./src/oclif/hooks/versionInfo"
       ]
     },
     "topics": {

package/scaffold/create.template.ts

@@ -0,0 +1,64 @@
+import type { Create, PerformFunction } from 'zapier-platform-core';
+
+// create a particular <%= LOWER_NOUN %> by name
+const perform: PerformFunction = 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
+    }
+  });
+  // this should return a single object
+  return response.data;
+};
+
+export default {
+  // 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 %>',
+  noun: '<%= NOUN %>',
+
+  display: {
+    label: 'Create <%= NOUN %>',
+    description: 'Creates a new <%= LOWER_NOUN %>, probably with input from previous steps.'
+  },
+
+  operation: {
+    perform,
+
+    <%= INCLUDE_INTRO_COMMENTS ? [
+      '// `inputFields` defines the fields a user could provide',
+      '// 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}
+    ],
+
+    <%= 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',
+      '// from the API, Zapier will fallback to this hard-coded sample. It should reflect the data structure of',
+      '// returned records, and have obvious placeholder values that we can show to any user.'
+    ].join('\n    ') : '' %>
+    sample: {
+      id: 1,
+      name: 'Test'
+    },
+
+    <%= INCLUDE_INTRO_COMMENTS ? [
+      '// If fields are custom to each user (like spreadsheet columns), `outputFields` can create human labels',
+      '// For a more complete example of using dynamic fields see',
+      '// https://github.com/zapier/zapier-platform/tree/main/packages/cli#customdynamic-fields',
+      '// Alternatively, a static field definition can be provided, to specify labels for the fields'
+    ].join('\n    ') : '' %>
+    outputFields: [
+      // these are placeholders to match the example `perform` above
+      // {key: 'id', label: 'Person ID'},
+      // {key: 'name', label: 'Person Name'}
+    ]
+  }
+} satisfies Create;

package/scaffold/resource.template.ts

@@ -0,0 +1,119 @@
+import type { PerformFunction, Resource } from 'zapier-platform-core';
+
+// get a list of <%= LOWER_NOUN %>s
+const performList: PerformFunction = async (z, bundle) => {
+  const response = await z.request({
+    url: 'https://jsonplaceholder.typicode.com/posts',
+    params: {
+      order_by: 'id desc',
+    },
+  });
+  return response.data;
+};
+
+// find a particular <%= LOWER_NOUN %> by name (or other search criteria)
+const performSearch: PerformFunction = async (z, bundle) => {
+  const response = await z.request({
+    url: 'https://jsonplaceholder.typicode.com/posts',
+    params: {
+      name: bundle.inputData.name,
+    },
+  });
+  return response.data;
+};
+
+// creates a new <%= LOWER_NOUN %>
+const performCreate: PerformFunction = async (z, bundle) => {
+  const response = await z.request({
+    method: 'POST',
+    url: 'https://jsonplaceholder.typicode.com/posts',
+    body: {
+      name: bundle.inputData.name, // json by default
+    },
+  });
+  return response.data;
+};
+
+export default {
+  // see here for a full list of available properties:
+  // https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#resourceschema
+  key: '<%= KEY %>',
+  noun: '<%= NOUN %>',
+
+  <%= INCLUDE_INTRO_COMMENTS ? [
+    '// If `get` is defined, it will be called after a `search` or `create`'
+  ].join('\n    ') : '' %>
+  // useful if your `searches` and `creates` return sparse objects
+  // get: {
+  //   display: {
+  //     label: 'Get <%= NOUN %>',
+  //     description: 'Gets a <%= LOWER_NOUN %>.'
+  //   },
+  //   operation: {
+  //     inputFields: [
+  //       {key: 'id', required: true}
+  //     ],
+  //     perform: defineMe
+  //   }
+  // },
+
+  list: {
+    display: {
+      label: 'New <%= NOUN %>',
+      description: 'Lists the <%= LOWER_NOUN %>s.',
+    },
+    operation: {
+      perform: performList,
+      <%= INCLUDE_INTRO_COMMENTS ? [
+        '// `inputFields` defines the fields a user could provide',
+        '// Zapier will pass them in as `bundle.inputData` later. They\'re optional on triggers, but required on searches and creates.'
+      ].join('\n      ') : '' %>
+      inputFields: [],
+    },
+  },
+
+  search: {
+    display: {
+      label: 'Find <%= NOUN %>',
+      description: 'Finds a <%= LOWER_NOUN %> give.',
+    },
+    operation: {
+      inputFields: [{ key: 'name', required: true }],
+      perform: performSearch,
+    },
+  },
+
+  create: {
+    display: {
+      label: 'Create <%= NOUN %>',
+      description: 'Creates a new <%= LOWER_NOUN %>.',
+    },
+    operation: {
+      inputFields: [{ key: 'name', required: true }],
+      perform: performCreate,
+    },
+  },
+
+  <%= 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',
+    '// from the API, Zapier will fallback to this hard-coded sample. It should reflect the data structure of',
+    '// returned records, and have obvious placeholder values that we can show to any user.',
+    '// In this resource, the sample is reused across all methods'
+  ].join('\n  ') : '' %>
+  sample: {
+    id: 1,
+    name: 'Test',
+  },
+
+  <%= INCLUDE_INTRO_COMMENTS ? [
+    '// If fields are custom to each user (like spreadsheet columns), `outputFields` can create human labels',
+    '// For a more complete example of using dynamic fields see',
+    '// https://github.com/zapier/zapier-platform/tree/main/packages/cli#customdynamic-fields',
+    '// Alternatively, a static field definition can be provided, to specify labels for the fields',
+    '// In this resource, these output fields are reused across all resources'
+  ].join('\n  ') : '' %>
+  outputFields: [
+    { key: 'id', label: 'ID' },
+    { key: 'name', label: 'Name' },
+  ],
+} satisfies Resource;

package/scaffold/search.template.ts

@@ -0,0 +1,63 @@
+import type { PerformFunction, Search } from 'zapier-platform-core';
+
+// find a particular <%= LOWER_NOUN %> by name
+const perform: PerformFunction = async (z, bundle) => {
+  const response = await z.request({
+    url: 'https://jsonplaceholder.typicode.com/posts',
+    params: {
+      name: bundle.inputData.name,
+    },
+  });
+  // this should return an array of objects (but only the first will be used)
+  return response.data;
+};
+
+export default {
+  // 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 %>',
+  noun: '<%= NOUN %>',
+
+  display: {
+    label: 'Find <%= NOUN %>',
+    description: 'Finds a <%= LOWER_NOUN %> based on name.',
+  },
+
+  operation: {
+    perform,
+
+    <%= INCLUDE_INTRO_COMMENTS ? [
+      '// `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.',
+      },
+    ],
+
+    <%= 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',
+    '// from the API, Zapier will fallback to this hard-coded sample. It should reflect the data structure of',
+    '// returned records, and have obvious placeholder values that we can show to any user.'
+    ].join('\n    ') : '' %>
+    sample: {
+      id: 1,
+      name: 'Test',
+    },
+
+    <%= INCLUDE_INTRO_COMMENTS ? [
+      '// If fields are custom to each user (like spreadsheet columns), `outputFields` can create human labels',
+      '// For a more complete example of using dynamic fields see',
+      '// https://github.com/zapier/zapier-platform/tree/main/packages/cli#customdynamic-fields',
+      '// Alternatively, a static field definition can be provided, to specify labels for the fields'
+    ].join('\n    ') : '' %>
+    outputFields: [
+      // these are placeholders to match the example `perform` above
+      // {key: 'id', label: 'Person ID'},
+      // {key: 'name', label: 'Person Name'}
+    ],
+  },
+} satisfies Search;

package/scaffold/test.template.ts

@@ -0,0 +1,18 @@
+import { describe, expect, it } from 'vitest';
+import zapier from 'zapier-platform-core';
+
+import App from '../../index';
+
+const appTester = zapier.createAppTester(App);
+// read the `.env` file into the environment, if available
+zapier.tools.env.inject();
+
+describe('<%= ACTION_PLURAL %>.<%= KEY %>', () => {
+  it('should run', async () => {
+    const bundle = { inputData: {} };
+
+    const results = await appTester(App.<%= ACTION_PLURAL %>['<%= KEY %>'].<%= MAYBE_RESOURCE %>operation.perform, bundle);
+    expect(results).toBeDefined();
+    // TODO: add more assertions
+  });
+});

package/scaffold/trigger.template.ts

@@ -0,0 +1,58 @@
+import type { PerformFunction, Trigger } from 'zapier-platform-core';
+
+// triggers on a new <%= LOWER_NOUN %> with a certain tag
+const perform: PerformFunction = async (z, bundle) => {
+  const response = await z.request({
+    url: 'https://jsonplaceholder.typicode.com/posts',
+    params: {
+      tag: bundle.inputData.tagName,
+    },
+  });
+  // this should return an array of objects
+  return response.data;
+};
+
+export default {
+  // 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,
+  noun: '<%= NOUN %>',
+
+  display: {
+    label: 'New <%= NOUN %>',
+    description: 'Triggers when a new <%= LOWER_NOUN %> is created.',
+  },
+
+  operation: {
+    type: 'polling',
+    perform,
+
+    <%= INCLUDE_INTRO_COMMENTS ? [
+      '// `inputFields` defines the fields a user could provide',
+      '// Zapier will pass them in as `bundle.inputData` later. They\'re optional.'
+    ].join('\n    ') : '' %>
+    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',
+      '// from the API, Zapier will fallback to this hard-coded sample. It should reflect the data structure of',
+      '// returned records, and have obvious placeholder values that we can show to any user.'
+    ].join('\n    ') : '' %>
+    sample: {
+      id: 1,
+      name: 'Test',
+    },
+
+    <%= INCLUDE_INTRO_COMMENTS ? [
+      '// If fields are custom to each user (like spreadsheet columns), `outputFields` can create human labels',
+      '// For a more complete example of using dynamic fields see',
+      '// https://github.com/zapier/zapier-platform/tree/main/packages/cli#customdynamic-fields',
+      '// Alternatively, a static field definition can be provided, to specify labels for the fields'
+    ].join('\n    ') : '' %>
+    outputFields: [
+      // these are placeholders to match the example `perform` above
+      // {key: 'id', label: 'Person ID'},
+      // {key: 'name', label: 'Person Name'}
+    ],
+  },
+} satisfies Trigger;

package/src/bin/run

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-require('@oclif/command')
-  .run() // this looks through the directory to find all the commands
-  .then(require('@oclif/command/flush'))
-  .catch(require('@oclif/errors/handle'));
+(async () => {
+  const oclif = await import('@oclif/core');
+  await oclif.execute({ development: false, dir: __dirname });
+})();

package/src/bin/run.cmd

@@ -1,6 +1,3 @@
-REM this is created by the oclif generator and is similar to a file that npm creates on install
-REM see https://stackoverflow.com/a/28415646/1825390
-
 @echo off
 
 node "%~dp0\run" %*

package/src/generators/index.js

@@ -13,14 +13,14 @@ const writeGenericReadme = (gen) => {
   gen.fs.copyTpl(
     gen.templatePath('README.template.md'),
     gen.destinationPath('README.md'),
-    { name: gen.options.packageName }
+    { name: gen.options.packageName },
   );
 };
 
 const appendReadme = (gen) => {
   const content = gen.fs.read(
     gen.templatePath(gen.options.template, 'README.md'),
-    { defaults: '' }
+    { defaults: '' },
   );
   if (content) {
     gen.fs.append(gen.destinationPath('README.md'), '\n' + content);
@@ -51,8 +51,8 @@ const writeGenericPackageJson = (gen, packageJsonExtension) => {
         },
         private: true,
       },
-      packageJsonExtension
-    )
+      packageJsonExtension,
+    ),
   );
 };
 
@@ -76,8 +76,8 @@ const writeTypeScriptPackageJson = (gen, packageJsonExtension) => {
         },
         private: true,
       },
-      packageJsonExtension
-    )
+      packageJsonExtension,
+    ),
   );
 };
 
@@ -85,7 +85,7 @@ const writeGenericIndex = (gen, hasAuth) => {
   gen.fs.copyTpl(
     gen.templatePath('index.template.js'),
     gen.destinationPath('index.js'),
-    { corePackageName: PLATFORM_PACKAGE, hasAuth }
+    { corePackageName: PLATFORM_PACKAGE, hasAuth },
   );
 };
 
@@ -108,14 +108,14 @@ const writeGenericAuthTest = (gen) => {
   const authType = authTypes[gen.options.template];
   gen.fs.copyTpl(
     gen.templatePath(`authTests/${authType || 'generic'}.test.js`),
-    gen.destinationPath('test/authentication.test.js')
+    gen.destinationPath('test/authentication.test.js'),
   );
 };
 
 const writeGenericTest = (gen) => {
   gen.fs.copyTpl(
     gen.templatePath('authTests/generic.test.js'),
-    gen.destinationPath('test/example.test.js')
+    gen.destinationPath('test/example.test.js'),
   );
 };
 
@@ -158,7 +158,7 @@ const writeForStandaloneTemplate = (gen) => {
 
   gen.fs.copy(
     gen.templatePath(gen.options.template, '**', '*.{js,json,ts}'),
-    gen.destinationPath()
+    gen.destinationPath(),
   );
 };
 
@@ -187,7 +187,7 @@ const writeForStandaloneTypeScriptTemplate = (gen) => {
 
   gen.fs.copy(
     gen.templatePath(gen.options.template, '**', '*.{js,json,ts}'),
-    gen.destinationPath()
+    gen.destinationPath(),
   );
 };
 

package/src/index.js

@@ -1,3 +1,3 @@
 // for now, requiring this file has no real effect
 
-module.exports = require('@oclif/command');
+module.exports = require('@oclif/core');