zapier-platform-schema 17.7.0 → 17.7.2

package/exported-schema.json

@@ -1,5 +1,5 @@
 {
-  "version": "17.7.0",
+  "version": "17.7.2",
   "schemas": {
     "AppSchema": {
       "id": "/AppSchema",
@@ -782,6 +782,28 @@
       },
       "additionalProperties": false
     },
+    "InputFieldGroupSchema": {
+      "id": "/InputFieldGroupSchema",
+      "description": "Object for visual grouping of input fields.",
+      "type": "object",
+      "required": ["key"],
+      "properties": {
+        "key": {
+          "description": "The unique identifier for this group.",
+          "$ref": "/KeySchema"
+        },
+        "label": {
+          "description": "The human-readable name for the group.",
+          "type": "string",
+          "minLength": 1
+        },
+        "emphasize": {
+          "description": "Whether this group should be visually emphasized in the UI.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
     "PlainOutputFieldSchema": {
       "description": "Field schema specialized for output fields. In addition to the requirements below, the following keys are mutually exclusive:\n\n* `children` & `list`\n* `children` & `dict`\n* `children` & `type`\n* `children` & `placeholder`\n* `children` & `helpText`\n* `children` & `default`\n* `dict` & `list`\n* `dynamic` & `dict`\n* `dynamic` & `choices`",
       "id": "/PlainOutputFieldSchema",
@@ -893,23 +915,7 @@
       "description": "An array or collection of input field groups.",
       "type": "array",
       "items": {
-        "type": "object",
-        "required": ["key"],
-        "properties": {
-          "key": {
-            "description": "The unique identifier for this group.",
-            "$ref": "/KeySchema"
-          },
-          "label": {
-            "description": "The human-readable name for the group.",
-            "type": "string",
-            "minLength": 1
-          },
-          "emphasize": {
-            "description": "Whether this group should be visually emphasized in the UI.",
-            "type": "boolean"
-          }
-        }
+        "$ref": "/InputFieldGroupSchema"
       },
       "additionalProperties": false
     },
@@ -1103,6 +1109,10 @@
         "throttle": {
           "description": "Zapier uses this configuration to apply throttling when the limit for the window is exceeded.",
           "$ref": "/ThrottleObjectSchema"
+        },
+        "skipCleanArrayInputData": {
+          "description": "(Experimental) Should empty strings, `null`, `undefined`, and empty Arrays or objects be removed from `inputData`?",
+          "type": "boolean"
         }
       },
       "additionalProperties": false
@@ -1209,6 +1219,10 @@
               "value": "**yes** (with exceptions, see description)"
             }
           }
+        },
+        "skipCleanArrayInputData": {
+          "description": "(Experimental) Should empty strings, `null`, `undefined`, and empty Arrays or objects be removed from `inputData`?",
+          "type": "boolean"
         }
       },
       "additionalProperties": false
@@ -1270,6 +1284,10 @@
         "throttle": {
           "description": "Zapier uses this configuration to apply throttling when the limit for the window is exceeded.",
           "$ref": "/ThrottleObjectSchema"
+        },
+        "skipCleanArrayInputData": {
+          "description": "(Experimental) Should empty strings, `null`, `undefined`, and empty Arrays or objects be removed from `inputData`?",
+          "type": "boolean"
         }
       },
       "additionalProperties": false
@@ -1340,6 +1358,10 @@
         "throttle": {
           "description": "Zapier uses this configuration to apply throttling when the limit for the window is exceeded.",
           "$ref": "/ThrottleObjectSchema"
+        },
+        "skipCleanArrayInputData": {
+          "description": "(Experimental) Should empty strings, `null`, `undefined`, and empty Arrays or objects be removed from `inputData`?",
+          "type": "boolean"
         }
       },
       "additionalProperties": false
@@ -1579,6 +1601,10 @@
             }
           }
         },
+        "skipCleanArrayInputData": {
+          "description": "(Experimental) Should empty strings, `null`, `undefined`, and empty Arrays or objects be removed from `inputData`?",
+          "type": "boolean"
+        },
         "maxPollingDelay": {
           "description": "The maximum amount of time to wait between polling requests in seconds. Minimum value is 20s and will default to 20 if not set, or set to a lower value.",
           "type": "integer"
@@ -1696,6 +1722,10 @@
         "throttle": {
           "description": "Zapier uses this configuration to apply throttling when the limit for the window is exceeded.",
           "$ref": "/ThrottleObjectSchema"
+        },
+        "skipCleanArrayInputData": {
+          "description": "(Experimental) Should empty strings, `null`, `undefined`, and empty Arrays or objects be removed from `inputData`?",
+          "type": "boolean"
         }
       },
       "additionalProperties": false
