@tinacms/schema-tools 1.4.4 → 1.4.6

package/dist/index.es.js

@@ -424,6 +424,13 @@ class TinaSchema {
     this.schema = config;
     this.walkFields(({ field, collection, path }) => {
       var _a;
+      if (!("searchable" in field)) {
+        if (field.type === "image") {
+          field.searchable = false;
+        } else {
+          field.searchable = true;
+        }
+      }
       if (field.type === "rich-text") {
         if (field.parser) {
           return;
@@ -881,11 +888,21 @@ const tinaConfigKey = z$1.object({
   publicFolder: z$1.string(),
   mediaRoot: z$1.string()
 }).strict().optional();
+const tinaSearchKey = z$1.object({
+  indexerToken: z$1.string().optional(),
+  stopwordLanguages: z$1.array(z$1.string()).nonempty().optional()
+}).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()
+  }).optional(),
+  search: z$1.object({
+    tina: tinaSearchKey,
+    searchClient: z$1.any().optional(),
+    indexBatchSize: z$1.number().gte(1).optional(),
+    maxSearchIndexFieldLength: z$1.number().gte(1).optional()
   }).optional()
 });
 const validateTinaCloudSchemaConfig = (config) => {
@@ -975,7 +992,7 @@ const TinaCloudSchemaZod = z.object({
   collections: z.array(TinaCloudCollection),
   config: tinaConfigZod.optional()
 }).superRefine((val, ctx) => {
-  var _a, _b;
+  var _a, _b, _c;
   const dups = findDuplicates((_a = val.collections) == null ? void 0 : _a.map((x) => x.name));
   if (dups) {
     ctx.addIssue({
@@ -993,6 +1010,15 @@ const TinaCloudSchemaZod = z.object({
       path: ["config", "media"]
     });
   }
+  const search = (_c = val == null ? void 0 : val.config) == null ? void 0 : _c.search;
+  if (search && search.tina && search.searchClient) {
+    ctx.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "can not have both searchClient and tina. Must use one or the other",
+      fatal: true,
+      path: ["config", "search"]
+    });
+  }
 });
 class TinaSchemaValidationError extends Error {
   constructor(message) {

package/dist/index.js

@@ -451,6 +451,13 @@
       this.schema = config;
       this.walkFields(({ field, collection, path }) => {
         var _a;
+        if (!("searchable" in field)) {
+          if (field.type === "image") {
+            field.searchable = false;
+          } else {
+            field.searchable = true;
+          }
+        }
         if (field.type === "rich-text") {
           if (field.parser) {
             return;
@@ -908,11 +915,21 @@ ${JSON.stringify(val, null, 2)}
     publicFolder: z__default["default"].string(),
     mediaRoot: z__default["default"].string()
   }).strict().optional();
+  const tinaSearchKey = z__default["default"].object({
+    indexerToken: z__default["default"].string().optional(),
+    stopwordLanguages: z__default["default"].array(z__default["default"].string()).nonempty().optional()
+  }).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()
+    }).optional(),
+    search: z__default["default"].object({
+      tina: tinaSearchKey,
+      searchClient: z__default["default"].any().optional(),
+      indexBatchSize: z__default["default"].number().gte(1).optional(),
+      maxSearchIndexFieldLength: z__default["default"].number().gte(1).optional()
     }).optional()
   });
   const validateTinaCloudSchemaConfig = (config) => {
@@ -1002,7 +1019,7 @@ ${JSON.stringify(val, null, 2)}
     collections: z.z.array(TinaCloudCollection),
     config: tinaConfigZod.optional()
   }).superRefine((val, ctx) => {
-    var _a, _b;
+    var _a, _b, _c;
     const dups = findDuplicates((_a = val.collections) == null ? void 0 : _a.map((x) => x.name));
     if (dups) {
       ctx.addIssue({
@@ -1020,6 +1037,15 @@ ${JSON.stringify(val, null, 2)}
         path: ["config", "media"]
       });
     }
+    const search = (_c = val == null ? void 0 : val.config) == null ? void 0 : _c.search;
+    if (search && search.tina && search.searchClient) {
+      ctx.addIssue({
+        code: z.z.ZodIssueCode.custom,
+        message: "can not have both searchClient and tina. Must use one or the other",
+        fatal: true,
+        path: ["config", "search"]
+      });
+    }
   });
   class TinaSchemaValidationError extends Error {
     constructor(message) {

package/dist/types/index.d.ts

@@ -117,6 +117,9 @@ declare type FieldGeneric<Type, List extends boolean | undefined, ExtraFieldUIPr
     list?: undefined;
     ui?: UIField<Type, false> & ExtraFieldUIProps;
 };
+declare type SearchableTextField = {
+    maxSearchIndexFieldLength?: number;
+};
 export interface BaseField {
     label?: string | boolean;
     required?: boolean;
@@ -124,8 +127,9 @@ export interface BaseField {
     name: string;
     nameOverride?: string;
     description?: string;
+    searchable?: boolean;
 }
-export declare type StringField = (FieldGeneric<string, undefined> | FieldGeneric<string, true> | FieldGeneric<string, false>) & BaseField & {
+export declare type StringField = (FieldGeneric<string, undefined> | FieldGeneric<string, true> | FieldGeneric<string, false>) & BaseField & SearchableTextField & {
     type: 'string';
     isTitle?: boolean;
     isBody?: boolean;
@@ -171,7 +175,7 @@ declare type RichTextAst = {
     type: 'root';
     children: Record<string, unknown>[];
 };
-export declare type RichTextField<WithNamespace extends boolean = false> = (FieldGeneric<RichTextAst, undefined> | FieldGeneric<RichTextAst, false>) & BaseField & {
+export declare type RichTextField<WithNamespace extends boolean = false> = (FieldGeneric<RichTextAst, undefined> | FieldGeneric<RichTextAst, false>) & BaseField & SearchableTextField & {
     type: 'rich-text';
     /**
      * When using Markdown or MDX formats, this field's value
@@ -280,7 +284,7 @@ declare type TokenObject = {
     access_token?: string;
     refresh_token?: string;
 };
-export interface Config<CMSCallback = undefined, FormifyCallback = undefined, DocumentCreatorCallback = undefined, Store = undefined> {
+export interface Config<CMSCallback = undefined, FormifyCallback = undefined, DocumentCreatorCallback = undefined, Store = undefined, SearchClient = undefined> {
     contentApiUrlOverride?: string;
     admin?: {
         auth?: {
@@ -428,6 +432,37 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
         };
         loadCustomStore?: never;
     };
+    search?: ({
+        /**
+         * An instance of a search client like Algolia
+         */
+        searchClient: SearchClient;
+        tina?: never;
+    } | {
+        searchClient?: never;
+        /**
+         * Use the Tina Cloud search index
+         */
+        tina: {
+            /**
+             * Search index token with permissions to write to search index. Only used by CLI.
+             */
+            indexerToken?: string;
+            /**
+             * stopword languages to use (default: eng)
+             */
+            stopwordLanguages?: string[];
+        };
+    }) & {
+        /**
+         * The number of documents to index per PUT request
+         */
+        indexBatchSize?: number;
+        /**
+         * The maximum length of a string field that will be indexed for search
+         */
+        maxSearchIndexFieldLength?: number;
+    };
     /**
      * Used to override the default Tina Cloud API URL
      *

package/dist/validate/schema.d.ts

@@ -133,7 +133,47 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
             };
             loadCustomStore?: (...args: unknown[]) => unknown;
         }>>;
+        search: z.ZodOptional<z.ZodObject<{
+            tina: z.ZodOptional<z.ZodObject<{
+                indexerToken: z.ZodOptional<z.ZodString>;
+                stopwordLanguages: z.ZodOptional<z.ZodArray<z.ZodString, "atleastone">>;
+            }, "strict", z.ZodTypeAny, {
+                indexerToken?: string;
+                stopwordLanguages?: [string, ...string[]];
+            }, {
+                indexerToken?: string;
+                stopwordLanguages?: [string, ...string[]];
+            }>>;
+            searchClient: z.ZodOptional<z.ZodAny>;
+            indexBatchSize: z.ZodOptional<z.ZodNumber>;
+            maxSearchIndexFieldLength: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            maxSearchIndexFieldLength?: number;
+            tina?: {
+                indexerToken?: string;
+                stopwordLanguages?: [string, ...string[]];
+            };
+            searchClient?: any;
+            indexBatchSize?: number;
+        }, {
+            maxSearchIndexFieldLength?: number;
+            tina?: {
+                indexerToken?: string;
+                stopwordLanguages?: [string, ...string[]];
+            };
+            searchClient?: any;
+            indexBatchSize?: number;
+        }>>;
     }, "strip", z.ZodTypeAny, {
+        search?: {
+            maxSearchIndexFieldLength?: number;
+            tina?: {
+                indexerToken?: string;
+                stopwordLanguages?: [string, ...string[]];
+            };
+            searchClient?: any;
+            indexBatchSize?: number;
+        };
         client?: {
             referenceDepth?: number;
         };
@@ -145,6 +185,15 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
             loadCustomStore?: (...args: unknown[]) => unknown;
         };
     }, {
+        search?: {
+            maxSearchIndexFieldLength?: number;
+            tina?: {
+                indexerToken?: string;
+                stopwordLanguages?: [string, ...string[]];
+            };
+            searchClient?: any;
+            indexBatchSize?: number;
+        };
         client?: {
             referenceDepth?: number;
         };
@@ -170,6 +219,15 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
     }[];
     config?: {
+        search?: {
+            maxSearchIndexFieldLength?: number;
+            tina?: {
+                indexerToken?: string;
+                stopwordLanguages?: [string, ...string[]];
+            };
+            searchClient?: any;
+            indexBatchSize?: number;
+        };
         client?: {
             referenceDepth?: number;
         };
@@ -195,6 +253,15 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
     }[];
     config?: {
+        search?: {
+            maxSearchIndexFieldLength?: number;
+            tina?: {
+                indexerToken?: string;
+                stopwordLanguages?: [string, ...string[]];
+            };
+            searchClient?: any;
+            indexBatchSize?: number;
+        };
         client?: {
             referenceDepth?: number;
         };
@@ -220,6 +287,15 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
     }[];
     config?: {
+        search?: {
+            maxSearchIndexFieldLength?: number;
+            tina?: {
+                indexerToken?: string;
+                stopwordLanguages?: [string, ...string[]];
+            };
+            searchClient?: any;
+            indexBatchSize?: number;
+        };
         client?: {
             referenceDepth?: number;
         };
@@ -245,6 +321,15 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
     }[];
     config?: {
+        search?: {
+            maxSearchIndexFieldLength?: number;
+            tina?: {
+                indexerToken?: string;
+                stopwordLanguages?: [string, ...string[]];
+            };
+            searchClient?: any;
+            indexBatchSize?: number;
+        };
         client?: {
             referenceDepth?: number;
         };

package/dist/validate/tinaCloudSchemaConfig.d.ts

@@ -36,7 +36,47 @@ export declare const tinaConfigZod: z.ZodObject<{
         };
         loadCustomStore?: (...args: unknown[]) => unknown;
     }>>;
+    search: z.ZodOptional<z.ZodObject<{
+        tina: z.ZodOptional<z.ZodObject<{
+            indexerToken: z.ZodOptional<z.ZodString>;
+            stopwordLanguages: z.ZodOptional<z.ZodArray<z.ZodString, "atleastone">>;
+        }, "strict", z.ZodTypeAny, {
+            indexerToken?: string;
+            stopwordLanguages?: [string, ...string[]];
+        }, {
+            indexerToken?: string;
+            stopwordLanguages?: [string, ...string[]];
+        }>>;
+        searchClient: z.ZodOptional<z.ZodAny>;
+        indexBatchSize: z.ZodOptional<z.ZodNumber>;
+        maxSearchIndexFieldLength: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        maxSearchIndexFieldLength?: number;
+        tina?: {
+            indexerToken?: string;
+            stopwordLanguages?: [string, ...string[]];
+        };
+        searchClient?: any;
+        indexBatchSize?: number;
+    }, {
+        maxSearchIndexFieldLength?: number;
+        tina?: {
+            indexerToken?: string;
+            stopwordLanguages?: [string, ...string[]];
+        };
+        searchClient?: any;
+        indexBatchSize?: number;
+    }>>;
 }, "strip", z.ZodTypeAny, {
+    search?: {
+        maxSearchIndexFieldLength?: number;
+        tina?: {
+            indexerToken?: string;
+            stopwordLanguages?: [string, ...string[]];
+        };
+        searchClient?: any;
+        indexBatchSize?: number;
+    };
     client?: {
         referenceDepth?: number;
     };
@@ -48,6 +88,15 @@ export declare const tinaConfigZod: z.ZodObject<{
         loadCustomStore?: (...args: unknown[]) => unknown;
     };
 }, {
+    search?: {
+        maxSearchIndexFieldLength?: number;
+        tina?: {
+            indexerToken?: string;
+            stopwordLanguages?: [string, ...string[]];
+        };
+        searchClient?: any;
+        indexBatchSize?: number;
+    };
     client?: {
         referenceDepth?: number;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "1.4.4",
+  "version": "1.4.6",
   "main": "dist/index.js",
   "module": "./dist/index.es.js",
   "exports": {