json-database-st 2.0.2 → 3.1.4

package/README.md

@@ -1,65 +1,88 @@
 # JSON Database ST
 
-[![NPM Version](https://badge.fury.io/js/json-database-st.svg)](https://badge.fury.io/js/json-database-st)
-[![NPM Downloads](https://img.shields.io/npm/dm/json-database-st.svg)](https://www.npmjs.com/package/json-database-st)
+> High-performance, lightweight JSON-based database engine for Node.js & Bun.
+> Powered by a **Rust** core for speed and reliability.
+
+[![npm version](https://img.shields.io/npm/v/json-database-st.svg)](https://www.npmjs.com/package/json-database-st)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-A high-performance, lightweight, and secure JSON-based database engine for Node.js. Designed for applications that need reliable data persistence, atomic operations, and encryption without the overhead of a full SQL server.
+> **WARNING:** This library currently only works on **macOS** and **Windows**. Linux support is temporarily unavailable.
 
-## 🚀 Key Features
+## 🚀 Features
 
-- **🔒 AES-256-GCM Encryption:** Military-grade security for your data at rest.
-- **⚡ O(1) Indexing:** Instant lookups, no matter how big the database gets.
-- **🛡️ Atomic Writes:** Zero corruption risk. Uses lockfiles and temp-write-swap strategy.
-- **🔢 Math Helpers:** Atomic `add` and `subtract` for financial/gaming logic.
-- **📄 Pagination:** Built-in support for handling large lists efficiently.
-- **📸 Snapshots:** One-line command to backup your entire database.
+- **⚡ Blazing Fast:** Core logic written in **Rust** via N-API for native performance.
+- **🛡️ Atomic Operations:** Uses Write-Ahead Logging (WAL) and atomic file swaps to prevent data corruption.
+- **🔍 O(1) Indexing:** In-memory `Map` indices allow for instant lookups by field.
+- **🔒 Encryption:** Optional AES-256-GCM encryption for data at rest.
+- **📦 Zero Dependencies (Runtime):** Self-contained native binary; no heavy external DB servers required.
+- **🔄 Middleware:** Support for `before` and `after` hooks on operations.
+- **💾 JSON Compatible:** Stores data in a simple, portable JSON file.
 
 ## 📦 Installation
 
 ```bash
-npm install json-database-st lodash proper-lockfile
+bun add json-database-st
+# or
+npm install json-database-st
 ```
 
-## ⚡ Quick Start
-
-```javascript
-const JSONDatabase = require('json-database-st');
+## 🛠️ Usage
 
-const db = new JSONDatabase('data.json');
+### Basic Example
 
-async function run() {
-    // 1. Set Data
-    await db.set('user.name', 'Sethun');
-    
-    // 2. Atomic Math (New!)
-    await db.set('user.balance', 1000);
-    await db.add('user.balance', 500); // Balance is now 1500
-    
-    // 3. Arrays with Uniqueness
-    await db.push('inventory', { id: 1, item: 'Laptop' });
+```javascript
+const { JSONDatabase } = require('json-database-st');
+
+const db = new JSONDatabase('mydb.json', {
+    encryptionKey: 'my-secret-key-123', // Optional: encrypts the file
+    indices: [
+        { name: 'email', path: 'users', field: 'email' } // O(1) lookup index
+    ]
+});
+
+async function main() {
+    // Write data
+    await db.set('users.u1', {
+        id: 1,
+        name: 'Alice',
+        email: 'alice@example.com'
+    });
+
+    // Read data
+    const user = await db.get('users.u1');
+    console.log(user); 
+    // { id: 1, name: 'Alice', ... }
+
+    // O(1) Lookup by Index
+    const alice = await db.findByIndex('email', 'alice@example.com');
+    console.log(alice); 
+    // { id: 1, name: 'Alice', ... }
     
-    console.log(await db.get('user'));
+    // Atomic Math Operations
+    await db.add('stats.visits', 1);
 }
 
-run();
+main();
 ```
 
+## ⚙️ Configuration
+
+| Option | Type | Default | Description |
+|os|--- |--- |--- |--- |
+| `saveDelay` | `number` | `60` | Debounce time (ms) for writes. Higher = better batching, lower = faster disk commit. |
+| `wal` | `boolean` | `true` | If true, uses Write-Ahead Logging for maximum durability. |
+
 ## 📖 Documentation
 
-Full documentation, API references, and benchmarks are available on the **[Home Page](https://sethunthunder111.github.io/json-database-st/)**.
+Visit our full documentation site: [https://sethunthunder111.github.io/json-database-st/docs.html](https://sethunthunder111.github.io/json-database-st/docs.html)
+
 
-## 🤝 Contributing
+## 📊 Benchmarks
 
-Built by **SethunThunder**.
+*Running benchmarks on your local machine...*
 
-## 🚀 Performance (v2.0)
+> **Note:** Performance depends heavily on disk I/O speed (SSD recommended).
 
-| Operation | 10k Records | 1M Records |
-| :--- | :--- | :--- |
-| **Indexed Read** | 0.15 ms | 0.07 ms |
-| **Write (Ingest)** | 42,450 ops/sec | 57,845 ops/sec |
-| **Single Update** | 100 ms | 6.3 s |
+## 📄 License
 
-> **Fastest in Class:** Indexed reads are O(1). Updates are 1.5x faster than v1.0.
-> [View Full Benchmarks](./BENCHMARKS.md)
+MIT

package/index.js

@@ -0,0 +1,117 @@
+const { platform, arch } = process
+
+let nativeBinding = null
+let loadError = null
+
+switch (platform) {
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        try {
+          nativeBinding = require('./index.win32-x64-msvc.node')
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        try {
+          nativeBinding = require('./index.win32-ia32-msvc.node')
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        try {
+          nativeBinding = require('./index.win32-arm64-msvc.node')
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        loadError = new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    switch (arch) {
+      case 'x64':
+        try {
+          nativeBinding = require('./index.darwin-x64.node')
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        try {
+          nativeBinding = require('./index.darwin-arm64.node')
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        loadError = new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      loadError = new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    } else {
+      try {
+        nativeBinding = require('./index.freebsd-x64.node')
+      } catch (e) {
+        loadError = e
+      }
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        try {
+          nativeBinding = require('./index.linux-x64-gnu.node')
+        } catch (e) {
+          loadError = e
+          try {
+            nativeBinding = require('./index.linux-x64-musl.node')
+            loadError = null
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        try {
+          nativeBinding = require('./index.linux-arm64-gnu.node')
+        } catch (e) {
+          loadError = e
+          try {
+            nativeBinding = require('./index.linux-arm64-musl.node')
+            loadError = null
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        try {
+          nativeBinding = require('./index.linux-arm-gnueabihf.node')
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        loadError = new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    loadError = new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { DatabaseCore } = nativeBinding
+
+module.exports.DatabaseCore = DatabaseCore

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "json-database-st",
-  "version": "2.0.02",
-  "description": "A simple, promise-based JSON file database for Node.js with atomic operations and lodash integration.",
+  "version": "3.1.4",
+  "description": "High-performance JSON database with Rust core, ACID compliance (WAL), and MongoDB-style queries.",
   "main": "JSONDatabase.js",
+  "module": "JSONDatabase.ts",
   "types": "JSONDatabase.d.ts",
   "scripts": {
     "test": "jest",
-    "benchmark": "node benchmark.js"
+    "benchmark": "node benchmark.js",
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "build:ts": "bun build JSONDatabase.ts --outfile JSONDatabase.js --target node --format cjs --external ./index",
+    "build:all": "bun run build && bun run build:ts"
   },
   "repository": {
     "type": "git",
@@ -30,7 +35,7 @@
   "bugs": {
     "url": "https://github.com/sethunthunder111/json-database-st/issues"
   },
-  "homepage": "https://github.com/sethunthunder111/json-database-st#readme",
+  "homepage": "https://sethunthunder111.github.io/json-database-st/",
   "dependencies": {
     "lodash": "^4.17.21",
     "proper-lockfile": "^4.1.2"
@@ -40,11 +45,19 @@
   },
   "files": [
     "JSONDatabase.js",
+    "JSONDatabase.d.ts",
+    "JSONDatabase.legacy.js",
+    "index.js",
+    "index.d.ts",
+    "*.node",
     "LICENSE",
-    "README.md",
-    "JSONDatabase.d.ts"
+    "README.md"
   ],
   "devDependencies": {
+    "@napi-rs/cli": "^3.5.1",
     "jest": "^30.1.1"
+  },
+  "napi": {
+    "binaryName": "index"
   }
 }