deepbase-redis 1.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Martin Clasen
+
+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

@@ -0,0 +1,97 @@
+# 🌳 DeepBase Redis
+
+DeepBaseRedis is an innovative and efficient module designed to seamlessly integrate with Redis Stack, providing a robust solution for managing and interacting with databases. With DeepBaseRedis, you can effortlessly perform CRUD operations and manipulate data stored in Redis Stack (json module) collections.
+
+For simplicity you may be interested in the version of DeepBase that persists in JSON files. https://www.npmjs.com/package/deepbase
+
+## 📦 Installation
+```shell
+npm install deepbase
+```
+
+## 🔧 Usage
+```js
+const DeepBase = require("deepbase");
+const mem = new DeepBase({ name: "db" }); // "db" redis prefix
+await mem.connect();
+```
+
+### ✍️ Setting Values
+```js
+await mem.set("config", "lang", "en");
+
+const configLang = await mem.get("config", "lang");
+console.log(configLang); // "en"
+```
+
+### ✅ Adding Rows
+```js
+const path = await mem.add("user", { name: "martin" });
+
+// add() will create a secure key (ie. "iKid4OCK")
+console.log(path) // [ 'user', 'iKid4OCK' ]
+
+const userName = await mem.get(...path, "name");
+console.log(userName); // "martin"
+```
+
+### 🔢 Increment fields
+```js
+await mem.inc(...path, "balance", 160);
+await mem.inc(...path, "balance", 420);
+
+const userBalance = await mem.get(...path, "balance");
+console.log(userBalance); // 580
+```
+
+### ⚗️ Update
+```js
+await mem.upd("config", "lang", v => v.toUpperCase());
+const lang = await mem.get("config", "lang"); // EN
+```
+
+### 🔥 Finally
+```js
+await mem.add("user", { name: "anya" });
+
+const userIds = await mem.keys("user")
+console.log(userIds) // [ 'iKid4OCKds', 'F3wORv_Jsd' ]
+
+console.log(await mem.get())
+// {
+//     config: { lang: 'EN' },
+//     user: {
+//         iKid4OCKds: { name: 'martin', balance: 580 },
+//         F3wORv_Jsd: { name: 'anya' }
+//     }
+// }
+```
+
+## 🤯 Features
+- 🔍 Easily access and modify nested objects in JSON storage.
+- 📁 Provides an easy-to-use interface for connecting to Redis JSON and performing data operations, saving development.
+- 🌱 Simple and intuitive API for managing complex JSON structures.
+
+## 🤔 Why DeepBase 
+- ⚡ Fastest and simplest way to add persistence to your projects.
+- 📖 Offers advanced querying capabilities, nested value retrieval, and seamless update processes.
+- 🧠 Easy to use and understand.
+
+## 🤝 Contributing
+Contributions to DeepBase are welcome! If you have an idea or a bug to report, please open an issue. If you would like to contribute to the code, please open a pull request.
+
+## 🎬 Conclusion
+DeepBaseRedis is built with efficiency and performance in mind, leveraging the power of the Redis Stack driver and optimizing data access operations. Whether you're building a small-scale application or a complex system, DeepBaseRedis empowers you to interact with Redis Stack effortlessly, making your development process smoother and more efficient.
+
+🚀 Try DeepBaseRedis today and experience the convenience and power it brings to your Redis Stack data management workflow!
+
+## 📄 License
+The MIT License (MIT)
+
+Copyright (c) Martin Clasen
+
+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/demo/demo.mjs

@@ -0,0 +1,54 @@
+import DeepBase from '../index.mjs';
+
+const mem = new DeepBase({ name: "demo" });
+
+await mem.connect();
+
+// SET
+await mem.set("config", "lang", "en");
+
+const configLang = await mem.get("config", "lang");
+console.log(configLang); // "en"
+
+// ADD
+const path = await mem.add("user", { name: "martin" });
+console.log(path) // [ 'user', 'iKid4OCKds' ] / iKid4OCKds is a random string
+
+const userName = await mem.get(...path, "name");
+console.log(userName); // "martin"
+
+// INC
+await mem.inc(...path, "count", 1);
+await mem.inc(...path, "count", 1);
+
+const userBalance = await mem.get(...path, "count");
+console.log(userBalance); // 2
+
+await mem.add("user", { name: "anya" });
+
+const userIds = await mem.keys("user")
+console.log(userIds) // [ 'CqtOILTDUg', 'MXOlTBSmEf' ]
+
+// UPDATE
+await mem.upd("config", "lang", v => v.toUpperCase());
+const lang = await mem.get("config", "lang"); // EN
+
+console.log({
+    config: await mem.get("config"),
+    user: await mem.get("user")
+})
+
+// {
+//     "config": {
+//         "lang": "EN"
+//     },
+//     "user": {
+//         "CqtOILTDUg": {
+//             "name": "martin",
+//             "count": 2
+//         },
+//         "MXOlTBSmEf": {
+//             "name": "anya"
+//         }
+//     }
+// }

