okf-search-native 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/README.md +110 -5
  2. package/dist/index.cjs +37 -11
  3. package/dist/index.d.cts +7 -3
  4. package/dist/index.d.mts +7 -3
  5. package/dist/index.d.ts +7 -3
  6. package/dist/index.mjs +37 -11
  7. package/native.cjs +54 -54
  8. package/native.d.cts +2 -1
  9. package/okf-search-native.darwin-arm64.node +0 -0
  10. package/okf-search-native.darwin-x64.node +0 -0
  11. package/okf-search-native.linux-x64-gnu.node +0 -0
  12. package/okf-search-native.win32-x64-msvc.node +0 -0
  13. package/package.json +2 -2
package/README.md CHANGED
@@ -61,13 +61,41 @@ Use the path and line numbers to open the source, and the heading and snippet
61
61
  to display a preview. Results contain at most one hit per document, ordered by
62
62
  relevance. See the [complete result shape](https://github.com/robhowley/okf-search/blob/main/packages/okf-search-native/API.md#results).
63
63
 
64
- **Open once and reuse the handle.** Opening reads and indexes the collection
65
- into memory; every new `openOkf` call rebuilds it. The handle does not watch
66
- files, write changes to disk, or persist the index. Reopen to pick up filesystem
67
- changes.
64
+ ## Open and reuse an index
65
+
66
+ Without options, `openOkf` reads and indexes the collection in memory. The
67
+ handle does not watch files or write source files. Without a cache, call
68
+ `openOkf` again to pick up source filesystem changes.
69
+
70
+ To reuse a native snapshot across processes, pass a filesystem `cachePath`:
71
+
72
+ ```js
73
+ import { openOkf } from "okf-search-native";
74
+
75
+ const cachePath = "./.cache/knowledge.okf";
76
+ const index = await openOkf("./knowledge", { cachePath });
77
+
78
+ index.ingest({
79
+ path: "runbooks/new.md",
80
+ markdown: "---\ntype: runbook\n---\nNew material.\n",
81
+ });
82
+ await index.save(cachePath);
83
+ ```
84
+
85
+ - **First open:** a missing cache is built from `root`; parent directories are
86
+ created, and the complete cache is published before `openOkf` resolves.
87
+ - **Later open:** an existing cache is loaded without reading or requiring
88
+ `root`; saved document paths stay unchanged.
89
+ - **Failures:** an existing directory, dangling link, unreadable, corrupt, or
90
+ incompatible cache destination rejects instead of silently rebuilding from
91
+ `root`. Damaged contents report `ERR_OKF_CACHE_INVALID`; unsupported cache
92
+ metadata reports `ERR_OKF_CACHE_INCOMPATIBLE`.
93
+ - **No cache:** without `cachePath`, the handle stays in memory and creates no
94
+ cache artifacts. `cachePath` is a cache-file path, not a Markdown identity.
68
95
 
69
96
  `openOkf` recursively reads lowercase `.md` files, excluding files named exactly
70
- `index.md` or `log.md`.
97
+ `index.md` or `log.md`. See the [persistence contract](https://github.com/robhowley/okf-search/blob/main/packages/okf-search-native/API.md#persistence)
98
+ for writer exclusion, snapshot timing, and filesystem caveats.
71
99
 
72
100
  ## Already have Markdown strings?
73
101
 
@@ -130,6 +158,29 @@ Use relative `.md` paths, such as `runbooks/restart.md`. If preparation of a
130
158
  replacement fails, the existing document remains searchable.
131
159
  See [update results and path rules](https://github.com/robhowley/okf-search/blob/main/packages/okf-search-native/API.md#update-and-reuse-the-handle).
132
160
 
161
+ ## Save a snapshot
162
+
163
+ `save(path)` explicitly writes the current handle state. It is available on
164
+ handles from both `openOkf` and `createOkfSearch`:
165
+
166
+ ```js
167
+ import { createOkfSearch } from "okf-search-native";
168
+
169
+ const index = createOkfSearch([
170
+ { path: "notes/one.md", markdown: "---\ntype: note\n---\nOne.\n" },
171
+ ]);
172
+
173
+ await index.save("./.cache/notes.okf");
174
+ ```
175
+
176
+ `save` captures one consistent snapshot before returning its promise and
177
+ resolves after atomic publication. Mutations made after capture require another
178
+ save. Concurrent writers to one destination reject with
179
+ `ERR_OKF_CACHE_BUSY`; independent handles are not merged. A failed save does
180
+ not replace a previous complete cache or poison a healthy handle. See the
181
+ [full persistence contract](https://github.com/robhowley/okf-search/blob/main/packages/okf-search-native/API.md#persistence)
182
+ for locking, reader visibility, and filesystem caveats.
183
+
133
184
  ## Check documents and handle failures
134
185
 
135
186
  Documents with valid OKF metadata are **strict**. Some metadata problems make
@@ -172,6 +223,60 @@ console.log(index.listTypes());
172
223
  console.log(index.listDegradedDocuments());
173
224
  ```
174
225
 
226
+ ## Performance benchmarks
227
+
228
+ On a sample OKF bundle of 13,692 Markdown documents (59.57 MiB
229
+ of source text), native opened about **10.8× faster** and used **70% less
230
+ post-open resident memory** in this benchmark.
231
+
232
+ | Metric | [okf-minisearch][benchmark-minisearch] | [okf-search-native][benchmark-native] | % Reduction |
233
+ | --- | ---: | ---: | ---: |
234
+ | Median `openOkf` time | 21.65 s | 2.00 s | 90.8% |
235
+ | Warm query p50 | 10.93 ms | 1.40 ms | 87.2% |
236
+ | Warm query p95 | 86.93 ms | 2.44 ms | 97.2% |
237
+ | Reported index storage¹ | 200.37 MiB | 81.31 MiB | — |
238
+ | Median post-open RSS | 1,880 MiB | 558 MiB | 70.3% |
239
+
240
+ ¹ MiniSearch: serialized JSON bytes. Native: in-memory Tantivy index-file bytes.
241
+ These measure different representations, not equivalent RAM usage; RSS measures
242
+ total process memory.
243
+
244
+ [benchmark-minisearch]: https://github.com/robhowley/okf-search/blob/830b9bfb3882cb965b57119d03d2ebcd1f38885a/packages/okf-minisearch/package.json
245
+ [benchmark-native]: https://github.com/robhowley/okf-search/blob/830b9bfb3882cb965b57119d03d2ebcd1f38885a/packages/okf-search-native/package.json
246
+
247
+ The native column is a committed branch candidate, not a published release. Its
248
+ manifest version is 0.5.1 (MiniSearch: 2.3.0); the benchmarked candidate applies
249
+ this branch's stored-field and compatibility changes relative to base revision
250
+ `830b9bfb3882cb965b57119d03d2ebcd1f38885a`. MiniSearch was built from the base
251
+ revision; native was built from this candidate in release mode.
252
+
253
+ ### Detailed results
254
+
255
+ Peak RSS medians were 2,930.55 MiB for MiniSearch and 638.87 MiB for native.
256
+ MiniSearch's API-reported serialized-index size was 210,099,191 bytes (200.37
257
+ MiB). Native's API-reported RamDirectory file-map size was 85,259,866 bytes
258
+ (81.31 MiB). These storage measurements are backend-specific: native bytes are
259
+ not total RSS or persisted disk size, and normal background merges can change
260
+ the RamDirectory value after open.
261
+
262
+ - **Method:** ten balanced AB/BA pairs (20 fresh processes total), run sequentially;
263
+ five MiniSearch→native pairs and five native→MiniSearch pairs. Each process ran
264
+ the same nine default-option queries, with 30 warmups and 200 timed calls per
265
+ query. Open time excludes imports and query calls used the package-root public
266
+ `openOkf`/`search` APIs, not raw binding methods. Filesystem caches were warm and
267
+ uncontrolled.
268
+ - **Aggregation:** open time, RSS, peak RSS, and storage are medians across ten
269
+ fresh processes per backend, with ranges retained in the benchmark report.
270
+ Query p50/p95 are pooled across 18,000 timed calls per backend, not medians of
271
+ process-level percentiles.
272
+ - **Memory:** RSS covers the whole process, including native allocations. Post-open
273
+ samples follow the public `indexStats()` call and forced GC; peak includes startup,
274
+ opening, stats, and searches. MiniSearch's stats serialization can affect memory
275
+ and allocator retention.
276
+ - **Limits:** one private corpus, not distributed here; no cold filesystem-cache
277
+ condition was established. Hit counts and public hit shapes were stable, but
278
+ result identity, ranking, and scores were not compared between backends.
279
+
175
280
  ## Reference and development
176
281
 
177
282
  - [API reference](https://github.com/robhowley/okf-search/blob/main/packages/okf-search-native/API.md): options, return values, errors, and index statistics.
package/dist/index.cjs CHANGED
@@ -55,6 +55,14 @@ function message(code, path, field) {
55
55
  return `Cannot parse OKF concept: ${subject}`;
56
56
  case "ERR_OKF_FIELD":
57
57
  return `Invalid OKF field: ${subject}`;
58
+ case "ERR_OKF_CACHE_INVALID":
59
+ return `Invalid OKF cache: ${subject}`;
60
+ case "ERR_OKF_CACHE_INCOMPATIBLE":
61
+ return `Incompatible OKF cache: ${subject}`;
62
+ case "ERR_OKF_WRITE":
63
+ return `Cannot write OKF cache: ${subject}`;
64
+ case "ERR_OKF_CACHE_BUSY":
65
+ return `OKF cache is busy: ${subject}`;
58
66
  case "ERR_OKF_INDEX_UNUSABLE":
59
67
  return path === "<index>" ? "Search index is permanently unusable and must be rebuilt" : `Search index failed while mutating ${path}; this OkfSearch handle is permanently unusable and must be rebuilt`;
60
68
  case "ERR_OKF_UNSUPPORTED":
@@ -69,10 +77,10 @@ function throwNativeError(error, path) {
69
77
  if (!NATIVE_MARKER.test(message2)) throw error;
70
78
  if (typeof error === "object" && error !== null && "code" in error && "path" in error) {
71
79
  const detail = error;
72
- if (detail.code === "ERR_OKF_FIELD" || detail.code === "ERR_OKF_PARSE" || detail.code === "ERR_OKF_READ") {
80
+ if (isNativeStructuredCode(detail.code) && typeof detail.path === "string") {
73
81
  throw new OkfError(detail.code, detail.path, {
74
82
  ...detail.field === void 0 ? {} : { field: detail.field },
75
- ...detail.cause === void 0 ? {} : { cause: new Error(String(detail.cause)) }
83
+ ...detail.cause === void 0 ? {} : { cause: new Error(detail.cause) }
76
84
  });
77
85
  }
78
86
  }
@@ -82,6 +90,9 @@ function throwNativeError(error, path) {
82
90
  const sanitized = message2.replace(NATIVE_MARKER, "").trim();
83
91
  throw INVALID_SEARCH_OPTIONS_MARKER.test(message2) ? new TypeError(sanitized) : new Error(sanitized || "Native OKF search failed");
84
92
  }
93
+ function isNativeStructuredCode(code) {
94
+ return code === "ERR_OKF_READ" || code === "ERR_OKF_PARSE" || code === "ERR_OKF_FIELD" || code === "ERR_OKF_CACHE_INVALID" || code === "ERR_OKF_CACHE_INCOMPATIBLE" || code === "ERR_OKF_WRITE" || code === "ERR_OKF_CACHE_BUSY" || code === "ERR_OKF_INDEX_UNUSABLE";
95
+ }
85
96
  function nativeMessage(error) {
86
97
  const message2 = error instanceof Error ? Object.getOwnPropertyDescriptor(error, "message")?.value : void 0;
87
98
  return typeof message2 === "string" ? message2 : "";
@@ -368,18 +379,29 @@ function wrapNative(native) {
368
379
  throw unusableError;
369
380
  }
370
381
  };
382
+ const translateNativeFailure = (path, error) => {
383
+ if (nativeMessage(error).match(POISON_MARKER)) {
384
+ const nativePath = error instanceof Error ? Object.getOwnPropertyDescriptor(error, "path")?.value : void 0;
385
+ const failurePath = typeof nativePath === "string" ? nativePath : path;
386
+ unusableError ??= new OkfError("ERR_OKF_INDEX_UNUSABLE", failurePath);
387
+ throw unusableError;
388
+ }
389
+ throwNativeError(error, path);
390
+ };
371
391
  const callNative = (path, call) => {
372
392
  assertUsable();
373
393
  try {
374
394
  return call();
375
395
  } catch (error) {
376
- if (nativeMessage(error).match(POISON_MARKER)) {
377
- const nativePath = error instanceof Error ? Object.getOwnPropertyDescriptor(error, "path")?.value : void 0;
378
- const failurePath = typeof nativePath === "string" ? nativePath : path;
379
- unusableError ??= new OkfError("ERR_OKF_INDEX_UNUSABLE", failurePath);
380
- throw unusableError;
381
- }
382
- throwNativeError(error, path);
396
+ return translateNativeFailure(path, error);
397
+ }
398
+ };
399
+ const callNativeAsync = async (path, call) => {
400
+ assertUsable();
401
+ try {
402
+ return await call();
403
+ } catch (error) {
404
+ return translateNativeFailure(path, error);
383
405
  }
384
406
  };
385
407
  return {
@@ -387,6 +409,9 @@ function wrapNative(native) {
387
409
  assertUsable();
388
410
  return copyIndexStats(callNative("<index>", () => native.indexStats()));
389
411
  },
412
+ async save(path) {
413
+ await callNativeAsync("<index>", () => native.save(path));
414
+ },
390
415
  ingest(input) {
391
416
  callNative("<index>", () => native.assertUsable());
392
417
  const snapshot = snapshotInput(input);
@@ -491,9 +516,10 @@ function compare(left, right) {
491
516
 
492
517
  // packages/okf-search-native/src/open-okf.ts
493
518
  var import_native2 = require("../native.cjs");
494
- async function openOkf(root) {
519
+ async function openOkf(root, options) {
520
+ const cachePath = options?.cachePath;
495
521
  try {
496
- return wrapNative(await import_native2.NativeOkfSearch.openRaw(root));
522
+ return wrapNative(await import_native2.NativeOkfSearch.openRaw(root, cachePath));
497
523
  } catch (error) {
498
524
  throwNativeError(error, "<index>");
499
525
  }
package/dist/index.d.cts CHANGED
@@ -63,8 +63,11 @@ interface OkfDocumentInput {
63
63
  path: string;
64
64
  markdown: string;
65
65
  }
66
+ interface OkfOpenOptions {
67
+ readonly cachePath?: string;
68
+ }
66
69
  type OkfDiagnosticCode = "ERR_OKF_PARSE" | "ERR_OKF_FIELD";
67
- type OkfErrorCode = "ERR_OKF_READ" | "ERR_OKF_PARSE" | "ERR_OKF_FIELD" | "ERR_OKF_INDEX_UNUSABLE" | "ERR_OKF_UNSUPPORTED";
70
+ type OkfErrorCode = "ERR_OKF_READ" | "ERR_OKF_PARSE" | "ERR_OKF_FIELD" | "ERR_OKF_CACHE_INVALID" | "ERR_OKF_CACHE_INCOMPATIBLE" | "ERR_OKF_WRITE" | "ERR_OKF_CACHE_BUSY" | "ERR_OKF_INDEX_UNUSABLE" | "ERR_OKF_UNSUPPORTED";
68
71
  interface OkfDiagnostic {
69
72
  code: OkfDiagnosticCode;
70
73
  path: string;
@@ -163,6 +166,7 @@ interface OkfSearchHit {
163
166
  }
164
167
  interface OkfSearch {
165
168
  indexStats(): OkfIndexStats;
169
+ save(path: string): Promise<void>;
166
170
  ingest(input: OkfDocumentInput): OkfIngestResult;
167
171
  listDegradedDocuments(): readonly OkfDegradedDocument[];
168
172
  listTypes(): readonly string[];
@@ -184,9 +188,9 @@ declare class OkfError extends Error {
184
188
  constructor(code: OkfErrorCode, path: string, options?: OkfErrorOptions);
185
189
  }
186
190
 
187
- declare function openOkf(root: string): Promise<OkfSearch>;
191
+ declare function openOkf(root: string, options?: OkfOpenOptions): Promise<OkfSearch>;
188
192
 
189
193
  declare function validateOkfDocument(input: OkfDocumentInput): OkfValidationResult;
190
194
 
191
195
  export { OkfError, createOkfSearch, openOkf, validateOkfDocument };
192
- export type { IsoDateTime, OkfAttester, OkfConformance, OkfDegradedDocument, OkfDiagnostic, OkfDiagnosticCode, OkfDocument, OkfDocumentInput, OkfErrorCode, OkfExecutor, OkfGeneration, OkfIndexStats, OkfIndexStorageStats, OkfIngestResult, OkfLogicalIndexStats, OkfParameter, OkfSearch, OkfSearchField, OkfSearchHit, OkfSearchOptions, OkfSource, OkfStatus, OkfTimeWindow, OkfTrustTier, OkfValidationResult, OkfVerification };
196
+ export type { IsoDateTime, OkfAttester, OkfConformance, OkfDegradedDocument, OkfDiagnostic, OkfDiagnosticCode, OkfDocument, OkfDocumentInput, OkfErrorCode, OkfExecutor, OkfGeneration, OkfIndexStats, OkfIndexStorageStats, OkfIngestResult, OkfLogicalIndexStats, OkfOpenOptions, OkfParameter, OkfSearch, OkfSearchField, OkfSearchHit, OkfSearchOptions, OkfSource, OkfStatus, OkfTimeWindow, OkfTrustTier, OkfValidationResult, OkfVerification };
package/dist/index.d.mts CHANGED
@@ -63,8 +63,11 @@ interface OkfDocumentInput {
63
63
  path: string;
64
64
  markdown: string;
65
65
  }
66
+ interface OkfOpenOptions {
67
+ readonly cachePath?: string;
68
+ }
66
69
  type OkfDiagnosticCode = "ERR_OKF_PARSE" | "ERR_OKF_FIELD";
67
- type OkfErrorCode = "ERR_OKF_READ" | "ERR_OKF_PARSE" | "ERR_OKF_FIELD" | "ERR_OKF_INDEX_UNUSABLE" | "ERR_OKF_UNSUPPORTED";
70
+ type OkfErrorCode = "ERR_OKF_READ" | "ERR_OKF_PARSE" | "ERR_OKF_FIELD" | "ERR_OKF_CACHE_INVALID" | "ERR_OKF_CACHE_INCOMPATIBLE" | "ERR_OKF_WRITE" | "ERR_OKF_CACHE_BUSY" | "ERR_OKF_INDEX_UNUSABLE" | "ERR_OKF_UNSUPPORTED";
68
71
  interface OkfDiagnostic {
69
72
  code: OkfDiagnosticCode;
70
73
  path: string;
@@ -163,6 +166,7 @@ interface OkfSearchHit {
163
166
  }
164
167
  interface OkfSearch {
165
168
  indexStats(): OkfIndexStats;
169
+ save(path: string): Promise<void>;
166
170
  ingest(input: OkfDocumentInput): OkfIngestResult;
167
171
  listDegradedDocuments(): readonly OkfDegradedDocument[];
168
172
  listTypes(): readonly string[];
@@ -184,9 +188,9 @@ declare class OkfError extends Error {
184
188
  constructor(code: OkfErrorCode, path: string, options?: OkfErrorOptions);
185
189
  }
186
190
 
187
- declare function openOkf(root: string): Promise<OkfSearch>;
191
+ declare function openOkf(root: string, options?: OkfOpenOptions): Promise<OkfSearch>;
188
192
 
189
193
  declare function validateOkfDocument(input: OkfDocumentInput): OkfValidationResult;
190
194
 
191
195
  export { OkfError, createOkfSearch, openOkf, validateOkfDocument };
192
- export type { IsoDateTime, OkfAttester, OkfConformance, OkfDegradedDocument, OkfDiagnostic, OkfDiagnosticCode, OkfDocument, OkfDocumentInput, OkfErrorCode, OkfExecutor, OkfGeneration, OkfIndexStats, OkfIndexStorageStats, OkfIngestResult, OkfLogicalIndexStats, OkfParameter, OkfSearch, OkfSearchField, OkfSearchHit, OkfSearchOptions, OkfSource, OkfStatus, OkfTimeWindow, OkfTrustTier, OkfValidationResult, OkfVerification };
196
+ export type { IsoDateTime, OkfAttester, OkfConformance, OkfDegradedDocument, OkfDiagnostic, OkfDiagnosticCode, OkfDocument, OkfDocumentInput, OkfErrorCode, OkfExecutor, OkfGeneration, OkfIndexStats, OkfIndexStorageStats, OkfIngestResult, OkfLogicalIndexStats, OkfOpenOptions, OkfParameter, OkfSearch, OkfSearchField, OkfSearchHit, OkfSearchOptions, OkfSource, OkfStatus, OkfTimeWindow, OkfTrustTier, OkfValidationResult, OkfVerification };
package/dist/index.d.ts CHANGED
@@ -63,8 +63,11 @@ interface OkfDocumentInput {
63
63
  path: string;
64
64
  markdown: string;
65
65
  }
66
+ interface OkfOpenOptions {
67
+ readonly cachePath?: string;
68
+ }
66
69
  type OkfDiagnosticCode = "ERR_OKF_PARSE" | "ERR_OKF_FIELD";
67
- type OkfErrorCode = "ERR_OKF_READ" | "ERR_OKF_PARSE" | "ERR_OKF_FIELD" | "ERR_OKF_INDEX_UNUSABLE" | "ERR_OKF_UNSUPPORTED";
70
+ type OkfErrorCode = "ERR_OKF_READ" | "ERR_OKF_PARSE" | "ERR_OKF_FIELD" | "ERR_OKF_CACHE_INVALID" | "ERR_OKF_CACHE_INCOMPATIBLE" | "ERR_OKF_WRITE" | "ERR_OKF_CACHE_BUSY" | "ERR_OKF_INDEX_UNUSABLE" | "ERR_OKF_UNSUPPORTED";
68
71
  interface OkfDiagnostic {
69
72
  code: OkfDiagnosticCode;
70
73
  path: string;
@@ -163,6 +166,7 @@ interface OkfSearchHit {
163
166
  }
164
167
  interface OkfSearch {
165
168
  indexStats(): OkfIndexStats;
169
+ save(path: string): Promise<void>;
166
170
  ingest(input: OkfDocumentInput): OkfIngestResult;
167
171
  listDegradedDocuments(): readonly OkfDegradedDocument[];
168
172
  listTypes(): readonly string[];
@@ -184,9 +188,9 @@ declare class OkfError extends Error {
184
188
  constructor(code: OkfErrorCode, path: string, options?: OkfErrorOptions);
185
189
  }
186
190
 
187
- declare function openOkf(root: string): Promise<OkfSearch>;
191
+ declare function openOkf(root: string, options?: OkfOpenOptions): Promise<OkfSearch>;
188
192
 
189
193
  declare function validateOkfDocument(input: OkfDocumentInput): OkfValidationResult;
190
194
 
191
195
  export { OkfError, createOkfSearch, openOkf, validateOkfDocument };
192
- export type { IsoDateTime, OkfAttester, OkfConformance, OkfDegradedDocument, OkfDiagnostic, OkfDiagnosticCode, OkfDocument, OkfDocumentInput, OkfErrorCode, OkfExecutor, OkfGeneration, OkfIndexStats, OkfIndexStorageStats, OkfIngestResult, OkfLogicalIndexStats, OkfParameter, OkfSearch, OkfSearchField, OkfSearchHit, OkfSearchOptions, OkfSource, OkfStatus, OkfTimeWindow, OkfTrustTier, OkfValidationResult, OkfVerification };
196
+ export type { IsoDateTime, OkfAttester, OkfConformance, OkfDegradedDocument, OkfDiagnostic, OkfDiagnosticCode, OkfDocument, OkfDocumentInput, OkfErrorCode, OkfExecutor, OkfGeneration, OkfIndexStats, OkfIndexStorageStats, OkfIngestResult, OkfLogicalIndexStats, OkfOpenOptions, OkfParameter, OkfSearch, OkfSearchField, OkfSearchHit, OkfSearchOptions, OkfSource, OkfStatus, OkfTimeWindow, OkfTrustTier, OkfValidationResult, OkfVerification };
package/dist/index.mjs CHANGED
@@ -27,6 +27,14 @@ function message(code, path, field) {
27
27
  return `Cannot parse OKF concept: ${subject}`;
28
28
  case "ERR_OKF_FIELD":
29
29
  return `Invalid OKF field: ${subject}`;
30
+ case "ERR_OKF_CACHE_INVALID":
31
+ return `Invalid OKF cache: ${subject}`;
32
+ case "ERR_OKF_CACHE_INCOMPATIBLE":
33
+ return `Incompatible OKF cache: ${subject}`;
34
+ case "ERR_OKF_WRITE":
35
+ return `Cannot write OKF cache: ${subject}`;
36
+ case "ERR_OKF_CACHE_BUSY":
37
+ return `OKF cache is busy: ${subject}`;
30
38
  case "ERR_OKF_INDEX_UNUSABLE":
31
39
  return path === "<index>" ? "Search index is permanently unusable and must be rebuilt" : `Search index failed while mutating ${path}; this OkfSearch handle is permanently unusable and must be rebuilt`;
32
40
  case "ERR_OKF_UNSUPPORTED":
@@ -41,10 +49,10 @@ function throwNativeError(error, path) {
41
49
  if (!NATIVE_MARKER.test(message2)) throw error;
42
50
  if (typeof error === "object" && error !== null && "code" in error && "path" in error) {
43
51
  const detail = error;
44
- if (detail.code === "ERR_OKF_FIELD" || detail.code === "ERR_OKF_PARSE" || detail.code === "ERR_OKF_READ") {
52
+ if (isNativeStructuredCode(detail.code) && typeof detail.path === "string") {
45
53
  throw new OkfError(detail.code, detail.path, {
46
54
  ...detail.field === void 0 ? {} : { field: detail.field },
47
- ...detail.cause === void 0 ? {} : { cause: new Error(String(detail.cause)) }
55
+ ...detail.cause === void 0 ? {} : { cause: new Error(detail.cause) }
48
56
  });
49
57
  }
50
58
  }
@@ -54,6 +62,9 @@ function throwNativeError(error, path) {
54
62
  const sanitized = message2.replace(NATIVE_MARKER, "").trim();
55
63
  throw INVALID_SEARCH_OPTIONS_MARKER.test(message2) ? new TypeError(sanitized) : new Error(sanitized || "Native OKF search failed");
56
64
  }
65
+ function isNativeStructuredCode(code) {
66
+ return code === "ERR_OKF_READ" || code === "ERR_OKF_PARSE" || code === "ERR_OKF_FIELD" || code === "ERR_OKF_CACHE_INVALID" || code === "ERR_OKF_CACHE_INCOMPATIBLE" || code === "ERR_OKF_WRITE" || code === "ERR_OKF_CACHE_BUSY" || code === "ERR_OKF_INDEX_UNUSABLE";
67
+ }
57
68
  function nativeMessage(error) {
58
69
  const message2 = error instanceof Error ? Object.getOwnPropertyDescriptor(error, "message")?.value : void 0;
59
70
  return typeof message2 === "string" ? message2 : "";
@@ -340,18 +351,29 @@ function wrapNative(native) {
340
351
  throw unusableError;
341
352
  }
342
353
  };
354
+ const translateNativeFailure = (path, error) => {
355
+ if (nativeMessage(error).match(POISON_MARKER)) {
356
+ const nativePath = error instanceof Error ? Object.getOwnPropertyDescriptor(error, "path")?.value : void 0;
357
+ const failurePath = typeof nativePath === "string" ? nativePath : path;
358
+ unusableError ??= new OkfError("ERR_OKF_INDEX_UNUSABLE", failurePath);
359
+ throw unusableError;
360
+ }
361
+ throwNativeError(error, path);
362
+ };
343
363
  const callNative = (path, call) => {
344
364
  assertUsable();
345
365
  try {
346
366
  return call();
347
367
  } catch (error) {
348
- if (nativeMessage(error).match(POISON_MARKER)) {
349
- const nativePath = error instanceof Error ? Object.getOwnPropertyDescriptor(error, "path")?.value : void 0;
350
- const failurePath = typeof nativePath === "string" ? nativePath : path;
351
- unusableError ??= new OkfError("ERR_OKF_INDEX_UNUSABLE", failurePath);
352
- throw unusableError;
353
- }
354
- throwNativeError(error, path);
368
+ return translateNativeFailure(path, error);
369
+ }
370
+ };
371
+ const callNativeAsync = async (path, call) => {
372
+ assertUsable();
373
+ try {
374
+ return await call();
375
+ } catch (error) {
376
+ return translateNativeFailure(path, error);
355
377
  }
356
378
  };
357
379
  return {
@@ -359,6 +381,9 @@ function wrapNative(native) {
359
381
  assertUsable();
360
382
  return copyIndexStats(callNative("<index>", () => native.indexStats()));
361
383
  },
384
+ async save(path) {
385
+ await callNativeAsync("<index>", () => native.save(path));
386
+ },
362
387
  ingest(input) {
363
388
  callNative("<index>", () => native.assertUsable());
364
389
  const snapshot = snapshotInput(input);
@@ -463,9 +488,10 @@ function compare(left, right) {
463
488
 
464
489
  // packages/okf-search-native/src/open-okf.ts
465
490
  import { NativeOkfSearch as NativeOkfSearch2 } from "../native.cjs";
466
- async function openOkf(root) {
491
+ async function openOkf(root, options) {
492
+ const cachePath = options?.cachePath;
467
493
  try {
468
- return wrapNative(await NativeOkfSearch2.openRaw(root));
494
+ return wrapNative(await NativeOkfSearch2.openRaw(root, cachePath));
469
495
  } catch (error) {
470
496
  throwNativeError(error, "<index>");
471
497
  }
package/native.cjs CHANGED
@@ -77,8 +77,8 @@ function requireNative() {
77
77
  try {
78
78
  const binding = require('okf-search-native-android-arm64')
79
79
  const bindingPackageVersion = require('okf-search-native-android-arm64/package.json').version
80
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
81
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
80
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
81
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
82
82
  }
83
83
  return binding
84
84
  } catch (e) {
@@ -93,8 +93,8 @@ function requireNative() {
93
93
  try {
94
94
  const binding = require('okf-search-native-android-arm-eabi')
95
95
  const bindingPackageVersion = require('okf-search-native-android-arm-eabi/package.json').version
96
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
97
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
96
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
97
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
98
98
  }
99
99
  return binding
100
100
  } catch (e) {
@@ -114,8 +114,8 @@ function requireNative() {
114
114
  try {
115
115
  const binding = require('okf-search-native-win32-x64-gnu')
116
116
  const bindingPackageVersion = require('okf-search-native-win32-x64-gnu/package.json').version
117
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
118
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
117
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
118
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
119
119
  }
120
120
  return binding
121
121
  } catch (e) {
@@ -130,8 +130,8 @@ function requireNative() {
130
130
  try {
131
131
  const binding = require('okf-search-native-win32-x64-msvc')
132
132
  const bindingPackageVersion = require('okf-search-native-win32-x64-msvc/package.json').version
133
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
134
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
133
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
134
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
135
135
  }
136
136
  return binding
137
137
  } catch (e) {
@@ -147,8 +147,8 @@ function requireNative() {
147
147
  try {
148
148
  const binding = require('okf-search-native-win32-ia32-msvc')
149
149
  const bindingPackageVersion = require('okf-search-native-win32-ia32-msvc/package.json').version
150
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
151
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
150
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
151
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
152
152
  }
153
153
  return binding
154
154
  } catch (e) {
@@ -163,8 +163,8 @@ function requireNative() {
163
163
  try {
164
164
  const binding = require('okf-search-native-win32-arm64-msvc')
165
165
  const bindingPackageVersion = require('okf-search-native-win32-arm64-msvc/package.json').version
166
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
167
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
166
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
167
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
168
168
  }
169
169
  return binding
170
170
  } catch (e) {
@@ -182,8 +182,8 @@ function requireNative() {
182
182
  try {
183
183
  const binding = require('okf-search-native-darwin-universal')
184
184
  const bindingPackageVersion = require('okf-search-native-darwin-universal/package.json').version
185
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
186
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
185
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
186
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
187
187
  }
188
188
  return binding
189
189
  } catch (e) {
@@ -198,8 +198,8 @@ function requireNative() {
198
198
  try {
199
199
  const binding = require('okf-search-native-darwin-x64')
200
200
  const bindingPackageVersion = require('okf-search-native-darwin-x64/package.json').version
201
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
202
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
201
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
202
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
203
203
  }
204
204
  return binding
205
205
  } catch (e) {
@@ -214,8 +214,8 @@ function requireNative() {
214
214
  try {
215
215
  const binding = require('okf-search-native-darwin-arm64')
216
216
  const bindingPackageVersion = require('okf-search-native-darwin-arm64/package.json').version
217
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
218
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
217
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
218
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
219
219
  }
220
220
  return binding
221
221
  } catch (e) {
@@ -234,8 +234,8 @@ function requireNative() {
234
234
  try {
235
235
  const binding = require('okf-search-native-freebsd-x64')
236
236
  const bindingPackageVersion = require('okf-search-native-freebsd-x64/package.json').version
237
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
238
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
237
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
238
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
239
239
  }
240
240
  return binding
241
241
  } catch (e) {
@@ -250,8 +250,8 @@ function requireNative() {
250
250
  try {
251
251
  const binding = require('okf-search-native-freebsd-arm64')
252
252
  const bindingPackageVersion = require('okf-search-native-freebsd-arm64/package.json').version
253
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
254
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
253
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
254
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
255
255
  }
256
256
  return binding
257
257
  } catch (e) {
@@ -271,8 +271,8 @@ function requireNative() {
271
271
  try {
272
272
  const binding = require('okf-search-native-linux-x64-musl')
273
273
  const bindingPackageVersion = require('okf-search-native-linux-x64-musl/package.json').version
274
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
275
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
274
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
275
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
276
276
  }
277
277
  return binding
278
278
  } catch (e) {
@@ -287,8 +287,8 @@ function requireNative() {
287
287
  try {
288
288
  const binding = require('okf-search-native-linux-x64-gnu')
289
289
  const bindingPackageVersion = require('okf-search-native-linux-x64-gnu/package.json').version
290
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
291
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
290
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
291
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
292
292
  }
293
293
  return binding
294
294
  } catch (e) {
@@ -305,8 +305,8 @@ function requireNative() {
305
305
  try {
306
306
  const binding = require('okf-search-native-linux-arm64-musl')
307
307
  const bindingPackageVersion = require('okf-search-native-linux-arm64-musl/package.json').version
308
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
309
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
308
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
309
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
310
310
  }
311
311
  return binding
312
312
  } catch (e) {
@@ -321,8 +321,8 @@ function requireNative() {
321
321
  try {
322
322
  const binding = require('okf-search-native-linux-arm64-gnu')
323
323
  const bindingPackageVersion = require('okf-search-native-linux-arm64-gnu/package.json').version
324
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
325
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
324
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
325
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
326
326
  }
327
327
  return binding
328
328
  } catch (e) {
@@ -339,8 +339,8 @@ function requireNative() {
339
339
  try {
340
340
  const binding = require('okf-search-native-linux-arm-musleabihf')
341
341
  const bindingPackageVersion = require('okf-search-native-linux-arm-musleabihf/package.json').version
342
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
343
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
342
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
343
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
344
344
  }
345
345
  return binding
346
346
  } catch (e) {
@@ -355,8 +355,8 @@ function requireNative() {
355
355
  try {
356
356
  const binding = require('okf-search-native-linux-arm-gnueabihf')
357
357
  const bindingPackageVersion = require('okf-search-native-linux-arm-gnueabihf/package.json').version
358
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
359
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
358
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
359
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
360
360
  }
361
361
  return binding
362
362
  } catch (e) {
@@ -373,8 +373,8 @@ function requireNative() {
373
373
  try {
374
374
  const binding = require('okf-search-native-linux-loong64-musl')
375
375
  const bindingPackageVersion = require('okf-search-native-linux-loong64-musl/package.json').version
376
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
377
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
376
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
377
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
378
378
  }
379
379
  return binding
380
380
  } catch (e) {
@@ -389,8 +389,8 @@ function requireNative() {
389
389
  try {
390
390
  const binding = require('okf-search-native-linux-loong64-gnu')
391
391
  const bindingPackageVersion = require('okf-search-native-linux-loong64-gnu/package.json').version
392
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
393
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
392
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
393
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
394
394
  }
395
395
  return binding
396
396
  } catch (e) {
@@ -407,8 +407,8 @@ function requireNative() {
407
407
  try {
408
408
  const binding = require('okf-search-native-linux-riscv64-musl')
409
409
  const bindingPackageVersion = require('okf-search-native-linux-riscv64-musl/package.json').version
410
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
411
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
410
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
411
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
412
412
  }
413
413
  return binding
414
414
  } catch (e) {
@@ -423,8 +423,8 @@ function requireNative() {
423
423
  try {
424
424
  const binding = require('okf-search-native-linux-riscv64-gnu')
425
425
  const bindingPackageVersion = require('okf-search-native-linux-riscv64-gnu/package.json').version
426
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
427
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
426
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
427
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
428
428
  }
429
429
  return binding
430
430
  } catch (e) {
@@ -440,8 +440,8 @@ function requireNative() {
440
440
  try {
441
441
  const binding = require('okf-search-native-linux-ppc64-gnu')
442
442
  const bindingPackageVersion = require('okf-search-native-linux-ppc64-gnu/package.json').version
443
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
444
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
443
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
444
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
445
445
  }
446
446
  return binding
447
447
  } catch (e) {
@@ -456,8 +456,8 @@ function requireNative() {
456
456
  try {
457
457
  const binding = require('okf-search-native-linux-s390x-gnu')
458
458
  const bindingPackageVersion = require('okf-search-native-linux-s390x-gnu/package.json').version
459
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
460
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
459
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
460
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
461
461
  }
462
462
  return binding
463
463
  } catch (e) {
@@ -476,8 +476,8 @@ function requireNative() {
476
476
  try {
477
477
  const binding = require('okf-search-native-openharmony-arm64')
478
478
  const bindingPackageVersion = require('okf-search-native-openharmony-arm64/package.json').version
479
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
480
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
479
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
480
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
481
481
  }
482
482
  return binding
483
483
  } catch (e) {
@@ -492,8 +492,8 @@ function requireNative() {
492
492
  try {
493
493
  const binding = require('okf-search-native-openharmony-x64')
494
494
  const bindingPackageVersion = require('okf-search-native-openharmony-x64/package.json').version
495
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
496
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
495
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
496
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
497
497
  }
498
498
  return binding
499
499
  } catch (e) {
@@ -508,8 +508,8 @@ function requireNative() {
508
508
  try {
509
509
  const binding = require('okf-search-native-openharmony-arm')
510
510
  const bindingPackageVersion = require('okf-search-native-openharmony-arm/package.json').version
511
- if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
512
- throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
511
+ if (bindingPackageVersion !== '0.5.1' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
512
+ throw new Error(`Native binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
513
513
  }
514
514
  return binding
515
515
  } catch (e) {
@@ -648,8 +648,8 @@ if (!nativeBinding || forceWasi) {
648
648
  if (!candidateFailed) {
649
649
  if (process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
650
650
  const bindingPackageVersion = require('okf-search-native-wasm32-wasi/package.json').version
651
- if (bindingPackageVersion !== '0.4.0') {
652
- throw new Error(`WASI binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
651
+ if (bindingPackageVersion !== '0.5.1') {
652
+ throw new Error(`WASI binding package version mismatch, expected 0.5.1 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
653
653
  }
654
654
  }
655
655
  wasiBinding = require('okf-search-native-wasm32-wasi')
package/native.d.cts CHANGED
@@ -17,7 +17,8 @@ export declare class NativeOkfSearch {
17
17
  */
18
18
  autoSuggest(query: string, options?: SearchOptions | undefined | null): Array<Suggestion>
19
19
  static validateRaw(input: object): unknown
20
- static openRaw(root: string): Promise<NativeOkfSearch>
20
+ static openRaw(root: string, cachePath?: string | undefined | null): Promise<NativeOkfSearch>
21
+ save(path: string): Promise<void>
21
22
  static fromRaw(inputs: Array<object>): NativeOkfSearch
22
23
  assertUsable(): void
23
24
  ingestRaw(input: object): unknown
package/okf-search-native.darwin-arm64.node CHANGED
Binary file
package/okf-search-native.darwin-x64.node CHANGED
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "okf-search-native",
3
- "version": "0.5.0",
3
+ "version": "0.6.0",
4
4
  "description": "Search Open Knowledge Format collections at native speed with a lean Rust and Tantivy engine.",
5
5
  "keywords": [
6
6
  "open-knowledge-format",
@@ -77,7 +77,7 @@
77
77
  "test:rust": "cargo test --locked",
78
78
  "test:prepare-bundle": "node ../../scripts/check-private-bundling.mjs native",
79
79
  "typecheck": "pnpm run test:types",
80
- "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/raw-boundary.test.ts tests/root-contract.test.ts tests/search-options.test.ts --no-file-parallelism && pnpm run test:rust",
80
+ "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",
81
81
  "verify:release-artifacts": "node scripts/verify-release-artifacts.mjs"
82
82
  }
83
83
  }