@versini/ui-hooks 3.0.1 → 4.0.1

package/dist/hooks/useLocalStorage.js

@@ -1,59 +1,42 @@
-import { useCallback as u, useState as m } from "react";
-import { useEventCallback as w } from "./useEventCallback.js";
-import { useEventListener as E } from "./useEventListener.js";
-const s = "av-local-storage", h = (t) => {
-  try {
-    return JSON.stringify(t);
-  } catch {
-    throw new Error(
-      "@versini/ui-hooks useLocalStorage: Failed to serialize the value"
-    );
-  }
-}, p = (t) => {
-  try {
-    return t && JSON.parse(t);
-  } catch {
-    return t;
-  }
-};
-function V({
+import { useSyncExternalStore as w, useCallback as a, useEffect as d } from "react";
+function S(t, e) {
+  window.dispatchEvent(new StorageEvent("storage", { key: t, newValue: e }));
+}
+const g = (t, e) => {
+  const c = JSON.stringify(
+    typeof e == "function" ? e() : e
+  );
+  window.localStorage.setItem(t, c), S(t, c);
+}, i = (t) => {
+  window.localStorage.removeItem(t), S(t, null);
+}, l = (t) => window.localStorage.getItem(t), m = (t) => (window.addEventListener("storage", t), () => window.removeEventListener("storage", t));
+function E({
   key: t,
-  defaultValue: n,
-  deserialize: g = p,
-  serialize: c = (o) => h(o)
+  initialValue: e
 }) {
-  const o = typeof n == "function" ? n() : n, a = u(() => {
-    let r;
-    try {
-      r = typeof window > "u" || !("localStorage" in window) || window.localStorage === null;
-    } catch {
-      r = !0;
-    }
-    if (r)
-      return window.localStorage.setItem(t, c(o)), o;
-    try {
-      const e = window.localStorage.getItem(t);
-      return e !== null ? g(e) : (window.localStorage.setItem(t, c(o)), o);
-    } catch (e) {
-      return console.warn(`Error reading localStorage key “${t}”:`, e), o;
-    }
-  }, [o, t]), [l, i] = m(a()), S = w((r) => {
+  const s = w(m, () => l(t)), o = a(
+    (n) => {
+      try {
+        const r = typeof n == "function" ? n(JSON.parse(s)) : n;
+        r == null ? i(t) : g(t, r);
+      } catch (r) {
+        console.warn(r);
+      }
+    },
+    [t, s]
+  ), u = a(() => {
+    o(e);
+  }, [e, o]), f = a(() => {
+    o(null);
+  }, [o]);
+  return d(() => {
     try {
-      const e = r instanceof Function ? r(l) : r;
-      if (e === void 0)
-        return;
-      window.localStorage.setItem(t, c(e)), i(e), window.dispatchEvent(new Event(s));
-    } catch (e) {
-      console.warn(`Error setting localStorage key “${t}”:`, e);
+      l(t) === null && typeof e < "u" && g(t, e);
+    } catch (n) {
+      console.warn(n);
     }
-  }), d = w(() => (window.localStorage.removeItem(t), i(a()), window.dispatchEvent(new Event(s)), l)), f = u(
-    (r) => {
-      r != null && r.key && r.key !== t || i(a());
-    },
-    [t, a]
-  );
-  return E(s, f), [l, S, d];
+  }, [t, e]), [s ? JSON.parse(s) : null, o, u, f];
 }
 export {
-  V as useLocalStorage
+  E as useLocalStorage
 };

package/dist/index.d.ts

@@ -1,9 +1,3 @@
-declare const CUSTOM_EVENT_NAME = "av-local-storage";
-declare global {
-    interface WindowEventMap {
-        [CUSTOM_EVENT_NAME]: CustomEvent;
-    }
-}
 interface StorageProperties<T> {
     /**
      * Storage key.
@@ -12,29 +6,23 @@ interface StorageProperties<T> {
     /**
      * Default value that will be set if value is not found in storage.
      */
-    defaultValue?: T;
-    /**
-     * Function to serialize value into string to be saved in storage.
-     */
-    serialize?: (value: T) => string;
-    /**
-     * Function to deserialize string value from storage to value.
-     */
-    deserialize?: (value: string | undefined) => T;
+    initialValue?: T;
 }
 /**
  *
  * @example
  * import { useLocalStorage } from '@versini/ui-hooks';
- * const [value, setValue] = useLocalStorage({
+ * const [value, setValue, resetValue, removeValue] = useLocalStorage({
  *   key: 'gpt-model',
- *   defaultValue: 'gpt-3',
+ *   initialValue: 'gpt-3',
  * });
  *
- * setValue('gpt-4');
+ * setValue('gpt-4'); ==> "gpt-4"
  * setValue((current) => (current === 'gpt-3' ? 'gpt-4' : 'gpt-3'));
+ * resetValue(); ==> "gpt-3"
+ * removeValue(); ==> null
  */
-declare function useLocalStorage<T = string>({ key, defaultValue, deserialize, serialize, }: StorageProperties<T>): [T, (val: T | ((prevState: T) => T)) => void, () => void];
+declare function useLocalStorage<T>({ key, initialValue, }: StorageProperties<T>): any[];
 
 /**
  * React utility to merge refs.

package/dist/index.js

@@ -3,7 +3,7 @@ import { useMergeRefs as f } from "./hooks/useMergeRefs.js";
 import { useUncontrolled as u } from "./hooks/useUncontrolled.js";
 import { useUniqueId as p } from "./hooks/useUniqueId.js";
 /*!
-  @versini/ui-hooks v3.0.1
+  @versini/ui-hooks v4.0.1
   © 2024 gizmette.com
 */
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@versini/ui-hooks",
-	"version": "3.0.1",
+	"version": "4.0.1",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"publishConfig": {
@@ -41,5 +41,5 @@
 		"react": "18.3.1",
 		"react-dom": "18.3.1"
 	},
-	"gitHead": "9e9b109b35d7ee476d6ff96cdd70bc9ef276ddb7"
+	"gitHead": "5ddede585a2476c9eddc74162cf10c30d0f1fe88"
 }

package/dist/hooks/useEventCallback.js

@@ -1,12 +0,0 @@
-import { useRef as t, useEffect as a, useCallback as c } from "react";
-function o(r) {
-  const e = t(() => {
-    throw new Error("Cannot call an event handler while rendering.");
-  });
-  return a(() => {
-    e.current = r;
-  }, [r]), c((...n) => e.current(...n), [e]);
-}
-export {
-  o as useEventCallback
-};

package/dist/hooks/useEventListener.js

@@ -1,18 +0,0 @@
-import { useRef as E, useEffect as i } from "react";
-function o(n, c, r, e) {
-  const s = E(c);
-  i(() => {
-    s.current = c;
-  }, [c]), i(() => {
-    const t = (r == null ? void 0 : r.current) ?? window;
-    if (!(t && t.addEventListener))
-      return;
-    const u = (f) => s.current(f);
-    return t.addEventListener(n, u, e), () => {
-      t.removeEventListener(n, u, e);
-    };
-  }, [n, r, e]);
-}
-export {
-  o as useEventListener
-};