@tinacms/schema-tools 0.0.3 → 0.0.6

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @tinacms/schema-tools
 
+## 0.0.6
+
+### Patch Changes
+
+- fb73fb355: Renames syncFolder to a mediaRoot when configuring Repo-Based Media
+
+## 0.0.5
+
+### Patch Changes
+
+- f6cb634c2: Added an optional config key to the schema that will be used for tina cloud media store
+
+## 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

@@ -58,7 +58,8 @@ __export(exports, {
   addNamespaceToSchema: () => addNamespaceToSchema,
   resolveField: () => resolveField,
   resolveForm: () => resolveForm,
-  validateSchema: () => validateSchema
+  validateSchema: () => validateSchema,
+  validateTinaCloudSchemaConfig: () => validateTinaCloudSchemaConfig
 });
 
 // pnp:/home/runner/work/tinacms/tinacms/packages/@tinacms/schema-tools/src/schema/addNamespaceToSchema.ts
@@ -185,6 +186,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));
     };
@@ -458,11 +464,11 @@ var resolveForm = ({
 };
 
 // pnp:/home/runner/work/tinacms/tinacms/packages/@tinacms/schema-tools/src/validate/index.ts
-var import_zod4 = __toModule(require("zod"));
+var import_zod5 = __toModule(require("zod"));
 
 // pnp:/home/runner/work/tinacms/tinacms/packages/@tinacms/schema-tools/src/util/parseZodErrors.ts
 var parseZodError = ({ zodError }) => {
-  var _a;
+  var _a, _b;
   const errors = zodError.flatten((issue) => {
     const moreInfo = [];
     if (issue.code === "invalid_union") {
@@ -478,14 +484,14 @@ var parseZodError = ({ zodError }) => {
   });
   const formErrors = errors.formErrors.flatMap((x) => x.errors);
   const parsedErrors = [
-    ...((_a = errors.fieldErrors) == null ? void 0 : _a.collections.flatMap((x) => x.errors)) || [],
+    ...((_b = (_a = errors.fieldErrors) == null ? void 0 : _a.collections) == null ? void 0 : _b.flatMap((x) => x.errors)) || [],
     ...formErrors
   ];
   return parsedErrors;
 };
 
 // pnp:/home/runner/work/tinacms/tinacms/packages/@tinacms/schema-tools/src/validate/schema.ts
-var import_zod3 = __toModule(require("zod"));
+var import_zod4 = __toModule(require("zod"));
 
 // pnp:/home/runner/work/tinacms/tinacms/packages/@tinacms/schema-tools/src/validate/properties.ts
 var import_zod = __toModule(require("zod"));
@@ -533,7 +539,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 +628,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);
@@ -645,31 +668,52 @@ var TinaFieldZod = import_zod2.z.lazy(() => {
   });
 });
 
+// pnp:/home/runner/work/tinacms/tinacms/packages/@tinacms/schema-tools/src/validate/tinaCloudSchemaConfig.ts
+var import_zod3 = __toModule(require("zod"));
+var tinaConfigKey = import_zod3.default.object({
+  publicFolder: import_zod3.default.string(),
+  mediaRoot: import_zod3.default.string()
+}).strict().optional();
+var tinaConfigZod = import_zod3.default.object({
+  media: import_zod3.default.object({
+    tina: tinaConfigKey
+  }).optional()
+});
+var validateTinaCloudSchemaConfig = (config) => {
+  const newConfig = tinaConfigZod.parse(config);
+  return newConfig;
+};
+
 // pnp:/home/runner/work/tinacms/tinacms/packages/@tinacms/schema-tools/src/validate/schema.ts
 var FORMATS = ["json", "md", "markdown", "mdx"];
