@tinacms/schema-tools 1.3.4 → 1.4.1

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export * from './types/index';
 export * from './validate';
 export * from './util/namer';
 export * from './util/parseURL';
+export * from './util/normalizePath';

package/dist/index.es.js

@@ -1,3 +1,4 @@
+import micromatch from "micromatch";
 import * as yup from "yup";
 import UrlPattern from "url-pattern";
 import z$1, { z, ZodError } from "zod";
@@ -143,14 +144,15 @@ const parseURL = (url) => {
       host: params.host
     };
   }
-  const pattern = new UrlPattern("/content/:clientId/github/*", {
-    escapeChar: " "
+  const pattern = new UrlPattern("/:v/content/:clientId/github/*", {
+    escapeChar: " ",
+    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/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,
@@ -159,6 +161,7 @@ const parseURL = (url) => {
     isLocalClient: false
   };
 };
+const normalizePath = (filepath) => filepath.replace(/\\/g, "/");
 class TinaSchema {
   constructor(config) {
     this.config = config;
@@ -171,10 +174,6 @@ class TinaSchema {
     this.getCollectionsByName = (collectionNames) => {
       return this.schema.collections.filter((collection) => collectionNames.includes(collection.name));
     };
-    this.getAllCollectionPaths = () => {
-      const paths = this.getCollections().map((collection) => `${collection.path}${collection.match || ""}`);
-      return paths;
-    };
     this.getCollection = (collectionName) => {
       const collection = this.schema.collections.find((collection2) => collection2.name === collectionName);
       if (!collection) {
@@ -201,7 +200,19 @@ class TinaSchema {
       return this.schema.collections.map((collection) => this.getCollection(collection.name)) || [];
     };
     this.getCollectionByFullPath = (filepath) => {
+      const fileExtension = filepath.split(".").pop();
       const possibleCollections = this.getCollections().filter((collection) => {
+        var _a, _b;
+        if (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 = micromatch([filepath], matches).length > 0;
+          if (!match) {
+            return false;
+          }
+        }
         return filepath.replace(/\\/g, "/").startsWith(collection.path.replace(/\/?$/, "/"));
       });
       if (possibleCollections.length === 0) {
@@ -357,7 +368,7 @@ class TinaSchema {
     };
     this.getTemplatesForCollectable = (collection) => {
       let extraFields = [];
-      if (collection.fields) {
+      if (collection == null ? void 0 : collection.fields) {
         const template = collection;
         if (typeof template.fields === "string" || typeof template.fields === "undefined") {
           throw new Error("Exptected template to have fields but none were found");
@@ -371,7 +382,7 @@ class TinaSchema {
           }
         };
       } else {
-        if (collection.templates) {
+        if (collection == null ? void 0 : collection.templates) {
           return {
             namespace: collection.namespace,
             type: "union",
@@ -388,7 +399,74 @@ class TinaSchema {
         }
       }
     };
+    this.walkFields = (cb) => {
+      const walk = (collectionOrObject, collection, path) => {
+        if (collectionOrObject.templates) {
+          collectionOrObject.templates.forEach((template) => {
+            template.fields.forEach((field) => {
+              cb({ field, collection, path: [...path, template.name] });
+            });
+          });
+        }
+        if (collectionOrObject.fields) {
+          collectionOrObject.fields.forEach((field) => {
+            cb({ field, collection, path: [...path, field.name] });
+            if (field.type === "rich-text" || field.type === "object") {
+              walk(field, collection, [...path, field.name]);
+            }
+          });
+        }
+      };
+      const collections = this.getCollections();
+      collections.forEach((collection) => walk(collection, collection, []));
+    };
     this.schema = config;
+    this.walkFields(({ field, collection, path }) => {
+      var _a;
+      if (field.type === "rich-text") {
+        if (field.parser) {
+          return;
+        }
+        if (collection.format === "mdx") {
+          field.parser = { type: "mdx" };
+        } else {
+          (_a = field.templates) == null ? void 0 : _a.forEach((template) => {
+            if (!template.match) {
+              console.warn(`WARNING: Found rich-text template at ${collection.name}.${path.join(".")} with no matches property.
+Visit https://tina.io/docs/reference/types/rich-text/#custom-shortcode-syntax to learn more
+                `);
+            }
+          });
+          field.parser = { type: "markdown" };
+        }
+      }
+    });
+  }
+  getMatches({
+    collection: collectionOrString
+  }) {
+    var _a, _b;
+    const collection = typeof collectionOrString === "string" ? this.getCollection(collectionOrString) : collectionOrString;
+    const normalPath = normalizePath(collection.path);
+    const format = collection.format || "md";
+    const matches = [];
+    if ((_a = collection == null ? void 0 : collection.match) == null ? void 0 : _a.include) {
+      const match = `${normalPath}/${collection.match.include}.${format}`;
+      matches.push(match);
+    }
+    if ((_b = collection == null ? void 0 : collection.match) == null ? void 0 : _b.exclude) {
+      const exclude = `!(${normalPath}/${collection.match.exclude}.${format})`;
+      matches.push(exclude);
+    }
+    return matches;
+  }
+  matchFiles({
+    collection,
+    files
+  }) {
+    const matches = this.getMatches({ collection });
+    const matchedFiles = micromatch(files, matches);
+    return matchedFiles;
   }
 }
 const resolveField = (field, schema) => {
@@ -925,4 +1003,4 @@ const validateSchema = ({ schema }) => {
     }
   }
 };
-export { NAMER, TINA_HOST, TinaSchema, TinaSchemaValidationError, addNamespaceToSchema, parseURL, resolveField, resolveForm, validateSchema, validateTinaCloudSchemaConfig };
+export { NAMER, TINA_HOST, TinaSchema, TinaSchemaValidationError, addNamespaceToSchema, normalizePath, parseURL, resolveField, resolveForm, validateSchema, validateTinaCloudSchemaConfig };

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("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 };
@@ -25,6 +25,7 @@
     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);
@@ -170,14 +171,15 @@
         host: params.host
       };
     }
-    const pattern = new UrlPattern__default["default"]("/content/:clientId/github/*", {
-      escapeChar: " "
+    const pattern = new UrlPattern__default["default"]("/:v/content/:clientId/github/*", {
+      escapeChar: " ",
+      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/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,
@@ -186,6 +188,7 @@
       isLocalClient: false
     };
   };
+  const normalizePath = (filepath) => filepath.replace(/\\/g, "/");
   class TinaSchema {
     constructor(config) {
       this.config = config;
@@ -198,10 +201,6 @@
       this.getCollectionsByName = (collectionNames) => {
         return this.schema.collections.filter((collection) => collectionNames.includes(collection.name));
       };
-      this.getAllCollectionPaths = () => {
-        const paths = this.getCollections().map((collection) => `${collection.path}${collection.match || ""}`);
-        return paths;
-      };
       this.getCollection = (collectionName) => {
         const collection = this.schema.collections.find((collection2) => collection2.name === collectionName);
         if (!collection) {
@@ -228,7 +227,19 @@
         return this.schema.collections.map((collection) => this.getCollection(collection.name)) || [];
       };
       this.getCollectionByFullPath = (filepath) => {
+        const fileExtension = filepath.split(".").pop();
         const possibleCollections = this.getCollections().filter((collection) => {
+          var _a, _b;
+          if (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 = micromatch__default["default"]([filepath], matches).length > 0;
+            if (!match) {
+              return false;
+            }
+          }
           return filepath.replace(/\\/g, "/").startsWith(collection.path.replace(/\/?$/, "/"));
         });
         if (possibleCollections.length === 0) {
@@ -384,7 +395,7 @@
       };
       this.getTemplatesForCollectable = (collection) => {
         let extraFields = [];
-        if (collection.fields) {
+        if (collection == null ? void 0 : collection.fields) {
           const template = collection;
           if (typeof template.fields === "string" || typeof template.fields === "undefined") {
             throw new Error("Exptected template to have fields but none were found");
@@ -398,7 +409,7 @@
             }
           };
         } else {
-          if (collection.templates) {
+          if (collection == null ? void 0 : collection.templates) {
             return {
               namespace: collection.namespace,
               type: "union",
@@ -415,7 +426,74 @@
           }
         }
       };
+      this.walkFields = (cb) => {
+        const walk = (collectionOrObject, collection, path) => {
+          if (collectionOrObject.templates) {
+            collectionOrObject.templates.forEach((template) => {
+              template.fields.forEach((field) => {
+                cb({ field, collection, path: [...path, template.name] });
+              });
+            });
+          }
+          if (collectionOrObject.fields) {
+            collectionOrObject.fields.forEach((field) => {
+              cb({ field, collection, path: [...path, field.name] });
+              if (field.type === "rich-text" || field.type === "object") {
+                walk(field, collection, [...path, field.name]);
+              }
+            });
+          }
+        };
+        const collections = this.getCollections();
+        collections.forEach((collection) => walk(collection, collection, []));
+      };
       this.schema = config;
+      this.walkFields(({ field, collection, path }) => {
+        var _a;
+        if (field.type === "rich-text") {
+          if (field.parser) {
+            return;
+          }
+          if (collection.format === "mdx") {
+            field.parser = { type: "mdx" };
+          } else {
+            (_a = field.templates) == null ? void 0 : _a.forEach((template) => {
+              if (!template.match) {
+                console.warn(`WARNING: Found rich-text template at ${collection.name}.${path.join(".")} with no matches property.
+Visit https://tina.io/docs/reference/types/rich-text/#custom-shortcode-syntax to learn more
+                `);
+              }
+            });
+            field.parser = { type: "markdown" };
+          }
+        }
+      });
+    }
+    getMatches({
+      collection: collectionOrString
+    }) {
+      var _a, _b;
+      const collection = typeof collectionOrString === "string" ? this.getCollection(collectionOrString) : collectionOrString;
+      const normalPath = normalizePath(collection.path);
+      const format = collection.format || "md";
+      const matches = [];
+      if ((_a = collection == null ? void 0 : collection.match) == null ? void 0 : _a.include) {
+        const match = `${normalPath}/${collection.match.include}.${format}`;
+        matches.push(match);
+      }
+      if ((_b = collection == null ? void 0 : collection.match) == null ? void 0 : _b.exclude) {
+        const exclude = `!(${normalPath}/${collection.match.exclude}.${format})`;
+        matches.push(exclude);
+      }
+      return matches;
+    }
+    matchFiles({
+      collection,
+      files
+    }) {
+      const matches = this.getMatches({ collection });
+      const matchedFiles = micromatch__default["default"](files, matches);
+      return matchedFiles;
     }
   }
   const resolveField = (field, schema) => {
@@ -957,6 +1035,7 @@ ${JSON.stringify(val, null, 2)}
   exports2.TinaSchema = TinaSchema;
   exports2.TinaSchemaValidationError = TinaSchemaValidationError;
   exports2.addNamespaceToSchema = addNamespaceToSchema;
+  exports2.normalizePath = normalizePath;
   exports2.parseURL = parseURL;
   exports2.resolveField = resolveField;
   exports2.resolveForm = resolveForm;

package/dist/schema/TinaSchema.d.ts

@@ -1,4 +1,4 @@
-import { Schema, Collection, Template, Collectable, CollectionTemplateable } from '../types/index';
+import { Schema, Collection, Template, Collectable, CollectionTemplateable, TinaField } from '../types/index';
 declare type Version = {
     fullVersion: string;
     major: string;
@@ -28,7 +28,6 @@ export declare class TinaSchema {
     } & Schema);
     getIsTitleFieldName: (collection: string) => string;
     getCollectionsByName: (collectionNames: string[]) => Collection<true>[];
-    getAllCollectionPaths: () => string[];
     getCollection: (collectionName: string) => Collection<true>;
     getCollections: () => Collection<true>[];
     getCollectionByFullPath: (filepath: string) => Collection<true>;
@@ -60,5 +59,23 @@ export declare class TinaSchema {
      *
      */
     getTemplatesForCollectable: (collection: Collectable) => CollectionTemplateable;
+    walkFields: (cb: (args: {
+        field: TinaField;
+        collection: Collection;
+        path: string[];
+    }) => void) => void;
+    /**
+     * 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, }: {
+        collection: string | Collection;
+    }): string[];
+    matchFiles({ collection, files, }: {
+        collection: string | Collection;
+        files: string[];
+    }): string[];
 }
 export {};

package/dist/types/index.d.ts

@@ -344,6 +344,10 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
      * Configurations for the autogenerated GraphQL HTTP client
      */
     client?: {
+        /**
+         * Skip building the autogenerated client
+         */
+        skip?: boolean;
         /**
          * Autogenerated queries will traverse references to a given depth
          * @default 2
@@ -467,7 +471,10 @@ interface BaseCollection {
      * The delimiters used to parse the frontmatter.
      */
     frontmatterDelimiters?: [string, string] | string;
-    match?: string;
+    match?: {
+        include?: string;
+        exclude?: string;
+    };
 }
 declare type TemplateCollection<WithNamespace extends boolean = false> = {
     /**

package/dist/util/normalizePath.d.ts

@@ -0,0 +1 @@
+export declare const normalizePath: (filepath: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "1.3.4",
+  "version": "1.4.1",
   "main": "dist/index.js",
   "module": "./dist/index.es.js",
   "exports": {
@@ -23,7 +23,8 @@
     ]
   },
   "devDependencies": {
-    "@tinacms/scripts": "1.0.4",
+    "@tinacms/scripts": "1.1.0",
+    "@types/micromatch": "^4.0.2",
     "@types/yup": "^0.29.10",
     "jest": "^27.0.6",
     "react": "17.0.2",
@@ -42,6 +43,7 @@
     "directory": "packages/@tinacms/cli"
   },
   "dependencies": {
+    "micromatch": "4.0.5",
     "url-pattern": "^1.0.3",
     "zod": "^3.14.3"
   },