@tinacms/search 0.0.0-c1132cd-20241024060747 → 0.0.0-c19d29e-20251224001156

package/dist/indexer/index.d.ts

@@ -15,6 +15,7 @@ export declare class SearchIndexer {
     private readonly schema;
     private readonly textIndexLength;
     constructor(options: SearchIndexOptions);
+    private createBatchProcessor;
     private makeIndexerCallback;
     indexContentByPaths(documentPaths: string[]): Promise<void>;
     indexAllContent(): Promise<{

package/dist/indexer/utils.d.ts

@@ -1,3 +1,3 @@
 import { Collection, ObjectField } from '@tinacms/schema-tools';
-export declare const processDocumentForIndexing: (data: any, path: string, collection: Collection, textIndexLength: number, field?: ObjectField) => any;
+export declare const processDocumentForIndexing: (data: Record<string, unknown>, path: string, collection: Collection, textIndexLength: number, field?: ObjectField) => Record<string, unknown>;
 export declare const lookupStopwords: (keys?: string[], defaultStopWords?: string[]) => string[];

package/dist/pagination.d.ts

@@ -0,0 +1,16 @@
+export interface PaginationOptions {
+    limit?: number;
+    cursor?: string;
+}
+export interface PageOptions {
+    PAGE?: {
+        SIZE: number;
+        NUMBER: number;
+    };
+}
+export interface PaginationCursors {
+    nextCursor: string | null;
+    prevCursor: string | null;
+}
+export declare function buildPageOptions(options: PaginationOptions): PageOptions;
+export declare function buildPaginationCursors(total: number, options: PaginationOptions): PaginationCursors;

package/dist/types.d.ts

@@ -1,15 +1,55 @@
+import type { FuzzySearchOptions, FuzzyMatch } from './fuzzy';
+export interface SearchOptions {
+    cursor?: string;
+    limit?: number;
+    fuzzy?: boolean;
+    fuzzyOptions?: FuzzySearchOptions;
+}
+export interface SearchResult {
+    _id: string;
+    _match: Record<string, string[]>;
+    [key: string]: unknown;
+}
+export interface SearchQueryResponse {
+    results: SearchResult[];
+    total: number;
+    nextCursor: string | null;
+    prevCursor: string | null;
+    fuzzyMatches?: Record<string, FuzzyMatch[]>;
+}
+export interface IndexableDocument {
+    _id: string;
+    [key: string]: unknown;
+}
+export interface SearchIndexResult {
+    RESULT: SearchResult[];
+    RESULT_LENGTH: number;
+}
+export interface SearchIndex {
+    PUT: (docs: IndexableDocument[]) => Promise<void>;
+    DELETE: (ids: string[]) => Promise<void>;
+    QUERY: (query: {
+        AND: string[];
+    } | {
+        OR: string[];
+    } | {
+        AND: (string | {
+            OR: string[];
+        })[];
+    }, options?: {
+        PAGE?: {
+            NUMBER: number;
+            SIZE: number;
+        };
+    }) => Promise<SearchIndexResult>;
+    DICTIONARY: (token?: {
+        FIELD: string;
+    }) => Promise<unknown[]>;
+}
 export type SearchClient = {
-    query: (query: string, options?: {
-        cursor?: string;
-        limit?: number;
-    }) => Promise<{
-        results: any[];
-        total: number;
-        nextCursor: string | null;
-        prevCursor: string | null;
-    }>;
-    put: (docs: any[]) => Promise<any>;
-    del: (ids: string[]) => Promise<any>;
+    query: (query: string, options?: SearchOptions) => Promise<SearchQueryResponse>;
+    put: (docs: IndexableDocument[] | Record<string, unknown>[]) => Promise<void>;
+    del: (ids: string[]) => Promise<void>;
     onStartIndexing?: () => Promise<void>;
     onFinishIndexing?: () => Promise<void>;
     supportsClientSideIndexing?: () => boolean;

package/package.json

@@ -1,21 +1,20 @@
 {
   "name": "@tinacms/search",
-  "version": "0.0.0-c1132cd-20241024060747",
+  "type": "module",
+  "version": "0.0.0-c19d29e-20251224001156",
   "main": "dist/index.js",
-  "module": "dist/index-client.mjs",
-  "typings": "dist/index.d.ts",
+  "types": "dist/index.d.ts",
   "files": [
-    "package.json",
     "dist"
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
-    "./dist/index-client": {
-      "import": "./dist/index-client.mjs",
-      "require": "./dist/index-client.js"
+    "./index-client": {
+      "types": "./dist/index-client.d.ts",
+      "default": "./dist/index-client.js"
     }
   },
   "license": "SEE LICENSE IN LICENSE",
@@ -31,10 +30,10 @@
   "dependencies": {
     "memory-level": "^1.0.0",
     "search-index": "4.0.0",
-    "sqlite-level": "^1.2.0",
-    "stopword": "^3.1.1",
-    "@tinacms/graphql": "0.0.0-c1132cd-20241024060747",
-    "@tinacms/schema-tools": "0.0.0-c1132cd-20241024060747"
+    "sqlite-level": "^1.2.1",
+    "stopword": "^3.1.4",
+    "@tinacms/graphql": "0.0.0-c19d29e-20251224001156",
+    "@tinacms/schema-tools": "0.0.0-c19d29e-20251224001156"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
@@ -44,23 +43,23 @@
     "directory": "packages/@tinacms/search"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.13",
+    "@types/jest": "^29.5.14",
     "@types/micromatch": "^4.0.9",
-    "@types/node": "^22.7.4",
+    "@types/node": "^22.13.1",
     "@types/search-index": "^3.2.4",
     "jest": "^29.7.0",
     "jest-diff": "^29.7.0",
     "jest-file-snapshot": "^0.7.0",
     "jest-matcher-utils": "^29.7.0",
-    "typescript": "^5.6.2",
-    "@tinacms/scripts": "1.3.0"
+    "typescript": "^5.7.3",
+    "@tinacms/scripts": "1.4.2"
   },
   "scripts": {
     "types": "pnpm tsc",
     "build": "tinacms-scripts build",
     "docs": "pnpm typedoc",
     "serve": "pnpm nodemon dist/server.js",
-    "test": "jest",
-    "test-watch": "jest --watch"
+    "test": "NODE_OPTIONS='--experimental-vm-modules' jest",
+    "test-watch": "NODE_OPTIONS='--experimental-vm-modules' jest --watch"
   }
 }

package/dist/index-client.mjs

@@ -1,195 +0,0 @@
-import * as sw from "stopword";
-class StringBuilder {
-  constructor(limit) {
-    this.length = 0;
-    this.buffer = [];
-    this.limit = limit;
-  }
-  append(str) {
-    if (this.length + str.length > this.limit) {
-      return true;
-    } else {
-      this.buffer.push(str);
-      this.length += str.length;
-      if (this.length > this.limit) {
-        return true;
-      }
-      return false;
-    }
-  }
-  toString() {
-    return this.buffer.join(" ");
-  }
-}
-const extractText = (data, acc, indexableNodeTypes) => {
-  var _a, _b;
-  if (data) {
-    if (indexableNodeTypes.indexOf(data.type) !== -1 && (data.text || data.value)) {
-      const tokens = tokenizeString(data.text || data.value);
-      for (const token of tokens) {
-        if (acc.append(token)) {
-          return;
-        }
-      }
-    }
-    (_b = (_a = data.children) == null ? void 0 : _a.forEach) == null ? void 0 : _b.call(
-      _a,
-      (child) => extractText(child, acc, indexableNodeTypes)
-    );
-  }
-};
-const relativePath = (path, collection) => {
-  return path.replace(/\\/g, "/").replace(collection.path, "").replace(/^\/|\/$/g, "");
-};
-const tokenizeString = (str) => {
-  return str.split(/[\s\.,]+/).map((s) => s.toLowerCase()).filter((s) => s);
-};
-const processTextFieldValue = (value, maxLen) => {
-  const tokens = tokenizeString(value);
-  const builder = new StringBuilder(maxLen);
-  for (const part of tokens) {
-    if (builder.append(part)) {
-      break;
-    }
-  }
-  return builder.toString();
-};
-const processDocumentForIndexing = (data, path, collection, textIndexLength, field) => {
-  if (!field) {
-    const relPath = relativePath(path, collection);
-    data["_id"] = `${collection.name}:${relPath}`;
-    data["_relativePath"] = relPath;
-  }
-  for (const f of (field == null ? void 0 : field.fields) || collection.fields || []) {
-    if (!f.searchable) {
-      delete data[f.name];
-      continue;
-    }
-    const isList = f.list;
-    if (data[f.name]) {
-      if (f.type === "object") {
-        if (isList) {
-          data[f.name] = data[f.name].map(
-            (obj) => processDocumentForIndexing(
-              obj,
-              path,
-              collection,
-              textIndexLength,
-              f
-            )
-          );
-        } else {
-          data[f.name] = processDocumentForIndexing(
-            data[f.name],
-            path,
-            collection,
-            textIndexLength,
-            f
-          );
-        }
-      } else if (f.type === "string") {
-        const fieldTextIndexLength = f.maxSearchIndexFieldLength || textIndexLength;
-        if (isList) {
-          data[f.name] = data[f.name].map(
-            (value) => processTextFieldValue(value, fieldTextIndexLength)
-          );
-        } else {
-          data[f.name] = processTextFieldValue(
-            data[f.name],
-            fieldTextIndexLength
-          );
-        }
-      } else if (f.type === "rich-text") {
-        const fieldTextIndexLength = f.maxSearchIndexFieldLength || textIndexLength;
-        if (isList) {
-          data[f.name] = data[f.name].map((value) => {
-            const acc = new StringBuilder(fieldTextIndexLength);
-            extractText(value, acc, ["text", "code_block", "html"]);
-            return acc.toString();
-          });
-        } else {
-          const acc = new StringBuilder(fieldTextIndexLength);
-          extractText(data[f.name], acc, ["text", "code_block", "html"]);
-          data[f.name] = acc.toString();
-        }
-      }
-    }
-  }
-  return data;
-};
-const memo = {};
-const lookupStopwords = (keys, defaultStopWords = sw.eng) => {
-  let stopwords = defaultStopWords;
-  if (keys) {
-    if (memo[keys.join(",")]) {
-      return memo[keys.join(",")];
-    }
-    stopwords = [];
-    for (const key of keys) {
-      stopwords.push(...sw[key]);
-    }
-    memo[keys.join(",")] = stopwords;
-  }
-  return stopwords;
-};
-const queryToSearchIndexQuery = (query, stopwordLanguages) => {
-  let q;
-  const parts = query.split(" ");
-  const stopwords = lookupStopwords(stopwordLanguages);
-  if (parts.length === 1) {
-    q = { AND: [parts[0]] };
-  } else {
-    q = {
-      AND: parts.filter(
-        (part) => part.toLowerCase() !== "and" && stopwords.indexOf(part.toLowerCase()) === -1
-      )
-    };
-  }
-  return q;
-};
-const optionsToSearchIndexOptions = (options) => {
-  const opt = {};
-  if (options == null ? void 0 : options.limit) {
-    opt["PAGE"] = {
-      SIZE: options.limit,
-      NUMBER: (options == null ? void 0 : options.cursor) ? parseInt(options.cursor) : 0
-    };
-  }
-  return opt;
-};
-const parseSearchIndexResponse = (data, options) => {
-  const results = data["RESULT"];
-  const total = data["RESULT_LENGTH"];
-  if ((options == null ? void 0 : options.cursor) && (options == null ? void 0 : options.limit)) {
-    const prevCursor = options.cursor === "0" ? null : (parseInt(options.cursor) - 1).toString();
-    const nextCursor = total <= (parseInt(options.cursor) + 1) * options.limit ? null : (parseInt(options.cursor) + 1).toString();
-    return {
-      results,
-      total,
-      prevCursor,
-      nextCursor
-    };
-  } else if (!(options == null ? void 0 : options.cursor) && (options == null ? void 0 : options.limit)) {
-    const prevCursor = null;
-    const nextCursor = total <= options.limit ? null : "1";
-    return {
-      results,
-      total,
-      prevCursor,
-      nextCursor
-    };
-  } else {
-    return {
-      results,
-      total,
-      prevCursor: null,
-      nextCursor: null
-    };
-  }
-};
-export {
-  optionsToSearchIndexOptions,
-  parseSearchIndexResponse,
-  processDocumentForIndexing,
-  queryToSearchIndexQuery
-};