From 141d33e4b7da03e05530e17ed6f5f30b82fe05c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Negr=C3=B3n?= Date: Mon, 13 Jan 2025 10:22:36 -0400 Subject: [PATCH 01/10] [PDE-5692] fix(CLI): Integration check reference URL's anchor tags are broken (#947) --- packages/cli/src/constants.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/cli/src/constants.js b/packages/cli/src/constants.js index 256c893ce..d1ae2038e 100644 --- a/packages/cli/src/constants.js +++ b/packages/cli/src/constants.js @@ -42,7 +42,7 @@ const PACKAGE_VERSION = packageJson.version; const UPDATE_NOTIFICATION_INTERVAL = 1000 * 60 * 60 * 24 * 7; // one week const CHECK_REF_DOC_LINK = - 'https://docs.zapier.com/platform/publish/integration-checks-reference#integration-check-reference'; + 'https://docs.zapier.com/platform/publish/integration-checks-reference'; const ISSUES_URL = 'https://github.com/zapier/zapier-platform/issues/new/choose'; From 28e4756c5c2ad03eb121d1422f3119e1114b2b24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Negr=C3=B3n?= Date: Mon, 13 Jan 2025 13:23:28 -0400 Subject: [PATCH 02/10] chore(cli, schema, core): release 16.1.1 (#948) * update changelog * Bump cli, core, schema 16.1.0 -> 16.1.1 --- CHANGELOG.md | 7 ++ 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/package.json | 2 +- packages/core/package.json | 4 +- packages/core/types/zapier.generated.d.ts | 2 +- packages/schema/docs/build/schema.md | 114 ++++++++++----------- packages/schema/exported-schema.json | 2 +- packages/schema/package.json | 2 +- 30 files changed, 93 insertions(+), 86 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e2ff0bcea..17bc053e9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +## 16.1.1 + +_released `2025-01-13`_ + +### cli + +- :bug: Fix "integration check reference" doc URL's anchor tags [#947](https://github.com/zapier/zapier-platform/pull/947) ## 16.1.0 diff --git a/example-apps/babel/package.json b/example-apps/babel/package.json index 255767667..c2f1e2dcd 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "babel-cli": "6.26.0", diff --git a/example-apps/basic-auth/package.json b/example-apps/basic-auth/package.json index 26a993262..b9789a2d0 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/callback/package.json b/example-apps/callback/package.json index 909efa24d..629092019 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/create/package.json b/example-apps/create/package.json index 0645b93b0..4ccb8502a 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/custom-auth/package.json b/example-apps/custom-auth/package.json index 027c7d2e2..049163a87 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/digest-auth/package.json b/example-apps/digest-auth/package.json index f918d41e9..7308b63bf 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/dynamic-dropdown/package.json b/example-apps/dynamic-dropdown/package.json index cec644016..f2f056937 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^29.6.0" diff --git a/example-apps/files/package.json b/example-apps/files/package.json index 99613312e..d5ddda291 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": "16.1.0", + "zapier-platform-core": "16.1.1", "form-data": "4.0.0" }, "devDependencies": { diff --git a/example-apps/github/package.json b/example-apps/github/package.json index 8f4920b97..10f5dd2f1 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^26.6.3", diff --git a/example-apps/middleware/package.json b/example-apps/middleware/package.json index d2d7a001f..c2ec5fe30 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/minimal/package.json b/example-apps/minimal/package.json index 72e624e2f..cf8e01ce9 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/oauth1-trello/package.json b/example-apps/oauth1-trello/package.json index f5974a90d..7e6324804 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/oauth1-tumblr/package.json b/example-apps/oauth1-tumblr/package.json index e2b6f6113..b70c1e4a5 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/oauth1-twitter/package.json b/example-apps/oauth1-twitter/package.json index ef7e2fe40..4b92eac05 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/oauth2/package.json b/example-apps/oauth2/package.json index cf3891461..133704847 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/onedrive/package.json b/example-apps/onedrive/package.json index 6d434a31d..9e942333c 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "eslint": "3.19.0", diff --git a/example-apps/resource/package.json b/example-apps/resource/package.json index 76d438b96..bd28c2126 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/rest-hooks/package.json b/example-apps/rest-hooks/package.json index 134cba8e5..9faaf0ea3 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/search-or-create/package.json b/example-apps/search-or-create/package.json index 1afe240aa..9f606c1bf 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/search/package.json b/example-apps/search/package.json index 322aab940..b23599412 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/session-auth/package.json b/example-apps/session-auth/package.json index 4dfd12d42..0695f9400 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/trigger/package.json b/example-apps/trigger/package.json index ef32f17bd..00d5f3252 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/typescript/package.json b/example-apps/typescript/package.json index 0cea8f3f1..d533a2654 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": "16.1.0" + "zapier-platform-core": "16.1.1" }, "devDependencies": { "rimraf": "^5.0.10", diff --git a/packages/cli/package.json b/packages/cli/package.json index e617ec6ae..6922e1661 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-cli", - "version": "16.1.0", + "version": "16.1.1", "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 626f1c89c..0f5eec8b4 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-core", - "version": "16.1.0", + "version": "16.1.1", "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.7.0", "oauth-sign": "0.9.0", "semver": "7.6.3", - "zapier-platform-schema": "16.1.0" + "zapier-platform-schema": "16.1.1" }, "devDependencies": { "@types/node-fetch": "^2.6.11", diff --git a/packages/core/types/zapier.generated.d.ts b/packages/core/types/zapier.generated.d.ts index b0ffb05fa..f5a5baae5 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: 16.1.0 + * zapier-platform-schema version: 16.1.1 * schema-to-ts compiler version: 0.1.0 */ diff --git a/packages/schema/docs/build/schema.md b/packages/schema/docs/build/schema.md index 2e2879eb0..bf86678a3 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 `16.1.0`. +This is automatically generated by the `npm run docs` command in `zapier-platform-schema` version `16.1.1`. ----- @@ -77,7 +77,7 @@ Codifies high-level options for your integration. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/AppFlagsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AppFlagsSchema.js) #### Properties @@ -107,7 +107,7 @@ Represents a full app. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/AppSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AppSchema.js) #### Properties @@ -152,7 +152,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@16.1.0/packages/schema/lib/schemas/AuthenticationBasicConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationBasicConfigSchema.js) #### Examples @@ -172,7 +172,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@16.1.0/packages/schema/lib/schemas/AuthenticationCustomConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationCustomConfigSchema.js) #### Properties @@ -209,7 +209,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@16.1.0/packages/schema/lib/schemas/AuthenticationDigestConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationDigestConfigSchema.js) #### Examples @@ -229,7 +229,7 @@ Config for OAuth1 authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/AuthenticationOAuth1ConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationOAuth1ConfigSchema.js) #### Properties @@ -268,7 +268,7 @@ Config for OAuth2 authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/AuthenticationOAuth2ConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationOAuth2ConfigSchema.js) #### Properties @@ -315,7 +315,7 @@ Represents authentication schemes. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/AuthenticationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationSchema.js) #### Properties @@ -356,7 +356,7 @@ Config for session authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/AuthenticationSessionConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationSessionConfigSchema.js) #### Properties @@ -381,7 +381,7 @@ Represents the fundamental mechanics of a search/create. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/BasicActionOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BasicActionOperationSchema.js) #### Properties @@ -414,7 +414,7 @@ Represents the fundamental mechanics of a create. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/BasicCreateActionOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BasicCreateActionOperationSchema.js) #### Properties @@ -450,7 +450,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@16.1.0/packages/schema/lib/schemas/BasicDisplaySchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BasicDisplaySchema.js) #### Properties @@ -488,7 +488,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@16.1.0/packages/schema/lib/schemas/BasicHookOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BasicHookOperationSchema.js) #### Properties @@ -540,7 +540,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@16.1.0/packages/schema/lib/schemas/BasicOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BasicOperationSchema.js) #### Properties @@ -571,7 +571,7 @@ Represents the fundamental mechanics of a trigger. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/BasicPollingOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BasicPollingOperationSchema.js) #### Properties @@ -603,7 +603,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@16.1.0/packages/schema/lib/schemas/BufferConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BufferConfigSchema.js) #### Properties @@ -631,7 +631,7 @@ How will Zapier fetch resources from your application? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/BulkReadSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BulkReadSchema.js) #### Properties @@ -675,7 +675,7 @@ Enumerates the bulk reads your app exposes. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/BulkReadsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BulkReadsSchema.js) #### Properties @@ -725,7 +725,7 @@ How will Zapier create a new object? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/CreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/CreateSchema.js) #### Properties @@ -794,7 +794,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@16.1.0/packages/schema/lib/schemas/CreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/CreatesSchema.js) #### Properties @@ -859,7 +859,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@16.1.0/packages/schema/lib/schemas/DynamicFieldsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/DynamicFieldsSchema.js) #### Examples @@ -884,7 +884,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@16.1.0/packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js) #### Properties @@ -917,7 +917,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@16.1.0/packages/schema/lib/schemas/FieldChoicesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FieldChoicesSchema.js) #### Examples @@ -939,7 +939,7 @@ Allows for additional metadata to be stored on the field. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/FieldMetaSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FieldMetaSchema.js) #### Properties @@ -966,7 +966,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@16.1.0/packages/schema/lib/schemas/FieldOrFunctionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FieldOrFunctionSchema.js) #### Examples @@ -1001,7 +1001,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@16.1.0/packages/schema/lib/schemas/FieldSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FieldSchema.js) #### Properties @@ -1063,7 +1063,7 @@ An array or collection of fields. #### Details * **Type** - `array`[[/FieldSchema](#fieldschema)] -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/FieldsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FieldsSchema.js) #### Examples @@ -1083,7 +1083,7 @@ An object whose values can only be primitives #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/FlatObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FlatObjectSchema.js) #### Properties @@ -1115,7 +1115,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@16.1.0/packages/schema/lib/schemas/FunctionRequireSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FunctionRequireSchema.js) #### Properties @@ -1141,7 +1141,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@16.1.0/packages/schema/lib/schemas/FunctionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FunctionSchema.js) #### Examples @@ -1166,7 +1166,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@16.1.0/packages/schema/lib/schemas/FunctionSourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FunctionSourceSchema.js) #### Properties @@ -1193,7 +1193,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@16.1.0/packages/schema/lib/schemas/HydratorsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/HydratorsSchema.js) #### Properties @@ -1219,7 +1219,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@16.1.0/packages/schema/lib/schemas/KeySchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/KeySchema.js) #### Examples @@ -1245,7 +1245,7 @@ A unique identifier for this item. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/LockObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/LockObjectSchema.js) #### Properties @@ -1274,7 +1274,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@16.1.0/packages/schema/lib/schemas/MiddlewaresSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/MiddlewaresSchema.js) #### Examples @@ -1295,7 +1295,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@16.1.0/packages/schema/lib/schemas/RedirectRequestSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/RedirectRequestSchema.js) #### Properties @@ -1323,7 +1323,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@16.1.0/packages/schema/lib/schemas/RefResourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/RefResourceSchema.js) #### Examples @@ -1350,7 +1350,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@16.1.0/packages/schema/lib/schemas/RequestSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/RequestSchema.js) #### Properties @@ -1384,7 +1384,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@16.1.0/packages/schema/lib/schemas/ResourceMethodCreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/ResourceMethodCreateSchema.js) #### Properties @@ -1431,7 +1431,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@16.1.0/packages/schema/lib/schemas/ResourceMethodGetSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/ResourceMethodGetSchema.js) #### Properties @@ -1474,7 +1474,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@16.1.0/packages/schema/lib/schemas/ResourceMethodHookSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/ResourceMethodHookSchema.js) #### Properties @@ -1521,7 +1521,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@16.1.0/packages/schema/lib/schemas/ResourceMethodListSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/ResourceMethodListSchema.js) #### Properties @@ -1577,7 +1577,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@16.1.0/packages/schema/lib/schemas/ResourceMethodSearchSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/ResourceMethodSearchSchema.js) #### Properties @@ -1626,7 +1626,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@16.1.0/packages/schema/lib/schemas/ResourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/ResourceSchema.js) #### Properties @@ -1712,7 +1712,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@16.1.0/packages/schema/lib/schemas/ResourcesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/ResourcesSchema.js) #### Properties @@ -1779,7 +1779,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@16.1.0/packages/schema/lib/schemas/ResultsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/ResultsSchema.js) #### Examples @@ -1800,7 +1800,7 @@ Alias for /SearchOrCreatesSchema #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/SearchAndCreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/SearchAndCreatesSchema.js) #### Properties @@ -1867,7 +1867,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@16.1.0/packages/schema/lib/schemas/SearchOrCreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/SearchOrCreateSchema.js) #### Properties @@ -1964,7 +1964,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@16.1.0/packages/schema/lib/schemas/SearchOrCreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/SearchOrCreatesSchema.js) #### Properties @@ -2031,7 +2031,7 @@ How will Zapier search for existing objects? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/SearchSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/SearchSchema.js) #### Properties @@ -2087,7 +2087,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@16.1.0/packages/schema/lib/schemas/SearchesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/SearchesSchema.js) #### Properties @@ -2139,7 +2139,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@16.1.0/packages/schema/lib/schemas/ThrottleObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/ThrottleObjectSchema.js) #### Properties @@ -2195,7 +2195,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@16.1.0/packages/schema/lib/schemas/ThrottleOverrideObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/ThrottleOverrideObjectSchema.js) #### Properties @@ -2228,7 +2228,7 @@ How will Zapier get notified of new objects? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.0/packages/schema/lib/schemas/TriggerSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/TriggerSchema.js) #### Properties @@ -2283,7 +2283,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@16.1.0/packages/schema/lib/schemas/TriggersSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/TriggersSchema.js) #### Properties @@ -2328,7 +2328,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@16.1.0/packages/schema/lib/schemas/VersionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/VersionSchema.js) #### Examples diff --git a/packages/schema/exported-schema.json b/packages/schema/exported-schema.json index 4030734ee..736003e40 100644 --- a/packages/schema/exported-schema.json +++ b/packages/schema/exported-schema.json @@ -1,5 +1,5 @@ { - "version": "16.1.0", + "version": "16.1.1", "schemas": { "AppSchema": { "id": "/AppSchema", diff --git a/packages/schema/package.json b/packages/schema/package.json index ba04c0a6e..38663a643 100644 --- a/packages/schema/package.json +++ b/packages/schema/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-schema", - "version": "16.1.0", + "version": "16.1.1", "description": "Schema definition for CLI apps in the Zapier Developer Platform.", "repository": "zapier/zapier-platform", "homepage": "https://platform.zapier.com/", From 44d599ee72505049ee265fe84c944ddc6bd49854 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Negr=C3=B3n?= Date: Tue, 14 Jan 2025 11:45:24 -0400 Subject: [PATCH 03/10] [PDE-5660] feat(cli): Require `--force` flag when updating production integration version environment variables via `env:set` or `env:unset` (#942) * initial commit * headers are always strings * review suggestions --- packages/cli/docs/cli.md | 2 + packages/cli/src/oclif/commands/env/set.js | 39 ++++++++++++++------ packages/cli/src/oclif/commands/env/unset.js | 38 +++++++++++++++---- packages/cli/src/utils/api.js | 1 + 4 files changed, 62 insertions(+), 18 deletions(-) diff --git a/packages/cli/docs/cli.md b/packages/cli/docs/cli.md index 68c49785a..ebc7ae180 100644 --- a/packages/cli/docs/cli.md +++ b/packages/cli/docs/cli.md @@ -225,6 +225,7 @@ resources convert and relate to different actions. * `key-value pairs...` | The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456` **Flags** +* `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution. * `-d, --debug` | Show extra debugging output. **Examples** @@ -242,6 +243,7 @@ resources convert and relate to different actions. * `keys...` | The keys to unset. Keys are case-insensitive. **Flags** +* `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution. * `-d, --debug` | Show extra debugging output. **Examples** diff --git a/packages/cli/src/oclif/commands/env/set.js b/packages/cli/src/oclif/commands/env/set.js index 9eb677988..d49111026 100644 --- a/packages/cli/src/oclif/commands/env/set.js +++ b/packages/cli/src/oclif/commands/env/set.js @@ -1,4 +1,4 @@ -const { Args } = require('@oclif/core'); +const { Args, Flags } = require('@oclif/core'); const { cyan } = require('colors/safe'); const { omit } = require('lodash'); @@ -45,21 +45,30 @@ class SetEnvCommand extends BaseCommand { } const url = `/apps/${app.id}/versions/${version}/multi-environment`; + const requestOptions = { + body: payload, + method: 'POST', + }; + + if (this.flags.force) { + requestOptions.extraHeaders = { + 'X-Force-Env-Var-Update': 'true', + }; + } try { - // currently, this returns nothing - await callAPI( - url, - { - body: payload, - method: 'POST', - }, - true, - ); + await callAPI(url, requestOptions, true); this.log(successMessage(version)); this.logJSON(payload); } catch (e) { + if (e.statusCode === 409) { + this.error( + `App version ${version} is the production version. Are you sure you want to set potentially live environment variables?` + + ` If so, run this command again with the --force flag.`, + ); + } + // comes back as json: { errors: [ 'The following keys failed to update: 3QER, 4WER' ] }, const failedKeys = e.json.errors[0].split('update: ')[1].split(', '); const successfulResult = omit(payload, failedKeys); @@ -85,7 +94,15 @@ SetEnvCommand.args = { 'The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`', }), }; -SetEnvCommand.flags = buildFlags(); +SetEnvCommand.flags = buildFlags({ + commandFlags: { + force: Flags.boolean({ + char: 'f', + description: + 'Force the update of environment variables regardless if the app version is production or not. Use with caution.', + }), + }, +}); SetEnvCommand.description = `Set environment variables for a version.`; SetEnvCommand.examples = [`zapier env:set 1.2.3 SECRET=12345 OTHER=4321`]; SetEnvCommand.strict = false; diff --git a/packages/cli/src/oclif/commands/env/unset.js b/packages/cli/src/oclif/commands/env/unset.js index cc70a655d..5fd09eeb8 100644 --- a/packages/cli/src/oclif/commands/env/unset.js +++ b/packages/cli/src/oclif/commands/env/unset.js @@ -1,4 +1,4 @@ -const { Args } = require('@oclif/core'); +const { Args, Flags } = require('@oclif/core'); const { cyan } = require('colors/safe'); const BaseCommand = require('../../ZapierBaseCommand'); @@ -42,13 +42,29 @@ class UnsetEnvCommand extends BaseCommand { } const url = `/apps/${app.id}/versions/${version}/multi-environment`; - - // currently, this returns nothing - // also, no need to cath errors here, since invalid keys don't get tripped over if the env var didn't exist in the first place - await callAPI(url, { + const requestOptions = { body: payload, method: 'POST', - }); + }; + + if (this.flags.force) { + requestOptions.extraHeaders = { + 'X-Force-Env-Var-Update': 'true', + }; + } + + try { + await callAPI(url, requestOptions); + } catch (e) { + if (e.statusCode === 409) { + this.error( + `App version ${version} is the production version. Are you sure you want to unset potentially live environment variables?` + + ` If so, run this command again with the --force flag.`, + ); + } else { + throw e; + } + } this.log(successMessage(version)); this.logJSON(keysToUnset); @@ -64,7 +80,15 @@ UnsetEnvCommand.args = { description: 'The keys to unset. Keys are case-insensitive.', }), }; -UnsetEnvCommand.flags = buildFlags(); +UnsetEnvCommand.flags = buildFlags({ + commandFlags: { + force: Flags.boolean({ + char: 'f', + description: + 'Force the update of environment variables regardless if the app version is production or not. Use with caution.', + }), + }, +}); UnsetEnvCommand.description = `Unset environment variables for a version.`; UnsetEnvCommand.examples = [`zapier env:unset 1.2.3 SECRET OTHER`]; UnsetEnvCommand.strict = false; diff --git a/packages/cli/src/utils/api.js b/packages/cli/src/utils/api.js index a0691b52f..2ca52d9ec 100644 --- a/packages/cli/src/utils/api.js +++ b/packages/cli/src/utils/api.js @@ -68,6 +68,7 @@ const callAPI = async ( method: options.method || 'GET', body: options.body ? JSON.stringify(options.body) : null, headers: { + ...options.extraHeaders, // extra headers first so they don't override defaults Accept: 'application/json', 'Content-Type': 'application/json; charset=utf-8', 'User-Agent': `${constants.PACKAGE_NAME}/${constants.PACKAGE_VERSION}`, From 019cca50f6d67e9ae9266f48c5c9f9b0df310e87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Negr=C3=B3n?= Date: Tue, 21 Jan 2025 09:01:34 -0400 Subject: [PATCH 04/10] [PDE-5660] fix(cli): Use .status when catching error response in env:set/env:unset (#952) --- packages/cli/src/oclif/commands/env/set.js | 2 +- packages/cli/src/oclif/commands/env/unset.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/cli/src/oclif/commands/env/set.js b/packages/cli/src/oclif/commands/env/set.js index d49111026..05bd8cbf9 100644 --- a/packages/cli/src/oclif/commands/env/set.js +++ b/packages/cli/src/oclif/commands/env/set.js @@ -62,7 +62,7 @@ class SetEnvCommand extends BaseCommand { this.log(successMessage(version)); this.logJSON(payload); } catch (e) { - if (e.statusCode === 409) { + if (e.status === 409) { this.error( `App version ${version} is the production version. Are you sure you want to set potentially live environment variables?` + ` If so, run this command again with the --force flag.`, diff --git a/packages/cli/src/oclif/commands/env/unset.js b/packages/cli/src/oclif/commands/env/unset.js index 5fd09eeb8..f97201823 100644 --- a/packages/cli/src/oclif/commands/env/unset.js +++ b/packages/cli/src/oclif/commands/env/unset.js @@ -56,7 +56,7 @@ class UnsetEnvCommand extends BaseCommand { try { await callAPI(url, requestOptions); } catch (e) { - if (e.statusCode === 409) { + if (e.status === 409) { this.error( `App version ${version} is the production version. Are you sure you want to unset potentially live environment variables?` + ` If so, run this command again with the --force flag.`, From 575fef5d196410d601dcf23a8a811599ef689a0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Negr=C3=B3n?= Date: Tue, 21 Jan 2025 11:01:26 -0400 Subject: [PATCH 05/10] [PDE-5602] feat(cli): Add support for running pre-checks via API before promotion and migration (#951) * checkpoint for using new endpoint before promotion/migration * refactor + spinner fixes * remove catch * review sugggestion * add debug logs, spinner should Error --- packages/cli/docs/cli.md | 1 + packages/cli/src/oclif/commands/migrate.js | 56 ++++++++++++++++++++ packages/cli/src/oclif/commands/promote.js | 60 ++++++++++++++++++++-- 3 files changed, 112 insertions(+), 5 deletions(-) diff --git a/packages/cli/docs/cli.md b/packages/cli/docs/cli.md index ebc7ae180..7ec6abc18 100644 --- a/packages/cli/docs/cli.md +++ b/packages/cli/docs/cli.md @@ -514,6 +514,7 @@ You cannot pass both `--user` and `--account`. **Flags** * `--user` | Migrates all of a users' Private Zaps within all accounts for which the specified user is a member * `--account` | Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member +* `-y, --yes` | Automatically answer "yes" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI. * `-d, --debug` | Show extra debugging output. **Examples** diff --git a/packages/cli/src/oclif/commands/migrate.js b/packages/cli/src/oclif/commands/migrate.js index 6492c9c12..e836df6fa 100644 --- a/packages/cli/src/oclif/commands/migrate.js +++ b/packages/cli/src/oclif/commands/migrate.js @@ -1,3 +1,5 @@ +const _ = require('lodash'); +const debug = require('debug')('zapier:migrate'); const { Args, Flags } = require('@oclif/core'); const BaseCommand = require('../ZapierBaseCommand'); @@ -6,6 +8,51 @@ const { callAPI } = require('../../utils/api'); const { buildFlags } = require('../buildFlags'); class MigrateCommand extends BaseCommand { + async run_require_confirmation_pre_checks(app, requestBody) { + const assumeYes = 'yes' in this.flags; + const url = `/apps/${app.id}/pre-migration-require-confirmation-checks`; + + this.startSpinner(`Running pre-checks before migration...`); + + try { + await callAPI( + url, + { + method: 'POST', + body: requestBody, + }, + true, + ); + } catch (response) { + this.stopSpinner({ success: false }); + + // 409 from the backend specifically signals pre-checks failed + if (response.status === 409) { + const softCheckErrors = _.get(response, 'json.errors', []); + const formattedErrors = softCheckErrors.map((e) => `* ${e}`).join('\n'); + + this.log(); + this.log('Non-blocking checks prior to migration returned warnings:'); + this.log(formattedErrors); + this.log(); + + const shouldContinuePreChecks = + assumeYes || + (await this.confirm( + 'Would you like to continue with the migration regardless?', + )); + + if (!shouldContinuePreChecks) { + this.error('Cancelled migration.'); + } + } else { + debug('Soft pre-checks before migration failed:', response.errText); + } + } finally { + this.stopSpinner(); + } + } + async perform() { const percent = this.args.percent; if (isNaN(percent) || percent < 1 || percent > 100) { @@ -14,6 +61,7 @@ class MigrateCommand extends BaseCommand { const account = this.flags.account; const user = this.flags.user; + const fromVersion = this.args.fromVersion; const toVersion = this.args.toVersion; let flagType; @@ -67,6 +115,9 @@ class MigrateCommand extends BaseCommand { email_type: flagType, }, }; + + await this.run_require_confirmation_pre_checks(app, body); + if (user || account) { this.startSpinner( `Starting migration from ${fromVersion} to ${toVersion} for ${ @@ -106,6 +157,11 @@ MigrateCommand.flags = buildFlags({ description: "Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member", }), + yes: Flags.boolean({ + char: 'y', + description: + 'Automatically answer "yes" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.', + }), }, }); diff --git a/packages/cli/src/oclif/commands/promote.js b/packages/cli/src/oclif/commands/promote.js index b206909ac..a6ba9ef89 100644 --- a/packages/cli/src/oclif/commands/promote.js +++ b/packages/cli/src/oclif/commands/promote.js @@ -1,4 +1,5 @@ const _ = require('lodash'); +const debug = require('debug')('zapier:promote'); const colors = require('colors/safe'); const { Args, Flags } = require('@oclif/core'); @@ -43,6 +44,52 @@ const hasAppChangeType = (metadata, changeType) => { }; class PromoteCommand extends BaseCommand { + async run_require_confirmation_pre_checks(app, requestBody) { + const assumeYes = 'yes' in this.flags; + const url = `/apps/${app.id}/pre-migration-require-confirmation-checks`; + + this.startSpinner(`Running pre-checks before promoting...`); + + try { + await callAPI( + url, + { + method: 'POST', + body: requestBody, + }, + true, + ); + } catch (response) { + this.stopSpinner({ success: false }); + // 409 from the backend specifically signals pre-checks failed + if (response.status === 409) { + const softCheckErrors = _.get(response, 'json.errors', []); + const formattedErrors = softCheckErrors.map((e) => `* ${e}`).join('\n'); + + this.log(); + this.log( + 'Non-blocking checks prior to promoting the integration returned warnings:', + ); + this.log(formattedErrors); + this.log(); + + const shouldContinuePreChecks = + assumeYes || + (await this.confirm( + 'Would you like to continue with the promotion process regardless?', + )); + + if (!shouldContinuePreChecks) { + this.error('Cancelled promote.'); + } + } else { + debug('Soft pre-checks before promotion failed:', response.errText); + } + } finally { + this.stopSpinner(); + } + } + async perform() { const app = await this.getWritableApp(); @@ -51,7 +98,8 @@ class PromoteCommand extends BaseCommand { const version = this.args.version; const assumeYes = 'yes' in this.flags; - let shouldContinue; + let shouldContinueChangelog; + const { changelog, appMetadata, issueMetadata } = await getVersionChangelog(version); @@ -133,15 +181,15 @@ ${metadataPromptHelper}`); this.log(); /* eslint-enable camelcase */ - shouldContinue = + shouldContinueChangelog = assumeYes || (await this.confirm( 'Would you like to continue promoting with this changelog?', )); - } - if (!shouldContinue) { - this.error('Cancelled promote.'); + if (!shouldContinueChangelog) { + this.error('Cancelled promote.'); + } } this.log( @@ -167,6 +215,8 @@ ${metadataPromptHelper}`); }, }; + await this.run_require_confirmation_pre_checks(app, body); + this.startSpinner(`Verifying and promoting ${version}`); const url = `/apps/${app.id}/migrations`; From 5b51578642748dab9a15219a5af96b7c7112022d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Negr=C3=B3n?= Date: Tue, 21 Jan 2025 13:10:16 -0400 Subject: [PATCH 06/10] [PDE-5660] fix(cli): Pass in rawError=true when catching error response in env:unset (#954) --- packages/cli/src/oclif/commands/env/unset.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/cli/src/oclif/commands/env/unset.js b/packages/cli/src/oclif/commands/env/unset.js index f97201823..9e102a76a 100644 --- a/packages/cli/src/oclif/commands/env/unset.js +++ b/packages/cli/src/oclif/commands/env/unset.js @@ -54,7 +54,7 @@ class UnsetEnvCommand extends BaseCommand { } try { - await callAPI(url, requestOptions); + await callAPI(url, requestOptions, true); } catch (e) { if (e.status === 409) { this.error( From 4b7d9cd3a0146b0c6cf9c17a0e9fa61adc6fccd7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Negr=C3=B3n?= Date: Tue, 21 Jan 2025 14:06:18 -0400 Subject: [PATCH 07/10] chore(cli, schema, core): release 16.2.0 (#953) * update changelog * Bump cli, core, schema 16.1.1 -> 16.2.0 --- CHANGELOG.md | 10 ++ 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/package.json | 2 +- packages/core/package.json | 4 +- packages/core/types/zapier.generated.d.ts | 2 +- packages/schema/docs/build/schema.md | 114 ++++++++++----------- packages/schema/exported-schema.json | 2 +- packages/schema/package.json | 2 +- 30 files changed, 96 insertions(+), 86 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 17bc053e9..b9897c707 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +## 16.2.0 + +_released `2025-01-21`_ + +### cli + +- :tada: Require `--force` flag when updating production integration version environment variables via `env:set` or `env:unset` [#942](https://github.com/zapier/zapier-platform/pull/942) +- :tada: Run environment variable soft checks (which require user confirmation to proceed) during `promote` and `migrate` [#951](https://github.com/zapier/zapier-platform/pull/951) + + ## 16.1.1 _released `2025-01-13`_ diff --git a/example-apps/babel/package.json b/example-apps/babel/package.json index c2f1e2dcd..99c7e7c5c 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "babel-cli": "6.26.0", diff --git a/example-apps/basic-auth/package.json b/example-apps/basic-auth/package.json index b9789a2d0..1cf925852 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/callback/package.json b/example-apps/callback/package.json index 629092019..e595ab073 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/create/package.json b/example-apps/create/package.json index 4ccb8502a..d4526e5ef 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/custom-auth/package.json b/example-apps/custom-auth/package.json index 049163a87..4a6f39be5 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/digest-auth/package.json b/example-apps/digest-auth/package.json index 7308b63bf..4ffae94aa 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/dynamic-dropdown/package.json b/example-apps/dynamic-dropdown/package.json index f2f056937..0d49f3cb9 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^29.6.0" diff --git a/example-apps/files/package.json b/example-apps/files/package.json index d5ddda291..822245ff1 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": "16.1.1", + "zapier-platform-core": "16.2.0", "form-data": "4.0.0" }, "devDependencies": { diff --git a/example-apps/github/package.json b/example-apps/github/package.json index 10f5dd2f1..8e1f08958 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^26.6.3", diff --git a/example-apps/middleware/package.json b/example-apps/middleware/package.json index c2ec5fe30..880c9f6d3 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/minimal/package.json b/example-apps/minimal/package.json index cf8e01ce9..2489ac612 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/oauth1-trello/package.json b/example-apps/oauth1-trello/package.json index 7e6324804..589c6e88b 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/oauth1-tumblr/package.json b/example-apps/oauth1-tumblr/package.json index b70c1e4a5..ec3db86a9 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/oauth1-twitter/package.json b/example-apps/oauth1-twitter/package.json index 4b92eac05..f21e00add 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/oauth2/package.json b/example-apps/oauth2/package.json index 133704847..027c33069 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/onedrive/package.json b/example-apps/onedrive/package.json index 9e942333c..29ec52201 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "eslint": "3.19.0", diff --git a/example-apps/resource/package.json b/example-apps/resource/package.json index bd28c2126..e544ce7eb 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/rest-hooks/package.json b/example-apps/rest-hooks/package.json index 9faaf0ea3..2ce07fc12 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": "16.1.1" + "zapier-platform-core": "16.2.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 9f606c1bf..c3d799812 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/search/package.json b/example-apps/search/package.json index b23599412..6b5ae8190 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/session-auth/package.json b/example-apps/session-auth/package.json index 0695f9400..06c8d6f06 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/trigger/package.json b/example-apps/trigger/package.json index 00d5f3252..b711821f5 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/typescript/package.json b/example-apps/typescript/package.json index d533a2654..ce0ea917c 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": "16.1.1" + "zapier-platform-core": "16.2.0" }, "devDependencies": { "rimraf": "^5.0.10", diff --git a/packages/cli/package.json b/packages/cli/package.json index 6922e1661..a1b4dfa44 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-cli", - "version": "16.1.1", + "version": "16.2.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 0f5eec8b4..0aed674df 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-core", - "version": "16.1.1", + "version": "16.2.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.7.0", "oauth-sign": "0.9.0", "semver": "7.6.3", - "zapier-platform-schema": "16.1.1" + "zapier-platform-schema": "16.2.0" }, "devDependencies": { "@types/node-fetch": "^2.6.11", diff --git a/packages/core/types/zapier.generated.d.ts b/packages/core/types/zapier.generated.d.ts index f5a5baae5..c5c34e60b 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: 16.1.1 + * zapier-platform-schema version: 16.2.0 * schema-to-ts compiler version: 0.1.0 */ diff --git a/packages/schema/docs/build/schema.md b/packages/schema/docs/build/schema.md index bf86678a3..f65819296 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 `16.1.1`. +This is automatically generated by the `npm run docs` command in `zapier-platform-schema` version `16.2.0`. ----- @@ -77,7 +77,7 @@ Codifies high-level options for your integration. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AppFlagsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AppFlagsSchema.js) #### Properties @@ -107,7 +107,7 @@ Represents a full app. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AppSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AppSchema.js) #### Properties @@ -152,7 +152,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@16.1.1/packages/schema/lib/schemas/AuthenticationBasicConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationBasicConfigSchema.js) #### Examples @@ -172,7 +172,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@16.1.1/packages/schema/lib/schemas/AuthenticationCustomConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationCustomConfigSchema.js) #### Properties @@ -209,7 +209,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@16.1.1/packages/schema/lib/schemas/AuthenticationDigestConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationDigestConfigSchema.js) #### Examples @@ -229,7 +229,7 @@ Config for OAuth1 authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationOAuth1ConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationOAuth1ConfigSchema.js) #### Properties @@ -268,7 +268,7 @@ Config for OAuth2 authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationOAuth2ConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationOAuth2ConfigSchema.js) #### Properties @@ -315,7 +315,7 @@ Represents authentication schemes. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationSchema.js) #### Properties @@ -356,7 +356,7 @@ Config for session authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/AuthenticationSessionConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationSessionConfigSchema.js) #### Properties @@ -381,7 +381,7 @@ Represents the fundamental mechanics of a search/create. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BasicActionOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BasicActionOperationSchema.js) #### Properties @@ -414,7 +414,7 @@ Represents the fundamental mechanics of a create. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BasicCreateActionOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BasicCreateActionOperationSchema.js) #### Properties @@ -450,7 +450,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@16.1.1/packages/schema/lib/schemas/BasicDisplaySchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BasicDisplaySchema.js) #### Properties @@ -488,7 +488,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@16.1.1/packages/schema/lib/schemas/BasicHookOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BasicHookOperationSchema.js) #### Properties @@ -540,7 +540,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@16.1.1/packages/schema/lib/schemas/BasicOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BasicOperationSchema.js) #### Properties @@ -571,7 +571,7 @@ Represents the fundamental mechanics of a trigger. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BasicPollingOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BasicPollingOperationSchema.js) #### Properties @@ -603,7 +603,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@16.1.1/packages/schema/lib/schemas/BufferConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BufferConfigSchema.js) #### Properties @@ -631,7 +631,7 @@ How will Zapier fetch resources from your application? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BulkReadSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BulkReadSchema.js) #### Properties @@ -675,7 +675,7 @@ Enumerates the bulk reads your app exposes. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/BulkReadsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BulkReadsSchema.js) #### Properties @@ -725,7 +725,7 @@ How will Zapier create a new object? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/CreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/CreateSchema.js) #### Properties @@ -794,7 +794,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@16.1.1/packages/schema/lib/schemas/CreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/CreatesSchema.js) #### Properties @@ -859,7 +859,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@16.1.1/packages/schema/lib/schemas/DynamicFieldsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/DynamicFieldsSchema.js) #### Examples @@ -884,7 +884,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@16.1.1/packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js) #### Properties @@ -917,7 +917,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@16.1.1/packages/schema/lib/schemas/FieldChoicesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FieldChoicesSchema.js) #### Examples @@ -939,7 +939,7 @@ Allows for additional metadata to be stored on the field. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FieldMetaSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FieldMetaSchema.js) #### Properties @@ -966,7 +966,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@16.1.1/packages/schema/lib/schemas/FieldOrFunctionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FieldOrFunctionSchema.js) #### Examples @@ -1001,7 +1001,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@16.1.1/packages/schema/lib/schemas/FieldSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FieldSchema.js) #### Properties @@ -1063,7 +1063,7 @@ An array or collection of fields. #### Details * **Type** - `array`[[/FieldSchema](#fieldschema)] -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FieldsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FieldsSchema.js) #### Examples @@ -1083,7 +1083,7 @@ An object whose values can only be primitives #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/FlatObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FlatObjectSchema.js) #### Properties @@ -1115,7 +1115,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@16.1.1/packages/schema/lib/schemas/FunctionRequireSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FunctionRequireSchema.js) #### Properties @@ -1141,7 +1141,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@16.1.1/packages/schema/lib/schemas/FunctionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FunctionSchema.js) #### Examples @@ -1166,7 +1166,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@16.1.1/packages/schema/lib/schemas/FunctionSourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FunctionSourceSchema.js) #### Properties @@ -1193,7 +1193,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@16.1.1/packages/schema/lib/schemas/HydratorsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/HydratorsSchema.js) #### Properties @@ -1219,7 +1219,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@16.1.1/packages/schema/lib/schemas/KeySchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/KeySchema.js) #### Examples @@ -1245,7 +1245,7 @@ A unique identifier for this item. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/LockObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/LockObjectSchema.js) #### Properties @@ -1274,7 +1274,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@16.1.1/packages/schema/lib/schemas/MiddlewaresSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/MiddlewaresSchema.js) #### Examples @@ -1295,7 +1295,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@16.1.1/packages/schema/lib/schemas/RedirectRequestSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/RedirectRequestSchema.js) #### Properties @@ -1323,7 +1323,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@16.1.1/packages/schema/lib/schemas/RefResourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/RefResourceSchema.js) #### Examples @@ -1350,7 +1350,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@16.1.1/packages/schema/lib/schemas/RequestSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/RequestSchema.js) #### Properties @@ -1384,7 +1384,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@16.1.1/packages/schema/lib/schemas/ResourceMethodCreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/ResourceMethodCreateSchema.js) #### Properties @@ -1431,7 +1431,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@16.1.1/packages/schema/lib/schemas/ResourceMethodGetSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/ResourceMethodGetSchema.js) #### Properties @@ -1474,7 +1474,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@16.1.1/packages/schema/lib/schemas/ResourceMethodHookSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/ResourceMethodHookSchema.js) #### Properties @@ -1521,7 +1521,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@16.1.1/packages/schema/lib/schemas/ResourceMethodListSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/ResourceMethodListSchema.js) #### Properties @@ -1577,7 +1577,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@16.1.1/packages/schema/lib/schemas/ResourceMethodSearchSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/ResourceMethodSearchSchema.js) #### Properties @@ -1626,7 +1626,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@16.1.1/packages/schema/lib/schemas/ResourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/ResourceSchema.js) #### Properties @@ -1712,7 +1712,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@16.1.1/packages/schema/lib/schemas/ResourcesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/ResourcesSchema.js) #### Properties @@ -1779,7 +1779,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@16.1.1/packages/schema/lib/schemas/ResultsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/ResultsSchema.js) #### Examples @@ -1800,7 +1800,7 @@ Alias for /SearchOrCreatesSchema #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/SearchAndCreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/SearchAndCreatesSchema.js) #### Properties @@ -1867,7 +1867,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@16.1.1/packages/schema/lib/schemas/SearchOrCreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/SearchOrCreateSchema.js) #### Properties @@ -1964,7 +1964,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@16.1.1/packages/schema/lib/schemas/SearchOrCreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/SearchOrCreatesSchema.js) #### Properties @@ -2031,7 +2031,7 @@ How will Zapier search for existing objects? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/SearchSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/SearchSchema.js) #### Properties @@ -2087,7 +2087,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@16.1.1/packages/schema/lib/schemas/SearchesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/SearchesSchema.js) #### Properties @@ -2139,7 +2139,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@16.1.1/packages/schema/lib/schemas/ThrottleObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/ThrottleObjectSchema.js) #### Properties @@ -2195,7 +2195,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@16.1.1/packages/schema/lib/schemas/ThrottleOverrideObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/ThrottleOverrideObjectSchema.js) #### Properties @@ -2228,7 +2228,7 @@ How will Zapier get notified of new objects? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.1.1/packages/schema/lib/schemas/TriggerSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/TriggerSchema.js) #### Properties @@ -2283,7 +2283,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@16.1.1/packages/schema/lib/schemas/TriggersSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/TriggersSchema.js) #### Properties @@ -2328,7 +2328,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@16.1.1/packages/schema/lib/schemas/VersionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/VersionSchema.js) #### Examples diff --git a/packages/schema/exported-schema.json b/packages/schema/exported-schema.json index 736003e40..d68af061a 100644 --- a/packages/schema/exported-schema.json +++ b/packages/schema/exported-schema.json @@ -1,5 +1,5 @@ { - "version": "16.1.1", + "version": "16.2.0", "schemas": { "AppSchema": { "id": "/AppSchema", diff --git a/packages/schema/package.json b/packages/schema/package.json index 38663a643..eeccbed4f 100644 --- a/packages/schema/package.json +++ b/packages/schema/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-schema", - "version": "16.1.1", + "version": "16.2.0", "description": "Schema definition for CLI apps in the Zapier Developer Platform.", "repository": "zapier/zapier-platform", "homepage": "https://platform.zapier.com/", From 1227d816d5542d3a3110e85f771a502b7a59d741 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Negr=C3=B3n?= Date: Tue, 28 Jan 2025 11:46:32 -0400 Subject: [PATCH 08/10] [PDE-5714] docs(cli): Update zapier pull prompt to clarify complex ynarxdeiH options during file conflicts (#959) --- packages/cli/src/generators/pull.js | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/packages/cli/src/generators/pull.js b/packages/cli/src/generators/pull.js index 3283fab11..2db69089c 100644 --- a/packages/cli/src/generators/pull.js +++ b/packages/cli/src/generators/pull.js @@ -24,7 +24,10 @@ module.exports = class PullGenerator extends Generator { name: 'confirm', message: `Warning: You are about to overwrite existing files. -Before proceeding, please make sure you have saved your work. Consider creating a backup or saving your current state in a git branch. During the process, you may abort anytime by pressing 'x'. +Before proceeding, please make sure you have saved your work. Consider creating a backup or saving your current state in a git branch. + +If presented with a series of options ('ynarxdeiH'), you may +press Enter to view more details about each option. For example, 'x' will abort the process. Do you want to continue?`, default: false, From d16b970af937344e411a146200f86c5fa5d8eb8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Negr=C3=B3n?= Date: Thu, 30 Jan 2025 10:14:09 -0400 Subject: [PATCH 09/10] [PDE-5716] feat(cli): Require `--overwrite-partner-changes` flag when a `zapier push` from staff could impact partner changes (#960) * checkpoint on implementation idea using overwrite flag * use rawError * fix flag value * rethrow nice message * oops * finish sentence --- packages/cli/src/oclif/commands/push.js | 11 +++++- packages/cli/src/utils/api.js | 48 +++++++++++++++++++------ 2 files changed, 48 insertions(+), 11 deletions(-) diff --git a/packages/cli/src/oclif/commands/push.js b/packages/cli/src/oclif/commands/push.js index 56b411486..d0f1fbf5f 100644 --- a/packages/cli/src/oclif/commands/push.js +++ b/packages/cli/src/oclif/commands/push.js @@ -1,5 +1,6 @@ const ZapierBaseCommand = require('../ZapierBaseCommand'); const { BUILD_PATH, SOURCE_PATH } = require('../../constants'); +const { Flags } = require('@oclif/core'); const BuildCommand = require('./build'); @@ -13,6 +14,7 @@ class PushCommand extends ZapierBaseCommand { skipNpmInstall: this.flags['skip-npm-install'], disableDependencyDetection: this.flags['disable-dependency-detection'], skipValidation: this.flags['skip-validation'], + overwritePartnerChanges: this.flags['overwrite-partner-changes'], }, ); this.log( @@ -21,7 +23,14 @@ class PushCommand extends ZapierBaseCommand { } } -PushCommand.flags = BuildCommand.flags; +PushCommand.flags = { + ...BuildCommand.flags, + 'overwrite-partner-changes': Flags.boolean({ + description: + '(Internal Use Only) Allows Zapier Staff to push changes to integrations in certain situations.', + hidden: true, + }), +}; PushCommand.description = `Build and upload the current integration. This command is the same as running \`zapier build\` and \`zapier upload\` in sequence. See those for more info.`; diff --git a/packages/cli/src/utils/api.js b/packages/cli/src/utils/api.js index 2ca52d9ec..679db973c 100644 --- a/packages/cli/src/utils/api.js +++ b/packages/cli/src/utils/api.js @@ -422,7 +422,10 @@ const downloadSourceZip = async (dst) => { } }; -const upload = async (app, { skipValidation = false } = {}) => { +const upload = async ( + app, + { skipValidation = false, overwritePartnerChanges = false } = {}, +) => { const zipPath = constants.BUILD_PATH; const sourceZipPath = constants.SOURCE_PATH; const appDir = process.cwd(); @@ -449,17 +452,42 @@ const upload = async (app, { skipValidation = false } = {}) => { const binarySourceZip = fs.readFileSync(fullSourceZipPath); const sourceBuffer = Buffer.from(binarySourceZip).toString('base64'); + const headers = {}; + if (overwritePartnerChanges) { + headers['X-Overwrite-Partner-Changes'] = 'true'; + } + startSpinner(`Uploading version ${definition.version}`); - await callAPI(`/apps/${app.id}/versions/${definition.version}`, { - method: 'PUT', - body: { - zip_file: buffer, - source_zip_file: sourceBuffer, - skip_validation: skipValidation, - }, - }); + try { + await callAPI( + `/apps/${app.id}/versions/${definition.version}`, + { + method: 'PUT', + body: { + zip_file: buffer, + source_zip_file: sourceBuffer, + skip_validation: skipValidation, + }, + extraHeaders: headers, + }, + true, + ); + } catch (err) { + endSpinner({ success: false }); + // 409 from the backend specifically signals that the last changes were from a partner + // and this is a staff user which could unintentionally overwrite those changes + if (err.status === 409) { + throw new Error( + `The latest integration changes appear to be from a partner. OK to overwrite?` + + ` If so, run this command again using the '--overwrite-partner-changes' flag.`, + ); + } - endSpinner(); + // Don't ignore other errors, re-throw them with a user-friendly message + throw new Error(err.errText); + } finally { + endSpinner(); + } }; module.exports = { From 0d13bba82858feee1ee0978226c089efa9791a02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Negr=C3=B3n?= Date: Thu, 30 Jan 2025 13:02:08 -0400 Subject: [PATCH 10/10] chore(cli, schema, core): release 16.3.0 (#961) * add changelog * Bump cli, core, schema 16.2.0 -> 16.3.0 --- CHANGELOG.md | 10 ++ 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/package.json | 2 +- packages/core/package.json | 4 +- packages/core/types/zapier.generated.d.ts | 2 +- packages/schema/docs/build/schema.md | 114 ++++++++++----------- packages/schema/exported-schema.json | 2 +- packages/schema/package.json | 2 +- 30 files changed, 96 insertions(+), 86 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b9897c707..7efba07be 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +## 16.3.0 + +_released `2025-01-30`_ + +### cli + +- :scroll: Update `pull` command help text to clarify `ynarxdeiH` options if file conflicts detected [#959](https://github.com/zapier/zapier-platform/pull/959) +- :tada: Add `--overwrite-partner-changes` flag in `push` command to help reduce partner integration clobbering (currently only supported for **internal** use) [#960](https://github.com/zapier/zapier-platform/pull/960) + + ## 16.2.0 _released `2025-01-21`_ diff --git a/example-apps/babel/package.json b/example-apps/babel/package.json index 99c7e7c5c..bd5f16903 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "babel-cli": "6.26.0", diff --git a/example-apps/basic-auth/package.json b/example-apps/basic-auth/package.json index 1cf925852..782d91694 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/callback/package.json b/example-apps/callback/package.json index e595ab073..2865d1d73 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/create/package.json b/example-apps/create/package.json index d4526e5ef..d5b4d12be 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/custom-auth/package.json b/example-apps/custom-auth/package.json index 4a6f39be5..8f8ef904f 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/digest-auth/package.json b/example-apps/digest-auth/package.json index 4ffae94aa..94012a71d 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/dynamic-dropdown/package.json b/example-apps/dynamic-dropdown/package.json index 0d49f3cb9..39f24cf5c 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^29.6.0" diff --git a/example-apps/files/package.json b/example-apps/files/package.json index 822245ff1..3d2a2ee37 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": "16.2.0", + "zapier-platform-core": "16.3.0", "form-data": "4.0.0" }, "devDependencies": { diff --git a/example-apps/github/package.json b/example-apps/github/package.json index 8e1f08958..7ec479f79 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^26.6.3", diff --git a/example-apps/middleware/package.json b/example-apps/middleware/package.json index 880c9f6d3..3a409e072 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/minimal/package.json b/example-apps/minimal/package.json index 2489ac612..e86c5b9a3 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/oauth1-trello/package.json b/example-apps/oauth1-trello/package.json index 589c6e88b..3ec447f24 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/oauth1-tumblr/package.json b/example-apps/oauth1-tumblr/package.json index ec3db86a9..ef5f4910f 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/oauth1-twitter/package.json b/example-apps/oauth1-twitter/package.json index f21e00add..328593498 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/oauth2/package.json b/example-apps/oauth2/package.json index 027c33069..8616a9325 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/onedrive/package.json b/example-apps/onedrive/package.json index 29ec52201..3631a4442 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "eslint": "3.19.0", diff --git a/example-apps/resource/package.json b/example-apps/resource/package.json index e544ce7eb..78de78a5b 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/rest-hooks/package.json b/example-apps/rest-hooks/package.json index 2ce07fc12..ea8e6ec93 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": "16.2.0" + "zapier-platform-core": "16.3.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 c3d799812..47f8d92ca 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/search/package.json b/example-apps/search/package.json index 6b5ae8190..64adccb3d 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/session-auth/package.json b/example-apps/session-auth/package.json index 06c8d6f06..dabaf3da4 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "jest": "^25.5.3" diff --git a/example-apps/trigger/package.json b/example-apps/trigger/package.json index b711821f5..353b9e72c 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "mocha": "^5.2.0", diff --git a/example-apps/typescript/package.json b/example-apps/typescript/package.json index ce0ea917c..f67d8c480 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": "16.2.0" + "zapier-platform-core": "16.3.0" }, "devDependencies": { "rimraf": "^5.0.10", diff --git a/packages/cli/package.json b/packages/cli/package.json index a1b4dfa44..e6588437c 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-cli", - "version": "16.2.0", + "version": "16.3.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 0aed674df..0013b8777 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-core", - "version": "16.2.0", + "version": "16.3.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.7.0", "oauth-sign": "0.9.0", "semver": "7.6.3", - "zapier-platform-schema": "16.2.0" + "zapier-platform-schema": "16.3.0" }, "devDependencies": { "@types/node-fetch": "^2.6.11", diff --git a/packages/core/types/zapier.generated.d.ts b/packages/core/types/zapier.generated.d.ts index c5c34e60b..094ff5c06 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: 16.2.0 + * zapier-platform-schema version: 16.3.0 * schema-to-ts compiler version: 0.1.0 */ diff --git a/packages/schema/docs/build/schema.md b/packages/schema/docs/build/schema.md index f65819296..656a3214a 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 `16.2.0`. +This is automatically generated by the `npm run docs` command in `zapier-platform-schema` version `16.3.0`. ----- @@ -77,7 +77,7 @@ Codifies high-level options for your integration. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AppFlagsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/AppFlagsSchema.js) #### Properties @@ -107,7 +107,7 @@ Represents a full app. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AppSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/AppSchema.js) #### Properties @@ -152,7 +152,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@16.2.0/packages/schema/lib/schemas/AuthenticationBasicConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/AuthenticationBasicConfigSchema.js) #### Examples @@ -172,7 +172,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@16.2.0/packages/schema/lib/schemas/AuthenticationCustomConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/AuthenticationCustomConfigSchema.js) #### Properties @@ -209,7 +209,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@16.2.0/packages/schema/lib/schemas/AuthenticationDigestConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/AuthenticationDigestConfigSchema.js) #### Examples @@ -229,7 +229,7 @@ Config for OAuth1 authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationOAuth1ConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/AuthenticationOAuth1ConfigSchema.js) #### Properties @@ -268,7 +268,7 @@ Config for OAuth2 authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationOAuth2ConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/AuthenticationOAuth2ConfigSchema.js) #### Properties @@ -315,7 +315,7 @@ Represents authentication schemes. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/AuthenticationSchema.js) #### Properties @@ -356,7 +356,7 @@ Config for session authentication. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/AuthenticationSessionConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/AuthenticationSessionConfigSchema.js) #### Properties @@ -381,7 +381,7 @@ Represents the fundamental mechanics of a search/create. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BasicActionOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/BasicActionOperationSchema.js) #### Properties @@ -414,7 +414,7 @@ Represents the fundamental mechanics of a create. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BasicCreateActionOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/BasicCreateActionOperationSchema.js) #### Properties @@ -450,7 +450,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@16.2.0/packages/schema/lib/schemas/BasicDisplaySchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/BasicDisplaySchema.js) #### Properties @@ -488,7 +488,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@16.2.0/packages/schema/lib/schemas/BasicHookOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/BasicHookOperationSchema.js) #### Properties @@ -540,7 +540,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@16.2.0/packages/schema/lib/schemas/BasicOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/BasicOperationSchema.js) #### Properties @@ -571,7 +571,7 @@ Represents the fundamental mechanics of a trigger. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BasicPollingOperationSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/BasicPollingOperationSchema.js) #### Properties @@ -603,7 +603,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@16.2.0/packages/schema/lib/schemas/BufferConfigSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/BufferConfigSchema.js) #### Properties @@ -631,7 +631,7 @@ How will Zapier fetch resources from your application? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BulkReadSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/BulkReadSchema.js) #### Properties @@ -675,7 +675,7 @@ Enumerates the bulk reads your app exposes. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/BulkReadsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/BulkReadsSchema.js) #### Properties @@ -725,7 +725,7 @@ How will Zapier create a new object? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/CreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/CreateSchema.js) #### Properties @@ -794,7 +794,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@16.2.0/packages/schema/lib/schemas/CreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/CreatesSchema.js) #### Properties @@ -859,7 +859,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@16.2.0/packages/schema/lib/schemas/DynamicFieldsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/DynamicFieldsSchema.js) #### Examples @@ -884,7 +884,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@16.2.0/packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/FieldChoiceWithLabelSchema.js) #### Properties @@ -917,7 +917,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@16.2.0/packages/schema/lib/schemas/FieldChoicesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/FieldChoicesSchema.js) #### Examples @@ -939,7 +939,7 @@ Allows for additional metadata to be stored on the field. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FieldMetaSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/FieldMetaSchema.js) #### Properties @@ -966,7 +966,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@16.2.0/packages/schema/lib/schemas/FieldOrFunctionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/FieldOrFunctionSchema.js) #### Examples @@ -1001,7 +1001,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@16.2.0/packages/schema/lib/schemas/FieldSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/FieldSchema.js) #### Properties @@ -1063,7 +1063,7 @@ An array or collection of fields. #### Details * **Type** - `array`[[/FieldSchema](#fieldschema)] -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FieldsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/FieldsSchema.js) #### Examples @@ -1083,7 +1083,7 @@ An object whose values can only be primitives #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/FlatObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/FlatObjectSchema.js) #### Properties @@ -1115,7 +1115,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@16.2.0/packages/schema/lib/schemas/FunctionRequireSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/FunctionRequireSchema.js) #### Properties @@ -1141,7 +1141,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@16.2.0/packages/schema/lib/schemas/FunctionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/FunctionSchema.js) #### Examples @@ -1166,7 +1166,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@16.2.0/packages/schema/lib/schemas/FunctionSourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/FunctionSourceSchema.js) #### Properties @@ -1193,7 +1193,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@16.2.0/packages/schema/lib/schemas/HydratorsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/HydratorsSchema.js) #### Properties @@ -1219,7 +1219,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@16.2.0/packages/schema/lib/schemas/KeySchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/KeySchema.js) #### Examples @@ -1245,7 +1245,7 @@ A unique identifier for this item. #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/LockObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/LockObjectSchema.js) #### Properties @@ -1274,7 +1274,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@16.2.0/packages/schema/lib/schemas/MiddlewaresSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/MiddlewaresSchema.js) #### Examples @@ -1295,7 +1295,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@16.2.0/packages/schema/lib/schemas/RedirectRequestSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/RedirectRequestSchema.js) #### Properties @@ -1323,7 +1323,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@16.2.0/packages/schema/lib/schemas/RefResourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/RefResourceSchema.js) #### Examples @@ -1350,7 +1350,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@16.2.0/packages/schema/lib/schemas/RequestSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/RequestSchema.js) #### Properties @@ -1384,7 +1384,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@16.2.0/packages/schema/lib/schemas/ResourceMethodCreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/ResourceMethodCreateSchema.js) #### Properties @@ -1431,7 +1431,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@16.2.0/packages/schema/lib/schemas/ResourceMethodGetSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/ResourceMethodGetSchema.js) #### Properties @@ -1474,7 +1474,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@16.2.0/packages/schema/lib/schemas/ResourceMethodHookSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/ResourceMethodHookSchema.js) #### Properties @@ -1521,7 +1521,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@16.2.0/packages/schema/lib/schemas/ResourceMethodListSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/ResourceMethodListSchema.js) #### Properties @@ -1577,7 +1577,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@16.2.0/packages/schema/lib/schemas/ResourceMethodSearchSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/ResourceMethodSearchSchema.js) #### Properties @@ -1626,7 +1626,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@16.2.0/packages/schema/lib/schemas/ResourceSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/ResourceSchema.js) #### Properties @@ -1712,7 +1712,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@16.2.0/packages/schema/lib/schemas/ResourcesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/ResourcesSchema.js) #### Properties @@ -1779,7 +1779,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@16.2.0/packages/schema/lib/schemas/ResultsSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/ResultsSchema.js) #### Examples @@ -1800,7 +1800,7 @@ Alias for /SearchOrCreatesSchema #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/SearchAndCreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/SearchAndCreatesSchema.js) #### Properties @@ -1867,7 +1867,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@16.2.0/packages/schema/lib/schemas/SearchOrCreateSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/SearchOrCreateSchema.js) #### Properties @@ -1964,7 +1964,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@16.2.0/packages/schema/lib/schemas/SearchOrCreatesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/SearchOrCreatesSchema.js) #### Properties @@ -2031,7 +2031,7 @@ How will Zapier search for existing objects? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/SearchSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/SearchSchema.js) #### Properties @@ -2087,7 +2087,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@16.2.0/packages/schema/lib/schemas/SearchesSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/SearchesSchema.js) #### Properties @@ -2139,7 +2139,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@16.2.0/packages/schema/lib/schemas/ThrottleObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/ThrottleObjectSchema.js) #### Properties @@ -2195,7 +2195,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@16.2.0/packages/schema/lib/schemas/ThrottleOverrideObjectSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/ThrottleOverrideObjectSchema.js) #### Properties @@ -2228,7 +2228,7 @@ How will Zapier get notified of new objects? #### Details * **Type** - `object` -* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.2.0/packages/schema/lib/schemas/TriggerSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/TriggerSchema.js) #### Properties @@ -2283,7 +2283,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@16.2.0/packages/schema/lib/schemas/TriggersSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/TriggersSchema.js) #### Properties @@ -2328,7 +2328,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@16.2.0/packages/schema/lib/schemas/VersionSchema.js) +* [**Source Code**](https://github.com/zapier/zapier-platform/blob/zapier-platform-schema@16.3.0/packages/schema/lib/schemas/VersionSchema.js) #### Examples diff --git a/packages/schema/exported-schema.json b/packages/schema/exported-schema.json index d68af061a..b5ae5a21c 100644 --- a/packages/schema/exported-schema.json +++ b/packages/schema/exported-schema.json @@ -1,5 +1,5 @@ { - "version": "16.2.0", + "version": "16.3.0", "schemas": { "AppSchema": { "id": "/AppSchema", diff --git a/packages/schema/package.json b/packages/schema/package.json index eeccbed4f..f6e0a47bd 100644 --- a/packages/schema/package.json +++ b/packages/schema/package.json @@ -1,6 +1,6 @@ { "name": "zapier-platform-schema", - "version": "16.2.0", + "version": "16.3.0", "description": "Schema definition for CLI apps in the Zapier Developer Platform.", "repository": "zapier/zapier-platform", "homepage": "https://platform.zapier.com/",