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

package/dist/index.mjs

@@ -1,43 +1,28 @@
 import * as yup from "yup";
 import UrlPattern from "url-pattern";
 import z$1, { z, ZodError } from "zod";
+import { CONTENT_FORMATS } from "@tinacms/common";
 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;
@@ -1943,7 +1928,7 @@ class TinaSchema {
         }
       }
     };
-    this.walkFields = (cb) => {
+    this.legacyWalkFields = (cb) => {
       const walk = (collectionOrObject, collection, path) => {
         if (collectionOrObject.templates) {
           collectionOrObject.templates.forEach((template) => {
@@ -1965,7 +1950,7 @@ class TinaSchema {
       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;
@@ -1986,6 +1971,67 @@ class TinaSchema {
       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.
    *
@@ -2208,9 +2254,12 @@ const parseZodError = ({ zodError }) => {
         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
@@ -2245,6 +2294,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",
@@ -2255,10 +2307,11 @@ const TypeName = [
   "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.union(
   [
     z.string(),
@@ -2344,7 +2397,7 @@ const TinaFieldZod = z.lazy(() => {
     if (dups) {
       ctx.addIssue({
         code: z.ZodIssueCode.custom,
-        message: `Fields must have a unique name, duplicate field names: ${dups}`
+        message: duplicateFieldErrorMessage(dups)
       });
     }
   });
@@ -2354,21 +2407,21 @@ const TinaFieldZod = z.lazy(() => {
       invalid_type_error: typeTypeError,
       required_error: typeRequiredError
     }),
-    fields: z.array(TinaFieldZod).min(1).optional().superRefine((val, ctx) => {
+    fields: 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.ZodIssueCode.custom,
-          message: `Fields must have a unique name, duplicate field names: ${dups}`
+          message: duplicateFieldErrorMessage(dups)
         });
       }
     }),
-    templates: z.array(TemplateTemp).min(1).optional().superRefine((val, ctx) => {
+    templates: 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.ZodIssueCode.custom,
-          message: `Templates must have a unique name, duplicate template names: ${dups}`
+          message: duplicateTemplateErrorMessage(dups)
         });
       }
     })
@@ -2383,7 +2436,7 @@ const TinaFieldZod = z.lazy(() => {
       if (dups) {
         ctx.addIssue({
           code: z.ZodIssueCode.custom,
-          message: `Templates must have a unique name, duplicate template names: ${dups}`
+          message: duplicateTemplateErrorMessage(dups)
         });
       }
     })
@@ -2403,10 +2456,17 @@ const TinaFieldZod = z.lazy(() => {
     ],
     {
       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 {
@@ -2416,77 +2476,52 @@ const TinaFieldZod = z.lazy(() => {
     }
   ).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
-            )}
-`
-          });
-        }
-        if (!val.required) {
-          ctx.addIssue({
-            code: 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.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.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.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.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.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.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.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.ZodIssueCode.custom,
-            message
-          });
-        }
-        return isValid;
       }
     }
     return true;
@@ -2519,19 +2554,10 @@ const validateTinaCloudSchemaConfig = (config) => {
   const newConfig = tinaConfigZod.parse(config);
   return newConfig;
 };
-const FORMATS = [
-  "json",
-  "md",
-  "markdown",
-  "mdx",
-  "toml",
-  "yaml",
-  "yml"
-];
 const Template = z.object({
   label: 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.array(TinaFieldZod)
@@ -2541,7 +2567,7 @@ const Template = z.object({
   if (dups) {
     ctx.addIssue({
       code: z.ZodIssueCode.custom,
-      message: `Fields must have a unique name, duplicate field names: ${dups}`
+      message: duplicateFieldErrorMessage(dups)
     });
   }
 });
@@ -2551,7 +2577,7 @@ const CollectionBaseSchema = z.object({
     if (val === "relativePath") {
       ctx.addIssue({
         code: 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."
       });
     }
   }),
@@ -2559,72 +2585,73 @@ const CollectionBaseSchema = z.object({
     if (val === ".") {
       ctx.addIssue({
         code: z.ZodIssueCode.custom,
-        message: `path cannot be '.'. Please use '/' or '' instead. `
+        message: "Invalid `path` property. `path` cannot be '.'. Please use '/' or '' instead."
       });
     }
   }),
-  format: z.enum(FORMATS).optional(),
+  format: z.enum(CONTENT_FORMATS).optional(),
   isAuthCollection: z.boolean().optional(),
   isDetached: z.boolean().optional()
 });
 const TinaCloudCollection = CollectionBaseSchema.extend({
-  fields: z.array(TinaFieldZod).min(1).optional().superRefine((val, ctx) => {
+  fields: 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.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.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.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.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.ZodIssueCode.custom,
+        message: `The following fields have \`type: password\`: [${arr.map((field) => field.name).join(", ")}]. Only one can be of \`type: password\`.`
+      });
+    }
+  }),
+  templates: 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.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.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.ZodIssueCode.custom,
+      message: "Fields of `type: object` must have either `templates` or `fields` property, not both."
+    });
+    return false;
+  }
+});
 const TinaCloudSchemaZod = z.object({
   collections: z.array(TinaCloudCollection),
   config: tinaConfigZod.optional()
@@ -2634,14 +2661,14 @@ const TinaCloudSchemaZod = z.object({
   if (dups) {
     ctx.addIssue({
       code: 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.ZodIssueCode.custom,
-      message: `Only one collection can be marked as isAuthCollection`,
+      message: "Only one collection can be marked as `isAuthCollection`.",
       fatal: true
     });
   }
@@ -2649,7 +2676,7 @@ const TinaCloudSchemaZod = z.object({
   if (media && media.tina && media.loadCustomStore) {
     ctx.addIssue({
       code: 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"]
     });
@@ -2658,7 +2685,7 @@ const TinaCloudSchemaZod = z.object({
   if (search && search.tina && search.searchClient) {
     ctx.addIssue({
       code: 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"]
     });
@@ -2676,7 +2703,7 @@ const validateSchema = ({ schema }) => {
   } catch (e) {
     if (e instanceof ZodError) {
       const errors = parseZodError({ zodError: e });
-      throw new TinaSchemaValidationError(errors.join(", \n"));
+      throw new TinaSchemaValidationError(errors.join("\n"));
     }
     throw new Error(e);
   }

package/dist/schema/TinaSchema.d.ts

@@ -28,6 +28,7 @@ export declare class TinaSchema {
     } & Schema);
     getIsTitleFieldName: (collection: string) => string;
     getCollectionsByName: (collectionNames: string[]) => Collection<true>[];
+    findReferencesFromCollection(name: string): Record<string, string[]>;
     getCollection: (collectionName: string) => Collection<true>;
     getCollections: () => Collection<true>[];
     getCollectionByFullPath: (filepath: string) => Collection<true>;
@@ -59,7 +60,26 @@ export declare class TinaSchema {
      *
      */
     getTemplatesForCollectable: (collection: Collectable) => CollectionTemplateable;
-    walkFields: (cb: (args: {
+    /**
+     * Walk all fields in tina schema
+     *
+     * @param cb callback function invoked for each field
+     */
+    walkFields(cb: (args: {
+        field: any;
+        collection: any;
+        path: string;
+        isListItem?: boolean;
+    }) => void): void;
+    /**
+     * Walk all fields in Tina Schema
+     *
+     * This is a legacy version to preserve backwards compatibility for the tina generated schema. It does not
+     * traverse fields in object lists in rich-text templates.
+     *
+     * @param cb callback function invoked for each field
+     */
+    legacyWalkFields: (cb: (args: {
         field: TinaField;
         collection: Collection;
         path: string[];

package/dist/schema/addNamespaceToSchema.d.ts

@@ -1,4 +1,8 @@
-/**
-
-*/
-export declare function addNamespaceToSchema<T extends object | string>(maybeNode: T, namespace?: string[]): T;
+type Node = {
+    name?: string;
+    value?: string;
+    namespace?: string[];
+    [key: string]: any;
+};
+export declare function addNamespaceToSchema<T extends Node | string>(maybeNode: T, namespace?: string[]): T;
+export {};