package/index.mjs

@@ -0,0 +1,135 @@
+import { createClient } from 'redis';
+import { customAlphabet } from 'nanoid'
+
+export default class DeepBaseRedis {
+
+    constructor(opts = {}) {
+        this.nidAlphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+        this.nidLength = 10;
+        this.name = "db";
+        this.url = "redis://localhost:6379";
+        Object.assign(this, opts)
+
+        this.nanoid = customAlphabet(this.nidAlphabet, this.nidLength)
+        this.client = createClient({ url: this.url });
+    }
+
+    async disconnect() {
+        await this.client.disconnect();
+    }
+
+    async connect() {
+        await this.client.connect();
+    }
+
+    async set(...args) {
+        if (args.length < 2) return
+        const keys = args.slice(0, -1)
+        const value = args[args.length - 1]
+
+        const key = keys.shift()
+        const keyPath = keys.length == 0 ? "." : keys.join('.')
+        await this._set(key, keyPath, value);
+        return args.slice(0, -1)
+    }
+
+    async _set(key, path, value) {
+
+        if (value === undefined) {
+            await this.client.json.del(this.name + ":" + key, path);
+            return;
+        }
+
+        let r = null;
+        try {
+            r = await this.client.json.set(this.name + ":" + key, path, value);
+        } catch (error) {
+
+        }
+
+        if (r === null) {
+            const keys = path.split('.');
+            keys.pop();
+            const keyPath = keys.length == 0 ? "." : keys.join('.')
+            await this._set(key, keyPath, {});
+            await this._set(key, path, value);
+        }
+    }
+
+    async get(...args) {
+
+        if (args.length == 0) return null
+
+        const key = args.shift()
+        const path = args.length == 0 ? "." : args.join('.');
+
+        let r = null
+        try {
+            r = await this.client.json.get(this.name + ":" + key, { path });
+        } catch (error) {
+
+        }
+        return r;
+    }
+
+    async keys(...args) {
+        const r = await this.get(...args)
+        return (r !== null && typeof r === "object") ? Object.keys(r) : [];
+    }
+
+    async upd(...args) {
+        const func = args.pop()
+        return this.set(...args, func(await this.get(...args)))
+    }
+
+    async inc(...args) {
+
+        const i = args.pop()
+        const key = args.shift()
+        const path = args.length == 0 ? "." : args.join('.')
+
+        try {
+            await this.client.json.numIncrBy(this.name + ":" + key, path, i);
+            return args.slice(0, -1)
+        } catch (error) {
+            args.unshift(key)
+            return this.upd(...args, n => n + i)
+        }
+    }
+
+    async dec(...args) {
+        const i = args.pop()
+        args.push(-i)
+        return this.inc(...args)
+    }
+
+    async del(...args) {
+        const key = args.shift()
+        const path = args.length == 0 ? "." : args.join('.')
+        await this.client.json.del(this.name + ":" + key, path);
+        return [key, ...args]
+    }
+
+    async add(...keys) {
+        const value = keys.pop();
+        const id = this.nanoid();
+        await this.set(...[...keys, id, value])
+        return [...keys, id]
+    }
+}
+
+// const mem = new DeepBaseRedis();
+
+// await mem.del('a')
+
+// await mem.add('a', 'b', 'c', 1)
+// await mem.add('a', 'b', 'c', 1)
+// await mem.get('a', 'b', 'c')
+
+// await mem.set('a', 'b', 'a', 1)
+// await mem.set('a', 'c', 'a', 1)
+// await mem.del('a', 'c', 'a', 1)
+
+// console.log(await mem.get('a'))
+
+// await client.quit();

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "deepbase-redis",
+  "version": "1.0.6",
+  "description": "⚡ Fastest and simplest way to add Redis persistence to your projects.",
+  "main": "index.js",
+  "dependencies": {
+    "nanoid": "^5.0.4",
+    "redis": "^4.6.12"
+  },
+  "scripts": {
+    "test": "mocha"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clasen/DeepBaseRedis.git"
+  },
+  "keywords": [
+    "redis",
+    "redis-json",
+    "redis-stack",
+    "json",
+    "database",
+    "persist",
+    "nested",
+    "objects",
+    "user-friendly",
+    "intuitive",
+    "reliable",
+    "synchronization",
+    "structure",
+    "lowdb"
+  ],
+  "author": "Martin Clasen",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/clasen/DeepBaseRedis/issues"
+  },
+  "homepage": "https://github.com/clasen/DeepBaseRedis#readme",
+  "devDependencies": {
+    "mocha": "^10.2.0"
+  },
+  "directories": {
+    "test": "test"
+  }
+}

