snowbase 5.0.0 → 6.0.0

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+## [6.0.0] - 2026-07-XX
+
+### Added
+
+- Added a cache layer to avoid repeated reads from disk and improve response times.
+- Added cache validation based on file modification time and file size.
+- Added support for a custom backup directory.
+- Added an async version of the database for non-blocking operations.
+- Added optional encryption support for stored data.
+- Added backup versioning with filenames following the pattern backup_YYYY-MM-DD_HH-MM-SS-XXXXX.json.
+- Added a CLI with commands for init, inspect, backup, restore, clear, get, set, remove, and has.
+- Added richer database operations such as set, save, get, remove, clear, all, has, count, and find.
+- Added event-based lifecycle support with ready and error events.
+- Added operation events for get, set, remove, clear, writes, and backup creation.
+
+### Changed
+
+- Reworked the storage layer to support persistence, backup, logging, and encryption in a more structured way.
+- Improved initialization so the base directory, backup directory, log directory, and database file are created automatically when missing.
+- Standardized backup and logging behavior to be configurable through constructor options.
+- The keys are now saved in alphabetic order.
+
+### Fixed
+
+- Fixed issues that caused repeated file reads when the database directory changed or the file state was updated.
+- Fixed backup handling to keep the backup folder organized and avoid excessive backup accumulation.
+- Improved validation to reject invalid database root structures.
+
+### Performance Improvements
+
+- Reduced unnecessary disk I/O by reusing cached data until the underlying file changes.
+- Improved write and backup flow for faster and more predictable persistence operations.

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2026 Pedro Henrique Brandão (p3droob)
+
+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

