zapier-platform-cli 16.5.0 → 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.",
@@ -1515,6 +1528,13 @@
       "args": {},
       "description": "List the versions of your integration available for use in Zapier automations.",
       "flags": {
+        "all": {
+          "char": "a",
+          "description": "List all versions, including deprecated versions.",
+          "name": "all",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1562,6 +1582,54 @@
         "versions.js"
       ]
     },
+    "cache:clear": {
+      "aliases": [],
+      "args": {
+        "majorVersion": {
+          "description": "(Optional) The cache data will be deleted for this major version. If not provided, you must pick from a list of major versions for this integration.",
+          "name": "majorVersion",
+          "required": false
+        }
+      },
+      "description": "Clear the cache data for a major version. \n\nThis command clears the cache data for a major version of your integration.\nThe job will be run in the background and may take some time to complete.\nYou can check `zapier history` to see the job status.\n",
+      "examples": [
+        "zapier cache:clear",
+        "zapier cache:clear 2"
+      ],
+      "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": "cache:clear",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "hide": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "cache",
+        "clear.js"
+      ]
+    },
     "canary:create": {
       "aliases": [],
       "args": {
@@ -1725,19 +1793,18 @@
         "list.js"
       ]
     },
-    "cache:clear": {
+    "env:get": {
       "aliases": [],
       "args": {
-        "majorVersion": {
-          "description": "(Optional) The cache data will be deleted for this major version. If not provided, you must pick from a list of major versions for this integration.",
-          "name": "majorVersion",
-          "required": false
+        "version": {
+          "description": "The version to get the environment for.",
+          "name": "version",
+          "required": true
         }
       },
-      "description": "Clear the cache data for a major version. \n\nThis command clears the cache data for a major version of your integration.\nThe job will be run in the background and may take some time to complete.\nYou can check `zapier history` to see the job status.\n",
+      "description": "Get environment variables for a version.",
       "examples": [
-        "zapier cache:clear",
-        "zapier cache:clear 2"
+        "zapier env:get 1.2.3"
       ],
       "flags": {
         "debug": {
@@ -1747,45 +1814,21 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "cache:clear",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "hide": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "cache",
-        "clear.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"
+        "format": {
+          "char": "f",
+          "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "plain",
+            "json",
+            "raw",
+            "row",
+            "table"
+          ],
+          "type": "option"
         },
         "invokedFromAnotherCommand": {
           "hidden": true,
@@ -1796,7 +1839,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "delete:integration",
+      "id": "env:get",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -1808,21 +1851,35 @@
         "src",
         "oclif",
         "commands",
-        "delete",
-        "integration.js"
+        "env",
+        "get.js"
       ]
     },
-    "delete:version": {
+    "env:set": {
       "aliases": [],
       "args": {
         "version": {
-          "description": "Specify the version to delete. It must have no users or Zaps.",
+          "description": "The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.",
           "name": "version",
           "required": true
+        },
+        "key-value pairs...": {
+          "description": "The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`",
+          "name": "key-value pairs..."
         }
       },
-      "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.",
+      "description": "Set environment variables for a version.",
+      "examples": [
+        "zapier env:set 1.2.3 SECRET=12345 OTHER=4321"
+      ],
       "flags": {
+        "force": {
+          "char": "f",
+          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1839,11 +1896,11 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "delete:version",
+      "id": "env:set",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
-      "strict": true,
+      "strict": false,
       "enableJsonFlag": false,
       "skipValidInstallCheck": true,
       "isESM": false,
@@ -1851,24 +1908,35 @@
         "src",
         "oclif",
         "commands",
-        "delete",
-        "version.js"
+        "env",
+        "set.js"
       ]
     },
-    "env:get": {
+    "env:unset": {
       "aliases": [],
       "args": {
         "version": {
-          "description": "The version to get the environment for.",
+          "description": "The version to set the environment for.",
           "name": "version",
           "required": true
+        },
+        "keys...": {
+          "description": "The keys to unset. Keys are case-insensitive.",
+          "name": "keys..."
         }
       },
-      "description": "Get environment variables for a version.",
+      "description": "Unset environment variables for a version.",
       "examples": [
-        "zapier env:get 1.2.3"
+        "zapier env:unset 1.2.3 SECRET OTHER"
       ],
       "flags": {
+        "force": {
+          "char": "f",
+          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1876,22 +1944,6 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "format": {
-          "char": "f",
-          "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
-          "name": "format",
-          "default": "table",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "plain",
-            "json",
-            "raw",
-            "row",
-            "table"
-          ],
-          "type": "option"
-        },
         "invokedFromAnotherCommand": {
           "hidden": true,
           "name": "invokedFromAnotherCommand",
@@ -1901,11 +1953,11 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "env:get",
+      "id": "env:unset",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
-      "strict": true,
+      "strict": false,
       "enableJsonFlag": false,
       "skipValidInstallCheck": true,
       "isESM": false,
@@ -1914,34 +1966,16 @@
         "oclif",
         "commands",
         "env",
-        "get.js"
+        "unset.js"
       ]
     },
-    "env:set": {
-      "aliases": [],
-      "args": {
-        "version": {
-          "description": "The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.",
-          "name": "version",
-          "required": true
-        },
-        "key-value pairs...": {
-          "description": "The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`",
-          "name": "key-value pairs..."
-        }
-      },
-      "description": "Set environment variables for a version.",
-      "examples": [
-        "zapier env:set 1.2.3 SECRET=12345 OTHER=4321"
+    "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": {
-        "force": {
-          "char": "f",
-          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1958,11 +1992,11 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "env:set",
+      "id": "delete:integration",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
-      "strict": false,
+      "strict": true,
       "enableJsonFlag": false,
       "skipValidInstallCheck": true,
       "isESM": false,
@@ -1970,35 +2004,21 @@
         "src",
         "oclif",
         "commands",
-        "env",
-        "set.js"
+        "delete",
+        "integration.js"
       ]
     },
-    "env:unset": {
+    "delete:version": {
       "aliases": [],
       "args": {
         "version": {
-          "description": "The version to set the environment for.",
+          "description": "Specify the version to delete. It must have no users or Zaps.",
           "name": "version",
           "required": true
-        },
-        "keys...": {
-          "description": "The keys to unset. Keys are case-insensitive.",
-          "name": "keys..."
         }
       },
-      "description": "Unset environment variables for a version.",
-      "examples": [
-        "zapier env:unset 1.2.3 SECRET OTHER"
-      ],
+      "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": {
-        "force": {
-          "char": "f",
-          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -2015,11 +2035,11 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "env:unset",
+      "id": "delete:version",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
-      "strict": false,
+      "strict": true,
       "enableJsonFlag": false,
       "skipValidInstallCheck": true,
       "isESM": false,
@@ -2027,8 +2047,8 @@
         "src",
         "oclif",
         "commands",
-        "env",
-        "unset.js"
+        "delete",
+        "version.js"
       ]
     },
     "team:add": {
@@ -2410,5 +2430,5 @@
       ]
     }
   },
-  "version": "16.5.0"
+  "version": "17.0.0"
 }

package/package.json

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