@tinacms/schema-tools 0.0.0-b4c6a60-20241010070518 → 0.0.0-bdc07c1-20250506013835

package/dist/index.d.ts

@@ -1,6 +1 @@
-export * from './schema';
-export * from './types/index';
-export * from './validate';
-export * from './util/namer';
-export * from './util/parseURL';
-export * from './util/normalizePath';
+export * from "../src/index"

package/dist/index.js

@@ -1,6 +1,6 @@
 (function(global, factory) {
-  typeof exports === "object" && typeof module !== "undefined" ? factory(exports, require("yup"), require("url-pattern"), require("zod")) : typeof define === "function" && define.amd ? define(["exports", "yup", "url-pattern", "zod"], factory) : (global = typeof globalThis !== "undefined" ? globalThis : global || self, factory(global["@tinacms/schema-tools"] = {}, global.NOOP, global.NOOP, global.NOOP));
-})(this, function(exports2, yup, UrlPattern, z) {
+  typeof exports === "object" && typeof module !== "undefined" ? factory(exports, require("yup"), require("url-pattern"), require("zod"), require("@tinacms/common")) : typeof define === "function" && define.amd ? define(["exports", "yup", "url-pattern", "zod", "@tinacms/common"], factory) : (global = typeof globalThis !== "undefined" ? globalThis : global || self, factory(global["@tinacms/schema-tools"] = {}, global.NOOP, global.NOOP, global.NOOP, global.NOOP));
+})(this, function(exports2, yup, UrlPattern, z, common) {
   "use strict";
   function _interopNamespaceDefault(e) {
     const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
@@ -20,42 +20,26 @@
   }
   const yup__namespace = /* @__PURE__ */ _interopNamespaceDefault(yup);
   function addNamespaceToSchema(maybeNode, namespace = []) {
-    if (typeof maybeNode === "string") {
+    if (typeof maybeNode !== "object" || maybeNode === null) {
       return maybeNode;
     }
-    if (typeof maybeNode === "boolean") {
-      return maybeNode;
-    }
-    if (typeof maybeNode === "function") {
-      return maybeNode;
-    }
-    const newNode = { ...maybeNode };
-    const keys = Object.keys(maybeNode);
-    Object.values(maybeNode).map((m, index) => {
-      const key = keys[index];
-      if (Array.isArray(m)) {
-        newNode[key] = m.map((element) => {
-          if (!element) {
-            return;
-          }
-          if (!element.hasOwnProperty("name")) {
-            return element;
+    const newNode = { ...maybeNode, namespace: [...namespace] };
+    Object.entries(maybeNode).forEach(([key, value]) => {
+      if (Array.isArray(value)) {
+        newNode[key] = value.map((element) => {
+          if (element && typeof element === "object" && "name" in element) {
+            const valueName = element.name || element.value;
+            return addNamespaceToSchema(element, [...namespace, valueName]);
           }
-          const value = element.name || element.value;
-          return addNamespaceToSchema(element, [...namespace, value]);
+          return element;
         });
+      } else if (value && typeof value === "object" && "name" in value) {
+        newNode[key] = addNamespaceToSchema(value, [...namespace, value.name]);
       } else {
-        if (!m) {
-          return;
-        }
-        if (!m.hasOwnProperty("name")) {
-          newNode[key] = m;
-        } else {
-          newNode[key] = addNamespaceToSchema(m, [...namespace, m.name]);
-        }
+        newNode[key] = value;
       }
     });
-    return { ...newNode, namespace };
+    return newNode;
   }
   function getDefaultExportFromCjs(x) {
     return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, "default") ? x["default"] : x;
@@ -1961,7 +1945,7 @@
           }
         }
       };
-      this.walkFields = (cb) => {
+      this.legacyWalkFields = (cb) => {
         const walk = (collectionOrObject, collection, path) => {
           if (collectionOrObject.templates) {
             collectionOrObject.templates.forEach((template) => {
@@ -1983,7 +1967,7 @@
         collections.forEach((collection) => walk(collection, collection, []));
       };
       this.schema = config;
-      this.walkFields(({ field, collection, path }) => {
+      this.legacyWalkFields(({ field, collection }) => {
         if (!("searchable" in field)) {
           if (field.type === "image") {
             field.searchable = false;
@@ -2004,6 +1988,67 @@
         field.uid = field.uid || false;
       });
     }
+    findReferencesFromCollection(name2) {
+      const result = {};
+      this.walkFields(({ field, collection: c, path }) => {
+        if (c.name !== name2) {
+          return;
+        }
+        if (field.type === "reference") {
+          field.collections.forEach((name22) => {
+            if (result[name22] === void 0) {
+              result[name22] = [];
+            }
+            result[name22].push(path);
+          });
+        }
+      });
+      return result;
+    }
+    /**
+     * Walk all fields in tina schema
+     *
+     * @param cb callback function invoked for each field
+     */
+    walkFields(cb) {
+      const walk = (collectionOrObject, collection, path = "$") => {
+        if (collectionOrObject.templates) {
+          collectionOrObject.templates.forEach((template) => {
+            const templatePath = `${path}.${template.name}`;
+            template.fields.forEach((field) => {
+              const fieldPath = field.list ? `${templatePath}[*].${field.name}` : `${templatePath}.${field.name}`;
+              cb({ field, collection, path: fieldPath });
+              if (field.type === "object") {
+                walk(field, collection, fieldPath);
+              }
+            });
+          });
+        }
+        if (collectionOrObject.fields) {
+          collectionOrObject.fields.forEach((field) => {
+            const fieldPath = field.list ? `${path}.${field.name}[*]` : `${path}.${field.name}`;
+            cb({ field, collection, path: fieldPath });
+            if (field.type === "object" && field.fields) {
+              walk(field, collection, fieldPath);
+            } else if (field.templates) {
+              field.templates.forEach((template) => {
+                const templatePath = `${fieldPath}.${template.name}`;
+                template.fields.forEach((field2) => {
+                  const fieldPath2 = field2.list ? `${templatePath}[*].${field2.name}` : `${templatePath}.${field2.name}`;
+                  cb({ field: field2, collection, path: fieldPath2 });
+                  if (field2.type === "object") {
+                    walk(field2, collection, fieldPath2);
+                  }
+                });
+              });
+            }
+          });
+        }
+      };
+      this.getCollections().forEach((collection) => {
+        walk(collection, collection);
+      });
+    }
     /**
      * This function returns an array of glob matches for a given collection.
      *
@@ -2226,9 +2271,12 @@
           moreInfo.push(parseZodError({ zodError: unionError }));
         });
       }
-      const errorMessage = `Error ${issue == null ? void 0 : issue.message} at path ${issue.path.join(
+      const errorMessage = `${issue == null ? void 0 : issue.message}
+Additional information: 
+	- Error found at path ${issue.path.join(
         "."
-      )}`;
+      )}
+`;
       const errorMessages = [errorMessage, ...moreInfo];
       return {
         errors: errorMessages
@@ -2263,6 +2311,9 @@ If you need to use this value in your content you can use the \`nameOverride\` p
       });
     }
   });
+  const duplicateFieldErrorMessage = (fields) => `Fields must have unique names. Found duplicate field names: [${fields}]`;
+  const duplicateTemplateErrorMessage = (templates) => `Templates must have unique names. Found duplicate template names: [${templates}]`;
+  const duplicateCollectionErrorMessage = (collection) => `Collections must have unique names. Found duplicate collection names: [${collection}]`;
   const TypeName = [
     "string",
     "boolean",
@@ -2273,10 +2324,11 @@ If you need to use this value in your content you can use the \`nameOverride\` p
     "reference",
     "rich-text"
   ];
-  const typeTypeError = `type must be one of ${TypeName.join(", ")}`;
-  const typeRequiredError = `type is required and must be one of ${TypeName.join(
-    ", "
-  )}`;
+  const formattedTypes = `  - ${TypeName.join("\n  - ")}`;
+  const typeTypeError = `Invalid \`type\` property. \`type\` expected to be one of the following values:
+${formattedTypes}`;
+  const typeRequiredError = `Missing \`type\` property. Please add a \`type\` property with one of the following:
+${formattedTypes}`;
   const Option = z.z.union(
     [
       z.z.string(),
@@ -2362,7 +2414,7 @@ If you need to use this value in your content you can use the \`nameOverride\` p
       if (dups) {
         ctx.addIssue({
           code: z.z.ZodIssueCode.custom,
-          message: `Fields must have a unique name, duplicate field names: ${dups}`
+          message: duplicateFieldErrorMessage(dups)
         });
       }
     });
@@ -2372,21 +2424,21 @@ If you need to use this value in your content you can use the \`nameOverride\` p
         invalid_type_error: typeTypeError,
         required_error: typeRequiredError
       }),
-      fields: z.z.array(TinaFieldZod).min(1).optional().superRefine((val, ctx) => {
+      fields: z.z.array(TinaFieldZod).min(1, "Property `fields` cannot be empty.").optional().superRefine((val, ctx) => {
         const dups = findDuplicates(val == null ? void 0 : val.map((x) => x.name));
         if (dups) {
           ctx.addIssue({
             code: z.z.ZodIssueCode.custom,
-            message: `Fields must have a unique name, duplicate field names: ${dups}`
+            message: duplicateFieldErrorMessage(dups)
           });
         }
       }),
-      templates: z.z.array(TemplateTemp).min(1).optional().superRefine((val, ctx) => {
+      templates: z.z.array(TemplateTemp).min(1, "Property `templates` cannot be empty.").optional().superRefine((val, ctx) => {
         const dups = findDuplicates(val == null ? void 0 : val.map((x) => x.name));
         if (dups) {
           ctx.addIssue({
             code: z.z.ZodIssueCode.custom,
-            message: `Templates must have a unique name, duplicate template names: ${dups}`
+            message: duplicateTemplateErrorMessage(dups)
           });
         }
       })
@@ -2401,7 +2453,7 @@ If you need to use this value in your content you can use the \`nameOverride\` p
         if (dups) {
           ctx.addIssue({
             code: z.z.ZodIssueCode.custom,
-            message: `Templates must have a unique name, duplicate template names: ${dups}`
+            message: duplicateTemplateErrorMessage(dups)
           });
         }
       })
@@ -2421,10 +2473,17 @@ If you need to use this value in your content you can use the \`nameOverride\` p
       ],
       {
         errorMap: (issue, ctx) => {
-          var _a;
+          var _a, _b;
           if (issue.code === "invalid_union_discriminator") {
+            if (!((_a = ctx.data) == null ? void 0 : _a.type)) {
+              return {
+                message: `Missing \`type\` property in field \`${ctx.data.name}\`. Please add a \`type\` property with one of the following:
+${formattedTypes}`
+              };
+            }
             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: `Invalid \`type\` property in field \`${ctx.data.name}\`. In the schema is 'type: ${(_b = ctx.data) == null ? void 0 : _b.type}' but expected one of the following:
+${formattedTypes}`
             };
           }
           return {
@@ -2434,77 +2493,52 @@ If you need to use this value in your content you can use the \`nameOverride\` p
       }
     ).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
-              )}
-`
-            });
-          }
-          if (!val.required) {
-            ctx.addIssue({
-              code: z.z.ZodIssueCode.custom,
-              message: `Must have { required: true } when using \`isTitle\` Error in value 
-${JSON.stringify(
-                val,
-                null,
-                2
-              )}
-`
-            });
-          }
+        const stringifiedField = JSON.stringify(val, null, 2);
+        if (val.isTitle && val.list) {
+          ctx.addIssue({
+            code: z.z.ZodIssueCode.custom,
+            message: `\`list: true\` is not allowed when using \`isTitle\` for fields of \`type: string\`. Error found in field:
+${stringifiedField}`
+          });
+        }
+        if (val.isTitle && !val.required) {
+          ctx.addIssue({
+            code: z.z.ZodIssueCode.custom,
+            message: `Property \`required: true\` is required when using \`isTitle\` for fields of \`type: string\`. Error found in field:
+${stringifiedField}`
+          });
         }
-        if (val.uid) {
+        if (val.uid && val.list) {
           if (val.list) {
             ctx.addIssue({
               code: z.z.ZodIssueCode.custom,
-              message: `Can not have \`list: true\` when using \`uid\`. Error in value 
-${JSON.stringify(
-                val,
-                null,
-                2
-              )}
-`
-            });
-          }
-          if (!val.required) {
-            ctx.addIssue({
-              code: z.z.ZodIssueCode.custom,
-              message: `Must have { required: true } when using \`uid\` Error in value 
-${JSON.stringify(
-                val,
-                null,
-                2
-              )}
-`
+              message: `\`list: true\` is not allowed when using \`uid\` for fields of \`type: string\`. Error found in field:
+${stringifiedField}`
             });
           }
         }
+        if (val.uid && !val.required) {
+          ctx.addIssue({
+            code: z.z.ZodIssueCode.custom,
+            message: `Property \`required: true\` is required when using \`uid\` for fields of \`type: string\`. Error found in field:
+${stringifiedField}`
+          });
+        }
       }
       if (val.type === "object") {
-        const message = "Must provide one of templates or fields in your collection";
-        let isValid = Boolean(val == null ? void 0 : val.templates) || Boolean(val == null ? void 0 : val.fields);
-        if (!isValid) {
+        if (!(val == null ? void 0 : val.templates) && !(val == null ? void 0 : val.fields)) {
           ctx.addIssue({
             code: z.z.ZodIssueCode.custom,
-            message
+            message: "Fields of `type: object` must have either `templates` or `fields` property."
+          });
+          return false;
+        }
+        if ((val == null ? void 0 : val.templates) && (val == null ? void 0 : val.fields)) {
+          ctx.addIssue({
+            code: z.z.ZodIssueCode.custom,
+            message: "Fields of `type: object` must have either `templates` or `fields` property, not both."
           });
           return false;
-        } else {
-          isValid = !((val == null ? void 0 : val.templates) && (val == null ? void 0 : val.fields));
-          if (!isValid) {
-            ctx.addIssue({
-              code: z.z.ZodIssueCode.custom,
-              message
-            });
-          }
-          return isValid;
         }
       }
       return true;
@@ -2537,19 +2571,10 @@ ${JSON.stringify(
     const newConfig = tinaConfigZod.parse(config);
     return newConfig;
   };
-  const FORMATS = [
-    "json",
-    "md",
-    "markdown",
-    "mdx",
-    "toml",
-    "yaml",
-    "yml"
-  ];
   const Template = z.z.object({
     label: z.z.string({
-      invalid_type_error: "label must be a string",
-      required_error: "label was not provided but is required"
+      invalid_type_error: "Invalid data type for property `label`. Must be of type `string`",
+      required_error: "Missing `label` property. Property `label` is required."
     }),
     name,
     fields: z.z.array(TinaFieldZod)
@@ -2559,7 +2584,7 @@ ${JSON.stringify(
     if (dups) {
       ctx.addIssue({
         code: z.z.ZodIssueCode.custom,
-        message: `Fields must have a unique name, duplicate field names: ${dups}`
+        message: duplicateFieldErrorMessage(dups)
       });
     }
   });
@@ -2569,7 +2594,7 @@ ${JSON.stringify(
       if (val === "relativePath") {
         ctx.addIssue({
           code: z.z.ZodIssueCode.custom,
-          message: `name cannot be 'relativePath'. 'relativePath' is a reserved field name.`
+          message: "Invalid `name` property. `name` cannot be 'relativePath' as it is a reserved field name."
         });
       }
     }),
@@ -2577,72 +2602,73 @@ ${JSON.stringify(
       if (val === ".") {
         ctx.addIssue({
           code: z.z.ZodIssueCode.custom,
-          message: `path cannot be '.'. Please use '/' or '' instead. `
+          message: "Invalid `path` property. `path` cannot be '.'. Please use '/' or '' instead."
         });
       }
     }),
-    format: z.z.enum(FORMATS).optional(),
+    format: z.z.enum(common.CONTENT_FORMATS).optional(),
     isAuthCollection: z.z.boolean().optional(),
     isDetached: z.z.boolean().optional()
   });
   const TinaCloudCollection = CollectionBaseSchema.extend({
-    fields: z.z.array(TinaFieldZod).min(1).optional().superRefine((val, ctx) => {
+    fields: z.z.array(TinaFieldZod).min(1, "Property `fields` cannot be empty.").optional().superRefine((val, ctx) => {
       const dups = findDuplicates(val == null ? void 0 : val.map((x) => x.name));
       if (dups) {
         ctx.addIssue({
           code: z.z.ZodIssueCode.custom,
-          message: `Fields must have a unique name, duplicate field names: ${dups}`
+          message: duplicateFieldErrorMessage(dups)
         });
       }
-    }).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`"
-      }
-    ).refine(
-      // It is valid if it is 0 or 1
-      (val) => {
-        const arr = (val == null ? void 0 : val.filter((x) => x.uid)) || [];
-        return arr.length < 2;
-      },
-      {
-        message: "Fields can only have one use of `uid`"
-      }
-    ).refine(
-      // It is valid if it is 0 or 1
-      (val) => {
-        const arr = (val == null ? void 0 : val.filter((x) => x.type === "password")) || [];
-        return arr.length < 2;
-      },
-      {
-        message: "Fields can only have one use of `password` type"
+    }).superRefine((val, ctx) => {
+      const arr = (val == null ? void 0 : val.filter((x) => x.type === "string" && x.isTitle)) || [];
+      if (arr.length > 1) {
+        ctx.addIssue({
+          code: z.z.ZodIssueCode.custom,
+          message: `The following fields have the property \`isTitle\`: [${arr.map((field) => field.name).join(", ")}]. Only one can contain the property \`isTitle\`.`
+        });
       }
-    ),
-    templates: z.z.array(Template).min(1).optional().superRefine((val, ctx) => {
+    }).superRefine((val, ctx) => {
+      const arr = (val == null ? void 0 : val.filter((x) => x.uid)) || [];
+      if (arr.length > 2) {
+        ctx.addIssue({
+          code: z.z.ZodIssueCode.custom,
+          message: `The following fields have the property \`uid\`: [${arr.map((field) => field.name).join(", ")}]. Only one can contain the property \`uid\`.`
+        });
+      }
+    }).superRefine((val, ctx) => {
+      const arr = (val == null ? void 0 : val.filter((x) => x.type === "password")) || [];
+      if (arr.length > 2) {
+        ctx.addIssue({
+          code: z.z.ZodIssueCode.custom,
+          message: `The following fields have \`type: password\`: [${arr.map((field) => field.name).join(", ")}]. Only one can be of \`type: password\`.`
+        });
+      }
+    }),
+    templates: z.z.array(Template).min(1, "Property `templates` cannot be empty.").optional().superRefine((val, ctx) => {
       const dups = findDuplicates(val == null ? void 0 : val.map((x) => x.name));
       if (dups) {
         ctx.addIssue({
           code: z.z.ZodIssueCode.custom,
-          message: `Templates must have a unique name, duplicate template names: ${dups}`
+          message: duplicateFieldErrorMessage(dups)
         });
       }
     })
-  }).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" }
-  );
+  }).superRefine((val, ctx) => {
+    if (!(val == null ? void 0 : val.templates) && !(val == null ? void 0 : val.fields)) {
+      ctx.addIssue({
+        code: z.z.ZodIssueCode.custom,
+        message: "Fields of `type: object` must have either `templates` or `fields` property."
+      });
+      return false;
+    }
+    if ((val == null ? void 0 : val.templates) && (val == null ? void 0 : val.fields)) {
+      ctx.addIssue({
+        code: z.z.ZodIssueCode.custom,
+        message: "Fields of `type: object` must have either `templates` or `fields` property, not both."
+      });
+      return false;
+    }
+  });
   const TinaCloudSchemaZod = z.z.object({
     collections: z.z.array(TinaCloudCollection),
     config: tinaConfigZod.optional()
@@ -2652,14 +2678,14 @@ ${JSON.stringify(
     if (dups) {
       ctx.addIssue({
         code: z.z.ZodIssueCode.custom,
-        message: `${dups} are duplicate names in your collections. Collection names must be unique.`,
+        message: duplicateCollectionErrorMessage(dups),
         fatal: true
       });
     }
     if (((_b = val.collections) == null ? void 0 : _b.filter((x) => x.isAuthCollection).length) > 1) {
       ctx.addIssue({
         code: z.z.ZodIssueCode.custom,
-        message: `Only one collection can be marked as isAuthCollection`,
+        message: "Only one collection can be marked as `isAuthCollection`.",
         fatal: true
       });
     }
@@ -2667,7 +2693,7 @@ ${JSON.stringify(
     if (media && media.tina && media.loadCustomStore) {
       ctx.addIssue({
         code: z.z.ZodIssueCode.custom,
-        message: "can not have both loadCustomStore and tina. Must use one or the other",
+        message: "Cannot have both `loadCustomStore` and `tina`. Must use one or the other.",
         fatal: true,
         path: ["config", "media"]
       });
@@ -2676,7 +2702,7 @@ ${JSON.stringify(
     if (search && search.tina && search.searchClient) {
       ctx.addIssue({
         code: z.z.ZodIssueCode.custom,
-        message: "can not have both searchClient and tina. Must use one or the other",
+        message: "Cannot have both `searchClient` and `tina`. Must use one or the other.",
         fatal: true,
         path: ["config", "search"]
       });
@@ -2694,7 +2720,7 @@ ${JSON.stringify(
     } catch (e) {
       if (e instanceof z.ZodError) {
         const errors = parseZodError({ zodError: e });
-        throw new TinaSchemaValidationError(errors.join(", \n"));
+        throw new TinaSchemaValidationError(errors.join("\n"));
       }
       throw new Error(e);
     }