@@ -1817,6 +1847,10 @@
           "description": "Zapier uses this configuration to apply throttling when the limit for the window is exceeded.",
           "$ref": "/ThrottleObjectSchema"
         },
+        "skipCleanArrayInputData": {
+          "description": "(Experimental) Should empty strings, `null`, `undefined`, and empty Arrays or objects be removed from `inputData`?",
+          "type": "boolean"
+        },
         "buffer": {
           "description": "Currently an **internal-only** feature. Zapier uses this configuration for creating objects in bulk with `performBuffer`.",
           "$ref": "/BufferConfigSchema",
@@ -2051,9 +2085,11 @@
     },
     "VersionSchema": {
       "id": "/VersionSchema",
-      "description": "Represents a simplified semver string, from `0.0.0` to `999.999.999`.",
+      "description": "Represents a simplified semver string, from `0.0.0` to `999.999.999` with optional simplified label. They need to be case-insensitive unique.",
       "type": "string",
-      "pattern": "^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}$"
+      "pattern": "^(?:0|[1-9]\\d{0,2})\\.(?:0|[1-9]\\d{0,2})\\.(?:0|[1-9]\\d{0,2})(?:-(?=.{1,12}$)[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*)?$",
+      "minLength": 5,
+      "maxLength": 24
     },
     "MiddlewaresSchema": {
       "id": "/MiddlewaresSchema",

package/lib/schemas/BasicActionOperationSchema.js

@@ -36,6 +36,8 @@ BasicActionOperationSchema.properties = {
   sample: BasicActionOperationSchema.properties.sample,
   lock: BasicActionOperationSchema.properties.lock,
   throttle: BasicActionOperationSchema.properties.throttle,
+  skipCleanArrayInputData:
+    BasicActionOperationSchema.properties.skipCleanArrayInputData,
 };
 
 BasicActionOperationSchema.examples = [

package/lib/schemas/BasicHookOperationSchema.js

@@ -84,6 +84,8 @@ BasicHookOperationSchema.properties = {
   inputFieldGroups: BasicHookOperationSchema.properties.inputFieldGroups,
   outputFields: BasicHookOperationSchema.properties.outputFields,
   sample: BasicHookOperationSchema.properties.sample,
+  skipCleanArrayInputData:
+    BasicHookOperationSchema.properties.skipCleanArrayInputData,
 };
 
 BasicHookOperationSchema.examples = [

package/lib/schemas/BasicHookToPollOperationSchema.js

@@ -62,6 +62,8 @@ BasicHookToPollOperationSchema.properties = {
   inputFieldGroups: BasicHookToPollOperationSchema.properties.inputFieldGroups,
   outputFields: BasicHookToPollOperationSchema.properties.outputFields,
   sample: BasicHookToPollOperationSchema.properties.sample,
+  skipCleanArrayInputData:
+    BasicHookToPollOperationSchema.properties.skipCleanArrayInputData,
   maxPollingDelay: {
     description:
       'The maximum amount of time to wait between polling requests in seconds. Minimum value is 20s and will default to 20 if not set, or set to a lower value.',

package/lib/schemas/BasicOperationSchema.js

@@ -69,6 +69,11 @@ module.exports = makeSchema(
           'Zapier uses this configuration to apply throttling when the limit for the window is exceeded.',
         $ref: ThrottleObjectSchema.id,
       },
+      skipCleanArrayInputData: {
+        description:
+          '(Experimental) Should empty strings, `null`, `undefined`, and empty Arrays or objects be removed from `inputData`?',
+        type: 'boolean',
+      },
     },
     examples: [
       {

package/lib/schemas/BasicPollingOperationSchema.js

@@ -35,6 +35,8 @@ BasicPollingOperationSchema.properties = {
   outputFields: BasicPollingOperationSchema.properties.outputFields,
   sample: BasicPollingOperationSchema.properties.sample,
   throttle: BasicPollingOperationSchema.properties.throttle,
+  skipCleanArrayInputData:
+    BasicPollingOperationSchema.properties.skipCleanArrayInputData,
 };
 
 module.exports = makeSchema(

package/lib/schemas/BasicSearchOperationSchema.js

@@ -40,6 +40,8 @@ BasicSearchOperationSchema.properties = {
   sample: BasicSearchOperationSchema.properties.sample,
   lock: BasicSearchOperationSchema.properties.lock,
   throttle: BasicSearchOperationSchema.properties.throttle,
+  skipCleanArrayInputData:
+    BasicSearchOperationSchema.properties.skipCleanArrayInputData,
 };
 
 BasicSearchOperationSchema.examples = [

package/lib/schemas/InputFieldGroupSchema.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const makeSchema = require('../utils/makeSchema');
+
+const KeySchema = require('./KeySchema');
+
+module.exports = makeSchema(
+  {
+    id: '/InputFieldGroupSchema',
+    description: 'Object for visual grouping of input fields.',
+    type: 'object',
+    required: ['key'],
+    properties: {
+      key: {
+        description: 'The unique identifier for this group.',
+        $ref: KeySchema.id,
+      },
+      label: {
+        description: 'The human-readable name for the group.',
+        type: 'string',
+        minLength: 1,
+      },
+      emphasize: {
+        description:
+          'Whether this group should be visually emphasized in the UI.',
+        type: 'boolean',
+      },
+    },
+    examples: [
+      { key: 'testGroup' },
+      { key: 'testGroup', label: 'Test Group', emphasize: true },
+    ],
+    antiExamples: [
+      { example: { label: 'test label' }, reason: 'key is required' },
+    ],
+    additionalProperties: false,
+  },
+  [KeySchema],
+);

package/lib/schemas/InputFieldGroupsSchema.js

@@ -2,7 +2,7 @@
 
 const makeSchema = require('../utils/makeSchema');
 
-const KeySchema = require('./KeySchema');
+const InputFieldGroupSchema = require('./InputFieldGroupSchema');
 
 module.exports = makeSchema(
   {
@@ -10,24 +10,7 @@ module.exports = makeSchema(
     description: 'An array or collection of input field groups.',
     type: 'array',
     items: {
-      type: 'object',
-      required: ['key'],
-      properties: {
-        key: {
-          description: 'The unique identifier for this group.',
-          $ref: KeySchema.id,
-        },
-        label: {
-          description: 'The human-readable name for the group.',
-          type: 'string',
-          minLength: 1,
-        },
-        emphasize: {
-          description:
-            'Whether this group should be visually emphasized in the UI.',
-          type: 'boolean',
-        },
-      },
+      $ref: InputFieldGroupSchema.id,
     },
     examples: [[{ key: 'abc' }]],
     antiExamples: [
@@ -36,5 +19,5 @@ module.exports = makeSchema(
     ],
     additionalProperties: false,
   },
-  [KeySchema],
+  [InputFieldGroupSchema],
 );

package/lib/schemas/VersionSchema.js

@@ -5,14 +5,25 @@ const makeSchema = require('../utils/makeSchema');
 module.exports = makeSchema({
   id: '/VersionSchema',
   description:
-    'Represents a simplified semver string, from `0.0.0` to `999.999.999`.',
+    'Represents a simplified semver string, from `0.0.0` to `999.999.999` with optional simplified label. They need to be case-insensitive unique.',
   type: 'string',
-  pattern: '^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}$',
-  examples: ['1.0.0', '2.11.3', '999.999.999'],
+  pattern:
+    // this is mirrored in ZapierBaseCommand.js and developer_cli/constants.py
+    '^(?:0|[1-9]\\d{0,2})\\.(?:0|[1-9]\\d{0,2})\\.(?:0|[1-9]\\d{0,2})(?:-(?=.{1,12}$)[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*)?$',
+  minLength: 5,
+  maxLength: 24,
+  examples: ['1.0.0', '2.11.3', '999.999.999', '1.2.0-beta', '0.0.0-ISSUE-123'],
   antiExamples: [
-    { example: '1.0.0.0', reason: 'Must have only 2 periods' },
+    { example: '1.0.0.0', reason: 'Must have 2 periods' },
     { example: '1000.0.0', reason: 'Each number can be a maximum of 3 digits' },
-    { example: 'v1.0.0', reason: 'No letters allowed' },
-    { example: '1.0.0-beta', reson: 'No letters allowed' },
+    { example: 'v1.0.0', reason: 'No letter prefix allowed' },
+    { example: '1.0.0-rc.1', reason: 'No periods allowed in label' },
+    { example: '1.0.0--', reason: 'No repeated dashes allowed' },
+    {
+      example: '1.0.0-foo--bar',
+      reason: 'No repeated dashes allowed in label',
+    },
+    { example: '1.0.0-', reason: 'No empty label allowed' },
+    { example: '1.0.0-foo-', reason: 'No trailing dash allowed in label' },
   ],
 });

package/package.json

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