use-good-hooks 1.0.9 → 1.0.11

package/README.md

@@ -274,6 +274,94 @@ const ProductFilter = () => {
     - State value
     - State setter function
 
+### `useGlobalState` and `createGlobalState`
+
+Creates and manages global state that can be shared across components with automatic synchronization.
+
+```typescript
+import { createGlobalState, useGlobalState } from 'use-good-hooks';
+
+// Create a global state instance (typically in a separate file)
+const counterState = createGlobalState({ count: 0 });
+
+// Component A
+const CounterDisplay = () => {
+  const [counter, setCounter] = useGlobalState(counterState);
+
+  return (
+    <div>
+      <p>Count: {counter.count}</p>
+      <button onClick={() => setCounter({ count: counter.count + 1 })}>
+        Increment
+      </button>
+    </div>
+  );
+};
+
+// Component B (in a different part of your app)
+const CounterActions = () => {
+  const [counter, setCounter] = useGlobalState(counterState);
+
+  return (
+    <div>
+      <button onClick={() => setCounter({ count: 0 })}>
+        Reset Count
+      </button>
+      <button onClick={() => setCounter(prev => ({ count: prev.count + 5 }))}>
+        Add 5
+      </button>
+    </div>
+  );
+};
+```
+
+#### Usage
+
+1. First, create a global state store:
+
+```typescript
+// state/counter.ts
+import { createGlobalState } from 'use-good-hooks';
+
+export const counterState = createGlobalState({ count: 0 });
+```
+
+2. Then use it in any component:
+
+```typescript
+import { useGlobalState } from 'use-good-hooks';
+import { counterState } from './state/counter';
+
+const MyComponent = () => {
+	const [counter, setCounter] = useGlobalState(counterState);
+	// ...
+};
+```
+
+#### `createGlobalState` Parameters
+
+- `initialState`: The initial state value
+
+#### `createGlobalState` Returns
+
+- Array with:
+    - `state`: The current state
+    - `setState`: Function to update state
+    - `store`: Object with utility methods:
+        - `getState()`: Function to get current state
+        - `subscribe(callback)`: Subscribe to state changes
+        - `resetState()`: Reset to initial state
+
+#### `useGlobalState` Parameters
+
+- `globalState`: The global state created with `createGlobalState`
+
+#### `useGlobalState` Returns
+
+- Array with:
+    - `state`: The component's local copy of the state
+    - `setState`: Function to update global state (accepts new value or update function)
+
 ## 🧪 Running Tests
 
 This library is thoroughly tested with Vitest and React Testing Library. To run the tests:

package/dist/index.d.ts

@@ -1,20 +1,56 @@
-import { default as useDebounce } from './hooks/use-debounce';
-import { default as useDistinct } from './hooks/use-distinct';
-import { default as usePrev } from './hooks/use-prev';
-import { default as useStorageState } from './hooks/use-storage-state';
-import { default as useThrottle } from './hooks/use-throttle';
-import { default as useUrlState } from './hooks/use-url-state';
+declare type SetUrlStateAction<T> = T | ((prevState: T) => T);
 
-export { useDebounce }
+declare type StorageType = 'local' | 'session';
 
-export { useDistinct }
+declare type StrictObject = {
+    [key: string]: any;
+} & {
+    length?: never;
+};
 
-export { usePrev }
+export declare const useDebounce: <T>(value: T, delay?: number) => T;
 
-export { useStorageState }
+export declare const useDistinct: <T>(inputValue: T, options?: UseDistinctOptions) => UseDistinctReturn<T>;
 
-export { useThrottle }
+declare type UseDistinctOptions = {
+    compare?: (a: any, b: any) => boolean;
+    debounce?: number;
+    deep?: boolean;
+};
 
-export { useUrlState }
+declare type UseDistinctReturn<T> = {
+    distinct: boolean;
+    prevValue: T | undefined;
+    value: T;
+};
+
+export declare const usePrev: <T>(value: T) => T | undefined;
+
+export declare const useStorageState: <T extends StrictObject>(key: string, initialState: T, options?: UseStorageStateOptions) => [T, (value: T | ((prev: T) => T)) => void, {
+    removeKey: () => void;
+}];
+
+declare type UseStorageStateOptions = {
+    debounce?: number;
+    onError?: (err: Error) => void;
+    omitKeys?: string[] | ((value: any, key: string) => boolean);
+    pickKeys?: string[] | ((value: any, key: string) => boolean);
+    storage?: StorageType;
+};
+
+export declare const useThrottle: <T>(value: T, delay?: number) => T;
+
+export declare const useUrlState: <T extends StrictObject>(initialState: T, options: UseUrlStateOptions) => [T, (value: SetUrlStateAction<T>) => void];
+
+declare type UseUrlStateOptions = {
+    debounce?: number;
+    kebabCase?: boolean;
+    omitKeys?: string[] | ((value: any, key: string) => boolean);
+    omitValues?: any[] | ((value: any, key: string) => boolean);
+    onError?: (err: Error) => void;
+    pickKeys?: string[] | ((value: any, key: string) => boolean);
+    prefix?: string;
+    url: URL;
+};
 
 export { }

package/package.json

@@ -14,6 +14,7 @@
 		"@types/react": "^19.0.8",
 		"@types/react-dom": "^19.0.3",
 		"@vitejs/plugin-react": "^4.3.4",
+		"@vitest/coverage-v8": "3.0.7",
 		"clsx": "^2.1.1",
 		"eslint": "^9.19.0",
 		"eslint-plugin-react-hooks": "^5.0.0",
@@ -43,7 +44,8 @@
 		"build": "yarn lint && vite build --mode export",
 		"lint": "prettier --write . && eslint .",
 		"npm-publish": "yarn test --run && yarn build && yarn version --patch --no-git-tag-version && yarn publish --non-interactive",
-		"test": "vitest"
+		"test": "vitest",
+		"test:coverage": "vitest --coverage"
 	},
-	"version": "1.0.9"
+	"version": "1.0.11"
 }