@melledijkstra/storage 1.0.0

package/dist/index.cjs

@@ -0,0 +1,103 @@
+let _melledijkstra_toolbox = require("@melledijkstra/toolbox");
+
+//#region src/memory.ts
+const logger = new _melledijkstra_toolbox.Logger("cache");
+const cache = {};
+const SEC_30 = 30 * 1e3;
+const MIN_1 = 60 * 1e3;
+const MIN_3 = 180 * 1e3;
+const MIN_5 = 300 * 1e3;
+const MIN_10 = 600 * 1e3;
+const MIN_15 = 900 * 1e3;
+function get(key) {
+	const cachedItem = cache[key];
+	if (cachedItem) if (Date.now() - cachedItem.timestamp > cachedItem.ttl) delete cache[key];
+	else {
+		logger.log("Cache hit:", key);
+		return cachedItem.data;
+	}
+}
+function set(key, value, ttl = Infinity) {
+	cache[key] = {
+		data: value,
+		timestamp: Date.now(),
+		ttl: ttl ?? MIN_5
+	};
+}
+/**
+* Curried `withCache`: first call it with your options,
+* then call the returned function with your async function.
+*/
+function withCache(originalFunc, options = {}) {
+	const defaultTTL = 300 * 1e3;
+	const cachedFunction = async (...args) => {
+		const cacheKey = options?.key ?? originalFunc.name;
+		const cacheTTL = options?.ttl ?? defaultTTL;
+		const cachedData = get(cacheKey);
+		if (cachedData !== void 0) return cachedData;
+		const result = await originalFunc(...args);
+		set(cacheKey, result, cacheTTL);
+		return result;
+	};
+	return cachedFunction;
+}
+var MemoryCache = class {
+	logger = new _melledijkstra_toolbox.Logger("MemoryCache");
+	_cache = {};
+	get(key) {
+		const cachedItem = this._cache[key];
+		if (!cachedItem) return;
+		if (Date.now() - cachedItem.timestamp > cachedItem.ttl) delete this._cache[key];
+		else return cachedItem.data;
+	}
+	async set(key, value, ttl = Infinity) {
+		this._cache[key] = {
+			data: value,
+			timestamp: Date.now(),
+			ttl
+		};
+	}
+	async delete(key) {
+		delete this._cache[key];
+	}
+	async clear() {
+		this._cache = {};
+	}
+	isExpired(key) {
+		const cachedItem = this._cache[key];
+		if (!cachedItem) return true;
+		if (Date.now() - cachedItem.timestamp > cachedItem.ttl) {
+			delete this._cache[key];
+			return true;
+		}
+		return false;
+	}
+	has(key) {
+		const cachedItem = this._cache[key];
+		if (!cachedItem) return false;
+		if (this.isExpired(key)) return false;
+		if (Date.now() - cachedItem.timestamp > cachedItem.ttl) {
+			delete this._cache[key];
+			return false;
+		}
+		return true;
+	}
+	keys() {
+		return Object.keys(this._cache);
+	}
+	size() {
+		return Object.keys(this._cache).length;
+	}
+};
+
+//#endregion
+exports.MIN_1 = MIN_1;
+exports.MIN_10 = MIN_10;
+exports.MIN_15 = MIN_15;
+exports.MIN_3 = MIN_3;
+exports.MIN_5 = MIN_5;
+exports.MemoryCache = MemoryCache;
+exports.SEC_30 = SEC_30;
+exports.get = get;
+exports.set = set;
+exports.withCache = withCache;

package/dist/index.d.cts

