refactor: migrate from @cacheable/node-cache to node-cache and update related types

Author: apetta

README.md

@@ -1,3 +1,3 @@
 # Node Cache Plus
 
-`node-cache-plus` is a simple wrapper around [`@cacheable/node-cache`](https://github.com/jaredwray/cacheable/tree/main/packages/node-cache) with additional features such tag based invalidation, factory functions, and other helpers for in-memory caching in Node.js applications.
+`node-cache-plus` is a wrapper around the popular library [`node-cache`](https://github.com/node-cache/node-cache/tree/master) with additional features such tag-based invalidation, factory functions, and other helpers for in-memory caching in Node.js applications.

package.json

@@ -2,7 +2,7 @@
 	"name": "node-cache-plus",
 	"version": "1.0.1",
 	"type": "module",
-	"description": "A wrapper around @cacheable/node-cache with additional features such tag based invalidation, factory functions, and more.",
+	"description": "A wrapper around the popular node-cache library, featuring tag-based invalidation, factory functions, and more.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"files": [
@@ -73,6 +73,6 @@
 		"vitest": "~2.1.8"
 	},
 	"dependencies": {
-		"@cacheable/node-cache": "1.5.1"
+		"node-cache": "^5.1.2"
 	}
 }

pnpm-lock.yaml

@@ -1,4 +1,3 @@
-import NodeCache from "@cacheable/node-cache";
 import { beforeEach, describe, expect, it } from "vitest";
 import { Cache } from "./Cache";
 
@@ -10,7 +9,7 @@ describe("Cache", () => {
 	});
 
 	it("should set, get, and take values correctly", () => {
-		cache.set("key0", "value0", 60, []);
+		cache.set("key0", "value0", 60);
 		cache.set("key1", "value1", 60, ["tag1"]);
 		cache.set("key2", "value2", 60, ["tag2"]);
 		cache.set("key3", "value3", 60, ["tag1", "tag2"]);
@@ -28,13 +27,22 @@ describe("Cache", () => {
 		expect(cache.get("key4")).toBe("value4");
 		expect(cache.get("key5")).toBe("value5");
 		expect(cache.get("key6")).toBe("value6");
+	});
+
+	it("should take values correctly", () => {
+		cache.set("key0", "value0", 60, ["test"]);
+
+		// verify tag is set
+		expect(cache.getTagMap().get("test")).toEqual(new Set(["key0"]));
 
 		// take value
 		expect(cache.take("key0")).toBe("value0");
 
-		// check if tags are removed
+		// check if key was removed
 		expect(cache.get("key0")).toBeUndefined();
-		expect(cache.get("key1")).toBe("value1");
+
+		// check if tag was removed
+		expect(cache.getTagMap().get("test")).toBeUndefined();
 	});
 
 	it("should delete a key", () => {
@@ -101,9 +109,9 @@ describe("Cache", () => {
 
 	it("should set multiple values using mset", () => {
 		const items = [
-			{ key: "key1", value: "value1", ttl: 60, tags: ["tag1"] },
-			{ key: "key2", value: "value2", ttl: 60, tags: ["tag2"] },
-			{ key: "key3", value: "value3", ttl: 60, tags: ["tag1", "tag2"] },
+			{ key: "key1", val: "value1", ttl: 60, tags: ["tag1"] },
+			{ key: "key2", val: "value2", ttl: 60, tags: ["tag2"] },
+			{ key: "key3", val: "value3", ttl: 60, tags: ["tag1", "tag2"] },
 		];
 		cache.mset(items);
 
@@ -118,12 +126,20 @@ describe("Cache", () => {
 		cache.set("key3", "value3", 60, ["tag1", "tag2"]);
 
 		const values = cache.mget(["key1", "key2", "key3"]);
-		expect(values).toEqual(["value1", "value2", "value3"]);
+		expect(values).toEqual({
+			key1: "value1",
+			key2: "value2",
+			key3: "value3",
+		});
 
 		// invalid tag & check if removed
 		cache.invalidateTagsIntersection(["tag1", "tag2"]);
 		const valuesAfterInvalidation = cache.mget(["key1", "key2", "key3"]);
-		expect(valuesAfterInvalidation).toEqual(["value1", "value2", undefined]);
+		expect(valuesAfterInvalidation).toEqual({
+			key1: "value1",
+			key2: "value2",
+			key3: undefined,
+		});
 	});
 
 	it("should delete multiple keys using mdel", () => {
@@ -197,27 +213,43 @@ describe("Cache", () => {
 		expect(stats.misses).toBe(0);
 	});
 
-	it("should return the cache instance for custom operations", () => {
-		const cacheInstance = cache.getCacheInstance();
-		expect(cacheInstance).toBeInstanceOf(NodeCache);
-
-		// test a hook
-		cacheInstance.on("set", (key, value) => {
-			expect(key).toBe("keyHook");
-			expect(value).toStrictEqual({
-				value: "valueHook",
-				tags: [],
-			});
-		});
-
-		cache.set("keyHook", "valueHook", 60);
-	});
-
 	it("should return the tag map", () => {
 		cache.set("key1", "value1", 60, ["tag1"]);
 		cache.set("key2", "value2", 60, ["tag2"]);
 		const tagMap = cache.getTagMap();
 		expect(tagMap.get("tag1")).toEqual(new Set(["key1"]));
 		expect(tagMap.get("tag2")).toEqual(new Set(["key2"]));
 	});
+
+	it("should handle number keys correctly", () => {
+		cache.set(1, "value1", 60);
+		cache.set(2, "value2", 60, ["tag1"]);
+		cache.set(3, "value3", 60, ["tag2"]);
+		cache.set(4, "value4", 60, ["tag1", "tag2"]);
+		cache.set(5, "value5", 60, ["tagA"]);
+		cache.set(6, "value6", 60, ["tagB"]);
+
+		expect(cache.get(1)).toBe("value1");
+		expect(cache.get(2)).toBe("value2");
+		expect(cache.get(3)).toBe("value3");
+		expect(cache.get(4)).toBe("value4");
+
+		cache.del(1);
+		expect(cache.get(1)).toBeUndefined();
+
+		cache.invalidateTag("tag1");
+		expect(cache.get(2)).toBeUndefined();
+		expect(cache.get(3)).toBe("value3");
+		expect(cache.get(4)).toBeUndefined();
+
+		cache.invalidateTagsIntersection(["tag1", "tag2"]);
+
+		expect(cache.get(3)).toBeUndefined();
+		expect(cache.get(5)).toBe("value5");
+		expect(cache.get(6)).toBe("value6");
+
+		cache.invalidateTagsUnion(["tagA", "tagB"]);
+		expect(cache.get(5)).toBeUndefined();
+		expect(cache.get(6)).toBeUndefined();
+	});
 });