@lde/search-typesense 0.4.1 → 0.4.3

package/README.md

@@ -17,6 +17,15 @@ type comes from each field’s `kind`, and the physical fanout (per-locale
 search/sort keys) matches what the projection writes, via
 `@lde/search`’s `physicalFields`, so the index and the documents cannot drift.
 
+**Memory lever.** Typesense keeps the index in RAM (with a raw copy of each
+document on disk), so RAM tracks the _indexed_ surface – roughly 2–3× the size
+of the fields you search, facet or sort on – not the full document.
+`buildCollectionSchema` keeps that surface minimal: the `output` display labels
+fan out to `index: false` fields, stored on disk and fetched only for a hit, so
+they cost no RAM; only the folded `*_search_${locale}`, facet/reference and
+`*_sort_${locale}` companions are indexed. Keeping retrieval-only fields
+un-indexed is the lever for holding a large index’s RAM down.
+
 `createTypesenseSearchEngine(client, { collection, labelsCollection })` is the
 `SearchEngine` implementation. Each search:
 

package/dist/collection-schema.d.ts

@@ -25,6 +25,15 @@ export interface CollectionSchemaOptions {
  * untagged `und` locale (and any searchable keyword/reference companion)
  * stems in `defaultLocale` when one is set, and is left unstemmed (folded
  * only) otherwise.
+ *
+ * Memory lever: Typesense holds the index in RAM (with a raw copy of each
+ * document on disk), so RAM tracks the *indexed* surface – roughly 2–3× the
+ * size of the fields you search, facet or sort on – not the whole document.
+ * This builder keeps that surface minimal: the `output` display labels fan out
+ * to `index: false` fields, kept on disk and read back only for a hit, so they
+ * cost no RAM; only the folded `*_search_${locale}`, facet/reference and
+ * `*_sort_${locale}` companions are indexed. Keeping retrieval-only fields
+ * un-indexed is the lever for holding a large index’s RAM down.
  */
 export declare function buildCollectionSchema(searchType: SearchType, options: CollectionSchemaOptions): CollectionCreateSchema;
 //# sourceMappingURL=collection-schema.d.ts.map

package/dist/collection-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collection-schema.d.ts","sourceRoot":"","sources":["../src/collection-schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAExD,OAAO,EAAoB,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAGhE,0EAA0E;AAC1E,MAAM,WAAW,uBAAuB;IACtC,gDAAgD;IAChD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;4BAGwB;IACxB,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,kEAAkE;IAClE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,kEAAkE;IAClE,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,uBAAuB,GAC/B,sBAAsB,CAexB"}
+{"version":3,"file":"collection-schema.d.ts","sourceRoot":"","sources":["../src/collection-schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAExD,OAAO,EAAoB,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAGhE,0EAA0E;AAC1E,MAAM,WAAW,uBAAuB;IACtC,gDAAgD;IAChD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;4BAGwB;IACxB,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,kEAAkE;IAClE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,kEAAkE;IAClE,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1C;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,uBAAuB,GAC/B,sBAAsB,CAexB"}

package/dist/collection-schema.js

@@ -10,6 +10,15 @@ import { physicalFields } from '@lde/search/adapter';
  * untagged `und` locale (and any searchable keyword/reference companion)
  * stems in `defaultLocale` when one is set, and is left unstemmed (folded
  * only) otherwise.
+ *
+ * Memory lever: Typesense holds the index in RAM (with a raw copy of each
+ * document on disk), so RAM tracks the *indexed* surface – roughly 2–3× the
+ * size of the fields you search, facet or sort on – not the whole document.
+ * This builder keeps that surface minimal: the `output` display labels fan out
+ * to `index: false` fields, kept on disk and read back only for a hit, so they
+ * cost no RAM; only the folded `*_search_${locale}`, facet/reference and
+ * `*_sort_${locale}` companions are indexed. Keeping retrieval-only fields
+ * un-indexed is the lever for holding a large index’s RAM down.
  */
 export function buildCollectionSchema(searchType, options) {
     const { defaultLocale } = options;
@@ -31,8 +40,10 @@ function typesenseFields(field, defaultLocale, defaultSortingField) {
     if (field.kind === 'text') {
         const locales = field.locales;
         return [
-            // Display labels: stored, not indexed for search (search uses the folded
-            // companions), accents preserved.
+            // Display labels: stored but NOT indexed (`index: false`) – search hits
+            // the folded `*_search` companions, so the display copy stays on disk and
+            // off RAM (fetched only for a hit), accents preserved. This is the memory
+            // lever: RAM tracks the search surface, not the display text.
             ...names.display.map((name) => ({
                 name,
                 type: 'string',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lde/search-typesense",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "Typesense implementation of the @lde/search SearchEngine port: collection-schema builder, query compiler, label-resolving result reconstruction, and blue/green index lifecycle. Engine-specific (Typesense) but domain-agnostic.",
   "repository": {
     "url": "git+https://github.com/ldelements/lde.git",
@@ -25,7 +25,7 @@
     "!**/*.tsbuildinfo"
   ],
   "dependencies": {
-    "@lde/search": "^0.3.0",
+    "@lde/search": "^0.3.1",
     "@lde/text-normalization": "^0.1.1",
     "tslib": "^2.3.0",
     "typesense": "^3.0.6"
@@ -35,6 +35,6 @@
   },
   "peerDependencies": {
     "@lde/dataset": "^0.7.8",
-    "@lde/pipeline": "^0.33.1"
+    "@lde/pipeline": "^0.33.3"
   }
 }