mobx-state-tree 3.12.2 → 3.15.0

package/dist/core/node/BaseNode.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/core/node/Hook.d.ts

@@ -1 +1,17 @@
-export {};
+/**
+ * @hidden
+ */
+export declare enum Hook {
+    afterCreate = "afterCreate",
+    afterAttach = "afterAttach",
+    afterCreationFinalization = "afterCreationFinalization",
+    beforeDetach = "beforeDetach",
+    beforeDestroy = "beforeDestroy"
+}
+export interface IHooks {
+    [Hook.afterCreate]?: () => void;
+    [Hook.afterAttach]?: () => void;
+    [Hook.beforeDetach]?: () => void;
+    [Hook.beforeDestroy]?: () => void;
+}
+export declare type IHooksGetter<T> = (self: T) => IHooks;

package/dist/core/node/create-node.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/core/node/identifier-cache.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/core/node/livelinessChecking.d.ts

@@ -1,37 +1,37 @@
-/**
- * Defines what MST should do when running into reads / writes to objects that have died.
- * - `"warn"`: Print a warning (default).
- * - `"error"`: Throw an exception.
- * - "`ignore`": Do nothing.
- */
-export declare type LivelinessMode = "warn" | "error" | "ignore";
-/**
- * Defines what MST should do when running into reads / writes to objects that have died.
- * By default it will print a warning.
- * Use the `"error"` option to easy debugging to see where the error was thrown and when the offending read / write took place
- *
- * @param mode `"warn"`, `"error"` or `"ignore"`
- */
-export declare function setLivelinessChecking(mode: LivelinessMode): void;
-/**
- * Returns the current liveliness checking mode.
- *
- * @returns `"warn"`, `"error"` or `"ignore"`
- */
-export declare function getLivelinessChecking(): LivelinessMode;
-/**
- * @deprecated use LivelinessMode instead
- * @hidden
- */
-export declare type LivelynessMode = LivelinessMode;
-/**
- * @deprecated use setLivelinessChecking instead
- * @hidden
- *
- * Defines what MST should do when running into reads / writes to objects that have died.
- * By default it will print a warning.
- * Use the `"error"` option to easy debugging to see where the error was thrown and when the offending read / write took place
- *
- * @param mode `"warn"`, `"error"` or `"ignore"`
- */
-export declare function setLivelynessChecking(mode: LivelinessMode): void;
+/**
+ * Defines what MST should do when running into reads / writes to objects that have died.
+ * - `"warn"`: Print a warning (default).
+ * - `"error"`: Throw an exception.
+ * - "`ignore`": Do nothing.
+ */
+export declare type LivelinessMode = "warn" | "error" | "ignore";
+/**
+ * Defines what MST should do when running into reads / writes to objects that have died.
+ * By default it will print a warning.
+ * Use the `"error"` option to easy debugging to see where the error was thrown and when the offending read / write took place
+ *
+ * @param mode `"warn"`, `"error"` or `"ignore"`
+ */
+export declare function setLivelinessChecking(mode: LivelinessMode): void;
+/**
+ * Returns the current liveliness checking mode.
+ *
+ * @returns `"warn"`, `"error"` or `"ignore"`
+ */
+export declare function getLivelinessChecking(): LivelinessMode;
+/**
+ * @deprecated use LivelinessMode instead
+ * @hidden
+ */
+export declare type LivelynessMode = LivelinessMode;
+/**
+ * @deprecated use setLivelinessChecking instead
+ * @hidden
+ *
+ * Defines what MST should do when running into reads / writes to objects that have died.
+ * By default it will print a warning.
+ * Use the `"error"` option to easy debugging to see where the error was thrown and when the offending read / write took place
+ *
+ * @param mode `"warn"`, `"error"` or `"ignore"`
+ */
+export declare function setLivelynessChecking(mode: LivelinessMode): void;

package/dist/core/node/node-utils.d.ts

@@ -1,28 +1,28 @@
-import { IAnyType } from "../../internal";
-/** @hidden */
-declare const $stateTreeNodeType: unique symbol;
-/**
- * Common interface that represents a node instance.
- * @hidden
- */
-export interface IStateTreeNode<IT extends IAnyType = IAnyType> {
-    readonly [$stateTreeNodeType]?: [IT] | [any];
-}
-/** @hidden */
-export declare type TypeOfValue<T extends IAnyStateTreeNode> = T extends IStateTreeNode<infer IT> ? IT : never;
-/**
- * Represents any state tree node instance.
- * @hidden
- */
-export interface IAnyStateTreeNode extends IStateTreeNode<IAnyType> {
-}
-/**
- * Returns true if the given value is a node in a state tree.
- * More precisely, that is, if the value is an instance of a
- * `types.model`, `types.array` or `types.map`.
- *
- * @param value
- * @returns true if the value is a state tree node.
- */
-export declare function isStateTreeNode<IT extends IAnyType = IAnyType>(value: any): value is IStateTreeNode<IT>;
-export {};
+import { IAnyType, STNValue, Instance, IAnyComplexType } from "../../internal";
+/** @hidden */
+declare const $stateTreeNodeType: unique symbol;
+/**
+ * Common interface that represents a node instance.
+ * @hidden
+ */
+export interface IStateTreeNode<IT extends IAnyType = IAnyType> {
+    readonly [$stateTreeNodeType]?: [IT] | [any];
+}
+/** @hidden */
+export declare type TypeOfValue<T extends IAnyStateTreeNode> = T extends IStateTreeNode<infer IT> ? IT : never;
+/**
+ * Represents any state tree node instance.
+ * @hidden
+ */
+export interface IAnyStateTreeNode extends STNValue<any, IAnyType> {
+}
+/**
+ * Returns true if the given value is a node in a state tree.
+ * More precisely, that is, if the value is an instance of a
+ * `types.model`, `types.array` or `types.map`.
+ *
+ * @param value
+ * @returns true if the value is a state tree node.
+ */
+export declare function isStateTreeNode<IT extends IAnyComplexType = IAnyComplexType>(value: any): value is STNValue<Instance<IT>, IT>;
+export {};

