sehawq.db 2.3.0

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,30 @@
+name: Publish to NPM
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*' # Sadece versiyon tag'lerinde çalışır (örn: v2.1.0)
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Publish package
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ömer
+
+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/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "sehawq.db",
+  "version": "2.3.0",
+  "description": "Lightweight JSON-based key-value database with namespaces, array & math helpers.",
+  "main": "src/index.js",
+  "keywords": [
+    "database",
+    "json",
+    "key-value",
+    "quick.db",
+    "lightweight"
+  ],
+  "author": "Omer (sehawq)",
+  "license": "MIT"
+}

package/readme.md

@@ -0,0 +1,46 @@
+# sehawq.db  
+
+[![npm version](https://img.shields.io/npm/v/sehawq.db.svg)](https://www.npmjs.com/package/sehawq.db)  
+[![npm downloads](https://img.shields.io/npm/dt/sehawq.db.svg)](https://www.npmjs.com/package/sehawq.db)  
+[![license](https://img.shields.io/github/license/sehawq/sehawq.db.svg)](LICENSE)  
+
+**Lightweight JSON-based key-value database for Node.js**  
+Minimal, dependency-free, and easy-to-use. Perfect for small projects, bots, CLIs, and prototyping.  
+
+---
+
+## 🚀 Features  
+
+- **JSON-based lightweight storage** — No extra dependencies, works with pure Node.js.  
+- **Key-Value structure** — Simple `set`, `get`, `delete` logic.  
+- **Dot-notation namespace** — Access nested data with `user.123.balance`.  
+- **Sync & Async API** — Choose blocking or non-blocking file operations.  
+- **Auto-save** — Writes changes to disk at regular intervals.  
+
+### 🔧 Array Helpers  
+- `push(key, value)` — Add an element to an array.  
+- `pull(key, value)` — Remove an element from an array.  
+
+### ➗ Math Helpers  
+- `add(key, number)` — Increment a numeric value.  
+- `subtract(key, number)` — Decrement a numeric value.  
+
+### 💾 Backup & Restore  
+- `backup(filePath)` — Save a backup of the database.  
+- `restore(filePath)` — Restore database from a backup.  
+
+### 📡 Event Emitter  
+Hooks into database operations:  
+- `set` — Triggered when data is added or updated.  
+- `delete` — Triggered when a key is removed.  
+- `clear` — Triggered when all data is cleared.  
+- `push` / `pull` — Triggered on array modification.  
+- `add` — Triggered on numeric increment.  
+- `backup` / `restore` — Triggered on backup or restore.  
+
+---
+
+## 📦 Installation  
+
+```bash
+npm install sehawq.db

package/src/index.js

@@ -0,0 +1,173 @@
+const fs = require("fs").promises;
+const path = require("path");
+const EventEmitter = require("events");
+
+class SehawqDB extends EventEmitter {
+  /**
+   * Create a new SehawqDB instance.
+   * @param {Object} options
+   * @param {string} [options.path="sehawq.json"] File path for storage.
+   * @param {number} [options.autoSaveInterval=0] Autosave interval in ms (0 disables autosave).
+   */
+  constructor(options = {}) {
+    super();
+    this.filePath = path.resolve(options.path || "sehawq.json");
+    this.autoSaveInterval = options.autoSaveInterval || 0;
+    this.data = {};
+
+    this._init();
+
+    if (this.autoSaveInterval > 0) {
+      this._interval = setInterval(() => this.save(), this.autoSaveInterval);
+    }
+  }
+
+  async _init() {
+    try {
+      await fs.access(this.filePath);
+    } catch {
+      await fs.writeFile(this.filePath, JSON.stringify({}), "utf8");
+    }
+
+    try {
+      const content = await fs.readFile(this.filePath, "utf8");
+      this.data = JSON.parse(content);
+    } catch {
+      this.data = {};
+    }
+  }
+
+  // ---------------- Core methods ----------------
+  set(key, value) {
+    this._setByPath(key, value);
+    this.emit("set", { key, value });
+    this.save();
+    return value;
+  }
+
+  get(key) {
+    return this._getByPath(key);
+  }
+
+  delete(key) {
+    this._deleteByPath(key);
+    this.emit("delete", { key });
+    this.save();
+  }
+
+  has(key) {
+    return this._getByPath(key) !== undefined;
+  }
+
+  all() {
+    return this.data;
+  }
+
+  clear() {
+    this.data = {};
+    this.emit("clear");
+    this.save();
+  }
+
+  keys() {
+    return Object.keys(this.data);
+  }
+
+  values() {
+    return Object.values(this.data);
+  }
+
+  // ---------------- Array helpers ----------------
+  push(key, value) {
+    let arr = this._getByPath(key);
+    if (!Array.isArray(arr)) arr = [];
+    arr.push(value);
+    this._setByPath(key, arr);
+    this.emit("push", { key, value });
+    this.save();
+    return arr;
+  }
+
+  pull(key, value) {
+    let arr = this._getByPath(key);
+    if (!Array.isArray(arr)) return [];
+    arr = arr.filter(v => v !== value);
+    this._setByPath(key, arr);
+    this.emit("pull", { key, value });
+    this.save();
+    return arr;
+  }
+
+  // ---------------- Math helpers ----------------
+  add(key, number) {
+    let val = this._getByPath(key);
+    if (typeof val !== "number") val = 0;
+    val += number;
+    this._setByPath(key, val);
+    this.emit("add", { key, number });
+    this.save();
+    return val;
+  }
+
+  subtract(key, number) {
+    return this.add(key, -number);
+  }
+
+  // ---------------- Backup & Restore ----------------
+  async backup(backupPath) {
+    await fs.writeFile(backupPath, JSON.stringify(this.data, null, 2), "utf8");
+    this.emit("backup", { backupPath });
+  }
+
+  async restore(backupPath) {
+    const content = await fs.readFile(backupPath, "utf8");
+    this.data = JSON.parse(content);
+    await this.save();
+    this.emit("restore", { backupPath });
+  }
+
+  // ---------------- Save ----------------
+  async save() {
+    const tmpPath = `${this.filePath}.tmp`;
+    await fs.writeFile(tmpPath, JSON.stringify(this.data, null, 2), "utf8");
+    await fs.rename(tmpPath, this.filePath);
+  }
+
+  // ---------------- Internal utilities ----------------
+  _getByPath(pathStr) {
+    const keys = pathStr.split(".");
+    let obj = this.data;
+    for (const k of keys) {
+      if (obj && Object.prototype.hasOwnProperty.call(obj, k)) {
+        obj = obj[k];
+      } else {
+        return undefined;
+      }
+    }
+    return obj;
+  }
+
+  _setByPath(pathStr, value) {
+    const keys = pathStr.split(".");
+    let obj = this.data;
+    while (keys.length > 1) {
+      const k = keys.shift();
+      if (!obj[k] || typeof obj[k] !== "object") obj[k] = {};
+      obj = obj[k];
+    }
+    obj[keys[0]] = value;
+  }
+
+  _deleteByPath(pathStr) {
+    const keys = pathStr.split(".");
+    let obj = this.data;
+    while (keys.length > 1) {
+      const k = keys.shift();
+      if (!obj[k]) return;
+      obj = obj[k];
+    }
+    delete obj[keys[0]];
+  }
+}
+
+module.exports = SehawqDB;