@peerbit/cache 1.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2017-2018 Protocol Labs Inc.
+Copyright (c) 2018 Haja Networks Oy
+
+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/lib/esm/index.d.ts

@@ -0,0 +1,23 @@
+export type CacheData<T> = {
+    value?: T | null;
+    time: number;
+};
+export declare class Cache<T = undefined> {
+    private _map;
+    private deleted;
+    private list;
+    max: number;
+    ttl?: number;
+    constructor(options: {
+        max: number;
+        ttl?: number;
+    });
+    has(key: string): boolean;
+    get map(): Map<string, CacheData<T>>;
+    get(key: string): T | null | undefined;
+    trim(time?: number): void;
+    del(key: string): void;
+    add(key: string, value?: T): void;
+    clear(): void;
+    get size(): number;
+}

package/lib/esm/index.js

@@ -0,0 +1,73 @@
+// Fifo
+import yallist from "yallist";
+export class Cache {
+    _map;
+    deleted;
+    list;
+    max;
+    ttl;
+    constructor(options) {
+        if (options.max <= 0) {
+            throw new Error("Expecting max >= 0");
+        }
+        this.max = options.max;
+        this.ttl = options.ttl;
+        this.clear();
+    }
+    has(key) {
+        this.trim();
+        if (this.deleted.has(key)) {
+            return false;
+        }
+        return this._map.has(key);
+    }
+    get map() {
+        return this._map;
+    }
+    get(key) {
+        this.trim();
+        if (this.deleted.has(key)) {
+            return undefined;
+        }
+        return this._map.get(key)?.value;
+    }
+    trim(time = +new Date()) {
+        const peek = this.list.head;
+        let outOfDate = peek &&
+            this.ttl !== undefined &&
+            this._map.get(peek.value).time < time - this.ttl;
+        while (outOfDate || this.list.length > this.max) {
+            const key = this.list.shift();
+            if (key !== undefined) {
+                outOfDate =
+                    this.ttl !== undefined && this._map.get(key).time < time - this.ttl;
+                this._map.delete(key);
+                this.deleted.delete(key);
+            }
+            else {
+                break;
+            }
+        }
+    }
+    del(key) {
+        this.deleted.add(key);
+    }
+    add(key, value) {
+        const time = +new Date();
+        this.trim(time);
+        if (!this._map.has(key)) {
+            this.list.push(key);
+        }
+        this._map.set(key, { time, value: value ?? null });
+        this.deleted.delete(key);
+    }
+    clear() {
+        this.list = yallist.create();
+        this._map = new Map();
+        this.deleted = new Set();
+    }
+    get size() {
+        return this.list.length - this.deleted.size;
+    }
+}
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO;AACP,OAAO,OAAO,MAAM,SAAS,CAAC;AAG9B,MAAM,OAAO,KAAK;IACT,IAAI,CAA4B;IAChC,OAAO,CAAc;IACrB,IAAI,CAAkB;IAC9B,GAAG,CAAS;IACZ,GAAG,CAAU;IACb,YAAY,OAAsC;QACjD,IAAI,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;SACtC;QACD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,KAAK,EAAE,CAAC;IACd,CAAC;IACD,GAAG,CAAC,GAAW;QACd,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC1B,OAAO,KAAK,CAAC;SACb;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,GAAG;QACN,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IAED,GAAG,CAAC,GAAW;QACd,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC1B,OAAO,SAAS,CAAC;SACjB;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC;IAClC,CAAC;IAED,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE;QACtB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5B,IAAI,SAAS,GACZ,IAAI;YACJ,IAAI,CAAC,GAAG,KAAK,SAAS;YACtB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAE,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;QACnD,OAAO,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE;YAChD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,IAAI,GAAG,KAAK,SAAS,EAAE;gBACtB,SAAS;oBACR,IAAI,CAAC,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;gBACtE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACtB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aACzB;iBAAM;gBACN,MAAM;aACN;SACD;IACF,CAAC;IAED,GAAG,CAAC,GAAW;QACd,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,GAAG,CAAC,GAAW,EAAE,KAAS;QACzB,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACpB;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IACD,KAAK;QACJ,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;IAC1B,CAAC;IAED,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7C,CAAC;CACD"}

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+	"name": "@peerbit/cache",
+	"version": "1.0.0",
+	"description": "Simple cache",
+	"type": "module",
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"lib",
+		"src",
+		"!src/**/__tests__",
+		"!lib/**/__tests__",
+		"LICENSE"
+	],
+	"module": "lib/esm/index.js",
+	"types": "lib/esm/index.d.ts",
+	"exports": {
+		"import": "./lib/esm/index.js",
+		"require": "./lib/cjs/index.js"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/dao-xyz/peerbit"
+	},
+	"homepage": "https://github.com/dao-xyz/peerbit",
+	"bugs": "https://github.com/dao-xyz/peerbit/issues",
+	"scripts": {
+		"clean": "shx rm -rf lib/*",
+		"build": "yarn clean && tsc -p tsconfig.json",
+		"postbuild": "echo '{\"type\":\"module\"} ' | node ../../../node_modules/.bin/json > lib/esm/package.json",
+		"test": "node ../../../node_modules/.bin/jest test  -c  ../../../jest.config.ts --runInBand --forceExit",
+		"test:unit": "node ../../../node_modules/.bin/jest test  -c  ../../../jest.config.unit.ts --runInBand --forceExit",
+		"test:integration": "node ../node_modules/.bin/jest test -c  ../../../jest.config.integration.ts --runInBand --forceExit"
+	},
+	"license": "MIT",
+	"devDependencies": {
+		"@peerbit/time": "1.0.0",
+		"@types/yallist": "^4.0.1"
+	},
+	"dependencies": {
+		"yallist": "^4.0.0"
+	},
+	"localMaintainers": [
+		"dao.xyz"
+	],
+	"gitHead": "069ce2f62a76c342875a1cc695c6f210beff13fd"
+}

