@legendapp/state 3.0.0-alpha.29 → 3.0.0-alpha.30

package/index.d.mts

@@ -1,282 +1,5 @@
-type Primitive$1 = string | number | boolean | symbol | bigint | undefined | null | Date;
-type ArrayOverrideFnNames = 'find' | 'findIndex' | 'every' | 'some' | 'filter' | 'reduce' | 'reduceRight' | 'forEach' | 'map' | 'sort';
-type RemoveIndex<T> = {
-    [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K];
-};
-type BuiltIns = String | Boolean | Number | Date | Error | RegExp | Array<any> | Function | Promise<any>;
-type IsUserDefinedObject<T> = T extends Function | BuiltIns | any[] ? false : T extends object ? true : false;
-type RemoveObservables<T> = T extends ImmutableObservableBase<infer t> ? t : T extends ImmutableObservableBase<infer t>[] ? t[] : IsUserDefinedObject<T> extends true ? {
-    [K in keyof T]: RemoveObservables<T[K]>;
-} : T extends ImmutableObservableBase<infer TObs> ? TObs : T extends () => infer TRet ? RemoveObservables<TRet> & T : T extends (key: infer TKey extends string | number) => infer TRet ? Record<TKey, RemoveObservables<TRet>> & T : T;
-interface ObservableArray<T, U> extends ObservablePrimitive<T>, Pick<Array<Observable<U>>, ArrayOverrideFnNames>, Omit<RemoveIndex<Array<U>>, ArrayOverrideFnNames> {
-}
-interface ObservableObjectFns<T> {
-    assign(value: Partial<T>): Observable<T>;
-}
-interface ObservableObjectFunctions<T = Record<string, any>> extends ObservablePrimitive<T>, ObservableObjectFns<T> {
-}
-type MapKey<T extends Map<any, any> | WeakMap<any, any>> = Parameters<T['has']>[0];
-type MapValue<T extends Map<any, any> | WeakMap<any, any>> = ReturnType<T['get']>;
-type ObservableMap<T extends Map<any, any> | WeakMap<any, any>> = Omit<T, 'get' | 'size' | 'set'> & Omit<ObservablePrimitive<T>, 'get' | 'size'> & {
-    get(key: Parameters<T['get']>[0]): Observable<Parameters<T['set']>[1]>;
-    get(): T;
-    size: number;
-    set(key: MapKey<T>, value: MapValue<T>): Observable<T>;
-    assign(value: Record<MapKey<T>, MapValue<T>> | Map<MapKey<T>, MapValue<T>> | WeakMap<MapKey<T>, MapValue<T>>): Observable<T>;
-};
-type SetValue<T extends Set<any> | WeakSet<any>> = Parameters<T['has']>[0];
-type ObservableSet<T extends Set<any> | WeakSet<any>> = Omit<T, 'size' | 'add'> & Omit<ObservablePrimitive<T>, 'size'> & {
-    size: number;
-    add: (value: SetValue<T>) => Observable<T>;
-};
-interface ObservableBoolean extends ObservablePrimitive<boolean> {
-    toggle(): void;
-}
-interface ObservablePrimitive<T> extends ImmutableObservableBase<T>, MutableObservableBase<T> {
-}
-type ObservableAny = Partial<ObservableObjectFns<any>> & ObservablePrimitive<any> & Record<string, any>;
-interface ImmutableObservableSimple<T> {
-    peek(): T;
-    get(trackingType?: any): any;
-    onChange(cb: ListenerFn<any>, options?: any): () => void;
-}
-interface ImmutableObservableBase<T> extends ImmutableObservableSimple<T> {
-    peek(): RemoveObservables<T>;
-    peek(): T;
-    get(trackingType?: TrackingType | GetOptions): RemoveObservables<T>;
-    onChange(cb: ListenerFn<T>, options?: {
-        trackingType?: TrackingType;
-        initial?: boolean;
-        immediate?: boolean;
-        noArgs?: boolean;
-    }): () => void;
-}
-interface MutableObservableSimple {
-    set(value: any): void;
-    delete(): void;
-}
-interface MutableObservableBase<T> extends MutableObservableSimple {
-    set(value: (prev: RemoveObservables<T>) => RemoveObservables<T>): void;
-    set(value: RecursiveValueOrFunction<T>): void;
-    set(value: Promise<RemoveObservables<T>>): void;
-    set(value: RemoveObservables<T>): void;
-    set(value: Observable<RemoveObservables<T>>): void;
-    delete(): void;
-}
-type UndefinedIf<T, U> = U extends true ? T | undefined : T;
-type IsNullable<T> = undefined extends T ? true : null extends T ? true : false;
-type NonObservable = Function | Observable;
-type NonObservableKeys<T> = {
-    [K in keyof T]-?: IsStrictAny<T[K]> extends true ? never : T[K] extends undefined | null ? never : NonNullable<T[K]> extends NonObservable ? K : never;
-}[keyof T];
-type ObservableProps<T> = NonObservableKeys<NonNullable<T>> extends never ? T : RestoreNullability<T, Omit<NonNullable<T>, NonObservableKeys<NonNullable<T>>>>;
-type NonObservableProps<T> = RestoreNullability<T, NullablePropsIf<Pick<NonNullable<T>, NonObservableKeys<NonNullable<T>>>, IsNullable<T>>>;
-type NullablePropsIf<T, U> = {
-    [K in keyof T]: UndefinedIf<T[K], U>;
-};
-type RestoreNullability<Source, Target> = IsNullable<Source> extends true ? Target | Extract<Source, null | undefined> : Target;
-type ObservableChildren<T, Nullable = IsNullable<T>> = {
-    [K in keyof T]-?: Observable<UndefinedIf<T[K], Nullable>>;
-};
-type ObservableFunctionChildren<T> = {
-    [K in keyof T]-?: T[K] extends Observable ? T[K] : T[K] extends (key: infer Key extends string | number) => Promise<infer t> | infer t ? IsLookupFunction<T[K]> extends true ? Observable<Record<Key, t>> & T[K] : t extends void ? T[K] : t extends Observable ? t : Observable<t> & (() => t) : T[K] & Observable<T[K]>;
-};
-type IsStrictAny<T> = 0 extends 1 & T ? true : false;
-type ObservableObject<T> = ObservableObjectFunctions<ObservableProps<T> & NonObservableProps<T>> & ObservableChildren<ObservableProps<T>> & ObservableFunctionChildren<NonObservableProps<T>>;
-type ObservableFunction<T> = T extends () => infer t ? t | (() => t) : T;
-type IsLookupFunction<T> = T extends (...args: infer P) => any ? P extends {
-    length: 1;
-} ? P[0] extends string | ObservablePrimitive<string> | number | ObservablePrimitive<number> ? true : false : false : false;
-type ObservableNode<T, NT = NonNullable<T>> = [NT] extends [never] ? ObservablePrimitive<T> : IsStrictAny<T> extends true ? ObservableAny : [T] extends [Promise<infer t>] ? ObservableNode<t> : [T] extends [(key: infer K extends string) => infer t] ? [t] extends [ImmutableObservableBase<any>] ? IsLookupFunction<T> extends true ? Observable<Record<K, t>> : t : IsLookupFunction<T> extends true ? Observable<Record<K, t>> & T : Observable<ObservableFunction<t>> : [NT] extends [ImmutableObservableBase<any>] ? NT : [NT] extends [Primitive$1] ? [NT] extends [boolean] ? ObservableBoolean : ObservablePrimitive<T> : NT extends Map<any, any> | WeakMap<any, any> ? ObservableMap<NT> : NT extends Set<infer U> ? ObservableSet<Set<UndefinedIf<U, IsNullable<T>>>> : NT extends WeakSet<any> ? ObservableSet<NT> : NT extends Array<infer U> ? ObservableArray<T, U> & ObservableChildren<T> : ObservableObject<T> & {};
-type Observable<T = any> = ObservableNode<T> & {};
-type ObservableParam<T = any> = ImmutableObservableSimple<T> & MutableObservableSimple;
-type FixExpanded<T> = [T] extends [boolean] ? boolean : T;
-type ValueOrFunction<T> = [T] extends [Function] ? T : T | ImmutableObservableBase<FixExpanded<T> | T> | Promise<FixExpanded<T> | T> | (() => FixExpanded<T> | T | Promise<FixExpanded<T> | T> | ImmutableObservableBase<FixExpanded<T> | T>);
-type ValueOrFunctionKeys<T> = {
-    [K in keyof T]: RecursiveValueOrFunction<T[K]>;
-};
-type RecursiveValueOrFunction<T> = T extends Function ? T : T extends object ? ((key: string) => any) | Promise<ValueOrFunctionKeys<T>> | ValueOrFunctionKeys<T> | ImmutableObservableBase<T> | (() => T | Promise<T> | ValueOrFunctionKeys<T> | Promise<ValueOrFunctionKeys<T>> | Observable<T>) : ValueOrFunction<T>;
-
-declare const symbolOpaque: unique symbol;
-declare function getPathType(value: any): TypeAtPath;
-declare function safeStringify(value: any): any;
-declare function safeParse(value: any): any;
-declare function clone<T>(value: T): any;
-declare function isObservable(value$: any): value$ is Observable;
-declare function getNode(value$: ObservableParam): NodeInfo;
-declare function setNodeValue(node: NodeInfo, newValue: any): {
-    prevValue: any;
-    newValue: any;
-};
-declare function getNodeValue(node: NodeInfo): any;
-declare function ensureNodeValue(node: NodeInfo): any;
-declare function findIDKey(obj: unknown | undefined, node: NodeInfo): string | ((value: any) => string) | undefined;
-
-type TrackingType = undefined | true | symbol;
-interface GetOptions {
-    shallow: boolean;
-}
-type OpaqueObject<T> = T & {
-    [symbolOpaque]: true;
-};
-interface ListenerParams<T = any> {
-    value: T;
-    getPrevious: () => T;
-    changes: Change[];
-    isFromSync: boolean;
-    isFromPersist: boolean;
-}
-type ListenerFn<T = any> = (params: ListenerParams<T>) => void;
-interface ObservableEvent {
-    fire(): void;
-    on(cb?: () => void): ObservableListenerDispose;
-    get(): void;
-}
-type TypeAtPath = 'object' | 'array' | 'map' | 'set';
-interface Change {
-    path: string[];
-    pathTypes: TypeAtPath[];
-    valueAtPath: any;
-    prevAtPath: any;
-}
-type RecordValue<T> = T extends Record<string, infer t> ? t : never;
-type ArrayValue<T> = T extends Array<infer t> ? t : never;
-type ObservableValue<T> = T extends Observable<infer t> ? t : never;
-type Selector<T> = ObservableParam<T> | ObservableEvent | (() => T) | T;
-type ClassConstructor<I, Args extends any[] = any[]> = new (...args: Args) => I;
-type ObservableListenerDispose = () => void;
-interface ObservableRoot {
-    _: any;
-    set?: (value: any) => void;
-}
-type Primitive = boolean | string | number | Date;
-type NotPrimitive<T> = T extends Primitive ? never : T;
-interface NodeListener {
-    track: TrackingType;
-    noArgs?: boolean;
-    listener: ListenerFn;
-}
-interface TrackingState {
-    nodes?: Map<NodeInfo, TrackingNode>;
-    traceListeners?: (nodes: Map<NodeInfo, TrackingNode>) => void;
-    traceUpdates?: (fn: Function) => Function;
-}
-interface BaseNodeInfo {
-    children?: Map<string, ChildNodeInfo>;
-    proxy?: object;
-    root: ObservableRoot;
-    listeners?: Set<NodeListener>;
-    listenersImmediate?: Set<NodeListener>;
-    isEvent?: boolean;
-    linkedToNode?: NodeInfo;
-    linkedToNodeDispose?: () => void;
-    activatedObserveDispose?: () => void;
-    linkedFromNodes?: Set<NodeInfo>;
-    isSetting?: number;
-    isAssigning?: number;
-    isComputing?: boolean;
-    parentOther?: NodeInfo;
-    functions?: Map<string, Function | Observable<any>>;
-    lazy?: boolean;
-    lazyFn?: Function;
-    needsExtract?: boolean;
-    numListenersRecursive: number;
-    state?: Observable<ObservableSyncState>;
-    activated?: boolean;
-    recursivelyAutoActivated?: boolean;
-    activationState?: LinkedOptions & {
-        onError?: () => void;
-        onChange: (params: UpdateFnParams) => void | Promise<void>;
-    };
-    dirtyFn?: () => void;
-    dirtyChildren?: Set<NodeInfo>;
-    numGets?: number;
-    getNumResolved?: number;
-}
-interface RootNodeInfo extends BaseNodeInfo {
-    parent?: undefined;
-    key?: undefined;
-}
-interface ChildNodeInfo extends BaseNodeInfo {
-    parent: NodeInfo;
-    key: string;
-}
-type NodeInfo = RootNodeInfo | ChildNodeInfo;
-interface TrackingNode {
-    node: NodeInfo;
-    track: TrackingType;
-    num: number;
-}
-interface ObserveEvent<T> {
-    num: number;
-    previous?: T | undefined;
-    cancel?: boolean;
-    onCleanup?: () => void;
-}
-interface ObserveEventCallback<T> {
-    num: number;
-    previous?: T | undefined;
-    value?: T;
-    cancel: boolean;
-    nodes: Map<NodeInfo, TrackingNode> | undefined;
-    refresh: () => void;
-    onCleanup?: () => void;
-    onCleanupReaction?: () => void;
-}
-type SetParams<T> = ListenerParams<T extends Promise<infer t> ? t : T>;
-interface LinkedOptions<T = any> {
-    get?: () => Promise<T> | T;
-    set?: (params: SetParams<T>) => void | Promise<any>;
-    waitFor?: Selector<any>;
-    waitForSet?: ((params: WaitForSetFnParams<T>) => any) | Promise<any> | ObservableParam<any> | ObservableEvent;
-    initial?: (() => T) | T;
-    activate?: 'auto' | 'lazy';
-}
-interface WaitForSetFnParams<T = any> {
-    value: T;
-    changes: Change[];
-}
-type GetMode = 'set' | 'assign' | 'merge' | 'append' | 'prepend';
-interface UpdateFnParams<T = any> {
-    value: T;
-    mode?: GetMode;
-    lastSync?: number | undefined;
-}
-type UpdateFn<T = any> = (params: UpdateFnParams<T>) => void;
-type Linked<T> = T;
-interface ObserveOptions {
-    immediate?: boolean;
-}
-interface ObservableSyncStateBase {
-    isPersistLoaded: boolean;
-    isPersistEnabled: boolean;
-    isSyncEnabled: boolean;
-    lastSync?: number;
-    syncCount?: number;
-    isGetting?: boolean;
-    numPendingGets?: number;
-    numPendingSets?: number;
-    isSetting?: boolean;
-    clearPersist: () => Promise<void>;
-    sync: () => Promise<void>;
-    getPendingChanges: () => Record<string, {
-        p: any;
-        v?: any;
-    }> | undefined;
-    numPendingRemoteLoads?: number;
-}
-interface ObservableState {
-    isLoaded: boolean;
-    error?: Error;
-}
-type ObservableSyncState = ObservableState & ObservableSyncStateBase;
-interface RetryOptions {
-    infinite?: boolean;
-    times?: number;
-    delay?: number;
-    backoff?: 'constant' | 'exponential';
-    maxDelay?: number;
-}
+import { N as NodeInfo, O as Observable, T as TrackingType, G as GetOptions, C as Change, R as RecursiveValueOrFunction, a as ObservableEvent, S as Selector, b as ObserveEvent, c as ObservableParam, d as OpaqueObject, e as TypeAtPath, L as LinkedOptions, f as Linked, g as ObservablePrimitive, h as ObserveOptions, i as ObserveEventCallback, j as ObservableSyncState, k as ListenerParams, l as TrackingNode, m as clone, n as ensureNodeValue, o as findIDKey, p as getNode, q as getNodeValue, r as getPathType, U as UpdateFn, s as safeParse, t as safeStringify, u as setNodeValue, v as TrackingState } from './observableInterfaces-Dilj6F92.mjs';
+export { A as ArrayValue, J as ChildNodeInfo, B as ClassConstructor, M as GetMode, a0 as ImmutableObservableBase, x as ListenerFn, H as NodeListener, F as NotPrimitive, $ as ObservableBoolean, D as ObservableListenerDispose, a1 as ObservableObject, _ as ObservableObjectFns, E as ObservableRoot, X as ObservableState, V as ObservableSyncStateBase, z as ObservableValue, P as Primitive, y as RecordValue, Z as RemoveObservables, Y as RetryOptions, I as RootNodeInfo, K as SetParams, Q as UpdateFnParams, W as WaitForSetFnParams, w as isObservable } from './observableInterfaces-Dilj6F92.mjs';
 
 declare function getProxy(node: NodeInfo, p?: string, asFunction?: Function): Observable;
 declare function set(node: NodeInfo, newValue?: any): void;
