Merge pull request #882 from zapier/release-15.17.0

chore: release 15.17.0
zapier · Oct 11, 2024 · 64057eb · 64057eb
2 parents 67d5538 + 0a81e7c
commit 64057eb
Show file tree

Hide file tree

Showing 39 changed files with 137 additions and 106 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,34 @@
+## 15.17.0
+
+_released `2024-10-11`_
+
+Introducing two major updates to improve 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.
+
+As usual, all other improvements and bug fixes are listed below.
+
+### cli
+
+- :tada: Introduce `zapier invoke` command ([#856](https://github.com/zapier/zapier-platform/pull/856), [#872](https://github.com/zapier/zapier-platform/pull/872), [#878](https://github.com/zapier/zapier-platform/pull/878))
+- :nail_care: Update "typescript" project template and example with latest type definitions ([#845](https://github.com/zapier/zapier-platform/pull/845))
+- :bug: Fix `zapier convert` command not writing `bulkReads` to separate files ([#881](https://github.com/zapier/zapier-platform/pull/881))
+
+### core
+
+- :nail_care: Retry on 5xx errors when calling RPC ([#875](https://github.com/zapier/zapier-platform/pull/875))
+- :nail_care: Add `ResponseError` type ([#877](https://github.com/zapier/zapier-platform/pull/877))
+- :wrench: Bump mock-fs from 5.2.0 to 5.3.0 ([#872](https://github.com/zapier/zapier-platform/pull/872))
+
+### schema
+
+None!
+
+### misc
+
+- :wrench: Drop Node.js 16 and add Node.js 20 from/to CI ([#872](https://github.com/zapier/zapier-platform/pull/872))
+
 ## 15.16.1
 
 _released `2024-10-04`_
@@ -8,15 +39,15 @@ None!
 
 ### core
 
-- :hammer: Return a descriptive error when a filename cannot be uploaded ([#874](https://github.com/zapier/zapier-platform/pull/874))
+- :nail_care: Return a descriptive error when a filename cannot be uploaded ([#874](https://github.com/zapier/zapier-platform/pull/874))
 
 ### schema 
 
 None!
 
 ### misc
 
-- :scroll: Add canary command to docs ([#870](https://github.com/zapier/zapier-platform/pull/870))
+- :scroll: Add `canary` command to docs ([#870](https://github.com/zapier/zapier-platform/pull/870))
 - :scroll: Add instructions for installing the Zapier Platform development version to docs ([#873](https://github.com/zapier/zapier-platform/pull/870))
 
 ## 15.16.0 
@@ -25,7 +56,7 @@ _released `2024-09-24`_
 
 ### cli
 
-- :nail_care: Introduce zapier canary command ([#861](https://github.com/zapier/zapier-platform/pull/861))
+- :tada: Introduce `zapier canary` command ([#861](https://github.com/zapier/zapier-platform/pull/861))
 
 ### core
 

diff --git a/INSTALL_DEV.md b/INSTALL_DEV.md
@@ -16,7 +16,7 @@ yarn
 Then add this line to your shell configuration file, such as `~/.bashrc` or `~/.zshrc`:
 
 ```
-alias zapier-dev="node ~/Projects/zapier-platform/packages/cli/src/bin/run"
+alias zapier-dev="node ~/projects/zapier-platform/packages/cli/src/bin/run"
 ```
 
 Restart your shell with `exec $SHELL` and `zapier-dev` should be available. Test it out by running `zapier-dev` in your terminal. You should see this:

diff --git a/docs/cli.html b/docs/cli.html
@@ -745,7 +745,7 @@ <h2 id="invoke">invoke</h2>
     <div class="col-md-5 col-sm-12 col-height  docs-primary">
       <blockquote>
 <p>Invoke an auth operation, a trigger, or a create/search action locally.</p>
-</blockquote><p><strong>Usage</strong>: <code>zapier invoke [ACTIONTYPE] [ACTIONKEY]</code></p><p>This command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.</p><p>This command loads environment variables and <code>authData</code> from the <code>.env</code> file in the current directory. If you don&apos;t have an <code>.env</code> file yet, you can use the <code>zapier invoke auth start</code> command to help you initialize it, or you can manually create it.</p><p>The <code>zapier invoke auth start</code> subcommand will prompt you for the necessary auth fields and save them to the <code>.env</code> file.</p><p>Each line in the <code>.env</code> file should follow one of these formats:</p><ul>
+</blockquote><p><strong>Usage</strong>: <code>zapier invoke [ACTIONTYPE] [ACTIONKEY]</code></p><p>This command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.</p><p>This command loads environment variables and <code>authData</code> from the <code>.env</code> file in the current directory. If you don&apos;t have a <code>.env</code> file yet, you can use the <code>zapier invoke auth start</code> command to help you initialize it, or you can manually create it.</p><p>The <code>zapier invoke auth start</code> subcommand will prompt you for the necessary auth fields and save them to the <code>.env</code> file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.</p><p>Each line in the <code>.env</code> file should follow one of these formats:</p><ul>
 <li><code>VAR_NAME=VALUE</code> for environment variables</li>
 <li><code>authData_FIELD_KEY=VALUE</code> for auth data fields</li>
 </ul><p>For example, a <code>.env</code> file for an OAuth2 integration might look like this:</p>

diff --git a/docs/cli.md b/docs/cli.md
@@ -307,9 +307,9 @@ This command also checks the current directory for a linked integration.
 
 This command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.
 
-This command loads environment variables and `authData` from the `.env` file in the current directory. If you don't have an `.env` file yet, you can use the `zapier invoke auth start` command to help you initialize it, or you can manually create it.
+This command loads environment variables and `authData` from the `.env` file in the current directory. If you don't have a `.env` file yet, you can use the `zapier invoke auth start` command to help you initialize it, or you can manually create it.
 
-The `zapier invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file.
+The `zapier invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.
 
 Each line in the `.env` file should follow one of these formats:
 

diff --git a/docs/index.html b/docs/index.html
@@ -432,7 +432,7 @@ <h1 align="center">
 <li><a href="https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md">Latest CLI Docs</a></li>
 <li><a href="https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md">Latest CLI Reference</a></li>
 <li><a href="https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md">Latest Schema Docs</a></li>
-</ul><p>Our code is updated frequently. To see a full list of changes, look no further than <a href="https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md">the CHANGELOG</a>.</p><p>This doc describes the latest CLI version (<strong>15.16.1</strong>), as of this writing. If you&apos;re using an older version of the CLI, you may want to check out these historical releases:</p><ul>
+</ul><p>Our code is updated frequently. To see a full list of changes, look no further than <a href="https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md">the CHANGELOG</a>.</p><p>This doc describes the latest CLI version (<strong>15.17.0</strong>), as of this writing. If you&apos;re using an older version of the CLI, you may want to check out these historical releases:</p><ul>
 <li>CLI Docs: <a href="https://github.com/zapier/zapier-platform/blob/[email protected]/packages/cli/README.md">14.x</a>, <a href="https://github.com/zapier/zapier-platform/blob/[email protected]/packages/cli/README.md">13.x</a></li>
 <li>CLI Reference: <a href="https://github.com/zapier/zapier-platform/blob/[email protected]/packages/cli/docs/cli.md">14.x</a>, <a href="https://github.com/zapier/zapier-platform/blob/[email protected]/packages/cli/docs/cli.md">13.x</a></li>
 <li>Schema Docs: <a href="https://github.com/zapier/zapier-platform/blob/[email protected]/packages/schema/docs/build/schema.md">14.x</a>, <a href="https://github.com/zapier/zapier-platform/blob/[email protected]/packages/schema/docs/build/schema.md">13.x</a></li>
@@ -4390,7 +4390,7 @@ <h4 id="error-response-handling">Error Response Handling</h4>
 </div><div class="row">
   <div class="row-height">
     <div class="col-md-5 col-sm-12 col-height  docs-primary">
-      <p>For developers using v9.x and below, it&apos;s your responsibility to throw an exception for an error response. That means you should call <code>response.throwForStatus()</code> or throw an error yourself, likely following the <code>z.request</code> call.</p><p>This behavior has changed periodically across major versions, which changes how/when you have to worry about handling errors. Here&apos;s a diagram to illustrate that:</p><p><img src="https://cdn.zappy.app/e835d9beca1b6489a065d51a381613f3.png" alt></p><p>Ensure you&apos;re handling errors correctly for your platform version. The latest released version is <strong>15.16.1</strong>.</p>
+      <p>For developers using v9.x and below, it&apos;s your responsibility to throw an exception for an error response. That means you should call <code>response.throwForStatus()</code> or throw an error yourself, likely following the <code>z.request</code> call.</p><p>This behavior has changed periodically across major versions, which changes how/when you have to worry about handling errors. Here&apos;s a diagram to illustrate that:</p><p><img src="https://cdn.zappy.app/e835d9beca1b6489a065d51a381613f3.png" alt></p><p>Ensure you&apos;re handling errors correctly for your platform version. The latest released version is <strong>15.17.0</strong>.</p>
     </div>
     <div class="col-md-7 col-sm-12 col-height is-empty docs-code">
 
@@ -6192,7 +6192,7 @@ <h3 id="updating-these-packages">Updating These Packages</h3>
 </div><div class="row">
   <div class="row-height">
     <div class="col-md-5 col-sm-12 col-height  docs-primary">
-      <p>The Zapier platform and its tools are under active development. While you don&apos;t need to install every release, we release new versions because they are better than the last. We do our best to adhere to <a href="https://semver.org/">Semantic Versioning</a> wherein we won&apos;t break your code unless there&apos;s a <code>major</code> release. Otherwise, we&apos;re just fixing bugs (<code>patch</code>) and adding features (<code>minor</code>).</p><p>Broadly speaking, all releases will continue to work indefinitely. While you never <em>have</em> to upgrade your app&apos;s <code>zapier-platform-core</code> dependency, we recommend keeping an eye on the <a href="https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md">changelog</a> to see what new features and bug fixes are available.</p><p>For more info about which Node versions are supported, see <a href="#how-do-i-manually-set-the-nodejs-version-to-run-my-app-with">the faq</a>.</p><p>The most recently released version of <code>cli</code> and <code>core</code> is <strong>15.16.1</strong>. You can see the versions you&apos;re working with by running <code>zapier -v</code>.</p><p>To update <code>cli</code>, run <code>npm install -g zapier-platform-cli</code>.</p><p>To update the version of <code>core</code> your app depends on, set the <code>zapier-platform-core</code> dependency in your <code>package.json</code> to a version listed <a href="https://www.npmjs.com/package/zapier-platform-core?activeTab=versions">here</a> and reinstall your dependencies (either <code>yarn</code> or <code>npm install</code>).</p><p>For maximum compatibility, keep the versions of <code>cli</code> and <code>core</code> in sync.</p>
+      <p>The Zapier platform and its tools are under active development. While you don&apos;t need to install every release, we release new versions because they are better than the last. We do our best to adhere to <a href="https://semver.org/">Semantic Versioning</a> wherein we won&apos;t break your code unless there&apos;s a <code>major</code> release. Otherwise, we&apos;re just fixing bugs (<code>patch</code>) and adding features (<code>minor</code>).</p><p>Broadly speaking, all releases will continue to work indefinitely. While you never <em>have</em> to upgrade your app&apos;s <code>zapier-platform-core</code> dependency, we recommend keeping an eye on the <a href="https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md">changelog</a> to see what new features and bug fixes are available.</p><p>For more info about which Node versions are supported, see <a href="#how-do-i-manually-set-the-nodejs-version-to-run-my-app-with">the faq</a>.</p><p>The most recently released version of <code>cli</code> and <code>core</code> is <strong>15.17.0</strong>. You can see the versions you&apos;re working with by running <code>zapier -v</code>.</p><p>To update <code>cli</code>, run <code>npm install -g zapier-platform-cli</code>.</p><p>To update the version of <code>core</code> your app depends on, set the <code>zapier-platform-core</code> dependency in your <code>package.json</code> to a version listed <a href="https://www.npmjs.com/package/zapier-platform-core?activeTab=versions">here</a> and reinstall your dependencies (either <code>yarn</code> or <code>npm install</code>).</p><p>For maximum compatibility, keep the versions of <code>cli</code> and <code>core</code> in sync.</p>
     </div>
     <div class="col-md-7 col-sm-12 col-height is-empty docs-code">
 

diff --git a/example-apps/babel/package.json b/example-apps/babel/package.json
@@ -21,7 +21,7 @@
   },
   "dependencies": {
     "babel-polyfill": "6.26.0",
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "babel-cli": "6.26.0",

diff --git a/example-apps/basic-auth/package.json b/example-apps/basic-auth/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

diff --git a/example-apps/callback/package.json b/example-apps/callback/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

diff --git a/example-apps/create/package.json b/example-apps/create/package.json
@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

diff --git a/example-apps/custom-auth/package.json b/example-apps/custom-auth/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

diff --git a/example-apps/digest-auth/package.json b/example-apps/digest-auth/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

diff --git a/example-apps/dynamic-dropdown/package.json b/example-apps/dynamic-dropdown/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

diff --git a/example-apps/files/package.json b/example-apps/files/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1",
+    "zapier-platform-core": "15.17.0",
     "form-data": "4.0.0"
   },
   "devDependencies": {

diff --git a/example-apps/github/package.json b/example-apps/github/package.json
@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^26.6.3",

diff --git a/example-apps/middleware/package.json b/example-apps/middleware/package.json
@@ -16,7 +16,7 @@
   },
   "dependencies": {
     "lodash": "4.17.19",
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

diff --git a/example-apps/minimal/package.json b/example-apps/minimal/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

diff --git a/example-apps/oauth1-trello/package.json b/example-apps/oauth1-trello/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

diff --git a/example-apps/oauth1-tumblr/package.json b/example-apps/oauth1-tumblr/package.json
@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

diff --git a/example-apps/oauth1-twitter/package.json b/example-apps/oauth1-twitter/package.json
@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

diff --git a/example-apps/oauth2/package.json b/example-apps/oauth2/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

diff --git a/example-apps/onedrive/package.json b/example-apps/onedrive/package.json
@@ -22,7 +22,7 @@
     "content-disposition": "0.5.2",
     "lodash": "4.17.11",
     "node-fetch": "1.7.1",
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "eslint": "3.19.0",

diff --git a/example-apps/resource/package.json b/example-apps/resource/package.json
@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

diff --git a/example-apps/rest-hooks/package.json b/example-apps/rest-hooks/package.json
@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

diff --git a/example-apps/search-or-create/package.json b/example-apps/search-or-create/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

diff --git a/example-apps/search/package.json b/example-apps/search/package.json
@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

diff --git a/example-apps/session-auth/package.json b/example-apps/session-auth/package.json
@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

diff --git a/example-apps/trigger/package.json b/example-apps/trigger/package.json
@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

diff --git a/example-apps/typescript/package.json b/example-apps/typescript/package.json
@@ -10,7 +10,7 @@
     "_zapier-build": "npm run build"
   },
   "dependencies": {
-    "zapier-platform-core": "15.16.1"
+    "zapier-platform-core": "15.17.0"
   },
   "devDependencies": {
     "rimraf": "^5.0.10",