@versini/ui-hooks 2.2.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,59 +1,91 @@
1
- import { useCallback as u, useState as m } from "react";
2
- import { useEventCallback as w } from "./useEventCallback.js";
3
- import { useEventListener as E } from "./useEventListener.js";
4
- const s = "av-local-storage", h = (t) => {
5
- try {
6
- return JSON.stringify(t);
7
- } catch {
8
- throw new Error(
9
- "@versini/ui-hooks useLocalStorage: Failed to serialize the value"
10
- );
11
- }
12
- }, p = (t) => {
13
- try {
14
- return t && JSON.parse(t);
15
- } catch {
16
- return t;
17
- }
18
- };
19
- function V({
20
- key: t,
21
- defaultValue: n,
22
- deserialize: g = p,
23
- serialize: c = (o) => h(o)
24
- }) {
25
- const o = typeof n == "function" ? n() : n, a = u(() => {
26
- let r;
27
- try {
28
- r = typeof window > "u" || !("localStorage" in window) || window.localStorage === null;
29
- } catch {
30
- r = !0;
31
- }
32
- if (r)
33
- return window.localStorage.setItem(t, c(o)), o;
1
+ import { useCallback as u, useState as F, useEffect as g, useRef as h, useLayoutEffect as I } from "react";
2
+ var m = typeof window < "u" ? I : g;
3
+ function S(r, e, t, c) {
4
+ const d = h(e);
5
+ m(() => {
6
+ d.current = e;
7
+ }, [e]), g(() => {
8
+ const a = window;
9
+ if (!(a && a.addEventListener))
10
+ return;
11
+ const s = (f) => {
12
+ d.current(f);
13
+ };
14
+ return a.addEventListener(r, s, c), () => {
15
+ a.removeEventListener(r, s, c);
16
+ };
17
+ }, [r, t, c]);
18
+ }
19
+ function v(r) {
20
+ const e = h(() => {
21
+ throw new Error("Cannot call an event handler while rendering.");
22
+ });
23
+ return m(() => {
24
+ e.current = r;
25
+ }, [r]), u((...t) => {
26
+ var c;
27
+ return (c = e.current) == null ? void 0 : c.call(e, ...t);
28
+ }, [e]);
29
+ }
30
+ var l = typeof window > "u";
31
+ function $(r, e, t = {}) {
32
+ const { initializeWithValue: c = !0 } = t, d = u(
33
+ (n) => t.serializer ? t.serializer(n) : JSON.stringify(n),
34
+ [t]
35
+ ), a = u(
36
+ (n) => {
37
+ if (t.deserializer)
38
+ return t.deserializer(n);
39
+ if (n === "undefined")
40
+ return;
41
+ const o = e instanceof Function ? e() : e;
42
+ let E;
43
+ try {
44
+ E = JSON.parse(n);
45
+ } catch (L) {
46
+ return console.error("Error parsing JSON:", L), o;
47
+ }
48
+ return E;
49
+ },
50
+ [t, e]
51
+ ), s = u(() => {
52
+ const n = e instanceof Function ? e() : e;
53
+ if (l)
54
+ return n;
34
55
  try {
35
- const e = window.localStorage.getItem(t);
36
- return e !== null ? g(e) : (window.localStorage.setItem(t, c(o)), o);
37
- } catch (e) {
38
- return console.warn(`Error reading localStorage key “${t}”:`, e), o;
56
+ const o = window.localStorage.getItem(r);
57
+ return o ? a(o) : n;
58
+ } catch (o) {
59
+ return console.warn(`Error reading localStorage key “${r}”:`, o), n;
39
60
  }
40
- }, [o, t]), [l, i] = m(a()), S = w((r) => {
61
+ }, [e, r, a]), [f, i] = F(() => c ? s() : e instanceof Function ? e() : e), C = v((n) => {
62
+ l && console.warn(
63
+ `Tried setting localStorage key “${r}” even though environment is not a client`
64
+ );
41
65
  try {
42
- const e = r instanceof Function ? r(l) : r;
43
- if (e === void 0)
44
- return;
45
- window.localStorage.setItem(t, c(e)), i(e), window.dispatchEvent(new Event(s));
46
- } catch (e) {
47
- console.warn(`Error setting localStorage key “${t}”:`, e);
66
+ const o = n instanceof Function ? n(s()) : n;
67
+ window.localStorage.setItem(r, d(o)), i(o), window.dispatchEvent(new StorageEvent("local-storage", { key: r }));
68
+ } catch (o) {
69
+ console.warn(`Error setting localStorage key “${r}”:`, o);
48
70
  }
49
- }), d = w(() => (window.localStorage.removeItem(t), i(a()), window.dispatchEvent(new Event(s)), l)), f = u(
50
- (r) => {
51
- r != null && r.key && r.key !== t || i(a());
71
+ }), z = v(() => {
72
+ l && console.warn(
73
+ `Tried removing localStorage key “${r}” even though environment is not a client`
74
+ );
75
+ const n = e instanceof Function ? e() : e;
76
+ window.localStorage.removeItem(r), i(n), window.dispatchEvent(new StorageEvent("local-storage", { key: r }));
77
+ });
78
+ g(() => {
79
+ i(s());
80
+ }, [r]);
81
+ const w = u(
82
+ (n) => {
83
+ n.key && n.key !== r || i(s());
52
84
  },
53
- [t, a]
85
+ [r, s]
54
86
  );
55
- return E(s, f), [l, S, d];
87
+ return S("storage", w), S("local-storage", w), [f, C, z];
56
88
  }
57
89
  export {
58
- V as useLocalStorage
90
+ $ as useLocalStorage
59
91
  };
package/dist/index.d.ts CHANGED
@@ -1,40 +1,4 @@
1
- declare const CUSTOM_EVENT_NAME = "av-local-storage";
2
- declare global {
3
- interface WindowEventMap {
4
- [CUSTOM_EVENT_NAME]: CustomEvent;
5
- }
6
- }
7
- interface StorageProperties<T> {
8
- /**
9
- * Storage key.
10
- */
11
- key: string;
12
- /**
13
- * Default value that will be set if value is not found in storage.
14
- */
15
- defaultValue?: T;
16
- /**
17
- * Function to serialize value into string to be saved in storage.
18
- */
19
- serialize?: (value: T) => string;
20
- /**
21
- * Function to deserialize string value from storage to value.
22
- */
23
- deserialize?: (value: string | undefined) => T;
24
- }
25
- /**
26
- *
27
- * @example
28
- * import { useLocalStorage } from '@versini/ui-hooks';
29
- * const [value, setValue] = useLocalStorage({
30
- * key: 'gpt-model',
31
- * defaultValue: 'gpt-3',
32
- * });
33
- *
34
- * setValue('gpt-4');
35
- * setValue((current) => (current === 'gpt-3' ? 'gpt-4' : 'gpt-3'));
36
- */
37
- declare function useLocalStorage<T = string>({ key, defaultValue, deserialize, serialize, }: StorageProperties<T>): [T, (val: T | ((prevState: T) => T)) => void, () => void];
1
+ export { useLocalStorage } from 'usehooks-ts';
38
2
 
39
3
  /**
40
4
  * React utility to merge refs.
@@ -129,4 +93,4 @@ type UseUniqueIdOptions = string | number | {
129
93
  };
130
94
  declare function useUniqueId(options?: UseUniqueIdOptions): string | undefined;
131
95
 
132
- export { useLocalStorage, useMergeRefs, useUncontrolled, useUniqueId };
96
+ export { useMergeRefs, useUncontrolled, useUniqueId };
package/dist/index.js CHANGED
@@ -1,14 +1,14 @@
1
- import { useLocalStorage as r } from "./hooks/useLocalStorage.js";
2
- import { useMergeRefs as f } from "./hooks/useMergeRefs.js";
3
- import { useUncontrolled as u } from "./hooks/useUncontrolled.js";
4
- import { useUniqueId as p } from "./hooks/useUniqueId.js";
1
+ import { useMergeRefs as r } from "./hooks/useMergeRefs.js";
2
+ import { useUncontrolled as f } from "./hooks/useUncontrolled.js";
3
+ import { useUniqueId as u } from "./hooks/useUniqueId.js";
4
+ import { useLocalStorage as p } from "./hooks/useLocalStorage.js";
5
5
  /*!
6
- @versini/ui-hooks v2.2.1
6
+ @versini/ui-hooks v3.0.0
7
7
  © 2024 gizmette.com
8
8
  */
9
9
  export {
10
- r as useLocalStorage,
11
- f as useMergeRefs,
12
- u as useUncontrolled,
13
- p as useUniqueId
10
+ p as useLocalStorage,
11
+ r as useMergeRefs,
12
+ f as useUncontrolled,
13
+ u as useUniqueId
14
14
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@versini/ui-hooks",
3
- "version": "2.2.1",
3
+ "version": "3.0.0",
4
4
  "license": "MIT",
5
5
  "author": "Arno Versini",
6
6
  "publishConfig": {
@@ -41,5 +41,8 @@
41
41
  "react": "18.3.1",
42
42
  "react-dom": "18.3.1"
43
43
  },
44
- "gitHead": "228d7682026ac0295086363e908b8ed629c086cb"
44
+ "dependencies": {
45
+ "usehooks-ts": "3.1.0"
46
+ },
47
+ "gitHead": "e3e5df0ce39be11620614a8f47de214155b589f5"
45
48
  }
@@ -1,12 +0,0 @@
1
- import { useRef as t, useEffect as a, useCallback as c } from "react";
2
- function o(r) {
3
- const e = t(() => {
4
- throw new Error("Cannot call an event handler while rendering.");
5
- });
6
- return a(() => {
7
- e.current = r;
8
- }, [r]), c((...n) => e.current(...n), [e]);
9
- }
10
- export {
11
- o as useEventCallback
12
- };
@@ -1,18 +0,0 @@
1
- import { useRef as E, useEffect as i } from "react";
2
- function o(n, c, r, e) {
3
- const s = E(c);
4
- i(() => {
5
- s.current = c;
6
- }, [c]), i(() => {
7
- const t = (r == null ? void 0 : r.current) ?? window;
8
- if (!(t && t.addEventListener))
9
- return;
10
- const u = (f) => s.current(f);
11
- return t.addEventListener(n, u, e), () => {
12
- t.removeEventListener(n, u, e);
13
- };
14
- }, [n, r, e]);
15
- }
16
- export {
17
- o as useEventListener
18
- };