-
-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add box * add readonlyBox * tests and use box internally * test value or box * prettier is dog-shit * update box * format * fix exports * update box once more * fix other examples * fix prettier * flatten and docs * format * fix lint * cleanup lint * not needed * update ci * PR changes --------- Co-authored-by: Hunter Johnston <[email protected]> Co-authored-by: AdrianGonz97 <[email protected]>
- Loading branch information
3 people
authored
Apr 25, 2024
1 parent
bdffcb7
commit 9787d92
Showing
22 changed files
with
1,269 additions
and
368 deletions.
There are no files selected for viewing
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,5 @@ | ||
| --- | ||
| "runed": minor | ||
| --- | ||
|
|
||
| add `box` utilities |
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 |
|---|---|---|
| @@ -1,8 +1,20 @@ | ||
| import config, { DEFAULT_IGNORES } from "@huntabyte/eslint-config"; | ||
|
|
||
| const CUSTOM_IGNORES = ["**/.github/**", "CHANGELOG.md", "**/.contentlayer"]; | ||
| const CUSTOM_IGNORES = [ | ||
| "**/.github/**", | ||
| "CHANGELOG.md", | ||
| "**/.contentlayer", | ||
| "**/node_modules/**", | ||
| "**/.svelte-kit/**", | ||
| ".svelte-kit/**/*", | ||
| "*.md", | ||
| ]; | ||
|
|
||
| export default config({ | ||
| svelte: true, | ||
| ignores: [...DEFAULT_IGNORES, ...CUSTOM_IGNORES], | ||
| }).override("antfu/typescript/rules", { | ||
| rules: { | ||
| "ts/consistent-type-definitions": "off", | ||
| }, | ||
| }); |
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 was deleted.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,192 @@ | ||
| import type { Expand, Getter } from "$lib/internal/types.js"; | ||
| import { isFunction, isObject } from "$lib/internal/utils/is.js"; | ||
|
|
||
| const BoxSymbol = Symbol("box"); | ||
| const isWritableSymbol = Symbol("is-writable"); | ||
|
|
||
| export interface ReadableBox<T> { | ||
| readonly [BoxSymbol]: true; | ||
| readonly value: T; | ||
| } | ||
|
|
||
| export interface WritableBox<T> extends ReadableBox<T> { | ||
| readonly [isWritableSymbol]: true; | ||
| value: T; | ||
| } | ||
|
|
||
| /** | ||
| * @returns Whether the value is a Box | ||
| */ | ||
| function isBox(value: unknown): value is ReadableBox<unknown> { | ||
| return isObject(value) && BoxSymbol in value; | ||
| } | ||
| /** | ||
| * @returns Whether the value is a WritableBox | ||
| */ | ||
| function isWritableBox(value: unknown): value is WritableBox<unknown> { | ||
| return box.isBox(value) && isWritableSymbol in value; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a writable box. | ||
| * | ||
| * @returns A box with a `value` property which can be set to a new value. | ||
| * Useful to pass state to other functions. | ||
| */ | ||
| export function box<T>(): WritableBox<T | undefined>; | ||
| /** | ||
| * Creates a writable box with an initial value. | ||
| * | ||
| * @param initialValue The initial value of the box. | ||
| * @returns A box with a `value` property which can be set to a new value. | ||
| * Useful to pass state to other functions. | ||
| */ | ||
| export function box<T>(initialValue: T): WritableBox<T>; | ||
| export function box(initialValue?: unknown) { | ||
| let value = $state(initialValue); | ||
|
|
||
| return { | ||
| [BoxSymbol]: true, | ||
| [isWritableSymbol]: true, | ||
| get value() { | ||
| return value as unknown; | ||
| }, | ||
| set value(v: unknown) { | ||
| value = v; | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a readonly box | ||
| * | ||
| * @param getter Function to get the value of the box | ||
| * @returns A box with a `value` property whose value is the result of the getter. | ||
| * Useful to pass state to other functions. | ||
| */ | ||
| function boxWith<T>(getter: () => T): ReadableBox<T>; | ||
| /** | ||
| * Creates a writable box | ||
| * | ||
| * @param getter Function to get the value of the box | ||
| * @param setter Function to set the value of the box | ||
| * @returns A box with a `value` property which can be set to a new value. | ||
| * Useful to pass state to other functions. | ||
| */ | ||
| function boxWith<T>(getter: () => T, setter: (v: T) => void): WritableBox<T>; | ||
| function boxWith<T>(getter: () => T, setter?: (v: T) => void) { | ||
| const derived = $derived.by(getter); | ||
|
|
||
| if (setter) { | ||
| return { | ||
| [BoxSymbol]: true, | ||
| [isWritableSymbol]: true, | ||
| get value() { | ||
| return derived; | ||
| }, | ||
| set value(v: T) { | ||
| setter(v); | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| return { | ||
| [BoxSymbol]: true, | ||
| get value() { | ||
| return getter(); | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| export type BoxFrom<T> = | ||
| T extends WritableBox<infer U> | ||
| ? WritableBox<U> | ||
| : T extends ReadableBox<infer U> | ||
| ? ReadableBox<U> | ||
| : T extends Getter<infer U> | ||
| ? ReadableBox<U> | ||
| : WritableBox<T>; | ||
|
|
||
| /** | ||
| * Creates a box from either a static value, a box, or a getter function. | ||
| * Useful when you want to receive any of these types of values and generate a boxed version of it. | ||
| * | ||
| * @returns A box with a `value` property whose value. | ||
| */ | ||
| function boxFrom<T>(value: T): BoxFrom<T> { | ||
| if (box.isBox(value)) return value as BoxFrom<T>; | ||
| if (isFunction(value)) return box.with(value) as BoxFrom<T>; | ||
| return box(value) as BoxFrom<T>; | ||
| } | ||
|
|
||
| type GetKeys<T, U> = { | ||
| [K in keyof T]: T[K] extends U ? K : never; | ||
| }[keyof T]; | ||
| type RemoveValues<T, U> = Omit<T, GetKeys<T, U>>; | ||
|
|
||
| type BoxFlatten<R extends Record<string, unknown>> = Expand< | ||
| RemoveValues< | ||
| { | ||
| [K in keyof R]: R[K] extends WritableBox<infer T> ? T : never; | ||
| }, | ||
| never | ||
| > & | ||
| RemoveValues< | ||
| { | ||
| readonly [K in keyof R]: R[K] extends WritableBox<infer _> | ||
| ? never | ||
| : R[K] extends ReadableBox<infer T> | ||
| ? T | ||
| : never; | ||
| }, | ||
| never | ||
| > | ||
| > & | ||
| RemoveValues< | ||
| { | ||
| [K in keyof R]: R[K] extends ReadableBox<infer _> ? never : R[K]; | ||
| }, | ||
| never | ||
| >; | ||
|
|
||
| /** | ||
| * Function that gets an object of boxes, and returns an object of reactive values | ||
| * | ||
| * @example | ||
| * const count = box(0) | ||
| * const flat = box.flatten({ count, double: box.with(() => count.value) }) | ||
| * // type of flat is { count: number, readonly double: number } | ||
| */ | ||
| function boxFlatten<R extends Record<string, unknown>>(boxes: R): BoxFlatten<R> { | ||
| return Object.entries(boxes).reduce<BoxFlatten<R>>((acc, [key, b]) => { | ||
| if (!box.isBox(b)) { | ||
| return Object.assign(acc, { [key]: b }); | ||
| } | ||
|
|
||
| if (box.isWritableBox(b)) { | ||
| Object.defineProperty(acc, key, { | ||
| get() { | ||
| return b.value; | ||
| }, | ||
| // eslint-disable-next-line ts/no-explicit-any | ||
| set(v: any) { | ||
| b.value = v; | ||
| }, | ||
| }); | ||
| } else { | ||
| Object.defineProperty(acc, key, { | ||
| get() { | ||
| return b.value; | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| return acc; | ||
| }, {} as BoxFlatten<R>); | ||
| } | ||
|
|
||
| box.from = boxFrom; | ||
| box.with = boxWith; | ||
| box.flatten = boxFlatten; | ||
| box.isBox = isBox; | ||
| box.isWritableBox = isWritableBox; |
Oops, something went wrong.