@wzyjs/hooks 0.3.32 → 0.3.36

package/dist/dom/index.d.ts

@@ -2,3 +2,4 @@ export * from './useElement';
 export * from './useElementScrollVisible';
 export * from './useCacheState';
 export * from './useHovered';
+export * from './useProjectLocalStorage';

package/dist/dom/index.js

@@ -2,3 +2,4 @@ export * from './useElement';
 export * from './useElementScrollVisible';
 export * from './useCacheState';
 export * from './useHovered';
+export * from './useProjectLocalStorage';

package/dist/dom/useProjectLocalStorage.d.ts

@@ -0,0 +1,11 @@
+type ProjectLocalStorageStore = Record<string, unknown>;
+interface UseProjectLocalStorageOptions<TStore extends ProjectLocalStorageStore> {
+    defaultValue?: TStore;
+}
+export declare const useProjectLocalStorage: <TStore extends ProjectLocalStorageStore = ProjectLocalStorageStore>(storageKey: string, options?: UseProjectLocalStorageOptions<TStore>) => {
+    getStore: () => TStore;
+    setStore: (store: TStore) => TStore;
+    getValue: <TValue = unknown>(path: string, fallbackValue?: TValue) => TValue;
+    setValue: <TValue = unknown>(path: string, value: TValue) => TStore;
+};
+export {};

package/dist/dom/useProjectLocalStorage.js

@@ -0,0 +1,62 @@
+import { useCallback } from 'react';
+import { cloneDeep, get, set } from 'lodash-es';
+const getBrowserLocalStorage = () => {
+    if (typeof window === 'undefined') {
+        return null;
+    }
+    return window.localStorage;
+};
+const isObjectStore = (value) => {
+    return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
+};
+// 功能：用一个项目级 localStorage key 集中保存对象，并通过 path 读写对象内部字段。
+export const useProjectLocalStorage = (storageKey, options = {}) => {
+    const { defaultValue } = options;
+    const getStore = useCallback(() => {
+        const storage = getBrowserLocalStorage();
+        if (!storage) {
+            return cloneDeep(defaultValue || {});
+        }
+        try {
+            const rawValue = storage.getItem(storageKey);
+            if (!rawValue) {
+                return cloneDeep(defaultValue || {});
+            }
+            const parsedValue = JSON.parse(rawValue);
+            if (!isObjectStore(parsedValue)) {
+                return cloneDeep(defaultValue || {});
+            }
+            return parsedValue;
+        }
+        catch {
+            return cloneDeep(defaultValue || {});
+        }
+    }, [defaultValue, storageKey]);
+    const setStore = useCallback((store) => {
+        const storage = getBrowserLocalStorage();
+        if (!storage) {
+            return store;
+        }
+        try {
+            storage.setItem(storageKey, JSON.stringify(store));
+        }
+        catch {
+            return store;
+        }
+        return store;
+    }, [storageKey]);
+    const getValue = useCallback((path, fallbackValue) => {
+        return get(getStore(), path, fallbackValue);
+    }, [getStore]);
+    const setValue = useCallback((path, value) => {
+        const nextStore = cloneDeep(getStore());
+        set(nextStore, path, value);
+        return setStore(nextStore);
+    }, [getStore, setStore]);
+    return {
+        getStore,
+        setStore,
+        getValue,
+        setValue,
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wzyjs/hooks",
-  "version": "0.3.32",
+  "version": "0.3.36",
   "description": "description",
   "author": "wzy",
   "type": "module",
@@ -8,7 +8,8 @@
   "types": "dist/index.d.ts",
   "sideEffects": false,
   "scripts": {
-    "build": "rm -rf dist && tsc"
+    "build": "rm -rf dist && tsc",
+    "typecheck": "tsc --noEmit"
   },
   "files": [
     "dist"
@@ -51,5 +52,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "260d8290106ef447ec42375d4656af2e89675b15"
+  "gitHead": "7db0faf741993d729a9e1c0742f480f364816222"
 }