@quereus/plugin-leveldb 0.2.2

package/README.md

@@ -0,0 +1,146 @@
+# @quereus/plugin-leveldb
+
+LevelDB storage plugin for Quereus. Provides persistent storage for Node.js environments using the [`@quereus/store`](../quereus-store/) module.
+
+## Features
+
+- **Fast**: LevelDB offers excellent read/write performance for key-value workloads
+- **Sorted keys**: Efficient range queries with ordered iteration
+- **ACID batches**: Atomic writes across multiple keys
+- **Compression**: Built-in Snappy compression for reduced disk usage
+
+## Installation
+
+```bash
+npm install @quereus/plugin-leveldb @quereus/store
+```
+
+## Quick Start
+
+### With registerPlugin (Recommended)
+
+```typescript
+import { Database, registerPlugin } from '@quereus/quereus';
+import leveldbPlugin from '@quereus/plugin-leveldb/plugin';
+
+const db = new Database();
+await registerPlugin(db, leveldbPlugin, { basePath: './data' });
+
+await db.exec(`
+  create table users (id integer primary key, name text)
+  using store
+`);
+```
+
+### Direct Usage with Provider
+
+```typescript
+import { Database } from '@quereus/quereus';
+import { createLevelDBProvider } from '@quereus/plugin-leveldb';
+import { StoreModule } from '@quereus/store';
+
+const db = new Database();
+const provider = createLevelDBProvider({ basePath: './data' });
+const storeModule = new StoreModule(provider);
+db.registerVtabModule('store', storeModule);
+
+await db.exec(`
+  create table users (id integer primary key, name text)
+  using store
+`);
+```
+
+## API
+
+### LevelDBStore
+
+Low-level KVStore implementation:
+
+```typescript
+import { LevelDBStore } from '@quereus/plugin-leveldb';
+
+const store = await LevelDBStore.open({ path: './data/mystore' });
+
+await store.put(key, value);
+const data = await store.get(key);
+await store.delete(key);
+
+// Range iteration
+for await (const { key, value } of store.iterate({ gte: startKey, lt: endKey })) {
+  console.log(key, value);
+}
+
+// Batch writes
+const batch = store.batch();
+batch.put(key1, value1);
+batch.put(key2, value2);
+batch.delete(key3);
+await batch.write();
+
+await store.close();
+```
+
+### LevelDBProvider
+
+Factory for managing multiple stores:
+
+```typescript
+import { createLevelDBProvider } from '@quereus/plugin-leveldb';
+
+const provider = createLevelDBProvider({ basePath: './data' });
+
+const userStore = await provider.getStore('main', 'users');  // ./data/main/users
+const catalogStore = await provider.getCatalogStore();       // ./data/__catalog__
+
+await provider.closeStore('main', 'users');
+await provider.closeAll();
+```
+
+## Configuration
+
+### Plugin Settings
+
+| Setting | Type | Default | Description |
+|---------|------|---------|-------------|
+| `basePath` | string | `'./data'` | Base directory for all stores |
+| `createIfMissing` | boolean | `true` | Create directories if they don't exist |
+| `moduleName` | string | `'store'` | Name to register the virtual table module under |
+
+### LevelDBStore Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `path` | string | required | Directory path for the database |
+| `createIfMissing` | boolean | `true` | Create database if it doesn't exist |
+
+## Example with Transactions
+
+```typescript
+import { Database, registerPlugin } from '@quereus/quereus';
+import leveldbPlugin from '@quereus/plugin-leveldb/plugin';
+
+const db = new Database();
+await registerPlugin(db, leveldbPlugin, { basePath: './data' });
+
+await db.exec(`create table accounts (id integer primary key, balance real) using store`);
+
+await db.exec('begin');
+try {
+  await db.exec(`update accounts set balance = balance - 100 where id = 1`);
+  await db.exec(`update accounts set balance = balance + 100 where id = 2`);
+  await db.exec('commit');
+} catch (e) {
+  await db.exec('rollback');
+  throw e;
+}
+```
+
+## Related Packages
+
+- [`@quereus/store`](../quereus-store/) - Core storage module (StoreModule, StoreTable)
+- [`@quereus/plugin-indexeddb`](../quereus-plugin-indexeddb/) - IndexedDB plugin for browsers
+
+## License
+
+MIT
+

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@quereus/plugin-leveldb",
+  "version": "0.2.2",
+  "type": "module",
+  "description": "LevelDB storage plugin for Quereus - Node.js persistent storage",
+  "keywords": [
+    "quereus",
+    "quereus-plugin",
+    "sql",
+    "database",
+    "storage",
+    "leveldb",
+    "kv-store",
+    "persistent"
+  ],
+  "publisher": "Got Choices Foundation",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gotchoices/quereus.git",
+    "directory": "packages/quereus-plugin-leveldb"
+  },
+  "license": "MIT",
+  "main": "dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    },
+    "./plugin": {
+      "types": "./dist/src/plugin.d.ts",
+      "import": "./dist/src/plugin.js"
+    }
+  },
+  "peerDependencies": {
+    "@quereus/quereus": "^0.24.0",
+    "@quereus/store": "^0.3.5"
+  },
+  "engines": {
+    "quereus": "^0.24.0"
+  },
+  "quereus": {
+    "provides": {
+      "vtables": [
+        "store"
+      ]
+    },
+    "settings": [
+      {
+        "key": "basePath",
+        "label": "Base Path",
+        "type": "string",
+        "default": "./data",
+        "help": "Base directory for all LevelDB stores"
+      },
+      {
+        "key": "createIfMissing",
+        "label": "Create If Missing",
+        "type": "boolean",
+        "default": true,
+        "help": "Create directories if they don't exist"
+      },
+      {
+        "key": "moduleName",
+        "label": "Module Name",
+        "type": "string",
+        "default": "store",
+        "help": "Name to register the virtual table module under"
+      }
+    ]
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "test": "cd ../.. && node --import ./packages/quereus-plugin-leveldb/register.mjs node_modules/mocha/bin/mocha.js \"packages/quereus-plugin-leveldb/test/**/*.spec.ts\" --colors"
+  },
+  "dependencies": {
+    "classic-level": "^2.0.0"
+  },
+  "devDependencies": {
+    "@quereus/quereus": "*",
+    "@quereus/store": "*",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.15.29",
+    "chai": "^5.2.0",
+    "mocha": "^11.5.0",
+    "rimraf": "^6.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  }
+}