package/src/index.ts

@@ -0,0 +1,80 @@
+// Fifo
+import yallist from "yallist";
+
+export type CacheData<T> = { value?: T | null; time: number };
+export class Cache<T = undefined> {
+	private _map: Map<string, CacheData<T>>;
+	private deleted: Set<string>;
+	private list: yallist<string>;
+	max: number;
+	ttl?: number;
+	constructor(options: { max: number; ttl?: number }) {
+		if (options.max <= 0) {
+			throw new Error("Expecting max >= 0");
+		}
+		this.max = options.max;
+		this.ttl = options.ttl;
+		this.clear();
+	}
+	has(key: string) {
+		this.trim();
+		if (this.deleted.has(key)) {
+			return false;
+		}
+		return this._map.has(key);
+	}
+
+	get map(): Map<string, CacheData<T>> {
+		return this._map;
+	}
+
+	get(key: string): T | null | undefined {
+		this.trim();
+		if (this.deleted.has(key)) {
+			return undefined;
+		}
+		return this._map.get(key)?.value;
+	}
+
+	trim(time = +new Date()) {
+		const peek = this.list.head;
+		let outOfDate =
+			peek &&
+			this.ttl !== undefined &&
+			this._map.get(peek.value)!.time < time - this.ttl;
+		while (outOfDate || this.list.length > this.max) {
+			const key = this.list.shift();
+			if (key !== undefined) {
+				outOfDate =
+					this.ttl !== undefined && this._map.get(key)!.time < time - this.ttl;
+				this._map.delete(key);
+				this.deleted.delete(key);
+			} else {
+				break;
+			}
+		}
+	}
+
+	del(key: string) {
+		this.deleted.add(key);
+	}
+
+	add(key: string, value?: T) {
+		const time = +new Date();
+		this.trim(time);
+		if (!this._map.has(key)) {
+			this.list.push(key);
+		}
+		this._map.set(key, { time, value: value ?? null });
+		this.deleted.delete(key);
+	}
+	clear() {
+		this.list = yallist.create();
+		this._map = new Map();
+		this.deleted = new Set();
+	}
+
+	get size() {
+		return this.list.length - this.deleted.size;
+	}
+}