zapier-platform-schema 15.0.1 → 15.2.0

package/exported-schema.json

@@ -1,5 +1,5 @@
 {
-  "version": "15.0.1",
+  "version": "15.2.0",
   "schemas": {
     "AppSchema": {
       "id": "/AppSchema",
@@ -226,7 +226,7 @@
           "type": "boolean"
         },
         "computed": {
-          "description": "Is this field automatically populated (and hidden from the user)?",
+          "description": "Is this field automatically populated (and hidden from the user)? Note: Only OAuth and Session Auth support fields with this key.",
           "type": "boolean"
         },
         "altersDynamicFields": {
@@ -605,6 +605,32 @@
       "minLength": 2,
       "pattern": "^[a-zA-Z]+[a-zA-Z0-9_]*$"
     },
+    "LockObjectSchema": {
+      "id": "/LockObjectSchema",
+      "description": "**INTERNAL USE ONLY**. Zapier uses this configuration for internal operation locking.",
+      "type": "object",
+      "required": ["key"],
+      "properties": {
+        "key": {
+          "description": "The key to use for locking. This should be unique to the operation. While actions of different integrations with the same key and scope will never lock each other out, actions of the same integration with the same key and scope will do. User data provided for the input fields can be used in the key with the use of the curly braces referencing. For example, to access the user data provided for the input field \"test_field\", use `{{bundle.inputData.test_field}}`. Note that a required input field should be referenced to get user data always.",
+          "type": "string",
+          "minLength": 1
+        },
+        "scope": {
+          "description": "By default, locks are scoped to the app. That is, all users of the app will share the same locks. If you want to restrict serial access to a specific user, auth, or account, you can set the scope to one or more of the following: 'user' - Locks based on user ids.  'auth' - Locks based on unique auth ids. 'account' - Locks for all users under a single account. You may also combine scopes. Note that \"app\" is included, always, in the scope provided. For example, a scope of ['account', 'auth'] would result to ['app', 'account', 'auth'].",
+          "type": "array",
+          "items": {
+            "enum": ["user", "auth", "account"],
+            "type": "string"
+          }
+        },
+        "timeout": {
+          "description": "The number of seconds to hold the lock before releasing it to become accessible to other task invokes that need it. If not provided, the default set by the app will be used. It cannot be more than 180.",
+          "type": "integer"
+        }
+      },
+      "additionalProperties": false
+    },
     "ResultsSchema": {
       "id": "/ResultsSchema",
       "description": "An array of objects suitable for returning in perform calls.",
@@ -695,6 +721,10 @@
               "value": "**yes** (with exceptions, see description)"
             }
           }
+        },
+        "lock": {
+          "description": "**INTERNAL USE ONLY**. Zapier uses this configuration for internal operation locking.",
+          "$ref": "/LockObjectSchema"
         }
       },
       "additionalProperties": false
@@ -908,6 +938,10 @@
               "value": "**yes** (with exceptions, see description)"
             }
           }
+        },
+        "lock": {
+          "description": "**INTERNAL USE ONLY**. Zapier uses this configuration for internal operation locking.",
+          "$ref": "/LockObjectSchema"
         }
       },
       "additionalProperties": false
@@ -1268,6 +1302,10 @@
             }
           }
         },
