deno.land / x / solid@v1.5.6 / store / src / store.ts
نووسراو ببینە
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444import { getListener, batch, DEV, $PROXY, $TRACK, Accessor, createSignal } from "solid-js";export const $RAW = Symbol("store-raw"), $NODE = Symbol("store-node"), $NAME = Symbol("store-name");
export type StoreNode = Record<PropertyKey, any>;export namespace SolidStore { export interface Unwrappable {}}export type NotWrappable = | string | number | bigint | symbol | boolean | Function | null | undefined | SolidStore.Unwrappable[keyof SolidStore.Unwrappable];export type Store<T> = T;
function wrap<T extends StoreNode>(value: T, name?: string): T { let p = value[$PROXY]; if (!p) { Object.defineProperty(value, $PROXY, { value: (p = new Proxy(value, proxyTraps)) }); if (!Array.isArray(value)) { const keys = Object.keys(value), desc = Object.getOwnPropertyDescriptors(value); for (let i = 0, l = keys.length; i < l; i++) { const prop = keys[i]; if (desc[prop].get) { const get = desc[prop].get!.bind(p); Object.defineProperty(value, prop, { get }); } } } if ("_SOLID_DEV_" && name) Object.defineProperty(value, $NAME, { value: name }); } return p;}
export function isWrappable<T>(obj: T | NotWrappable): obj is T;export function isWrappable(obj: any) { let proto; return ( obj != null && typeof obj === "object" && (obj[$PROXY] || !(proto = Object.getPrototypeOf(obj)) || proto === Object.prototype || Array.isArray(obj)) );}
export function unwrap<T>(item: T, set?: Set<unknown>): T;export function unwrap<T>(item: any, set = new Set()): T { let result, unwrapped, v, prop; if ((result = item != null && item[$RAW])) return result; if (!isWrappable(item) || set.has(item)) return item;
if (Array.isArray(item)) { if (Object.isFrozen(item)) item = item.slice(0); else set.add(item); for (let i = 0, l = item.length; i < l; i++) { v = item[i]; if ((unwrapped = unwrap(v, set)) !== v) item[i] = unwrapped; } } else { if (Object.isFrozen(item)) item = Object.assign({}, item); else set.add(item); const keys = Object.keys(item), desc = Object.getOwnPropertyDescriptors(item); for (let i = 0, l = keys.length; i < l; i++) { prop = keys[i]; if ((desc as any)[prop].get) continue; v = item[prop]; if ((unwrapped = unwrap(v, set)) !== v) item[prop] = unwrapped; } } return item;}
export function getDataNodes(target: StoreNode) { let nodes = target[$NODE]; if (!nodes) Object.defineProperty(target, $NODE, { value: (nodes = {}) }); return nodes;}
export function getDataNode(nodes: Record<string, any>, property: string | symbol, value: any) { return nodes[property as string] || (nodes[property as string] = createDataNode(value));}
export function proxyDescriptor(target: StoreNode, property: PropertyKey) { const desc = Reflect.getOwnPropertyDescriptor(target, property); if ( !desc || desc.get || !desc.configurable || property === $PROXY || property === $NODE || property === $NAME ) return desc; delete desc.value; delete desc.writable; desc.get = () => target[$PROXY][property]; return desc;}
export function trackSelf(target: StoreNode) { if (getListener()) { const nodes = getDataNodes(target); (nodes._ || (nodes._ = createDataNode()))(); }}
export function ownKeys(target: StoreNode) { trackSelf(target); return Reflect.ownKeys(target);}
function createDataNode(value?: any) { const [s, set] = createSignal<any>(value, { equals: false, internal: true }); (s as Accessor<any> & { $: (v: any) => void }).$ = set; return s as Accessor<any> & { $: (v: any) => void };}
const proxyTraps: ProxyHandler<StoreNode> = { get(target, property, receiver) { if (property === $RAW) return target; if (property === $PROXY) return receiver; if (property === $TRACK) { trackSelf(target); return receiver; } const nodes = getDataNodes(target); const tracked = nodes.hasOwnProperty(property); let value = tracked ? nodes[property]() : target[property]; if (property === $NODE || property === "__proto__") return value;
if (!tracked) { const desc = Object.getOwnPropertyDescriptor(target, property); if ( getListener() && (typeof value !== "function" || target.hasOwnProperty(property)) && !(desc && desc.get) ) value = getDataNode(nodes, property, value)(); } return isWrappable(value) ? wrap(value, "_SOLID_DEV_" && target[$NAME] && `${target[$NAME]}:${property.toString()}`) : value; },
has(target, property) { if (property === $RAW || property === $PROXY || property === $TRACK || property === $NODE || property === "__proto__") return true; const tracked = getDataNodes(target)[property]; tracked && tracked(); return property in target; },
set() { if ("_SOLID_DEV_") console.warn("Cannot mutate a Store directly"); return true; },
deleteProperty() { if ("_SOLID_DEV_") console.warn("Cannot mutate a Store directly"); return true; },
ownKeys: ownKeys,
getOwnPropertyDescriptor: proxyDescriptor};
export function setProperty(state: StoreNode, property: PropertyKey, value: any, deleting: boolean = false) { if (!deleting && state[property] === value) return; const prev = state[property]; const len = state.length; if (value === undefined) { delete state[property]; } else state[property] = value; let nodes = getDataNodes(state), node; if ((node = getDataNode(nodes, property as string, prev))) node.$(() => value);
if (Array.isArray(state) && state.length !== len) (node = getDataNode(nodes, "length", len)) && node.$(state.length); (node = nodes._) && node.$();}
function mergeStoreNode(state: StoreNode, value: Partial<StoreNode>) { const keys = Object.keys(value); for (let i = 0; i < keys.length; i += 1) { const key = keys[i]; setProperty(state, key, value[key]); }}
function updateArray( current: StoreNode, next: Array<any> | Record<string, any> | ((prev: StoreNode) => Array<any> | Record<string, any>)) { if (typeof next === "function") next = next(current); next = unwrap(next) as Array<any> | Record<string, any>; if (Array.isArray(next)) { if (current === next) return; let i = 0, len = next.length; for (; i < len; i++) { const value = next[i]; if (current[i] !== value) setProperty(current, i, value); } setProperty(current, "length", len); } else mergeStoreNode(current, next);}
export function updatePath(current: StoreNode, path: any[], traversed: PropertyKey[] = []) { let part, prev = current; if (path.length > 1) { part = path.shift(); const partType = typeof part, isArray = Array.isArray(current);
if (Array.isArray(part)) { // Ex. update('data', [2, 23], 'label', l => l + ' !!!'); for (let i = 0; i < part.length; i++) { updatePath(current, [part[i]].concat(path), traversed); } return; } else if (isArray && partType === "function") { // Ex. update('data', i => i.id === 42, 'label', l => l + ' !!!'); for (let i = 0; i < current.length; i++) { if (part(current[i], i)) updatePath(current, [i].concat(path), traversed); } return; } else if (isArray && partType === "object") { // Ex. update('data', { from: 3, to: 12, by: 2 }, 'label', l => l + ' !!!'); const { from = 0, to = current.length - 1, by = 1 } = part; for (let i = from; i <= to; i += by) { updatePath(current, [i].concat(path), traversed); } return; } else if (path.length > 1) { updatePath(current[part], path, [part].concat(traversed)); return; } prev = current[part]; traversed = [part].concat(traversed); } let value = path[0]; if (typeof value === "function") { value = value(prev, traversed); if (value === prev) return; } if (part === undefined && value == undefined) return; value = unwrap(value); if (part === undefined || (isWrappable(prev) && isWrappable(value) && !Array.isArray(value))) { mergeStoreNode(prev, value); } else setProperty(current, part, value);}
/** @deprecated */export type DeepReadonly<T> = 0 extends 1 & T ? T : T extends NotWrappable ? T : { readonly [K in keyof T]: DeepReadonly<T[K]>; };/** @deprecated */export type DeepMutable<T> = 0 extends 1 & T ? T : T extends NotWrappable ? T : { -readonly [K in keyof T]: DeepMutable<T[K]>; };
export type CustomPartial<T> = T extends readonly unknown[] ? "0" extends keyof T ? { [K in Extract<keyof T, `${number}`>]?: T[K] } : { [x: number]: T[number] } : Partial<T>;
export type StorePathRange = { from?: number; to?: number; by?: number };
export type ArrayFilterFn<T> = (item: T, index: number) => boolean;
export type StoreSetter<T, U extends PropertyKey[] = []> = | ((prevState: T, traversed: U) => T | CustomPartial<T>) | T | CustomPartial<T>;
export type Part<T, K extends KeyOf<T> = KeyOf<T>> = | K | ([K] extends [never] ? never : readonly K[]) | ([T] extends [readonly unknown[]] ? ArrayFilterFn<T[number]> | StorePathRange : never);
// shortcut to avoid writing `Exclude<T, NotWrappable>` too many timestype W<T> = Exclude<T, NotWrappable>;
// specially handle keyof to avoid errors with arrays and anytype KeyOf<T> = number extends keyof T // have to check this otherwise ts won't allow KeyOf<T> to index T ? 0 extends 1 & T // if it's any just return keyof T ? keyof T : [T] extends [readonly unknown[]] ? number // it's an array or tuple; exclude the non-number properties : [T] extends [never] ? never // keyof never is PropertyKey which number extends; return never : keyof T // it's something which contains an index signature for strings or numbers : keyof T;
type Rest<T, U extends PropertyKey[]> = | [StoreSetter<T, U>] | (0 extends 1 & T ? [...Part<any>[], StoreSetter<any, PropertyKey[]>] : DistributeRest<W<T>, KeyOf<W<T>>, U>);// need a second type to distribute `K`type DistributeRest<T, K, U extends PropertyKey[]> = [T] extends [never] ? never : K extends KeyOf<T> ? [Part<T, K>, ...Rest<T[K], [K, ...U]>] : never;
export interface SetStoreFunction<T> { < K1 extends KeyOf<W<T>>, K2 extends KeyOf<W<W<T>[K1]>>, K3 extends KeyOf<W<W<W<T>[K1]>[K2]>>, K4 extends KeyOf<W<W<W<W<T>[K1]>[K2]>[K3]>>, K5 extends KeyOf<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>>, K6 extends KeyOf<W<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>[K5]>>, K7 extends KeyOf<W<W<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>[K5]>[K6]>> >( k1: Part<W<T>, K1>, k2: Part<W<W<T>[K1]>, K2>, k3: Part<W<W<W<T>[K1]>[K2]>, K3>, k4: Part<W<W<W<W<T>[K1]>[K2]>[K3]>, K4>, k5: Part<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>, K5>, k6: Part<W<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>[K5]>, K6>, k7: Part<W<W<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>[K5]>[K6]>, K7>, ...rest: Rest<W<W<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>[K5]>[K6]>[K7], [K7, K6, K5, K4, K3, K2, K1]> ): void; < K1 extends KeyOf<W<T>>, K2 extends KeyOf<W<W<T>[K1]>>, K3 extends KeyOf<W<W<W<T>[K1]>[K2]>>, K4 extends KeyOf<W<W<W<W<T>[K1]>[K2]>[K3]>>, K5 extends KeyOf<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>>, K6 extends KeyOf<W<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>[K5]>> >( k1: Part<W<T>, K1>, k2: Part<W<W<T>[K1]>, K2>, k3: Part<W<W<W<T>[K1]>[K2]>, K3>, k4: Part<W<W<W<W<T>[K1]>[K2]>[K3]>, K4>, k5: Part<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>, K5>, k6: Part<W<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>[K5]>, K6>, setter: StoreSetter<W<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>[K5]>[K6], [K6, K5, K4, K3, K2, K1]> ): void; < K1 extends KeyOf<W<T>>, K2 extends KeyOf<W<W<T>[K1]>>, K3 extends KeyOf<W<W<W<T>[K1]>[K2]>>, K4 extends KeyOf<W<W<W<W<T>[K1]>[K2]>[K3]>>, K5 extends KeyOf<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>> >( k1: Part<W<T>, K1>, k2: Part<W<W<T>[K1]>, K2>, k3: Part<W<W<W<T>[K1]>[K2]>, K3>, k4: Part<W<W<W<W<T>[K1]>[K2]>[K3]>, K4>, k5: Part<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>, K5>, setter: StoreSetter<W<W<W<W<W<T>[K1]>[K2]>[K3]>[K4]>[K5], [K5, K4, K3, K2, K1]> ): void; < K1 extends KeyOf<W<T>>, K2 extends KeyOf<W<W<T>[K1]>>, K3 extends KeyOf<W<W<W<T>[K1]>[K2]>>, K4 extends KeyOf<W<W<W<W<T>[K1]>[K2]>[K3]>> >( k1: Part<W<T>, K1>, k2: Part<W<W<T>[K1]>, K2>, k3: Part<W<W<W<T>[K1]>[K2]>, K3>, k4: Part<W<W<W<W<T>[K1]>[K2]>[K3]>, K4>, setter: StoreSetter<W<W<W<W<T>[K1]>[K2]>[K3]>[K4], [K4, K3, K2, K1]> ): void; <K1 extends KeyOf<W<T>>, K2 extends KeyOf<W<W<T>[K1]>>, K3 extends KeyOf<W<W<W<T>[K1]>[K2]>>>( k1: Part<W<T>, K1>, k2: Part<W<W<T>[K1]>, K2>, k3: Part<W<W<W<T>[K1]>[K2]>, K3>, setter: StoreSetter<W<W<W<T>[K1]>[K2]>[K3], [K3, K2, K1]> ): void; <K1 extends KeyOf<W<T>>, K2 extends KeyOf<W<W<T>[K1]>>>( k1: Part<W<T>, K1>, k2: Part<W<W<T>[K1]>, K2>, setter: StoreSetter<W<W<T>[K1]>[K2], [K2, K1]> ): void; <K1 extends KeyOf<W<T>>>(k1: Part<W<T>, K1>, setter: StoreSetter<W<T>[K1], [K1]>): void; (setter: StoreSetter<T, []>): void;}
/** * creates a reactive store that can be read through a proxy object and written with a setter function * * @description https://www.solidjs.com/docs/latest/api#createstore */export function createStore<T extends object = {}>( ...[store, options]: {} extends T ? [store?: T | Store<T>, options?: { name?: string }] : [store: T | Store<T>, options?: { name?: string }]): [get: Store<T>, set: SetStoreFunction<T>] { const unwrappedStore = unwrap((store || {}) as T); const isArray = Array.isArray(unwrappedStore); if ("_SOLID_DEV_" && typeof unwrappedStore !== "object" && typeof unwrappedStore !== "function") throw new Error( `Unexpected type ${typeof unwrappedStore} received when initializing 'createStore'. Expected an object.` ); const wrappedStore = wrap( unwrappedStore, "_SOLID_DEV_" && ((options && options.name) || DEV.hashValue(unwrappedStore)) ); if ("_SOLID_DEV_") { const name = (options && options.name) || DEV.hashValue(unwrappedStore); DEV.registerGraph(name, { value: unwrappedStore }); } function setStore(...args: any[]): void { batch(() => { isArray && args.length === 1 ? updateArray(unwrappedStore, args[0]) : updatePath(unwrappedStore, args); }); }
return [wrappedStore, setStore];}
solid
Version Info
a year ago
