@tinacms/schema-tools 1.4.12 → 1.4.14

package/LICENSE

@@ -1,12 +1,4 @@
-Copyright (c) 2023-present Forestry.io Holdings Inc. 
-
-Portions of the TinaCMS software are licensed as follows:
-
-* All software that resides under the "packages/@tinacms/datalayer/" and the "packages/@tinacms/graphql/" directories (the "Tina Data Layer"), is licensed under the license defined in "packages/@tinacms/datalayer/LICENSE".
-
-* All software outside of the above-mentioned directories is available under the "Apache 2.0" license as set forth below.
-
-Apache License
+                                Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 

package/dist/index.js

@@ -231,6 +231,7 @@
       };
       this.getCollectionByFullPath = (filepath) => {
         const fileExtension = filepath.split(".").pop();
+        const normalizedPath = filepath.replace(/\\/g, "/");
         const possibleCollections = this.getCollections().filter((collection) => {
           var _a, _b;
           if (fileExtension !== (collection.format || "md")) {
@@ -238,13 +239,13 @@
           }
           if (((_a = collection == null ? void 0 : collection.match) == null ? void 0 : _a.include) || ((_b = collection == null ? void 0 : collection.match) == null ? void 0 : _b.exclude)) {
             const matches = this.getMatches({ collection });
-            const match = picomatch.isMatch(filepath, matches);
+            const match = picomatch.isMatch(normalizedPath, matches);
             if (!match) {
               return false;
             }
           }
           const path = collection.path ? collection.path.replace(/\/?$/, "/") : "";
-          return filepath.replace(/\\/g, "/").startsWith(path);
+          return normalizedPath.startsWith(path);
         });
         if (possibleCollections.length === 0) {
           throw new Error(`Unable to find collection for file at ${filepath}`);
@@ -423,7 +424,7 @@
         if (collection == null ? void 0 : collection.fields) {
           const template = collection;
           if (typeof template.fields === "string" || typeof template.fields === "undefined") {
-            throw new Error("Exptected template to have fields but none were found");
+            throw new Error("Expected template to have fields but none were found");
           }
           return {
             namespace: collection.namespace,
@@ -495,6 +496,7 @@
             field.parser = { type: "markdown" };
           }
         }
+        field.uid = field.uid || false;
       });
     }
     /**
@@ -677,6 +679,12 @@
           component: "rich-text",
           ...extraFields
         };
+      case "password":
+        return {
+          component: "password",
+          ...field,
+          ...extraFields
+        };
       case "reference":
         return {
           ...field,
@@ -784,7 +792,8 @@ If you need to use this value in your content you can use the \`nameOverride\` p
   });
   const FieldWithList = TinaField.extend({ list: z.z.boolean().optional() });
   const TinaScalerBase = FieldWithList.extend({
-    options: z.z.array(Option).optional()
+    options: z.z.array(Option).optional(),
+    uid: z.z.boolean().optional()
   });
   const StringField = TinaScalerBase.extend({
     type: z.z.literal("string", {
@@ -793,6 +802,12 @@ If you need to use this value in your content you can use the \`nameOverride\` p
     }),
     isTitle: z.z.boolean().optional()
   });
+  const PasswordField = TinaScalerBase.extend({
+    type: z.z.literal("password", {
+      invalid_type_error: typeTypeError,
+      required_error: typeRequiredError
+    })
+  });
   const BooleanField = TinaScalerBase.extend({
     type: z.z.literal("boolean", {
       invalid_type_error: typeTypeError,
@@ -894,7 +909,8 @@ If you need to use this value in your content you can use the \`nameOverride\` p
         DateTimeField,
         ReferenceField,
         ObjectField,
-        RichTextField
+        RichTextField,
+        PasswordField
       ],
       {
         errorMap: (issue, ctx) => {
@@ -933,6 +949,32 @@ ${JSON.stringify(
                 null,
                 2
               )}
+`
+            });
+          }
+        }
+        if (val.uid) {
+          if (val.list) {
+            ctx.addIssue({
+              code: z.z.ZodIssueCode.custom,
+              message: `Can not have \`list: true\` when using \`uid\`. Error in value 
+${JSON.stringify(
+                val,
+                null,
+                2
+              )}
+`
+            });
+          }
+          if (!val.required) {
+            ctx.addIssue({
+              code: z.z.ZodIssueCode.custom,
+              message: `Must have { required: true } when using \`uid\` Error in value 
+${JSON.stringify(
+                val,
+                null,
+                2
+              )}
 `
             });
           }
@@ -1032,7 +1074,9 @@ ${JSON.stringify(
         });
       }
     }),
-    format: z.z.enum(FORMATS).optional()
+    format: z.z.enum(FORMATS).optional(),
+    isAuthCollection: z.z.boolean().optional(),
+    isDetached: z.z.boolean().optional()
   });
   const TinaCloudCollection = CollectionBaseSchema.extend({
     fields: z.z.array(TinaFieldZod).min(1).optional().superRefine((val, ctx) => {
@@ -1052,6 +1096,24 @@ ${JSON.stringify(
       {
         message: "Fields can only have one use of `isTitle`"
       }
+    ).refine(
+      // It is valid if it is 0 or 1
+      (val) => {
+        const arr = (val == null ? void 0 : val.filter((x) => x.uid)) || [];
+        return arr.length < 2;
+      },
+      {
+        message: "Fields can only have one use of `uid`"
+      }
+    ).refine(
+      // It is valid if it is 0 or 1
+      (val) => {
+        const arr = (val == null ? void 0 : val.filter((x) => x.type === "password")) || [];
+        return arr.length < 2;
+      },
+      {
+        message: "Fields can only have one use of `password` type"
+      }
     ),
     templates: z.z.array(Template).min(1).optional().superRefine((val, ctx) => {
       const dups = findDuplicates(val == null ? void 0 : val.map((x) => x.name));
@@ -1078,7 +1140,7 @@ ${JSON.stringify(
     collections: z.z.array(TinaCloudCollection),
     config: tinaConfigZod.optional()
   }).superRefine((val, ctx) => {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     const dups = findDuplicates((_a = val.collections) == null ? void 0 : _a.map((x) => x.name));
     if (dups) {
       ctx.addIssue({
@@ -1087,7 +1149,14 @@ ${JSON.stringify(
         fatal: true
       });
     }
-    const media = (_b = val == null ? void 0 : val.config) == null ? void 0 : _b.media;
+    if (((_b = val.collections) == null ? void 0 : _b.filter((x) => x.isAuthCollection).length) > 1) {
+      ctx.addIssue({
+        code: z.z.ZodIssueCode.custom,
+        message: `Only one collection can be marked as isAuthCollection`,
+        fatal: true
+      });
+    }
+    const media = (_c = val == null ? void 0 : val.config) == null ? void 0 : _c.media;
     if (media && media.tina && media.loadCustomStore) {
       ctx.addIssue({
         code: z.z.ZodIssueCode.custom,
@@ -1096,7 +1165,7 @@ ${JSON.stringify(
         path: ["config", "media"]
       });
     }
-    const search = (_c = val == null ? void 0 : val.config) == null ? void 0 : _c.search;
+    const search = (_d = val == null ? void 0 : val.config) == null ? void 0 : _d.search;
     if (search && search.tina && search.searchClient) {
       ctx.addIssue({
         code: z.z.ZodIssueCode.custom,

package/dist/index.mjs

@@ -214,6 +214,7 @@ class TinaSchema {
     };
     this.getCollectionByFullPath = (filepath) => {
       const fileExtension = filepath.split(".").pop();
+      const normalizedPath = filepath.replace(/\\/g, "/");
       const possibleCollections = this.getCollections().filter((collection) => {
         var _a, _b;
         if (fileExtension !== (collection.format || "md")) {
@@ -221,13 +222,13 @@ class TinaSchema {
         }
         if (((_a = collection == null ? void 0 : collection.match) == null ? void 0 : _a.include) || ((_b = collection == null ? void 0 : collection.match) == null ? void 0 : _b.exclude)) {
           const matches = this.getMatches({ collection });
-          const match = picomatch.isMatch(filepath, matches);
+          const match = picomatch.isMatch(normalizedPath, matches);
           if (!match) {
             return false;
           }
         }
         const path = collection.path ? collection.path.replace(/\/?$/, "/") : "";
-        return filepath.replace(/\\/g, "/").startsWith(path);
+        return normalizedPath.startsWith(path);
       });
       if (possibleCollections.length === 0) {
         throw new Error(`Unable to find collection for file at ${filepath}`);
@@ -406,7 +407,7 @@ class TinaSchema {
       if (collection == null ? void 0 : collection.fields) {
         const template = collection;
         if (typeof template.fields === "string" || typeof template.fields === "undefined") {
-          throw new Error("Exptected template to have fields but none were found");
+          throw new Error("Expected template to have fields but none were found");
         }
         return {
           namespace: collection.namespace,
@@ -478,6 +479,7 @@ class TinaSchema {
           field.parser = { type: "markdown" };
         }
       }
+      field.uid = field.uid || false;
     });
   }
   /**
@@ -660,6 +662,12 @@ const resolveField = (field, schema) => {
         component: "rich-text",
         ...extraFields
       };
+    case "password":
+      return {
+        component: "password",
+        ...field,
+        ...extraFields
+      };
     case "reference":
       return {
         ...field,
@@ -767,7 +775,8 @@ const TinaField = z.object({
 });
 const FieldWithList = TinaField.extend({ list: z.boolean().optional() });
 const TinaScalerBase = FieldWithList.extend({
-  options: z.array(Option).optional()
+  options: z.array(Option).optional(),
+  uid: z.boolean().optional()
 });
 const StringField = TinaScalerBase.extend({
   type: z.literal("string", {
@@ -776,6 +785,12 @@ const StringField = TinaScalerBase.extend({
   }),
   isTitle: z.boolean().optional()
 });
+const PasswordField = TinaScalerBase.extend({
+  type: z.literal("password", {
+    invalid_type_error: typeTypeError,
+    required_error: typeRequiredError
+  })
+});
 const BooleanField = TinaScalerBase.extend({
   type: z.literal("boolean", {
     invalid_type_error: typeTypeError,
@@ -877,7 +892,8 @@ const TinaFieldZod = z.lazy(() => {
       DateTimeField,
       ReferenceField,
       ObjectField,
-      RichTextField
+      RichTextField,
+      PasswordField
     ],
     {
       errorMap: (issue, ctx) => {
@@ -916,6 +932,32 @@ ${JSON.stringify(
               null,
               2
             )}
+`
+          });
+        }
+      }
+      if (val.uid) {
+        if (val.list) {
+          ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: `Can not have \`list: true\` when using \`uid\`. Error in value 
+${JSON.stringify(
+              val,
+              null,
+              2
+            )}
+`
+          });
+        }
+        if (!val.required) {
+          ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: `Must have { required: true } when using \`uid\` Error in value 
+${JSON.stringify(
+              val,
+              null,
+              2
+            )}
 `
           });
         }
@@ -1015,7 +1057,9 @@ const CollectionBaseSchema = z.object({
       });
     }
   }),
-  format: z.enum(FORMATS).optional()
+  format: z.enum(FORMATS).optional(),
+  isAuthCollection: z.boolean().optional(),
+  isDetached: z.boolean().optional()
 });
 const TinaCloudCollection = CollectionBaseSchema.extend({
   fields: z.array(TinaFieldZod).min(1).optional().superRefine((val, ctx) => {
@@ -1035,6 +1079,24 @@ const TinaCloudCollection = CollectionBaseSchema.extend({
     {
       message: "Fields can only have one use of `isTitle`"
     }
+  ).refine(
+    // It is valid if it is 0 or 1
+    (val) => {
+      const arr = (val == null ? void 0 : val.filter((x) => x.uid)) || [];
+      return arr.length < 2;
+    },
+    {
+      message: "Fields can only have one use of `uid`"
+    }
+  ).refine(
+    // It is valid if it is 0 or 1
+    (val) => {
+      const arr = (val == null ? void 0 : val.filter((x) => x.type === "password")) || [];
+      return arr.length < 2;
+    },
+    {
+      message: "Fields can only have one use of `password` type"
+    }
   ),
   templates: z.array(Template).min(1).optional().superRefine((val, ctx) => {
     const dups = findDuplicates(val == null ? void 0 : val.map((x) => x.name));
@@ -1061,7 +1123,7 @@ const TinaCloudSchemaZod = z.object({
   collections: z.array(TinaCloudCollection),
   config: tinaConfigZod.optional()
 }).superRefine((val, ctx) => {
-  var _a, _b, _c;
+  var _a, _b, _c, _d;
   const dups = findDuplicates((_a = val.collections) == null ? void 0 : _a.map((x) => x.name));
   if (dups) {
     ctx.addIssue({
@@ -1070,7 +1132,14 @@ const TinaCloudSchemaZod = z.object({
       fatal: true
     });
   }
-  const media = (_b = val == null ? void 0 : val.config) == null ? void 0 : _b.media;
+  if (((_b = val.collections) == null ? void 0 : _b.filter((x) => x.isAuthCollection).length) > 1) {
+    ctx.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: `Only one collection can be marked as isAuthCollection`,
+      fatal: true
+    });
+  }
+  const media = (_c = val == null ? void 0 : val.config) == null ? void 0 : _c.media;
   if (media && media.tina && media.loadCustomStore) {
     ctx.addIssue({
       code: z.ZodIssueCode.custom,
@@ -1079,7 +1148,7 @@ const TinaCloudSchemaZod = z.object({
       path: ["config", "media"]
     });
   }
-  const search = (_c = val == null ? void 0 : val.config) == null ? void 0 : _c.search;
+  const search = (_d = val == null ? void 0 : val.config) == null ? void 0 : _d.search;
   if (search && search.tina && search.searchClient) {
     ctx.addIssue({
       code: z.ZodIssueCode.custom,

package/dist/schema/resolveForm.d.ts

@@ -1,6 +1,7 @@
 /**
 
 */