@@ -293,16 +16,6 @@ declare function endBatch(force?: boolean): void;
 declare function computed<T>(get: () => RecursiveValueOrFunction<T>): Observable<T>;
 declare function computed<T, T2 = T>(get: (() => RecursiveValueOrFunction<T>) | RecursiveValueOrFunction<T>, set: (value: T2) => void): Observable<T>;
 
-declare function configureLegendState({ observableFunctions, observableProperties, jsonReplacer, jsonReviver, }: {
-    observableFunctions?: Record<string, (node: NodeInfo, ...args: any[]) => any>;
-    observableProperties?: Record<string, {
-        get: (node: NodeInfo) => any;
-        set: (node: NodeInfo, value: any) => any;
-    }>;
-    jsonReplacer?: (this: any, key: string, value: any) => any;
-    jsonReviver?: (this: any, key: string, value: any) => any;
-}): void;
-
 declare function event(): ObservableEvent;
 
 declare function computeSelector<T>(selector: Selector<T>, e?: ObserveEvent<T>, retainObservable?: boolean): T;
@@ -310,7 +23,6 @@ declare function getObservableIndex(value$: ObservableParam): number;
 declare function opaqueObject<T extends object>(value: T): OpaqueObject<T>;
 declare function getValueAtPath(obj: Record<string, any>, path: string[]): any;
 declare function setAtPath<T extends object>(obj: T, path: string[], pathTypes: TypeAtPath[], value: any, mode?: 'set' | 'merge', fullObj?: T, restore?: (path: string[], value: any) => void): T;
