@tinacms/schema-tools 0.1.0 → 0.1.1

package/dist/index.es.js

@@ -7,6 +7,9 @@ function addNamespaceToSchema(maybeNode, namespace = []) {
   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) => {
@@ -169,12 +172,7 @@ class TinaSchema {
     };
     this.getCollectionAndTemplateByFullPath = (filepath, templateName) => {
       let template;
-      const collection = this.getCollections().find((collection2) => {
-        return filepath.replace("\\", "/").startsWith(collection2.path);
-      });
-      if (!collection) {
-        throw new Error(`Unable to find collection for file at ${filepath}`);
-      }
+      const collection = this.getCollectionByFullPath(filepath);
       const templates = this.getTemplatesForCollectable(collection);
       if (templates.type === "union") {
         if (templateName) {
@@ -438,7 +436,9 @@ const parseZodError = ({ zodError }) => {
 const name = z.string({
   required_error: "Name is required but not provided",
   invalid_type_error: "Name must be a string"
-});
+}).refine((val) => val.match(/^[a-zA-Z0-9_]*$/) !== null, (val) => ({
+  message: `name, "${val}" must be alphanumeric and can only contain underscores`
+}));
 const TypeName = [
   "string",
   "boolean",

package/dist/index.js

@@ -34,6 +34,9 @@
     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) => {
@@ -196,12 +199,7 @@
       };
       this.getCollectionAndTemplateByFullPath = (filepath, templateName) => {
         let template;
-        const collection = this.getCollections().find((collection2) => {
-          return filepath.replace("\\", "/").startsWith(collection2.path);
-        });
-        if (!collection) {
-          throw new Error(`Unable to find collection for file at ${filepath}`);
-        }
+        const collection = this.getCollectionByFullPath(filepath);
         const templates = this.getTemplatesForCollectable(collection);
         if (templates.type === "union") {
           if (templateName) {
@@ -465,7 +463,9 @@
   const name = z.z.string({
     required_error: "Name is required but not provided",
     invalid_type_error: "Name must be a string"
-  });
+  }).refine((val) => val.match(/^[a-zA-Z0-9_]*$/) !== null, (val) => ({
+    message: `name, "${val}" must be alphanumeric and can only contain underscores`
+  }));
   const TypeName = [
     "string",
     "boolean",

package/dist/types/SchemaTypes.d.ts

@@ -44,11 +44,46 @@ export declare type TinaCloudCollection<WithNamespace extends boolean> = Collect
 export declare type TinaCloudCollectionBase = TinaCloudCollection<false>;
 export declare type TinaCloudCollectionEnriched = TinaCloudCollection<true>;
 declare type FormatType = 'json' | 'md' | 'markdown' | 'mdx';
+declare type Document = {
+    _sys: {
+        title?: string;
+        template: string;
+        breadcrumbs: string[];
+        path: string;
+        basename: string;
+        relativePath: string;
+        filename: string;
+        extension: string;
+    };
+};
 interface BaseCollection {
     label?: string;
     name: string;
     path: string;
     format?: FormatType;
+    ui?: {
+        /**
+         * Forms for this collection will be editable from the global sidebar rather than the form panel
+         */
+        global?: boolean | {
+            icon?: any;
+            layout: 'fullscreen' | 'popup';
+        };
+        /**
+         * Provide the path that your document is viewable on your site
+         *
+         * eg:
+         * ```ts
+         * router: ({ document }) => {
+         *   return `blog-posts/${document._sys.filename}`;
+         * }
+         * ```
+         */
+        router?: (args: {
+            document: Document;
+            collection: TinaCloudCollection<true>;
+        }) => string | undefined;
+    };
     match?: string;
 }
 declare type CollectionTemplates<WithNamespace extends boolean> = WithNamespace extends true ? CollectionTemplatesWithNamespace<WithNamespace> : CollectionTemplatesInner<WithNamespace>;

package/dist/validate/properties.d.ts

@@ -11,4 +11,4 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 import { z } from 'zod';
-export declare const name: z.ZodString;
+export declare const name: z.ZodEffects<z.ZodString, string, string>;

package/dist/validate/schema.d.ts

@@ -14,13 +14,13 @@ import { z } from 'zod';
 export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
     collections: z.ZodArray<z.ZodEffects<z.ZodObject<z.extendShape<{
         label: z.ZodOptional<z.ZodString>;
-        name: z.ZodString;
+        name: z.ZodEffects<z.ZodString, string, string>;
         format: z.ZodOptional<z.ZodEnum<["json", "md", "markdown", "mdx"]>>;
     }, {
         fields: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodType<import("..").TinaFieldInner<false>, z.ZodTypeDef, import("..").TinaFieldInner<false>>, "many">>, import("..").TinaFieldInner<false>[], import("..").TinaFieldInner<false>[]>, import("..").TinaFieldInner<false>[], import("..").TinaFieldInner<false>[]>;
         templates: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
             label: z.ZodString;
-            name: z.ZodString;
+            name: z.ZodEffects<z.ZodString, string, string>;
             fields: z.ZodArray<z.ZodType<import("..").TinaFieldInner<false>, z.ZodTypeDef, import("..").TinaFieldInner<false>>, "many">;
         }, "strip", z.ZodTypeAny, {
             name?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "main": "dist/index.js",
   "module": "./dist/index.es.js",
   "exports": {
@@ -23,7 +23,7 @@
     ]
   },
   "devDependencies": {
-    "@tinacms/scripts": "0.51.0",
+    "@tinacms/scripts": "0.51.1",
     "@types/yup": "^0.29.10",
     "jest": "^27.0.6",
     "react": "17.0.2",