-var Template = import_zod3.z.object({
-  label: import_zod3.z.string({
+var Template = import_zod4.z.object({
+  label: import_zod4.z.string({
     invalid_type_error: "label must be a string",
     required_error: "label was not provided but is required"
   }),
   name,
-  fields: import_zod3.z.array(TinaFieldZod)
+  fields: import_zod4.z.array(TinaFieldZod)
 }).refine((val) => {
   var _a;
   return !hasDuplicates((_a = val.fields) == null ? void 0 : _a.map((x) => x.name));
 }, {
   message: "Fields must have a unique name"
 });
-var TinaCloudCollectionBase = import_zod3.z.object({
-  label: import_zod3.z.string().optional(),
+var TinaCloudCollectionBase = import_zod4.z.object({
+  label: import_zod4.z.string().optional(),
   name,
-  format: import_zod3.z.enum(FORMATS).optional()
+  format: import_zod4.z.enum(FORMATS).optional()
 });
 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)), {
+  fields: import_zod4.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)), {
+  templates: import_zod4.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"
   })
 }).refine((val) => {
@@ -681,8 +725,9 @@ var TinaCloudCollection = TinaCloudCollectionBase.extend({
     return isValid;
   }
 }, { message: "Must provide one of templates or fields in your collection" });
-var TinaCloudSchemaZod = import_zod3.z.object({
-  collections: import_zod3.z.array(TinaCloudCollection)
+var TinaCloudSchemaZod = import_zod4.z.object({
+  collections: import_zod4.z.array(TinaCloudCollection),
+  config: tinaConfigZod.optional()
 }).refine((val) => !hasDuplicates(val.collections.map((x) => x.name)), {
   message: "can not have two collections with the same name"
 });
@@ -700,7 +745,7 @@ var validateSchema = ({
   try {
     TinaCloudSchemaZod.parse(config);
   } catch (e) {
-    if (e instanceof import_zod4.ZodError) {
+    if (e instanceof import_zod5.ZodError) {
       const errors = parseZodError({ zodError: e });
       throw new TinaSchemaValidationError(errors.join(", \n"));
     } else {
@@ -715,5 +760,6 @@ var validateSchema = ({
   addNamespaceToSchema,
   resolveField,
   resolveForm,
-  validateSchema
+  validateSchema,
+  validateTinaCloudSchemaConfig
 });

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

@@ -21,9 +21,18 @@ export declare type UIField<F extends UIField = any, Shape = any> = {
     validate?(value: Shape, allValues: any, meta: any, field: UIField<F, Shape>): string | object | undefined | void;
     defaultValue?: Shape;
 };
+export interface TinaCloudSchemaConfig {
+    media?: {
+        tina?: {
+            publicFolder: string;
+            mediaRoot: string;
+        };
+    };
+}
 export interface TinaCloudSchema<WithNamespace extends boolean> {
     templates?: GlobalTemplate<WithNamespace>[];
     collections: TinaCloudCollection<WithNamespace>[];
+    config?: TinaCloudSchemaConfig;
 }
 export declare type TinaCloudSchemaBase = TinaCloudSchema<false>;
 export declare type TinaCloudSchemaEnriched = TinaCloudSchema<true>;
@@ -35,6 +44,7 @@ export declare type TinaCloudSchemaEnriched = TinaCloudSchema<true>;
 export interface TinaCloudSchemaWithNamespace {
     templates?: GlobalTemplate<true>[];
     collections: TinaCloudCollection<true>[];
+    config?: TinaCloudSchemaConfig;
     namespace: string[];
 }
 export declare type TinaCloudCollection<WithNamespace extends boolean> = CollectionFields<WithNamespace> | CollectionTemplates<WithNamespace>;
@@ -108,11 +118,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/index.d.ts

@@ -11,6 +11,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 import { TinaCloudSchema } from '../types';
+export { validateTinaCloudSchemaConfig } from './tinaCloudSchemaConfig';
 export declare class TinaSchemaValidationError extends Error {
     constructor(message: any);
 }

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;
@@ -88,6 +88,44 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "json" | "md" | "markdown" | "mdx";
         label?: string;
     }>, "many">;
+    config: z.ZodOptional<z.ZodObject<{
+        media: z.ZodOptional<z.ZodObject<{
+            tina: z.ZodOptional<z.ZodObject<{
+                publicFolder: z.ZodString;
+                mediaRoot: z.ZodString;
+            }, "strict", z.ZodTypeAny, {
+                publicFolder?: string;
+                mediaRoot?: string;
+            }, {
+                publicFolder?: string;
+                mediaRoot?: string;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+        }, {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+        };
+    }, {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+        };
+    }>>;
 }, "strip", z.ZodTypeAny, {
     collections?: {
         name?: string;
@@ -100,6 +138,14 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "json" | "md" | "markdown" | "mdx";
         label?: string;
     }[];
+    config?: {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+        };
+    };
 }, {
     collections?: {
         name?: string;
@@ -112,6 +158,14 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "json" | "md" | "markdown" | "mdx";
         label?: string;
     }[];
+    config?: {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+        };
+    };
 }>, {
     collections?: {
         name?: string;
@@ -124,6 +178,14 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "json" | "md" | "markdown" | "mdx";
         label?: string;
     }[];
+    config?: {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+        };
+    };
 }, {
     collections?: {
         name?: string;
@@ -136,4 +198,12 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "json" | "md" | "markdown" | "mdx";
         label?: string;
     }[];
+    config?: {
+        media?: {
+            tina?: {
+                publicFolder?: string;
+                mediaRoot?: string;
+            };
+        };
+    };
 }>;

package/dist/validate/tinaCloudSchemaConfig.d.ts

@@ -0,0 +1,53 @@
+/**
+Copyright 2021 Forestry.io Holdings, Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+import { TinaCloudSchemaConfig } from '../types';
+import z from 'zod';
+export declare const tinaConfigZod: z.ZodObject<{
+    media: z.ZodOptional<z.ZodObject<{
+        tina: z.ZodOptional<z.ZodObject<{
+            publicFolder: z.ZodString;
+            mediaRoot: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            publicFolder?: string;
+            mediaRoot?: string;
+        }, {
+            publicFolder?: string;
+            mediaRoot?: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        tina?: {
+            publicFolder?: string;
+            mediaRoot?: string;
+        };
+    }, {
+        tina?: {
+            publicFolder?: string;
+            mediaRoot?: string;
+        };
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    media?: {
+        tina?: {
+            publicFolder?: string;
+            mediaRoot?: string;
+        };
+    };
+}, {
+    media?: {
+        tina?: {
+            publicFolder?: string;
+            mediaRoot?: string;
+        };
+    };
+}>;
+export declare const validateTinaCloudSchemaConfig: (config: unknown) => TinaCloudSchemaConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
@@ -16,7 +16,7 @@
     ]
   },
   "devDependencies": {
-    "@tinacms/scripts": "0.50.7",
+    "@tinacms/scripts": "0.50.9",
     "@types/yup": "^0.29.10",
     "jest": "^27.0.6",
     "react": "16.14.0",