@galaxy05/map.db 1.2.1 → 1.3.0

package/README.md

@@ -13,10 +13,10 @@ The file structure is easily accessible and the data is stored in JSON format, a
 
 ![image](img2.png)
 
-You also have the option to only use local storage without touching internal memory
+You also have the option to only use local storage, disabling internal memory
 
 ### Differences
-Although this module works in fact the same way as a Map, there are still some little differences between them, which are listed below:
+Although this module works in fact the same way as a Map, there are a few differences between them, which are listed below:
 > - `MapDB#set()` and `MapDB#delete()` return **promises**
 > - `Map#size` in map.db is a **method** (`MapDB#size()`)
 > - When a value is reassigned to a key, it is only saved in the Map but not in the actual save file, so you always have to **set the key/value pair with the new value**.
@@ -46,4 +46,4 @@ With **npm**:
 
 With **yarn**:
 
-`yarn add @galaxy05/map.db`
+`yarn add @galaxy05/map.db`

package/build/index.js

@@ -0,0 +1,216 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+const util_1 = require("util");
+const fs = __importStar(require("fs"));
+const writeDB = (0, util_1.promisify)(fs.writeFile);
+// const deleteDB = promisify(fs.unlink);
+class MapDB {
+    map;
+    filename;
+    db;
+    options;
+    path;
+    /**
+     * @constructor
+     * @param filename If not set, MapDB will only use internal memory
+     * @example 'file.db'
+     * @param options Options to pass in the constructor
+     * @param options.localOnly Disable internal memory
+     * @param options.path Optional existing path to save the MapDB data directory
+     */
+    constructor(filename, options) {
+        if (!filename && options?.localOnly)
+            throw new Error('Cannot use local storage without a filename');
+        this.map = !options?.localOnly ? new Map() : null;
+        this.filename = filename;
+        this.path = options.path ?? '.';
+        if (!fs.existsSync(`${this.path}/data/`))
+            fs.mkdirSync(`${this.path}/data`);
+        this.db = this.filename ? `${this.path}/data/${this.filename}` : null;
+        if (this.map && this.db) {
+            try {
+                const file = fs.readFileSync(this.db);
+                const data = JSON.parse(file.toString());
+                for (let i = 0; i < data.length; i++) {
+                    this.map.set(data[i].key, data[i].value);
+                }
+            }
+            catch { }
+        }
+    }
+    /**
+     *
+     * @param key
+     * @param value
+     */
+    async set(key, value) {
+        if (typeof key !== 'string' && typeof key !== 'number') {
+            throw new TypeError('key must be of type string or number');
+        }
+        if (this.db) {
+            try {
+                const file = fs.readFileSync(this.db);
+                const data = JSON.parse(file.toString());
+                const i = data.findIndex(pair => pair.key == key);
+                !data[i] ? data.push({ key, value }) : data[i] = { key, value };
+                await writeDB(this.db, JSON.stringify(data));
+                if (!this.map)
+                    return data;
+            }
+            catch {
+                await writeDB(this.db, `[${JSON.stringify({ key, value })}]`).then(() => {
+                    if (!this.map)
+                        return JSON.parse(fs.readFileSync(this.db).toString());
+                });
+            }
+        }
+        return this.map.set(key, value);
+    }
+    /**
+     *
+     * @param key
+     */
+    get(key) {
+        if (this.map) {
+            return this.map.get(key);
+        }
+        else {
+            const file = fs.readFileSync(this.db);
+            const data = JSON.parse(file.toString());
+            return data.find(pair => pair.key == key)?.value || undefined;
+        }
+    }
+    /**
+     *
+     * @param key
+     */
+    has(key) {
+        if (this.map) {
+            return this.map.has(key);
+        }
+        else {
+            const file = fs.readFileSync(this.db);
+            const data = JSON.parse(file.toString());
+            return data.find(pair => pair.key == key) ? true : false;
+        }
+    }
+    entries() {
+        if (this.map) {
+            return this.map.entries();
+        }
+        else {
+            const file = fs.readFileSync(this.db);
+            const data = JSON.parse(file.toString());
+            return data.map(pair => [pair.key, pair.value]);
+        }
+    }
+    keys() {
+        if (this.map) {
+            return this.map.keys();
+        }
+        else {
+            const file = fs.readFileSync(this.db);
+            const data = JSON.parse(file.toString());
+            return data.map(pair => pair.key);
+        }
+    }
+    values() {
+        if (this.map) {
+            return this.map.values();
+        }
+        else {
+            const file = fs.readFileSync(this.db);
+            const data = JSON.parse(file.toString());
+            return data.map(pair => pair.value);
+        }
+    }
+    /**
+     *
+     * @param callbackfn
+     */
+    forEach(callback) {
+        if (this.map) {
+            this.map.forEach(callback);
+        }
+        else {
+            const file = fs.readFileSync(this.db);
+            const data = JSON.parse(file.toString());
+            data.forEach(pair => callback(pair.value, pair.key, this.map));
+        }
+    }
+    /**
+     *
+     * @param key
+     */
+    async delete(key) {
+        if (this.db) {
+            try {
+                const file = fs.readFileSync(this.db);
+                const data = JSON.parse(file.toString());
+                const i = data.findIndex(pair => pair.key == key);
+                if (data[i]) {
+                    data.splice(i, 1);
+                    await writeDB(this.db, JSON.stringify(data));
+                    if (!this.map)
+                        return true;
+                }
+                else if (!this.map) {
+                    return false;
+                }
+            }
+            catch { }
+        }
+        if (this.map) {
+            return this.map.delete(key);
+        }
+    }
+    async clear() {
+        await writeDB(this.db, JSON.stringify([])).catch(() => { });
+        if (this.map) {
+            this.map.clear();
+        }
+    }
+    size() {
+        if (this.map) {
+            return this.map.size;
+        }
+        else {
+            const file = fs.readFileSync(this.db);
+            const data = JSON.parse(file.toString());
+            return data.length;
+        }
+    }
+}
+module.exports = MapDB;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galaxy05/map.db",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "A Map that stores data locally and loads it at startup",
   "types": "types/index.d.ts",
   "main": "build/index.js",
