@pluv/addon-indexeddb 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/dist/index.d.mts

@@ -0,0 +1,7 @@
+import { ClientDefs, PluvRoom, PluvRoomAddon } from "@pluv/client";
+interface AddonIndexedDBConfig<TDefs extends ClientDefs = any> {
+  enabled?: boolean | ((room: PluvRoom<TDefs>) => boolean);
+}
+export declare const addonIndexedDB: <TDefs extends ClientDefs = any>(config?: AddonIndexedDBConfig<TDefs>) => PluvRoomAddon<any>;
+export {};
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/addonIndexedDB.ts"],"mappings":";UAGiB,qBAAqB,cAAc;EAChD,sBAAsB,MAAM,SAAS;;qBAG5B,iBAAkB,cAAc,kBAAgB,SAChD,qBAAqB,WAC/B"}

package/dist/index.mjs

@@ -0,0 +1,86 @@
+import { AbstractStorageStore } from "@pluv/client";
+import { openDB } from "idb";
+// src/IndexedDBStorage.ts
+const STORAGE_STORE_FLATTEN_THRESHOLD = 500;
+const UPGRADES_KEY = "__PLUV_UPDATES";
+var IndexedDBStorage = class extends AbstractStorageStore {
+	constructor(room) {
+		super(room);
+		this._db = null;
+		this._dbRef = 0;
+		this._dbSize = 0;
+		this.room = room;
+	}
+	async addUpdate(update) {
+		const db = this._db;
+		if (!db) return;
+		await db.add(UPGRADES_KEY, update);
+		this._dbSize += 1;
+	}
+	destroy() {
+		if (!this._db) return Promise.resolve();
+		this._db.close();
+		this._db = null;
+		this._dbRef = 0;
+		this._dbSize = 0;
+		return Promise.resolve();
+	}
+	async flatten(encodedState) {
+		const db = this._db;
+		if (!db) return;
+		await db.add(UPGRADES_KEY, encodedState);
+		await db.delete(UPGRADES_KEY, this._getUpperBound(this._dbRef, true));
+		this._dbSize = await this._getSize();
+	}
+	async getShouldFlatten() {
+		return await this._getSize() >= STORAGE_STORE_FLATTEN_THRESHOLD;
+	}
+	async getUpdates(start = 0) {
+		const db = this._db;
+		if (!db) return [];
+		const updates = await db.getAll(UPGRADES_KEY, this._getLowerBound(start));
+		const lastKey = await this._getLastKey();
+		this._dbRef = lastKey + 1;
+		return updates;
+	}
+	async initialize() {
+		const newDB = await openDB(this.room, void 0, { upgrade: (db) => {
+			db.createObjectStore(UPGRADES_KEY, { autoIncrement: true });
+		} });
+		newDB.addEventListener("versionchange", () => {
+			newDB.close();
+		});
+		if (typeof window !== "undefined") window.addEventListener("unload", () => {
+			newDB.close();
+		});
+		this._db = newDB;
+	}
+	async _getLastKey() {
+		const db = this._db;
+		if (!db) throw new Error("IndexedDB not initialized");
+		return (await db.transaction(UPGRADES_KEY).objectStore(UPGRADES_KEY).openCursor(null, "prev"))?.key ?? -1;
+	}
+	_getLowerBound(lower, open = false) {
+		return IDBKeyRange.lowerBound(lower, open);
+	}
+	async _getSize() {
+		if (this._dbSize) return this._dbSize;
+		const db = this._db;
+		if (!db) throw new Error("IndexedDB not initialized");
+		return db.transaction(UPGRADES_KEY).objectStore(UPGRADES_KEY).count();
+	}
+	_getUpperBound(upper, open = false) {
+		return IDBKeyRange.upperBound(upper, open);
+	}
+};
+// src/addonIndexedDB.ts
+const addonIndexedDB = (config) => {
+	const { enabled = true } = config ?? {};
+	return ({ room }) => {
+		if (!(typeof enabled === "boolean" ? enabled : enabled(room))) return {};
+		return { storage: new IndexedDBStorage(room.id) };
+	};
+};
+export { addonIndexedDB };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/IndexedDBStorage.ts","../src/addonIndexedDB.ts"],"sourcesContent":["import { AbstractStorageStore } from \"@pluv/client\";\nimport type { IDBPDatabase } from \"idb\";\nimport { openDB } from \"idb\";\n\nconst STORAGE_STORE_FLATTEN_THRESHOLD = 500;\nconst UPGRADES_KEY = \"__PLUV_UPDATES\";\n\ntype IndexDBSchema = {\n    [UPGRADES_KEY]: {\n        key: number;\n        value: string;\n    };\n};\n\ntype IndexedDB = IDBPDatabase<IndexDBSchema>;\n\nexport class IndexedDBStorage extends AbstractStorageStore {\n    public room: string;\n\n    private _db: IndexedDB | null = null;\n    private _dbRef: number = 0;\n    private _dbSize: number = 0;\n\n    constructor(room: string) {\n        super(room);\n\n        this.room = room;\n    }\n\n    public async addUpdate(update: string): Promise<void> {\n        const db = this._db;\n\n        if (!db) return;\n\n        await db.add(UPGRADES_KEY, update);\n\n        this._dbSize += 1;\n    }\n\n    public destroy(): Promise<void> {\n        if (!this._db) return Promise.resolve();\n\n        this._db.close();\n        this._db = null;\n        this._dbRef = 0;\n        this._dbSize = 0;\n\n        return Promise.resolve();\n    }\n\n    public async flatten(encodedState: string): Promise<void> {\n        const db = this._db;\n\n        if (!db) return;\n\n        await db.add(UPGRADES_KEY, encodedState);\n        await db.delete(UPGRADES_KEY, this._getUpperBound(this._dbRef, true));\n\n        this._dbSize = await this._getSize();\n    }\n\n    public async getShouldFlatten(): Promise<boolean> {\n        const dbSize = await this._getSize();\n\n        return dbSize >= STORAGE_STORE_FLATTEN_THRESHOLD;\n    }\n\n    public async getUpdates(start: number = 0): Promise<readonly string[]> {\n        const db = this._db;\n\n        if (!db) return [];\n\n        const updates = await db.getAll(UPGRADES_KEY, this._getLowerBound(start));\n\n        const lastKey = await this._getLastKey();\n\n        this._dbRef = lastKey + 1;\n\n        return updates;\n    }\n\n    public async initialize(): Promise<void> {\n        const newDB = await openDB<IndexDBSchema>(this.room, undefined, {\n            upgrade: (db) => {\n                db.createObjectStore(UPGRADES_KEY, { autoIncrement: true });\n            },\n        });\n\n        newDB.addEventListener(\"versionchange\", () => {\n            newDB.close();\n        });\n\n        if (typeof window !== \"undefined\") {\n            window.addEventListener(\"unload\", () => {\n                newDB.close();\n            });\n        }\n\n        this._db = newDB;\n    }\n\n    private async _getLastKey(): Promise<number> {\n        const db = this._db;\n\n        if (!db) throw new Error(\"IndexedDB not initialized\");\n\n        const store = db.transaction(UPGRADES_KEY).objectStore(UPGRADES_KEY);\n        const cursor = await store.openCursor(null, \"prev\");\n\n        return cursor?.key ?? -1;\n    }\n\n    private _getLowerBound(lower: number, open: boolean = false): IDBKeyRange {\n        return IDBKeyRange.lowerBound(lower, open);\n    }\n\n    private async _getSize(): Promise<number> {\n        if (this._dbSize) return this._dbSize;\n\n        const db = this._db;\n\n        if (!db) throw new Error(\"IndexedDB not initialized\");\n\n        const store = db.transaction(UPGRADES_KEY).objectStore(UPGRADES_KEY);\n\n        return store.count();\n    }\n\n    private _getUpperBound(upper: number, open: boolean = false): IDBKeyRange {\n        return IDBKeyRange.upperBound(upper, open);\n    }\n}\n","import type { ClientDefs, PluvRoom, PluvRoomAddon } from \"@pluv/client\";\nimport { IndexedDBStorage } from \"./IndexedDBStorage\";\n\nexport interface AddonIndexedDBConfig<TDefs extends ClientDefs = any> {\n    enabled?: boolean | ((room: PluvRoom<TDefs>) => boolean);\n}\n\nexport const addonIndexedDB = <TDefs extends ClientDefs = any>(\n    config?: AddonIndexedDBConfig<TDefs>,\n): PluvRoomAddon<any> => {\n    const { enabled = true } = config ?? {};\n\n    return ({ room }) => {\n        const _enabled = typeof enabled === \"boolean\" ? enabled : enabled(room);\n\n        if (!_enabled) return {};\n\n        return {\n            storage: new IndexedDBStorage(room.id),\n        };\n    };\n};\n"],"mappings":";;;AAIA,MAAM,kCAAkC;AACxC,MAAM,eAAe;AAWrB,IAAa,mBAAb,cAAsC,qBAAqB;CAOvD,YAAY,MAAc;EACtB,MAAM,IAAI;EALkB,KAAA,MAAA;EACP,KAAA,SAAA;EACC,KAAA,UAAA;EAKtB,KAAK,OAAO;CAChB;CAEA,MAAa,UAAU,QAA+B;EAClD,MAAM,KAAK,KAAK;EAEhB,IAAI,CAAC,IAAI;EAET,MAAM,GAAG,IAAI,cAAc,MAAM;EAEjC,KAAK,WAAW;CACpB;CAEA,UAAgC;EAC5B,IAAI,CAAC,KAAK,KAAK,OAAO,QAAQ,QAAQ;EAEtC,KAAK,IAAI,MAAM;EACf,KAAK,MAAM;EACX,KAAK,SAAS;EACd,KAAK,UAAU;EAEf,OAAO,QAAQ,QAAQ;CAC3B;CAEA,MAAa,QAAQ,cAAqC;EACtD,MAAM,KAAK,KAAK;EAEhB,IAAI,CAAC,IAAI;EAET,MAAM,GAAG,IAAI,cAAc,YAAY;EACvC,MAAM,GAAG,OAAO,cAAc,KAAK,eAAe,KAAK,QAAQ,IAAI,CAAC;EAEpE,KAAK,UAAU,MAAM,KAAK,SAAS;CACvC;CAEA,MAAa,mBAAqC;EAG9C,OAAO,MAFc,KAAK,SAAS,KAElB;CACrB;CAEA,MAAa,WAAW,QAAgB,GAA+B;EACnE,MAAM,KAAK,KAAK;EAEhB,IAAI,CAAC,IAAI,OAAO,CAAC;EAEjB,MAAM,UAAU,MAAM,GAAG,OAAO,cAAc,KAAK,eAAe,KAAK,CAAC;EAExE,MAAM,UAAU,MAAM,KAAK,YAAY;EAEvC,KAAK,SAAS,UAAU;EAExB,OAAO;CACX;CAEA,MAAa,aAA4B;EACrC,MAAM,QAAQ,MAAM,OAAsB,KAAK,MAAM,KAAA,GAAW,EAC5D,UAAU,OAAO;GACb,GAAG,kBAAkB,cAAc,EAAE,eAAe,KAAK,CAAC;EAC9D,EACJ,CAAC;EAED,MAAM,iBAAiB,uBAAuB;GAC1C,MAAM,MAAM;EAChB,CAAC;EAED,IAAI,OAAO,WAAW,aAClB,OAAO,iBAAiB,gBAAgB;GACpC,MAAM,MAAM;EAChB,CAAC;EAGL,KAAK,MAAM;CACf;CAEA,MAAc,cAA+B;EACzC,MAAM,KAAK,KAAK;EAEhB,IAAI,CAAC,IAAI,MAAM,IAAI,MAAM,2BAA2B;EAKpD,QAAO,MAHO,GAAG,YAAY,YAAY,CAAC,CAAC,YAAY,YAC9B,CAAC,CAAC,WAAW,MAAM,MAAM,EAAA,EAEnC,OAAO;CAC1B;CAEA,eAAuB,OAAe,OAAgB,OAAoB;EACtE,OAAO,YAAY,WAAW,OAAO,IAAI;CAC7C;CAEA,MAAc,WAA4B;EACtC,IAAI,KAAK,SAAS,OAAO,KAAK;EAE9B,MAAM,KAAK,KAAK;EAEhB,IAAI,CAAC,IAAI,MAAM,IAAI,MAAM,2BAA2B;EAIpD,OAFc,GAAG,YAAY,YAAY,CAAC,CAAC,YAAY,YAE5C,CAAC,CAAC,MAAM;CACvB;CAEA,eAAuB,OAAe,OAAgB,OAAoB;EACtE,OAAO,YAAY,WAAW,OAAO,IAAI;CAC7C;AACJ;;AC5HA,MAAa,kBACT,WACqB;CACrB,MAAM,EAAE,UAAU,SAAS,UAAU,CAAC;CAEtC,QAAQ,EAAE,WAAW;EAGjB,IAAI,EAFa,OAAO,YAAY,YAAY,UAAU,QAAQ,IAAI,IAEvD,OAAO,CAAC;EAEvB,OAAO,EACH,SAAS,IAAI,iBAAiB,KAAK,EAAE,EACzC;CACJ;AACJ"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@pluv/addon-indexeddb",
+  "version": "0.0.0-canary-20261027022227",
+  "description": "@pluv/io indexeddb for client storage persistence",
+  "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/addon-indexeddb"
+  },
+  "type": "module",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@pluv/client": "^0.0.0-canary-20261027022227",
+    "@pluv/crdt": "^0.0.0-canary-20261027022227",
+    "idb": "^8.0.4"
+  },
+  "devDependencies": {
+    "@pluv/tsconfig": "^0.0.0-canary-20261027022227",
+    "@pluv/types": "^0.0.0-canary-20261027022227",
+    "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"
+  }
+}