From be27647ff73d1529372a80c3e145f3ee4f229a17 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Fri, 26 May 2023 16:51:47 -0300 Subject: use buildKeyStorage to prevent different type for same key --- packages/web-util/src/hooks/index.ts | 2 +- packages/web-util/src/hooks/useLang.ts | 12 +++-- packages/web-util/src/hooks/useLocalStorage.ts | 70 ++++++++++++++----------- packages/web-util/src/hooks/useMemoryStorage.ts | 60 ++++++++++----------- 4 files changed, 77 insertions(+), 67 deletions(-) (limited to 'packages/web-util') diff --git a/packages/web-util/src/hooks/index.ts b/packages/web-util/src/hooks/index.ts index ae8872497..a3a2053e6 100644 --- a/packages/web-util/src/hooks/index.ts +++ b/packages/web-util/src/hooks/index.ts @@ -1,5 +1,5 @@ export { useLang } from "./useLang.js"; -export { useLocalStorage } from "./useLocalStorage.js"; +export { useLocalStorage, buildStorageKey } from "./useLocalStorage.js"; export { useMemoryStorage } from "./useMemoryStorage.js"; export { useNotifications, diff --git a/packages/web-util/src/hooks/useLang.ts b/packages/web-util/src/hooks/useLang.ts index d64cf6e1a..448cd8aba 100644 --- a/packages/web-util/src/hooks/useLang.ts +++ b/packages/web-util/src/hooks/useLang.ts @@ -14,7 +14,11 @@ GNU Anastasis; see the file COPYING. If not, see */ -import { LocalStorageState, useLocalStorage } from "./useLocalStorage.js"; +import { + StorageState, + buildStorageKey, + useLocalStorage, +} from "./useLocalStorage.js"; function getBrowserLang(): string | undefined { if (typeof window === "undefined") return undefined; @@ -23,7 +27,9 @@ function getBrowserLang(): string | undefined { return undefined; } -export function useLang(initial?: string): Required { +const langPreferenceKey = buildStorageKey("lang-preference"); + +export function useLang(initial?: string): Required { const defaultValue = (getBrowserLang() || initial || "en").substring(0, 2); - return useLocalStorage("lang-preference", { defaultValue: defaultValue }); + return useLocalStorage(langPreferenceKey, defaultValue); } diff --git a/packages/web-util/src/hooks/useLocalStorage.ts b/packages/web-util/src/hooks/useLocalStorage.ts index 55efd01cb..45b7abd3c 100644 --- a/packages/web-util/src/hooks/useLocalStorage.ts +++ b/packages/web-util/src/hooks/useLocalStorage.ts @@ -19,7 +19,7 @@ * @author Sebastian Javier Marchano (sebasjm) */ -import { Codec } from "@gnu-taler/taler-util"; +import { Codec, codecForString } from "@gnu-taler/taler-util"; import { useEffect, useState } from "preact/hooks"; import { ObservableMap, @@ -28,7 +28,26 @@ import { memoryMap, } from "../utils/observable.js"; -export interface LocalStorageState { +declare const opaque_StorageKey: unique symbol; + +export type StorageKey = { + id: string; + [opaque_StorageKey]: true; + codec: Codec; +}; + +export function buildStorageKey( + name: string, + codec?: Codec, +): StorageKey { + return { + id: name, + codec: codec ?? (codecForString() as Codec), + [opaque_StorageKey]: true, + }; +} + +export interface StorageState { value?: Type; update: (s: Type) => void; reset: () => void; @@ -50,59 +69,48 @@ const storage: ObservableMap = (function buildStorage() { //with initial value export function useLocalStorage( - key: string, - options?: { - defaultValue: Type; - codec?: Codec; - }, -): Required>; + key: StorageKey, + defaultValue: Type, +): Required>; //without initial value export function useLocalStorage( - key: string, - options?: { - codec?: Codec; - }, -): LocalStorageState; + key: StorageKey, +): StorageState; // impl export function useLocalStorage( - key: string, - options?: { - defaultValue?: Type; - codec?: Codec; - }, -): LocalStorageState { + key: StorageKey, + defaultValue?: Type, +): StorageState { function convert(updated: string | undefined): Type | undefined { - if (updated === undefined) return options?.defaultValue; //optional + if (updated === undefined) return defaultValue; //optional try { - return !options?.codec - ? (updated as Type) - : options.codec.decode(JSON.parse(updated)); + return key.codec.decode(JSON.parse(updated)); } catch (e) { //decode error - return options?.defaultValue; + return defaultValue; } } const [storedValue, setStoredValue] = useState( (): Type | undefined => { - const prev = storage.get(key); + const prev = storage.get(key.id); return convert(prev); }, ); useEffect(() => { - return storage.onUpdate(key, () => { - const newValue = storage.get(key); + 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); + storage.delete(key.id); } else { storage.set( - key, - options?.codec ? JSON.stringify(value) : (value as string), + key.id, + key.codec ? JSON.stringify(value) : (value as string), ); } }; @@ -111,7 +119,7 @@ export function useLocalStorage( value: storedValue, update: setValue, reset: () => { - setValue(options?.defaultValue); + setValue(defaultValue); }, }; } diff --git a/packages/web-util/src/hooks/useMemoryStorage.ts b/packages/web-util/src/hooks/useMemoryStorage.ts index 7160b035e..d8be24c1e 100644 --- a/packages/web-util/src/hooks/useMemoryStorage.ts +++ b/packages/web-util/src/hooks/useMemoryStorage.ts @@ -20,48 +20,44 @@ */ import { useEffect, useState } from "preact/hooks"; -import { - ObservableMap, - browserStorageMap, - localStorageMap, - memoryMap, -} from "../utils/observable.js"; +import { ObservableMap, memoryMap } from "../utils/observable.js"; +import { StorageKey, StorageState } from "./useLocalStorage.js"; -export interface LocalStorageState { - value?: string; - update: (s: string) => void; - reset: () => void; -} - -const storage: ObservableMap = memoryMap(); +const storage: ObservableMap = memoryMap(); -export function useMemoryStorage( - key: string, - initialValue: string, -): Required; -export function useMemoryStorage(key: string): LocalStorageState; -export function useMemoryStorage( - key: string, - initialValue?: string, -): LocalStorageState { - const [storedValue, setStoredValue] = useState( - (): string | undefined => { - return storage.get(key) ?? initialValue; +//with initial value +export function useMemoryStorage( + key: StorageKey, + defaultValue: Type, +): Required>; +//with initial value +export function useMemoryStorage( + key: StorageKey, +): StorageState; +// impl +export function useMemoryStorage( + key: StorageKey, + defaultValue?: Type, +): StorageState { + const [storedValue, setStoredValue] = useState( + (): Type | undefined => { + const prev = storage.get(key.id); + return prev; }, ); useEffect(() => { - return storage.onUpdate(key, () => { - const newValue = storage.get(key); - setStoredValue(newValue ?? initialValue); + return storage.onUpdate(key.id, () => { + const newValue = storage.get(key.id); + setStoredValue(newValue); }); }, []); - const setValue = (value?: string): void => { + const setValue = (value?: Type): void => { if (value === undefined) { - storage.delete(key); + storage.delete(key.id); } else { - storage.set(key, value); + storage.set(key.id, value); } }; @@ -69,7 +65,7 @@ export function useMemoryStorage( value: storedValue, update: setValue, reset: () => { - setValue(initialValue); + setValue(defaultValue); }, }; } -- cgit v1.2.3