-declare function setInObservableAtPath(value$: ObservableParam, path: string[], pathTypes: TypeAtPath[], value: any, mode: 'assign' | 'set' | 'merge'): void;
 declare function mergeIntoObservable<T extends ObservableParam<any>>(target: T, ...sources: any[]): T;
 declare function constructObjectWithPath(path: string[], pathTypes: TypeAtPath[], value: any): object;
 declare function deconstructObjectWithPath(path: string[], pathTypes: TypeAtPath[], value: any): object;
@@ -368,14 +80,6 @@ declare function whenReady<T, T2>(predicate: Promise<T>, effect: (value: T) => T
 declare function whenReady<T, T2>(predicate: Selector<T>, effect: (value: T) => T2): Promise<T2>;
 declare function whenReady<T>(predicate: Selector<T>): Promise<T>;
 
-declare function runWithRetry<T>(state: {
-    retryNum: number;
-    retry: RetryOptions | undefined;
-}, fn: (e: {
-    retryNum: number;
-    cancelRetry: () => void;
-}) => T | Promise<T>): T | Promise<T>;
-
 declare const internal: {
     createPreviousHandler: typeof createPreviousHandler;
     clone: typeof clone;
@@ -397,14 +101,13 @@ declare const internal: {
         };
         pendingNodes: Map<NodeInfo, () => void>;
         dirtyNodes: Set<NodeInfo>;
-        replacer: undefined | ((this: any, key: string, value: any) => any);
-        reviver: undefined | ((this: any, key: string, value: any) => any);
+        replacer: ((this: any, key: string, value: any) => any) | undefined;
+        reviver: ((this: any, key: string, value: any) => any) | undefined;
     };
     initializePathType: typeof initializePathType;
     observableFns: Map<string, (node: NodeInfo, ...args: any[]) => any>;
     optimized: symbol;
     peek: typeof peek;
-    runWithRetry: typeof runWithRetry;
     safeParse: typeof safeParse;
     safeStringify: typeof safeStringify;
     set: typeof set;
@@ -417,4 +120,4 @@ declare const internal: {
     };
 };
 