@@ -1,31 +1,224 @@
-# Snowbase ❄️
-
-## Overview
-- #### [Alpha Discord](https://www.npmjs.com/package/alpha-discord) - A library for interact with discord [API](https://discord.com/api) on js
-- ## Server
-```js
-const snowbase = require('snowbase');
-
-const db = new snowbase.Server({
-  login: 'Your account login of snowbase',
-  password: 'Your password'
-});
-db.save('value1', 150)//emits valueUpdate event: key, {old: old_value, new: new_value}
-
-db.get('value1')//150
-
-db.remove('value1')//emits valueDelete event: key, deleted_value
-```
-
-- ## Local
-```js
-const db = new snowbase.Local('./database.json')//or other file
-
-db.save('value2', 100)
-
-db.get('value2')//100
-
-db.all(a => a == 100)//filter
-
-db.remove('value2')
-```
+<div align="center">
+<h1>Snowbase ❄️</h1>
+<br>
+<img src="./img/snowbase-logo.png" alt="Snowbase logo" width="200" height="200" style="border-radius:35%;border: 4px solid #e7e9ebff;"/>
+<p>A lightweight file-based database for Node.js</p>
+<a href="https://www.npmjs.com/package/snowbase">
+    <img src="https://img.shields.io/npm/v/snowbase?color=blue" alt="Current version"/>
+    </a>
+    <a href="https://www.npmjs.com/package/snowbase">
+    <img
+    src="https://packagephobia.com/badge?p=snowbase@6.0.0"
+    alt="install size">
+    </a>
+<a href="https://www.npmjs.com/package/snowbase">
+    <img src="https://img.shields.io/npm/dt/snowbase?color=darkcyan" alt="npm downloads"/>
+</a>
+<img src="https://img.shields.io/npm/l/snowbase" alt="license"/>
+<br>
+<b>Simple.</b> <b>Fast.</b> <b>Persistent.</b>
+</div>
+
+---
+
+- [Overview](#overview)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [Events](#events)
+- [Async API](#async-api)
+- [CLI](#cli)
+- [License](#license)
+
+## Overview
+
+Snowbase is a simple, fast, and persistent file-based database for Node.js.  
+It creates and manages a local JSON file to store your data safely, making it perfect for lightweight applications, prototypes, scripts, and small tools.
+
+No servers. No complex setup. Just storage.
+
+## ✨ Features
+
+- ⚡ Lightweight and easy to use
+- 📦 File-based persistence with no external database required
+- 🔐 Optional encryption for stored data
+- 🧾 Optional logging for operations
+- 💾 Automatic backups with versioned files
+- ⚙️ Supports both sync and async APIs
+- 🧩 Works well for prototypes, local apps, and small projects
+
+## 📥 Installation
+
+```bash
+npm install snowbase
+```
+
+## Usage
+
+### CommonJS
+
+```js
+const Snowbase = require("snowbase");
+
+const db = new Snowbase();
+
+db.on("ready", () => {
+  console.log("Database is ready");
+});
+```
+
+### ES Modules
+
+```js
+import Snowbase from "snowbase";
+
+const db = new Snowbase();
+
+db.on("ready", () => {
+  console.log("Database is ready");
+});
+```
+
+### Basic operations
+
+```js
+// Set a value
+db.set("user/name", "Pedro");
+
+// Get a value
+console.log(db.get("user/name")); // Pedro
+
+// Remove a value
+db.remove("user/name");
+
+// Clear the whole database
+db.clear();
+```
+
+## Configuration
+
+You can configure Snowbase during initialization:
+
+```js
+const db = new Snowbase({
+  baseDir: "./my-database",
+  encryption: true,
+  secret: "my-secret",
+  logging: true,
+  backup: true,
+});
+```
+
+### Options
+
+- baseDir: directory where the database file will be stored
+- encryption: enables encrypted persistence
+- secret: secret key used when encryption is enabled
+- logging: enables operation logging
+- backup: enables automatic backups
+
+## Advanced examples
+
+### Set and save nested data
+
+```js
+db.set("patients", {
+  john: {
+    age: 20,
+    name: "John",
+    city: "New York",
+  },
+  albert: {
+    age: 31,
+    name: "Albert",
+    city: "Chicago",
+  },
+});
+```
+
+### Read and query data
+
+```js
+console.log(db.get("patients/john/city")); // New York
+console.log(db.has("patients/albert")); // true
+console.log(db.count("patients")); // 2
+```
+
+### Find and remove
+
+```js
+const result = db.find("patients", ({ key }) => key.includes("a"));
+console.log(result);
+
+db.remove("patients/albert"); // true
+db.remove("patients/susy"); // false
+```
+
+## Events
+
+Snowbase can emit events for lifecycle and database operations. You can listen to them with the standard EventEmitter API.
+
+```js
+const db = new Snowbase();
+
+db.on("ready", () => {
+  console.log("Database is ready");
+});
+
+db.on("error", (err) => {
+  console.error(err.message);
+});
+
+db.on("get", (details, timestamp) => {
+  console.log("Get event", details, timestamp);
+});
+```
+
+### Available events
+
+- ready: emitted when the database instance is initialized
+- error: emitted when an error occurs; receives an Error object
+- get: emitted after a read operation; payload includes the path and the resolved value
+- set: emitted after a write operation; payload includes the path, key, and value
+- remove: emitted after a remove operation; payload includes the path, removed value, and whether it was removed
+- clear: emitted after clearing the database; payload includes the previous data
+- \_write: emitted after data is written to disk
+- create backup: emitted when a backup file is created
+
+## Async API
+
+For non-blocking operations, use the async version:
+
+```js
+import Snowbase from "snowbase/async";
+
+const db = new Snowbase({
+  encryption: true,
+  secret: "my-secret",
+  backup: true,
+});
+
+await db.set("user/name", "Pedro");
+console.log(await db.get("user/name"));
+```
+
+## CLI
+
+Snowbase also includes a CLI for common tasks:
+
+```bash
+snowbase init
+snowbase inspect
+snowbase backup
+snowbase restore
+snowbase get user/name
+snowbase set user/name Pedro
+snowbase remove user/name
+snowbase clear
+snowbase has
+```
+
+## License
+
+MIT

package/bin/snowbase.js

@@ -0,0 +1,291 @@
+#!/usr/bin/env node
+import Snowbase from "../src/Snowbase.js";
+import fs from "fs";
+import path from "path";
+import chalk from "chalk";
+
+const args = process.argv.slice(2);
+const cmd = args[0];
+function levenshtein(a, b) {
+  const matrix = Array.from({ length: b.length + 1 }, (_, i) => [i]);
+
+  for (let j = 0; j <= a.length; j++) matrix[0][j] = j;
+
+  for (let i = 1; i <= b.length; i++) {
+    for (let j = 1; j <= a.length; j++) {
+      matrix[i][j] =
+        b[i - 1] === a[j - 1]
+          ? matrix[i - 1][j - 1]
+          : Math.min(
+              matrix[i - 1][j] + 1,
+              matrix[i][j - 1] + 1,
+              matrix[i - 1][j - 1] + 1,
+            );
+    }
+  }
+
+  return matrix[b.length][a.length];
+}
+
+function suggestCommand(input, commands) {
+  let best = null;
+  let distance = Infinity;
+
+  for (const command of commands) {
+    const d = levenshtein(input, command);
+
+    if (d < distance) {
+      distance = d;
+      best = command;
+    }
+  }
+
+  return distance <= 3 ? best : null;
+}
+
+let helpMessage = `
+${chalk.bold("SNOWBASE COMMANDS")}
+  ${chalk.blue("init")}  Load the directory and create the database file
+
+  ${chalk.blue("inspect")}  Inspect the database file
+
+  ${chalk.blue("backup")}  Creates a backup of the database file
+
+  ${chalk.blue("restore")}  Restore the database file
+
+  ${chalk.blue("clear")}  Clear the database file
+
+  ============================================================
+${chalk.bold("COMPILER OPTION")}
+
+  ${chalk.blue("--baseDir")} The directory where the database is located. Default: ./snowbase
+
+  ${chalk.blue("--encryption")} Enables encryption. Default: false
+
+  ${chalk.blue("--secret")} The secret key for encryption. Default: ""
+
+  ${chalk.blue("--logging")} Enables logging. Default: false
+
+  ${chalk.blue("--backup")} Enables backup. Default: false
+
+  ${chalk.blue("--restoreFile")} The backup file to restore. Default: ""
+  
+${chalk.bold("EXAMPLE")}
+  ${chalk.yellow('snowbase init --baseDir "./snowbase" --encryption --secret "mysecret" --logging --backup')}
+  `;
+if (!cmd) {
+  console.log(helpMessage);
+}
+
+const commands = ["init", "inspect", "backup", "clear", "restore", "get", "set", "remove", "has"];
+if (cmd) {
+  let config = {
+    baseDir: "./snowbase",
+    encryption: false,
+    secret: "",
+    logging: false,
+    backup: false,
+  };
+  for (let i = 1; i < args.length; i++) {
+    const arg = args[i];
+
+    if (!arg.startsWith("--")) continue;
+
+    const key = arg.slice(2);
+
+    if (i + 1 < args.length && !args[i + 1].startsWith("--")) {
+      config[key] = args[++i];
+    } else {
+      config[key] = true;
+    }
+  }
+  const db = new Snowbase(config);
+
+  switch (cmd) {
+    default: {
+      console.log(helpMessage);
+      const suggestion = suggestCommand(cmd, commands);
+      if (suggestion) {
+        console.log(`Did you mean ${chalk.blue(suggestion)}?`);
+      }
+      break;
+    }
+
+    case "init": {
+      console.log(`Snowbase initialized at ${db.baseDir}`);
+      console.log(db.backupDir);
+      break;
+    }
+    case "inspect": {
+      const all = db.get();
+      let keys = Object.keys(all || {});
+      let d = 0;
+      if (
+        keys.length === 4 &&
+        keys.sort().every((v, i) => v === ["data", "iv", "salt", "tag"][i])
+      ) {
+        d = 1;
+        console.log(chalk.blue("Database is encrypted, wait..."));
+        try {
+          keys = Object.keys(db._decrypt(JSON.stringify(all), config.secret));
+        } catch (error) {
+          d = -1;
+        }
+      }
+      if (d === 1)
+        console.log(chalk.greenBright("Database decrypted successfully"));
+      if (d > -1) {
+        console.log(`Number of keys: ${keys.length}`);
+        console.log("Keys:", keys);
+        console.log("Size of database:", JSON.stringify(all).length, " bytes");
+      } else
+        console.log(
+          chalk.red("Decryption failed, please provide a valid secret"),
+        );
+      break;
+    }
+
+    case "backup": {
+      const backupFile = db.storage.createBackup();
+      if (!backupFile)
+        console.log(
+          chalk.red(
+            "You need to use --backup flag and must have a backup directory",
+          ),
+        );
+      else console.log(`Backup created at ${backupFile}`);
+      break;
+    }
+
+    case "restore": {
+      if (!config.restoreFile) {
+        console.log(
+          "Usage: snowbase restore --secret <secret, only if needed> --restoreFile <backup-ID>",
+        );
+        console.log(
+          "Example: snowbase restore --secret mysecret123 --restoreFile 2026-06-27T14-30-45-123Z-asf3k",
+        );
+        break;
+      }
+      const backupFile = path.join(
+        db.storage.backupDir || "./snowbase/backups",
+        `backup_${config.restoreFile}.json`,
+      );
+      if (fs.existsSync(backupFile)) {
+        let fileData = fs.readFileSync(backupFile, "utf8");
+        fileData = JSON.parse(fileData);
+        let keys = Object.keys(fileData || {});
+        let d = 0;
+        if (
+          keys.length === 4 &&
+          keys.sort().every((v, i) => v === ["data", "iv", "salt", "tag"][i])
+        ) {
+          d++;
+          console.log(chalk.blue("Database is encrypted, wait..."));
+          try {
+            fileData = db._decrypt(JSON.stringify(fileData), config.secret);
+          } catch (error) {
+            d = -1;
+          }
+        }
+        if (d === 1)
+          console.log(chalk.greenBright("Database decrypted successfully"));
+        if (d > -1) {
+          const backupDataRestore = JSON.parse(
+            fs.readFileSync(backupFile, "utf8"),
+          );
+
+          fs.mkdirSync(db.storage.baseDir, { recursive: true });
+          fs.writeFileSync(
+            path.join(db.storage.baseDir, "snowbase.json"),
+            JSON.stringify(backupDataRestore),
+          );
+          db.storage._cache = backupDataRestore;
+          db.storage._cacheMtime = fs.statSync(backupFile).mtimeMs;
+          db.storage._cacheSize = fs.statSync(backupFile).size;
+          console.log(`Database restored from ${backupFile}`);
+        } else
+          console.log(
+            chalk.red("Decryption failed, please provide a valid secret"),
+            'Example: snowbase restore --secret <secret> --restoreFile <backup-ID>',
+          );
+      } else {
+        console.log(chalk.red(`Backup file ${backupFile} does not exist. Check the backup ID or if the dir exists`));
+      }
+      break;
+    }
+
+    case "clear": {
+      let all = db.get();
+      let keys = Object.keys(all || {});
+      let d = 0;
+      if (
+        keys.length === 4 &&
+        keys.sort().every((v, i) => v === ["data", "iv", "salt", "tag"][i])
+      ) {
+        d = 1;
+        console.log(chalk.blue("Database is encrypted, wait..."));
+        try {
+          all = db._decrypt(JSON.stringify(all), config.secret);
+        } catch (error) {
+          d = -1;
+        }
+      }
+      if (d === 1)
+        console.log(chalk.greenBright("Database decrypted successfully"));
+      if (d > -1) {
+        db.clear();
+        console.log("Database cleared.");
+      } else
+        console.log(
+          chalk.red("Decryption failed, please provide a valid secret"),
+        );
+      break;
+    }
+
+    case "get": {
+      let all = db.get();
+      let keys = Object.keys(all || {});
+      let d = 0;
+      if (
+        keys.length === 4 &&
+        keys.sort().every((v, i) => v === ["data", "iv", "salt", "tag"][i])
+      ) {
+        d = 1;
+        console.log(chalk.blue("Database is encrypted, wait..."));
+        try {
+          all = db._decrypt(JSON.stringify(all), config.secret);
+        } catch (error) {
+          d = -1;
+        }
+      }
+      if (d === 1)
+        console.log(chalk.greenBright("Database decrypted successfully"));
+      if (d > -1) {
+        if (!config.key) console.log(all);
+        else console.log(db._getTargetFromData(all, config.key));
+      } else
+        console.log(
+          chalk.red("Decryption failed, please provide a valid secret"),
+        );
+      break;
+    }
+
+    case "set": {
+      if (!config.key) console.log(db.get());
+      else console.log(db.get(config.key));
+      break;
+    }
+    case "remove": {
+      let run = db.remove(config.key);
+      if (run) console.log(chalk.green("Value removed successfully"));
+      else console.log(chalk.red("Value not removed"));
+      break;
+    }
+    case "has": {
+      let run = db.has(config.key);
+      console.log(run);
+      break;
+    }
+  }
+}

package/package.json

@@ -1,24 +1,58 @@
 {
   "name": "snowbase",
-  "version": "5.0.0",
-  "description": "Local and Global Server database using json",
-  "main": "index.js",
-  "dependencies": {
-    "node-fetch": "^2.6.1"
-  },
-  "devDependencies": {},
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "mr.frozenfire",
-  "license": "ISC",
+  "version": "6.0.0",
+  "description": "A lightweight local JSON database for modern JavaScript projects.",
+  "keywords": [
+    "file-database",
+    "local storage",
+    "database",
+    "json",
+    "crypto",
+    "lightweight",
+    "db"
+  ],
+  "homepage": "https://github.com/p3droob/snowbase#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/FrozenFireBR/snowbase.git"
+    "url": "https://github.com/p3droob/snowbase"
   },
   "bugs": {
-    "url": "https://github.com/FrozenFireBR/snowbase/issues"
+    "url": "https://github.com/p3droob/snowbase/issues"
+  },
+  "license": "MIT",
+  "author": "p3droob",
+  "main": "./src/Snowbase.js",
+  "type": "module",
+  "exports": {
+    ".": "./src/Snowbase.js",
+    "./async": "./src/SnowbaseAsync.js"
+  },
+  "bin": {
+    "snowbase": "./bin/snowbase.js"
   },
-  "homepage": "https://github.com/FrozenFireBR/snowbase#readme"
+  "files": [
+    "src",
+    "bin",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "node test/index.js",
+    "test:comprehensive": "node test/comprehensive.js",
+    "test:async": "node test/indexAsync.js"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "devDependencies": {
+    "@types/node": "^26.0.1",
+    "typescript": "^6.0.3"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2"
+  }
 }