Merge pull request #26 from HichemTab-tech/add-updaters

HichemTab-tech · web-flow · commit 926c1f6b6b9a · 2025-10-01T17:52:54.000+01:00
Add updaters to apis
diff --git a/README.md b/README.md
@@ -519,11 +519,11 @@ const subStateScoped = sharedSubscriptionsApi.get('live-chat', 'myScope');
 
 ## API summary:
 
-| API                      | Methods                                                                                                                                                                                 |
-|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `sharedStatesApi`        | `get(key, scopeName?)`, `set(key, val, scopeName?)`, `has(key, scopeName?)`, `clear(key, scopeName?)`, `clearAll(withoutListeners?, withStatic?)`, `clearScope(scopeName?)`, `getAll()` |
-| `sharedFunctionsApi`     | `get(key, scopeName?)`, `set(key, val, scopeName?)`, `has(key, scopeName?)`, `clear(key, scopeName?)`, `clearAll(withoutListeners?, withStatic?)`, `clearScope(scopeName?)`, `getAll()` |
-| `sharedSubscriptionsApi` | `get(key, scopeName?)`, `set(key, val, scopeName?)`, `has(key, scopeName?)`, `clear(key, scopeName?)`, `clearAll(withoutListeners?, withStatic?)`, `clearScope(scopeName?)`, `getAll()` |
+| API                      | Methods                                                                                                                                                                                                                     |
+|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `sharedStatesApi`        | `get(key, scopeName?)`, `set(key, val, scopeName?)`, `update(key, updater, scopeName?)`, `has(key, scopeName?)`, `clear(key, scopeName?)`, `clearAll(withoutListeners?, withStatic?)`, `clearScope(scopeName?)`, `getAll()` |
+| `sharedFunctionsApi`     | `get(key, scopeName?)`, `set(key, val, scopeName?)`, `update(key, updater, scopeName?)`, `has(key, scopeName?)`, `clear(key, scopeName?)`, `clearAll(withoutListeners?, withStatic?)`, `clearScope(scopeName?)`, `getAll()` |
+| `sharedSubscriptionsApi` | `get(key, scopeName?)`, `set(key, val, scopeName?)`, `update(key, updater, scopeName?)`, `has(key, scopeName?)`, `clear(key, scopeName?)`, `clearAll(withoutListeners?, withStatic?)`, `clearScope(scopeName?)`, `getAll()` |
 
 `scopeName` defaults to `"_global"`. Internally, keys are stored as `${scope}//${key}`. The `.getAll()` method returns a nested object: `{ [scope]: { [key]: value } }`.
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-shared-states",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "type": "module",
   "description": "Global state made as simple as useState, with zero config, built-in async caching, and automatic scoping.",
   "keywords": [
diff --git a/src/SharedValuesManager.ts b/src/SharedValuesManager.ts
@@ -180,6 +180,33 @@ export class SharedValuesApi<T extends SharedValue, V, R = T> {
         this.sharedData.callListeners(keyStr, prefix);
     }
 
+    /**
+     * update a value in the shared data
+     * @param key
+     * @param updater
+     * @param scopeName
+     */
+    update<S extends string = string>(key: S, updater: (prev: R) => V, scopeName: Prefix): void;
+    update<S extends string = string>(sharedCreated: SharedCreated, updater: (prev: R) => V): void;
+    update<S extends string = string>(key: S | SharedCreated, updater: (prev: R) => V, scopeName?: Prefix) {
+
+        let prevData;
+        if (typeof key === "string") {
+            prevData = this.get<S>(key, scopeName as Prefix);
+        }
+        else{
+            prevData = this.get(key);
+        }
+        const newValue = updater(prevData);
+
+        if (typeof key === "string") {
+            this.set(key, newValue, scopeName as Prefix);
+        }
+        else{
+            this.set(key, newValue);
+        }
+    }
+
     /**
      * clear all values from the shared data
      */
diff --git a/src/hooks/use-shared-function.ts b/src/hooks/use-shared-function.ts
@@ -55,6 +55,22 @@ export class SharedFunctionsApi extends SharedValuesApi<SharedFunction<unknown>,
         }
         super.set(key, value, scopeName);
     }
+    update<T, Args extends unknown[], S extends string = string>(key: S, updater: (prev: SharedFunctionValue<T>) => { fnState: SharedFunctionValue<T> }, scopeName?: Prefix): void;
+    update<T, Args extends unknown[]>(sharedFunctionCreated: SharedFunctionCreated<T, Args>, updater: (prev: SharedFunctionValue<T>) => { fnState: SharedFunctionValue<T> }): void;
+    update<T, Args extends unknown[], S extends string = string>(key: S | SharedFunctionCreated<T, Args>, updater: (prev: SharedFunctionValue<T>) => { fnState: SharedFunctionValue<T> }, scopeName: Prefix = "_global") {
+        let prev: SharedFunctionValue<T>;
+        if (typeof key === "string") {
+            prev = this.get(key, scopeName);
+        } else {
+            prev = this.get(key);
+        }
+        const newValue = updater(prev);
+        if (typeof key === "string") {
+            this.set(key, newValue, scopeName);
+        } else {
+            this.set(key, newValue);
+        }
+    }
 }
 
 const sharedFunctionsManager = new SharedFunctionsManager();
