@asaidimu/utils-cache 2.1.1 → 2.1.3

package/index.d.mts

@@ -1,4 +1,51 @@
-import { S as SimplePersistence } from '../types-ZDD-bdCz.js';
+interface SimplePersistence<T> {
+    /**
+     * Persists data to storage.
+     *
+     * @param id The **unique identifier of the *consumer instance*** making the change. This is NOT the ID of the data (`T`) itself.
+     * Think of it as the ID of the specific browser tab, component, or module that's currently interacting with the persistence layer.
+     * It should typically be a **UUID** generated once at the consumer instance's instantiation.
+     * This `id` is crucial for the `subscribe` method, helping to differentiate updates originating from the current instance versus other instances/tabs, thereby preventing self-triggered notification loops.
+     * @param state The state (of type T) to persist. This state is generally considered the **global or shared state** that all instances interact with.
+     * @returns `true` if the operation was successful, `false` if an error occurred. For asynchronous implementations (like `IndexedDBPersistence`), this returns a `Promise<boolean>`.
+     */
+    set(id: string, state: T): boolean | Promise<boolean>;
+    /**
+     * Retrieves the global persisted data from storage.
+     *
+     * @returns The retrieved state of type `T`, or `null` if no data is found or if an error occurs during retrieval/parsing.
+     * For asynchronous implementations, this returns a `Promise<T | null>`.
+     */
+    get(): (T | null) | (Promise<T | null>);
+    /**
+     * Subscribes to changes in the global persisted data that originate from *other* instances of your application (e.g., other tabs or independent components using the same persistence layer).
+     *
+     * @param id The **unique identifier of the *consumer instance* subscribing**. This allows the persistence implementation to filter out notifications that were initiated by the subscribing instance itself.
+     * @param callback The function to call when the global persisted data changes from *another* source. The new state (`T`) is passed as an argument to this callback.
+     * @returns A function that, when called, will unsubscribe the provided callback from future updates. Call this when your component or instance is no longer active to prevent memory leaks.
+     */
+    subscribe(id: string, callback: (state: T) => void): () => void;
+    /**
+     * Clears (removes) the entire global persisted data from storage.
+     *
+     * @returns `true` if the operation was successful, `false` if an error occurred. For asynchronous implementations, this returns a `Promise<boolean>`.
+     */
+    clear(): boolean | Promise<boolean>;
+    /**
+     * Returns metadata about the persistence layer.
+     *
+     * This is useful for distinguishing between multiple apps running on the same host
+     * (e.g., several apps served at `localhost:3000` that share the same storage key).
+     *
+     * @returns An object containing:
+     * - `version`: The semantic version string of the persistence schema or application.
+     * - `id`: A unique identifier for the application using this persistence instance.
+     */
+    stats(): {
+        version: string;
+        id: string;
+    };
+}
 
 interface CacheOptions {
     staleTime?: number;

package/index.d.ts

@@ -1,4 +1,51 @@
-import { S as SimplePersistence } from '../types-ZDD-bdCz.js';
+interface SimplePersistence<T> {
+    /**
+     * Persists data to storage.
+     *
+     * @param id The **unique identifier of the *consumer instance*** making the change. This is NOT the ID of the data (`T`) itself.
+     * Think of it as the ID of the specific browser tab, component, or module that's currently interacting with the persistence layer.
+     * It should typically be a **UUID** generated once at the consumer instance's instantiation.
+     * This `id` is crucial for the `subscribe` method, helping to differentiate updates originating from the current instance versus other instances/tabs, thereby preventing self-triggered notification loops.
+     * @param state The state (of type T) to persist. This state is generally considered the **global or shared state** that all instances interact with.
+     * @returns `true` if the operation was successful, `false` if an error occurred. For asynchronous implementations (like `IndexedDBPersistence`), this returns a `Promise<boolean>`.
+     */
+    set(id: string, state: T): boolean | Promise<boolean>;
+    /**
+     * Retrieves the global persisted data from storage.
+     *
+     * @returns The retrieved state of type `T`, or `null` if no data is found or if an error occurs during retrieval/parsing.
+     * For asynchronous implementations, this returns a `Promise<T | null>`.
+     */
+    get(): (T | null) | (Promise<T | null>);
+    /**
+     * Subscribes to changes in the global persisted data that originate from *other* instances of your application (e.g., other tabs or independent components using the same persistence layer).
+     *
+     * @param id The **unique identifier of the *consumer instance* subscribing**. This allows the persistence implementation to filter out notifications that were initiated by the subscribing instance itself.
+     * @param callback The function to call when the global persisted data changes from *another* source. The new state (`T`) is passed as an argument to this callback.
+     * @returns A function that, when called, will unsubscribe the provided callback from future updates. Call this when your component or instance is no longer active to prevent memory leaks.
+     */
+    subscribe(id: string, callback: (state: T) => void): () => void;
+    /**
+     * Clears (removes) the entire global persisted data from storage.
+     *
+     * @returns `true` if the operation was successful, `false` if an error occurred. For asynchronous implementations, this returns a `Promise<boolean>`.
+     */
+    clear(): boolean | Promise<boolean>;
+    /**
+     * Returns metadata about the persistence layer.
+     *
+     * This is useful for distinguishing between multiple apps running on the same host
+     * (e.g., several apps served at `localhost:3000` that share the same storage key).
+     *
+     * @returns An object containing:
+     * - `version`: The semantic version string of the persistence schema or application.
+     * - `id`: A unique identifier for the application using this persistence instance.
+     */
+    stats(): {
+        version: string;
+        id: string;
+    };
+}
 
 interface CacheOptions {
     staleTime?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asaidimu/utils-cache",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "Resource and cache management utilities for @asaidimu applications.",
   "main": "index.js",
   "module": "index.mjs",
@@ -30,7 +30,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@asaidimu/utils-persistence": "2.1.0",
+    "@asaidimu/utils-persistence": "2.2.1",
     "uuid": "^11.1.0",
     "@asaidimu/events": "^1.1.1"
   },