@legendapp/state 2.2.0-next.2 → 2.2.0-next.4

package/src/observableInterfaces.d.ts

@@ -96,7 +96,7 @@ type PrimitiveKeys<T> = Pick<T, {
 type NonPrimitiveKeys<T> = Pick<T, {
     [K in keyof T]-?: T[K] extends Primitive ? never : K;
 }[keyof T]>;
-type Recurse<T, K extends keyof T, TRecurse> = T[K] extends ObservableReadable ? T[K] : T[K] extends Promise<infer t> ? Observable<t & WithState> : T[K] extends () => infer t ? t extends Observable ? t : Observable<t> & T[K] : T[K] extends (params: ComputedParams) => infer t ? t extends Observable ? t : Observable<t> : T[K] extends (params: ComputedProxyParams<infer t>) => void ? t extends Observable ? Record<string, t> : Observable<Record<string, t>> : T[K] extends Function ? T[K] : T[K] extends ObservableProxyTwoWay<infer t, infer t2> ? ObservableProxyTwoWay<t, t2> : T[K] extends ObservableProxy<infer t> ? ObservableProxy<t> : T[K] extends ObservableProxyLink<infer t> ? ObservableProxyLink<t> : T[K] extends Map<any, any> | WeakMap<any, any> ? ObservableMap<T[K]> : T[K] extends Set<any> | WeakSet<any> ? ObservableSet<T[K]> : T[K] extends Set<any> | WeakSet<any> ? T[K] & ObservablePrimitiveBaseFns<T[K]> : T[K] extends OpaqueObject<T[K]> ? T[K] & ObservablePrimitiveChildFns<T[K]> : T[K] extends Primitive ? ObservablePrimitiveChild<T[K]> : T[K] extends Array<any> ? ObservableObjectFns<T[K]> & ObservableArrayOverride<T[K][number]> : T extends object ? TRecurse : T[K];
+type Recurse<T, K extends keyof T, TRecurse> = T[K] extends ObservableReadable ? T[K] : T[K] extends Promise<infer t> ? Observable<t & WithState> : T[K] extends () => infer t ? t extends Observable ? t : Observable<t> & T[K] : T[K] extends (params: ActivateParams) => infer t ? t extends Observable ? t : Observable<t> : T[K] extends (params: ActivateProxyParams<infer t>) => void ? t extends Observable ? Record<string, t> : Observable<Record<string, t>> : T[K] extends Function ? T[K] : T[K] extends ObservableProxyTwoWay<infer t, infer t2> ? ObservableProxyTwoWay<t, t2> : T[K] extends ObservableProxy<infer t> ? ObservableProxy<t> : T[K] extends ObservableProxyLink<infer t> ? ObservableProxyLink<t> : T[K] extends Map<any, any> | WeakMap<any, any> ? ObservableMap<T[K]> : T[K] extends Set<any> | WeakSet<any> ? ObservableSet<T[K]> : T[K] extends Set<any> | WeakSet<any> ? T[K] & ObservablePrimitiveBaseFns<T[K]> : T[K] extends OpaqueObject<T[K]> ? T[K] & ObservablePrimitiveChildFns<T[K]> : T[K] extends Primitive ? ObservablePrimitiveChild<T[K]> : T[K] extends Array<any> ? ObservableObjectFns<T[K]> & ObservableArrayOverride<T[K][number]> : T extends object ? TRecurse : T[K];
 type ObservableFnsRecursiveUnsafe<T> = {
     [K in keyof T]-?: Recurse<T, K, ObservableObject<NonNullable<T[K]>>>;
 };
@@ -158,6 +158,8 @@ export type PersistOptionsRemote<T = any> = ObservablePersistenceConfigRemoteGlo
     };
     offlineBehavior?: false | 'retry';
     changeTimeout?: number;
+    metadataTimeout?: number;
+    retry?: RetryOptions;
     onGetError?: (error: Error) => void;
     onSetError?: (error: Error) => void;
     log?: (message?: any, ...optionalParams: any[]) => void;
@@ -234,6 +236,7 @@ export interface ObservablePersistRemoteGetParams<T> {
     options: PersistOptions<T>;
     dateModified?: number;
     onGet: () => void;
+    onError: (error: Error) => void;
     onChange: (params: ObservableOnChangeParams) => void | Promise<void>;
 }
 export type ObservablePersistRemoteGetFnParams<T> = Omit<ObservablePersistRemoteGetParams<T>, 'onGet'>;
@@ -260,11 +263,12 @@ export interface WithState {
     state?: ObservableState;
     _state?: ObservableState;
 }