diff --git a/src/hooks/use-shared-state.ts b/src/hooks/use-shared-state.ts
@@ -47,6 +47,22 @@ export class SharedStatesApi extends SharedValuesApi<SharedState<unknown>, { val
         }
         super.set(key, {value}, scopeName);
     }
+    update<T, S extends string = string>(key: S, updater: (prev: T) => T, scopeName?: Prefix): void;
+    update<T>(sharedStateCreated: SharedStateCreated<T>, updater: (prev: T) => T): void;
+    update<T, S extends string = string>(key: S | SharedStateCreated<T>, updater: (prev: T) => T, scopeName: Prefix = "_global") {
+        let prev: T;
+        if (typeof key === "string") {
+            prev = this.get(key, scopeName);
+        } else {
+            prev = this.get(key);
+        }
+        const newValue = updater(prev);
+        if (typeof key === "string") {
+            this.set(key, newValue, scopeName);
+        } else {
+            this.set(key, newValue);
+        }
+    }
 }
 
 const sharedStatesManager = new SharedStatesManager();
diff --git a/src/hooks/use-shared-subscription.ts b/src/hooks/use-shared-subscription.ts
@@ -92,6 +92,22 @@ export class SharedSubscriptionsApi extends SharedValuesApi<SharedSubscription<u
         }
         super.set(key, value, scopeName);
     }
+    update<T, S extends string = string>(key: S, updater: (prev: SharedSubscriptionValue<T>) => { fnState: SharedSubscriptionValue<T> }, scopeName?: Prefix): void;
+    update<T>(sharedSubscriptionCreated: SharedSubscriptionCreated<T>, updater: (prev: SharedSubscriptionValue<T>) => { fnState: SharedSubscriptionValue<T> }): void;
+    update<T, S extends string = string>(key: S | SharedSubscriptionCreated<T>, updater: (prev: SharedSubscriptionValue<T>) => { fnState: SharedSubscriptionValue<T> }, scopeName: Prefix = "_global") {
+        let prev: SharedSubscriptionValue<T>;
+        if (typeof key === "string") {
+            prev = this.get(key, scopeName);
+        } else {
+            prev = this.get(key);
+        }
+        const newValue = updater(prev);
+        if (typeof key === "string") {
+            this.set(key, newValue, scopeName);
+        } else {
+            this.set(key, newValue);
+        }
+    }
 }
 
 const sharedSubscriptionsManager = new SharedSubscriptionsManager();
diff --git a/tests/index.test.tsx b/tests/index.test.tsx
@@ -159,6 +159,14 @@ describe('useSharedState', () => {
         // Get updated value
         expect(sharedStatesApi.get(sharedCounter)).toBe(200);
 
+        // Update the value
+        act(() => {
+            sharedStatesApi.update(sharedCounter, (prev) => prev + 50);
+        });
+
+        // Get updated value after update
+        expect(sharedStatesApi.get(sharedCounter)).toBe(250);
+
         // Clear the value
         act(() => {
             sharedStatesApi.clear(sharedCounter);
@@ -310,6 +318,20 @@ describe('useSharedFunction', () => {
         expect(updatedState.isLoading).toBe(true);
         expect(updatedState.error).toBe('test error');
 
+        // Update the state
+        act(() => {
+            sharedFunctionsApi.update(sharedFunction, (prev) => ({
+                fnState: {
+                    ...prev,
+                    results: 'updated data',
+                }
+            }));
+        });
+
+        // Get updated state after update
+        const updatedState2 = sharedFunctionsApi.get(sharedFunction);
+        expect(updatedState2.results).toBe('updated data');
+
         // Clear the value
         act(() => {
             sharedFunctionsApi.clear(sharedFunction);
@@ -374,6 +396,20 @@ describe('useSharedSubscription', () => {
         expect(updatedState.isLoading).toBe(true);
         expect(updatedState.error).toBe('test error');
 
+        // Update the state
+        act(() => {
+            sharedSubscriptionsApi.update(sharedSubscription, (prev) => ({
+                fnState: {
+                    ...prev,
+                    data: 'updated data',
+                }
+            }));
+        });
+
+        // Get updated state after update
+        const updatedState2 = sharedSubscriptionsApi.get(sharedSubscription);
+        expect(updatedState2.data).toBe('updated data');
+
         // Clear the value
         act(() => {
             sharedSubscriptionsApi.clear(sharedSubscription);
@@ -513,6 +549,20 @@ describe('useSharedSubscription', () => {
         expect(updatedState.isLoading).toBe(true);
         expect(updatedState.error).toBe('test error');
 
+        // Update the state
+        act(() => {
+            sharedSubscriptionsApi.update(sharedSubscription, (prev) => ({
+                fnState: {
+                    ...prev,
+                    data: 'updated data',
+                }
+            }));
+        });
+
+        // Get updated state after update
+        const updatedState2 = sharedSubscriptionsApi.get(sharedSubscription);
+        expect(updatedState2.data).toBe('updated data');
+
         // Clear the value
         act(() => {
             sharedSubscriptionsApi.clear(sharedSubscription);

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "react-shared-states",`
`3`		`- "version": "1.0.13",`
	`3`	`+ "version": "1.0.14",`
`4`	`4`	`"type": "module",`
`5`	`5`	`"description": "Global state made as simple as useState, with zero config, built-in async caching, and automatic scoping.",`
`6`	`6`	`"keywords": [`