@@ -26,7 +26,7 @@
   },
   "homepage": "https://github.com/GalaxyVinci05/map.db#readme",
   "devDependencies": {
-    "@types/node": "^24.10.1"
+    "@types/node": "^25.2.0"
   },
   "dependencies": {
     "typescript": "^5.9.3"

package/src/index.ts

@@ -2,30 +2,33 @@ import { promisify } from 'util';
 import * as fs from 'fs';
 
 const writeDB = promisify(fs.writeFile);
-const deleteDB = promisify(fs.unlink);
+// const deleteDB = promisify(fs.unlink);
 
 class MapDB {
     readonly map;
     filename: string;
     readonly db;
-    options: any;
+    options: MapDBOptions;
+    private path: string;
 
     /**
      * @constructor
      * @param filename If not set, MapDB will only use internal memory
      * @example 'file.db'
      * @param options Options to pass in the constructor
-     * @param options.localOnly When enabled, MapDB will only use local storage, without touching internal memory (requires a filename)
+     * @param options.localOnly Disable internal memory
+     * @param options.path Optional existing path to save the MapDB data directory
      */
-    constructor(filename?: string, options?: { localOnly: boolean }) {
+    constructor(filename?: string, options?: MapDBOptions) {
         if (!filename && options?.localOnly) throw new Error('Cannot use local storage without a filename');
 
         this.map = !options?.localOnly ? new Map() : null;
         this.filename = filename;
+        this.path = options.path ?? '.';
         
-        if (!fs.existsSync('./data/')) fs.mkdirSync('./data');
+        if (!fs.existsSync(`${this.path}/data/`)) fs.mkdirSync(`${this.path}/data`);
 
-        this.db = this.filename ? `./data/${this.filename}` : null;
+        this.db = this.filename ? `${this.path}/data/${this.filename}` : null;
         
         if (this.map && this.db) {
             try {
@@ -197,4 +200,9 @@ class MapDB {
     }
 }
 
-export = MapDB;
+interface MapDBOptions {
+    localOnly?: boolean;
+    path?: string;
+}
+
+export = MapDB;

package/tsconfig.json

@@ -5,7 +5,6 @@
         "target": "ESNext",
         "noImplicitAny": true,
         "declaration": true,
-        "watch": true,
         "outDir": "build",
         "declarationDir": "types",
         "esModuleInterop": true   
@@ -16,4 +15,4 @@
     "exclude": [
         "node_modules"
     ]
-}
+}

package/types/index.d.ts

@@ -2,17 +2,17 @@ declare class MapDB {
     readonly map: Map<any, any>;
     filename: string;
     readonly db: string;
-    options: any;
+    options: MapDBOptions;
+    private path;
     /**
      * @constructor
      * @param filename If not set, MapDB will only use internal memory
      * @example 'file.db'
      * @param options Options to pass in the constructor
-     * @param options.localOnly When enabled, MapDB will only use local storage, without touching internal memory (requires a filename)
+     * @param options.localOnly Disable internal memory
+     * @param options.path Optional existing path to save the MapDB data directory
      */
-    constructor(filename?: string, options?: {
-        localOnly: boolean;
-    });
+    constructor(filename?: string, options?: MapDBOptions);
     /**
      *
      * @param key
@@ -29,9 +29,9 @@ declare class MapDB {
      * @param key
      */
     has(key: string | number): boolean;
-    entries(): IterableIterator<[any, any]> | any[][];
-    keys(): any[] | IterableIterator<any>;
-    values(): any[] | IterableIterator<any>;
+    entries(): MapIterator<[any, any]> | any[][];
+    keys(): any[] | MapIterator<any>;
+    values(): any[] | MapIterator<any>;
     /**
      *
      * @param callbackfn
@@ -45,4 +45,8 @@ declare class MapDB {
     clear(): Promise<void>;
     size(): number;
 }
+interface MapDBOptions {
+    localOnly?: boolean;
+    path?: string;
+}
 export = MapDB;