package/dist/core/node/object-node.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/core/node/scalar-node.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/core/process.d.ts

@@ -1,45 +1,45 @@
-/**
- * @deprecated has been renamed to `flow()`.
- * @hidden
- */
-export declare function process<R>(generator: () => IterableIterator<any>): () => Promise<R>;
-/**
- * @deprecated has been renamed to `flow()`.
- * @hidden
- */
-export declare function process<A1>(generator: (a1: A1) => IterableIterator<any>): (a1: A1) => Promise<any>;
-/**
- * @deprecated has been renamed to `flow()`.
- * @hidden
- */
-export declare function process<A1, A2>(generator: (a1: A1, a2: A2) => IterableIterator<any>): (a1: A1, a2: A2) => Promise<any>;
-/**
- * @deprecated has been renamed to `flow()`.
- * @hidden
- */
-export declare function process<A1, A2, A3>(generator: (a1: A1, a2: A2, a3: A3) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3) => Promise<any>;
-/**
- * @deprecated has been renamed to `flow()`.
- * @hidden
- */
-export declare function process<A1, A2, A3, A4>(generator: (a1: A1, a2: A2, a3: A3, a4: A4) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4) => Promise<any>;
-/**
- * @deprecated has been renamed to `flow()`.
- * @hidden
- */
-export declare function process<A1, A2, A3, A4, A5>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => Promise<any>;
-/**
- * @deprecated has been renamed to `flow()`.
- * @hidden
- */
-export declare function process<A1, A2, A3, A4, A5, A6>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => Promise<any>;
-/**
- * @deprecated has been renamed to `flow()`.
- * @hidden
- */
-export declare function process<A1, A2, A3, A4, A5, A6, A7>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => Promise<any>;
-/**
- * @deprecated has been renamed to `flow()`.
- * @hidden
- */
-export declare function process<A1, A2, A3, A4, A5, A6, A7, A8>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<R>(generator: () => IterableIterator<any>): () => Promise<R>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1>(generator: (a1: A1) => IterableIterator<any>): (a1: A1) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2>(generator: (a1: A1, a2: A2) => IterableIterator<any>): (a1: A1, a2: A2) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3>(generator: (a1: A1, a2: A2, a3: A3) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3, A4>(generator: (a1: A1, a2: A2, a3: A3, a4: A4) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3, A4, A5>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3, A4, A5, A6>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3, A4, A5, A6, A7>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => Promise<any>;
+/**
+ * @deprecated has been renamed to `flow()`.
+ * @hidden
+ */
+export declare function process<A1, A2, A3, A4, A5, A6, A7, A8>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8) => Promise<any>;

package/dist/core/type/type-checker.d.ts

@@ -1,30 +1,30 @@
-import { IAnyType, ExtractCSTWithSTN } from "../../internal";
-/** Validation context entry, this is, where the validation should run against which type */
-export interface IValidationContextEntry {
-    /** Subpath where the validation should be run, or an empty string to validate it all */
-    path: string;
-    /** Type to validate the subpath against */
-    type: IAnyType;
-}
-/** Array of validation context entries */
-export declare type IValidationContext = IValidationContextEntry[];
-/** Type validation error */
-export interface IValidationError {
-    /** Validation context */
-    context: IValidationContext;
-    /** Value that was being validated, either a snapshot or an instance */
-    value: any;
-    /** Error message */
-    message?: string;
-}
-/** Type validation result, which is an array of type validation errors */
-export declare type IValidationResult = IValidationError[];
-/**
- * Run's the typechecker for the given type on the given value, which can be a snapshot or an instance.
- * Throws if the given value is not according the provided type specification.
- * Use this if you need typechecks even in a production build (by default all automatic runtime type checks will be skipped in production builds)
- *
- * @param type Type to check against.
- * @param value Value to be checked, either a snapshot or an instance.
- */
-export declare function typecheck<IT extends IAnyType>(type: IT, value: ExtractCSTWithSTN<IT>): void;
+import { IAnyType, ExtractCSTWithSTN } from "../../internal";
+/** Validation context entry, this is, where the validation should run against which type */
+export interface IValidationContextEntry {
+    /** Subpath where the validation should be run, or an empty string to validate it all */
+    path: string;
+    /** Type to validate the subpath against */
+    type: IAnyType;
+}
+/** Array of validation context entries */
+export declare type IValidationContext = IValidationContextEntry[];
+/** Type validation error */
+export interface IValidationError {
+    /** Validation context */
+    context: IValidationContext;
+    /** Value that was being validated, either a snapshot or an instance */
+    value: any;
+    /** Error message */
+    message?: string;
+}
+/** Type validation result, which is an array of type validation errors */
+export declare type IValidationResult = IValidationError[];
+/**
+ * Run's the typechecker for the given type on the given value, which can be a snapshot or an instance.
+ * Throws if the given value is not according the provided type specification.
+ * Use this if you need typechecks even in a production build (by default all automatic runtime type checks will be skipped in production builds)
+ *
+ * @param type Type to check against.
+ * @param value Value to be checked, either a snapshot or an instance.
+ */
+export declare function typecheck<IT extends IAnyType>(type: IT, value: ExtractCSTWithSTN<IT>): void;