@tinacms/schema-tools 0.0.8 → 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) => {
@@ -113,8 +116,9 @@ class TinaSchema {
   constructor(config) {
     this.config = config;
     this.getIsTitleFieldName = (collection) => {
+      var _a;
       const col = this.getCollection(collection);
-      const field = col == null ? void 0 : col.fields.find((x) => x.type === "string" && x.isTitle);
+      const field = (_a = col == null ? void 0 : col.fields) == null ? void 0 : _a.find((x) => x.type === "string" && x.isTitle);
       return field == null ? void 0 : field.name;
     };
     this.getCollectionsByName = (collectionNames) => {
@@ -168,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) {
@@ -373,6 +372,7 @@ const resolveField = ({ namespace, ...field }, schema) => {
             key: templateName,
             inline: template.inline,
             name: templateName,
+            match: template.match,
             fields: template.fields.map((field2) => resolveField(field2, schema)),
             ...extraFields2
           };
@@ -436,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",
@@ -452,6 +454,13 @@ 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 cannot contain spaces",
+      code: z.ZodIssueCode.custom,
+      fatal: true
+    });
 });
 const Option = z.union([z.string(), z.object({ label: z.string(), value: z.string() })], {
   errorMap: () => {
@@ -513,7 +522,11 @@ const TinaFieldZod = z.lazy(() => {
   const TemplateTemp = z.object({
     label: z.string(),
     name: nameProp,
-    fields: z.array(TinaFieldZod)
+    fields: z.array(TinaFieldZod),
+    match: z.object({
+      start: z.string(),
+      end: z.string()
+    }).optional()
   }).refine((val) => {
     var _a;
     return !hasDuplicates((_a = val.fields) == null ? void 0 : _a.map((x) => x.name));
@@ -607,6 +620,7 @@ const tinaConfigKey = z$1.object({
   mediaRoot: z$1.string()
 }).strict().optional();
 const tinaConfigZod = z$1.object({
+  client: z$1.object({ referenceDepth: z$1.number().optional() }).optional(),
   media: z$1.object({
     tina: tinaConfigKey,
     loadCustomStore: z$1.function().optional()
@@ -660,7 +674,7 @@ const TinaCloudSchemaZod = z.object({
   collections: z.array(TinaCloudCollection),
   config: tinaConfigZod.optional()
 }).superRefine((val, ctx) => {
-  var _a;
+  var _a, _b;
   if (hasDuplicates(val.collections.map((x) => x.name))) {
     ctx.addIssue({
       code: z.ZodIssueCode.custom,
@@ -668,7 +682,12 @@ const TinaCloudSchemaZod = z.object({
       fatal: true
     });
   }
-  const media = (_a = val == null ? void 0 : val.config) == null ? void 0 : _a.media;
+  (_a = val == null ? void 0 : val.collections) == null ? void 0 : _a.map((x) => {
+    if (!x.format) {
+      console.warn(`No format provided for collection ${x.name}, defaulting to .md`);
+    }
+  });
+  const media = (_b = val == null ? void 0 : val.config) == null ? void 0 : _b.media;
   if (media && media.tina && media.loadCustomStore) {
     ctx.addIssue({
       code: z.ZodIssueCode.custom,

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) => {
@@ -140,8 +143,9 @@
     constructor(config) {
       this.config = config;
       this.getIsTitleFieldName = (collection) => {
+        var _a;
         const col = this.getCollection(collection);
-        const field = col == null ? void 0 : col.fields.find((x) => x.type === "string" && x.isTitle);
+        const field = (_a = col == null ? void 0 : col.fields) == null ? void 0 : _a.find((x) => x.type === "string" && x.isTitle);
         return field == null ? void 0 : field.name;
       };
       this.getCollectionsByName = (collectionNames) => {
@@ -195,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) {
@@ -400,6 +399,7 @@
               key: templateName,
               inline: template.inline,
               name: templateName,
+              match: template.match,
               fields: template.fields.map((field2) => resolveField(field2, schema)),
               ...extraFields2
             };
@@ -463,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",
@@ -479,6 +481,13 @@
   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 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() })], {
     errorMap: () => {
@@ -540,7 +549,11 @@
     const TemplateTemp = z.z.object({
       label: z.z.string(),
       name: nameProp,
-      fields: z.z.array(TinaFieldZod)
+      fields: z.z.array(TinaFieldZod),
+      match: z.z.object({
+        start: z.z.string(),
+        end: z.z.string()
+      }).optional()
     }).refine((val) => {
       var _a;
       return !hasDuplicates((_a = val.fields) == null ? void 0 : _a.map((x) => x.name));
@@ -634,6 +647,7 @@
     mediaRoot: z__default["default"].string()
   }).strict().optional();
   const tinaConfigZod = z__default["default"].object({
+    client: z__default["default"].object({ referenceDepth: z__default["default"].number().optional() }).optional(),
     media: z__default["default"].object({
       tina: tinaConfigKey,
       loadCustomStore: z__default["default"].function().optional()
@@ -687,7 +701,7 @@
     collections: z.z.array(TinaCloudCollection),
     config: tinaConfigZod.optional()
   }).superRefine((val, ctx) => {
-    var _a;
+    var _a, _b;
     if (hasDuplicates(val.collections.map((x) => x.name))) {
       ctx.addIssue({
         code: z.z.ZodIssueCode.custom,
@@ -695,7 +709,12 @@
         fatal: true
       });
     }
-    const media = (_a = val == null ? void 0 : val.config) == null ? void 0 : _a.media;
+    (_a = val == null ? void 0 : val.collections) == null ? void 0 : _a.map((x) => {
+      if (!x.format) {
+        console.warn(`No format provided for collection ${x.name}, defaulting to .md`);
+      }
+    });
+    const media = (_b = val == null ? void 0 : val.config) == null ? void 0 : _b.media;
     if (media && media.tina && media.loadCustomStore) {
       ctx.addIssue({
         code: z.z.ZodIssueCode.custom,

package/dist/types/SchemaTypes.d.ts

@@ -10,8 +10,9 @@ 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 { TinaSchema } from '../schema';
 import type { FC } from 'react';
+import { TinaSchema } from '../schema';
+import type { TinaCloudSchemaConfig } from './config';
 export declare type UIField<F extends UIField = any, Shape = any> = {
     label?: string;
     description?: string;
@@ -21,15 +22,6 @@ 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<Store = any> {
-    media?: {
-        loadCustomStore?: () => Promise<Store>;
-        tina?: {
-            publicFolder: string;
-            mediaRoot: string;
-        };
-    };
-}
 export interface TinaCloudSchema<WithNamespace extends boolean, Store = any> {
     templates?: GlobalTemplate<WithNamespace>[];
     collections: TinaCloudCollection<WithNamespace>[];
@@ -52,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>;
@@ -317,6 +344,10 @@ export declare type Template<WithNamespace extends boolean> = WithNamespace exte
     label: string;
     name: string;
     fields: TinaFieldInner<WithNamespace>[];
+    match?: {
+        start: string;
+        end: string;
+    };
     ui?: object | (UIField<any, any> & {
         previewSrc: string;
     });
@@ -328,6 +359,10 @@ export declare type Template<WithNamespace extends boolean> = WithNamespace exte
         previewSrc: string;
     });
     fields: TinaFieldInner<WithNamespace>[];
+    match?: {
+        start: string;
+        end: string;
+    };
 };
 export declare type CollectionTemplateableUnion = {
     namespace: string[];
@@ -360,4 +395,4 @@ export declare type ResolveFormArgs = {
     template: Templateable;
     schema: TinaSchema;
 };
-export {};
+export * from './config';

package/dist/types/config.d.ts

@@ -0,0 +1,40 @@
+/**
+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.
+*/
+export interface TinaCloudSchemaConfig<Store = any> {
+    client?: {
+        referenceDepth?: number;
+    };
+    build?: {
+        publicFolder: string;
+        outputFolder: string;
+    };
+    /**
+     * The base branch to pull content from. Note that this is ignored for local development
+     */
+    branch?: string;
+    /**
+     * Your clientId from  app.tina.io
+     */
+    clientId?: string;
+    /**
+     * Your read only token from app.tina.io
+     */
+    token?: string;
+    media?: {
+        loadCustomStore?: () => Promise<Store>;
+        tina?: {
+            publicFolder: string;
+            mediaRoot: string;
+        };
+    };
+}

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;
@@ -89,6 +89,13 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
     }>, "many">;
     config: z.ZodOptional<z.ZodObject<{
+        client: z.ZodOptional<z.ZodObject<{
+            referenceDepth: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            referenceDepth?: number;
+        }, {
+            referenceDepth?: number;
+        }>>;
         media: z.ZodOptional<z.ZodObject<{
             tina: z.ZodOptional<z.ZodObject<{
                 publicFolder: z.ZodString;
@@ -115,6 +122,9 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
             loadCustomStore?: (...args: unknown[]) => unknown;
         }>>;
     }, "strip", z.ZodTypeAny, {
+        client?: {
+            referenceDepth?: number;
+        };
         media?: {
             tina?: {
                 publicFolder?: string;
@@ -123,6 +133,9 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
             loadCustomStore?: (...args: unknown[]) => unknown;
         };
     }, {
+        client?: {
+            referenceDepth?: number;
+        };
         media?: {
             tina?: {
                 publicFolder?: string;
@@ -144,6 +157,9 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
     }[];
     config?: {
+        client?: {
+            referenceDepth?: number;
+        };
         media?: {
             tina?: {
                 publicFolder?: string;
@@ -165,6 +181,9 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
     }[];
     config?: {
+        client?: {
+            referenceDepth?: number;
+        };
         media?: {
             tina?: {
                 publicFolder?: string;
@@ -186,6 +205,9 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
     }[];
     config?: {
+        client?: {
+            referenceDepth?: number;
+        };
         media?: {
             tina?: {
                 publicFolder?: string;
@@ -207,6 +229,9 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
     }[];
     config?: {
+        client?: {
+            referenceDepth?: number;
+        };
         media?: {
             tina?: {
                 publicFolder?: string;

package/dist/validate/tinaCloudSchemaConfig.d.ts

@@ -13,6 +13,13 @@ limitations under the License.
 import { TinaCloudSchemaConfig } from '../types';
 import z from 'zod';
 export declare const tinaConfigZod: z.ZodObject<{
+    client: z.ZodOptional<z.ZodObject<{
+        referenceDepth: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        referenceDepth?: number;
+    }, {
+        referenceDepth?: number;
+    }>>;
     media: z.ZodOptional<z.ZodObject<{
         tina: z.ZodOptional<z.ZodObject<{
             publicFolder: z.ZodString;
@@ -39,6 +46,9 @@ export declare const tinaConfigZod: z.ZodObject<{
         loadCustomStore?: (...args: unknown[]) => unknown;
     }>>;
 }, "strip", z.ZodTypeAny, {
+    client?: {
+        referenceDepth?: number;
+    };
     media?: {
         tina?: {
             publicFolder?: string;
@@ -47,6 +57,9 @@ export declare const tinaConfigZod: z.ZodObject<{
         loadCustomStore?: (...args: unknown[]) => unknown;
     };
 }, {
+    client?: {
+        referenceDepth?: number;
+    };
     media?: {
         tina?: {
             publicFolder?: string;

package/package.json

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