zapier-platform-schema 15.18.0 → 15.19.0

package/exported-schema.json

@@ -1,5 +1,5 @@
 {
-  "version": "15.18.0",
+  "version": "15.19.0",
   "schemas": {
     "AppSchema": {
       "id": "/AppSchema",
@@ -149,6 +149,27 @@
         }
       ]
     },
+    "FieldMetaSchema": {
+      "id": "/FieldMetaSchema",
+      "type": "object",
+      "description": "Allows for additional metadata to be stored on the field.",
+      "patternProperties": {
+        "[^\\s]+": {
+          "description": "Only string, integer or boolean values are allowed.",
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "integer"
+            },
+            {
+              "type": "boolean"
+            }
+          ]
+        }
+      }
+    },
     "FieldSchema": {
       "id": "/FieldSchema",
       "description": "Defines a field an app either needs as input, or gives as output. 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`",
@@ -249,6 +270,10 @@
           "description": "Useful when you expect the input to be part of a longer string. Put \"{{input}}\" in place of the user's input (IE: \"https://{{input}}.yourdomain.com\").",
           "type": "string",
           "pattern": "^.*{{input}}.*$"
+        },
+        "meta": {
+          "description": "Allows for additional metadata to be stored on the field. Supports simple key-values only (no sub-objects or arrays).",
+          "$ref": "/FieldMetaSchema"
         }
       },
       "additionalProperties": false

package/lib/schemas/FieldMetaSchema.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const makeSchema = require('../utils/makeSchema');
+
+module.exports = makeSchema({
+  id: '/FieldMetaSchema',
+  type: 'object',
+  description: 'Allows for additional metadata to be stored on the field.',
+  patternProperties: {
+    '[^\\s]+': {
+      description: 'Only string, integer or boolean values are allowed.',
+      anyOf: [{ type: 'string' }, { type: 'integer' }, { type: 'boolean' }],
+    },
+  },
+  examples: [
+    { shouldCapitalize: true },
+    { shouldCapitalize: true, internalType: 'datetime' },
+  ],
+  antiExamples: [
+    {
+      example: { databank: { primaryContact: 'abc' } },
+      reason: 'No complex values allowed',
+    },
+    {
+      example: { needsProcessing: null },
+      reason: 'No null values allowed',
+    },
+  ],
+});

package/lib/schemas/FieldSchema.js

@@ -6,6 +6,8 @@ const RefResourceSchema = require('./RefResourceSchema');
 
 const FieldChoicesSchema = require('./FieldChoicesSchema');
 
+const FieldMetaSchema = require('./FieldMetaSchema');
+
 const { INCOMPATIBLE_FIELD_SCHEMA_KEYS } = require('../constants');
 
 // the following takes an array of string arrays (string[][]) and returns the follwing string:
@@ -137,6 +139,11 @@ module.exports = makeSchema(
         // TODO: Check if it contains one and ONLY ONE '{{input}}'
         pattern: '^.*{{input}}.*$',
       },
+      meta: {
+        description:
+          'Allows for additional metadata to be stored on the field. Supports simple key-values only (no sub-objects or arrays).',
+        $ref: FieldMetaSchema.id,
+      },
     },
     examples: [
       { key: 'abc' },
@@ -148,6 +155,15 @@ module.exports = makeSchema(
       },
       { key: 'abc', children: [{ key: 'abc' }] },
       { key: 'abc', type: 'integer', helpText: 'neat' },
+      {
+        key: 'abc',
+        type: 'integer',
+        meta: {
+          internalType: 'numeric',
+          should_call_api: true,
+          display_order: 1,
+        },
+      },
     ],
     antiExamples: [
       {
@@ -190,5 +206,5 @@ module.exports = makeSchema(
     ],
     additionalProperties: false,
   },
-  [RefResourceSchema, FieldChoicesSchema]
+  [RefResourceSchema, FieldChoicesSchema, FieldMetaSchema]
 );

package/package.json

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