@tinacms/schema-tools 1.4.7 → 1.4.8

package/dist/index.es.js

@@ -146,13 +146,16 @@ const parseURL = (url) => {
   }
   const pattern = new UrlPattern("/:v/content/:clientId/github/*", {
     escapeChar: " ",
+    // extend to allow `.` in version
     segmentValueCharset: "a-zA-Z0-9-_~ %."
   });
   const result = pattern.match(params.pathname);
   const branch = result == null ? void 0 : result._;
   const clientId = result == null ? void 0 : result.clientId;
   if (!branch || !clientId) {
-    throw new Error(`Invalid URL format provided. Expected: https://content.tinajs.io/<Version>/content/<ClientID>/github/<Branch> but but received ${url}`);
+    throw new Error(
+      `Invalid URL format provided. Expected: https://content.tinajs.io/<Version>/content/<ClientID>/github/<Branch> but but received ${url}`
+    );
   }
   return {
     host: params.host,
@@ -163,6 +166,9 @@ const parseURL = (url) => {
 };
 const normalizePath = (filepath) => filepath.replace(/\\/g, "/");
 class TinaSchema {
+  /**
+   * Create a schema class from a user defined schema object
+   */
   constructor(config) {
     this.config = config;
     this.getIsTitleFieldName = (collection) => {
@@ -172,10 +178,14 @@ class TinaSchema {
       return field == null ? void 0 : field.name;
     };
     this.getCollectionsByName = (collectionNames) => {
-      return this.schema.collections.filter((collection) => collectionNames.includes(collection.name));
+      return this.schema.collections.filter(
+        (collection) => collectionNames.includes(collection.name)
+      );
     };
     this.getCollection = (collectionName) => {
-      const collection = this.schema.collections.find((collection2) => collection2.name === collectionName);
+      const collection = this.schema.collections.find(
+        (collection2) => collection2.name === collectionName
+      );
       if (!collection) {
         throw new Error(`Expected to find collection named ${collectionName}`);
       }
@@ -190,6 +200,7 @@ class TinaSchema {
           break;
       }
       return {
+        // @ts-ignore FIXME: backwards compatibility, using `slug` should probably be deprecated
         slug: collection.name,
         ...extraFields,
         ...collection,
@@ -197,7 +208,9 @@ class TinaSchema {
       };
     };
     this.getCollections = () => {
-      return this.schema.collections.map((collection) => this.getCollection(collection.name)) || [];
+      return this.schema.collections.map(
+        (collection) => this.getCollection(collection.name)
+      ) || [];
     };
     this.getCollectionByFullPath = (filepath) => {
       const fileExtension = filepath.split(".").pop();
@@ -238,19 +251,27 @@ class TinaSchema {
       const templates = this.getTemplatesForCollectable(collection);
       if (templates.type === "union") {
         if (templateName) {
-          template = templates.templates.find((template2) => lastItem(template2.namespace) === templateName);
+          template = templates.templates.find(
+            (template2) => lastItem(template2.namespace) === templateName
+          );
           if (!template) {
-            throw new Error(`Unable to determine template for item at ${filepath}`);
+            throw new Error(
+              `Unable to determine template for item at ${filepath}`
+            );
           }
         } else {
-          throw new Error(`Unable to determine template for item at ${filepath}, no template name provided for collection with multiple templates`);
+          throw new Error(
+            `Unable to determine template for item at ${filepath}, no template name provided for collection with multiple templates`
+          );
         }
       }
       if (templates.type === "object") {
         template = templates.template;
       }
       if (!template) {
-        throw new Error(`Something went wrong while trying to determine template for ${filepath}`);
+        throw new Error(
+          `Something went wrong while trying to determine template for ${filepath}`
+        );
       }
       return { collection, template };
     };
@@ -263,10 +284,17 @@ class TinaSchema {
         case "object":
           return templateInfo.template;
         case "union":
-          assertShape(data, (yup2) => yup2.object({ _template: yup2.string().required() }));
-          const template = templateInfo.templates.find((template2) => template2.namespace[template2.namespace.length - 1] === data._template);
+          assertShape(
+            data,
+            (yup2) => yup2.object({ _template: yup2.string().required() })
+          );
+          const template = templateInfo.templates.find(
+            (template2) => template2.namespace[template2.namespace.length - 1] === data._template
+          );
           if (!template) {
-            throw new Error(`Expected to find template named '${data._template}' for collection '${lastItem(collection.namespace)}'`);
+            throw new Error(
+              `Expected to find template named '${data._template}' for collection '${lastItem(collection.namespace)}'`
+            );
           }
           return template;
       }
@@ -320,7 +348,10 @@ class TinaSchema {
       if (field.type === "object")
         if (field.templates) {
           if (field.list) {
-            assertShape(value, (yup2) => yup2.array(yup2.object({ _template: yup2.string().required() })));
+            assertShape(
+              value,
+              (yup2) => yup2.array(yup2.object({ _template: yup2.string().required() }))
+            );
             return value.map((item) => {
               const { _template, ...rest } = item;
               const template = field.templates.find((template2) => {
@@ -337,7 +368,10 @@ class TinaSchema {
               };
             });
           } else {
-            assertShape(value, (yup2) => yup2.object({ _template: yup2.string().required() }));
+            assertShape(
+              value,
+              (yup2) => yup2.object({ _template: yup2.string().required() })
+            );
             const { _template, ...rest } = value;
             return { [_template]: this.transformCollectablePayload(rest, field) };
           }
@@ -368,7 +402,7 @@ class TinaSchema {
       return false;
     };
     this.getTemplatesForCollectable = (collection) => {
-      let extraFields = [];
+      const extraFields = [];
       if (collection == null ? void 0 : collection.fields) {
         const template = collection;
         if (typeof template.fields === "string" || typeof template.fields === "undefined") {
@@ -396,7 +430,11 @@ class TinaSchema {
             })
           };
         } else {
-          throw new Error(`Expected either fields or templates array to be defined on collection ${collection.namespace.join("_")}`);
+          throw new Error(
+            `Expected either fields or templates array to be defined on collection ${collection.namespace.join(
+              "_"
+            )}`
+          );
         }
       }
     };
@@ -442,6 +480,12 @@ class TinaSchema {
       }
     });
   }
+  /**
+   * This function returns an array of glob matches for a given collection.
+   *
+   * @param collection The collection to get the matches for. Can be a string or a collection object.
+   * @returns An array of glob matches.
+   */
   getMatches({
     collection: collectionOrString
   }) {
@@ -536,6 +580,7 @@ const resolveField = (field, schema) => {
       }
       if (field.list) {
         return {
+          // Allows component to be overridden for scalars
           component: "list",
           field: {
             component: "text"
@@ -545,6 +590,7 @@ const resolveField = (field, schema) => {
         };
       }
       return {
+        // Allows component to be overridden for scalars
         component: "text",
         ...field,
         ...extraFields
@@ -555,7 +601,9 @@ const resolveField = (field, schema) => {
         return {
           ...field,
           component: field.list ? "group-list" : "group",
-          fields: templateInfo.template.fields.map((field2) => resolveField(field2, schema)),
+          fields: templateInfo.template.fields.map(
+            (field2) => resolveField(field2, schema)
+          ),
           ...extraFields
         };
       } else if (templateInfo.type === "union") {
@@ -646,7 +694,9 @@ const parseZodError = ({ zodError }) => {
         moreInfo.push(parseZodError({ zodError: unionError }));
       });
     }
-    const errorMessage = `Error ${issue == null ? void 0 : issue.message} at path ${issue.path.join(".")}`;
+    const errorMessage = `Error ${issue == null ? void 0 : issue.message} at path ${issue.path.join(
+      "."
+    )}`;
     const errorMessages = [errorMessage, ...moreInfo];
     return {
       errors: errorMessages
@@ -692,18 +742,23 @@ const TypeName = [
   "rich-text"
 ];
 const typeTypeError = `type must be one of ${TypeName.join(", ")}`;
-const typeRequiredError = `type is required and must be one of ${TypeName.join(", ")}`;
-const Option = z.union([
-  z.string(),
-  z.object({ label: z.string(), value: z.string() }),
-  z.object({ icon: z.any(), value: z.string() })
-], {
-  errorMap: () => {
-    return {
-      message: "Invalid option array. Must be a string[] or {label: string, value: string}[] or {icon: React.ComponentType<any>, value: string}[]"
-    };
+const typeRequiredError = `type is required and must be one of ${TypeName.join(
+  ", "
+)}`;
+const Option = z.union(
+  [
+    z.string(),
+    z.object({ label: z.string(), value: z.string() }),
+    z.object({ icon: z.any(), value: z.string() })
+  ],
+  {
+    errorMap: () => {
+      return {
+        message: "Invalid option array. Must be a string[] or {label: string, value: string}[] or {icon: React.ComponentType<any>, value: string}[]"
+      };
+    }
   }
-});
+);
 const TinaField = z.object({
   name,
   label: z.string().or(z.boolean()).optional(),
@@ -773,6 +828,7 @@ const TinaFieldZod = z.lazy(() => {
     }
   });
   const ObjectField = FieldWithList.extend({
+    // needs to be redefined here to avoid circle deps
     type: z.literal("object", {
       invalid_type_error: typeTypeError,
       required_error: typeRequiredError
@@ -811,35 +867,43 @@ const TinaFieldZod = z.lazy(() => {
       }
     })
   });
-  return z.discriminatedUnion("type", [
-    StringField,
-    BooleanField,
-    NumberField,
-    ImageField,
-    DateTimeField,
-    ReferenceField,
-    ObjectField,
-    RichTextField
-  ], {
-    errorMap: (issue, ctx) => {
-      var _a;
-      if (issue.code === "invalid_union_discriminator") {
+  return z.discriminatedUnion(
+    "type",
+    [
+      StringField,
+      BooleanField,
+      NumberField,
+      ImageField,
+      DateTimeField,
+      ReferenceField,
+      ObjectField,
+      RichTextField
+    ],
+    {
+      errorMap: (issue, ctx) => {
+        var _a;
+        if (issue.code === "invalid_union_discriminator") {
+          return {
+            message: `Invalid \`type\` property. In the schema is 'type: ${(_a = ctx.data) == null ? void 0 : _a.type}' and expected one of ${TypeName.join(", ")}`
+          };
+        }
         return {
-          message: `Invalid \`type\` property. In the schema is 'type: ${(_a = ctx.data) == null ? void 0 : _a.type}' and expected one of ${TypeName.join(", ")}`
+          message: issue.message
         };
       }
-      return {
-        message: issue.message
-      };
     }
-  }).superRefine((val, ctx) => {
+  ).superRefine((val, ctx) => {
     if (val.type === "string") {
       if (val.isTitle) {
         if (val.list) {
           ctx.addIssue({
             code: z.ZodIssueCode.custom,
             message: `Can not have \`list: true\` when using \`isTitle\`. Error in value 
-${JSON.stringify(val, null, 2)}
+${JSON.stringify(
+              val,
+              null,
+              2
+            )}
 `
           });
         }
@@ -847,7 +911,11 @@ ${JSON.stringify(val, null, 2)}
           ctx.addIssue({
             code: z.ZodIssueCode.custom,
             message: `Must have { required: true } when using \`isTitle\` Error in value 
-${JSON.stringify(val, null, 2)}
+${JSON.stringify(
+              val,
+              null,
+              2
+            )}
 `
           });
         }
@@ -957,12 +1025,16 @@ const TinaCloudCollection = CollectionBaseSchema.extend({
         message: `Fields must have a unique name, duplicate field names: ${dups}`
       });
     }
-  }).refine((val) => {
-    const arr = (val == null ? void 0 : val.filter((x) => x.type === "string" && x.isTitle)) || [];
-    return arr.length < 2;
-  }, {
-    message: "Fields can only have one use of `isTitle`"
-  }),
+  }).refine(
+    // It is valid if it is 0 or 1
+    (val) => {
+      const arr = (val == null ? void 0 : val.filter((x) => x.type === "string" && x.isTitle)) || [];
+      return arr.length < 2;
+    },
+    {
+      message: "Fields can only have one use of `isTitle`"
+    }
+  ),
   templates: z.array(Template).min(1).optional().superRefine((val, ctx) => {
     const dups = findDuplicates(val == null ? void 0 : val.map((x) => x.name));
     if (dups) {
@@ -972,15 +1044,18 @@ const TinaCloudCollection = CollectionBaseSchema.extend({
       });
     }
   })
-}).refine((val) => {
-  let isValid = Boolean(val == null ? void 0 : val.templates) || Boolean(val == null ? void 0 : val.fields);
-  if (!isValid) {
-    return false;
-  } else {
-    isValid = !((val == null ? void 0 : val.templates) && (val == null ? void 0 : val.fields));
-    return isValid;
-  }
-}, { message: "Must provide one of templates or fields in your collection" });
+}).refine(
+  (val) => {
+    let isValid = Boolean(val == null ? void 0 : val.templates) || Boolean(val == null ? void 0 : val.fields);
+    if (!isValid) {
+      return false;
+    } else {
+      isValid = !((val == null ? void 0 : val.templates) && (val == null ? void 0 : val.fields));
+      return isValid;
+    }
+  },
+  { message: "Must provide one of templates or fields in your collection" }
+);
 const TinaCloudSchemaZod = z.object({
   collections: z.array(TinaCloudCollection),
   config: tinaConfigZod.optional()
@@ -1031,4 +1106,16 @@ const validateSchema = ({ schema }) => {
     }
   }
 };
-export { NAMER, TINA_HOST, TinaSchema, TinaSchemaValidationError, addNamespaceToSchema, normalizePath, parseURL, resolveField, resolveForm, validateSchema, validateTinaCloudSchemaConfig };
+export {
+  NAMER,
+  TINA_HOST,
+  TinaSchema,
+  TinaSchemaValidationError,
+  addNamespaceToSchema,
+  normalizePath,
+  parseURL,
+  resolveField,
+  resolveForm,
+  validateSchema,
+  validateTinaCloudSchemaConfig
+};

package/dist/index.js

@@ -2,33 +2,23 @@
   typeof exports === "object" && typeof module !== "undefined" ? factory(exports, require("micromatch"), require("yup"), require("url-pattern"), require("zod")) : typeof define === "function" && define.amd ? define(["exports", "micromatch", "yup", "url-pattern", "zod"], factory) : (global = typeof globalThis !== "undefined" ? globalThis : global || self, factory(global["@tinacms/schema-tools"] = {}, global.NOOP, global.NOOP, global.NOOP, global.NOOP));
 })(this, function(exports2, micromatch, yup, UrlPattern, z) {
   "use strict";
-  function _interopDefaultLegacy(e) {
-    return e && typeof e === "object" && "default" in e ? e : { "default": e };
-  }
-  function _interopNamespace(e) {
-    if (e && e.__esModule)
-      return e;
-    var n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
+  function _interopNamespaceDefault(e) {
+    const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
     if (e) {
-      Object.keys(e).forEach(function(k) {
+      for (const k in e) {
         if (k !== "default") {
-          var d = Object.getOwnPropertyDescriptor(e, k);
+          const d = Object.getOwnPropertyDescriptor(e, k);
           Object.defineProperty(n, k, d.get ? d : {
             enumerable: true,
-            get: function() {
-              return e[k];
-            }
+            get: () => e[k]
           });
         }
-      });
+      }
     }
-    n["default"] = e;
+    n.default = e;
     return Object.freeze(n);
   }
-  var micromatch__default = /* @__PURE__ */ _interopDefaultLegacy(micromatch);
-  var yup__namespace = /* @__PURE__ */ _interopNamespace(yup);
-  var UrlPattern__default = /* @__PURE__ */ _interopDefaultLegacy(UrlPattern);
-  var z__default = /* @__PURE__ */ _interopDefaultLegacy(z);
+  const yup__namespace = /* @__PURE__ */ _interopNamespaceDefault(yup);
   function addNamespaceToSchema(maybeNode, namespace = []) {
     if (typeof maybeNode === "string") {
       return maybeNode;
@@ -171,15 +161,18 @@
         host: params.host
       };
     }
-    const pattern = new UrlPattern__default["default"]("/:v/content/:clientId/github/*", {
+    const pattern = new UrlPattern("/:v/content/:clientId/github/*", {
       escapeChar: " ",
+      // extend to allow `.` in version
       segmentValueCharset: "a-zA-Z0-9-_~ %."
     });
     const result = pattern.match(params.pathname);
     const branch = result == null ? void 0 : result._;
     const clientId = result == null ? void 0 : result.clientId;
     if (!branch || !clientId) {
-      throw new Error(`Invalid URL format provided. Expected: https://content.tinajs.io/<Version>/content/<ClientID>/github/<Branch> but but received ${url}`);
+      throw new Error(
+        `Invalid URL format provided. Expected: https://content.tinajs.io/<Version>/content/<ClientID>/github/<Branch> but but received ${url}`
+      );
     }
     return {
       host: params.host,
@@ -190,6 +183,9 @@
   };
   const normalizePath = (filepath) => filepath.replace(/\\/g, "/");
   class TinaSchema {
+    /**
+     * Create a schema class from a user defined schema object
+     */
     constructor(config) {
       this.config = config;
       this.getIsTitleFieldName = (collection) => {
@@ -199,10 +195,14 @@
         return field == null ? void 0 : field.name;
       };
       this.getCollectionsByName = (collectionNames) => {
-        return this.schema.collections.filter((collection) => collectionNames.includes(collection.name));
+        return this.schema.collections.filter(
+          (collection) => collectionNames.includes(collection.name)
+        );
       };
       this.getCollection = (collectionName) => {
-        const collection = this.schema.collections.find((collection2) => collection2.name === collectionName);
+        const collection = this.schema.collections.find(
+          (collection2) => collection2.name === collectionName
+        );
         if (!collection) {
           throw new Error(`Expected to find collection named ${collectionName}`);
         }
@@ -217,6 +217,7 @@
             break;
         }
         return {
+          // @ts-ignore FIXME: backwards compatibility, using `slug` should probably be deprecated
           slug: collection.name,
           ...extraFields,
           ...collection,
@@ -224,7 +225,9 @@
         };
       };
       this.getCollections = () => {
-        return this.schema.collections.map((collection) => this.getCollection(collection.name)) || [];
+        return this.schema.collections.map(
+          (collection) => this.getCollection(collection.name)
+        ) || [];
       };
       this.getCollectionByFullPath = (filepath) => {
         const fileExtension = filepath.split(".").pop();
@@ -235,7 +238,7 @@
           }
           if (((_a = collection == null ? void 0 : collection.match) == null ? void 0 : _a.include) || ((_b = collection == null ? void 0 : collection.match) == null ? void 0 : _b.exclude)) {
             const matches = this.getMatches({ collection });
-            const match = micromatch__default["default"]([filepath], matches).length > 0;
+            const match = micromatch([filepath], matches).length > 0;
             if (!match) {
               return false;
             }
@@ -265,19 +268,27 @@
         const templates = this.getTemplatesForCollectable(collection);
         if (templates.type === "union") {
           if (templateName) {
-            template = templates.templates.find((template2) => lastItem(template2.namespace) === templateName);
+            template = templates.templates.find(
+              (template2) => lastItem(template2.namespace) === templateName
+            );
             if (!template) {
-              throw new Error(`Unable to determine template for item at ${filepath}`);
+              throw new Error(
+                `Unable to determine template for item at ${filepath}`
+              );
             }
           } else {
-            throw new Error(`Unable to determine template for item at ${filepath}, no template name provided for collection with multiple templates`);
+            throw new Error(
+              `Unable to determine template for item at ${filepath}, no template name provided for collection with multiple templates`
+            );
           }
         }
         if (templates.type === "object") {
           template = templates.template;
         }
         if (!template) {
-          throw new Error(`Something went wrong while trying to determine template for ${filepath}`);
+          throw new Error(
+            `Something went wrong while trying to determine template for ${filepath}`
+          );
         }
         return { collection, template };
       };
@@ -290,10 +301,17 @@
           case "object":
             return templateInfo.template;
           case "union":
-            assertShape(data, (yup2) => yup2.object({ _template: yup2.string().required() }));
-            const template = templateInfo.templates.find((template2) => template2.namespace[template2.namespace.length - 1] === data._template);
+            assertShape(
+              data,
+              (yup2) => yup2.object({ _template: yup2.string().required() })
+            );
+            const template = templateInfo.templates.find(
+              (template2) => template2.namespace[template2.namespace.length - 1] === data._template
+            );
             if (!template) {
-              throw new Error(`Expected to find template named '${data._template}' for collection '${lastItem(collection.namespace)}'`);
+              throw new Error(
+                `Expected to find template named '${data._template}' for collection '${lastItem(collection.namespace)}'`
+              );
             }
             return template;
         }
@@ -347,7 +365,10 @@
         if (field.type === "object")
           if (field.templates) {
             if (field.list) {
-              assertShape(value, (yup2) => yup2.array(yup2.object({ _template: yup2.string().required() })));
+              assertShape(
+                value,
+                (yup2) => yup2.array(yup2.object({ _template: yup2.string().required() }))
+              );
               return value.map((item) => {
                 const { _template, ...rest } = item;
                 const template = field.templates.find((template2) => {
@@ -364,7 +385,10 @@
                 };
               });
             } else {
-              assertShape(value, (yup2) => yup2.object({ _template: yup2.string().required() }));
+              assertShape(
+                value,
+                (yup2) => yup2.object({ _template: yup2.string().required() })
+              );
               const { _template, ...rest } = value;
               return { [_template]: this.transformCollectablePayload(rest, field) };
             }
@@ -395,7 +419,7 @@
         return false;
       };
       this.getTemplatesForCollectable = (collection) => {
-        let extraFields = [];
+        const extraFields = [];
         if (collection == null ? void 0 : collection.fields) {
           const template = collection;
           if (typeof template.fields === "string" || typeof template.fields === "undefined") {
@@ -423,7 +447,11 @@
               })
             };
           } else {
-            throw new Error(`Expected either fields or templates array to be defined on collection ${collection.namespace.join("_")}`);
+            throw new Error(
+              `Expected either fields or templates array to be defined on collection ${collection.namespace.join(
+                "_"
+              )}`
+            );
           }
         }
       };
@@ -469,6 +497,12 @@
         }
       });
     }
+    /**
+     * This function returns an array of glob matches for a given collection.
+     *
+     * @param collection The collection to get the matches for. Can be a string or a collection object.
+     * @returns An array of glob matches.
+     */
     getMatches({
       collection: collectionOrString
     }) {
@@ -493,7 +527,7 @@
       files
     }) {
       const matches = this.getMatches({ collection });
-      const matchedFiles = micromatch__default["default"](files, matches);
+      const matchedFiles = micromatch(files, matches);
       return matchedFiles;
     }
   }
@@ -563,6 +597,7 @@
         }
         if (field.list) {
           return {
+            // Allows component to be overridden for scalars
             component: "list",
             field: {
               component: "text"
@@ -572,6 +607,7 @@
           };
         }
         return {
+          // Allows component to be overridden for scalars
           component: "text",
           ...field,
           ...extraFields
@@ -582,7 +618,9 @@
           return {
             ...field,
             component: field.list ? "group-list" : "group",
-            fields: templateInfo.template.fields.map((field2) => resolveField(field2, schema)),
+            fields: templateInfo.template.fields.map(
+              (field2) => resolveField(field2, schema)
+            ),
             ...extraFields
           };
         } else if (templateInfo.type === "union") {
@@ -673,7 +711,9 @@
           moreInfo.push(parseZodError({ zodError: unionError }));
         });
       }
-      const errorMessage = `Error ${issue == null ? void 0 : issue.message} at path ${issue.path.join(".")}`;
+      const errorMessage = `Error ${issue == null ? void 0 : issue.message} at path ${issue.path.join(
+        "."
+      )}`;
       const errorMessages = [errorMessage, ...moreInfo];
       return {
         errors: errorMessages
@@ -719,18 +759,23 @@ If you need to use this value in your content you can use the \`nameOverride\` p
     "rich-text"
   ];
   const typeTypeError = `type must be one of ${TypeName.join(", ")}`;
-  const typeRequiredError = `type is required and must be one of ${TypeName.join(", ")}`;
-  const Option = z.z.union([
-    z.z.string(),
-    z.z.object({ label: z.z.string(), value: z.z.string() }),
-    z.z.object({ icon: z.z.any(), value: z.z.string() })
-  ], {
-    errorMap: () => {
-      return {
-        message: "Invalid option array. Must be a string[] or {label: string, value: string}[] or {icon: React.ComponentType<any>, value: string}[]"
-      };
+  const typeRequiredError = `type is required and must be one of ${TypeName.join(
+    ", "
+  )}`;
+  const Option = z.z.union(
+    [
+      z.z.string(),
+      z.z.object({ label: z.z.string(), value: z.z.string() }),
+      z.z.object({ icon: z.z.any(), value: z.z.string() })
+    ],
+    {
+      errorMap: () => {
+        return {
+          message: "Invalid option array. Must be a string[] or {label: string, value: string}[] or {icon: React.ComponentType<any>, value: string}[]"
+        };
+      }
     }
-  });
+  );
   const TinaField = z.z.object({
     name,
     label: z.z.string().or(z.z.boolean()).optional(),
@@ -800,6 +845,7 @@ If you need to use this value in your content you can use the \`nameOverride\` p
       }
     });
     const ObjectField = FieldWithList.extend({
+      // needs to be redefined here to avoid circle deps
       type: z.z.literal("object", {
         invalid_type_error: typeTypeError,
         required_error: typeRequiredError
@@ -838,35 +884,43 @@ If you need to use this value in your content you can use the \`nameOverride\` p
         }
       })
     });
-    return z.z.discriminatedUnion("type", [
-      StringField,
-      BooleanField,
-      NumberField,
-      ImageField,
-      DateTimeField,
-      ReferenceField,
-      ObjectField,
-      RichTextField
-    ], {
-      errorMap: (issue, ctx) => {
-        var _a;
-        if (issue.code === "invalid_union_discriminator") {
+    return z.z.discriminatedUnion(
+      "type",
+      [
+        StringField,
+        BooleanField,
+        NumberField,
+        ImageField,
+        DateTimeField,
+        ReferenceField,
+        ObjectField,
+        RichTextField
+      ],
+      {
+        errorMap: (issue, ctx) => {
+          var _a;
+          if (issue.code === "invalid_union_discriminator") {
+            return {
+              message: `Invalid \`type\` property. In the schema is 'type: ${(_a = ctx.data) == null ? void 0 : _a.type}' and expected one of ${TypeName.join(", ")}`
+            };
+          }
           return {
-            message: `Invalid \`type\` property. In the schema is 'type: ${(_a = ctx.data) == null ? void 0 : _a.type}' and expected one of ${TypeName.join(", ")}`
+            message: issue.message
           };
         }
-        return {
-          message: issue.message
-        };
       }
