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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*
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 { Codec, codecForString } from "@gnu-taler/taler-util";
import { useEffect, useState } from "preact/hooks";
import {
ObservableMap,
browserStorageMap,
localStorageMap,
memoryMap,
} from "../utils/observable.js";
declare const opaque_StorageKey: unique symbol;
export type StorageKey<Key> = {
id: string;
[opaque_StorageKey]: true;
codec: Codec<Key>;
};
export function buildStorageKey<Key>(
name: string,
codec: Codec<Key>,
): StorageKey<Key>;
export function buildStorageKey(name: string): StorageKey<string>;
export function buildStorageKey<Key = string>(
name: string,
codec?: Codec<Key>,
): StorageKey<Key> {
return {
id: name,
codec: codec ?? (codecForString() as Codec<Key>),
} as StorageKey<Key>;
}
export interface StorageState<Type = string> {
value?: Type;
update: (s: Type) => 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>();
}
})();
//with initial value
export function useLocalStorage<Type = string>(
key: StorageKey<Type>,
defaultValue: Type,
): Required<StorageState<Type>>;
//without initial value
export function useLocalStorage<Type = string>(
key: StorageKey<Type>,
): StorageState<Type>;
// impl
export function useLocalStorage<Type = string>(
key: StorageKey<Type>,
defaultValue?: Type,
): StorageState<Type> {
function convert(updated: string | undefined): Type | undefined {
if (updated === undefined) return defaultValue; //optional
try {
return key.codec.decode(JSON.parse(updated));
} catch (e) {
//decode error
return defaultValue;
}
}
const [storedValue, setStoredValue] = useState<Type | undefined>(
(): Type | undefined => {
const prev = storage.get(key.id);
return convert(prev);
},
);
useEffect(() => {
return storage.onUpdate(key.id, () => {
const newValue = storage.get(key.id);
setStoredValue(convert(newValue));
});
}, []);
const setValue = (value?: Type): void => {
if (value === undefined) {
storage.delete(key.id);
} else {
storage.set(
key.id,
key.codec ? JSON.stringify(value) : (value as string),
);
}
};
return {
value: storedValue,
update: setValue,
reset: () => {
setValue(defaultValue);
},
};
}
|
