lucivy 3.0.4 → 3.0.6

package/README.md

@@ -1,4 +1,4 @@
-# lucivy 3.0.4
+# lucivy 3.0.6
 
 Fast BM25 full-text search for Node.js — with substring matching, fuzzy search, regex, and highlights. Powered by Rust via napi-rs.
 

package/index.d.ts

@@ -311,6 +311,12 @@ export declare class Index {
    * @returns Total size in bytes (a `number`; exact below 2^53).
    */
   indexBytes(): number
+  /**
+   * True when the last search hit the per-segment match cap
+   * (`LUCIVY_MAX_MATCHES_PER_SEGMENT`, `0` disables it) on some segment:
+   * the hits are real, but some documents were never looked at.
+   */
+  lastSearchTruncated(): boolean
   /**
    * Delete the whole index: commit and release everything (like `close()`),
    * then remove the index files from disk.
@@ -378,9 +384,12 @@ export declare class Index {
    *   from all nodes (obtained by merging `exportStats()` outputs).
    * @param limit - Maximum number of results (default 10).
    * @param highlights - If true, return highlight byte offsets per field.
+   * @param allowedIds - Restrict the search to those `_node_id` values: a
+   *   real pre-filter, under the federation's statistics — the ids decide
+   *   which documents are visited, the statistics how they score.
    * @returns `Array<SearchResult>` scored with global BM25 statistics.
    */
-  searchWithGlobalStats(queryJson: string, globalStatsJson: string, limit?: number | undefined | null, highlights?: boolean | undefined | null): Array<SearchResult>
+  searchWithGlobalStats(queryJson: string, globalStatsJson: string, limit?: number | undefined | null, highlights?: boolean | undefined | null, allowedIds?: Array<number> | undefined | null): Array<SearchResult>
 }
 /**
  * An index whose files live in a storage you provide — a transactional

package/index.js

@@ -1,3 +1,44 @@
-const { Index, BlobIndex, mergeStats } = require('./lucivy.node');
+// The addon for this platform, in this order: the one the release workflow
+// built (lucivy.<platform>.node next to this file), the platform package
+// npm installed (lucivy-linux-x64-gnu, lucivy-darwin-arm64, ...), or a
+// local build (`npm run build` leaves lucivy.node here).
+const { platform, arch } = process;
+
+function platformKey() {
+  if (platform === 'linux') return `linux-${arch}-gnu`;
+  if (platform === 'darwin') return `darwin-${arch}`;
+  if (platform === 'win32') return `win32-${arch}-msvc`;
+  return `${platform}-${arch}`;
+}
+
+function load() {
+  const key = platformKey();
+  // The Windows package is `lucivy-windows-x64`: npm's spam filter refused
+  // the napi-style `lucivy-win32-x64-msvc` at first publish.
+  const pkg = key === 'win32-x64-msvc' ? 'lucivy-windows-x64' : `lucivy-${key}`;
+  const candidates = [
+    `./lucivy.${key}.node`,
+    pkg,
+    `./lucivy.node`,
+  ];
+  const errors = [];
+  for (const candidate of candidates) {
+    try {
+      return require(candidate);
+    } catch (e) {
+      // Missing: try the next. Present but not loadable (a build for
+      // another platform, a broken file): say so, and try the next too.
+      errors.push(`${candidate}: ${String(e.message).split('\n')[0]}`);
+    }
+  }
+  throw new Error(
+    `lucivy: no addon loads on ${platform}-${arch}.\n` +
+    `Prebuilt: Linux x64/arm64 (glibc >= 2.28), macOS x64/arm64, Windows x64. ` +
+    `Elsewhere: clone https://github.com/L-Defraiteur/lucivy and run \`npm run build\` in bindings/nodejs.\n` +
+    errors.map(e => '  ' + e).join('\n'),
+  );
+}
+
+const { Index, BlobIndex, mergeStats } = load();
 
 module.exports = { Index, BlobIndex, mergeStats };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lucivy",
-  "version": "3.0.4",
+  "version": "3.0.6",
   "description": "Fast BM25 full-text search with substring matching, fuzzy search, and regex — powered by Rust",
   "main": "index.js",
   "types": "index.d.ts",
@@ -29,7 +29,6 @@
   "files": [
     "index.js",
     "index.d.ts",
-    "lucivy.node",
     "README.md"
   ],
   "devDependencies": {
@@ -38,5 +37,12 @@
   "scripts": {
     "build": "napi build --release",
     "build:debug": "napi build"
+  },
+  "optionalDependencies": {
+    "lucivy-linux-x64-gnu": "3.0.6",
+    "lucivy-linux-arm64-gnu": "3.0.6",
+    "lucivy-darwin-x64": "3.0.6",
+    "lucivy-darwin-arm64": "3.0.6",
+    "lucivy-windows-x64": "3.0.6"
   }
 }