package/test/test.mjs

@@ -0,0 +1,136 @@
+/* eslint-env mocha */
+
+import DeepBase from '../index.mjs';
+import assert from 'assert';
+
+describe('DeepBaseRedis', () => {
+    let db;
+
+    beforeEach(async () => {
+        db = new DeepBase({ name: 'test' });
+        await db.connect();
+    });
+
+    afterEach(async () => {
+        await db.del('foo');
+    });
+
+    describe('#set()', () => {
+        it('should set a value at a given path', async () => {
+            await db.set('foo', 'bar', 'baz');
+            const baz = await db.get('foo', 'bar');
+            assert.deepEqual(baz, 'baz');
+        });
+
+        it('should overwrite an existing value at the same path', async () => {
+            await db.set('foo', 'bar', 'baz');
+            await db.set('foo', 'bar', 'qux');
+            const qux = await db.get('foo', 'bar')
+            assert.deepEqual(qux, 'qux');
+        });
+
+        it('should do nothing if no value is provided', async () => {
+            await db.set('foo', 'bar');
+            await db.set('foo', 'bar', undefined);
+            const udf = await db.get('foo', 'bar');
+            assert.deepEqual(udf, undefined);
+        });
+
+        it('should save changes to Redis', async () => {
+            await db.set('foo', 'bar', 'baz');
+            db = new DeepBase({ name: 'test' }); // create a new instance to reload the saved data
+            await db.connect();
+            const baz = await db.get('foo', 'bar');
+            assert.deepEqual(baz, 'baz');
+        });
+    });
+
+    describe('#get()', () => {
+        it('should retrieve a value at a given path', async () => {
+            await db.set('foo', 'bar', 'baz');
+            assert.deepEqual(await db.get('foo', 'bar'), 'baz');
+        });
+
+        it('should return null if the value does not exist', async () => {
+            assert.deepEqual(await db.get('foo', 'bar'), null);
+        });
+
+        it('should return null if no keys are provided', async () => {
+            assert.deepEqual(await db.get(), null);
+        });
+    });
+
+    describe('#del()', () => {
+        it('should delete a value at a given path', async () => {
+            await db.set('foo', 'bar', 'baz');
+            await db.del('foo', 'bar');
+            assert.deepEqual(await db.get('foo', 'bar'), null);
+        });
+
+        it('should do nothing if the value does not exist', async () => {
+            await db.del('foo', 'bar');
+            assert.deepEqual(await db.get('foo', 'bar'), null);
+        });
+
+        it('should save changes to Redis', async () => {
+            await db.set('foo', 'bar', 'baz');
+            await db.del('foo', 'bar');
+            db = new DeepBase({ name: 'test' }); // create a new instance to reload the saved data
+            await db.connect();
+            assert.deepEqual(await db.get('foo', 'bar'), null);
+        });
+    });
+
+    describe('#add()', () => {
+
+        it('should save changes to Redis', async () => {
+            const obj = { bar: 'baz' }
+            const path = await db.add('foo', obj);
+            assert.deepEqual(await db.get(...path), obj);
+        });
+    });
+
+    describe('#inc()', () => {
+
+        it('should increment a value at a given path', async () => {
+            await db.set('foo', 'bar', 1);
+            await db.inc('foo', 'bar', 2);
+            assert.deepEqual(await db.get('foo', 'bar'), 3);
+        });
+    });
+
+    describe('#dec()', () => {
+
+        it('should save changes to Redis', async () => {
+            await db.set('foo', 'bar', 3);
+            await db.dec('foo', 'bar', 2);
+            db = new DeepBase({ name: 'test' }); // create a new instance to reload the saved data
+            await db.connect();
+            assert.deepEqual(await db.get('foo', 'bar'), 1);
+        });
+
+        it('should set the value to -1 if it does not exist', async () => {
+            await db.dec('foo', 'bar', 2);
+            assert.deepEqual(await db.get('foo', 'bar'), -2);
+        });
+    });
+
+    describe('#keys()', () => {
+
+        it('should return keys', async () => {
+            await db.set('foo', 'bar', 1);
+            await db.set('foo', 'quux', 1);
+            assert.deepEqual(await db.keys('foo'), ['bar', 'quux']);
+        });
+    });
+
+    describe('#upd()', async () => {
+
+        it('should update field keys', async () => {
+            await db.set('foo', 'bar', 2);
+            await db.upd('foo', 'bar', n => n * 3);
+            assert.deepEqual(await db.get('foo', 'bar'), 6);
+        });
+
+    });
+});