slatedb-node 0.1.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Gadget Software Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,128 @@
+# slatedb-node
+
+High-performance Node.js bindings for [SlateDB](https://github.com/slatedb/slatedb) implemented as a native Rust extension using `napi-rs`.
+
+- Native extension (no subprocess bridge)
+- Async TypeScript API
+- Supports SlateDB DB/Reader/Snapshot/Transaction/Admin primitives
+- Compiled with `slatedb` feature `all` (object store + compression feature set)
+
+## Installation
+
+```bash
+pnpm add slatedb-node
+```
+
+## Quick Start
+
+```ts
+import { WriteBatch, open } from "slatedb-node";
+
+const db = await open({ path: "example-db", url: "memory:///" });
+
+await db.put("user:1", "alice");
+console.log((await db.get("user:1"))?.toString());
+
+const batch = new WriteBatch();
+batch.put("user:2", "bob");
+batch.delete("user:1");
+await db.write(batch);
+
+const iter = await db.scanPrefix("user:");
+for await (const [key, value] of iter) {
+  console.log(key.toString(), value.toString());
+}
+
+await db.close();
+```
+
+## Opening Databases
+
+```ts
+import { open } from "slatedb-node";
+
+const db = await open({
+  path: "my-db",
+  url: "file:///tmp/slatedb-store",
+  settingsPath: "./SlateDb.toml", // optional
+  settings: {
+    flush_interval: "50ms",
+    manifest_poll_interval: "1s",
+  }, // optional object overrides
+});
+```
+
+## Reader and Admin APIs
+
+```ts
+import { open, openAdmin, openReader } from "slatedb-node";
+
+const db = await open({ path: "my-db", url: "file:///tmp/slatedb-store" });
+const checkpoint = await db.createCheckpoint("durable");
+
+const reader = await openReader({
+  path: "my-db",
+  url: "file:///tmp/slatedb-store",
+  checkpointId: checkpoint.id,
+});
+
+const admin = await openAdmin({ path: "my-db", url: "file:///tmp/slatedb-store" });
+console.log(await admin.listCheckpoints());
+
+await reader.close();
+await db.close();
+```
+
+## Errors
+
+Errors are mapped to typed classes:
+
+- `TransactionError`
+- `ClosedError`
+- `UnavailableError`
+- `InvalidError`
+- `DataError`
+- `InternalError`
+
+## Development
+
+Requirements:
+
+- Node.js 20+
+- Rust toolchain
+- `pnpm`
+
+Commands:
+
+```bash
+pnpm install
+pnpm run build
+pnpm test
+```
+
+## Prebuilt Binaries
+
+The package uses `@napi-rs/cli` optional dependency packages (like `esbuild`/`swc`) so the main package stays small and installs only the binary for the current platform.
+
+Generated optional packages:
+
+- macOS x64 / arm64
+- Linux x64 / arm64 (gnu + musl)
+- Windows x64 / arm64 (msvc)
+
+The generated package names are:
+
+- `slatedb-node-darwin-x64`
+- `slatedb-node-darwin-arm64`
+- `slatedb-node-linux-x64-gnu`
+- `slatedb-node-linux-x64-musl`
+- `slatedb-node-linux-arm64-gnu`
+- `slatedb-node-linux-arm64-musl`
+- `slatedb-node-win32-x64-msvc`
+- `slatedb-node-win32-arm64-msvc`
+
+## Publishing
+
+`publish.yml` builds all native targets, downloads artifacts, creates per-platform npm package dirs, and runs `npm publish`.
+
+`prepublishOnly` runs `napi pre-publish -t npm`, which updates `optionalDependencies` and publishes the platform packages alongside the main package.

package/native.cjs

@@ -0,0 +1,98 @@
+const { createRequire } = require("node:module");
+const { readFileSync } = require("node:fs");
+const path = require("node:path");
+
+const requireFromHere = createRequire(__filename);
+
+/** @type {Error[]} */
+const loadErrors = [];
+
+const isMusl = () => {
+  if (process.platform !== "linux") return false;
+  try {
+    return readFileSync("/usr/bin/ldd", "utf-8").includes("musl");
+  } catch {
+    return false;
+  }
+};
+
+/**
+ * @param {string} pathOrPackage
+ * @returns {unknown}
+ */
+const tryRequire = (pathOrPackage) => {
+  try {
+    const loaded = requireFromHere(pathOrPackage);
+    return /** @type {unknown} */ (loaded);
+  } catch (error) {
+    loadErrors.push(/** @type {Error} */ (error));
+    return null;
+  }
+};
+
+/** @returns {unknown} */
+const loadNative = () => {
+  if (process.env.NAPI_RS_NATIVE_LIBRARY_PATH) {
+    const fromEnv = tryRequire(process.env.NAPI_RS_NATIVE_LIBRARY_PATH);
+    if (fromEnv) return fromEnv;
+  }
+
+  const candidates = [];
+  const optionalPackages = [];
+
+  if (process.platform === "darwin") {
+    if (process.arch === "arm64") {
+      candidates.push("./slatedb-node.darwin-arm64.node");
+      optionalPackages.push("slatedb-node-darwin-arm64");
+    } else if (process.arch === "x64") {
+      candidates.push("./slatedb-node.darwin-x64.node");
+      optionalPackages.push("slatedb-node-darwin-x64");
+    }
+  } else if (process.platform === "win32") {
+    if (process.arch === "arm64") {
+      candidates.push("./slatedb-node.win32-arm64-msvc.node");
+      optionalPackages.push("slatedb-node-win32-arm64-msvc");
+    } else if (process.arch === "x64") {
+      candidates.push("./slatedb-node.win32-x64-msvc.node");
+      optionalPackages.push("slatedb-node-win32-x64-msvc");
+    }
+  } else if (process.platform === "linux") {
+    if (process.arch === "arm64") {
+      if (isMusl()) {
+        candidates.push("./slatedb-node.linux-arm64-musl.node");
+        optionalPackages.push("slatedb-node-linux-arm64-musl");
+      } else {
+        candidates.push("./slatedb-node.linux-arm64-gnu.node");
+        optionalPackages.push("slatedb-node-linux-arm64-gnu");
+      }
+    } else if (process.arch === "x64") {
+      if (isMusl()) {
+        candidates.push("./slatedb-node.linux-x64-musl.node");
+        optionalPackages.push("slatedb-node-linux-x64-musl");
+      } else {
+        candidates.push("./slatedb-node.linux-x64-gnu.node");
+        optionalPackages.push("slatedb-node-linux-x64-gnu");
+      }
+    }
+  }
+
+  for (const candidate of candidates) {
+    const loaded = tryRequire(path.join(__dirname, candidate));
+    if (loaded) return loaded;
+    const loadedRelative = tryRequire(candidate);
+    if (loadedRelative) return loadedRelative;
+  }
+
+  for (const packageName of optionalPackages) {
+    const loaded = tryRequire(packageName);
+    if (loaded) return loaded;
+  }
+
+  const error = new Error(
+    `Failed to load native binding for ${process.platform}/${process.arch}.\n` + loadErrors.map((entry) => `- ${entry.message}`).join("\n"),
+  );
+  error.cause = loadErrors;
+  throw error;
+};
+
+module.exports = loadNative();

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "slatedb-node",
+  "version": "0.1.0",
+  "description": "Node.js bindings for SlateDB via napi-rs",
+  "homepage": "https://github.com/gadget-inc/slatedb-node",
+  "bugs": {
+    "url": "https://github.com/gadget-inc/slatedb-node/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "SlateDB Authors"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gadget-inc/slatedb-node.git"
+  },
+  "files": [
+    "lib",
+    "native.cjs",
+    "README.md"
+  ],
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "create-npm-dirs": "napi create-npm-dirs",
+    "build": "pnpm run clean && pnpm run build:debug && pnpm run build:ts",
+    "build:debug": "napi build --platform --no-js --dts target/napi-rs/index.d.ts",
+    "build:release": "napi build --platform --release --no-js --dts target/napi-rs/index.d.ts",
+    "build:ts": "tsc -p tsconfig.build.json",
+    "clean": "rimraf *.node",
+    "lint": "pnpm run --aggregate-output '/^lint:(?!fix).*/'",
+    "lint:cspell": "cspell . --no-progress --show-suggestions --show-context",
+    "lint:fix": "oxfmt && oxlint --type-aware --fix",
+    "lint:oxfmt": "oxfmt --check",
+    "lint:oxlint": "oxlint --type-aware --deny-warnings",
+    "prepublishOnly": "napi pre-publish -t npm",
+    "release": "pnpm run build:release && pnpm run build:ts",
+    "test": "pnpm run build:debug && pnpm run build:ts && vitest run"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^3.2.0",
+    "@types/node": "^24.5.2",
+    "cspell": "^9.6.4",
+    "oxfmt": "^0.32.0",
+    "oxlint": "^1.49.0",
+    "oxlint-tsgolint": "^0.14.1",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.15"
+  },
+  "napi": {
+    "binaryName": "slatedb-node",
+    "targets": [
+      "x86_64-apple-darwin",
+      "aarch64-apple-darwin",
+      "x86_64-pc-windows-msvc",
+      "aarch64-pc-windows-msvc",
+      "x86_64-unknown-linux-gnu",
+      "x86_64-unknown-linux-musl",
+      "aarch64-unknown-linux-gnu",
+      "aarch64-unknown-linux-musl"
+    ]
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "packageManager": "pnpm@10.11.0",
+  "pnpm": {
+    "overrides": {
+      "diff": "^4.0.4",
+      "rollup": "^4.59.0"
+    }
+  },
+  "optionalDependencies": {
+    "slatedb-node-darwin-x64": "0.1.0",
+    "slatedb-node-darwin-arm64": "0.1.0",
+    "slatedb-node-win32-x64-msvc": "0.1.0",
+    "slatedb-node-win32-arm64-msvc": "0.1.0",
+    "slatedb-node-linux-x64-gnu": "0.1.0",
+    "slatedb-node-linux-x64-musl": "0.1.0",
+    "slatedb-node-linux-arm64-gnu": "0.1.0",
+    "slatedb-node-linux-arm64-musl": "0.1.0"
+  }
+}