okf-search-native 0.6.0 → 0.7.1

package/README.md

@@ -225,57 +225,42 @@ console.log(index.listDegradedDocuments());
 
 ## Performance benchmarks
 
-On a sample OKF bundle of 13,692 Markdown documents (59.57 MiB
-of source text), native opened about **10.8× faster** and used **70% less
-post-open resident memory** in this benchmark.
-
-| Metric | [okf-minisearch][benchmark-minisearch] | [okf-search-native][benchmark-native] | % Reduction |
-| --- | ---: | ---: | ---: |
-| Median `openOkf` time | 21.65 s | 2.00 s | 90.8% |
-| Warm query p50 | 10.93 ms | 1.40 ms | 87.2% |
-| Warm query p95 | 86.93 ms | 2.44 ms | 97.2% |
-| Reported index storage¹ | 200.37 MiB | 81.31 MiB | — |
-| Median post-open RSS | 1,880 MiB | 558 MiB | 70.3% |
-
-¹ MiniSearch: serialized JSON bytes. Native: in-memory Tantivy index-file bytes.
-These measure different representations, not equivalent RAM usage; RSS measures
-total process memory.
-
-[benchmark-minisearch]: https://github.com/robhowley/okf-search/blob/830b9bfb3882cb965b57119d03d2ebcd1f38885a/packages/okf-minisearch/package.json
-[benchmark-native]: https://github.com/robhowley/okf-search/blob/830b9bfb3882cb965b57119d03d2ebcd1f38885a/packages/okf-search-native/package.json
-
-The native column is a committed branch candidate, not a published release. Its
-manifest version is 0.5.1 (MiniSearch: 2.3.0); the benchmarked candidate applies
-this branch's stored-field and compatibility changes relative to base revision
-`830b9bfb3882cb965b57119d03d2ebcd1f38885a`. MiniSearch was built from the base
-revision; native was built from this candidate in release mode.
-
-### Detailed results
-
-Peak RSS medians were 2,930.55 MiB for MiniSearch and 638.87 MiB for native.
-MiniSearch's API-reported serialized-index size was 210,099,191 bytes (200.37
-MiB). Native's API-reported RamDirectory file-map size was 85,259,866 bytes
-(81.31 MiB). These storage measurements are backend-specific: native bytes are
-not total RSS or persisted disk size, and normal background merges can change
-the RamDirectory value after open.
-
-- **Method:** ten balanced AB/BA pairs (20 fresh processes total), run sequentially;
-  five MiniSearch→native pairs and five native→MiniSearch pairs. Each process ran
-  the same nine default-option queries, with 30 warmups and 200 timed calls per
-  query. Open time excludes imports and query calls used the package-root public
-  `openOkf`/`search` APIs, not raw binding methods. Filesystem caches were warm and
-  uncontrolled.
-- **Aggregation:** open time, RSS, peak RSS, and storage are medians across ten
-  fresh processes per backend, with ranges retained in the benchmark report.
-  Query p50/p95 are pooled across 18,000 timed calls per backend, not medians of
-  process-level percentiles.
-- **Memory:** RSS covers the whole process, including native allocations. Post-open
-  samples follow the public `indexStats()` call and forced GC; peak includes startup,
-  opening, stats, and searches. MiniSearch's stats serialization can affect memory
-  and allocator retention.
-- **Limits:** one private corpus, not distributed here; no cold filesystem-cache
-  condition was established. Hit counts and public hit shapes were stable, but
-  result identity, ranking, and scores were not compared between backends.
+Measured on 13,692 Markdown documents (59.57 MiB of source text), using the public
+`openOkf` and `search` APIs.
+
+### Default search options
+
+Fuzzy matching is disabled by default; final-term prefix matching remains enabled.
+
+| Metric | [okf-minisearch][benchmark-minisearch] | [okf-search-native][benchmark-native] |
+| --- | ---: | ---: |
+| Median `openOkf` time | 20.40 s | 1.57 s |
+| Warm query p50 | 10.45 ms | 1.38 ms |
+| Warm query p95 | 86.81 ms | 2.38 ms |
+| Warm query p99 | 95.64 ms | 2.45 ms |
+| Reported index storage¹ | 200.37 MiB | 80.75 MiB |
+| Median post-open RSS | 2,235 MiB | 527 MiB |
+
+### Fuzzy matching enabled
+
+The same queries and defaults, changing only the search call to:
+
+```ts
+index.search(query, { fuzzy: true });
+```
+
+| Metric | [okf-minisearch][benchmark-minisearch] | [okf-search-native][benchmark-native] |
+| --- | ---: | ---: |
+| Warm query p50 | 14.36 ms | 7.96 ms |
+| Warm query p95 | 87.36 ms | 14.12 ms |
+| Warm query p99 | 96.71 ms | 15.00 ms |
+
+¹ MiniSearch reports serialized JSON bytes; native reports in-memory Tantivy
+index-file bytes. These are different storage representations, not equivalent RAM
+measurements. Native storage can vary with background merges.
+
+[benchmark-minisearch]: https://github.com/robhowley/okf-search/blob/31d5da38d9502a85101c670729ca1a9646ad3a32/packages/okf-minisearch/package.json
+[benchmark-native]: https://github.com/robhowley/okf-search/blob/c187a764b10682919805714faf51d54bf53eb133/packages/okf-search-native/package.json
 
 ## Reference and development
 

