Merge branch 'main' into bulk-write

CHANGELOG.md

@@ -1,3 +1,67 @@
+## 15.14.0
+
+_released `2024-08-28`_
+
+### cli
+
+None!
+
+### core
+
+- :nail_care: Add scopes as an option for zcache usage ([#849](https://github.com/zapier/zapier-platform/pull/849))
+
+### schema
+
+None!
+
+### misc
+
+- :hammer: Add `customOptions` field to z.request options ([#846](https://github.com/zapier/zapier-platform/pull/846))
+
+## 15.13.0 
+
+_released `2024-08-21`_
+
+### cli
+
+None!
+
+### core
+
+None!
+
+### schema 
+- :nail_care: Add configurable poll delay for HookToPoll ([#844](https://github.com/zapier/zapier-platform/pull/844))
+
+### misc
+- :hammer: Bump elliptic from 6.5.4 to 6.5.7 ([#842](https://github.com/zapier/zapier-platform/pull/842))
+- :hammer: Bump axios from 1.6.1 to 1.7.4 ([#843](https://github.com/zapier/zapier-platform/pull/843))
+
+## 15.12.0
+
+_released `2024-08-16`_
+
+### cli 
+- :nail_care: Introduce `zapier pull` command ([#838](https://github.com/zapier/zapier-platform/pull/838))
+- :nail_care: Handle subheadings when interpreting the changelog ([#827](https://github.com/zapier/zapier-platform/pull/827))
+
+### core 
+- :bug: Properly type HTTP Options, replacing generic `object` types ([#840](https://github.com/zapier/zapier-platform/pull/840))
+- :bug: Allow Async Middleware Functions Types ([#826](https://github.com/zapier/zapier-platform/pull/826))
+
+### schema
+- :bug: Correct casing on `bulk reads` action type ([#831](https://github.com/zapier/zapier-platform/pull/831))
+- :bug: Display the `bulk_reads` functional constraint ([#829](https://github.com/zapier/zapier-platform/pull/829))
+
+### schema-to-ts
+- :bug: Simplify and correct Array types in Schema to TS conversion ([#835](https://github.com/zapier/zapier-platform/pull/835))
+
+### misc 
+
+- :scroll: Improve documentation accuracy regarding `primary: true` limitations ([#836](https://github.com/zapier/zapier-platform/pull/836))
+- :scroll: Document limitations regarding `primary` in `outputFields` ([#834](https://github.com/zapier/zapier-platform/pull/834))
+- :scroll: Document `bundle.meta.withSearch` ([#823](https://github.com/zapier/zapier-platform/pull/823))
+
 ## 15.11.1
 
 _released `2024-07-19`_

docs/index.html

@@ -431,7 +431,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.11.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.14.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/zapier-platform-cli@14.1.2/packages/cli/README.md">14.x</a>, <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@13.0.0/packages/cli/README.md">13.x</a></li>
 <li>CLI Reference: <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@14.1.2/packages/cli/docs/cli.md">14.x</a>, <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@13.0.0/packages/cli/docs/cli.md">13.x</a></li>
 <li>Schema Docs: <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@14.1.2/packages/schema/docs/build/schema.md">14.x</a>, <a href="https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@13.0.0/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.11.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.14.0</strong>.</p>
     </div>
     <div class="col-md-7 col-sm-12 col-height is-empty docs-code">
 
@@ -6017,7 +6017,7 @@ <h3 id="why-are-my-triggers-complaining-if-i-dont-provide-an-explicit-id-field">
 </div><div class="row">
   <div class="row-height">
     <div class="col-md-5 col-sm-12 col-height  docs-primary">
-      <p>will tell Zapier to use <code>(userId, slug)</code> as the unique primary key to deduplicate items when running a polling trigger.</p>
+      <p>will tell Zapier to use <code>(userId, slug)</code> as the unique primary key to deduplicate items when running a polling trigger.</p><p><strong>Limitation:</strong> The <code>primary</code> option currently doesn&apos;t support mixing top-level fields with nested fields that use double underscores in their keys. For example, if you set <code>primary: true</code> on both <code>id</code> and <code>user__id</code>, the <code>primary</code> setting on the <code>user__id</code> field will be ignored; only <code>id</code> will be used for deduplication. However, if all the <code>primary</code> fields are all nested, such as <code>user__id</code> + <code>user__name</code>, it will work as expected.</p>
     </div>
     <div class="col-md-7 col-sm-12 col-height is-empty docs-code">
 
@@ -6157,7 +6157,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.11.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.14.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">
 

example-apps/babel/package.json

@@ -21,7 +21,7 @@
   },
   "dependencies": {
     "babel-polyfill": "6.26.0",
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "babel-cli": "6.26.0",

example-apps/basic-auth/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/callback/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/create/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/custom-auth/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/digest-auth/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/dynamic-dropdown/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/files/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1",
+    "zapier-platform-core": "15.14.0",
     "form-data": "4.0.0"
   },
   "devDependencies": {

example-apps/github/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^26.6.3",

example-apps/middleware/package.json

@@ -16,7 +16,7 @@
   },
   "dependencies": {
     "lodash": "4.17.19",
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/minimal/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/oauth1-trello/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/oauth1-tumblr/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/oauth1-twitter/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/oauth2/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

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.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "eslint": "3.19.0",

example-apps/resource/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/rest-hooks/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/search-or-create/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/search/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/session-auth/package.json

@@ -7,7 +7,7 @@
     "test": "jest --testTimeout 10000"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3"

example-apps/trigger/package.json

@@ -15,7 +15,7 @@
     "npm": ">=5.6.0"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "mocha": "^5.2.0",

example-apps/typescript/package.json

@@ -11,7 +11,7 @@
     "_zapier-build": "npm run build"
   },
   "dependencies": {
-    "zapier-platform-core": "15.11.1"
+    "zapier-platform-core": "15.14.0"
   },
   "devDependencies": {
     "jest": "^25.5.3",

packages/cli/README-source.md

@@ -2201,6 +2201,8 @@ Since v15.6.0, instead of using the default `id` field, you can also define one
 
 will tell Zapier to use `(userId, slug)` as the unique primary key to deduplicate items when running a polling trigger.
 
+**Limitation:** The `primary` option currently doesn't support mixing top-level fields with nested fields that use double underscores in their keys. For example, if you set `primary: true` on both `id` and `user__id`, the `primary` setting on the `user__id` field will be ignored; only `id` will be used for deduplication. However, if all the `primary` fields are all nested, such as `user__id` + `user__name`, it will work as expected.
+
 ### Node X No Longer Supported
 
 If you're seeing errors like the following:

packages/cli/README.md

@@ -22,7 +22,7 @@ You may find some documents on the Zapier site duplicate or outdated. The most u
 
 Our code is updated frequently. To see a full list of changes, look no further than [the CHANGELOG](https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md).
 
-This doc describes the latest CLI version (**15.11.1**), as of this writing. If you're using an older version of the CLI, you may want to check out these historical releases:
+This doc describes the latest CLI version (**15.14.0**), as of this writing. If you're using an older version of the CLI, you may want to check out these historical releases:
 
 - CLI Docs: [14.x](https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@14.1.2/packages/cli/README.md), [13.x](https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@13.0.0/packages/cli/README.md)
 - CLI Reference: [14.x](https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@14.1.2/packages/cli/docs/cli.md), [13.x](https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@13.0.0/packages/cli/docs/cli.md)
@@ -2706,7 +2706,7 @@ This behavior has changed periodically across major versions, which changes how/
 
 ![](https://cdn.zappy.app/e835d9beca1b6489a065d51a381613f3.png)
 
-Ensure you're handling errors correctly for your platform version. The latest released version is **15.11.1**.
+Ensure you're handling errors correctly for your platform version. The latest released version is **15.14.0**.
 
 ### HTTP Request Options
 
@@ -3825,6 +3825,8 @@ Since v15.6.0, instead of using the default `id` field, you can also define one
 
 will tell Zapier to use `(userId, slug)` as the unique primary key to deduplicate items when running a polling trigger.
 
+**Limitation:** The `primary` option currently doesn't support mixing top-level fields with nested fields that use double underscores in their keys. For example, if you set `primary: true` on both `id` and `user__id`, the `primary` setting on the `user__id` field will be ignored; only `id` will be used for deduplication. However, if all the `primary` fields are all nested, such as `user__id` + `user__name`, it will work as expected.
+
 ### Node X No Longer Supported
 
 If you're seeing errors like the following:
@@ -3903,7 +3905,7 @@ Broadly speaking, all releases will continue to work indefinitely. While you nev
 For more info about which Node versions are supported, see [the faq](#how-do-i-manually-set-the-nodejs-version-to-run-my-app-with).
 
 <!-- TODO: if we decouple releases, change this -->
-The most recently released version of `cli` and `core` is **15.11.1**. You can see the versions you're working with by running `zapier -v`.
+The most recently released version of `cli` and `core` is **15.14.0**. You can see the versions you're working with by running `zapier -v`.
 
 To update `cli`, run `npm install -g zapier-platform-cli`.