lucivy-wasm 0.3.0 → 0.4.0

package/README.md

@@ -2,6 +2,8 @@
 
 Fast BM25 full-text search for browsers — WASM build of Lucivy with **threading** (emscripten pthreads), OPFS persistence, and LUCE snapshot support. Runs in a Web Worker.
 
+> **v0.4.0**: Search results can now include stored field values via `{ fields: true }` option.
+>
 > **v0.3.0 breaking change**: This package now uses the emscripten build with threading support. The API is now worker-based (async). See below for migration.
 
 ## Install
@@ -91,8 +93,14 @@ const results2 = await index.search(
     { highlights: true }
 );
 
+// Return stored fields with results
+const results3 = await index.search('programming', { fields: true });
+for (const r of results3) {
+    console.log(r.fields.title, r.score);  // stored field values
+}
+
 // Pre-filtered by doc IDs
-const results3 = await index.searchFiltered('programming', [1, 3], { highlights: true });
+const results4 = await index.searchFiltered('programming', [1, 3], { highlights: true, fields: true });
 
 // Metadata
 const count = await index.numDocs();

package/js/lucivy-worker.js

@@ -265,7 +265,7 @@ self.onmessage = async (e) => {
                 const queryJson = typeof args.query === 'string' && !args.query.startsWith('{')
                     ? JSON.stringify(args.query)
                     : (typeof args.query === 'object' ? JSON.stringify(args.query) : args.query);
-                const json = callStr('lucivy_search', ctx, queryJson, args.limit || 10, args.highlights ? 1 : 0);
+                const json = callStr('lucivy_search', ctx, queryJson, args.limit || 10, args.highlights ? 1 : 0, args.fields ? 1 : 0);
                 result = JSON.parse(json);
                 if (result.error) throw new Error(result.error);
                 break;
@@ -282,8 +282,8 @@ self.onmessage = async (e) => {
                 Module.HEAPU8.set(new Uint8Array(ids.buffer), idsPtr);
 
                 const resPtr = Module.ccall('lucivy_search_filtered', 'number',
-                    ['number', 'string', 'number', 'number', 'number', 'number'],
-                    [ctx, queryJson, args.limit || 10, idsPtr, ids.length, args.highlights ? 1 : 0]);
+                    ['number', 'string', 'number', 'number', 'number', 'number', 'number'],
+                    [ctx, queryJson, args.limit || 10, idsPtr, ids.length, args.highlights ? 1 : 0, args.fields ? 1 : 0]);
                 const json = Module.UTF8ToString(resPtr);
                 Module._free(idsPtr);
 

package/js/lucivy.d.ts

@@ -1,7 +1,7 @@
 /** Field definition for creating an index. */
 export interface FieldDef {
     name: string;
-    type: 'text' | 'u64' | 'i64' | 'f64';
+    type: 'text' | 'string' | 'u64' | 'i64' | 'f64';
 }
 
 /** Search query — either a plain string or a structured query object. */
@@ -18,6 +18,8 @@ export type SearchQuery = string | {
 export interface SearchOptions {
     limit?: number;
     highlights?: boolean;
+    /** Include stored fields in results. */
+    fields?: boolean;
 }
 
 /** A single search result. */
@@ -25,6 +27,8 @@ export interface SearchResult {
     docId: number;
     score: number;
     highlights?: Record<string, [number, number][]>;
+    /** Stored field values (when `fields: true`). */
+    fields?: Record<string, string | number>;
 }
 
 /** Main-thread Promise API for lucivy-emscripten. */

package/js/lucivy.js

@@ -98,6 +98,7 @@ export class LucivyIndex {
             query,
             limit: options.limit,
             highlights: options.highlights,
+            fields: options.fields,
         });
     }
 
@@ -108,6 +109,7 @@ export class LucivyIndex {
             allowedIds,
             limit: options.limit,
             highlights: options.highlights,
+            fields: options.fields,
         });
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lucivy-wasm",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "description": "Fast BM25 full-text search for browsers — WASM build of Lucivy with threading, OPFS persistence, and LUCE snapshot support",
   "license": "MIT",