-    }).superRefine((val, ctx) => {
+    ).superRefine((val, ctx) => {
       if (val.type === "string") {
         if (val.isTitle) {
           if (val.list) {
             ctx.addIssue({
               code: z.z.ZodIssueCode.custom,
               message: `Can not have \`list: true\` when using \`isTitle\`. Error in value 
-${JSON.stringify(val, null, 2)}
+${JSON.stringify(
+                val,
+                null,
+                2
+              )}
 `
             });
           }
@@ -874,7 +928,11 @@ ${JSON.stringify(val, null, 2)}
             ctx.addIssue({
               code: z.z.ZodIssueCode.custom,
               message: `Must have { required: true } when using \`isTitle\` Error in value 
-${JSON.stringify(val, null, 2)}
+${JSON.stringify(
+                val,
+                null,
+                2
+              )}
 `
             });
           }
@@ -903,26 +961,26 @@ ${JSON.stringify(val, null, 2)}
       return true;
     });
   });
-  const tinaConfigKey = z__default["default"].object({
-    publicFolder: z__default["default"].string(),
-    mediaRoot: z__default["default"].string()
+  const tinaConfigKey = z.object({
+    publicFolder: z.string(),
+    mediaRoot: z.string()
   }).strict().optional();
-  const tinaSearchKey = z__default["default"].object({
-    indexerToken: z__default["default"].string().optional(),
-    stopwordLanguages: z__default["default"].array(z__default["default"].string()).nonempty().optional(),
-    tokenSplitRegex: z__default["default"].string().optional()
+  const tinaSearchKey = z.object({
+    indexerToken: z.string().optional(),
+    stopwordLanguages: z.array(z.string()).nonempty().optional(),
+    tokenSplitRegex: z.string().optional()
   }).strict().optional();
-  const tinaConfigZod = z__default["default"].object({
-    client: z__default["default"].object({ referenceDepth: z__default["default"].number().optional() }).optional(),
-    media: z__default["default"].object({
+  const tinaConfigZod = z.object({
+    client: z.object({ referenceDepth: z.number().optional() }).optional(),
+    media: z.object({
       tina: tinaConfigKey,
-      loadCustomStore: z__default["default"].function().optional()
+      loadCustomStore: z.function().optional()
     }).optional(),
-    search: z__default["default"].object({
+    search: z.object({
       tina: tinaSearchKey,
-      searchClient: z__default["default"].any().optional(),
-      indexBatchSize: z__default["default"].number().gte(1).optional(),
-      maxSearchIndexFieldLength: z__default["default"].number().gte(1).optional()
+      searchClient: z.any().optional(),
+      indexBatchSize: z.number().gte(1).optional(),
+      maxSearchIndexFieldLength: z.number().gte(1).optional()
     }).optional()
   });
   const validateTinaCloudSchemaConfig = (config) => {
@@ -984,12 +1042,16 @@ ${JSON.stringify(val, null, 2)}
           message: `Fields must have a unique name, duplicate field names: ${dups}`
         });
       }
-    }).refine((val) => {
-      const arr = (val == null ? void 0 : val.filter((x) => x.type === "string" && x.isTitle)) || [];
-      return arr.length < 2;
-    }, {
-      message: "Fields can only have one use of `isTitle`"
-    }),
+    }).refine(
+      // It is valid if it is 0 or 1
+      (val) => {
+        const arr = (val == null ? void 0 : val.filter((x) => x.type === "string" && x.isTitle)) || [];
+        return arr.length < 2;
+      },
+      {
+        message: "Fields can only have one use of `isTitle`"
+      }
+    ),
     templates: z.z.array(Template).min(1).optional().superRefine((val, ctx) => {
       const dups = findDuplicates(val == null ? void 0 : val.map((x) => x.name));
       if (dups) {
@@ -999,15 +1061,18 @@ ${JSON.stringify(val, null, 2)}
         });
       }
     })
-  }).refine((val) => {
-    let isValid = Boolean(val == null ? void 0 : val.templates) || Boolean(val == null ? void 0 : val.fields);
-    if (!isValid) {
-      return false;
-    } else {
-      isValid = !((val == null ? void 0 : val.templates) && (val == null ? void 0 : val.fields));
-      return isValid;
-    }
-  }, { message: "Must provide one of templates or fields in your collection" });
+  }).refine(
+    (val) => {
+      let isValid = Boolean(val == null ? void 0 : val.templates) || Boolean(val == null ? void 0 : val.fields);
+      if (!isValid) {
+        return false;
+      } else {
+        isValid = !((val == null ? void 0 : val.templates) && (val == null ? void 0 : val.fields));
+        return isValid;
+      }
+    },
+    { message: "Must provide one of templates or fields in your collection" }
+  );
   const TinaCloudSchemaZod = z.z.object({
     collections: z.z.array(TinaCloudCollection),
     config: tinaConfigZod.optional()
@@ -1069,5 +1134,5 @@ ${JSON.stringify(val, null, 2)}
   exports2.resolveForm = resolveForm;
   exports2.validateSchema = validateSchema;
   exports2.validateTinaCloudSchemaConfig = validateTinaCloudSchemaConfig;
-  Object.defineProperties(exports2, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
+  Object.defineProperty(exports2, Symbol.toStringTag, { value: "Module" });
 });

package/dist/types/index.d.ts

@@ -335,17 +335,45 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
      */
     schema: Schema;
     /**
-     * The base branch to pull content from. Note that this is ignored for local development
+     * The base branch to pull content from.
+     *
+     * Note: This is ignored and not needed for local development or when self-hosting
      */
-    branch: string | null;
+    branch?: string | null;
     /**
      * Your clientId from  app.tina.io
+     *
+     * Note: This is ignored and not needed for local development or when self-hosting
      */
-    clientId: string | null;
+    clientId?: string | null;
     /**
      * Your read only token from app.tina.io
+     *
+     *  Note: This is ignored and not needed for local development or when self-hosting
      */
-    token: string | null;
+    token?: string | null;
+    ui?: {
+        /**
+         * When using Tina Cloud's branching feature, provide the URL for your given branch
+         *
+         * Eg. If you're deplying to Vercel, and your repo name is 'my-app',
+         * Vercel's preview URL would be based on the branch:
+         *
+         * ```js
+         * previewUrl: (context) => {
+         *  const repoName = 'my-app'
+         *  // `https://<project-name>-git-<branch-name>.vercel.app`
+         *  return { url: `https://my-app-git-${context.branch}` }
+         * }
+         * ```
+         * [more info](https://vercel.com/docs/concepts/deployments/generated-urls#url-with-git-branch)
+         */
+        previewUrl: (context: {
+            branch: string;
+        }) => {
+            url: string;
+        };
+    };
     /**
      * Configurations for the autogenerated GraphQL HTTP client
      */

package/dist/util/validate.d.ts

@@ -3,4 +3,4 @@
 */
 import * as yup from 'yup';
 import type { AnySchema } from 'yup';
-export declare function assertShape<T extends unknown>(value: unknown, yupSchema: (args: typeof yup) => AnySchema, errorMessage?: string): asserts value is T;
+export declare function assertShape<T>(value: unknown, yupSchema: (args: typeof yup) => AnySchema, errorMessage?: string): asserts value is T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "1.4.7",
+  "version": "1.4.8",
   "main": "dist/index.js",
   "module": "./dist/index.es.js",
   "exports": {
@@ -26,7 +26,7 @@
     "@tinacms/scripts": "1.1.0",
     "@types/micromatch": "^4.0.2",
     "@types/yup": "^0.29.10",
-    "jest": "^27.0.6",
+    "jest": "^29.5.0",
     "react": "17.0.2",
     "typescript": "4.3.5",
     "yup": "^0.32.0"