@tinacms/schema-tools 1.7.3 → 1.8.0

package/dist/index.js

@@ -1664,6 +1664,9 @@
     };
   };
   const normalizePath = (filepath) => filepath.replace(/\\/g, "/");
+  const canonicalPath = (filepath) => {
+    return normalizePath(filepath).split("/").filter((name2) => name2 !== "").join("/");
+  };
   class TinaSchema {
     /**
      * Create a schema class from a user defined schema object
@@ -1713,21 +1716,21 @@
       };
       this.getCollectionByFullPath = (filepath) => {
         const fileExtension = filepath.split(".").pop();
-        const normalizedPath = filepath.replace(/\\/g, "/");
+        const canonicalFilepath = canonicalPath(filepath);
         const possibleCollections = this.getCollections().filter((collection) => {
           var _a, _b;
-          if (!normalizedPath.endsWith(`.gitkeep.${collection.format || "md"}`) && fileExtension !== (collection.format || "md")) {
+          if (!canonicalFilepath.endsWith(`.gitkeep.${collection.format || "md"}`) && fileExtension !== (collection.format || "md")) {
             return false;
           }
           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 = picomatch$1.isMatch(normalizedPath, matches);
+            const match = picomatch$1.isMatch(canonicalFilepath, matches);
             if (!match) {
               return false;
             }
           }
-          const path = collection.path ? collection.path.replace(/\/?$/, "/") : "";
-          return normalizedPath.startsWith(path);
+          const collectionPath = canonicalPath(collection.path);
+          return collectionPath === "" || canonicalFilepath.startsWith(`${collectionPath}/`);
         });
         if (possibleCollections.length === 0) {
           throw new Error(`Unable to find collection for file at ${filepath}`);
@@ -2060,16 +2063,16 @@
     }) {
       var _a, _b;
       const collection = typeof collectionOrString === "string" ? this.getCollection(collectionOrString) : collectionOrString;
-      const normalPath = normalizePath(collection.path);
-      const pathSuffix = normalPath ? "/" : "";
+      const collectionPath = canonicalPath(collection.path);
+      const pathSuffix = collectionPath ? "/" : "";
       const format = collection.format || "md";
       const matches = [];
       if ((_a = collection == null ? void 0 : collection.match) == null ? void 0 : _a.include) {
-        const match = `${normalPath}${pathSuffix}${collection.match.include}.${format}`;
+        const match = `${collectionPath}${pathSuffix}${collection.match.include}.${format}`;
         matches.push(match);
       }
       if ((_b = collection == null ? void 0 : collection.match) == null ? void 0 : _b.exclude) {
-        const exclude = `!(${normalPath}${pathSuffix}${collection.match.exclude}.${format})`;
+        const exclude = `!(${collectionPath}${pathSuffix}${collection.match.exclude}.${format})`;
         matches.push(exclude);
       }
       return matches;
@@ -2262,6 +2265,15 @@
       })
     };
   };
+  const CONTENT_FORMATS = [
+    "mdx",
+    "md",
+    "markdown",
+    "json",
+    "yaml",
+    "yml",
+    "toml"
+  ];
   const parseZodError = ({ zodError }) => {
     var _a, _b, _c, _d;
     const errors = zodError.flatten((issue) => {
@@ -2571,15 +2583,6 @@ ${stringifiedField}`
     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: "Invalid data type for property `label`. Must be of type `string`",
@@ -2615,7 +2618,7 @@ ${stringifiedField}`
         });
       }
     }),
-    format: z.z.enum(FORMATS).optional(),
+    format: z.z.enum(CONTENT_FORMATS).optional(),
     isAuthCollection: z.z.boolean().optional(),
     isDetached: z.z.boolean().optional()
   });
@@ -2734,11 +2737,13 @@ ${stringifiedField}`
       throw new Error(e);
     }
   };
+  exports2.CONTENT_FORMATS = CONTENT_FORMATS;
   exports2.NAMER = NAMER;
   exports2.TINA_HOST = TINA_HOST;
   exports2.TinaSchema = TinaSchema;
   exports2.TinaSchemaValidationError = TinaSchemaValidationError;
   exports2.addNamespaceToSchema = addNamespaceToSchema;
+  exports2.canonicalPath = canonicalPath;
   exports2.normalizePath = normalizePath;
   exports2.parseURL = parseURL;
   exports2.resolveField = resolveField;

package/dist/index.mjs

@@ -1646,6 +1646,9 @@ const parseURL = (url) => {
   };
 };
 const normalizePath = (filepath) => filepath.replace(/\\/g, "/");
+const canonicalPath = (filepath) => {
+  return normalizePath(filepath).split("/").filter((name2) => name2 !== "").join("/");
+};
 class TinaSchema {
   /**
    * Create a schema class from a user defined schema object
@@ -1695,21 +1698,21 @@ class TinaSchema {
     };
     this.getCollectionByFullPath = (filepath) => {
       const fileExtension = filepath.split(".").pop();
-      const normalizedPath = filepath.replace(/\\/g, "/");
+      const canonicalFilepath = canonicalPath(filepath);
       const possibleCollections = this.getCollections().filter((collection) => {
         var _a, _b;
-        if (!normalizedPath.endsWith(`.gitkeep.${collection.format || "md"}`) && fileExtension !== (collection.format || "md")) {
+        if (!canonicalFilepath.endsWith(`.gitkeep.${collection.format || "md"}`) && fileExtension !== (collection.format || "md")) {
           return false;
         }
         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 = picomatch$1.isMatch(normalizedPath, matches);
+          const match = picomatch$1.isMatch(canonicalFilepath, matches);
           if (!match) {
             return false;
           }
         }
-        const path = collection.path ? collection.path.replace(/\/?$/, "/") : "";
-        return normalizedPath.startsWith(path);
+        const collectionPath = canonicalPath(collection.path);
+        return collectionPath === "" || canonicalFilepath.startsWith(`${collectionPath}/`);
       });
       if (possibleCollections.length === 0) {
         throw new Error(`Unable to find collection for file at ${filepath}`);
@@ -2042,16 +2045,16 @@ class TinaSchema {
   }) {
     var _a, _b;
     const collection = typeof collectionOrString === "string" ? this.getCollection(collectionOrString) : collectionOrString;
-    const normalPath = normalizePath(collection.path);
-    const pathSuffix = normalPath ? "/" : "";
+    const collectionPath = canonicalPath(collection.path);
+    const pathSuffix = collectionPath ? "/" : "";
     const format = collection.format || "md";
     const matches = [];
     if ((_a = collection == null ? void 0 : collection.match) == null ? void 0 : _a.include) {
-      const match = `${normalPath}${pathSuffix}${collection.match.include}.${format}`;
+      const match = `${collectionPath}${pathSuffix}${collection.match.include}.${format}`;
       matches.push(match);
     }
     if ((_b = collection == null ? void 0 : collection.match) == null ? void 0 : _b.exclude) {
-      const exclude = `!(${normalPath}${pathSuffix}${collection.match.exclude}.${format})`;
+      const exclude = `!(${collectionPath}${pathSuffix}${collection.match.exclude}.${format})`;
       matches.push(exclude);
     }
     return matches;
@@ -2244,6 +2247,15 @@ const resolveForm = ({
     })
   };
 };
+const CONTENT_FORMATS = [
+  "mdx",
+  "md",
+  "markdown",
+  "json",
+  "yaml",
+  "yml",
+  "toml"
+];
 const parseZodError = ({ zodError }) => {
   var _a, _b, _c, _d;
   const errors = zodError.flatten((issue) => {
@@ -2553,15 +2565,6 @@ 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: "Invalid data type for property `label`. Must be of type `string`",
@@ -2597,7 +2600,7 @@ const CollectionBaseSchema = z.object({
       });
     }
   }),
-  format: z.enum(FORMATS).optional(),
+  format: z.enum(CONTENT_FORMATS).optional(),
   isAuthCollection: z.boolean().optional(),
   isDetached: z.boolean().optional()
 });
@@ -2717,11 +2720,13 @@ const validateSchema = ({ schema }) => {
   }
 };
 export {
+  CONTENT_FORMATS,
   NAMER,
   TINA_HOST,
   TinaSchema,
   TinaSchemaValidationError,
   addNamespaceToSchema,
+  canonicalPath,
   normalizePath,
   parseURL,
   resolveField,

package/dist/types/index.d.ts

@@ -1,5 +1,23 @@
 import type { FC } from 'react';
 import type React from 'react';
+export declare const CONTENT_FORMATS: readonly ["mdx", "md", "markdown", "json", "yaml", "yml", "toml"];
+export type ContentFormat = (typeof CONTENT_FORMATS)[number];
+export type ContentFrontmatterFormat = 'yaml' | 'toml' | 'json';
+export type Parser = {
+    type: 'mdx';
+} | {
+    type: 'markdown';
+    /**
+     * Tina will escape entities like `<` and `[` by default. You can choose to turn
+     * off all escaping, or specify HTML, so `<div>` will not be turned into `\<div>`
+     */
+    skipEscaping?: 'all' | 'html' | 'none';
+} | {
+    /**
+     * Experimental: Returns the native Slate.js document as JSON. Ideal to retain the pure editor content structure.
+     */
+    type: 'slatejson';
+};
 type Meta = {
     active?: boolean;
     dirty?: boolean;
@@ -212,16 +230,7 @@ export type RichTextField<WithNamespace extends boolean = false> = (FieldGeneric
      *
      * Specify `"markdown"` if you're having problems with Tina parsing your content.
      */
-    parser?: {
-        type: 'markdown';
-        /**
-         * Tina will escape entities like `<` and `[` by default. You can choose to turn
-         * off all escaping, or specify HTML, so `<div>` will not be turned into `\<div>`
-         */
-        skipEscaping?: 'all' | 'html' | 'none';
-    } | {
-        type: 'mdx';
-    };
+    parser?: Parser;
 };
 export type RichTextTemplate<WithNamespace extends boolean = false> = Template<WithNamespace> & {
     inline?: boolean;
@@ -587,7 +596,7 @@ interface BaseCollection {
     name: string;
     path: string;
     indexes?: IndexType[];
-    format?: 'json' | 'md' | 'markdown' | 'mdx' | 'yaml' | 'yml' | 'toml';
+    format?: ContentFormat;
     ui?: UICollection;
     /**
      * @deprecated - use `ui.defaultItem` on the each `template` instead
@@ -596,7 +605,7 @@ interface BaseCollection {
     /**
      * This format will be used to parse the markdown frontmatter
      */
-    frontmatterFormat?: 'yaml' | 'toml' | 'json';
+    frontmatterFormat?: ContentFrontmatterFormat;
     /**
      * The delimiters used to parse the frontmatter.
      */

package/dist/util/normalizePath.d.ts

@@ -1 +1,9 @@
 export declare const normalizePath: (filepath: string) => string;
+/**
+ * Returns the given path such that:
+ * - The path separator is converted from '\' to '/' if necessary.
+ * - Duplicate '/' are removed
+ * - Leading and trailing '/' are cleared
+ * @param filepath Filepath to convert to its canonical form
+ */
+export declare const canonicalPath: (filepath: string) => string;

package/dist/validate/schema.d.ts

@@ -3,21 +3,21 @@ export declare const CollectionBaseSchema: z.ZodObject<{
     label: z.ZodOptional<z.ZodString>;
     name: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
     path: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
-    format: z.ZodOptional<z.ZodEnum<["json", "md", "markdown", "mdx", "toml", "yaml", "yml"]>>;
+    format: z.ZodOptional<z.ZodEnum<["mdx", "md", "markdown", "json", "yaml", "yml", "toml"]>>;
     isAuthCollection: z.ZodOptional<z.ZodBoolean>;
     isDetached: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     name?: string;
     label?: string;
     path?: string;
-    format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+    format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
     isDetached?: boolean;
     isAuthCollection?: boolean;
 }, {
     name?: string;
     label?: string;
     path?: string;
-    format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+    format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
     isDetached?: boolean;
     isAuthCollection?: boolean;
 }>;
@@ -26,90 +26,90 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         name: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
         path: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
-        format: z.ZodOptional<z.ZodEnum<["json", "md", "markdown", "mdx", "toml", "yaml", "yml"]>>;
+        format: z.ZodOptional<z.ZodEnum<["mdx", "md", "markdown", "json", "yaml", "yml", "toml"]>>;
         isAuthCollection: z.ZodOptional<z.ZodBoolean>;
         isDetached: z.ZodOptional<z.ZodBoolean>;
     }, {
-        fields: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodType<import("..").TinaField, z.ZodTypeDef, import("..").TinaField>, "many">>, import("..").TinaField[], import("..").TinaField[]>, import("..").TinaField[], import("..").TinaField[]>, import("..").TinaField[], import("..").TinaField[]>, import("..").TinaField[], import("..").TinaField[]>;
+        fields: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodType<import("../types/index").TinaField, z.ZodTypeDef, import("../types/index").TinaField>, "many">>, import("../types/index").TinaField[], import("../types/index").TinaField[]>, import("../types/index").TinaField[], import("../types/index").TinaField[]>, import("../types/index").TinaField[], import("../types/index").TinaField[]>, import("../types/index").TinaField[], import("../types/index").TinaField[]>;
         templates: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
             label: z.ZodString;
             name: z.ZodEffects<z.ZodString, string, string>;
-            fields: z.ZodArray<z.ZodType<import("..").TinaField, z.ZodTypeDef, import("..").TinaField>, "many">;
+            fields: z.ZodArray<z.ZodType<import("../types/index").TinaField, z.ZodTypeDef, import("../types/index").TinaField>, "many">;
         }, "strip", z.ZodTypeAny, {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }, {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }>, {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }, {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }>, "many">>, {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[], {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[]>;
     }>, "strip", z.ZodTypeAny, {
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }, {
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }>, {
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }, {
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }>, "many">;
@@ -237,13 +237,13 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }[];
@@ -275,13 +275,13 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }[];
@@ -313,13 +313,13 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }[];
@@ -351,13 +351,13 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "main": "dist/index.js",
   "module": "./dist/index.mjs",
   "exports": {
@@ -32,7 +32,7 @@
     "ts-jest": "^29.2.5",
     "typescript": "^5.7.3",
     "yup": "^0.32.11",
-    "@tinacms/scripts": "1.3.4"
+    "@tinacms/scripts": "1.3.5"
   },
   "peerDependencies": {
     "react": ">=16.14.0",