-export { type ArrayValue, type Change, type ChildNodeInfo, type ClassConstructor, type GetMode, type GetOptions, type ImmutableObservableBase, type Linked, type LinkedOptions, type ListenerFn, type ListenerParams, type NodeInfo, type NodeListener, type NotPrimitive, type Observable, type ObservableBoolean, type ObservableEvent, type ObservableListenerDispose, type ObservableObject, type ObservableObjectFns, type ObservableParam, type ObservablePrimitive, type ObservableRoot, type ObservableState, type ObservableSyncState, type ObservableSyncStateBase, type ObservableValue, type ObserveEvent, type ObserveEventCallback, type ObserveOptions, type OpaqueObject, type Primitive, type RecordValue, type RecursiveValueOrFunction, type RemoveObservables, type RetryOptions, type RootNodeInfo, type Selector, type SetParams, type TrackingNode, type TrackingState, type TrackingType, type TypeAtPath, type UpdateFn, type UpdateFnParams, type WaitForSetFnParams, applyChange, applyChanges, batch, beginBatch, computeSelector, computed, configureLegendState, constructObjectWithPath, deconstructObjectWithPath, endBatch, event, getObservableIndex, hasOwnProperty, internal, isArray, isBoolean, isDate, isEmpty, isFunction, isMap, isNullOrUndefined, isNumber, isObject, isObservable, isObservableValueReady, isObserved, isPrimitive, isPromise, isString, isSymbol, linked, mergeIntoObservable, observable, observablePrimitive, observe, opaqueObject, proxy, setAtPath, setInObservableAtPath, setSilently, shouldIgnoreUnobserved, syncState, trackSelector, when, whenReady };
+export { Change, GetOptions, Linked, LinkedOptions, ListenerParams, NodeInfo, Observable, ObservableEvent, ObservableParam, ObservablePrimitive, ObservableSyncState, ObserveEvent, ObserveEventCallback, ObserveOptions, OpaqueObject, RecursiveValueOrFunction, Selector, TrackingNode, TrackingState, TrackingType, TypeAtPath, UpdateFn, applyChange, applyChanges, batch, beginBatch, computeSelector, computed, constructObjectWithPath, deconstructObjectWithPath, endBatch, event, getObservableIndex, hasOwnProperty, internal, isArray, isBoolean, isDate, isEmpty, isFunction, isMap, isNullOrUndefined, isNumber, isObject, isObservableValueReady, isObserved, isPrimitive, isPromise, isString, isSymbol, linked, mergeIntoObservable, observable, observablePrimitive, observe, opaqueObject, proxy, setAtPath, setSilently, shouldIgnoreUnobserved, syncState, trackSelector, when, whenReady };