+        "lock": {
+          "description": "**INTERNAL USE ONLY**. Zapier uses this configuration for internal operation locking.",
+          "$ref": "/LockObjectSchema"
+        },
         "shouldLock": {
           "description": "Should this action be performed one at a time (avoid concurrency)?",
           "type": "boolean"

package/lib/schemas/BasicActionOperationSchema.js

@@ -33,6 +33,7 @@ BasicActionOperationSchema.properties = {
   inputFields: BasicActionOperationSchema.properties.inputFields,
   outputFields: BasicActionOperationSchema.properties.outputFields,
   sample: BasicActionOperationSchema.properties.sample,
+  lock: BasicActionOperationSchema.properties.lock,
 };
 
 BasicActionOperationSchema.examples = [

package/lib/schemas/BasicOperationSchema.js

@@ -8,6 +8,7 @@ const FunctionSchema = require('./FunctionSchema');
 const RequestSchema = require('./RequestSchema');
 const ResultsSchema = require('./ResultsSchema');
 const KeySchema = require('./KeySchema');
+const LockObjectSchema = require('./LockObjectSchema');
 
 module.exports = makeSchema(
   {
@@ -50,6 +51,11 @@ module.exports = makeSchema(
           },
         },
       },
+      lock: {
+        description:
+          '**INTERNAL USE ONLY**. Zapier uses this configuration for internal operation locking.',
+        $ref: LockObjectSchema.id,
+      },
     },
     examples: [
       {
@@ -69,5 +75,5 @@ module.exports = makeSchema(
     ],
     additionalProperties: false,
   },
-  [DynamicFieldsSchema, FunctionSchema, KeySchema, RequestSchema, ResultsSchema]
+  [DynamicFieldsSchema, FunctionSchema, KeySchema, LockObjectSchema, RequestSchema, ResultsSchema]
 );

package/lib/schemas/FieldSchema.js

@@ -112,7 +112,7 @@ module.exports = makeSchema(
       },
       computed: {
         description:
-          'Is this field automatically populated (and hidden from the user)?',
+          'Is this field automatically populated (and hidden from the user)? Note: Only OAuth and Session Auth support fields with this key.',
         type: 'boolean',
       },
       altersDynamicFields: {

package/lib/schemas/LockObjectSchema.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const makeSchema = require('../utils/makeSchema');
+
+module.exports = makeSchema({
+  id: '/LockObjectSchema',
+  description:
+    '**INTERNAL USE ONLY**. Zapier uses this configuration for internal operation locking.',
+  type: 'object',
+  required: ['key'],
+  properties: {
+    key: {
+      description:
+        'The key to use for locking. This should be unique to the operation. While actions of different integrations with the same key and scope will never lock each other out, actions of the same integration with the same key and scope will do. User data provided for the input fields can be used in the key with the use of the curly braces referencing. For example, to access the user data provided for the input field "test_field", use `{{bundle.inputData.test_field}}`. Note that a required input field should be referenced to get user data always.',
+      type: 'string',
+      minLength: 1,
+    },
+    scope: {
+      description: `By default, locks are scoped to the app. That is, all users of the app will share the same locks. If you want to restrict serial access to a specific user, auth, or account, you can set the scope to one or more of the following: 'user' - Locks based on user ids.  'auth' - Locks based on unique auth ids. 'account' - Locks for all users under a single account. You may also combine scopes. Note that "app" is included, always, in the scope provided. For example, a scope of ['account', 'auth'] would result to ['app', 'account', 'auth'].`,
+      type: 'array',
+      items: {
+        enum: ['user', 'auth', 'account'],
+        type: 'string',
+      },
+    },
+    timeout: {
+      description:
+        'The number of seconds to hold the lock before releasing it to become accessible to other task invokes that need it. If not provided, the default set by the app will be used. It cannot be more than 180.',
+      type: 'integer',
+    },
+  },
+  examples: [
+    {
+      key: 'random_key',
+      scope: ['account', 'user'],
+      timeout: 30,
+    },
+    {
+      key: '{{bundle.inputData.test_field}}',
+    },
+  ],
+  antiExamples: [
+    {
+      example: {
+        key: 'random_key',
+        scope: ['zap'],
+      },
+      reason: 'Invalid scope provided: `zap`.',
+    },
+    {
+      example: {},
+      reason: 'Missing required key: `key`.',
+    },
+  ],
+  additionalProperties: false,
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-schema",
-  "version": "15.0.1",
+  "version": "15.2.0",
   "description": "Schema definition for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",