zapier-platform-schema 12.2.1 → 14.0.0

package/CHANGELOG.md

@@ -1,3 +1,3 @@
 Read docs: https://zapier.github.io/zapier-platform/.
 
-Changelog: https://github.com/zapier/zapier-platform/blob/master/CHANGELOG.md
+Changelog: https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md

package/exported-schema.json

@@ -1,5 +1,5 @@
 {
-  "version": "12.2.1",
+  "version": "14.0.0",
   "schemas": {
     "AppSchema": {
       "id": "/AppSchema",
@@ -550,6 +550,10 @@
         "autoRefresh": {
           "description": "Should Zapier invoke `refreshAccessToken` when we receive an error for a 401 response?",
           "type": "boolean"
+        },
+        "enablePkce": {
+          "description": "Should Zapier use PKCE for OAuth2?",
+          "type": "boolean"
         }
       },
       "additionalProperties": false
@@ -725,7 +729,7 @@
           "$ref": "/FunctionSchema"
         },
         "performList": {
-          "description": "Can get \"live\" data on demand instead of waiting for a hook. If you find yourself reaching for this - consider resources and their built-in hook/list methods. Note: this is required for public apps to ensure the best UX for the end-user. For private apps, you can ignore warnings about this property with the `--without-style` flag during `zapier push`.",
+          "description": "Fetch a list of items on demand during testing instead of waiting for a hook. You can also consider resources and their built-in hook/list methods. Note: this is required for public apps to ensure the best UX for the end-user. For private apps, this is strongly recommended for testing REST Hooks. Otherwise, you can ignore warnings about this property with the `--without-style` flag during `zapier push`.",
           "oneOf": [
             {
               "$ref": "/RequestSchema"
@@ -746,7 +750,7 @@
           "type": "boolean"
         },
         "performSubscribe": {
-          "description": "Takes a URL and any necessary data from the user and subscribes. Note: this is required for public apps to ensure the best UX for the end-user. For private apps, you can ignore warnings about this property with the `--without-style` flag during `zapier push`.",
+          "description": "Takes a URL and any necessary data from the user and subscribes. Note: this is required for public apps to ensure the best UX for the end-user. For private apps, this is strongly recommended for testing REST Hooks. Otherwise, you can ignore warnings about this property with the `--without-style` flag during `zapier push`.",
           "oneOf": [
             {
               "$ref": "/RequestSchema"
@@ -763,7 +767,7 @@
           }
         },
         "performUnsubscribe": {
-          "description": "Takes a URL and data from a previous subscribe call and unsubscribes. Note: this is required for public apps to ensure the best UX for the end-user. For private apps, you can ignore warnings about this property with the `--without-style` flag during `zapier push`.",
+          "description": "Takes a URL and data from a previous subscribe call and unsubscribes. Note: this is required for public apps to ensure the best UX for the end-user. For private apps, this is strongly recommended for testing REST Hooks. Otherwise, you can ignore warnings about this property with the `--without-style` flag during `zapier push`.",
           "oneOf": [
             {
               "$ref": "/RequestSchema"
@@ -1524,7 +1528,7 @@
           "type": "boolean"
         },
         "skipThrowForStatus": {
-          "description": "Starting in `core` version `10.0.0`, `response.throwForStatus()` was called by default. We introduced a per-request way to opt-out of this behavior. This flag takes that a step further and controls that behavior integration-wide **for requests made using `z.request()`**. Unless they specify otherwise (per-request, or via middleware), [Shorthand requests](https://github.com/zapier/zapier-platform/blob/master/packages/cli/README.md#shorthand-http-requests) _always_ call `throwForStatus()`. `z.request()` calls can also ignore this flag if they set `skipThrowForStatus` directly",
+          "description": "Starting in `core` version `10.0.0`, `response.throwForStatus()` was called by default. We introduced a per-request way to opt-out of this behavior. This flag takes that a step further and controls that behavior integration-wide **for requests made using `z.request()`**. Unless they specify otherwise (per-request, or via middleware), [Shorthand requests](https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md#shorthand-http-requests) _always_ call `throwForStatus()`. `z.request()` calls can also ignore this flag if they set `skipThrowForStatus` directly",
           "type": "boolean"
         }
       },

package/lib/functional-constraints/index.js

@@ -18,7 +18,6 @@ const checks = [
   require('./matchingKeys'),
   require('./labelWhenVisible'),
   require('./uniqueInputFieldKeys'),
-  require('./searchAndCreatesAlias'),
 ];
 
 const runFunctionalConstraints = (definition, mainSchema) => {

package/lib/functional-constraints/searchOrCreateKeys.js

@@ -21,11 +21,7 @@ const getSearchOutputSampleKeys = (definition, searchKey) => {
   return Object.keys(searchOutputSampleFields);
 };
 
-const validateSearchOrCreateKeys = (definition) => {
-  // searchAndCreates is an alias for searchOrCreates. Another functional constraint makes sure only one of them is defined.
-  const searchCreatesKey = definition.searchAndCreates
-    ? 'searchAndCreates'
-    : 'searchOrCreates';
+const validateSearchCreateKeys = (definition, searchCreatesKey) => {
   const searchCreates = definition[searchCreatesKey];
 
   if (!searchCreates) {
@@ -254,4 +250,14 @@ const validateSearchOrCreateKeys = (definition) => {
   return errors;
 };
 
+const validateSearchOrCreateKeys = (definition) => {
+  // searchAndCreates is an alias for searchOrCreates. They are the same, but
+  // you can define both searchAndCreates and searchOrCreates to avoid search
+  // key collision.
+  return [
+    ...validateSearchCreateKeys(definition, 'searchOrCreates'),
+    ...validateSearchCreateKeys(definition, 'searchAndCreates'),
+  ];
+};
+
 module.exports = validateSearchOrCreateKeys;

package/lib/schemas/AppFlagsSchema.js

@@ -14,7 +14,7 @@ module.exports = makeSchema({
     },
     skipThrowForStatus: {
       description:
-        'Starting in `core` version `10.0.0`, `response.throwForStatus()` was called by default. We introduced a per-request way to opt-out of this behavior. This flag takes that a step further and controls that behavior integration-wide **for requests made using `z.request()`**. Unless they specify otherwise (per-request, or via middleware), [Shorthand requests](https://github.com/zapier/zapier-platform/blob/master/packages/cli/README.md#shorthand-http-requests) _always_ call `throwForStatus()`. `z.request()` calls can also ignore this flag if they set `skipThrowForStatus` directly',
+        'Starting in `core` version `10.0.0`, `response.throwForStatus()` was called by default. We introduced a per-request way to opt-out of this behavior. This flag takes that a step further and controls that behavior integration-wide **for requests made using `z.request()`**. Unless they specify otherwise (per-request, or via middleware), [Shorthand requests](https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md#shorthand-http-requests) _always_ call `throwForStatus()`. `z.request()` calls can also ignore this flag if they set `skipThrowForStatus` directly',
       type: 'boolean',
     },
   },

package/lib/schemas/AuthenticationOAuth2ConfigSchema.js

@@ -44,6 +44,10 @@ module.exports = makeSchema(
           'Should Zapier invoke `refreshAccessToken` when we receive an error for a 401 response?',
         type: 'boolean',
       },
+      enablePkce: {
+        description: 'Should Zapier use PKCE for OAuth2?',
+        type: 'boolean',
+      },
     },
     additionalProperties: false,
     examples: [
@@ -58,6 +62,7 @@ module.exports = makeSchema(
         codeParam: 'unique_code',
         scope: 'read/write',
         autoRefresh: true,
+        enablePkce: true,
       },
     ],
     antiExamples: [

package/lib/schemas/BasicHookOperationSchema.js

@@ -14,7 +14,7 @@ const BasicHookOperationSchema = JSON.parse(
 );
 
 const hookTechnicallyRequired =
-  'Note: this is required for public apps to ensure the best UX for the end-user. For private apps, you can ignore warnings about this property with the `--without-style` flag during `zapier push`.';
+  'Note: this is required for public apps to ensure the best UX for the end-user. For private apps, this is strongly recommended for testing REST Hooks. Otherwise, you can ignore warnings about this property with the `--without-style` flag during `zapier push`.';
 
 BasicHookOperationSchema.id = '/BasicHookOperationSchema';
 
@@ -41,7 +41,7 @@ BasicHookOperationSchema.properties = {
   },
   performList: {
     description:
-      'Can get "live" data on demand instead of waiting for a hook. If you find yourself reaching for this - consider resources and their built-in hook/list methods. ' +
+      'Fetch a list of items on demand during testing instead of waiting for a hook. You can also consider resources and their built-in hook/list methods. ' +
       hookTechnicallyRequired,
     oneOf: [{ $ref: RequestSchema.id }, { $ref: FunctionSchema.id }],
     docAnnotation: {

package/lib/utils/links.js

@@ -20,8 +20,8 @@ const makeDocLink = (id) =>
   });
 
 module.exports = {
-  filename: filename,
-  anchor: anchor,
-  makeCodeLink: makeCodeLink,
-  makeDocLink: makeDocLink,
+  filename,
+  anchor,
+  makeCodeLink,
+  makeDocLink,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-schema",
-  "version": "12.2.1",
+  "version": "14.0.0",
   "description": "Schema definition for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -14,9 +14,9 @@
   ],
   "scripts": {
     "preversion": "git pull && yarn test && yarn build",
-    "test": "mocha -t 10000 --recursive test",
-    "smoke-test": "mocha -t 10000 --recursive smoke-test",
-    "test:debug": "mocha -t 5-10000 --recursive --inspect-brk test",
+    "test": "mocha -t 10s --recursive test --exit",
+    "smoke-test": "mocha -t 10s --recursive smoke-test --exit",
+    "test:debug": "mocha --recursive --inspect-brk test",
     "lint": "eslint lib",
     "lint:fix": "eslint --fix lib",
     "coverage": "istanbul cover _mocha -- --recursive",

package/lib/functional-constraints/searchAndCreatesAlias.js

@@ -1,24 +0,0 @@
-'use strict';
-
-const jsonschema = require('jsonschema');
-
-const searchAndCreatesAliasConstraint = (definition) => {
-  // Ensure that 'searchOrCreates' and 'searchAndCreates' don't appear together, since one is an alias of the other
-  const errors = [];
-  if (definition.searchOrCreates && definition.searchAndCreates) {
-    errors.push(
-      new jsonschema.ValidationError(
-        `should not be used at the same time as its alias, searchAndCreates`,
-        definition,
-        `/AppSchema`,
-        `instance.searchOrCreates`,
-        'invalid',
-        'key'
-      )
-    );
-  }
-
-  return errors;
-};
-
-module.exports = searchAndCreatesAliasConstraint;