@tinacms/schema-tools 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @tinacms/schema-tools
 
+## 0.0.4
+
+### Patch Changes
+
+- 6e2ed31a2: Added `isTitle` property to the schema that allows the title to be displayed in the CMS
+
 ## 0.0.3
 
 ### Patch Changes

package/dist/index.js

@@ -185,6 +185,11 @@ function hasDuplicates(array) {
 var TinaSchema = class {
   constructor(config) {
     this.config = config;
+    this.getIsTitleFieldName = (collection) => {
+      const col = this.getCollection(collection);
+      const field = col == null ? void 0 : col.fields.find((x) => x.type === "string" && x.isTitle);
+      return field == null ? void 0 : field.name;
+    };
     this.getCollectionsByName = (collectionNames) => {
       return this.schema.collections.filter((collection) => collectionNames.includes(collection.name));
     };
@@ -533,7 +538,8 @@ var StringField = TinaScalerBase.extend({
   type: import_zod2.z.literal("string", {
     invalid_type_error: typeTypeError,
     required_error: typeRequiredError
-  })
+  }),
+  isTitle: import_zod2.z.boolean().optional()
 });
 var BooleanField = TinaScalerBase.extend({
   type: import_zod2.z.literal("boolean", {
@@ -621,6 +627,22 @@ var TinaFieldZod = import_zod2.z.lazy(() => {
       };
     }
   }).superRefine((val, ctx) => {
+    if (val.type === "string") {
+      if (val.isTitle) {
+        if (val.list) {
+          ctx.addIssue({
+            code: import_zod2.z.ZodIssueCode.custom,
+            message: "You can not have `list: true` when using `isTitle`"
+          });
+        }
+        if (!val.required) {
+          ctx.addIssue({
+            code: import_zod2.z.ZodIssueCode.custom,
+            message: "You must have { required: true } when using `isTitle`"
+          });
+        }
+      }
+    }
     if (val.type === "object") {
       const message = "Must provide one of templates or fields in your collection";
       let isValid = Boolean(val == null ? void 0 : val.templates) || Boolean(val == null ? void 0 : val.fields);
@@ -668,6 +690,11 @@ var TinaCloudCollectionBase = import_zod3.z.object({
 var TinaCloudCollection = TinaCloudCollectionBase.extend({
   fields: import_zod3.z.array(TinaFieldZod).min(1).optional().refine((val) => !hasDuplicates(val == null ? void 0 : val.map((x) => x.name)), {
     message: "Fields must have a unique name"
+  }).refine((val) => {
+    const arr = (val == null ? void 0 : val.filter((x) => x.type === "string" && x.isTitle)) || [];
+    return arr.length < 2;
+  }, {
+    message: "Fields can only have one use of `isTitle`"
   }),
   templates: import_zod3.z.array(Template).min(1).optional().refine((val) => !hasDuplicates(val == null ? void 0 : val.map((x) => x.name)), {
     message: "Templates must have a unique name"

package/dist/schema/TinaSchema.d.ts

@@ -41,6 +41,7 @@ export declare class TinaSchema {
         version?: Version;
         meta?: Meta;
     } & TinaCloudSchemaBase);
+    getIsTitleFieldName: (collection: string) => string;
     getCollectionsByName: (collectionNames: string[]) => TinaCloudCollection<true>[];
     getAllCollectionPaths: () => string[];
     getCollection: (collectionName: string) => TinaCloudCollection<true>;

package/dist/types/SchemaTypes.d.ts

@@ -108,11 +108,13 @@ declare type StringField = {
     type: 'string';
     isBody?: boolean;
     list?: false;
+    isTitle?: boolean;
     ui?: UIField<any, string>;
 } | {
     type: 'string';
     isBody?: boolean;
     list: true;
+    isTitle?: never;
     ui?: UIField<any, string[]>;
 };
 declare type BooleanField = {

package/dist/validate/schema.d.ts

@@ -17,7 +17,7 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         name: z.ZodString;
         format: z.ZodOptional<z.ZodEnum<["json", "md", "markdown", "mdx"]>>;
     }, {
-        fields: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodType<import("..").TinaFieldInner<false>, z.ZodTypeDef, import("..").TinaFieldInner<false>>, "many">>, import("..").TinaFieldInner<false>[], import("..").TinaFieldInner<false>[]>;
+        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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [