-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve handling of localStorage and svelte stores
Also moving the svelte-stored-writable package into the repo. So we have it closer for maintenance, we can eventually rewrite it in svelte 5 runes later. Reference: efstajas/svelte-stored-writable#5
- Loading branch information
1 parent
bd02c85
commit 023c0ec
Showing
7 changed files
with
148 additions
and
87 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| import type { SafeParseReturnType } from "zod"; | ||
| import type { Writable } from "svelte/store"; | ||
|
|
||
| import { writable, get } from "svelte/store"; | ||
| import { z } from "zod"; | ||
|
|
||
| type Equals<X, Y> = | ||
| (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 | ||
| ? true | ||
| : false; | ||
|
|
||
| /** | ||
| * An extension of Svelte's `writable` that also saves its state to localStorage and | ||
| * automatically restores it. | ||
| * @param key The localStorage key to use for saving the writable's contents. | ||
| * @param schema A Zod schema describing the contents of the writable. | ||
| * @param initialValue The initial value to use if no prior state has been saved in | ||
| * localstorage. | ||
| * @param disableLocalStorage Skip interaction with localStorage, for example during SSR. | ||
| * @returns A stored writable. | ||
| */ | ||
| export default function storedWritable< | ||
| S extends z.infer<T>, | ||
| T extends z.ZodType = z.ZodType<S>, | ||
| >( | ||
| key: string, | ||
| schema: T, | ||
| initialValue: z.infer<typeof schema>, | ||
| disableLocalStorage = false, | ||
| ): Writable< | ||
| Equals<T, typeof schema> extends true ? S : z.infer<typeof schema> | ||
| > & { clear: () => void } { | ||
| const stored = !disableLocalStorage ? localStorage.getItem(key) : null; | ||
|
|
||
| const parseFromJson = ( | ||
| content: string, | ||
| ): SafeParseReturnType<string, T["_output"]> => { | ||
| return z | ||
| .string() | ||
| .transform((_, ctx) => { | ||
| try { | ||
| return JSON.parse(content); | ||
| } catch { | ||
| ctx.addIssue({ | ||
| code: z.ZodIssueCode.custom, | ||
| message: "invalid json", | ||
| }); | ||
| return z.never; | ||
| } | ||
| }) | ||
| .pipe(schema) | ||
| .safeParse(content); | ||
| }; | ||
|
|
||
| // Subscribe to window storage event to keep changes from another tab in sync. | ||
| if (!disableLocalStorage) { | ||
| window?.addEventListener("storage", event => { | ||
| if (event.key === key) { | ||
| if (event.newValue === null) { | ||
| w.set(initialValue); | ||
| return; | ||
| } | ||
|
|
||
| const { success, data } = parseFromJson(event.newValue); | ||
| w.set(success ? data : initialValue); | ||
| } | ||
| }); | ||
| } | ||
| const parsed = parseFromJson(stored || initialValue); | ||
| const w = writable<S>(parsed?.success ? parsed.data : initialValue); | ||
|
|
||
| /** | ||
| * Set writable value and inform subscribers. Updates the writeable's stored data in | ||
| * localstorage. | ||
| * */ | ||
| function set(...args: Parameters<typeof w.set>) { | ||
| w.set(...args); | ||
| if (!disableLocalStorage) localStorage.setItem(key, JSON.stringify(get(w))); | ||
| } | ||
|
|
||
| /** | ||
| * Update writable value using a callback and inform subscribers. Updates the writeable's | ||
| * stored data in localstorage. | ||
| * */ | ||
| function update(...args: Parameters<typeof w.update>) { | ||
| w.update(...args); | ||
| if (!disableLocalStorage) localStorage.setItem(key, JSON.stringify(get(w))); | ||
| } | ||
|
|
||
| /** | ||
| * Delete any data saved for this StoredWritable in localstorage. | ||
| */ | ||
| function clear() { | ||
| w.set(initialValue); | ||
| localStorage.removeItem(key); | ||
| } | ||
|
|
||
| return { | ||
| subscribe: w.subscribe, | ||
| set, | ||
| update, | ||
| clear, | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters