@ff-labs/fff-node 0.10.5-dev.774d6bc → 0.10.5-nightly.f565d37

package/dist/index.js

@@ -1,11 +1,11 @@
 // src/binary.ts
-import { existsSync, readFileSync } from "node:fs";
-import { createRequire } from "node:module";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
+import { existsSync, readFileSync } from "fs";
+import { createRequire } from "module";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
 
 // src/platform.ts
-import { execSync } from "node:child_process";
+import { execSync } from "child_process";
 function getTriple() {
   const platform = process.platform;
   const arch = process.arch;
@@ -29,11 +29,11 @@ function detectLinuxLibc() {
   try {
     output = execSync("ldd --version 2>&1", {
       encoding: "utf-8",
-      timeout: 5000
+      timeout: 5e3
     });
   } catch (e) {
-    const err = e;
-    output = String(err?.stdout ?? "") + String(err?.stderr ?? "");
+    const err2 = e;
+    output = String(err2?.stdout ?? "") + String(err2?.stderr ?? "");
   }
   if (output.toLowerCase().includes("musl")) {
     return "unknown-linux-musl";
@@ -92,10 +92,8 @@ function getNpmPackageName() {
 }
 
 // src/binary.ts
-var __dirname = "/home/runner/work/fff/fff/packages/fff-node/src";
 function getCurrentDir() {
-  if (typeof __dirname !== "undefined")
-    return __dirname;
+  if (typeof __dirname !== "undefined") return __dirname;
   const url = import.meta.url;
   if (url.startsWith("file://")) {
     return dirname(fileURLToPath(url));
@@ -105,14 +103,15 @@ function getCurrentDir() {
 function getPackageDir() {
   const currentDir = getCurrentDir();
   let dir = currentDir;
-  for (let i = 0;i < 5; i++) {
+  for (let i = 0; i < 5; i++) {
     if (existsSync(join(dir, "package.json"))) {
       try {
         const pkg = JSON.parse(readFileSync(join(dir, "package.json"), "utf-8"));
         if (pkg.name === "@ff-labs/fff-node") {
           return dir;
         }
-      } catch {}
+      } catch {
+      }
     }
     dir = dirname(dir);
   }
@@ -131,7 +130,8 @@ function resolveFromNpmPackage() {
     if (existsSync(binaryPath)) {
       return binaryPath;
     }
-  } catch {}
+  } catch {
+  }
   return null;
 }
 function getDevBinaryPath() {
@@ -156,21 +156,18 @@ function isDevWorkspace() {
 function findBinary() {
   if (isDevWorkspace()) {
     const binPath = join(getPackageDir(), "bin", getLibFilename());
-    if (existsSync(binPath))
-      return binPath;
+    if (existsSync(binPath)) return binPath;
     const devPath = getDevBinaryPath();
-    if (devPath)
-      return devPath;
+    if (devPath) return devPath;
     const npmPath2 = resolveFromNpmPackage();
-    if (npmPath2)
-      return npmPath2;
+    if (npmPath2) return npmPath2;
     return null;
   }
   const npmPath = resolveFromNpmPackage();
-  if (npmPath)
-    return npmPath;
+  if (npmPath) return npmPath;
   return getDevBinaryPath();
 }
+
 // src/ffi.ts
 import {
   close,
@@ -240,32 +237,32 @@ var FFF_RESULT_STRUCT = {
   int_value: DataType.I64
 };
 function loadLibrary() {
-  if (isLoaded)
-    return;
+  if (isLoaded) return;
   const binaryPath = findBinary();
   if (!binaryPath) {
-    throw new Error("fff native library not found. Run `npx @ff-labs/fff-node download` or build from source with `cargo build --release -p fff-c`");
+    throw new Error(
+      "fff native library not found. Run `npx @ff-labs/fff-node download` or build from source with `cargo build --release -p fff-c`"
+    );
   }
   open({ library: LIBRARY_KEY, path: binaryPath });
   isLoaded = true;
 }
 function snakeToCamel(obj) {
-  if (obj === null || obj === undefined)
-    return obj;
-  if (typeof obj !== "object")
-    return obj;
-  if (Array.isArray(obj))
-    return obj.map(snakeToCamel);
+  if (obj === null || obj === void 0) return obj;
+  if (typeof obj !== "object") return obj;
+  if (Array.isArray(obj)) return obj.map(snakeToCamel);
   const result = {};
   for (const [key, value] of Object.entries(obj)) {
-    const camelKey = key.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
+    const camelKey = key.replace(
+      /_([a-z])/g,
+      (_, letter) => letter.toUpperCase()
+    );
     result[camelKey] = snakeToCamel(value);
   }
   return result;
 }
 function readCString(ptr) {
-  if (isNullPointer(ptr))
-    return null;
+  if (isNullPointer(ptr)) return null;
   try {
     const [str] = restorePointer({
       retType: [DataType.String],
@@ -300,7 +297,8 @@ function freeResult(resultPtr) {
       paramsType: [DataType.External],
       paramsValue: [resultPtr]
     });
-  } catch {}
+  } catch {
+  }
 }
 function readResultEnvelope(funcName, paramsType, paramsValue) {
   loadLibrary();
@@ -314,51 +312,43 @@ function readResultEnvelope(funcName, paramsType, paramsValue) {
 }
 function callVoidResult(funcName, paramsType, paramsValue) {
   const res = readResultEnvelope(funcName, paramsType, paramsValue);
-  if ("ok" in res)
-    return res;
+  if ("ok" in res) return res;
   freeResult(res.rawPtr);
-  return { ok: true, value: undefined };
+  return { ok: true, value: void 0 };
 }
 function callIntResult(funcName, paramsType, paramsValue) {
   const res = readResultEnvelope(funcName, paramsType, paramsValue);
-  if ("ok" in res)
-    return res;
+  if ("ok" in res) return res;
   const value = Number(res.struct.int_value);
   freeResult(res.rawPtr);
   return { ok: true, value };
 }
 function callBoolResult(funcName, paramsType, paramsValue) {
   const res = readResultEnvelope(funcName, paramsType, paramsValue);
-  if ("ok" in res)
-    return res;
+  if ("ok" in res) return res;
   const value = Number(res.struct.int_value) !== 0;
   freeResult(res.rawPtr);
   return { ok: true, value };
 }
 function callStringResult(funcName, paramsType, paramsValue) {
   const res = readResultEnvelope(funcName, paramsType, paramsValue);
-  if ("ok" in res)
-    return res;
+  if ("ok" in res) return res;
   const handlePtr = res.struct.handle;
   freeResult(res.rawPtr);
-  if (isNullPointer(handlePtr))
-    return { ok: true, value: null };
+  if (isNullPointer(handlePtr)) return { ok: true, value: null };
   const str = readCString(handlePtr);
   freeString(handlePtr);
   return { ok: true, value: str };
 }
 function callJsonResult(funcName, paramsType, paramsValue) {
   const res = readResultEnvelope(funcName, paramsType, paramsValue);
-  if ("ok" in res)
-    return res;
+  if ("ok" in res) return res;
   const handlePtr = res.struct.handle;
   freeResult(res.rawPtr);
-  if (isNullPointer(handlePtr))
-    return { ok: true, value: undefined };
+  if (isNullPointer(handlePtr)) return { ok: true, value: void 0 };
   const jsonStr = readCString(handlePtr);
   freeString(handlePtr);
-  if (jsonStr === null || jsonStr === "")
-    return { ok: true, value: undefined };
+  if (jsonStr === null || jsonStr === "") return { ok: true, value: void 0 };
   try {
     return { ok: true, value: snakeToCamel(JSON.parse(jsonStr)) };
   } catch {
@@ -374,7 +364,8 @@ function freeString(ptr) {
       paramsType: [DataType.External],
       paramsValue: [ptr]
     });
-  } catch {}
+  } catch {
+  }
 }
 function ffiCreate(basePath, frecencyDbPath, historyDbPath, _useUnsafeNoLock, enableMmapCache, enableContentIndexing, watch, aiMode, logFilePath, logLevel, cacheBudgetMaxFiles, cacheBudgetMaxBytes, cacheBudgetMaxFileSize, enableFsRootScanning, enableHomeDirScanning, followSymlinks) {
   loadLibrary();
@@ -463,6 +454,7 @@ var FFF_SEARCH_RESULT_STRUCT = {
   count: DataType.U32,
   total_matched: DataType.U32,
   total_files: DataType.U32,
+  // FffLocation inlined (flattened)
   location_tag: DataType.U8,
   location_line: DataType.I32,
   location_col: DataType.I32,
@@ -500,6 +492,7 @@ var FFF_MIXED_SEARCH_RESULT_STRUCT = {
   total_matched: DataType.U32,
   total_files: DataType.U32,
   total_dirs: DataType.U32,
+  // FffLocation inlined (flattened)
   location_tag: DataType.U8,
   location_line: DataType.I32,
   location_col: DataType.I32,
@@ -526,6 +519,7 @@ var FFF_GREP_MATCH_STRUCT = {
   context_before_count: DataType.U32,
   context_after_count: DataType.U32,
   fuzzy_score: DataType.U32,
+  // actually u16 in C, but ffi-rs doesn't so we read it as u32 with padding
   has_fuzzy_score: DataType.U8,
   is_binary: DataType.U8,
   is_definition: DataType.U8
@@ -627,10 +621,9 @@ function ptrOffset(base, bytes) {
   });
 }
 function readCStringArray(ptrArray, count) {
-  if (count === 0 || isNullPointer(ptrArray))
-    return [];
+  if (count === 0 || isNullPointer(ptrArray)) return [];
   const result = [];
-  for (let i = 0;i < count; i++) {
+  for (let i = 0; i < count; i++) {
     const elemPtr = ptrOffset(ptrArray, i * 8);
     const [charPtr] = restorePointer({
       retType: [DataType.External],
@@ -642,7 +635,7 @@ function readCStringArray(ptrArray, count) {
 }
 function readGrepMatchFromRaw(raw) {
   const matchRanges = [];
-  for (let i = 0;i < raw.match_ranges_count; i++) {
+  for (let i = 0; i < raw.match_ranges_count; i++) {
     const rangePtr = ptrOffset(raw.match_ranges, i * 8);
     const [rangeRaw] = restorePointer({
       retType: [FFF_MATCH_RANGE_STRUCT],
@@ -702,10 +695,15 @@ function parseGrepResult(rawPtr) {
     paramsValue: wrapPointer([handlePtr])
   });
   const count = gr.count;
-  const regexFallbackError = readCString(gr.regex_fallback_error) ?? undefined;
+  const regexFallbackError = readCString(gr.regex_fallback_error) ?? void 0;
   const items = [];
-  for (let i = 0;i < count; i++) {
-    const rawMatch = callAccessor("fff_grep_result_get_match", handlePtr, i, FFF_GREP_MATCH_STRUCT);
+  for (let i = 0; i < count; i++) {
+    const rawMatch = callAccessor(
+      "fff_grep_result_get_match",
+      handlePtr,
+      i,
+      FFF_GREP_MATCH_STRUCT
+    );
     items.push(readGrepMatchFromRaw(rawMatch));
   }
   load({
@@ -768,10 +766,20 @@ function parseSearchResult(rawPtr) {
   }
   const items = [];
   const scores = [];
-  for (let i = 0;i < count; i++) {
-    const rawItem = callAccessor("fff_search_result_get_item", handlePtr, i, FFF_FILE_ITEM_STRUCT);
+  for (let i = 0; i < count; i++) {
+    const rawItem = callAccessor(
+      "fff_search_result_get_item",
+      handlePtr,
+      i,
+      FFF_FILE_ITEM_STRUCT
+    );
     items.push(readFileItemFromRaw(rawItem));
-    const rawScore = callAccessor("fff_search_result_get_score", handlePtr, i, FFF_SCORE_STRUCT);
+    const rawScore = callAccessor(
+      "fff_search_result_get_score",
+      handlePtr,
+      i,
+      FFF_SCORE_STRUCT
+    );
     scores.push(readScoreFromRaw(rawScore));
   }
   load({
@@ -816,10 +824,20 @@ function parseDirSearchResult(rawPtr) {
   const count = sr.count;
   const items = [];
   const scores = [];
-  for (let i = 0;i < count; i++) {
-    const rawItem = callAccessor("fff_dir_search_result_get_item", handlePtr, i, FFF_DIR_ITEM_STRUCT);
+  for (let i = 0; i < count; i++) {
+    const rawItem = callAccessor(
+      "fff_dir_search_result_get_item",
+      handlePtr,
+      i,
+      FFF_DIR_ITEM_STRUCT
+    );
     items.push(readDirItemFromRaw(rawItem));
-    const rawScore = callAccessor("fff_dir_search_result_get_score", handlePtr, i, FFF_SCORE_STRUCT);
+    const rawScore = callAccessor(
+      "fff_dir_search_result_get_score",
+      handlePtr,
+      i,
+      FFF_SCORE_STRUCT
+    );
     scores.push(readScoreFromRaw(rawScore));
   }
   load({
@@ -879,10 +897,20 @@ function parseMixedSearchResult(rawPtr) {
   }
   const items = [];
   const scores = [];
-  for (let i = 0;i < count; i++) {
-    const rawItem = callAccessor("fff_mixed_search_result_get_item", handlePtr, i, FFF_MIXED_ITEM_STRUCT);
+  for (let i = 0; i < count; i++) {
+    const rawItem = callAccessor(
+      "fff_mixed_search_result_get_item",
+      handlePtr,
+      i,
+      FFF_MIXED_ITEM_STRUCT
+    );
     items.push(readMixedItemFromRaw(rawItem));
-    const rawScore = callAccessor("fff_mixed_search_result_get_score", handlePtr, i, FFF_SCORE_STRUCT);
+    const rawScore = callAccessor(
+      "fff_mixed_search_result_get_score",
+      handlePtr,
+      i,
+      FFF_SCORE_STRUCT
+    );
     scores.push(readScoreFromRaw(rawScore));
   }
   load({
@@ -912,13 +940,21 @@ function ffiSearch(handle, query, currentFile, maxThreads, pageIndex, pageSize,
     retType: DataType.External,
     paramsType: [
       DataType.External,
+      // handle
       DataType.String,
+      // query
       DataType.String,
+      // current_file
       DataType.U32,
+      // max_threads
       DataType.U32,
+      // page_index
       DataType.U32,
+      // page_size
       DataType.I32,
+      // combo_boost_multiplier
       DataType.U32
+      // min_combo_count
     ],
     paramsValue: [
       handle,
@@ -942,11 +978,17 @@ function ffiGlob(handle, pattern, currentFile, maxThreads, pageIndex, pageSize)
     retType: DataType.External,
     paramsType: [
       DataType.External,
+      // handle
       DataType.String,
+      // pattern
       DataType.String,
+      // current_file
       DataType.U32,
+      // max_threads
       DataType.U32,
+      // page_index
       DataType.U32
+      // page_size
     ],
     paramsValue: [handle, pattern, currentFile, maxThreads, pageIndex, pageSize],
     freeResultMemory: false
@@ -961,11 +1003,17 @@ function ffiSearchDirectories(handle, query, currentFile, maxThreads, pageIndex,
     retType: DataType.External,
     paramsType: [
       DataType.External,
+      // handle
       DataType.String,
+      // query
       DataType.String,
+      // current_file
       DataType.U32,
+      // max_threads
       DataType.U32,
+      // page_index
       DataType.U32
+      // page_size
     ],
     paramsValue: [handle, query, currentFile ?? "", maxThreads, pageIndex, pageSize],
     freeResultMemory: false
@@ -980,13 +1028,21 @@ function ffiSearchMixed(handle, query, currentFile, maxThreads, pageIndex, pageS
     retType: DataType.External,
     paramsType: [
       DataType.External,
+      // handle
       DataType.String,
+      // query
       DataType.String,
+      // current_file
       DataType.U32,
+      // max_threads
       DataType.U32,
+      // page_index
       DataType.U32,
+      // page_size
       DataType.I32,
+      // combo_boost_multiplier
       DataType.U32
+      // min_combo_count
     ],
     paramsValue: [
       handle,
@@ -1010,17 +1066,29 @@ function ffiLiveGrep(handle, query, mode, maxFileSize, maxMatchesPerFile, smartC
     retType: DataType.External,
     paramsType: [
       DataType.External,
+      // handle
       DataType.String,
+      // query
       DataType.U8,
+      // mode
       DataType.U64,
+      // max_file_size
       DataType.U32,
+      // max_matches_per_file
       DataType.Boolean,
+      // smart_case
       DataType.U32,
+      // file_offset
       DataType.U32,
+      // page_limit
       DataType.U64,
+      // time_budget_ms
       DataType.U32,
+      // before_context
       DataType.U32,
+      // after_context
       DataType.Boolean
+      // classify_definitions
     ],
     paramsValue: [
       handle,
@@ -1048,17 +1116,29 @@ function ffiMultiGrep(handle, patternsJoined, constraints, maxFileSize, maxMatch
     retType: DataType.External,
     paramsType: [
       DataType.External,
+      // handle
       DataType.String,
+      // patterns_joined
       DataType.String,
+      // constraints
       DataType.U64,
+      // max_file_size
       DataType.U32,
+      // max_matches_per_file
       DataType.Boolean,
+      // smart_case
       DataType.U32,
+      // file_offset
       DataType.U32,
+      // page_limit
       DataType.U64,
+      // time_budget_ms
       DataType.U32,
+      // before_context
       DataType.U32,
+      // after_context
       DataType.Boolean
+      // classify_definitions
     ],
     paramsValue: [
       handle,
@@ -1103,12 +1183,10 @@ var FFF_SCAN_PROGRESS_STRUCT = {
 function ffiGetScanProgress(handle) {
   loadLibrary();
   const res = readResultEnvelope("fff_get_scan_progress", [DataType.External], [handle]);
-  if ("ok" in res)
-    return res;
+  if ("ok" in res) return res;
   const handlePtr = res.struct.handle;
   freeResult(res.rawPtr);
-  if (isNullPointer(handlePtr))
-    return err("scan progress returned null");
+  if (isNullPointer(handlePtr)) return err("scan progress returned null");
   const [sp] = restorePointer({
     retType: [FFF_SCAN_PROGRESS_STRUCT],
     paramsValue: wrapPointer([handlePtr])
@@ -1129,19 +1207,35 @@ function ffiGetScanProgress(handle) {
   return { ok: true, value: result };
 }
 function ffiWaitForScan(handle, timeoutMs) {
-  return callBoolResult("fff_wait_for_scan", [DataType.External, DataType.U64], [handle, timeoutMs]);
+  return callBoolResult(
+    "fff_wait_for_scan",
+    [DataType.External, DataType.U64],
+    [handle, timeoutMs]
+  );
 }
 function ffiRestartIndex(handle, newPath) {
-  return callVoidResult("fff_restart_index", [DataType.External, DataType.String], [handle, newPath]);
+  return callVoidResult(
+    "fff_restart_index",
+    [DataType.External, DataType.String],
+    [handle, newPath]
+  );
 }
 function ffiRefreshGitStatus(handle) {
   return callIntResult("fff_refresh_git_status", [DataType.External], [handle]);
 }
 function ffiTrackQuery(handle, query, filePath) {
-  return callBoolResult("fff_track_query", [DataType.External, DataType.String, DataType.String], [handle, query, filePath]);
+  return callBoolResult(
+    "fff_track_query",
+    [DataType.External, DataType.String, DataType.String],
+    [handle, query, filePath]
+  );
 }
 function ffiGetHistoricalQuery(handle, offset) {
-  return callStringResult("fff_get_historical_query", [DataType.External, DataType.U64], [handle, offset]);
+  return callStringResult(
+    "fff_get_historical_query",
+    [DataType.External, DataType.U64],
+    [handle, offset]
+  );
 }
 function watchKindFromU8(kind) {
   switch (kind) {
@@ -1159,8 +1253,8 @@ var WATCH_TRAMPOLINE_TYPE = funcConstructor({
   paramsType: [DataType.U64, DataType.U64, DataType.U64],
   retType: DataType.Void
 });
-var watchHandlers = new Map;
-var watchInstances = new Set;
+var watchHandlers = /* @__PURE__ */ new Map();
+var watchInstances = /* @__PURE__ */ new Set();
 var watchTrampoline = null;
 function addressToExternal(address) {
   return load({
@@ -1181,7 +1275,7 @@ function consumeWatchBatch(address) {
     paramsValue: [batchPtr]
   });
   const events = [];
-  for (let i = 0;i < count; i++) {
+  for (let i = 0; i < count; i++) {
     const path = load({
       library: LIBRARY_KEY,
       funcName: "fff_watch_events_get_path",
@@ -1213,11 +1307,11 @@ function consumeWatchBatch(address) {
 function watchTrampolineImpl(watchId, batchAddress, _userData) {
   const events = consumeWatchBatch(batchAddress);
   const handler = watchHandlers.get(Number(watchId));
-  if (handler === undefined || events.length === 0)
-    return;
+  if (handler === void 0 || events.length === 0) return;
   try {
     handler(events);
-  } catch {}
+  } catch {
+  }
 }
 function ensureWatchTrampoline() {
   if (watchTrampoline === null) {
@@ -1229,12 +1323,14 @@ function ensureWatchTrampoline() {
   return unwrapPointer(watchTrampoline)[0];
 }
 function ensureWatchCallbackRegistered(handle) {
-  if (watchInstances.has(handle))
-    return { ok: true, value: undefined };
+  if (watchInstances.has(handle)) return { ok: true, value: void 0 };
   const trampoline = ensureWatchTrampoline();
-  const registered = callVoidResult("fff_set_watch_callback", [DataType.External, DataType.External, DataType.U64], [handle, trampoline, 0]);
-  if (registered.ok)
-    watchInstances.add(handle);
+  const registered = callVoidResult(
+    "fff_set_watch_callback",
+    [DataType.External, DataType.External, DataType.U64],
+    [handle, trampoline, 0]
+  );
+  if (registered.ok) watchInstances.add(handle);
   return registered;
 }
 function releaseWatchTrampolineIfIdle() {
@@ -1250,16 +1346,22 @@ function releaseWatchTrampolineIfIdle() {
 function ffiWatch(handle, pattern, ignore, callback) {
   loadLibrary();
   const registered = ensureWatchCallbackRegistered(handle);
-  if (!registered.ok)
-    return registered;
-  const created = callIntResult("fff_watch_args", [DataType.External, DataType.String, DataType.StringArray, DataType.U32], [handle, pattern, ignore, ignore.length]);
-  if (!created.ok)
-    return created;
+  if (!registered.ok) return registered;
+  const created = callIntResult(
+    "fff_watch_args",
+    [DataType.External, DataType.String, DataType.StringArray, DataType.U32],
+    [handle, pattern, ignore, ignore.length]
+  );
+  if (!created.ok) return created;
   watchHandlers.set(created.value, callback);
   return created;
 }
 function ffiUnwatch(handle, watchId) {
-  const result = callBoolResult("fff_unwatch", [DataType.External, DataType.U64], [handle, watchId]);
+  const result = callBoolResult(
+    "fff_unwatch",
+    [DataType.External, DataType.U64],
+    [handle, watchId]
+  );
   watchHandlers.delete(watchId);
   return result;
 }
@@ -1272,9 +1374,17 @@ function ffiWatchCleanupAfterDestroy(handle, watchIds) {
 }
 function ffiHealthCheck(handle, testPath) {
   if (handle === null) {
-    return callJsonResult("fff_health_check", [DataType.U64, DataType.String], [0, testPath]);
-  }
-  return callJsonResult("fff_health_check", [DataType.External, DataType.String], [handle, testPath]);
+    return callJsonResult(
+      "fff_health_check",
+      [DataType.U64, DataType.String],
+      [0, testPath]
+    );
+  }
+  return callJsonResult(
+    "fff_health_check",
+    [DataType.External, DataType.String],
+    [handle, testPath]
+  );
 }
 function ensureLoaded() {
   loadLibrary();
@@ -1293,20 +1403,65 @@ function closeLibrary() {
     isLoaded = false;
   }
 }
+
 // src/finder.ts
-class FileFinder {
+var FileFinder = class _FileFinder {
   handle;
-  watchers = new Set;
+  /** Native ids of this instance's active watch subscriptions. */
+  watchers = /* @__PURE__ */ new Set();
   constructor(handle) {
     this.handle = handle;
   }
+  /**
+   * Create a new file finder instance.
+   *
+   * @param options - Initialization options
+   * @returns Result containing the new FileFinder instance or an error
+   *
+   * @example
+   * ```typescript
+   * // Basic initialization
+   * const finder = FileFinder.create({ basePath: "/path/to/project" });
+   *
+   * // With custom database paths
+   * const finder = FileFinder.create({
+   *   basePath: "/path/to/project",
+   *   frecencyDbPath: "/custom/frecency.mdb",
+   *   historyDbPath: "/custom/history.mdb",
+   * });
+   * ```
+   */
   static create(options) {
-    const result = ffiCreate(options.basePath, options.frecencyDbPath ?? "", options.historyDbPath ?? "", options.useUnsafeNoLock ?? false, !(options.disableMmapCache ?? false), !(options.disableContentIndexing ?? options.disableMmapCache ?? false), !(options.disableWatch ?? false), options.aiMode ?? false, options.logFilePath ?? "", options.logLevel ?? "", options.cacheBudgetMaxFiles ?? 0, options.cacheBudgetMaxBytes ?? 0, options.cacheBudgetMaxFileSize ?? 0, options.enableFsRootScanning ?? false, options.enableHomeDirScanning ?? false, options.followSymlinks ?? false);
+    const result = ffiCreate(
+      options.basePath,
+      options.frecencyDbPath ?? "",
+      options.historyDbPath ?? "",
+      options.useUnsafeNoLock ?? false,
+      !(options.disableMmapCache ?? false),
+      !(options.disableContentIndexing ?? options.disableMmapCache ?? false),
+      !(options.disableWatch ?? false),
+      options.aiMode ?? false,
+      options.logFilePath ?? "",
+      options.logLevel ?? "",
+      options.cacheBudgetMaxFiles ?? 0,
+      options.cacheBudgetMaxBytes ?? 0,
+      options.cacheBudgetMaxFileSize ?? 0,
+      options.enableFsRootScanning ?? false,
+      options.enableHomeDirScanning ?? false,
+      options.followSymlinks ?? false
+    );
     if (!result.ok) {
       return result;
     }
-    return { ok: true, value: new FileFinder(result.value) };
-  }
+    return { ok: true, value: new _FileFinder(result.value) };
+  }
+  /**
+   * Destroy and clean up all resources.
+   *
+   * Call this when you're done using the file finder to free memory
+   * and stop background file watching. After calling this, the instance
+   * must not be used again.
+   */
   destroy() {
     if (this.handle !== null) {
       const handle = this.handle;
@@ -1316,82 +1471,314 @@ class FileFinder {
       this.watchers.clear();
     }
   }
+  /**
+   * Check if this instance has been destroyed.
+   */
   get isDestroyed() {
     return this.handle === null;
   }
+  /**
+   * Guard that returns an error if the instance has been destroyed.
+   */
   ensureAlive() {
     if (this.handle === null) {
       return err("FileFinder instance has been destroyed.");
     }
     return { ok: true, value: this.handle };
   }
+  /**
+   * Search for files matching the query.
+   *
+   * The query supports fuzzy matching and special syntax:
+   * - `foo bar` - Match files containing "foo" and "bar"
+   * - `src/` - Match files in src directory
+   * - `file.ts:42` - Match file.ts with line 42
+   * - `file.ts:42:10` - Match file.ts with line 42, column 10
+   *
+   * @param query - Search query string
+   * @param options - Search options
+   * @returns Search results with matched files and scores
+   *
+   * @example
+   * ```typescript
+   * const result = finder.search("main.ts", { pageSize: 10 });
+   * if (result.ok) {
+   *   console.log(`Found ${result.value.totalMatched} files`);
+   *   for (const item of result.value.items) {
+   *     console.log(item.relativePath);
+   *   }
+   * }
+   * ```
+   */
   fileSearch(query, options) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
-    return ffiSearch(guard.value, query, options?.currentFile ?? "", options?.maxThreads ?? 0, options?.pageIndex ?? 0, options?.pageSize ?? 0, options?.comboBoostMultiplier ?? 0, options?.minComboCount ?? 0);
-  }
+    if (!guard.ok) return guard;
+    return ffiSearch(
+      guard.value,
+      query,
+      options?.currentFile ?? "",
+      options?.maxThreads ?? 0,
+      options?.pageIndex ?? 0,
+      options?.pageSize ?? 0,
+      options?.comboBoostMultiplier ?? 0,
+      options?.minComboCount ?? 0
+    );
+  }
+  /**
+   * Filters files using glob wildcard expression.
+   *
+   * The pattern is applied as a single pass SIMD optimized prefiltering
+   * without any fuzzy matching involved. Faster and 100% compatible to npm `glob`.
+   *
+   * @param pattern - Glob pattern (required, non-empty)
+   * @param options - Glob search options (pagination, max threads, current file)
+   * @returns Search results with files matching the glob
+   *
+   * @example
+   * ```typescript
+   * const result = finder.glob("**\/*.rs", { pageSize: 100 });
+   * if (result.ok) {
+   *   for (const item of result.value.items) {
+   *     console.log(item.relativePath);
+   *   }
+   * }
+   * ```
+   */
   glob(pattern, options) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
-    return ffiGlob(guard.value, pattern, options?.currentFile ?? "", options?.maxThreads ?? 0, options?.pageIndex ?? 0, options?.pageSize ?? 0);
-  }
+    if (!guard.ok) return guard;
+    return ffiGlob(
+      guard.value,
+      pattern,
+      options?.currentFile ?? "",
+      options?.maxThreads ?? 0,
+      options?.pageIndex ?? 0,
+      options?.pageSize ?? 0
+    );
+  }
+  /**
+   * Search for directories matching the query.
+   *
+   * @param query - Search query string
+   * @param options - Directory search options
+   * @returns Search results with matched directories and scores
+   *
+   * @example
+   * ```typescript
+   * const result = finder.directorySearch("src/comp", { pageSize: 10 });
+   * if (result.ok) {
+   *   console.log(`Found ${result.value.totalMatched} directories`);
+   *   for (const item of result.value.items) {
+   *     console.log(item.relativePath);
+   *   }
+   * }
+   * ```
+   */
   directorySearch(query, options) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
-    return ffiSearchDirectories(guard.value, query, options?.currentFile ?? null, options?.maxThreads ?? 0, options?.pageIndex ?? 0, options?.pageSize ?? 0);
-  }
+    if (!guard.ok) return guard;
+    return ffiSearchDirectories(
+      guard.value,
+      query,
+      options?.currentFile ?? null,
+      options?.maxThreads ?? 0,
+      options?.pageIndex ?? 0,
+      options?.pageSize ?? 0
+    );
+  }
+  /**
+   * Search for files and directories matching the query (mixed results).
+   *
+   * Results are interleaved by total score in descending order, mixing
+   * both file and directory items.
+   *
+   * @param query - Search query string
+   * @param options - Search options
+   * @returns Mixed search results with files and directories interleaved by score
+   *
+   * @example
+   * ```typescript
+   * const result = finder.mixedSearch("main", { pageSize: 20 });
+   * if (result.ok) {
+   *   for (const entry of result.value.items) {
+   *     if (entry.type === "file") {
+   *       console.log(`File: ${entry.item.relativePath}`);
+   *     } else {
+   *       console.log(`Dir: ${entry.item.relativePath}`);
+   *     }
+   *   }
+   * }
+   * ```
+   */
   mixedSearch(query, options) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
-    return ffiSearchMixed(guard.value, query, options?.currentFile ?? "", options?.maxThreads ?? 0, options?.pageIndex ?? 0, options?.pageSize ?? 0, options?.comboBoostMultiplier ?? 0, options?.minComboCount ?? 0);
-  }
+    if (!guard.ok) return guard;
+    return ffiSearchMixed(
+      guard.value,
+      query,
+      options?.currentFile ?? "",
+      options?.maxThreads ?? 0,
+      options?.pageIndex ?? 0,
+      options?.pageSize ?? 0,
+      options?.comboBoostMultiplier ?? 0,
+      options?.minComboCount ?? 0
+    );
+  }
+  /**
+   * Search file contents (live grep).
+   *
+   * Searches through the contents of indexed files using the specified mode:
+   * - `"plain"` (default): SIMD-accelerated literal text matching
+   * - `"regex"`: Regular expression matching
+   * - `"fuzzy"`: Smith-Waterman fuzzy matching per line
+   *
+   * Supports pagination for large result sets. The result includes a `nextCursor`
+   * that can be passed back to fetch the next page.
+   *
+   * The query also supports constraint syntax:
+   * - `*.ts pattern` - Only search in TypeScript files
+   * - `src/ pattern` - Only search in the src directory
+   *
+   * @param query - Search query string
+   * @param options - Grep options (mode, pagination, limits)
+   * @returns Grep results with matched lines and file metadata
+   *
+   * @example
+   * ```typescript
+   * // First page
+   * const result = finder.grep("TODO", { mode: "plain" });
+   * if (result.ok) {
+   *   for (const match of result.value.items) {
+   *     console.log(`${match.relativePath}:${match.lineNumber}: ${match.lineContent}`);
+   *   }
+   *   // Fetch next page
+   *   if (result.value.nextCursor) {
+   *     const page2 = finder.grep("TODO", {
+   *       cursor: result.value.nextCursor,
+   *     });
+   *   }
+   * }
+   * ```
+   */
   grep(query, options) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
-    return ffiLiveGrep(guard.value, query, options?.mode ?? "plain", options?.maxFileSize ?? 0, options?.maxMatchesPerFile ?? 0, options?.smartCase ?? true, options?.cursor?._offset ?? 0, options?.pageSize ?? 0, options?.timeBudgetMs ?? 0, options?.beforeContext ?? 0, options?.afterContext ?? 0, options?.classifyDefinitions ?? false);
-  }
+    if (!guard.ok) return guard;
+    return ffiLiveGrep(
+      guard.value,
+      query,
+      options?.mode ?? "plain",
+      options?.maxFileSize ?? 0,
+      options?.maxMatchesPerFile ?? 0,
+      options?.smartCase ?? true,
+      options?.cursor?._offset ?? 0,
+      options?.pageSize ?? 0,
+      options?.timeBudgetMs ?? 0,
+      options?.beforeContext ?? 0,
+      options?.afterContext ?? 0,
+      options?.classifyDefinitions ?? false
+    );
+  }
+  /**
+   * Multi-pattern OR search using Aho-Corasick.
+   *
+   * Searches for lines matching ANY of the provided patterns using
+   * SIMD-accelerated multi-needle matching. Faster than regex alternation
+   * for literal text searches.
+   *
+   * Supports pagination. The result includes a `nextCursor` that can be
+   * passed back to fetch the next page.
+   *
+   * @param options - Multi-grep options including patterns and optional constraints
+   * @returns Grep results with matched lines and file metadata
+   *
+   * @example
+   * ```typescript
+   * const result = finder.multiGrep({
+   *   patterns: ["VideoFrame", "video_frame", "PreloadedImage"],
+   * });
+   * if (result.ok) {
+   *   for (const match of result.value.items) {
+   *     console.log(`${match.relativePath}:${match.lineNumber}: ${match.lineContent}`);
+   *   }
+   * }
+   * ```
+   */
   multiGrep(options) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     if (!options.patterns || options.patterns.length === 0) {
       return err("patterns array must have at least 1 element");
     }
-    return ffiMultiGrep(guard.value, options.patterns.join(`
-`), options.constraints ?? "", options.maxFileSize ?? 0, options.maxMatchesPerFile ?? 0, options.smartCase ?? true, options.cursor?._offset ?? 0, options.pageSize ?? 0, options.timeBudgetMs ?? 0, options.beforeContext ?? 0, options.afterContext ?? 0, options.classifyDefinitions ?? false);
-  }
+    return ffiMultiGrep(
+      guard.value,
+      options.patterns.join("\n"),
+      options.constraints ?? "",
+      options.maxFileSize ?? 0,
+      options.maxMatchesPerFile ?? 0,
+      options.smartCase ?? true,
+      options.cursor?._offset ?? 0,
+      options.pageSize ?? 0,
+      options.timeBudgetMs ?? 0,
+      options.beforeContext ?? 0,
+      options.afterContext ?? 0,
+      options.classifyDefinitions ?? false
+    );
+  }
+  /**
+   * Trigger a rescan of the indexed directory.
+   *
+   * This is useful after major file system changes that the
+   * background watcher might have missed.
+   */
   scanFiles() {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     return ffiScanFiles(guard.value);
   }
+  /**
+   * Check if a scan is currently in progress.
+   */
   isScanning() {
-    if (this.handle === null)
-      return false;
+    if (this.handle === null) return false;
     return ffiIsScanning(this.handle);
   }
+  /**
+   * Get the base path of the file picker (the root directory being indexed).
+   */
   getBasePath() {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     return ffiGetBasePath(guard.value);
   }
+  /**
+   * Get the current scan progress.
+   */
   getScanProgress() {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     return ffiGetScanProgress(guard.value);
   }
-  async waitForScan(timeoutMs = 5000) {
+  /**
+   * Wait for the initial file scan to complete.
+   * Non-blocking: polls `isScanning` and yields to the event loop between checks.
+   *
+   * @param timeoutMs - Maximum time to wait in milliseconds (default: 5000)
+   * @returns true if scan completed, false if timed out
+   *
+   * @example
+   * ```typescript
+   * const finder = FileFinder.create({ basePath: "/path/to/project" });
+   * if (finder.ok) {
+   *   const completed = await finder.value.waitForScan(10000);
+   *   if (!completed.ok || !completed.value) {
+   *     console.warn("Scan did not complete in time");
+   *   }
+   * }
+   * ```
+   */
+  async waitForScan(timeoutMs = 5e3) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     const deadline = Date.now() + timeoutMs;
     while (this.isScanning()) {
       if (Date.now() >= deadline) {
@@ -1401,21 +1788,36 @@ class FileFinder {
     }
     return { ok: true, value: true };
   }
-  waitForScanBlocking(timeoutMs = 5000) {
+  /**
+   * Wait for the initial file scan to complete, blocking the calling thread.
+   *
+   * Backed by the native `fff_wait_for_scan` call. Prefer {@link waitForScan}
+   * unless you specifically need synchronous blocking behaviour.
+   *
+   * @param timeoutMs - Maximum time to wait in milliseconds (default: 5000)
+   * @returns true if scan completed, false if timed out
+   */
+  waitForScanBlocking(timeoutMs = 5e3) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     return ffiWaitForScan(guard.value, timeoutMs);
   }
-  async waitForIndexReady(timeoutMs = 5000) {
+  /**
+   * Wait until the index is fully ready: the scan has finished and the warmup
+   * (content indexing / bigram) phase has completed.
+   *
+   * Non-blocking: polls `getScanProgress` and yields to the event loop.
+   *
+   * @param timeoutMs - Maximum time to wait in milliseconds (default: 5000)
+   * @returns true if the index became ready, false if timed out
+   */
+  async waitForIndexReady(timeoutMs = 5e3) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     const deadline = Date.now() + timeoutMs;
     while (true) {
       const progress = this.getScanProgress();
-      if (!progress.ok)
-        return progress;
+      if (!progress.ok) return progress;
       if (!progress.value.isScanning && progress.value.isWarmupComplete) {
         return { ok: true, value: true };
       }
@@ -1425,28 +1827,51 @@ class FileFinder {
       await new Promise((resolve) => setTimeout(resolve, 50));
     }
   }
+  /**
+   * Change the indexed directory to a new path.
+   *
+   * This stops the current file watcher and starts indexing the new directory.
+   *
+   * @param newPath - New directory path to index
+   */
   reindex(newPath) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     return ffiRestartIndex(guard.value, newPath);
   }
+  /**
+   * Refresh the git status cache.
+   *
+   * @returns Number of files with updated git status
+   */
   refreshGitStatus() {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     return ffiRefreshGitStatus(guard.value);
   }
+  /**
+   * Track query completion for smart suggestions.
+   *
+   * Call this when a user selects a file from search results.
+   * This helps improve future search rankings for similar queries.
+   *
+   * @param query - The search query that was used
+   * @param selectedFilePath - The file path that was selected
+   */
   trackQuery(query, selectedFilePath) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     return ffiTrackQuery(guard.value, query, selectedFilePath);
   }
+  /**
+   * Get a historical query by offset.
+   *
+   * @param offset - Offset from most recent (0 = most recent)
+   * @returns The historical query string, or null if not found
+   */
   getHistoricalQuery(offset) {
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     return ffiGetHistoricalQuery(guard.value, offset);
   }
   watch(patternOrCallback, callbackOrOptions, maybeOptions) {
@@ -1458,47 +1883,65 @@ class FileFinder {
       return err("watch callback must be a function");
     }
     const guard = this.ensureAlive();
-    if (!guard.ok)
-      return guard;
+    if (!guard.ok) return guard;
     const created = ffiWatch(guard.value, pattern, options?.ignore ?? [], callback);
-    if (!created.ok)
-      return created;
+    if (!created.ok) return created;
     const watchId = created.value;
     this.watchers.add(watchId);
     return {
       ok: true,
       value: () => {
-        if (!this.watchers.delete(watchId))
-          return;
-        if (this.handle !== null)
-          ffiUnwatch(this.handle, watchId);
+        if (!this.watchers.delete(watchId)) return;
+        if (this.handle !== null) ffiUnwatch(this.handle, watchId);
       }
     };
   }
+  /**
+   * Get health check information.
+   *
+   * Useful for debugging and verifying the file finder is working correctly.
+   *
+   * @param testPath - Optional path to test git repository detection
+   */
   healthCheck(testPath) {
     return ffiHealthCheck(this.handle, testPath || "");
   }
+  /**
+   * Check if the native library is available.
+   */
   static isAvailable() {
     return isAvailable();
   }
+  /**
+   * Ensure the native library is loaded.
+   *
+   * Loads the native library from the platform-specific npm package
+   * or a local dev build. Throws if the binary is not found.
+   */
   static ensureLoaded() {
     ensureLoaded();
   }
+  /**
+   * Get a health check without requiring an instance.
+   *
+   * Returns limited info (version + git only, no picker/frecency/query data).
+   *
+   * @param testPath - Optional path to test git repository detection
+   */
   static healthCheckStatic(testPath) {
     return ffiHealthCheck(null, testPath || "");
   }
-}
+};
 export {
-  ok,
-  getTriple,
-  getNpmPackageName,
-  getLibFilename,
-  getLibExtension,
-  findBinary,
-  err,
-  closeLibrary,
+  FileFinder,
   binaryExists,
-  FileFinder
+  closeLibrary,
+  err,
+  findBinary,
+  getLibExtension,
+  getLibFilename,
+  getNpmPackageName,
+  getTriple,
+  ok
 };
-
-//# debugId=12D927B23EC3D3EE64756E2164756E21
+//# sourceMappingURL=index.js.map