+/// <reference types="react" />
 import type { Template, Collection } from '../types/index';
 import type { TinaSchema } from './TinaSchema';
 /**
@@ -19,9 +20,9 @@ export declare const resolveForm: ({ collection, basename, template, schema, }:
             };
             input: {
                 name: string;
-                onBlur: (event?: any) => void;
-                onChange: (event: any) => void;
-                onFocus: (event?: any) => void;
+                onBlur: (event?: import("react").FocusEvent<string, Element>) => void;
+                onChange: (event: import("react").ChangeEvent<string>) => void;
+                onFocus: (event?: import("react").FocusEvent<string, Element>) => void;
                 type?: string;
                 value: string[];
             };
@@ -36,9 +37,9 @@ export declare const resolveForm: ({ collection, basename, template, schema, }:
             };
             input: {
                 name: string;
-                onBlur: (event?: any) => void;
-                onChange: (event: any) => void;
-                onFocus: (event?: any) => void;
+                onBlur: (event?: import("react").FocusEvent<number, Element>) => void;
+                onChange: (event: import("react").ChangeEvent<number>) => void;
+                onFocus: (event?: import("react").FocusEvent<number, Element>) => void;
                 type?: string;
                 value: number[];
             };
@@ -53,9 +54,9 @@ export declare const resolveForm: ({ collection, basename, template, schema, }:
             };
             input: {
                 name: string;
-                onBlur: (event?: any) => void;
-                onChange: (event: any) => void;
-                onFocus: (event?: any) => void;
+                onBlur: (event?: import("react").FocusEvent<boolean, Element>) => void;
+                onChange: (event: import("react").ChangeEvent<boolean>) => void;
+                onFocus: (event?: import("react").FocusEvent<boolean, Element>) => void;
                 type?: string;
                 value: boolean[];
             };
@@ -70,9 +71,18 @@ export declare const resolveForm: ({ collection, basename, template, schema, }:
             };
             input: {
                 name: string;
-                onBlur: (event?: any) => void;
-                onChange: (event: any) => void;
-                onFocus: (event?: any) => void;
+                onBlur: (event?: import("react").FocusEvent<{
+                    type: "root";
+                    children: Record<string, unknown>[];
+                }, Element>) => void;
+                onChange: (event: import("react").ChangeEvent<{
+                    type: "root";
+                    children: Record<string, unknown>[];
+                }>) => void;
+                onFocus: (event?: import("react").FocusEvent<{
+                    type: "root";
+                    children: Record<string, unknown>[];
+                }, Element>) => void;
                 type?: string;
                 value: {
                     type: "root";
@@ -90,9 +100,9 @@ export declare const resolveForm: ({ collection, basename, template, schema, }:
             };
             input: {
                 name: string;
-                onBlur: (event?: any) => void;
-                onChange: (event: any) => void;
-                onFocus: (event?: any) => void;
+                onBlur: (event?: import("react").FocusEvent<string, Element>) => void;
+                onChange: (event: import("react").ChangeEvent<string>) => void;
+                onFocus: (event?: import("react").FocusEvent<string, Element>) => void;
                 type?: string;
                 value: string;
             };
@@ -107,9 +117,9 @@ export declare const resolveForm: ({ collection, basename, template, schema, }:
             };
             input: {
                 name: string;
-                onBlur: (event?: any) => void;
-                onChange: (event: any) => void;
-                onFocus: (event?: any) => void;
+                onBlur: (event?: import("react").FocusEvent<number, Element>) => void;
+                onChange: (event: import("react").ChangeEvent<number>) => void;
+                onFocus: (event?: import("react").FocusEvent<number, Element>) => void;
                 type?: string;
                 value: number;
             };
@@ -124,9 +134,9 @@ export declare const resolveForm: ({ collection, basename, template, schema, }:
             };
             input: {
                 name: string;
-                onBlur: (event?: any) => void;
-                onChange: (event: any) => void;
-                onFocus: (event?: any) => void;
+                onBlur: (event?: import("react").FocusEvent<boolean, Element>) => void;
+                onChange: (event: import("react").ChangeEvent<boolean>) => void;
+                onFocus: (event?: import("react").FocusEvent<boolean, Element>) => void;
                 type?: string;
                 value: boolean;
             };
@@ -141,9 +151,18 @@ export declare const resolveForm: ({ collection, basename, template, schema, }:
             };
             input: {
                 name: string;
-                onBlur: (event?: any) => void;
-                onChange: (event: any) => void;
-                onFocus: (event?: any) => void;
+                onBlur: (event?: import("react").FocusEvent<{
+                    type: "root";
+                    children: Record<string, unknown>[];
+                }, Element>) => void;
+                onChange: (event: import("react").ChangeEvent<{
+                    type: "root";
+                    children: Record<string, unknown>[];
+                }>) => void;
+                onFocus: (event?: import("react").FocusEvent<{
+                    type: "root";
+                    children: Record<string, unknown>[];
+                }, Element>) => void;
                 type?: string;
                 value: {
                     type: "root";

package/dist/types/index.d.ts

@@ -128,6 +128,7 @@ export interface BaseField {
     nameOverride?: string;
     description?: string;
     searchable?: boolean;
+    uid?: boolean;
 }
 export declare type StringField = (FieldGeneric<string, undefined> | FieldGeneric<string, true> | FieldGeneric<string, false>) & BaseField & SearchableTextField & {
     type: 'string';
@@ -171,6 +172,9 @@ export declare type ReferenceField = (FieldGeneric<string, undefined> | FieldGen
      */
     collections: string[];
 };
