zapier-platform-schema 18.2.2 → 18.3.0

package/exported-schema.json

@@ -1,5 +1,5 @@
 {
-  "version": "18.2.2",
+  "version": "18.3.0",
   "schemas": {
     "AppSchema": {
       "id": "/AppSchema",
@@ -650,6 +650,26 @@
       "type": "string",
       "pattern": "^[a-zA-Z0-9_]+\\.[a-zA-Z0-9_\\s\\[\\]]+(\\.[a-zA-Z0-9_\\s\\[\\]]+(,[a-zA-Z0-9_\\s\\[\\]]+)*)?$"
     },
+    "FieldDynamicChoicesSchema": {
+      "id": "/FieldDynamicChoicesSchema",
+      "description": "Describes dynamic dropdowns powered by a perform function or request.",
+      "type": "object",
+      "required": ["perform"],
+      "properties": {
+        "perform": {
+          "description": "A function or request that returns choices for this dynamic dropdown.",
+          "oneOf": [
+            {
+              "$ref": "/FunctionSchema"
+            },
+            {
+              "$ref": "/RequestSchema"
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
     "FieldMetaSchema": {
       "id": "/FieldMetaSchema",
       "type": "object",
@@ -749,9 +769,29 @@
           "description": "A reference to a trigger that will power a dynamic dropdown.",
           "$ref": "/RefResourceSchema"
         },
+        "dependsOn": {
+          "description": "Specifies which other input fields this field depends on. These must be filled before this one becomes enabled, and when their values change, this field's value should be cleared.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "resource": {
+          "description": "Explicitly links this input field to a resource. Use the resource key (e.g., \"spreadsheet\") or dot notation for resource fields (e.g., \"spreadsheet.url\"). If not set for dynamic dropdowns, the resource is derived implicitly from the `dynamic` property.",
+          "type": "string",
+          "minLength": 1,
+          "pattern": "^[a-zA-Z0-9_]+(\\.[a-zA-Z0-9_]+)?$"
+        },
         "choices": {
-          "description": "An object of machine keys and human values to populate a static dropdown.",
-          "$ref": "/FieldChoicesSchema"
+          "description": "Describes how to populate this dropdown. Can be a static list or a dynamic object with pagination and search support.",
+          "oneOf": [
+            {
+              "$ref": "/FieldChoicesSchema"
+            },
+            {
+              "$ref": "/FieldDynamicChoicesSchema"
+            }
+          ]
         },
         "placeholder": {
           "description": "An example value that is not saved.",

package/lib/schemas/FieldDynamicChoicesSchema.js

@@ -0,0 +1,54 @@
+'use strict';
+
+const makeSchema = require('../utils/makeSchema');
+
+const FunctionSchema = require('./FunctionSchema');
+const RequestSchema = require('./RequestSchema');
+
+module.exports = makeSchema(
+  {
+    id: '/FieldDynamicChoicesSchema',
+    description:
+      'Describes dynamic dropdowns powered by a perform function or request.',
+    type: 'object',
+    required: ['perform'],
+    properties: {
+      perform: {
+        description:
+          'A function or request that returns choices for this dynamic dropdown.',
+        oneOf: [{ $ref: FunctionSchema.id }, { $ref: RequestSchema.id }],
+      },
+    },
+    additionalProperties: false,
+    examples: [
+      { perform: '$func$0$f$' },
+      { perform: { source: 'return []' } },
+      {
+        perform: {
+          method: 'GET',
+          url: 'https://api.example.com/choices',
+        },
+      },
+    ],
+    antiExamples: [
+      {
+        example: {},
+        reason: 'Missing required key: perform',
+      },
+      {
+        example: { someKey: 'value' },
+        reason: 'Missing required key: perform',
+      },
+      {
+        example: { perform: 'invalid' },
+        reason:
+          'Invalid value for key: perform (must be a function or request)',
+      },
+      {
+        example: { perform: '$func$0$f$', unknownKey: 'value' },
+        reason: 'Invalid extra property: unknownKey',
+      },
+    ],
+  },
+  [FunctionSchema, RequestSchema],
+);

package/lib/schemas/PlainInputFieldSchema.js

@@ -3,6 +3,7 @@
 const makeSchema = require('../utils/makeSchema');
 const RefResourceSchema = require('./RefResourceSchema');
 const FieldChoicesSchema = require('./FieldChoicesSchema');
+const FieldDynamicChoicesSchema = require('./FieldDynamicChoicesSchema');
 const PlainFieldSchema = require('./PlainFieldSchema');
 const FieldMetaSchema = require('./FieldMetaSchema');
 const KeySchema = require('./KeySchema');
@@ -39,10 +40,26 @@ module.exports = makeSchema(
           'A reference to a trigger that will power a dynamic dropdown.',
         $ref: RefResourceSchema.id,
       },
+      dependsOn: {
+        description:
+          "Specifies which other input fields this field depends on. These must be filled before this one becomes enabled, and when their values change, this field's value should be cleared.",
+        type: 'array',
+        items: { type: 'string' },
+      },
+      resource: {
+        description:
+          'Explicitly links this input field to a resource. Use the resource key (e.g., "spreadsheet") or dot notation for resource fields (e.g., "spreadsheet.url"). If not set for dynamic dropdowns, the resource is derived implicitly from the `dynamic` property.',
+        type: 'string',
+        minLength: 1,
+        pattern: '^[a-zA-Z0-9_]+(\\.[a-zA-Z0-9_]+)?$',
+      },
       choices: {
         description:
-          'An object of machine keys and human values to populate a static dropdown.',
-        $ref: FieldChoicesSchema.id,
+          'Describes how to populate this dropdown. Can be a static list or a dynamic object with pagination and search support.',
+        oneOf: [
+          { $ref: FieldChoicesSchema.id },
+          { $ref: FieldDynamicChoicesSchema.id },
+        ],
       },
       placeholder: {
         description: 'An example value that is not saved.',
@@ -85,6 +102,10 @@ module.exports = makeSchema(
         key: 'abc',
         choices: [{ label: 'Red', sample: '#f00', value: '#f00' }],
       },
+      {
+        key: 'abc',
+        choices: { perform: '$func$0$f$' },
+      },
       { key: 'abc', children: [{ key: 'abc' }] },
       { key: 'abc', type: 'integer' },
       {
@@ -104,6 +125,19 @@ module.exports = makeSchema(
         key: 'email',
         group: 'contact',
       },
+      {
+        key: 'spreadsheet',
+        dependsOn: ['folder'],
+      },
+      {
+        key: 'worksheet',
+        dependsOn: ['folder', 'spreadsheet'],
+      },
+      {
+        key: 'spreadsheet_id',
+        resource: 'spreadsheet',
+        choices: { perform: '$func$0$f$' },
+      },
     ],
     antiExamples: [
       {
@@ -149,6 +183,7 @@ module.exports = makeSchema(
   [
     RefResourceSchema,
     FieldChoicesSchema,
+    FieldDynamicChoicesSchema,
     FieldMetaSchema,
     PlainFieldSchema,
     KeySchema,

package/lib/utils/makeValidator.js

@@ -32,7 +32,8 @@ const makePath = (path, newSegment) =>
 const processBaseError = (err, path) => {
   const completePath = makePath(path, err.property)
     .replace(/\.instance\.?/g, '.')
-    .replace(/\.instance$/, '');
+    .replace(/\.instance$/, '')
+    .replace(/\.$/, ''); // Remove any trailing dots
 
   const subSchemas = err.message.match(/\[subschema \d+\]/g);
   if (subSchemas) {

package/package.json

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