@orieg/expanse 0.3.0 → 0.4.1

package/README.md

@@ -3,7 +3,7 @@
 > Native Node.js, Bun, and Deno bindings for **Expanse**: clean-room, pure-Rust Judy arrays and 256-ary digital tries with optimistic concurrency control (OCC).
 
 [![npm version](https://img.shields.io/npm/v/@orieg/expanse.svg)](https://www.npmjs.com/package/@orieg/expanse)
-[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](../../LICENSE-MIT)
+[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](https://github.com/orieg/expanse/blob/main/LICENSE-MIT)
 
 ## Overview
 

package/index.d.ts

@@ -462,14 +462,18 @@ export class ExpanseBlobMap {
   compact(): CompactionStatsResult;
 
   /**
-   * Saves the map to a relocatable binary image file. Returns bytes written.
+   * Saves the map to a relocatable binary image file. Returns the number of bytes
+   * written as a BigInt (an image can exceed 4 GiB, so it does not fit in a 32-bit number).
    */
-  saveImage(path: string): number;
+  saveImage(path: string): bigint;
 
   /**
    * Loads a map from a relocatable binary image file.
+   *
+   * The whole file is read into memory and the index is rebuilt; the image is NOT
+   * memory-mapped (no lazy-fault SIGBUS hazard, at the cost of the image being resident).
    */
-  static openImage(path: string, mmap?: boolean): ExpanseBlobMap;
+  static openImage(path: string): ExpanseBlobMap;
 }
 
 /**

package/index.js

@@ -1,10 +1,49 @@
 const path = require('path');
 const fs = require('fs');
 
+// Map the current runtime to the napi-style platform name used by the
+// per-platform prebuilt packages (@orieg/expanse-<platform>), published as
+// optionalDependencies of @orieg/expanse.
+function platformName() {
+  const { platform, arch } = process;
+  if (platform === 'linux') {
+    if (arch === 'x64') return 'linux-x64-gnu';
+    if (arch === 'arm64') return 'linux-arm64-gnu';
+  } else if (platform === 'darwin') {
+    if (arch === 'x64') return 'darwin-x64';
+    if (arch === 'arm64') return 'darwin-arm64';
+  } else if (platform === 'win32') {
+    if (arch === 'x64') return 'win32-x64-msvc';
+  }
+  return null;
+}
+
 function loadBinding() {
-  const candidates = [
-    path.join(__dirname, 'index.node'),
-    path.join(__dirname, 'expanse-node.node'),
+  const plat = platformName();
+
+  // 1. A co-located prebuilt addon (e.g. bundled next to this loader).
+  const localCandidates = [];
+  if (plat) {
+    localCandidates.push(path.join(__dirname, `expanse.${plat}.node`));
+  }
+  localCandidates.push(path.join(__dirname, 'index.node'));
+  for (const candidate of localCandidates) {
+    if (fs.existsSync(candidate)) {
+      return require(candidate);
+    }
+  }
+
+  // 2. The published per-platform package installed via optionalDependencies.
+  if (plat) {
+    try {
+      return require(`@orieg/expanse-${plat}`);
+    } catch (err) {
+      // fall through to the local development fallbacks below
+    }
+  }
+
+  // 3. Development / CI fallback: load straight from `cargo build` output.
+  const devCandidates = [
     path.join(__dirname, '../../target/release/libexpanse_node.dylib'),
     path.join(__dirname, '../../target/release/libexpanse_node.so'),
     path.join(__dirname, '../../target/release/expanse_node.dll'),
@@ -12,13 +51,9 @@ function loadBinding() {
     path.join(__dirname, '../../target/debug/libexpanse_node.so'),
     path.join(__dirname, '../../target/debug/expanse_node.dll'),
   ];
-
-  for (const candidate of candidates) {
+  for (const candidate of devCandidates) {
     if (fs.existsSync(candidate)) {
       try {
-        if (candidate.endsWith('.node')) {
-          return require(candidate);
-        }
         const mod = { exports: {} };
         process.dlopen(mod, candidate);
         return mod.exports;
@@ -29,7 +64,9 @@ function loadBinding() {
   }
 
   throw new Error(
-    'Failed to load @orieg/expanse native addon. Please build with `cargo build -p expanse-node`.'
+    'Failed to load the @orieg/expanse native addon. ' +
+      'Ensure the matching @orieg/expanse-<platform> optionalDependency was installed, ' +
+      'or build locally with `cargo build -p expanse-node`.'
   );
 }
 

package/package.json

@@ -1,19 +1,25 @@
 {
   "name": "@orieg/expanse",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Clean-room, pure-Rust modern Judy arrays and digital tries with cache-line-tuned node geometries, inline value packing, slab arenas, and OCC concurrency for Node.js, Bun, and Deno.",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
     "index.js",
     "index.d.ts",
-    "index.node",
     "README.md",
     "LICENSE-MIT",
     "LICENSE-APACHE"
   ],
+  "optionalDependencies": {
+    "@orieg/expanse-linux-x64-gnu": "0.4.1",
+    "@orieg/expanse-darwin-x64": "0.4.1",
+    "@orieg/expanse-darwin-arm64": "0.4.1",
+    "@orieg/expanse-win32-x64-msvc": "0.4.1"
+  },
   "scripts": {
     "test": "node test.js",
+    "bench": "node bench.js",
     "build": "cargo build --release -p expanse-node",
     "build:debug": "cargo build -p expanse-node"
   },