+export declare type PasswordField = (FieldGeneric<string, undefined> | FieldGeneric<string, false>) & BaseField & {
+    type: 'password';
+};
 declare type RichTextAst = {
     type: 'root';
     children: Record<string, unknown>[];
@@ -240,7 +244,7 @@ export declare type ObjectField<WithNamespace extends boolean = false> = (FieldG
     templates: Template<WithNamespace>[];
     templateKey?: string;
 });
-declare type Field<WithNamespace extends boolean = false> = (StringField | NumberField | BooleanField | DateTimeField | ImageField | ReferenceField | RichTextField<WithNamespace> | ObjectField<WithNamespace>) & MaybeNamespace<WithNamespace>;
+declare type Field<WithNamespace extends boolean = false> = (StringField | NumberField | BooleanField | DateTimeField | ImageField | ReferenceField | RichTextField<WithNamespace> | ObjectField<WithNamespace> | PasswordField) & MaybeNamespace<WithNamespace>;
 export declare type TinaField<WithNamespace extends boolean = false> = Field<WithNamespace> & MaybeNamespace<WithNamespace>;
 declare type MaybeNamespace<WithNamespace extends boolean = false> = WithNamespace extends true ? {
     namespace: string[];
@@ -284,59 +288,68 @@ declare type TokenObject = {
     access_token?: string;
     refresh_token?: string;
 };
+export declare type LoginStrategy = 'UsernamePassword' | 'Redirect';
+export interface AuthProvider {
+    /**
+     *  Used for getting the token from the custom auth provider
+     *
+     * @returns {Promise<TokenObject | null>}
+     **/
+    getToken: () => Promise<TokenObject | null>;
+    /**
+     *  Used to logout from the custom auth provider
+     *
+     **/
+    logout: () => Promise<void>;
+    /**
+     *  Used for getting the user from the custom auth provider. If this returns a truthy value, the user will be logged in and the CMS will be enabled.
+     *
+     *  If this returns a falsy value, the user will be logged out and the CMS will be disabled.
+     *
+     **/
+    getUser: () => Promise<any | null | boolean>;
+    /**
+     *  Used to authorize the user with the custom auth provider.
+     *
+     *  If this returns a truthy value, the user will be logged in and the CMS will be enabled.
+     *
+     *  If not provided, the existence of a user will be enough to authorize the user.
+     *
+     * @param context
+     */
+    authorize: (context?: any) => Promise<any | null>;
+    /**
+     * Used to authenticate the user with the custom auth provider. This is called when the user clicks the login button.
+     *
+     **/
+    authenticate: (props?: Record<string, any>) => Promise<any | null>;
+    fetchWithToken: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+    isAuthorized: (context?: any) => Promise<boolean>;
+    isAuthenticated: () => Promise<boolean>;
+    getLoginStrategy: () => LoginStrategy;
+    getSessionProvider: () => FC<{
+        basePath?: string;
+    }>;
+}
+interface AuthHooks {
+    onLogin?: (args: {
+        token: TokenObject;
+    }) => Promise<void>;
+    onLogout?: () => Promise<void>;
+}
+declare type AuthOptions = AuthHooks & AuthProvider;
 export interface Config<CMSCallback = undefined, FormifyCallback = undefined, DocumentCreatorCallback = undefined, Store = undefined, SearchClient = undefined> {
     contentApiUrlOverride?: string;
+    authProvider?: AuthProvider;
     admin?: {
-        auth?: {
-            /**
-             * If you wish to use the local auth provider, set this to true
-             *
-             * This will take precedence over the customAuth option (if set to true)
-             *
-             **/
-            useLocalAuth?: boolean;
-            /**
-             * If you are using a custom auth provider, set this to true
-             **/
-            customAuth?: boolean;
-            /**
-             *  Used for getting the token from the custom auth provider
-             *
-             * @returns {Promise<TokenObject | null>}
-             **/
-            getToken?: () => Promise<TokenObject | null>;
-            /**
-             *  Used to logout from the custom auth provider
-             *
-             **/
-            logout?: () => Promise<void>;
-            /**
-             *  Used for getting the user from the custom auth provider. If this returns a truthy value, the user will be logged in and the CMS will be enabled.
-             *
-             *  If this returns a falsy value, the user will be logged out and the CMS will be disabled.
-             *
-             **/
-            getUser?: () => Promise<any | null>;
-            /**
-             *  Used to authorize the user with the custom auth provider.
-             *
-             *  If this returns a truthy value, the user will be logged in and the CMS will be enabled.
-             *
-             *  If not provided, the existence of a user will be enough to authorize the user.
-             *
-             * @param context
-             */
-            authorize?: (context?: any) => Promise<any | null>;
-            /**
-             * Used to authenticate the user with the custom auth provider. This is called when the user clicks the login button.
-             *
-             **/
-            authenticate?: () => Promise<any | null>;
-            onLogin?: (args: {
-                token: TokenObject;
-            }) => Promise<void>;
-            onLogout?: () => Promise<void>;
-        };
+        /**
+         * @deprecated use `authProvider`and admin.authHooks instead
+         */
+        auth?: AuthOptions;
+        /**
+         * Hook functions that can be used to run logic when certain events happen
+         */
+        authHooks?: AuthHooks;
     };
     /**
      * The Schema is used to define the shape of the content.
@@ -397,6 +410,12 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
          * @default 2
          */
         referenceDepth?: number;
+        /**
+         * Determines how the client will handle errors. If it is set to `throw` the client will throw an error when a query fails. If it is set to `include` the client will return the error in the response.
+         *
+         * @default 'throw'
+         */
+        errorPolicy?: 'throw' | 'include';
     };
     /**
      *
@@ -561,6 +580,8 @@ interface BaseCollection {
         include?: string;
         exclude?: string;
     };
+    isDetached?: boolean;
+    isAuthCollection?: boolean;
 }
 declare type TemplateCollection<WithNamespace extends boolean = false> = {
     /**

package/dist/validate/schema.d.ts

@@ -7,16 +7,22 @@ export declare const CollectionBaseSchema: z.ZodObject<{
     name: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
     path: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
     format: z.ZodOptional<z.ZodEnum<["json", "md", "markdown", "mdx", "toml", "yaml", "yml"]>>;
+    isAuthCollection: z.ZodOptional<z.ZodBoolean>;
+    isDetached: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     name?: string;
     label?: string;
     path?: string;
     format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+    isDetached?: boolean;
+    isAuthCollection?: boolean;
 }, {
     name?: string;
     label?: string;
     path?: string;
     format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+    isDetached?: boolean;
+    isAuthCollection?: boolean;
 }>;
 export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
     collections: z.ZodArray<z.ZodEffects<z.ZodObject<z.extendShape<{
@@ -24,8 +30,10 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         name: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
         path: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
         format: z.ZodOptional<z.ZodEnum<["json", "md", "markdown", "mdx", "toml", "yaml", "yml"]>>;
+        isAuthCollection: z.ZodOptional<z.ZodBoolean>;
+        isDetached: z.ZodOptional<z.ZodBoolean>;
     }, {
-        fields: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodType<import("..").TinaField<false>, z.ZodTypeDef, import("..").TinaField<false>>, "many">>, import("..").TinaField<false>[], import("..").TinaField<false>[]>, import("..").TinaField<false>[], import("..").TinaField<false>[]>;
+        fields: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodType<import("..").TinaField<false>, z.ZodTypeDef, import("..").TinaField<false>>, "many">>, import("..").TinaField<false>[], import("..").TinaField<false>[]>, import("..").TinaField<false>[], import("..").TinaField<false>[]>, import("..").TinaField<false>[], import("..").TinaField<false>[]>, import("..").TinaField<false>[], import("..").TinaField<false>[]>;
         templates: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
             label: z.ZodString;
             name: z.ZodEffects<z.ZodString, string, string>;
@@ -66,6 +74,8 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
         path?: string;
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        isDetached?: boolean;
+        isAuthCollection?: boolean;
     }, {
         name?: string;
         templates?: {
@@ -77,6 +87,8 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
         path?: string;
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        isDetached?: boolean;
+        isAuthCollection?: boolean;
     }>, {
         name?: string;
         templates?: {
@@ -88,6 +100,8 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
         path?: string;
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        isDetached?: boolean;
+        isAuthCollection?: boolean;
     }, {
         name?: string;
         templates?: {
@@ -99,6 +113,8 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
         path?: string;
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        isDetached?: boolean;
+        isAuthCollection?: boolean;
     }>, "many">;
     config: z.ZodOptional<z.ZodObject<{
         client: z.ZodOptional<z.ZodObject<{
@@ -231,6 +247,8 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
         path?: string;
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        isDetached?: boolean;
+        isAuthCollection?: boolean;
     }[];
     config?: {
         search?: {
@@ -267,6 +285,8 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
         path?: string;
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        isDetached?: boolean;
+        isAuthCollection?: boolean;
     }[];
     config?: {
         search?: {
@@ -303,6 +323,8 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
         path?: string;
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        isDetached?: boolean;
+        isAuthCollection?: boolean;
     }[];
     config?: {
         search?: {
@@ -339,6 +361,8 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label?: string;
         path?: string;
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        isDetached?: boolean;
+        isAuthCollection?: boolean;
     }[];
     config?: {
         search?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "1.4.12",
+  "version": "1.4.14",
   "main": "dist/index.js",
   "module": "./dist/index.mjs",
   "exports": {
@@ -23,7 +23,8 @@
     ]
   },
   "devDependencies": {
-    "@tinacms/scripts": "1.1.2",
+    "@types/react": "17.0.2",
+    "@tinacms/scripts": "1.1.3",
     "@types/micromatch": "^4.0.2",
     "@types/yup": "^0.29.10",
     "jest": "^29.5.0",