-export interface ObservablePersistState extends ObservableState {
+export interface ObservablePersistStateBase {
     isLoadedLocal: boolean;
     isEnabledLocal: boolean;
     isEnabledRemote: boolean;
     dateModified?: number;
+    syncCount?: number;
     clearLocal: () => Promise<void>;
     sync: () => Promise<void>;
     getPendingChanges: () => Record<string, {
@@ -272,6 +276,10 @@ export interface ObservablePersistState extends ObservableState {
         v?: any;
     }> | undefined;
 }
+export type ObservablePersistState = ObservableState & ObservablePersistStateBase;
+export type ObservablePersistStateInternal = ObservablePersistState & {
+    refreshNum: number;
+};
 export interface WithPersistState {
     state?: ObservablePersistState;
     _state?: ObservablePersistState;
@@ -357,7 +365,17 @@ interface BaseNodeValue {
     lazy?: boolean | Function;
     state?: Observable<ObservablePersistState>;
     activated?: boolean;
-    proxyFn2?: (key: string, params: ComputedParams) => any;
+    proxyFn2?: (key: string, params: ActivateParams) => any;
+    activationState?: {
+        onSetFn?: (value: ListenerParams<any>, extra: OnSetExtra) => void;
+        update?: UpdateFn;
+        subscriber?: (params: SubscribeOptions) => void;
+        retryOptions?: RetryOptions;
+        lastSync: {
+            value?: number;
+        };
+        cacheOptions?: CacheOptions;
+    };
 }
 export interface RootNodeValue extends BaseNodeValue {
     parent?: undefined;
@@ -401,16 +419,30 @@ export interface CacheOptions<T = any> {
     local: string | PersistOptionsLocal<T>;
     pluginLocal?: ClassConstructor<ObservablePersistLocal, T[]>;
 }
-export interface ComputedParams<T = any> {
-    onSet: (fn: (params: ListenerParams<T>) => void) => void;
+export interface ActivateParams<T = any> {
+    obs$: Observable<T>;
+    onSet: (fn: (params: ListenerParams<T>, extra: OnSetExtra) => void) => void;
     subscribe: (fn: (params: {
-        update: (props: ObservableOnChangeParams) => void;
+        update: UpdateFn;
+        refresh: () => void;
     }) => void) => void;
-    cache: (cacheOptions: CacheOptions<T> | (() => CacheOptions<T>)) => void;
-    updateLastSync: (lastSync: number) => void;
 }
-export interface ComputedProxyParams<T = any> extends ComputedParams {
-    proxy: (fn: (key: string, params: ComputedParams<T>) => T | Promise<T>) => void;
+export interface ActivateProxyParams<T = any> extends ActivateParams {
+    proxy: (fn: (key: string, params: ActivateParams<T>) => T | Promise<T>) => void;
 }
 export type UpdateFn = (params: ObservableOnChangeParams) => void;
+export interface RetryOptions {
+    infinite?: boolean;
+    times?: number;
+    delay?: number;
+    backoff?: 'constant' | 'exponential';
+    maxDelay?: number;
+}
+export interface OnSetExtra {
+    update: UpdateFn;
+}
+export interface SubscribeOptions {
+    update: UpdateFn;
+    refresh: () => void;
+}
 export {};

package/src/persist/persistActivateNode.d.ts

@@ -0,0 +1,18 @@
+import type { CacheOptions, ObservablePersistStateBase, RetryOptions } from '@legendapp/state';
+export declare function persistActivateNode(): void;
+declare module '@legendapp/state' {
+    interface ActivateParams<T> {
+        cache: (cacheOptions: CacheOptions<T> | (() => CacheOptions<T>)) => void;
+        updateLastSync: (lastSync: number) => void;
+        retry: (options: RetryOptions) => void;
+    }
+    interface OnSetExtra {
+        updateLastSync: (lastSync: number) => void;
+        applyRemoteChange: (fn: () => void) => void;
+    }
+    interface SubscribeOptions {
+        applyRemoteChange: (fn: () => void) => void;
+    }
+    interface ObservableState extends ObservablePersistStateBase {
+    }
+}

package/src/persist/persistObservable.d.ts

@@ -3,6 +3,7 @@ export declare const mapPersistences: WeakMap<ClassConstructor<ObservablePersist
     persist: ObservablePersistLocal | ObservablePersistRemoteClass;
     initialized?: Observable<boolean>;
 }>;
+export declare function onChangeRemote(cb: () => void): void;
 export declare function transformOutData(value: any, path: string[], pathTypes: TypeAtPath[], { transform, fieldTransforms }: {
     transform?: PersistTransform;
     fieldTransforms?: FieldTransforms<any>;