@@ -0,0 +1,83 @@
+import { Logger } from "@melledijkstra/toolbox";
+
+//#region src/storage.interface.d.ts
+
+/**
+ * Abstract interface for various storage solutions
+ * Supports: localStorage, sessionStorage, cookies, IndexedDB, memory, etc.
+ */
+interface IStorage {
+  /**
+   * Retrieve a value from storage
+   * @template T - Type of the stored value
+   * @param key - Storage key
+   * @returns The stored value or undefined if not found
+   */
+  get<T>(key: string): Promise<T | undefined>;
+  /**
+   * Store a value in storage
+   * @template T - Type of the value to store
+   * @param key - Storage key
+   * @param value - Value to store
+   * @param ttl - Time to live in milliseconds (optional)
+   */
+  set<T>(key: string, value: T, ttl?: number): Promise<void>;
+  /**
+   * Delete a specific item from storage
+   * @param key - Storage key to delete
+   */
+  delete(key: string): Promise<void>;
+  /**
+   * Clear all items from storage
+   */
+  clear(): Promise<void>;
+  /**
+   * Check if a key exists in storage
+   * @param key - Storage key
+   * @returns True if key exists, false otherwise
+   */
+  has(key: string): boolean;
+  /**
+   * Get all keys stored in storage
+   * @returns Array of all keys
+   */
+  keys(): string[];
+  /**
+   * Get the number of items in storage
+   * @returns Number of stored items
+   */
+  size(): number;
+}
+//#endregion
+//#region src/memory.d.ts
+declare const SEC_30: number;
+declare const MIN_1: number;
+declare const MIN_3: number;
+declare const MIN_5: number;
+declare const MIN_10: number;
+declare const MIN_15: number;
+declare function get(key: string): unknown;
+declare function set(key: string, value: unknown, ttl?: number): void;
+type CacheOptions = {
+  key?: string;
+  ttl?: number;
+};
+/**
+ * Curried `withCache`: first call it with your options,
+ * then call the returned function with your async function.
+ */
+declare function withCache<T, A extends unknown[]>(originalFunc: (...args: A) => Promise<T>, options?: CacheOptions): (...args: A) => Promise<T>;
+declare class MemoryCache implements IStorage {
+  logger: Logger;
+  private _cache;
+  get<T>(key: string): T | undefined;
+  set(key: string, value: unknown, ttl?: number): Promise<void>;
+  delete(key: string): Promise<void>;
+  clear(): Promise<void>;
+  isExpired(key: string): boolean;
+  has(key: string): boolean;
+  keys(): string[];
+  size(): number;
+}
+//#endregion
+export { IStorage, MIN_1, MIN_10, MIN_15, MIN_3, MIN_5, MemoryCache, SEC_30, get, set, withCache };

package/dist/index.d.mts

@@ -0,0 +1,83 @@
+import { Logger } from "@melledijkstra/toolbox";
+
+//#region src/storage.interface.d.ts
+
+/**
+ * Abstract interface for various storage solutions
+ * Supports: localStorage, sessionStorage, cookies, IndexedDB, memory, etc.
+ */
+interface IStorage {
+  /**
+   * Retrieve a value from storage
+   * @template T - Type of the stored value
+   * @param key - Storage key
+   * @returns The stored value or undefined if not found
+   */
+  get<T>(key: string): Promise<T | undefined>;
+  /**
+   * Store a value in storage
+   * @template T - Type of the value to store
+   * @param key - Storage key
+   * @param value - Value to store
+   * @param ttl - Time to live in milliseconds (optional)
+   */
+  set<T>(key: string, value: T, ttl?: number): Promise<void>;
+  /**
+   * Delete a specific item from storage
+   * @param key - Storage key to delete
+   */
+  delete(key: string): Promise<void>;
+  /**
+   * Clear all items from storage
+   */
+  clear(): Promise<void>;
+  /**
+   * Check if a key exists in storage
+   * @param key - Storage key
+   * @returns True if key exists, false otherwise
+   */
+  has(key: string): boolean;
+  /**
+   * Get all keys stored in storage
+   * @returns Array of all keys
+   */
+  keys(): string[];
+  /**
+   * Get the number of items in storage
+   * @returns Number of stored items
+   */
+  size(): number;
+}
+//#endregion
+//#region src/memory.d.ts
+declare const SEC_30: number;
+declare const MIN_1: number;
+declare const MIN_3: number;
+declare const MIN_5: number;
+declare const MIN_10: number;
+declare const MIN_15: number;
+declare function get(key: string): unknown;
+declare function set(key: string, value: unknown, ttl?: number): void;
+type CacheOptions = {
+  key?: string;
+  ttl?: number;
+};
+/**
+ * Curried `withCache`: first call it with your options,
+ * then call the returned function with your async function.
+ */
+declare function withCache<T, A extends unknown[]>(originalFunc: (...args: A) => Promise<T>, options?: CacheOptions): (...args: A) => Promise<T>;
+declare class MemoryCache implements IStorage {
+  logger: Logger;
+  private _cache;
+  get<T>(key: string): T | undefined;
+  set(key: string, value: unknown, ttl?: number): Promise<void>;
+  delete(key: string): Promise<void>;
+  clear(): Promise<void>;
+  isExpired(key: string): boolean;
+  has(key: string): boolean;
+  keys(): string[];
+  size(): number;
+}
+//#endregion
+export { IStorage, MIN_1, MIN_10, MIN_15, MIN_3, MIN_5, MemoryCache, SEC_30, get, set, withCache };

