@tinacms/schema-tools 1.3.1 → 1.3.3

package/dist/index.es.js

@@ -200,14 +200,6 @@ class TinaSchema {
     this.getCollections = () => {
       return this.schema.collections.map((collection) => this.getCollection(collection.name)) || [];
     };
-    this.getGlobalTemplate = (templateName) => {
-      var _a;
-      const globalTemplate = (_a = this.schema.templates) == null ? void 0 : _a.find((template) => template.name === templateName);
-      if (!globalTemplate) {
-        throw new Error(`Expected to find global template of name ${templateName}`);
-      }
-      return globalTemplate;
-    };
     this.getCollectionByFullPath = (filepath) => {
       const possibleCollections = this.getCollections().filter((collection) => {
         return filepath.replace(/\\/g, "/").startsWith(collection.path.replace(/\/?$/, "/"));
@@ -365,11 +357,8 @@ class TinaSchema {
     };
     this.getTemplatesForCollectable = (collection) => {
       let extraFields = [];
-      if (collection.references) {
-        extraFields = collection.references;
-      }
       if (collection.fields) {
-        const template = typeof collection.fields === "string" ? this.getGlobalTemplate(collection.fields) : collection;
+        const template = collection;
         if (typeof template.fields === "string" || typeof template.fields === "undefined") {
           throw new Error("Exptected template to have fields but none were found");
         }
@@ -387,7 +376,7 @@ class TinaSchema {
             namespace: collection.namespace,
             type: "union",
             templates: collection.templates.map((templateOrTemplateString) => {
-              const template = typeof templateOrTemplateString === "string" ? this.getGlobalTemplate(templateOrTemplateString) : templateOrTemplateString;
+              const template = templateOrTemplateString;
               return {
                 ...template,
                 fields: [...template.fields, ...extraFields]
@@ -404,7 +393,6 @@ class TinaSchema {
 }
 const resolveField = (field, schema) => {
   var _a;
-  field.parentTypename = NAMER.dataTypeName(field.namespace.filter((_, i) => i < field.namespace.length - 1));
   const extraFields = field.ui || {};
   switch (field.type) {
     case "number":
@@ -586,9 +574,24 @@ 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`
-}));
+}).superRefine((val, ctx) => {
+  if (val.match(/^[a-zA-Z0-9_]*$/) === null) {
+    ctx.addIssue({
+      code: "custom",
+      message: `name, "${val}" must be alphanumeric and can only contain underscores. (No spaces, dashes, special characters, etc.)
+If you only want to display this value in the CMS UI, you can use the label property to customize it.
+
+If you need to use this value in your content you can use the \`nameOverride\` property to customize the value. For example:
+\`\`\`
+{
+  "name": ${val.replace(/[^a-zA-Z0-9]/g, "_")},
+  "nameOverride": ${val},
+  // ...
+}
+\`\`\``
+    });
+  }
+});
 const TypeName = [
   "string",
   "boolean",
@@ -601,17 +604,6 @@ const TypeName = [
 ];
 const typeTypeError = `type must be one of ${TypeName.join(", ")}`;
 const typeRequiredError = `type is required and must be one of ${TypeName.join(", ")}`;
-const nameProp = z.string({
-  required_error: "name must be provided",
-  invalid_type_error: "name must be a sting"
-}).superRefine((val, ctx) => {
-  if (val.includes(" "))
-    ctx.addIssue({
-      message: `name "${val}" cannot contain spaces`,
-      code: z.ZodIssueCode.custom,
-      fatal: true
-    });
-});
 const Option = z.union([
   z.string(),
   z.object({ label: z.string(), value: z.string() }),
@@ -624,7 +616,7 @@ const Option = z.union([
   }
 });
 const TinaField = z.object({
-  name: nameProp,
+  name,
   label: z.string().or(z.boolean()).optional(),
   description: z.string().optional(),
   required: z.boolean().optional()
@@ -675,7 +667,7 @@ const ReferenceField = FieldWithList.extend({
 const TinaFieldZod = z.lazy(() => {
   const TemplateTemp = z.object({
     label: z.string().optional(),
-    name: nameProp,
+    name,
     fields: z.array(TinaFieldZod),
     match: z.object({
       start: z.string(),
@@ -836,7 +828,7 @@ const Template = z.object({
     });
   }
 });
-const TinaCloudCollectionBase = z.object({
+const CollectionBaseSchema = z.object({
   label: z.string().optional(),
   name: name.superRefine((val, ctx) => {
     if (val === "relativePath") {
@@ -846,9 +838,10 @@ const TinaCloudCollectionBase = z.object({
       });
     }
   }),
+  path: z.string().transform((val) => val.replace(/^\/|\/$/g, "")),
   format: z.enum(FORMATS).optional()
 });
-const TinaCloudCollection = TinaCloudCollectionBase.extend({
+const TinaCloudCollection = CollectionBaseSchema.extend({
   fields: z.array(TinaFieldZod).min(1).optional().superRefine((val, ctx) => {
     const dups = findDuplicates(val == null ? void 0 : val.map((x) => x.name));
     if (dups) {
@@ -910,9 +903,7 @@ class TinaSchemaValidationError extends Error {
     this.name = "TinaSchemaValidationError";
   }
 }
-const validateSchema = ({
-  schema
-}) => {
+const validateSchema = ({ schema }) => {
   try {
     TinaCloudSchemaZod.parse(schema);
   } catch (e) {

package/dist/index.js

@@ -227,14 +227,6 @@
       this.getCollections = () => {
         return this.schema.collections.map((collection) => this.getCollection(collection.name)) || [];
       };
-      this.getGlobalTemplate = (templateName) => {
-        var _a;
-        const globalTemplate = (_a = this.schema.templates) == null ? void 0 : _a.find((template) => template.name === templateName);
-        if (!globalTemplate) {
-          throw new Error(`Expected to find global template of name ${templateName}`);
-        }
-        return globalTemplate;
-      };
       this.getCollectionByFullPath = (filepath) => {
         const possibleCollections = this.getCollections().filter((collection) => {
           return filepath.replace(/\\/g, "/").startsWith(collection.path.replace(/\/?$/, "/"));
@@ -392,11 +384,8 @@
       };
       this.getTemplatesForCollectable = (collection) => {
         let extraFields = [];
-        if (collection.references) {
-          extraFields = collection.references;
-        }
         if (collection.fields) {
-          const template = typeof collection.fields === "string" ? this.getGlobalTemplate(collection.fields) : collection;
+          const template = collection;
           if (typeof template.fields === "string" || typeof template.fields === "undefined") {
             throw new Error("Exptected template to have fields but none were found");
           }
@@ -414,7 +403,7 @@
               namespace: collection.namespace,
               type: "union",
               templates: collection.templates.map((templateOrTemplateString) => {
-                const template = typeof templateOrTemplateString === "string" ? this.getGlobalTemplate(templateOrTemplateString) : templateOrTemplateString;
+                const template = templateOrTemplateString;
                 return {
                   ...template,
                   fields: [...template.fields, ...extraFields]
@@ -431,7 +420,6 @@
   }
   const resolveField = (field, schema) => {
     var _a;
-    field.parentTypename = NAMER.dataTypeName(field.namespace.filter((_, i) => i < field.namespace.length - 1));
     const extraFields = field.ui || {};
     switch (field.type) {
       case "number":
@@ -613,9 +601,24 @@
   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`
-  }));
+  }).superRefine((val, ctx) => {
+    if (val.match(/^[a-zA-Z0-9_]*$/) === null) {
+      ctx.addIssue({
+        code: "custom",
+        message: `name, "${val}" must be alphanumeric and can only contain underscores. (No spaces, dashes, special characters, etc.)
+If you only want to display this value in the CMS UI, you can use the label property to customize it.
+
+If you need to use this value in your content you can use the \`nameOverride\` property to customize the value. For example:
+\`\`\`
+{
+  "name": ${val.replace(/[^a-zA-Z0-9]/g, "_")},
+  "nameOverride": ${val},
+  // ...
+}
+\`\`\``
+      });
+    }
+  });
   const TypeName = [
     "string",
     "boolean",
@@ -628,17 +631,6 @@
   ];
   const typeTypeError = `type must be one of ${TypeName.join(", ")}`;
   const typeRequiredError = `type is required and must be one of ${TypeName.join(", ")}`;
-  const nameProp = z.z.string({
-    required_error: "name must be provided",
-    invalid_type_error: "name must be a sting"
-  }).superRefine((val, ctx) => {
-    if (val.includes(" "))
-      ctx.addIssue({
-        message: `name "${val}" cannot contain spaces`,
-        code: z.z.ZodIssueCode.custom,
-        fatal: true
-      });
-  });
   const Option = z.z.union([
     z.z.string(),
     z.z.object({ label: z.z.string(), value: z.z.string() }),
@@ -651,7 +643,7 @@
     }
   });
   const TinaField = z.z.object({
-    name: nameProp,
+    name,
     label: z.z.string().or(z.z.boolean()).optional(),
     description: z.z.string().optional(),
     required: z.z.boolean().optional()
@@ -702,7 +694,7 @@
   const TinaFieldZod = z.z.lazy(() => {
     const TemplateTemp = z.z.object({
       label: z.z.string().optional(),
-      name: nameProp,
+      name,
       fields: z.z.array(TinaFieldZod),
       match: z.z.object({
         start: z.z.string(),
@@ -863,7 +855,7 @@ ${JSON.stringify(val, null, 2)}
       });
     }
   });
-  const TinaCloudCollectionBase = z.z.object({
+  const CollectionBaseSchema = z.z.object({
     label: z.z.string().optional(),
     name: name.superRefine((val, ctx) => {
       if (val === "relativePath") {
@@ -873,9 +865,10 @@ ${JSON.stringify(val, null, 2)}
         });
       }
     }),
+    path: z.z.string().transform((val) => val.replace(/^\/|\/$/g, "")),
     format: z.z.enum(FORMATS).optional()
   });
-  const TinaCloudCollection = TinaCloudCollectionBase.extend({
+  const TinaCloudCollection = CollectionBaseSchema.extend({
     fields: z.z.array(TinaFieldZod).min(1).optional().superRefine((val, ctx) => {
       const dups = findDuplicates(val == null ? void 0 : val.map((x) => x.name));
       if (dups) {
@@ -937,9 +930,7 @@ ${JSON.stringify(val, null, 2)}
       this.name = "TinaSchemaValidationError";
     }
   }
-  const validateSchema = ({
-    schema
-  }) => {
+  const validateSchema = ({ schema }) => {
     try {
       TinaCloudSchemaZod.parse(schema);
     } catch (e) {

package/dist/schema/TinaSchema.d.ts

@@ -1,7 +1,4 @@
-/**
-
-*/
-import { TinaCloudSchemaEnriched, TinaCloudSchemaBase, TinaCloudCollection, Templateable, Collectable, CollectionTemplateable } from '../types/index';
+import { Schema, Collection, Template, Collectable, CollectionTemplateable } from '../types/index';
 declare type Version = {
     fullVersion: string;
     major: string;
@@ -20,39 +17,29 @@ export declare class TinaSchema {
     config: {
         version?: Version;
         meta?: Meta;
-    } & TinaCloudSchemaBase;
-    schema: TinaCloudSchemaEnriched;
+    } & Schema;
+    schema: Schema<true>;
     /**
-     *
      * Create a schema class from a user defined schema object
-     *
-     * @param  {{version?:Version;meta?:Meta}&TinaCloudSchemaBase} config
      */
     constructor(config: {
         version?: Version;
         meta?: Meta;
-    } & TinaCloudSchemaBase);
+    } & Schema);
     getIsTitleFieldName: (collection: string) => string;
-    getCollectionsByName: (collectionNames: string[]) => TinaCloudCollection<true>[];
+    getCollectionsByName: (collectionNames: string[]) => Collection<true>[];
     getAllCollectionPaths: () => string[];
-    getCollection: (collectionName: string) => TinaCloudCollection<true>;
-    getCollections: () => TinaCloudCollection<true>[];
-    getGlobalTemplate: (templateName: string) => {
-        label: string;
-        name: string;
-        ui?: import("../types/SchemaTypes").UICollection;
-        fields: import("../types/SchemaTypes").TinaFieldInner<true>[];
-        namespace: string[];
-    };
-    getCollectionByFullPath: (filepath: string) => TinaCloudCollection<true>;
+    getCollection: (collectionName: string) => Collection<true>;
+    getCollections: () => Collection<true>[];
+    getCollectionByFullPath: (filepath: string) => Collection<true>;
     getCollectionAndTemplateByFullPath: (filepath: string, templateName?: string) => {
-        collection: TinaCloudCollection<true>;
-        template: Templateable;
+        collection: Collection<true>;
+        template: Template<true>;
     };
     getTemplateForData: ({ data, collection, }: {
         data?: unknown;
         collection: Collectable;
-    }) => Templateable;
+    }) => Template<true>;
     transformPayload: (collectionName: string, payload: object) => {
         [x: string]: {
             [x: string]: {};

package/dist/schema/resolveField.d.ts

@@ -1,20 +1,14 @@
 /**
 
 */
-import { TinaFieldEnriched } from '../types/index';
+import { TinaField } from '../types/index';
 import { TinaSchema } from './TinaSchema';
 /**
- *
  * Turns a field the schema (schema.{js,ts} file) into a valid front end FieldConfig
- *
- *
- * @param  {TinaFieldEnriched} field. The field that will be transformed
- * @param  {TinaSchema} schema the entireT Tina Schema
- * @returns unknown
  */
-export declare const resolveField: (field: TinaFieldEnriched, schema: TinaSchema) => {
+export declare const resolveField: (field: TinaField<true>, schema: TinaSchema) => {
     [key: string]: unknown;
     name: string;
-    component: string;
+    component: TinaField<true>['ui']['component'];
     type: string;
 };

package/dist/schema/resolveForm.d.ts

@@ -1,7 +1,8 @@
 /**
 
 */
-import type { ResolveFormArgs } from '../types/index';
+import type { Template, Collection } from '../types/index';
+import type { TinaSchema } from './TinaSchema';
 /**
  *  Given a collection, basename, template and schema. This will transform the given information into a valid frontend form config
  */
@@ -12,7 +13,156 @@ export declare const resolveForm: ({ collection, basename, template, schema, }:
     fields: {
         [key: string]: unknown;
         name: string;
-        component: string;
+        component: string | ((props: {
+            field: import("../types/index").TinaField<false> & {
+                namespace: string[];
+            };
+            input: {
+                name: string;
+                onBlur: (event?: any) => void;
+                onChange: (event: any) => void;
+                onFocus: (event?: any) => void;
+                type?: string;
+                value: string[];
+            };
+            meta: {
+                active?: boolean;
+                dirty?: boolean;
+                error?: any;
+            };
+        }) => any) | ((props: {
+            field: import("../types/index").TinaField<false> & {
+                namespace: string[];
+            };
+            input: {
+                name: string;
+                onBlur: (event?: any) => void;
+                onChange: (event: any) => void;
+                onFocus: (event?: any) => void;
+                type?: string;
+                value: number[];
+            };
+            meta: {
+                active?: boolean;
+                dirty?: boolean;
+                error?: any;
+            };
+        }) => any) | ((props: {
+            field: import("../types/index").TinaField<false> & {
+                namespace: string[];
+            };
+            input: {
+                name: string;
+                onBlur: (event?: any) => void;
+                onChange: (event: any) => void;
+                onFocus: (event?: any) => void;
+                type?: string;
+                value: boolean[];
+            };
+            meta: {
+                active?: boolean;
+                dirty?: boolean;
+                error?: any;
+            };
+        }) => any) | ((props: {
+            field: import("../types/index").TinaField<false> & {
+                namespace: string[];
+            };
+            input: {
+                name: string;
+                onBlur: (event?: any) => void;
+                onChange: (event: any) => void;
+                onFocus: (event?: any) => void;
+                type?: string;
+                value: {
+                    type: "root";
+                    children: Record<string, unknown>[];
+                }[];
+            };
+            meta: {
+                active?: boolean;
+                dirty?: boolean;
+                error?: any;
+            };
+        }) => any) | ((props: {
+            field: import("../types/index").TinaField<false> & {
+                namespace: string[];
+            };
+            input: {
+                name: string;
+                onBlur: (event?: any) => void;
+                onChange: (event: any) => void;
+                onFocus: (event?: any) => void;
+                type?: string;
+                value: string;
+            };
+            meta: {
+                active?: boolean;
+                dirty?: boolean;
+                error?: any;
+            };
+        }) => any) | ((props: {
+            field: import("../types/index").TinaField<false> & {
+                namespace: string[];
+            };
+            input: {
+                name: string;
+                onBlur: (event?: any) => void;
+                onChange: (event: any) => void;
+                onFocus: (event?: any) => void;
+                type?: string;
+                value: number;
+            };
+            meta: {
+                active?: boolean;
+                dirty?: boolean;
+                error?: any;
+            };
+        }) => any) | ((props: {
+            field: import("../types/index").TinaField<false> & {
+                namespace: string[];
+            };
+            input: {
+                name: string;
+                onBlur: (event?: any) => void;
+                onChange: (event: any) => void;
+                onFocus: (event?: any) => void;
+                type?: string;
+                value: boolean;
+            };
+            meta: {
+                active?: boolean;
+                dirty?: boolean;
+                error?: any;
+            };
+        }) => any) | ((props: {
+            field: import("../types/index").TinaField<false> & {
+                namespace: string[];
+            };
+            input: {
+                name: string;
+                onBlur: (event?: any) => void;
+                onChange: (event: any) => void;
+                onFocus: (event?: any) => void;
+                type?: string;
+                value: {
+                    type: "root";
+                    children: Record<string, unknown>[];
+                };
+            };
+            meta: {
+                active?: boolean;
+                dirty?: boolean;
+                error?: any;
+            };
+        }) => any);
         type: string;
     }[];
 };
+declare type ResolveFormArgs = {
+    collection: Collection<true>;
+    basename: string;
+    template: Template<true>;
+    schema: TinaSchema;
+};
+export {};