/*
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
*/
/**
*
* @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 = (function buildStorage() {
if (supportBrowserStorage) {
return browserStorageMap(memoryMap());
} else if (supportLocalStorage) {
return localStorageMap();
} else {
return memoryMap();
}
})();
export function useLocalStorage(
key: string,
initialValue: string,
): Required;
export function useLocalStorage(key: string): LocalStorageState;
export function useLocalStorage(
key: string,
initialValue?: string,
): LocalStorageState {
const [storedValue, setStoredValue] = useState(
(): 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) {
storage.delete(key);
} else {
storage.set(key, value);
}
};
return {
value: storedValue,
update: setValue,
reset: () => {
setValue(initialValue);
},
};
}