🚀 @trap_stevo/star-vault

Unleash the future of data management with the ultimate platform for secure, scalable, and dynamic data operations. Power the next generation of applications by combining advanced encryption, revolutionary real-time querying, and seamless synchronization to create an ecosystem where data transforms into action.

🌌 Features

• 🔐 Optional Encryption – Secure sensitive data at rest
• ⚙️ Sharded Storage Engine – Efficiently scales writes across shards
• 🧠 In-Memory Caching – High-speed read layer with StarCache
• 📜 Write-Ahead Logging – Resilient logs with rotation and retention policies
• 🔍 Advanced Query Engine – Chainable and expressive queries with filtering, search, sorting, and spatial support
• 🚀 Real-Time Event Emission – Listen to data changes with fine-grained control
• 🛡️ Authentication Layer – Optional handler to authorize every operation
• 🌠 Collection Wildcards – Seamlessly operate across multiple collections

📜 API Specification

🔧 Constructor

Use these parameters when initializing StarVault.

new StarVault(dbPath, logPath, shardCount, maxLogSize, logRetention, options)

Core Parameters

options Object

🔐 authOptions (StarAuth Configuration)

Pass this object under the options.authOptions key when creating your StarVault instance.

Collection Settings

Session Behavior

Stellar Login

Hooks & Extensions

Cleanup & Locking

📦 Core Methods

These are the primary database interaction methods.

🔍 Query Engine

Chainable query builder for filtering and searching collection data.

vault.query("collection")
     .where({ key: "value" })                         // Filters by key-value pairs
     .search("field", "text")                         // Text search within a specific field
     .recent("timestamp", "7d")                       // Gets records from the last 7 days
     .near("location", { lat: 0, lng: 0 }, 50)        // Geospatial filter within 50 units
     .sort({ name: 1 })                               // Sorts by a field (1 = asc, -1 = desc)
     .select(["id", "name"])                          // Selects specific fields
     .limit(10)                                       // Limits results
     .offset(0)                                       // Skips first N records
     .filterBy(record => record.active)              // Filters with custom function
     .execute(exactCollection = false)                // Run the query with optional strict collection matching

🛡️ Authentication

All methods below require authOptions configuration and are used for session/user management.

🎧 Event Listening

Used for reactive, event-driven architecture patterns.

🌌 Collection & Path Matching

Utilities for dynamic collection operations and wildcard paths.

✨ Getting Started

Installation

npm install @trap_stevo/star-vault

Basic Usage

const StarVault = require("@trap_stevo/star-vault");

const vault = new StarVault(
     "./data",
     "./logs",
     4,
     "869MB",
     "1w",
     {
          enableEncryption : true,
          masterKey : "supersecretkey",
          authHandler : (auth) => auth.token === "valid-token"
     }
);

vault.create("users", { id : "001", name : "Nova" }, { source : "init" }, { token : "valid-token" });

📈 Querying

const results = vault.query("users")
     .where({ role : "admin" })
     .sort({ name : 1 })
     .select(["id", "name"])
     .limit(10)
     .execute();

🎧 Listening to Changes

vault.listen("create", "users/*", (path, data) => {
     console.log("New user created:", path, data);
});

🌐 Wildcard Collection Queries

vault.query("logs/*/2025")
     .recent("timestamp", "7d")
     .execute();

✨ License

See License in LICENSE.md

🚀 Transform Data into Action

StarVault transcends traditional data systems—offering a full-fledged database engine and cosmic foundation that propels secure, reactive, and intelligent data-driven architectures.