aboutsummaryrefslogtreecommitdiff
path: root/packages/web-util/src/hooks/useLocalStorage.ts
blob: 13182573628d2efdbcb019132d859bb76e155d14 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*
 This file is part of GNU Anastasis
 (C) 2021-2022 Anastasis SARL

 GNU Anastasis is free software; you can redistribute it and/or modify it under the
 terms of the GNU Affero General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 GNU Anastasis is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License along with
 GNU Anastasis; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */

/**
 *
 * @author Sebastian Javier Marchano (sebasjm)
 */

import { useEffect, useState } from "preact/hooks";
import {
  ObservableMap,
  browserStorageMap,
  localStorageMap,
  memoryMap,
} from "../utils/observable.js";

export interface LocalStorageState {
  value?: string;
  update: (s: string) => void;
  reset: () => void;
}

const supportLocalStorage = typeof window !== "undefined";
const supportBrowserStorage =
  typeof chrome !== "undefined" && typeof chrome.storage !== "undefined";

const storage: ObservableMap<string, string> = (function buildStorage() {
  if (supportBrowserStorage) {
    return browserStorageMap(memoryMap<string>());
  } else if (supportLocalStorage) {
    return localStorageMap();
  } else {
    return memoryMap<string>();
  }
})();

export function useLocalStorage(
  key: string,
  initialValue: string,
): Required<LocalStorageState>;
export function useLocalStorage(key: string): LocalStorageState;
export function useLocalStorage(
  key: string,
  initialValue?: string,
): LocalStorageState {
  const [storedValue, setStoredValue] = useState<string | undefined>(
    (): string | undefined => {
      return storage.get(key) ?? initialValue;
    },
  );

  useEffect(() => {
    return storage.onUpdate(key, () => {
      const newValue = storage.get(key);
      setStoredValue(newValue ?? initialValue);
    });
  }, []);

  const setValue = (value?: string): void => {
    if (value === undefined) {
      storage.delete(key);
    } else {
      storage.set(key, value);
    }
  };

  return {
    value: storedValue,
    update: setValue,
    reset: () => {
      setValue(initialValue);
    },
  };
}