package/dist/index.mjs

@@ -0,0 +1,94 @@
+import { Logger } from "@melledijkstra/toolbox";
+
+//#region src/memory.ts
+const logger = new Logger("cache");
+const cache = {};
+const SEC_30 = 30 * 1e3;
+const MIN_1 = 60 * 1e3;
+const MIN_3 = 180 * 1e3;
+const MIN_5 = 300 * 1e3;
+const MIN_10 = 600 * 1e3;
+const MIN_15 = 900 * 1e3;
+function get(key) {
+	const cachedItem = cache[key];
+	if (cachedItem) if (Date.now() - cachedItem.timestamp > cachedItem.ttl) delete cache[key];
+	else {
+		logger.log("Cache hit:", key);
+		return cachedItem.data;
+	}
+}
+function set(key, value, ttl = Infinity) {
+	cache[key] = {
+		data: value,
+		timestamp: Date.now(),
+		ttl: ttl ?? MIN_5
+	};
+}
+/**
+* Curried `withCache`: first call it with your options,
+* then call the returned function with your async function.
+*/
+function withCache(originalFunc, options = {}) {
+	const defaultTTL = 300 * 1e3;
+	const cachedFunction = async (...args) => {
+		const cacheKey = options?.key ?? originalFunc.name;
+		const cacheTTL = options?.ttl ?? defaultTTL;
+		const cachedData = get(cacheKey);
+		if (cachedData !== void 0) return cachedData;
+		const result = await originalFunc(...args);
+		set(cacheKey, result, cacheTTL);
+		return result;
+	};
+	return cachedFunction;
+}
+var MemoryCache = class {
+	logger = new Logger("MemoryCache");
+	_cache = {};
+	get(key) {
+		const cachedItem = this._cache[key];
+		if (!cachedItem) return;
+		if (Date.now() - cachedItem.timestamp > cachedItem.ttl) delete this._cache[key];
+		else return cachedItem.data;
+	}
+	async set(key, value, ttl = Infinity) {
+		this._cache[key] = {
+			data: value,
+			timestamp: Date.now(),
+			ttl
+		};
+	}
+	async delete(key) {
+		delete this._cache[key];
+	}
+	async clear() {
+		this._cache = {};
+	}
+	isExpired(key) {
+		const cachedItem = this._cache[key];
+		if (!cachedItem) return true;
+		if (Date.now() - cachedItem.timestamp > cachedItem.ttl) {
+			delete this._cache[key];
+			return true;
+		}
+		return false;
+	}
+	has(key) {
+		const cachedItem = this._cache[key];
+		if (!cachedItem) return false;
+		if (this.isExpired(key)) return false;
+		if (Date.now() - cachedItem.timestamp > cachedItem.ttl) {
+			delete this._cache[key];
+			return false;
+		}
+		return true;
+	}
+	keys() {
+		return Object.keys(this._cache);
+	}
+	size() {
+		return Object.keys(this._cache).length;
+	}
+};
+
+//#endregion
+export { MIN_1, MIN_10, MIN_15, MIN_3, MIN_5, MemoryCache, SEC_30, get, set, withCache };

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@melledijkstra/storage",
+  "version": "1.0.0",
+  "author": "Melle Dijkstra",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@melledijkstra/toolbox": "1.0.0"
+  },
+  "devDependencies": {
+    "@melledijkstra/config": "1.0.0"
+  },
+  "scripts": {
+    "dev": "tsdown --watch",
+    "build": "tsdown"
+  }
+}