package/dist/index.cjs

@@ -122,6 +122,8 @@ function sanitizeSearchOptions(options = {}) {
   const asOf = validateAsOf(asOfValue);
   const limitValue = options.limit;
   const limit = validateLimit(limitValue);
+  const snippetLengthValue = options.snippetLength;
+  const snippetLength = validateSnippetLength(snippetLengthValue);
   const matchValue = options.match;
   const match = validateMatch(matchValue);
   const fieldsValue = options.fields;
@@ -136,6 +138,9 @@ function sanitizeSearchOptions(options = {}) {
   if (limitValue !== void 0) {
     native.limit = limit;
   }
+  if (snippetLength !== void 0) {
+    native.snippetLength = snippetLength;
+  }
   if (where !== void 0) {
     native.where = where;
   }
@@ -182,6 +187,17 @@ function validateLimit(value) {
   }
   return limit;
 }
+function validateSnippetLength(value) {
+  if (value === void 0) {
+    return void 0;
+  }
+  if (typeof value !== "number" || !Number.isSafeInteger(value) || value <= 0) {
+    throw new TypeError(
+      "options.snippetLength must be a finite positive integer"
+    );
+  }
+  return value;
+}
 function validateMatch(value) {
   if (value !== void 0 && value !== "any" && value !== "all") {
     throw new TypeError(

package/dist/index.d.cts

@@ -137,6 +137,8 @@ type OkfIngestResult = {
 type OkfSearchField = "resource" | "title" | "heading" | "description" | "tags" | "type" | "sources" | "body";
 interface OkfSearchOptions {
     limit?: number;
+    /** Maximum section-text window in UTF-16 code units, like String.length. */
+    snippetLength?: number;
     where?: {
         types?: readonly string[];
         tagsAny?: readonly string[];

package/dist/index.d.mts

@@ -137,6 +137,8 @@ type OkfIngestResult = {
 type OkfSearchField = "resource" | "title" | "heading" | "description" | "tags" | "type" | "sources" | "body";
 interface OkfSearchOptions {
     limit?: number;
+    /** Maximum section-text window in UTF-16 code units, like String.length. */
+    snippetLength?: number;
     where?: {
         types?: readonly string[];
         tagsAny?: readonly string[];

package/dist/index.d.ts

@@ -137,6 +137,8 @@ type OkfIngestResult = {
 type OkfSearchField = "resource" | "title" | "heading" | "description" | "tags" | "type" | "sources" | "body";
 interface OkfSearchOptions {
     limit?: number;
+    /** Maximum section-text window in UTF-16 code units, like String.length. */
+    snippetLength?: number;
     where?: {
         types?: readonly string[];
         tagsAny?: readonly string[];

package/dist/index.mjs

@@ -94,6 +94,8 @@ function sanitizeSearchOptions(options = {}) {
   const asOf = validateAsOf(asOfValue);
   const limitValue = options.limit;
   const limit = validateLimit(limitValue);
+  const snippetLengthValue = options.snippetLength;
+  const snippetLength = validateSnippetLength(snippetLengthValue);
   const matchValue = options.match;
   const match = validateMatch(matchValue);
   const fieldsValue = options.fields;
@@ -108,6 +110,9 @@ function sanitizeSearchOptions(options = {}) {
   if (limitValue !== void 0) {
     native.limit = limit;
   }
+  if (snippetLength !== void 0) {
+    native.snippetLength = snippetLength;
+  }
   if (where !== void 0) {
     native.where = where;
   }
@@ -154,6 +159,17 @@ function validateLimit(value) {
   }
   return limit;
 }
+function validateSnippetLength(value) {
+  if (value === void 0) {
+    return void 0;
+  }
+  if (typeof value !== "number" || !Number.isSafeInteger(value) || value <= 0) {
+    throw new TypeError(
+      "options.snippetLength must be a finite positive integer"
+    );
+  }
+  return value;
+}
 function validateMatch(value) {
   if (value !== void 0 && value !== "any" && value !== "all") {
     throw new TypeError(

package/native.cjs

@@ -77,8 +77,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-android-arm64')
         const bindingPackageVersion = require('okf-search-native-android-arm64/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -93,8 +93,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-android-arm-eabi')
         const bindingPackageVersion = require('okf-search-native-android-arm-eabi/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -114,8 +114,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-win32-x64-gnu')
         const bindingPackageVersion = require('okf-search-native-win32-x64-gnu/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -130,8 +130,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-win32-x64-msvc')
         const bindingPackageVersion = require('okf-search-native-win32-x64-msvc/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -147,8 +147,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-win32-ia32-msvc')
         const bindingPackageVersion = require('okf-search-native-win32-ia32-msvc/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -163,8 +163,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-win32-arm64-msvc')
         const bindingPackageVersion = require('okf-search-native-win32-arm64-msvc/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -182,8 +182,8 @@ function requireNative() {
     try {
       const binding = require('okf-search-native-darwin-universal')
       const bindingPackageVersion = require('okf-search-native-darwin-universal/package.json').version
-      if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-        throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+      if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+        throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
       }
       return binding
     } catch (e) {
@@ -198,8 +198,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-darwin-x64')
         const bindingPackageVersion = require('okf-search-native-darwin-x64/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -214,8 +214,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-darwin-arm64')
         const bindingPackageVersion = require('okf-search-native-darwin-arm64/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -234,8 +234,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-freebsd-x64')
         const bindingPackageVersion = require('okf-search-native-freebsd-x64/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -250,8 +250,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-freebsd-arm64')
         const bindingPackageVersion = require('okf-search-native-freebsd-arm64/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -271,8 +271,8 @@ function requireNative() {
         try {
           const binding = require('okf-search-native-linux-x64-musl')
           const bindingPackageVersion = require('okf-search-native-linux-x64-musl/package.json').version
-          if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -287,8 +287,8 @@ function requireNative() {
         try {
           const binding = require('okf-search-native-linux-x64-gnu')
           const bindingPackageVersion = require('okf-search-native-linux-x64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -305,8 +305,8 @@ function requireNative() {
         try {
           const binding = require('okf-search-native-linux-arm64-musl')
           const bindingPackageVersion = require('okf-search-native-linux-arm64-musl/package.json').version
-          if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -321,8 +321,8 @@ function requireNative() {
         try {
           const binding = require('okf-search-native-linux-arm64-gnu')
           const bindingPackageVersion = require('okf-search-native-linux-arm64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -339,8 +339,8 @@ function requireNative() {
         try {
           const binding = require('okf-search-native-linux-arm-musleabihf')
           const bindingPackageVersion = require('okf-search-native-linux-arm-musleabihf/package.json').version
-          if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -355,8 +355,8 @@ function requireNative() {
         try {
           const binding = require('okf-search-native-linux-arm-gnueabihf')
           const bindingPackageVersion = require('okf-search-native-linux-arm-gnueabihf/package.json').version
-          if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -373,8 +373,8 @@ function requireNative() {
         try {
           const binding = require('okf-search-native-linux-loong64-musl')
           const bindingPackageVersion = require('okf-search-native-linux-loong64-musl/package.json').version
-          if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -389,8 +389,8 @@ function requireNative() {
         try {
           const binding = require('okf-search-native-linux-loong64-gnu')
           const bindingPackageVersion = require('okf-search-native-linux-loong64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -407,8 +407,8 @@ function requireNative() {
         try {
           const binding = require('okf-search-native-linux-riscv64-musl')
           const bindingPackageVersion = require('okf-search-native-linux-riscv64-musl/package.json').version
-          if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -423,8 +423,8 @@ function requireNative() {
         try {
           const binding = require('okf-search-native-linux-riscv64-gnu')
           const bindingPackageVersion = require('okf-search-native-linux-riscv64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -440,8 +440,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-linux-ppc64-gnu')
         const bindingPackageVersion = require('okf-search-native-linux-ppc64-gnu/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -456,8 +456,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-linux-s390x-gnu')
         const bindingPackageVersion = require('okf-search-native-linux-s390x-gnu/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -476,8 +476,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-openharmony-arm64')
         const bindingPackageVersion = require('okf-search-native-openharmony-arm64/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -492,8 +492,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-openharmony-x64')
         const bindingPackageVersion = require('okf-search-native-openharmony-x64/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -508,8 +508,8 @@ function requireNative() {
       try {
         const binding = require('okf-search-native-openharmony-arm')
         const bindingPackageVersion = require('okf-search-native-openharmony-arm/package.json').version
-        if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.6.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -648,8 +648,8 @@ if (!nativeBinding || forceWasi) {
       if (!candidateFailed) {
         if (process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
           const bindingPackageVersion = require('okf-search-native-wasm32-wasi/package.json').version
-          if (bindingPackageVersion !== '0.5.1') {
-            throw new Error(`WASI binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.6.0') {
+            throw new Error(`WASI binding package version mismatch, expected 0.6.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
         }
         wasiBinding = require('okf-search-native-wasm32-wasi')

package/native.d.cts

@@ -84,14 +84,14 @@ export interface PreparedDocument {
   documentId: string
   path: string
   type: string
-  conformance: string
+  conformance: "strict" | "degraded"
   diagnostics: Array<Diagnostic>
   title: string
   tags: Array<string>
-  status?: string
+  status?: "draft" | "stable" | "deprecated"
   staleAfterEpoch?: number
   stalenessClassified: boolean
-  trustTier?: string
+  trustTier?: "unverified" | "machine-confirmed" | "human-reviewed"
   resource: string
   description: string
   sourceText: string
@@ -123,8 +123,8 @@ export interface SearchHit {
   title: string
   sectionId: string
   score: number
-  conformance: string
-  matchedFields: Array<string>
+  conformance: "strict" | "degraded"
+  matchedFields: Array<"resource" | "title" | "heading" | "description" | "tags" | "type" | "sources" | "body">
   headingPath: string
   path: string
   startLine: number
@@ -134,10 +134,11 @@ export interface SearchHit {
 
 export interface SearchOptions {
   limit?: number
+  snippetLength?: number
   where?: SearchWhere
   asOf?: Date
-  match?: string
-  fields?: Array<string>
+  match?: "any" | "all"
+  fields?: Array<"resource" | "title" | "heading" | "description" | "tags" | "type" | "sources" | "body">
   boost?: SearchBoost
   fuzzy?: boolean | number
 }
@@ -145,10 +146,10 @@ export interface SearchOptions {
 export interface SearchWhere {
   types?: Array<string>
   tagsAny?: Array<string>
-  statuses?: Array<string>
-  trustTiers?: Array<string>
+  statuses?: Array<"draft" | "stable" | "deprecated">
+  trustTiers?: Array<"unverified" | "machine-confirmed" | "human-reviewed">
   stale?: boolean
-  conformance?: Array<string>
+  conformance?: Array<"strict" | "degraded">
 }
 
 export interface Suggestion {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "okf-search-native",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "description": "Search Open Knowledge Format collections at native speed with a lean Rust and Tantivy engine.",
   "keywords": [
     "open-knowledge-format",
@@ -77,7 +77,7 @@
     "test:rust": "cargo test --locked",
     "test:prepare-bundle": "node ../../scripts/check-private-bundling.mjs native",
     "typecheck": "pnpm run test:types",
-    "test": "pnpm run test:prepare-bundle && pnpm run test:types && pnpm run test:package-api && vitest run tests/directory.test.ts tests/lifecycle.test.ts tests/persistence.test.ts tests/raw-boundary.test.ts tests/root-contract.test.ts tests/search-options.test.ts --no-file-parallelism && pnpm run test:rust",
+    "test": "pnpm run test:prepare-bundle && pnpm run test:package-api && vitest run tests/directory.test.ts tests/lifecycle.test.ts tests/persistence.test.ts tests/raw-boundary.test.ts tests/root-contract.test.ts tests/search-options.test.ts --no-file-parallelism && pnpm run test:rust",
     "verify:release-artifacts": "node scripts/verify-release-artifacts.mjs"
   }
 }