@tinacms/schema-tools 2.7.1 → 2.7.2

package/dist/index.js

@@ -2255,6 +2255,12 @@ const resolveField = (field, schema) => {
         component: "reference",
         ...extraFields
       };
+    case "displayOnly":
+      return {
+        component: "displayOnly",
+        ...field,
+        ...extraFields
+      };
     default:
       throw new Error(`Unknown field type ${field.type}`);
   }
@@ -2343,7 +2349,8 @@ const TypeName = [
   "image",
   "object",
   "reference",
-  "rich-text"
+  "rich-text",
+  "displayOnly"
 ];
 const formattedTypes = `  - ${TypeName.join("\n  - ")}`;
 const typeTypeError = `Invalid \`type\` property. \`type\` expected to be one of the following values:
@@ -2415,6 +2422,27 @@ const DateTimeField = TinaScalerBase.extend({
   dateFormat: z.string().optional(),
   timeFormat: z.string().optional()
 });
+const DisplayOnlyField = TinaField.omit({ required: true }).extend({
+  type: z.literal("displayOnly", {
+    invalid_type_error: typeTypeError,
+    required_error: typeRequiredError
+  }),
+  list: z.literal(void 0, {
+    errorMap: () => ({
+      message: "Property `list` is not allowed on fields of `type: displayOnly`."
+    })
+  }).optional(),
+  required: z.literal(void 0, {
+    errorMap: () => ({
+      message: "Property `required` is not allowed on fields of `type: displayOnly`."
+    })
+  }).optional(),
+  indexed: z.literal(void 0, {
+    errorMap: () => ({
+      message: "Property `indexed` is not allowed on fields of `type: displayOnly`."
+    })
+  }).optional()
+});
 const ReferenceField = FieldWithList.extend({
   type: z.literal("reference", {
     invalid_type_error: typeTypeError,
@@ -2491,7 +2519,8 @@ const TinaFieldZod = z.lazy(() => {
       ReferenceField,
       ObjectField,
       RichTextField,
-      PasswordField
+      PasswordField,
+      DisplayOnlyField
     ],
     {
       errorMap: (issue, ctx) => {

package/dist/types/index.d.ts

@@ -245,6 +245,15 @@ export type ReferenceField = (FieldGeneric<string, undefined, ReferenceFieldOpti
 export type PasswordField = (FieldGeneric<string, undefined> | FieldGeneric<string, false>) & BaseField & {
     type: 'password';
 };
+export type DisplayOnlyField = BaseField & {
+    type: 'displayOnly';
+    list?: never;
+    required?: never;
+    indexed?: never;
+    ui?: {
+        component?: FC<any> | null;
+    };
+};
 export type ToolbarOverrideType = 'heading' | 'link' | 'image' | 'quote' | 'ul' | 'ol' | 'code' | 'codeBlock' | 'bold' | 'italic' | 'strikethrough' | 'highlight' | 'raw' | 'embed' | 'mermaid' | 'table' | 'hr';
 type RichTextAst = {
     type: 'root';
@@ -320,7 +329,7 @@ export type ObjectField<WithNamespace extends boolean = false> = (FieldGeneric<s
     templates: Template<WithNamespace>[];
     templateKey?: string;
 });
-type Field<WithNamespace extends boolean = false> = (StringField | NumberField | BooleanField | DateTimeField | ImageField | ReferenceField | RichTextField<WithNamespace> | ObjectField<WithNamespace> | PasswordField) & MaybeNamespace<WithNamespace>;
+type Field<WithNamespace extends boolean = false> = (StringField | NumberField | BooleanField | DateTimeField | ImageField | ReferenceField | RichTextField<WithNamespace> | ObjectField<WithNamespace> | PasswordField | DisplayOnlyField) & MaybeNamespace<WithNamespace>;
 export type TinaField<WithNamespace extends boolean = false> = Field<WithNamespace> & MaybeNamespace<WithNamespace>;
 type MaybeNamespace<WithNamespace extends boolean = false> = WithNamespace extends true ? {
     namespace: string[];
@@ -659,7 +668,7 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
          * @example
          *s
          * historyUrl: ({ relativePath, branch }) => ({
-         *   url: `https://github.com/tinacms/tinacms/commits/${branch}/examples/next-2024/${relativePath}`
+         *   url: `https://github.com/tinacms/tinacms/commits/${branch}/examples/next/kitchen-sink/${relativePath}`
          * })
          *      */
         historyUrl?: (context: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tinacms/schema-tools",
   "type": "module",
-  "version": "2.7.1",
+  "version": "2.7.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [