twin-db 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jaelson Kaciel
+
+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/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { TwinDB } from './structures/database';
+export default TwinDB;

package/dist/index.js

@@ -0,0 +1,2 @@
+import { TwinDB } from './structures/database';
+export default TwinDB;

package/dist/structures/database.d.ts

@@ -0,0 +1,18 @@
+export declare class TwinDB {
+    data: object;
+    path: string;
+    name: string;
+    constructor(name?: string);
+    private load;
+    private update;
+    set(path: string, value: unknown): Promise<object>;
+    get(path: string): unknown | null;
+    delete(path: string): Promise<object>;
+    private sumOrSub;
+    sum(path: string, value: number): Promise<object>;
+    sub(path: string, value: number): Promise<object>;
+    concat(path: string, value: string): Promise<object>;
+    push(path: string, ...values: unknown[]): Promise<object>;
+    pull(path: string, ...values: unknown[]): Promise<object>;
+}
+export type SumOrSub = 'sum' | 'sub';

package/dist/structures/database.js

@@ -0,0 +1,133 @@
+import { readFileSync, writeFileSync, mkdirSync, existsSync } from 'fs';
+const pathErrorMessage = 'The path must be a string or you dont provide a path';
+export class TwinDB {
+    data;
+    path;
+    name;
+    constructor(name = 'db') {
+        this.path = 'database/' + name + '.json';
+        this.name = name;
+        if (!existsSync('database'))
+            mkdirSync('database');
+        this.load();
+    }
+    async load() {
+        let data;
+        try {
+            data = readFileSync(this.path, 'utf8');
+        }
+        catch (e) {
+            data = '';
+        }
+        this.data = data ? JSON.parse(data) : {};
+        if (!data)
+            writeFileSync(this.path, JSON.stringify(this.data, null, 2), 'utf8');
+    }
+    async update(path /*user.info.name*/, value) {
+        const keys = path.split('.');
+        if (keys.length > 1)
+            for (let i = 0; i < keys.length - 1; i++) {
+                const thisKeys = keys.slice(0, i + 1);
+                const mappedKeys = thisKeys.map((key) => `['${key}']`);
+                const searchedValue = await eval('this.data' + mappedKeys.join(''));
+                if (typeof searchedValue !== 'object')
+                    await eval('this.data' + mappedKeys.join('') + ' = {}');
+            } // percorre todos os objetos definindo eles como {} para não dar erro abaixo
+        await eval(`this.data` +
+            keys.map((key) => `['${key}']`).join('') +
+            ` = ${JSON.stringify(value)}`);
+        writeFileSync(this.path, JSON.stringify(this.data, null, 2), 'utf8');
+        return this.data;
+    }
+    set(path, value) {
+        if (!path || typeof path !== 'string')
+            throw new Error(pathErrorMessage);
+        if (value === undefined)
+            throw new Error('You must provide a value to update');
+        return this.update(path, value);
+    }
+    get(path) {
+        if (!path || typeof path !== 'string')
+            throw new Error(pathErrorMessage);
+        const keys = path.split('.');
+        let current = this.data;
+        let i = 0;
+        for (const key of keys) {
+            i++;
+            if (i === keys.length)
+                return current[key] ?? null;
+            if (typeof current[key] !== 'object')
+                return null;
+            current = current[key];
+        }
+    }
+    async delete(path) {
+        if (!path || typeof path !== 'string')
+            throw new Error(pathErrorMessage);
+        const keys = path.split('.');
+        const pathExists = this.get(path);
+        if (pathExists === null)
+            throw new Error('The path does not exists or its value is null');
+        const success = await eval('delete this.data' + keys.map((key) => `['${key}']`).join(''));
+        if (!success)
+            throw new Error('Could not delete the value');
+        writeFileSync(this.path, JSON.stringify(this.data, null, 2), 'utf8');
+        return this.data;
+    }
+    sumOrSub(path, value, type) {
+        if (!path || typeof path !== 'string')
+            throw new Error(pathErrorMessage);
+        if (!type || !['sum', 'sub'].includes(type))
+            throw new Error('The type must be "sum" or "sub"');
+        const isSum = type === 'sum';
+        if (!value || typeof value !== 'number')
+            throw new Error(`The value to ${isSum ? 'sum' : 'sub'} must be a number`);
+        const currentValue = this.get(path);
+        if (typeof currentValue !== 'number')
+            throw new Error(`The value to ${isSum ? 'sum' : 'sub'} is not a number or the path does not exists`);
+        return this.update(path, isSum ? currentValue + value : currentValue - value);
+    }
+    sum(path, value) {
+        return this.sumOrSub(path, value, 'sum');
+    }
+    sub(path, value) {
+        return this.sumOrSub(path, value, 'sub');
+    }
+    concat(path, value) {
+        if (!path || typeof path !== 'string')
+            throw new Error(pathErrorMessage);
+        if (!value || typeof value !== 'string')
+            throw new Error('You must provide a string value to update');
+        const currentValue = this.get(path);
+        if (typeof currentValue !== 'string')
+            throw new Error('The value to concat is not a string or the path does not exists');
+        return this.update(path, currentValue + value);
+    }
+    push(path, ...values) {
+        if (!path || typeof path !== 'string')
+            throw new Error(pathErrorMessage);
+        if (!values || values.length === 0)
+            throw new Error('You must provide a value to update');
+        const currentValue = this.get(path);
+        if (!Array.isArray(currentValue))
+            throw new Error('The current value of this path is not an array or the path does not exists');
+        currentValue.push(...values);
+        return this.update(path, currentValue);
+    }
+    pull(path, ...values) {
+        if (!path || typeof path !== 'string')
+            throw new Error(pathErrorMessage);
+        if (!values || values.length === 0)
+            throw new Error('You must provide a value to update');
+        const currentValue = this.get(path);
+        if (!Array.isArray(currentValue))
+            throw new Error('The current value of this path is not an array or the path does not exists');
+        for (const value of values) {
+            const index = currentValue.indexOf(value);
+            if (index < 0)
+                continue;
+            currentValue.splice(index, 1);
+        }
+        return this.update(path, currentValue);
+    }
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "twin-db",
+  "version": "1.0.0",
+  "description": "A usefully local database.",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
+  "scripts": {
+    "test": "tsx src/index.ts",
+    "prettier": "npx prettier --write \"**/*.{js,ts}\"",
+    "build": "npx tsc"
+  },
+  "author": {
+    "name": "Jaelson Kaciel",
+    "email": "jaelsonkaciel4@gmail.com",
+    "url": "https://github.com/toddy007"
+  },
+  "keywords": ["db", "database", "local", "localdb", "localdatabase", "twin"],
+  "license": "MIT",
+  "devDependencies": {
+    "prettier": "^3.8.1",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/toddy007/twin-db.git"
+  },
+  "engines": {
+    "node": ">=21.6.2"
+  }
+}