diff --git a/CHANGELOG.md b/CHANGELOG.md index 2eb76e2e3..795624512 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,10 +2,11 @@ _released `2024-10-11`_ -Introducing two major updates to improve your development experience: +Introducing three major updates, with the first two aimed at improving your development experience: -- The `zapier invoke` command: This powerful new command enables you to emulate Zapier's production environment locally. Test triggers, actions, and authentication flows right from your terminal without deploying to Zapier. This is especially valuable for debugging, development, and quick testing iterations. Learn more about the command in the [README](https://github.com/zapier/zapier-platform/blob/67d55389/packages/cli/README.md#using-zapier-invoke-command) or by typing `zapier invoke --help` in your teriminal. -- Refreshed "[typescript](https://github.com/zapier/zapier-platform/tree/67d55389/example-apps/typescript)" project template: We've updated the "typescript" project template with the latest type definitions. Enjoy enhanced type safety, improved autocompletion, and a smoother coding experience overall. +- The `zapier invoke` command: This powerful new command enables you to emulate Zapier's production environment locally. Test triggers, actions, and authentication flows right from your terminal without deploying to Zapier. This is especially valuable for debugging, development, and quick testing iterations. Learn more about the command in the [README](https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md#using-zapier-invoke-command) or by typing [`zapier invoke --help`](https://github.com/zapier/zapier-platform/blob/main/docs/cli.md#invoke) in your teriminal. +- Refreshed "[typescript](https://github.com/zapier/zapier-platform/tree/main/example-apps/typescript)" project template: We've updated the "typescript" project template with the latest type definitions. Enjoy enhanced type safety, improved autocompletion, and a smoother coding experience overall. +- `zapier-platform-cli` no longer supports Node.js 16: We don't consider this a breaking change because `zapier-platform-core` had stopped supporting Node.js 16 and has been running on Node.js 18 since v15.0.0. The minimum Node.js version required for `zapier-platform-cli` is now Node.js 18, aligning with `zapier-platform-core`. As usual, all other improvements and bug fixes are listed below. diff --git a/docs/index.html b/docs/index.html index feba820bd..2a4afb8b6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5102,12 +5102,15 @@
zapier invoke
CommandAdded in v15.17.0.
The zapier invoke <ACTION_TYPE> <ACTION_KEY>
CLI command emulates how the Zapier production environment would invoke your app. Since it runs code locally, it's a fast way to debug and test interactively without needing to deploy the code to Zapier.
Its general execution flow invovles calling operation.inputFields
of an action, resolving the input data to the expected types, and then calling the operation.perform
method.
zapier invoke --help
should be self-explanatory, but here's a quick rundown:
Added in v15.17.0.
The zapier invoke <ACTION_TYPE> <ACTION_KEY>
CLI command emulates how the Zapier production environment would invoke your app. Since it runs code locally, it's a fast way to debug and test interactively without needing to deploy the code to Zapier.
Its general execution flow involves calling operation.inputFields
of an action, resolving the input data to the expected types, and then calling the operation.perform
method.
zapier invoke --help
should be self-explanatory, but here's a quick rundown:
# Intialize auth data in .env file
+ # Initialize auth data in .env file
zapier invoke auth start
+# Refresh auth data (for OAuth2 or Session auth)
+zapier invoke auth refresh
+
# Test your auth data in .env
zapier invoke auth test
zapier invoke auth label
diff --git a/packages/cli/README-source.md b/packages/cli/README-source.md
index f79057510..fed94c8c0 100644
--- a/packages/cli/README-source.md
+++ b/packages/cli/README-source.md
@@ -1799,14 +1799,17 @@ There are several ways to test your Zapier integration:
The `zapier invoke ` CLI command emulates how the Zapier production environment would invoke your app. Since it runs code locally, it's a fast way to debug and test interactively without needing to deploy the code to Zapier.
-Its general execution flow invovles calling `operation.inputFields` of an action, resolving the input data to the expected types, and then calling the `operation.perform` method.
+Its general execution flow involves calling `operation.inputFields` of an action, resolving the input data to the expected types, and then calling the `operation.perform` method.
`zapier invoke --help` should be self-explanatory, but here's a quick rundown:
```bash
-# Intialize auth data in .env file
+# Initialize auth data in .env file
zapier invoke auth start
+# Refresh auth data (for OAuth2 or Session auth)
+zapier invoke auth refresh
+
# Test your auth data in .env
zapier invoke auth test
zapier invoke auth label
diff --git a/packages/cli/README.md b/packages/cli/README.md
index 2f7408c4a..af595c8db 100644
--- a/packages/cli/README.md
+++ b/packages/cli/README.md
@@ -3180,14 +3180,17 @@ There are several ways to test your Zapier integration:
The `zapier invoke ` CLI command emulates how the Zapier production environment would invoke your app. Since it runs code locally, it's a fast way to debug and test interactively without needing to deploy the code to Zapier.
-Its general execution flow invovles calling `operation.inputFields` of an action, resolving the input data to the expected types, and then calling the `operation.perform` method.
+Its general execution flow involves calling `operation.inputFields` of an action, resolving the input data to the expected types, and then calling the `operation.perform` method.
`zapier invoke --help` should be self-explanatory, but here's a quick rundown:
```bash
-# Intialize auth data in .env file
+# Initialize auth data in .env file
zapier invoke auth start
+# Refresh auth data (for OAuth2 or Session auth)
+zapier invoke auth refresh
+
# Test your auth data in .env
zapier invoke auth test
zapier invoke auth label
diff --git a/packages/cli/docs/index.html b/packages/cli/docs/index.html
index feba820bd..2a4afb8b6 100644
--- a/packages/cli/docs/index.html
+++ b/packages/cli/docs/index.html
@@ -5102,12 +5102,15 @@ Using zapier invoke
Command
- Added in v15.17.0.
The zapier invoke <ACTION_TYPE> <ACTION_KEY>
CLI command emulates how the Zapier production environment would invoke your app. Since it runs code locally, it's a fast way to debug and test interactively without needing to deploy the code to Zapier.
Its general execution flow invovles calling operation.inputFields
of an action, resolving the input data to the expected types, and then calling the operation.perform
method.
zapier invoke --help
should be self-explanatory, but here's a quick rundown:
+ Added in v15.17.0.
The zapier invoke <ACTION_TYPE> <ACTION_KEY>
CLI command emulates how the Zapier production environment would invoke your app. Since it runs code locally, it's a fast way to debug and test interactively without needing to deploy the code to Zapier.
Its general execution flow involves calling operation.inputFields
of an action, resolving the input data to the expected types, and then calling the operation.perform
method.
zapier invoke --help
should be self-explanatory, but here's a quick rundown:
- # Intialize auth data in .env file
+ # Initialize auth data in .env file
zapier invoke auth start
+# Refresh auth data (for OAuth2 or Session auth)
+zapier invoke auth refresh
+
# Test your auth data in .env
zapier invoke auth test
zapier invoke auth label
diff --git a/packages/cli/package.json b/packages/cli/package.json
index 5b3e3dd1d..c3f3044dd 100644
--- a/packages/cli/package.json
+++ b/packages/cli/package.json
@@ -19,7 +19,7 @@
"/oclif.manifest.json"
],
"engines": {
- "node": ">=16"
+ "node": ">=18"
},
"scripts": {
"docs": "ZAPIER_BASE_ENDPOINT='' node scripts/docs.js && cp -r docs ../..",