@pluv/persistence-redis 0.0.0-canary-20261027022227

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Shoubhit Dash
+
+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,18 @@
+## `@pluv/persistence-redis`
+
+> Crdt storage persistence for [@pluv/io](https://www.npmjs.com/package/@pluv/io) rooms on distributed systems. Available for [Node.js](https://nodejs.org/) only.
+
+**👉 See full documentation on [docs.pluv.io](https://docs.pluv.io/docs). 👈**
+
+## Installation
+
+```bash
+# npm
+npm install @pluv/persistence-redis ioredis
+
+# yarn
+yarn add @pluv/persistence-redis ioredis
+
+# pnpm
+pnpm add @pluv/persistence-redis ioredis
+```

package/dist/index.d.mts

@@ -0,0 +1,28 @@
+import { AbstractPersistence } from "@pluv/io";
+import { JsonObject } from "@pluv/types";
+import { Cluster, Redis } from "ioredis";
+type RedisClient = Cluster | Redis;
+interface PersistenceRedisOptions {
+  client: RedisClient;
+}
+export declare class PersistenceRedis extends AbstractPersistence {
+  private _client;
+  private _initialized;
+  constructor(options: PersistenceRedisOptions);
+  addUser(room: string, connectionId: string, user: JsonObject | null): Promise<void>;
+  deleteStorageState(room: string): Promise<void>;
+  deleteUser(room: string, connectionId: string): Promise<void>;
+  deleteUsers(room: string): Promise<void>;
+  getStorageState(room: string): Promise<string | null>;
+  setStorageState(room: string, state: string): Promise<void>;
+  getUser(room: string, connectionId: string): Promise<JsonObject | null>;
+  getUsers(room: string): Promise<Map<[connectionId: string][0], JsonObject | null>>;
+  getUsersSize(room: string): Promise<number>;
+  initialize(roomContext: {}): typeof this;
+  private _getClusterKey;
+  private _getRoomStorageKey;
+  private _getRoomUsersKey;
+  private _getRoomUsersUserKey;
+}
+export type { RedisClient };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/PersistenceRedis.ts"],"mappings":";;;KAUY,cAAc,UAAU;UAEnB;EACb,QAAQ;;qBAGC,yBAAyB;UAC1B;UACA;EAER,YAAY,SAAS;EASR,QACT,cACA,sBACA,MAAM,oBACP;EAYU,mBAAmB,eAAe;EAQlC,WAAW,cAAc,uBAAuB;EAmBhD,YAAY,eAAe;EAiB3B,gBAAgB,eAAe;EAQ/B,gBAAgB,cAAc,gBAAgB;EAQ9C,QAAQ,cAAc,uBAAuB,QAAQ;EAUrD,SACT,eACD,QAAQ,KAAK,0BAA0B;EAqB7B,aAAa,eAAe;EAQlC,WAAW;UAUV;UAIA;UAIA;UAIA"}

package/dist/index.mjs

@@ -0,0 +1,102 @@
+import { AbstractPersistence } from "@pluv/io";
+// src/utils/partitionByLength.ts
+const partitionByLength = (arr, length) => {
+	if (!arr.length) return [];
+	const head = arr.slice(0, length);
+	const tail = arr.slice(length);
+	return [head, ...partitionByLength(tail, length)];
+};
+// src/PersistenceRedis.ts
+const DELIMITER = ":::";
+const HASH_TAG = "{PluvPersistenceRedis}";
+const GET_USERS_CONCURRENCY = 4;
+var PersistenceRedis = class PersistenceRedis extends AbstractPersistence {
+	_client;
+	_initialized = null;
+	constructor(options) {
+		super();
+		const { client } = options;
+		this._client = client;
+		this._initialized = options._initialized;
+	}
+	async addUser(room, connectionId, user) {
+		if (!this._initialized) return;
+		await this._initialized;
+		await this._client.multi().sadd(this._getRoomUsersKey(room), connectionId).set(this._getRoomUsersUserKey(room, connectionId), JSON.stringify(user)).exec();
+	}
+	async deleteStorageState(room) {
+		if (!this._initialized) return;
+		await this._initialized;
+		await this._client.del(this._getRoomStorageKey(room));
+	}
+	async deleteUser(room, connectionId) {
+		if (!this._initialized) return;
+		await this._initialized;
+		const size = await this.getUsersSize(room);
+		let multi = this._client.multi().srem(this._getRoomUsersKey(room), connectionId).del(this._getRoomUsersUserKey(room, connectionId));
+		if (size === 1) multi = multi.del(this._getRoomStorageKey(room)).del(this._getRoomUsersKey(room));
+		await multi.exec();
+	}
+	async deleteUsers(room) {
+		if (!this._initialized) return;
+		await this._initialized;
+		await (await this._client.smembers(this._getRoomUsersKey(room))).reduce((commands, connectionId) => {
+			return commands.del(this._getRoomUsersUserKey(room, connectionId));
+		}, this._client.multi().del(this._getRoomUsersKey(room))).exec();
+	}
+	async getStorageState(room) {
+		if (!this._initialized) return null;
+		await this._initialized;
+		return await this._client.get(this._getRoomStorageKey(room));
+	}
+	async setStorageState(room, state) {
+		if (!this._initialized) return;
+		await this._initialized;
+		await this._client.set(this._getRoomStorageKey(room), state);
+	}
+	async getUser(room, connectionId) {
+		if (!this._initialized) return null;
+		await this._initialized;
+		const data = await this._client.get(this._getRoomUsersUserKey(room, connectionId));
+		return !data ? null : JSON.parse(data);
+	}
+	async getUsers(room) {
+		if (!this._initialized) return /* @__PURE__ */ new Map();
+		await this._initialized;
+		const members = await this._client.smembers(this._getRoomUsersKey(room));
+		return await partitionByLength(members, GET_USERS_CONCURRENCY).reduce(async (promise, partition) => {
+			const map = await promise;
+			const promises = partition.map(async (connectionId) => {
+				map.set(connectionId, await this.getUser(room, connectionId));
+			});
+			await Promise.all(promises);
+			return map;
+		}, Promise.resolve(/* @__PURE__ */ new Map()));
+	}
+	async getUsersSize(room) {
+		if (!this._initialized) return 0;
+		await this._initialized;
+		return await this._client.scard(this._getRoomUsersKey(room));
+	}
+	initialize(roomContext) {
+		return new PersistenceRedis({
+			client: this._client,
+			_initialized: Promise.resolve(true)
+		});
+	}
+	_getClusterKey(key) {
+		return `${HASH_TAG}${key}`;
+	}
+	_getRoomStorageKey(room) {
+		return this._getClusterKey(`room_storage${DELIMITER}${room}`);
+	}
+	_getRoomUsersKey(room) {
+		return this._getClusterKey(`room_users${DELIMITER}${room}`);
+	}
+	_getRoomUsersUserKey(room, connectionId) {
+		return this._getClusterKey(`${this._getRoomUsersKey(room)}${DELIMITER}${connectionId}`);
+	}
+};
+export { PersistenceRedis };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/utils/partitionByLength.ts","../src/PersistenceRedis.ts"],"sourcesContent":["export const partitionByLength = <T>(\n    arr: readonly T[] | T[],\n    length: number,\n): readonly (readonly T[])[] => {\n    if (!arr.length) return [];\n\n    const head = arr.slice(0, length);\n    const tail = arr.slice(length);\n\n    return [head, ...partitionByLength(tail, length)];\n};\n","import { AbstractPersistence } from \"@pluv/io\";\nimport type { JsonObject } from \"@pluv/types\";\nimport type { Cluster, Redis } from \"ioredis\";\nimport { partitionByLength } from \"./utils\";\n\nconst DELIMITER = \":::\";\nconst HASH_TAG = \"{PluvPersistenceRedis}\";\n\nconst GET_USERS_CONCURRENCY = 4;\n\nexport type RedisClient = Cluster | Redis;\n\nexport interface PersistenceRedisOptions {\n    client: RedisClient;\n}\n\nexport class PersistenceRedis extends AbstractPersistence {\n    private _client: RedisClient;\n    private _initialized: Promise<true> | null = null;\n\n    constructor(options: PersistenceRedisOptions) {\n        super();\n\n        const { client } = options;\n\n        this._client = client;\n        this._initialized = (options as any)._initialized;\n    }\n\n    public async addUser(\n        room: string,\n        connectionId: string,\n        user: JsonObject | null,\n    ): Promise<void> {\n        if (!this._initialized) return;\n\n        await this._initialized;\n\n        await this._client\n            .multi()\n            .sadd(this._getRoomUsersKey(room), connectionId)\n            .set(this._getRoomUsersUserKey(room, connectionId), JSON.stringify(user))\n            .exec();\n    }\n\n    public async deleteStorageState(room: string): Promise<void> {\n        if (!this._initialized) return;\n\n        await this._initialized;\n\n        await this._client.del(this._getRoomStorageKey(room));\n    }\n\n    public async deleteUser(room: string, connectionId: string): Promise<void> {\n        if (!this._initialized) return;\n\n        await this._initialized;\n\n        const size = await this.getUsersSize(room);\n\n        let multi = this._client\n            .multi()\n            .srem(this._getRoomUsersKey(room), connectionId)\n            .del(this._getRoomUsersUserKey(room, connectionId));\n\n        if (size === 1) {\n            multi = multi.del(this._getRoomStorageKey(room)).del(this._getRoomUsersKey(room));\n        }\n\n        await multi.exec();\n    }\n\n    public async deleteUsers(room: string): Promise<void> {\n        if (!this._initialized) return;\n\n        await this._initialized;\n\n        const members = await this._client.smembers(this._getRoomUsersKey(room));\n\n        await members\n            .reduce(\n                (commands, connectionId) => {\n                    return commands.del(this._getRoomUsersUserKey(room, connectionId));\n                },\n                this._client.multi().del(this._getRoomUsersKey(room)),\n            )\n            .exec();\n    }\n\n    public async getStorageState(room: string): Promise<string | null> {\n        if (!this._initialized) return null;\n\n        await this._initialized;\n\n        return await this._client.get(this._getRoomStorageKey(room));\n    }\n\n    public async setStorageState(room: string, state: string): Promise<void> {\n        if (!this._initialized) return;\n\n        await this._initialized;\n\n        await this._client.set(this._getRoomStorageKey(room), state);\n    }\n\n    public async getUser(room: string, connectionId: string): Promise<JsonObject | null> {\n        if (!this._initialized) return null;\n\n        await this._initialized;\n\n        const data = await this._client.get(this._getRoomUsersUserKey(room, connectionId));\n\n        return !data ? null : JSON.parse(data);\n    }\n\n    public async getUsers(\n        room: string,\n    ): Promise<Map<[connectionId: string][0], JsonObject | null>> {\n        if (!this._initialized) return new Map();\n\n        await this._initialized;\n\n        const members = await this._client.smembers(this._getRoomUsersKey(room));\n        const partitions = partitionByLength(members, GET_USERS_CONCURRENCY);\n\n        return await partitions.reduce(async (promise, partition) => {\n            const map = await promise;\n\n            const promises = partition.map(async (connectionId) => {\n                map.set(connectionId, await this.getUser(room, connectionId));\n            });\n\n            await Promise.all(promises);\n\n            return map;\n        }, Promise.resolve(new Map<string, JsonObject | null>()));\n    }\n\n    public async getUsersSize(room: string): Promise<number> {\n        if (!this._initialized) return 0;\n\n        await this._initialized;\n\n        return await this._client.scard(this._getRoomUsersKey(room));\n    }\n\n    public initialize(roomContext: {}): typeof this {\n        return new PersistenceRedis({\n            client: this._client,\n            // Spreading avoids an excess property check, so `_initialized` can be handed to the\n            // constructor without exposing it on PersistenceRedisOptions.\n            // oxlint-disable-next-line unicorn/no-useless-spread\n            ...{ _initialized: Promise.resolve(true as const) },\n        }) as typeof this;\n    }\n\n    private _getClusterKey(key: string): string {\n        return `${HASH_TAG}${key}`;\n    }\n\n    private _getRoomStorageKey(room: string): string {\n        return this._getClusterKey(`room_storage${DELIMITER}${room}`);\n    }\n\n    private _getRoomUsersKey(room: string): string {\n        return this._getClusterKey(`room_users${DELIMITER}${room}`);\n    }\n\n    private _getRoomUsersUserKey(room: string, connectionId: string): string {\n        return this._getClusterKey(`${this._getRoomUsersKey(room)}${DELIMITER}${connectionId}`);\n    }\n}\n"],"mappings":";;AAAA,MAAa,qBACT,KACA,WAC4B;CAC5B,IAAI,CAAC,IAAI,QAAQ,OAAO,CAAC;CAEzB,MAAM,OAAO,IAAI,MAAM,GAAG,MAAM;CAChC,MAAM,OAAO,IAAI,MAAM,MAAM;CAE7B,OAAO,CAAC,MAAM,GAAG,kBAAkB,MAAM,MAAM,CAAC;AACpD;;ACLA,MAAM,YAAY;AAClB,MAAM,WAAW;AAEjB,MAAM,wBAAwB;AAQ9B,IAAa,mBAAb,MAAa,yBAAyB,oBAAoB;CACtD;CACA,eAA6C;CAE7C,YAAY,SAAkC;EAC1C,MAAM;EAEN,MAAM,EAAE,WAAW;EAEnB,KAAK,UAAU;EACf,KAAK,eAAgB,QAAgB;CACzC;CAEA,MAAa,QACT,MACA,cACA,MACa;EACb,IAAI,CAAC,KAAK,cAAc;EAExB,MAAM,KAAK;EAEX,MAAM,KAAK,QACN,MAAM,CAAC,CACP,KAAK,KAAK,iBAAiB,IAAI,GAAG,YAAY,CAAC,CAC/C,IAAI,KAAK,qBAAqB,MAAM,YAAY,GAAG,KAAK,UAAU,IAAI,CAAC,CAAC,CACxE,KAAK;CACd;CAEA,MAAa,mBAAmB,MAA6B;EACzD,IAAI,CAAC,KAAK,cAAc;EAExB,MAAM,KAAK;EAEX,MAAM,KAAK,QAAQ,IAAI,KAAK,mBAAmB,IAAI,CAAC;CACxD;CAEA,MAAa,WAAW,MAAc,cAAqC;EACvE,IAAI,CAAC,KAAK,cAAc;EAExB,MAAM,KAAK;EAEX,MAAM,OAAO,MAAM,KAAK,aAAa,IAAI;EAEzC,IAAI,QAAQ,KAAK,QACZ,MAAM,CAAC,CACP,KAAK,KAAK,iBAAiB,IAAI,GAAG,YAAY,CAAC,CAC/C,IAAI,KAAK,qBAAqB,MAAM,YAAY,CAAC;EAEtD,IAAI,SAAS,GACT,QAAQ,MAAM,IAAI,KAAK,mBAAmB,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,iBAAiB,IAAI,CAAC;EAGpF,MAAM,MAAM,KAAK;CACrB;CAEA,MAAa,YAAY,MAA6B;EAClD,IAAI,CAAC,KAAK,cAAc;EAExB,MAAM,KAAK;EAIX,OAAM,MAFgB,KAAK,QAAQ,SAAS,KAAK,iBAAiB,IAAI,CAAC,EAAA,CAGlE,QACI,UAAU,iBAAiB;GACxB,OAAO,SAAS,IAAI,KAAK,qBAAqB,MAAM,YAAY,CAAC;EACrE,GACA,KAAK,QAAQ,MAAM,CAAC,CAAC,IAAI,KAAK,iBAAiB,IAAI,CAAC,CACxD,CAAC,CACA,KAAK;CACd;CAEA,MAAa,gBAAgB,MAAsC;EAC/D,IAAI,CAAC,KAAK,cAAc,OAAO;EAE/B,MAAM,KAAK;EAEX,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,mBAAmB,IAAI,CAAC;CAC/D;CAEA,MAAa,gBAAgB,MAAc,OAA8B;EACrE,IAAI,CAAC,KAAK,cAAc;EAExB,MAAM,KAAK;EAEX,MAAM,KAAK,QAAQ,IAAI,KAAK,mBAAmB,IAAI,GAAG,KAAK;CAC/D;CAEA,MAAa,QAAQ,MAAc,cAAkD;EACjF,IAAI,CAAC,KAAK,cAAc,OAAO;EAE/B,MAAM,KAAK;EAEX,MAAM,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,qBAAqB,MAAM,YAAY,CAAC;EAEjF,OAAO,CAAC,OAAO,OAAO,KAAK,MAAM,IAAI;CACzC;CAEA,MAAa,SACT,MAC0D;EAC1D,IAAI,CAAC,KAAK,cAAc,uBAAO,IAAI,IAAI;EAEvC,MAAM,KAAK;EAEX,MAAM,UAAU,MAAM,KAAK,QAAQ,SAAS,KAAK,iBAAiB,IAAI,CAAC;EAGvE,OAAO,MAFY,kBAAkB,SAAS,qBAExB,CAAC,CAAC,OAAO,OAAO,SAAS,cAAc;GACzD,MAAM,MAAM,MAAM;GAElB,MAAM,WAAW,UAAU,IAAI,OAAO,iBAAiB;IACnD,IAAI,IAAI,cAAc,MAAM,KAAK,QAAQ,MAAM,YAAY,CAAC;GAChE,CAAC;GAED,MAAM,QAAQ,IAAI,QAAQ;GAE1B,OAAO;EACX,GAAG,QAAQ,wBAAQ,IAAI,IAA+B,CAAC,CAAC;CAC5D;CAEA,MAAa,aAAa,MAA+B;EACrD,IAAI,CAAC,KAAK,cAAc,OAAO;EAE/B,MAAM,KAAK;EAEX,OAAO,MAAM,KAAK,QAAQ,MAAM,KAAK,iBAAiB,IAAI,CAAC;CAC/D;CAEA,WAAkB,aAA8B;EAC5C,OAAO,IAAI,iBAAiB;GACxB,QAAQ,KAAK;GAIR,cAAc,QAAQ,QAAQ,IAAa;EACpD,CAAC;CACL;CAEA,eAAuB,KAAqB;EACxC,OAAO,GAAG,WAAW;CACzB;CAEA,mBAA2B,MAAsB;EAC7C,OAAO,KAAK,eAAe,eAAe,YAAY,MAAM;CAChE;CAEA,iBAAyB,MAAsB;EAC3C,OAAO,KAAK,eAAe,aAAa,YAAY,MAAM;CAC9D;CAEA,qBAA6B,MAAc,cAA8B;EACrE,OAAO,KAAK,eAAe,GAAG,KAAK,iBAAiB,IAAI,IAAI,YAAY,cAAc;CAC1F;AACJ"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@pluv/persistence-redis",
+  "version": "0.0.0-canary-20261027022227",
+  "description": "@pluv/io crdt storage persistence for node.js",
+  "author": {
+    "email": "david@pluv.io",
+    "name": "i3dly",
+    "url": "https://github.com/i3dly"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/pluv-io/pluv",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pluv-io/pluv.git",
+    "directory": "packages/persistence-redis"
+  },
+  "type": "module",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@pluv/io": "^0.0.0-canary-20261027022227",
+    "@pluv/types": "^0.0.0-canary-20261027022227",
+    "@types/node": "^26.6.5"
+  },
+  "peerDependencies": {
+    "ioredis": "^5.0.0 || ^6.0.0"
+  },
+  "devDependencies": {
+    "@pluv/tsconfig": "^0.0.0-canary-20261027022227",
+    "ioredis": "^6.0.0",
+    "tsdown": "^0.23.2",
+    "typescript": "7.1.0-beta"
+  },
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./*": "./*"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
+  }
+}