proxy-state-tree - npm Package Compare versions

Comparing version 6.3.1-1745419922669 to 6.3.1-1746035488845

es/index.d.ts

@@ -7,3 +7,3 @@ import { MutationTree } from './MutationTree';
 export * from './types';
-export declare class ProxyStateTree<T extends object> implements IProxyStateTree<T> {
+export declare class ProxyStateTree<T extends object, D> implements IProxyStateTree<T, D> {
     flushCallbacks: IFlushCallback[];
@@ -14,5 +14,5 @@ mutationCallbacks: IMutationCallback[];
     previousTree: TTree;
-    mutationTree: IMutationTree<T>;
+    mutationTree: IMutationTree<T, D>;
     proxifier: IProxifier<T>;
-    root: ProxyStateTree<T>;
+    root: ProxyStateTree<T, D>;
     pathDependencies: {
@@ -23,12 +23,12 @@ [path: string]: Set<ITrackCallback>;
     sourceState: T;
-    options: IOptions;
-    constructor(state: T, options?: IOptions);
+    options: IOptions<D>;
+    constructor(state: T, options?: IOptions<D>);
     private createTrackStateProxifier;
-    getMutationTree(): IMutationTree<T>;
-    getTrackStateTree(): ITrackStateTree<T>;
-    getTrackStateTreeWithProxifier(): ITrackStateTree<T>;
-    setTrackStateTree(tree: ITrackStateTree<T>): void;
-    unsetTrackStateTree(tree: ITrackStateTree<T>): void;
+    getMutationTree(): IMutationTree<T, D>;
+    getTrackStateTree(): ITrackStateTree<T, D>;
+    getTrackStateTreeWithProxifier(): ITrackStateTree<T, D>;
+    setTrackStateTree(tree: ITrackStateTree<T, D>): void;
+    unsetTrackStateTree(tree: ITrackStateTree<T, D>): void;
     clearTrackStateTree(): void;
-    disposeTree(tree: IMutationTree<T> | ITrackStateTree<T>): void;
+    disposeTree(tree: IMutationTree<T, D> | ITrackStateTree<T, D>): void;
     onMutation(callback: IMutationCallback): () => void;
@@ -35,0 +35,0 @@ forceFlush(): void;

es/MutationTree.d.ts

 import { IMutation, IMutationCallback, IMutationTree, IProxifier, IProxyStateTree } from './types';
-export declare class MutationTree<T extends object> implements IMutationTree<T> {
+export declare class MutationTree<T extends object, D> implements IMutationTree<T, D> {
     private mutationCallbacks;
-    root: IProxyStateTree<T>;
+    root: IProxyStateTree<T, D>;
     state: T;
@@ -12,3 +12,3 @@ proxifier: IProxifier<T>;
     trackPathListeners: Array<(path: string) => void>;
-    constructor(root: IProxyStateTree<T>, proxifier?: IProxifier<T>);
+    constructor(root: IProxyStateTree<T, D>, proxifier?: IProxifier<T>);
     trackPaths(): () => Set<string>;
@@ -15,0 +15,0 @@ getMutations(): IMutation[];

es/Proxyfier.d.ts

@@ -18,3 +18,3 @@ import { IMutationTree, TTree } from './types';
     getTrackingTree(): TTree;
-    getMutationTree(): IMutationTree<any>;
+    getMutationTree(): IMutationTree<any, any>;
     private isProxyCached;
@@ -21,0 +21,0 @@ private createArrayProxy;

es/TrackStateTree.d.ts

 import { IProxifier, IProxyStateTree, ITrackCallback, ITrackScopedCallback, ITrackStateTree } from './types';
-export declare class TrackStateTree<T extends object> implements ITrackStateTree<T> {
+export declare class TrackStateTree<T extends object, D> implements ITrackStateTree<T, D> {
     private disposeOnReset;
-    root: IProxyStateTree<T>;
+    root: IProxyStateTree<T, D>;
     pathDependencies: Set<string>;
@@ -9,3 +9,3 @@ state: T;
     trackPathListeners: Array<(path: string) => void>;
-    constructor(root: IProxyStateTree<T>);
+    constructor(root: IProxyStateTree<T, D>);
     trackPaths(): () => Set<string>;
@@ -17,3 +17,3 @@ track(): this;
     subscribe(cb: ITrackCallback): () => void;
-    trackScope(scope: ITrackScopedCallback<T>): this;
+    trackScope(scope: ITrackScopedCallback<T, D>): this;
 }

es/types.d.ts

@@ -15,3 +15,3 @@ export interface IProxifier<T extends object> {
 }
-export interface IMutationTree<T extends object> {
+export interface IMutationTree<T extends object, D> {
     addMutation(mutation: IMutation, objectChangePath?: string): void;
@@ -28,5 +28,5 @@ onMutation(callback: IMutationCallback): void;
     };
-    dispose(): IMutationTree<T>;
+    dispose(): IMutationTree<T, D>;
     objectChanges: Set<string>;
-    root: IProxyStateTree<T>;
+    root: IProxyStateTree<T, D>;
     proxifier: IProxifier<T>;
@@ -40,13 +40,13 @@ mutations: IMutation[];
 }
-export interface ITrackScopedCallback<T extends object> {
-    (tree: ITrackStateTree<T>): any;
+export interface ITrackScopedCallback<T extends object, D> {
+    (tree: ITrackStateTree<T, D>): any;
 }
-export interface ITrackStateTree<T extends object> {
+export interface ITrackStateTree<T extends object, D> {
     addTrackingPath(path: string): void;
     subscribe(cb: ITrackCallback): () => void;
-    track(): ITrackStateTree<T>;
-    trackScope(scope: ITrackScopedCallback<T>): any;
+    track(): ITrackStateTree<T, D>;
+    trackScope(scope: ITrackScopedCallback<T, D>): any;
     canTrack(): boolean;
     canMutate(): boolean;
-    root: IProxyStateTree<T>;
+    root: IProxyStateTree<T, D>;
     proxifier: IProxifier<T>;
@@ -57,3 +57,3 @@ state: T;
 }
-export interface IOptions {
+export interface IOptions<D> {
     delimiter?: string;
@@ -65,2 +65,3 @@ devmode?: boolean;
     onGetter?: Function;
+    getDevtools?: () => D;
 }
@@ -70,21 +71,21 @@ export interface IFlushCallback {
 }
-export type TTree = IMutationTree<any> | ITrackStateTree<any>;
+export type TTree = IMutationTree<any, any> | ITrackStateTree<any, any>;
 export interface IRemoveProxyCallback {
     (path: string): void;
 }
-export interface IProxyStateTree<T extends object> {
+export interface IProxyStateTree<T extends object, D> {
     addPathDependency(path: string, callback: ITrackCallback): void;
     removePathDependency(path: string, callback: ITrackCallback): void;
-    getTrackStateTree(): ITrackStateTree<T>;
-    getMutationTree(): IMutationTree<T>;
-    setTrackStateTree(tree: ITrackStateTree<T> | null): void;
-    unsetTrackStateTree(tree: ITrackStateTree<T> | null): void;
+    getTrackStateTree(): ITrackStateTree<T, D>;
+    getMutationTree(): IMutationTree<T, D>;
+    setTrackStateTree(tree: ITrackStateTree<T, D> | null): void;
+    unsetTrackStateTree(tree: ITrackStateTree<T, D> | null): void;
     clearTrackStateTree(): void;
     disposeTree(proxy: TTree): void;
     onMutation(cb: IMutationCallback): void;
-    flush(tree: IMutationTree<T>, isAsync: boolean): {
+    flush(tree: IMutationTree<T, D>, isAsync: boolean): {
         mutations: IMutation[];
         flushId: number;
     };
-    flush(trees: IMutationTree<T>[], isAsync: boolean): {
+    flush(trees: IMutationTree<T, D>[], isAsync: boolean): {
         mutations: IMutation[];
@@ -97,11 +98,11 @@ flushId: number;
     state: T;
-    options: IOptions;
+    options: IOptions<D>;
     pathDependencies: {
         [path: string]: Set<ITrackCallback>;
     };
-    root: IProxyStateTree<T>;
+    root: IProxyStateTree<T, D>;
     proxifier: IProxifier<T>;
     currentTree: TTree;
     previousTree: TTree;
-    mutationTree: IMutationTree<T>;
+    mutationTree: IMutationTree<T, D>;
     mutationCallbacks: IMutationCallback[];
@@ -108,0 +109,0 @@ flushCallbacks: IFlushCallback[];

lib/index.d.ts

@@ -7,3 +7,3 @@ import { MutationTree } from './MutationTree';
 export * from './types';
-export declare class ProxyStateTree<T extends object> implements IProxyStateTree<T> {
+export declare class ProxyStateTree<T extends object, D> implements IProxyStateTree<T, D> {
     flushCallbacks: IFlushCallback[];
@@ -14,5 +14,5 @@ mutationCallbacks: IMutationCallback[];
     previousTree: TTree;
-    mutationTree: IMutationTree<T>;
+    mutationTree: IMutationTree<T, D>;
     proxifier: IProxifier<T>;
-    root: ProxyStateTree<T>;
+    root: ProxyStateTree<T, D>;
     pathDependencies: {
@@ -23,12 +23,12 @@ [path: string]: Set<ITrackCallback>;
     sourceState: T;
-    options: IOptions;
-    constructor(state: T, options?: IOptions);
+    options: IOptions<D>;
+    constructor(state: T, options?: IOptions<D>);
     private createTrackStateProxifier;
-    getMutationTree(): IMutationTree<T>;
-    getTrackStateTree(): ITrackStateTree<T>;
-    getTrackStateTreeWithProxifier(): ITrackStateTree<T>;
-    setTrackStateTree(tree: ITrackStateTree<T>): void;
-    unsetTrackStateTree(tree: ITrackStateTree<T>): void;
+    getMutationTree(): IMutationTree<T, D>;
+    getTrackStateTree(): ITrackStateTree<T, D>;
+    getTrackStateTreeWithProxifier(): ITrackStateTree<T, D>;
+    setTrackStateTree(tree: ITrackStateTree<T, D>): void;
+    unsetTrackStateTree(tree: ITrackStateTree<T, D>): void;
     clearTrackStateTree(): void;
-    disposeTree(tree: IMutationTree<T> | ITrackStateTree<T>): void;
+    disposeTree(tree: IMutationTree<T, D> | ITrackStateTree<T, D>): void;
     onMutation(callback: IMutationCallback): () => void;
@@ -35,0 +35,0 @@ forceFlush(): void;

lib/MutationTree.d.ts

 import { IMutation, IMutationCallback, IMutationTree, IProxifier, IProxyStateTree } from './types';
-export declare class MutationTree<T extends object> implements IMutationTree<T> {
+export declare class MutationTree<T extends object, D> implements IMutationTree<T, D> {
     private mutationCallbacks;
-    root: IProxyStateTree<T>;
+    root: IProxyStateTree<T, D>;
     state: T;
@@ -12,3 +12,3 @@ proxifier: IProxifier<T>;
     trackPathListeners: Array<(path: string) => void>;
-    constructor(root: IProxyStateTree<T>, proxifier?: IProxifier<T>);
+    constructor(root: IProxyStateTree<T, D>, proxifier?: IProxifier<T>);
     trackPaths(): () => Set<string>;
@@ -15,0 +15,0 @@ getMutations(): IMutation[];

lib/Proxyfier.d.ts

@@ -18,3 +18,3 @@ import { IMutationTree, TTree } from './types';
     getTrackingTree(): TTree;
-    getMutationTree(): IMutationTree<any>;
+    getMutationTree(): IMutationTree<any, any>;
     private isProxyCached;
@@ -21,0 +21,0 @@ private createArrayProxy;

lib/TrackStateTree.d.ts

 import { IProxifier, IProxyStateTree, ITrackCallback, ITrackScopedCallback, ITrackStateTree } from './types';
-export declare class TrackStateTree<T extends object> implements ITrackStateTree<T> {
+export declare class TrackStateTree<T extends object, D> implements ITrackStateTree<T, D> {
     private disposeOnReset;
-    root: IProxyStateTree<T>;
+    root: IProxyStateTree<T, D>;
     pathDependencies: Set<string>;
@@ -9,3 +9,3 @@ state: T;
     trackPathListeners: Array<(path: string) => void>;
-    constructor(root: IProxyStateTree<T>);
+    constructor(root: IProxyStateTree<T, D>);
     trackPaths(): () => Set<string>;
@@ -17,3 +17,3 @@ track(): this;
     subscribe(cb: ITrackCallback): () => void;
-    trackScope(scope: ITrackScopedCallback<T>): this;
+    trackScope(scope: ITrackScopedCallback<T, D>): this;
 }

lib/types.d.ts

@@ -15,3 +15,3 @@ export interface IProxifier<T extends object> {
 }
-export interface IMutationTree<T extends object> {
+export interface IMutationTree<T extends object, D> {
     addMutation(mutation: IMutation, objectChangePath?: string): void;
@@ -28,5 +28,5 @@ onMutation(callback: IMutationCallback): void;
     };
-    dispose(): IMutationTree<T>;
+    dispose(): IMutationTree<T, D>;
     objectChanges: Set<string>;
-    root: IProxyStateTree<T>;
+    root: IProxyStateTree<T, D>;
     proxifier: IProxifier<T>;
@@ -40,13 +40,13 @@ mutations: IMutation[];
 }
-export interface ITrackScopedCallback<T extends object> {
-    (tree: ITrackStateTree<T>): any;
+export interface ITrackScopedCallback<T extends object, D> {
+    (tree: ITrackStateTree<T, D>): any;
 }
-export interface ITrackStateTree<T extends object> {
+export interface ITrackStateTree<T extends object, D> {
     addTrackingPath(path: string): void;
     subscribe(cb: ITrackCallback): () => void;
-    track(): ITrackStateTree<T>;
-    trackScope(scope: ITrackScopedCallback<T>): any;
+    track(): ITrackStateTree<T, D>;
+    trackScope(scope: ITrackScopedCallback<T, D>): any;
     canTrack(): boolean;
     canMutate(): boolean;
-    root: IProxyStateTree<T>;
+    root: IProxyStateTree<T, D>;
     proxifier: IProxifier<T>;
@@ -57,3 +57,3 @@ state: T;
 }
-export interface IOptions {
+export interface IOptions<D> {
     delimiter?: string;
@@ -65,2 +65,3 @@ devmode?: boolean;
     onGetter?: Function;
+    getDevtools?: () => D;
 }
@@ -70,21 +71,21 @@ export interface IFlushCallback {
 }
-export type TTree = IMutationTree<any> | ITrackStateTree<any>;
+export type TTree = IMutationTree<any, any> | ITrackStateTree<any, any>;
 export interface IRemoveProxyCallback {
     (path: string): void;
 }
-export interface IProxyStateTree<T extends object> {
+export interface IProxyStateTree<T extends object, D> {
     addPathDependency(path: string, callback: ITrackCallback): void;
     removePathDependency(path: string, callback: ITrackCallback): void;
-    getTrackStateTree(): ITrackStateTree<T>;
-    getMutationTree(): IMutationTree<T>;
-    setTrackStateTree(tree: ITrackStateTree<T> | null): void;
-    unsetTrackStateTree(tree: ITrackStateTree<T> | null): void;
+    getTrackStateTree(): ITrackStateTree<T, D>;
+    getMutationTree(): IMutationTree<T, D>;
+    setTrackStateTree(tree: ITrackStateTree<T, D> | null): void;
+    unsetTrackStateTree(tree: ITrackStateTree<T, D> | null): void;
     clearTrackStateTree(): void;
     disposeTree(proxy: TTree): void;
     onMutation(cb: IMutationCallback): void;
-    flush(tree: IMutationTree<T>, isAsync: boolean): {
+    flush(tree: IMutationTree<T, D>, isAsync: boolean): {
         mutations: IMutation[];
         flushId: number;
     };
-    flush(trees: IMutationTree<T>[], isAsync: boolean): {
+    flush(trees: IMutationTree<T, D>[], isAsync: boolean): {
         mutations: IMutation[];
@@ -97,11 +98,11 @@ flushId: number;
     state: T;
-    options: IOptions;
+    options: IOptions<D>;
     pathDependencies: {
         [path: string]: Set<ITrackCallback>;
     };
-    root: IProxyStateTree<T>;
+    root: IProxyStateTree<T, D>;
     proxifier: IProxifier<T>;
     currentTree: TTree;
     previousTree: TTree;
-    mutationTree: IMutationTree<T>;
+    mutationTree: IMutationTree<T, D>;
     mutationCallbacks: IMutationCallback[];
@@ -108,0 +109,0 @@ flushCallbacks: IFlushCallback[];

package.json

 {
   "name": "proxy-state-tree",
-  "version": "6.3.1-1745419922669",
+  "version": "6.3.1-1746035488845",
   "description": "An implementation of the Mobx/Vue state tracking approach, for library authors",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

No alert changes

Improved metrics

Total package byte prevSize

184518

0.43%

Lines of code

1755

0.11%

No dependency changes