Package Exports

mingledb
mingledb/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mingledb) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

MingleDB

Stars Badge Forks Badge Issues Badge License Badge

MingleDB is a lightweight, file-based NoSQL database built on top of the BSON serialization format with support for:

🔐 Basic authentication
✅ Schema validation
🔎 Query filters (including regex, range, $in, etc.)
📦 BSON + Zlib compression
💾 Flat file-based persistence

Designed for fast prototyping, embedded use, CLI apps, or offline-first environments.

📦 Installation

npm install mingledb

🚀 Features

Feature	Description
🔐 User Authentication	Register, login, logout, and session tracking using SHA256 hashing
🧾 Schema Definition	Define required fields, types, and unique constraints per collection
🧠 Smart Querying	Supports advanced query filters like `$gt`, `$in`, `$regex`, etc.
💨 Compression	Uses zlib + BSON to store entries compactly
📁 Flatfile Storage	Saves data in `.mingleDB` files with a binary header and metadata
🔄 Update/Delete Operations	Simple CRUD support with updateOne and deleteOne
📃 Minimal Dependencies	Zero external DB needed, runs anywhere Node.js runs

🧪 Example Usage

import MingleDB from "mingledb"; // For ES Modules
// const MingleDB = require("mingledb"); // For CommonJS

const db = new MingleDB(); // Optional: pass custom directory path

// 🔐 1. Register & Login
db.registerUser("admin", "secure123");
db.login("admin", "secure123");

// ✅ 2. Define schema
db.defineSchema("users", {
  name: { type: "string", required: true },
  email: { type: "string", required: true, unique: true },
  age: { type: "number" },
});

// 📥 3. Insert documents
db.insertOne("users", {
  name: "Wayne",
  email: "wayne@mingle.com",
  age: 25,
});

// 🔎 4. Read operations
console.log(db.findAll("users")); // All documents
console.log(db.findOne("users", { email: "wayne@mingle.com" })); // Exact match
console.log(db.find("users", { age: { $gte: 18, $lt: 30 } })); // Range filter

// 📝 5. Update a document
db.updateOne("users", { name: "Wayne" }, { age: 26 });

// 🗑️ 6. Delete a document
db.deleteOne("users", { email: "wayne@mingle.com" });

// 🚪 7. Logout
db.logout("admin");

🧠 Query Operators Supported

Operator	Description
`$gt`, `$gte`, `$lt`, `$lte`	Greater/Less Than (or Equal)
`$eq`, `$ne`	Equals / Not Equals
`$in`, `$nin`	Matches any in list / not in list
`$regex`	Regular Expression matching (case-insensitive supported via `$options`)

🔐 Authentication API

registerUser(username: string, password: string): void
login(username: string, password: string): boolean
isAuthenticated(username: string): boolean
logout(username: string): void

📂 Schema Example

db.defineSchema("posts", {
  title: { type: "string", required: true },
  slug: { type: "string", unique: true },
  views: { type: "number" },
});

required will throw error if missing
unique will scan the whole collection to ensure no duplicates

💡 Use Cases

Embedded/local-first database
Desktop apps (Electron)
CLI tools or utilities
Offline PWA storage simulation
Rapid prototyping with schema validation
Lightweight admin panel backend

🔧 Configuration

const db = new MingleDB("./data"); // Change default directory

Each collection will be stored as a .mingleDB binary file with compressed records.

📁 File Format

Each collection file contains:

Header (MINGLEDBv1)
JSON metadata (collection name, version)
Repeated entries of:
- 4-byte length
- zlib-compressed BSON document

✅ Roadmap (Future Ideas)

Auto-indexing for faster unique validation
Nested field queries
Export/import data as JSON
File-level locking for concurrent writes
Optional encryption
WebSocket sync module

👨‍💻 Development

npm install
node test.js   # or build your app around it

📜 License

💬 Feedback

Feel free to open issues or submit pull requests to suggest improvements or report bugs!