@legendapp/state 3.0.0-alpha.2 → 3.0.0-alpha.20

package/index.d.ts

@@ -1,13 +1,13 @@
 type Primitive$1 = string | number | boolean | symbol | bigint | undefined | null | Date;
-type ArrayOverrideFnNames = 'find' | 'every' | 'some' | 'filter' | 'reduce' | 'reduceRight' | 'forEach' | 'map' | 'sort';
+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 : IsUserDefinedObject<T> extends true ? {
+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: string) => infer TRet ? Record<string, RemoveObservables<TRet>> & T : T;
+} : 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> {
@@ -76,18 +76,19 @@ 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) => Promise<infer t> | infer t ? HasOneStringParam<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]>;
+    [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 HasOneStringParam<T> = T extends (...args: infer P) => any ? P extends {
+type IsLookupFunction<T> = T extends (...args: infer P) => any ? P extends {
     length: 1;
-} ? P[0] extends string | ObservablePrimitive<string> ? 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>] ? HasOneStringParam<T> extends true ? Observable<Record<K, t>> : t : HasOneStringParam<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> & {};
+} ? 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 ValueOrFunction<T> = T extends Function ? T : T | ImmutableObservableBase<T> | Promise<T> | (() => T | Promise<T>);
+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]>;
 };
@@ -95,7 +96,7 @@ type RecursiveValueOrFunction<T> = T extends Function ? T : T extends object ? (
 
 declare const symbolOpaque: unique symbol;
 declare function getPathType(value: any): TypeAtPath;
-declare function safeStringify(value: any): string;
+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;
@@ -119,7 +120,8 @@ interface ListenerParams<T = any> {
     value: T;
     getPrevious: () => T;
     changes: Change[];
-    remote: boolean;
+    isFromSync: boolean;
+    isFromPersist: boolean;
 }
 type ListenerFn<T = any> = (params: ListenerParams<T>) => void;
 interface ObservableEvent {
@@ -178,12 +180,15 @@ interface BaseNodeValue {
     numListenersRecursive: number;
     state?: Observable<ObservableSyncState>;
     activated?: boolean;
+    recursivelyAutoActivated?: boolean;
     activationState?: LinkedOptions & {
         onError?: () => void;
-        persistedRetry?: boolean;
+        onChange: (params: UpdateFnParams) => void | Promise<void>;
     };
     dirtyFn?: () => void;
     dirtyChildren?: Set<NodeValue>;
+    numGets?: number;
+    getNumResolved?: number;
 }
 interface RootNodeValue extends BaseNodeValue {
     parent?: undefined;
@@ -229,12 +234,12 @@ interface WaitForSetFnParams<T = any> {
     changes: Change[];
 }
 type GetMode = 'set' | 'assign' | 'merge' | 'append' | 'prepend';
-interface UpdateFnParams {
-    value: unknown;
+interface UpdateFnParams<T = any> {
+    value: T;
     mode?: GetMode;
     lastSync?: number | undefined;
 }
-type UpdateFn = (params: UpdateFnParams) => void;
+type UpdateFn<T = any> = (params: UpdateFnParams<T>) => void;
 type Linked<T> = T;
 interface ObserveOptions {
     immediate?: boolean;
@@ -245,12 +250,17 @@ interface ObservableSyncStateBase {
     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;
@@ -265,6 +275,13 @@ interface RetryOptions {
     maxDelay?: number;
 }
 
+declare function getProxy(node: NodeValue, p?: string, asFunction?: Function): Observable;
+declare function set(node: NodeValue, newValue?: any): void;
+declare function get(node: NodeValue, options?: TrackingType | GetOptions): any;
+declare function peek(node: NodeValue): any;
+declare function isObserved(node: NodeValue): boolean;
+declare function shouldIgnoreUnobserved(node: NodeValue, refreshFn: () => void): true | undefined;
+
 declare function createPreviousHandler(value: any, changes: Change[]): () => any;
 declare function batch(fn: () => void): void;
 declare function beginBatch(): void;
@@ -273,8 +290,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 linked<T>(params: LinkedOptions<T> | (() => T), options?: LinkedOptions<T>): Linked<T>;
-
 declare function configureLegendState({ observableFunctions, observableProperties, jsonReplacer, jsonReviver, }: {
     observableFunctions?: Record<string, (node: NodeValue, ...args: any[]) => any>;
     observableProperties?: Record<string, {
@@ -293,7 +308,7 @@ 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<Record<string, any>> | object>(target: T, ...sources: any[]): T;
+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;
 declare function isObservableValueReady(value: any): boolean;
@@ -301,6 +316,7 @@ declare function setSilently(value$: ObservableParam, newValue: any): any;
 declare function initializePathType(pathType: TypeAtPath): any;
 declare function applyChange<T extends object>(value: T, change: Change, applyPrevious?: boolean): T;
 declare function applyChanges<T extends object>(value: T, changes: Change[], applyPrevious?: boolean): T;
+declare function deepMerge<T extends object>(target: T, ...sources: any[]): T;
 
 declare const hasOwnProperty: (v: PropertyKey) => boolean;
 declare function isArray(obj: unknown): obj is Array<any>;
@@ -317,12 +333,13 @@ declare function isNumber(obj: unknown): obj is number;
 declare function isEmpty(obj: object): boolean;
 declare function isNullOrUndefined(value: any): value is undefined | null;
 
+declare function linked<T>(params: LinkedOptions<T> | (() => T), options?: LinkedOptions<T>): Linked<T>;
+
 declare function observable<T>(): Observable<T | undefined>;
 declare function observable<T>(value: Promise<RecursiveValueOrFunction<T>> | (() => RecursiveValueOrFunction<T>) | RecursiveValueOrFunction<T>): Observable<T>;
 declare function observable<T>(value: T): Observable<T>;
 declare function observablePrimitive<T>(value: Promise<T>): ObservablePrimitive<T>;
 declare function observablePrimitive<T>(value?: T): ObservablePrimitive<T>;
-declare function syncState(obs: ObservableParam): Observable<ObservableSyncState>;
 
 declare function observe<T>(run: (e: ObserveEvent<T>) => T | void, options?: ObserveOptions): () => void;
 declare function observe<T>(selector: Selector<T> | ((e: ObserveEvent<T>) => any), reaction?: (e: ObserveEventCallback<T>) => any, options?: ObserveOptions): () => void;
@@ -332,6 +349,8 @@ declare function proxy<T extends Record<string, any>>(get: <K extends keyof T>(k
 declare function proxy<T>(get: (key: string) => ObservableParam<T>): Observable<Record<string, T>>;
 declare function proxy<T>(get: (key: string) => T): Observable<Record<string, T>>;
 
+declare function syncState(obs: ObservableParam): Observable<ObservableSyncState>;
+
 declare function trackSelector<T>(selector: Selector<T>, update: (params: ListenerParams) => void, observeEvent?: ObserveEvent<T>, observeOptions?: ObserveOptions, createResubscribe?: boolean): {
     nodes: Map<NodeValue, TrackingNode> | undefined;
     value: T;
@@ -346,23 +365,18 @@ 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 getProxy(node: NodeValue, p?: string, asFunction?: Function): Observable;
-declare function set(node: NodeValue, newValue?: any): void;
-declare function get(node: NodeValue, options?: TrackingType | GetOptions): any;
-declare function peek(node: NodeValue): any;
-declare function isObserved(node: NodeValue): boolean;
-declare function shouldIgnoreUnobserved(node: NodeValue, refreshFn: () => void): true | undefined;
-
-declare function runWithRetry<T>(node: NodeValue, state: {
-    attemptNum: number;
+declare function runWithRetry<T>(state: {
+    retryNum: number;
     retry: RetryOptions | undefined;
 }, fn: (e: {
-    cancel?: boolean;
+    retryNum: number;
+    cancelRetry: () => void;
 }) => T | Promise<T>): T | Promise<T>;
 
 declare const internal: {
     createPreviousHandler: typeof createPreviousHandler;
     clone: typeof clone;
+    deepMerge: typeof deepMerge;
     ensureNodeValue: typeof ensureNodeValue;
     findIDKey: typeof findIDKey;
     get: typeof get;
@@ -373,7 +387,6 @@ declare const internal: {
     getValueAtPath: typeof getValueAtPath;
     globalState: {
         isLoadingLocal: boolean;
-        isMerging: boolean;
         isLoadingRemote: boolean;
         activateSyncedNode: (node: NodeValue, newValue: any) => {
             update: UpdateFn;
@@ -381,8 +394,8 @@ declare const internal: {
         };
         pendingNodes: Map<NodeValue, () => void>;
         dirtyNodes: Set<NodeValue>;
-        replacer: ((this: any, key: string, value: any) => any) | undefined;
-        reviver: ((this: any, key: string, value: any) => any) | undefined;
+        replacer: undefined | ((this: any, key: string, value: any) => any);
+        reviver: undefined | ((this: any, key: string, value: any) => any);
     };
     initializePathType: typeof initializePathType;
     observableFns: Map<string, (node: NodeValue, ...args: any[]) => any>;
@@ -401,4 +414,4 @@ declare const internal: {
     };
 };
 
-export { type ArrayValue, type Change, type ChildNodeValue, type ClassConstructor, type GetMode, type GetOptions, type ImmutableObservableBase, type Linked, type LinkedOptions, type ListenerFn, type ListenerParams, type NodeValue, type NodeValueListener, type NotPrimitive, type Observable, type ObservableBoolean, type ObservableEvent, type ObservableListenerDispose, type ObservableObject, 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 RootNodeValue, 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 { type ArrayValue, type Change, type ChildNodeValue, type ClassConstructor, type GetMode, type GetOptions, type ImmutableObservableBase, type Linked, type LinkedOptions, type ListenerFn, type ListenerParams, type NodeValue, type NodeValueListener, 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 RootNodeValue, 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 };