From 8013b26c6d2ed1390936622db6689aee10ac3c1d Mon Sep 17 00:00:00 2001 From: Chang-Hung Liang Date: Thu, 10 Oct 2024 17:25:16 +0800 Subject: [PATCH 1/6] Add 15.17.0 changelog --- CHANGELOG.md | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c1878ee7c..2eb76e2e3 100644 --- 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,7 +39,7 @@ 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 @@ -16,7 +47,7 @@ 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 From b2638ebe8cfa10e82151ec2ae7df2f54c39f4830 Mon Sep 17 00:00:00 2001 From: Chang-Hung Liang Date: Thu, 10 Oct 2024 17:31:44 +0800 Subject: [PATCH 2/6] Bump cli, core, schema 15.16.1 -> 15.17.0 --- docs/index.html | 6 +- example-apps/babel/package.json | 2 +- example-apps/basic-auth/package.json | 2 +- example-apps/callback/package.json | 2 +- example-apps/create/package.json | 2 +- example-apps/custom-auth/package.json | 2 +- example-apps/digest-auth/package.json | 2 +- example-apps/dynamic-dropdown/package.json | 2 +- example-apps/files/package.json | 2 +- example-apps/github/package.json | 2 +- example-apps/middleware/package.json | 2 +- example-apps/minimal/package.json | 2 +- example-apps/oauth1-trello/package.json | 2 +- example-apps/oauth1-tumblr/package.json | 2 +- example-apps/oauth1-twitter/package.json | 2 +- example-apps/oauth2/package.json | 2 +- example-apps/onedrive/package.json | 2 +- example-apps/resource/package.json | 2 +- example-apps/rest-hooks/package.json | 2 +- example-apps/search-or-create/package.json | 2 +- example-apps/search/package.json | 2 +- example-apps/session-auth/package.json | 2 +- example-apps/trigger/package.json | 2 +- example-apps/typescript/package.json | 2 +- packages/cli/README.md | 6 +- packages/cli/docs/index.html | 6 +- packages/cli/package.json | 2 +- packages/core/package.json | 4 +- packages/schema/docs/build/schema.md | 112 ++++++++++----------- packages/schema/exported-schema.json | 2 +- packages/schema/package.json | 2 +- 31 files changed, 93 insertions(+), 93 deletions(-) diff --git a/docs/index.html b/docs/index.html index 178c946e2..feba820bd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -432,7 +432,7 @@

  • Latest CLI Docs
  • Latest CLI Reference
  • Latest Schema Docs
    • -

    Our code is updated frequently. To see a full list of changes, look no further than the CHANGELOG.

    This doc describes the latest CLI version (15.16.1), as of this writing. If you're using an older version of the CLI, you may want to check out these historical releases:

      +

    Our code is updated frequently. To see a full list of changes, look no further than the CHANGELOG.

    This doc describes the latest CLI version (15.17.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, 13.x
    • CLI Reference: 14.x, 13.x
    • Schema Docs: 14.x, 13.x
      • @@ -4390,7 +4390,7 @@

      Error Response Handling

      -

      For developers using v9.x and below, it's your responsibility to throw an exception for an error response. That means you should call response.throwForStatus() or throw an error yourself, likely following the z.request call.

      This behavior has changed periodically across major versions, which changes how/when you have to worry about handling errors. Here's a diagram to illustrate that:

      Ensure you're handling errors correctly for your platform version. The latest released version is 15.16.1.

      +

      For developers using v9.x and below, it's your responsibility to throw an exception for an error response. That means you should call response.throwForStatus() or throw an error yourself, likely following the z.request call.

      This behavior has changed periodically across major versions, which changes how/when you have to worry about handling errors. Here's a diagram to illustrate that:

      Ensure you're handling errors correctly for your platform version. The latest released version is 15.17.0.

      @@ -6192,7 +6192,7 @@

      Updating These Packages

      -

      The Zapier platform and its tools are under active development. While you don't need to install every release, we release new versions because they are better than the last. We do our best to adhere to Semantic Versioning wherein we won't break your code unless there's a major release. Otherwise, we're just fixing bugs (patch) and adding features (minor).

      Broadly speaking, all releases will continue to work indefinitely. While you never have to upgrade your app's zapier-platform-core dependency, we recommend keeping an eye on the changelog to see what new features and bug fixes are available.

      For more info about which Node versions are supported, see the faq.

      The most recently released version of cli and core is 15.16.1. You can see the versions you're working with by running zapier -v.

      To update cli, run npm install -g zapier-platform-cli.

      To update the version of core your app depends on, set the zapier-platform-core dependency in your package.json to a version listed here and reinstall your dependencies (either yarn or npm install).

      For maximum compatibility, keep the versions of cli and core in sync.

      +

      The Zapier platform and its tools are under active development. While you don't need to install every release, we release new versions because they are better than the last. We do our best to adhere to Semantic Versioning wherein we won't break your code unless there's a major release. Otherwise, we're just fixing bugs (patch) and adding features (minor).

      Broadly speaking, all releases will continue to work indefinitely. While you never have to upgrade your app's zapier-platform-core dependency, we recommend keeping an eye on the changelog to see what new features and bug fixes are available.

      For more info about which Node versions are supported, see the faq.

      The most recently released version of cli and core is 15.17.0. You can see the versions you're working with by running zapier -v.

      To update cli, run npm install -g zapier-platform-cli.

      To update the version of core your app depends on, set the zapier-platform-core dependency in your package.json to a version listed here and reinstall your dependencies (either yarn or npm install).

      For maximum compatibility, keep the versions of cli and core in sync.

      diff --git a/example-apps/babel/package.json b/example-apps/babel/package.json index 9f2a3a9ff..7fc7f2a62 100644 --- 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 index 484f23198..90502b1e5 100644 --- 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 index e581e016c..f81e35c55 100644 --- 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 index 00ed36428..9388c1359 100644 --- 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 index 0359aec78..9ea667cf9 100644 --- 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 index b046803e9..0a292e9d2 100644 --- 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 index 35923a65b..c0d57b355 100644 --- 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 index 6a1e50ef1..8510bae55 100644 --- 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 index a5c671b60..9ec9abf0d 100644 --- 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 index d4bc196a2..c05cdc2cf 100644 --- 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 index 55c1dc10f..e678d7a39 100644 --- 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 index 10817f1ab..69dba4120 100644 --- 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 index 77a34c6b2..cb0932ea8 100644 --- 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 index acb415ad4..162de9a69 100644 --- 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 index 98f9e0776..01e6b4f68 100644 --- 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 index 3564ea484..311596a81 100644 --- 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 index ccc4779c1..2cf958969 100644 --- 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 index 428218e9d..d3d08ed18 100644 --- 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 index c65e59c79..3c869b325 100644 --- 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 index e5e4eb5b5..bc52d9d14 100644 --- 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 index a17cf8381..ccebe91fd 100644 --- 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 index b50343751..ccf7a1025 100644 --- 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 index fdc81d34d..85309b3c2 100644 --- 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", diff --git a/packages/cli/README.md b/packages/cli/README.md index 17f732da5..2f7408c4a 100644 --- a/packages/cli/README.md +++ b/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.16.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.17.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) @@ -2705,7 +2705,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.16.1**. +Ensure you're handling errors correctly for your platform version. The latest released version is **15.17.0**. ### HTTP Request Options @@ -3934,7 +3934,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). -The most recently released version of `cli` and `core` is **15.16.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.17.0**. You can see the versions you're working with by running `zapier -v`. To update `cli`, run `npm install -g zapier-platform-cli`. diff --git a/packages/cli/docs/index.html b/packages/cli/docs/index.html index 178c946e2..feba820bd 100644 --- a/packages/cli/docs/index.html +++ b/packages/cli/docs/index.html @@ -432,7 +432,7 @@

    • Latest CLI Docs
    • Latest CLI Reference
    • Latest Schema Docs
      • -

    Our code is updated frequently. To see a full list of changes, look no further than the CHANGELOG.

    This doc describes the latest CLI version (15.16.1), as of this writing. If you're using an older version of the CLI, you may want to check out these historical releases:

      +

    Our code is updated frequently. To see a full list of changes, look no further than the CHANGELOG.

    This doc describes the latest CLI version (15.17.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, 13.x
    • CLI Reference: 14.x, 13.x
    • Schema Docs: 14.x, 13.x
      • @@ -4390,7 +4390,7 @@

      Error Response Handling

      -

      For developers using v9.x and below, it's your responsibility to throw an exception for an error response. That means you should call response.throwForStatus() or throw an error yourself, likely following the z.request call.

      This behavior has changed periodically across major versions, which changes how/when you have to worry about handling errors. Here's a diagram to illustrate that:

      Ensure you're handling errors correctly for your platform version. The latest released version is 15.16.1.

      +

      For developers using v9.x and below, it's your responsibility to throw an exception for an error response. That means you should call response.throwForStatus() or throw an error yourself, likely following the z.request call.

      This behavior has changed periodically across major versions, which changes how/when you have to worry about handling errors. Here's a diagram to illustrate that:

      Ensure you're handling errors correctly for your platform version. The latest released version is 15.17.0.

      @@ -6192,7 +6192,7 @@

      Updating These Packages

      -

      The Zapier platform and its tools are under active development. While you don't need to install every release, we release new versions because they are better than the last. We do our best to adhere to Semantic Versioning wherein we won't break your code unless there's a major release. Otherwise, we're just fixing bugs (patch) and adding features (minor).

      Broadly speaking, all releases will continue to work indefinitely. While you never have to upgrade your app's zapier-platform-core dependency, we recommend keeping an eye on the changelog to see what new features and bug fixes are available.

      For more info about which Node versions are supported, see the faq.

      The most recently released version of cli and core is 15.16.1. You can see the versions you're working with by running zapier -v.

      To update cli, run npm install -g zapier-platform-cli.

      To update the version of core your app depends on, set the zapier-platform-core dependency in your package.json to a version listed here and reinstall your dependencies (either yarn or npm install).

      For maximum compatibility, keep the versions of cli and core in sync.

      +

      The Zapier platform and its tools are under active development. While you don't need to install every release, we release new versions because they are better than the last. We do our best to adhere to Semantic Versioning wherein we won't break your code unless there's a major release. Otherwise, we're just fixing bugs (patch) and adding features (minor).

      Broadly speaking, all releases will continue to work indefinitely. While you never have to upgrade your app's zapier-platform-core dependency, we recommend keeping an eye on the changelog to see what new features and bug fixes are available.

      For more info about which Node versions are supported, see the faq.

      The most recently released version of cli and core is 15.17.0. You can see the versions you're working with by running zapier -v.

      To update cli, run npm install -g zapier-platform-cli.

      To update the version of core your app depends on, set the zapier-platform-core dependency in your package.json to a version listed here and reinstall your dependencies (either yarn or npm install).

      For maximum compatibility, keep the versions of cli and core in sync.

      diff --git a/packages/cli/package.json b/packages/cli/package.json index ee985dbcd..5b3e3dd1d 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-cli", - "version": "15.16.1", + "version": "15.17.0", "description": "The CLI for managing integrations in Zapier Developer Platform.", "repository": "zapier/zapier-platform", "homepage": "https://platform.zapier.com/", diff --git a/packages/core/package.json b/packages/core/package.json index d699f6575..bfd4e3f84 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-core", - "version": "15.16.1", + "version": "15.17.0", "description": "The core SDK for CLI apps in the Zapier Developer Platform.", "repository": "zapier/zapier-platform", "homepage": "https://platform.zapier.com/", @@ -53,7 +53,7 @@ "node-fetch": "2.6.7", "oauth-sign": "0.9.0", "semver": "7.5.2", - "zapier-platform-schema": "15.16.1" + "zapier-platform-schema": "15.17.0" }, "devDependencies": { "@types/node-fetch": "^2.6.11", diff --git a/packages/schema/docs/build/schema.md b/packages/schema/docs/build/schema.md index 659ddb74a..b4b9763af 100644 --- a/packages/schema/docs/build/schema.md +++ b/packages/schema/docs/build/schema.md @@ -1,7 +1,7 @@ # `zapier-platform-schema` Generated Documentation -This is automatically generated by the `npm run docs` command in `zapier-platform-schema` version `15.16.1`. +This is automatically generated by the `npm run docs` command in `zapier-platform-schema` version `15.17.0`. ----- @@ -76,7 +76,7 @@ Codifies high-level options for your integration. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/AppFlagsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/AppFlagsSchema.js) #### Properties @@ -106,7 +106,7 @@ Represents a full app. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/AppSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/AppSchema.js) #### Properties @@ -151,7 +151,7 @@ Config for Basic Authentication. No extra properties are required to setup Basic #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/AuthenticationBasicConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/AuthenticationBasicConfigSchema.js) #### Examples @@ -171,7 +171,7 @@ Config for custom authentication (like API keys). No extra properties are requir #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/AuthenticationCustomConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/AuthenticationCustomConfigSchema.js) #### Properties @@ -208,7 +208,7 @@ Config for Digest Authentication. No extra properties are required to setup Dige #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/AuthenticationDigestConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/AuthenticationDigestConfigSchema.js) #### Examples @@ -228,7 +228,7 @@ Config for OAuth1 authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/AuthenticationOAuth1ConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/AuthenticationOAuth1ConfigSchema.js) #### Properties @@ -267,7 +267,7 @@ Config for OAuth2 authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/AuthenticationOAuth2ConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/AuthenticationOAuth2ConfigSchema.js) #### Properties @@ -314,7 +314,7 @@ Represents authentication schemes. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/AuthenticationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/AuthenticationSchema.js) #### Properties @@ -355,7 +355,7 @@ Config for session authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/AuthenticationSessionConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/AuthenticationSessionConfigSchema.js) #### Properties @@ -380,7 +380,7 @@ Represents the fundamental mechanics of a search/create. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/BasicActionOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/BasicActionOperationSchema.js) #### Properties @@ -413,7 +413,7 @@ Represents the fundamental mechanics of a create. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/BasicCreateActionOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/BasicCreateActionOperationSchema.js) #### Properties @@ -449,7 +449,7 @@ Represents user information for a trigger, search, or create. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/BasicDisplaySchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/BasicDisplaySchema.js) #### Properties @@ -487,7 +487,7 @@ Represents the inbound mechanics of hooks with optional subscribe/unsubscribe. D #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/BasicHookOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/BasicHookOperationSchema.js) #### Properties @@ -539,7 +539,7 @@ Represents the fundamental mechanics of triggers, searches, or creates. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/BasicOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/BasicOperationSchema.js) #### Properties @@ -570,7 +570,7 @@ Represents the fundamental mechanics of a trigger. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/BasicPollingOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/BasicPollingOperationSchema.js) #### Properties @@ -602,7 +602,7 @@ Currently an **internal-only** feature. Zapier uses this configuration for creat #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/BufferConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/BufferConfigSchema.js) #### Properties @@ -630,7 +630,7 @@ How will Zapier fetch resources from your application? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/BulkReadSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/BulkReadSchema.js) #### Properties @@ -674,7 +674,7 @@ Enumerates the bulk reads your app exposes. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/BulkReadsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/BulkReadsSchema.js) #### Properties @@ -724,7 +724,7 @@ How will Zapier create a new object? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/CreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/CreateSchema.js) #### Properties @@ -793,7 +793,7 @@ Enumerates the creates your app has available for users. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/CreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/CreatesSchema.js) #### Properties @@ -858,7 +858,7 @@ Like [/FieldsSchema](#fieldsschema) but you can provide functions to create dyna #### Details * **Type** - [/FieldOrFunctionSchema](#fieldorfunctionschema) -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/DynamicFieldsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/DynamicFieldsSchema.js) #### Examples @@ -883,7 +883,7 @@ An object describing a labeled choice in a static dropdown. Useful if the value #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js) #### Properties @@ -916,7 +916,7 @@ Yes | Yes | Array of [FieldChoiceWithLabel](#fieldchoicewithlabelschema) #### Details * **Type** - oneOf(`object`, `array`[oneOf(`string`, [/FieldChoiceWithLabelSchema](#fieldchoicewithlabelschema))]) -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/FieldChoicesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/FieldChoicesSchema.js) #### Examples @@ -938,7 +938,7 @@ Represents an array of fields or functions. #### Details * **Type** - `array`[oneOf([/FieldSchema](#fieldschema), [/FunctionSchema](#functionschema))] -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/FieldOrFunctionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/FieldOrFunctionSchema.js) #### Examples @@ -973,7 +973,7 @@ Defines a field an app either needs as input, or gives as output. In addition to #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/FieldSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/FieldSchema.js) #### Properties @@ -1027,7 +1027,7 @@ An array or collection of fields. #### Details * **Type** - `array`[[/FieldSchema](#fieldschema)] -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/FieldsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/FieldsSchema.js) #### Examples @@ -1047,7 +1047,7 @@ An object whose values can only be primitives #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/FlatObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/FlatObjectSchema.js) #### Properties @@ -1079,7 +1079,7 @@ A path to a file that might have content like `module.exports = (z, bundle) => [ #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/FunctionRequireSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/FunctionRequireSchema.js) #### Properties @@ -1105,7 +1105,7 @@ Internal pointer to a function from the original source or the source code itsel #### Details * **Type** - oneOf(`string`, [/FunctionRequireSchema](#functionrequireschema), [/FunctionSourceSchema](#functionsourceschema)) -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/FunctionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/FunctionSchema.js) #### Examples @@ -1130,7 +1130,7 @@ Source code like `{source: "return 1 + 2"}` which the system will wrap in a func #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/FunctionSourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/FunctionSourceSchema.js) #### Properties @@ -1157,7 +1157,7 @@ A bank of named functions that you can use in `z.hydrate('someName')` to lazily #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/HydratorsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/HydratorsSchema.js) #### Properties @@ -1183,7 +1183,7 @@ A unique identifier for this item. * **Type** - `string` * **Pattern** - `^[a-zA-Z]+[a-zA-Z0-9_]*$` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/KeySchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/KeySchema.js) #### Examples @@ -1209,7 +1209,7 @@ A unique identifier for this item. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/LockObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/LockObjectSchema.js) #### Properties @@ -1238,7 +1238,7 @@ List of before or after middlewares. Can be an array of functions or a single fu #### Details * **Type** - oneOf(`array`[[/FunctionSchema](#functionschema)], [/FunctionSchema](#functionschema)) -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/MiddlewaresSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/MiddlewaresSchema.js) #### Examples @@ -1259,7 +1259,7 @@ A representation of a HTTP redirect - you can use the `{{syntax}}` to inject aut #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/RedirectRequestSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/RedirectRequestSchema.js) #### Properties @@ -1287,7 +1287,7 @@ Reference a resource by key and the data it returns. In the format of: `{resourc * **Type** - `string` * **Pattern** - `^[a-zA-Z0-9_]+\.[a-zA-Z0-9_\s\[\]]+(\.[a-zA-Z0-9_\s\[\]]+(,[a-zA-Z0-9_\s\[\]]+)*)?$` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/RefResourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/RefResourceSchema.js) #### Examples @@ -1314,7 +1314,7 @@ A representation of a HTTP request - you can use the `{{syntax}}` to inject auth #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/RequestSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/RequestSchema.js) #### Properties @@ -1348,7 +1348,7 @@ How will we find create a specific object given inputs? Will be turned into a cr #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/ResourceMethodCreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/ResourceMethodCreateSchema.js) #### Properties @@ -1395,7 +1395,7 @@ How will we get a single object given a unique identifier/id? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/ResourceMethodGetSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/ResourceMethodGetSchema.js) #### Properties @@ -1438,7 +1438,7 @@ How will we get notified of new objects? Will be turned into a trigger automatic #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/ResourceMethodHookSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/ResourceMethodHookSchema.js) #### Properties @@ -1485,7 +1485,7 @@ How will we get a list of new objects? Will be turned into a trigger automatical #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/ResourceMethodListSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/ResourceMethodListSchema.js) #### Properties @@ -1541,7 +1541,7 @@ How will we find a specific object given filters or search terms? Will be turned #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/ResourceMethodSearchSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/ResourceMethodSearchSchema.js) #### Properties @@ -1590,7 +1590,7 @@ Represents a resource, which will in turn power triggers, searches, or creates. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/ResourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/ResourceSchema.js) #### Properties @@ -1676,7 +1676,7 @@ All the resources that underlie common CRUD methods powering automatically handl #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/ResourcesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/ResourcesSchema.js) #### Properties @@ -1743,7 +1743,7 @@ An array of objects suitable for returning in perform calls. #### Details * **Type** - `array`[`object`] -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/ResultsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/ResultsSchema.js) #### Examples @@ -1764,7 +1764,7 @@ Alias for /SearchOrCreatesSchema #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/SearchAndCreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/SearchAndCreatesSchema.js) #### Properties @@ -1831,7 +1831,7 @@ Pair an existing search and a create to enable "Find or Create" functionality in #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/SearchOrCreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/SearchOrCreateSchema.js) #### Properties @@ -1928,7 +1928,7 @@ Enumerates the search-or-creates your app has available for users. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/SearchOrCreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/SearchOrCreatesSchema.js) #### Properties @@ -1995,7 +1995,7 @@ How will Zapier search for existing objects? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/SearchSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/SearchSchema.js) #### Properties @@ -2051,7 +2051,7 @@ Enumerates the searches your app has available for users. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/SearchesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/SearchesSchema.js) #### Properties @@ -2103,7 +2103,7 @@ Zapier uses this configuration to apply throttling when the limit for the window #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/ThrottleObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/ThrottleObjectSchema.js) #### Properties @@ -2159,7 +2159,7 @@ EXPERIMENTAL: Overrides the original throttle configuration based on a Zapier ac #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/ThrottleOverrideObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/ThrottleOverrideObjectSchema.js) #### Properties @@ -2192,7 +2192,7 @@ How will Zapier get notified of new objects? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/TriggerSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/TriggerSchema.js) #### Properties @@ -2247,7 +2247,7 @@ Enumerates the triggers your app has available for users. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/TriggersSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/TriggersSchema.js) #### Properties @@ -2292,7 +2292,7 @@ Represents a simplified semver string, from `0.0.0` to `999.999.999`. * **Type** - `string` * **Pattern** - `^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.16.1/packages/schema/lib/schemas/VersionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@15.17.0/packages/schema/lib/schemas/VersionSchema.js) #### Examples diff --git a/packages/schema/exported-schema.json b/packages/schema/exported-schema.json index f40e40d91..c2cbe5853 100644 --- a/packages/schema/exported-schema.json +++ b/packages/schema/exported-schema.json @@ -1,5 +1,5 @@ { - "version": "15.16.1", + "version": "15.17.0", "schemas": { "AppSchema": { "id": "/AppSchema", diff --git a/packages/schema/package.json b/packages/schema/package.json index e06647783..ddebea5de 100644 --- a/packages/schema/package.json +++ b/packages/schema/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-schema", - "version": "15.16.1", + "version": "15.17.0", "description": "Schema definition for CLI apps in the Zapier Developer Platform.", "repository": "zapier/zapier-platform", "homepage": "https://platform.zapier.com/", From 292a0a914d7bd4dd362bbe2d3e7e70410faabe79 Mon Sep 17 00:00:00 2001 From: Chang-Hung Liang Date: Thu, 10 Oct 2024 20:36:09 +0800 Subject: [PATCH 3/6] Update version number in type definition --- packages/core/types/zapier.generated.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/types/zapier.generated.d.ts b/packages/core/types/zapier.generated.d.ts index 0df408bc9..de8080b46 100644 --- a/packages/core/types/zapier.generated.d.ts +++ b/packages/core/types/zapier.generated.d.ts @@ -4,7 +4,7 @@ * files, and/or the schema-to-ts tool and run its CLI to regenerate * these typings. * - * zapier-platform-schema version: 15.16.1 + * zapier-platform-schema version: 15.17.0 * schema-to-ts compiler version: 0.1.0 */ From 968e21bd25c9e22a2dc02a06de2b4d3ac630ad38 Mon Sep 17 00:00:00 2001 From: Chang-Hung Liang Date: Thu, 10 Oct 2024 20:36:46 +0800 Subject: [PATCH 4/6] Fix path in INSTALL_DEV.md --- INSTALL_DEV.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL_DEV.md b/INSTALL_DEV.md index f3da4e5e2..d9ecc0f90 100644 --- 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: From 38eb70e74014a4e8fe479d8c46bb3c66f8a401a5 Mon Sep 17 00:00:00 2001 From: Chang-Hung Liang Date: Thu, 10 Oct 2024 20:40:59 +0800 Subject: [PATCH 5/6] Improve invoke help doc --- docs/cli.html | 2 +- docs/cli.md | 4 ++-- packages/cli/docs/cli.html | 2 +- packages/cli/docs/cli.md | 4 ++-- packages/cli/src/oclif/commands/invoke.js | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/cli.html b/docs/cli.html index d8e39b316..08004b0f5 100644 --- a/docs/cli.html +++ b/docs/cli.html @@ -745,7 +745,7 @@

      invoke

      Invoke an auth operation, a trigger, or a create/search action locally.

      -

      Usage: zapier invoke [ACTIONTYPE] [ACTIONKEY]

      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.

      The zapier invoke auth start subcommand will prompt you for the necessary auth fields and save them to the .env file.

      Each line in the .env file should follow one of these formats:

        +

        Usage: zapier invoke [ACTIONTYPE] [ACTIONKEY]

        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 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. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token.

        Each line in the .env file should follow one of these formats:

        • VAR_NAME=VALUE for environment variables
        • authData_FIELD_KEY=VALUE for auth data fields

        For example, a .env file for an OAuth2 integration might look like this:

        diff --git a/docs/cli.md b/docs/cli.md index 480aca030..89bffed9f 100644 --- 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 browser, and wait for the OAuth2 redirect callback to get the access token. Each line in the `.env` file should follow one of these formats: diff --git a/packages/cli/docs/cli.html b/packages/cli/docs/cli.html index d8e39b316..08004b0f5 100644 --- a/packages/cli/docs/cli.html +++ b/packages/cli/docs/cli.html @@ -745,7 +745,7 @@

        invoke

        Invoke an auth operation, a trigger, or a create/search action locally.

        -

        Usage: zapier invoke [ACTIONTYPE] [ACTIONKEY]

        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.

        The zapier invoke auth start subcommand will prompt you for the necessary auth fields and save them to the .env file.

        Each line in the .env file should follow one of these formats:

          +

          Usage: zapier invoke [ACTIONTYPE] [ACTIONKEY]

          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 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. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token.

          Each line in the .env file should follow one of these formats:

          • VAR_NAME=VALUE for environment variables
          • authData_FIELD_KEY=VALUE for auth data fields

          For example, a .env file for an OAuth2 integration might look like this:

          diff --git a/packages/cli/docs/cli.md b/packages/cli/docs/cli.md index 480aca030..89bffed9f 100644 --- a/packages/cli/docs/cli.md +++ b/packages/cli/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 browser, and wait for the OAuth2 redirect callback to get the access token. Each line in the `.env` file should follow one of these formats: diff --git a/packages/cli/src/oclif/commands/invoke.js b/packages/cli/src/oclif/commands/invoke.js index 024c9d28b..094bd76f5 100644 --- a/packages/cli/src/oclif/commands/invoke.js +++ b/packages/cli/src/oclif/commands/invoke.js @@ -1155,9 +1155,9 @@ InvokeCommand.description = `Invoke an auth operation, a trigger, or a create/se 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 browser, and wait for the OAuth2 redirect callback to get the access token. Each line in the \`.env\` file should follow one of these formats: From 0a81e7ca16a55a681c200513d9877689ac8e6dfd Mon Sep 17 00:00:00 2001 From: Chang-Hung Liang Date: Thu, 10 Oct 2024 20:52:27 +0800 Subject: [PATCH 6/6] Update invoke help doc --- docs/cli.html | 2 +- docs/cli.md | 2 +- packages/cli/docs/cli.html | 2 +- packages/cli/docs/cli.md | 2 +- packages/cli/src/oclif/commands/invoke.js | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/cli.html b/docs/cli.html index 08004b0f5..392c64c39 100644 --- a/docs/cli.html +++ b/docs/cli.html @@ -745,7 +745,7 @@

          invoke

          Invoke an auth operation, a trigger, or a create/search action locally.

          -

          Usage: zapier invoke [ACTIONTYPE] [ACTIONKEY]

          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 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. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token.

          Each line in the .env file should follow one of these formats:

            +

            Usage: zapier invoke [ACTIONTYPE] [ACTIONKEY]

            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 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. 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:

            • VAR_NAME=VALUE for environment variables
            • authData_FIELD_KEY=VALUE for auth data fields

            For example, a .env file for an OAuth2 integration might look like this:

            diff --git a/docs/cli.md b/docs/cli.md index 89bffed9f..10a9de7b8 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -309,7 +309,7 @@ This command emulates how Zapier production environment would invoke your integr 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. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token. +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/packages/cli/docs/cli.html b/packages/cli/docs/cli.html index 08004b0f5..392c64c39 100644 --- a/packages/cli/docs/cli.html +++ b/packages/cli/docs/cli.html @@ -745,7 +745,7 @@

            invoke

            Invoke an auth operation, a trigger, or a create/search action locally.

            -

            Usage: zapier invoke [ACTIONTYPE] [ACTIONKEY]

            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 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. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token.

            Each line in the .env file should follow one of these formats:

              +

              Usage: zapier invoke [ACTIONTYPE] [ACTIONKEY]

              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 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. 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:

              • VAR_NAME=VALUE for environment variables
              • authData_FIELD_KEY=VALUE for auth data fields

              For example, a .env file for an OAuth2 integration might look like this:

              diff --git a/packages/cli/docs/cli.md b/packages/cli/docs/cli.md index 89bffed9f..10a9de7b8 100644 --- a/packages/cli/docs/cli.md +++ b/packages/cli/docs/cli.md @@ -309,7 +309,7 @@ This command emulates how Zapier production environment would invoke your integr 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. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token. +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/packages/cli/src/oclif/commands/invoke.js b/packages/cli/src/oclif/commands/invoke.js index 094bd76f5..452a7d6f8 100644 --- a/packages/cli/src/oclif/commands/invoke.js +++ b/packages/cli/src/oclif/commands/invoke.js @@ -1157,7 +1157,7 @@ This command emulates how Zapier production environment would invoke your integr 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. For OAuth2, it will start a local HTTP server, open the browser, and wait for the OAuth2 redirect callback to get the access token. +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: