mobx-state-tree 3.14.1 → 3.17.2

package/dist/core/action.d.ts

@@ -17,7 +17,7 @@ export declare type IMiddlewareHandler = (actionCall: IMiddlewareEvent, next: (a
  * Middleware can be used to intercept any action is invoked on the subtree where it is attached.
  * If a tree is protected (by default), this means that any mutation of the tree will pass through your middleware.
  *
- * For more details, see the [middleware docs](../middleware.md)
+ * For more details, see the [middleware docs](concepts/middleware.md)
  *
  * @param target Node to apply the middleware to.
  * @param middleware Middleware to apply.

package/dist/core/flow.d.ts

@@ -1,30 +1,63 @@
-/** @hidden */
-declare const $flowYield: unique symbol;
-/** @hidden */
-export interface FlowYield {
-    [$flowYield]: undefined;
-}
-/** @hidden */
-declare const $flowReturn: unique symbol;
-/** @hidden */
-export interface FlowReturn<T> {
-    [$flowReturn]: T;
-}
-/** @hidden */
-export declare type FlowReturnType<R> = IfAllAreFlowYieldThenVoid<R extends FlowReturn<infer FR> ? FR extends Promise<infer FRP> ? FRP : FR : R extends Promise<any> ? FlowYield : R>;
-/** @hidden */
-export declare type IfAllAreFlowYieldThenVoid<R> = Exclude<R, FlowYield> extends never ? void : Exclude<R, FlowYield>;
 /**
- * See [asynchronous actions](https://github.com/mobxjs/mobx-state-tree/blob/master/docs/async-actions.md).
+ * @hidden
+ */
+export declare type FlowReturn<R> = R extends Promise<infer T> ? T : R;
+/**
+ * See [asynchronous actions](concepts/async-actions.md).
  *
  * @returns The flow as a promise.
  */
-export declare function flow<R, Args extends any[]>(generator: (...args: Args) => IterableIterator<R>): (...args: Args) => Promise<FlowReturnType<R>>;
+export declare function flow<R, Args extends any[]>(generator: (...args: Args) => Generator<Promise<any>, R, any>): (...args: Args) => Promise<FlowReturn<R>>;
 /**
- *  Used for TypeScript to make flows that return a promise return the actual promise result.
+ * @deprecated Not needed since TS3.6.
+ * Used for TypeScript to make flows that return a promise return the actual promise result.
  *
  * @param val
  * @returns
  */
-export declare function castFlowReturn<T>(val: T): FlowReturn<T>;
-export {};
+export declare function castFlowReturn<T>(val: T): T;
+/**
+ * @experimental
+ * experimental api - might change on minor/patch releases
+ *
+ * Convert a promise-returning function to a generator-returning one.
+ * This is intended to allow for usage of `yield*` in async actions to
+ * retain the promise return type.
+ *
+ * Example:
+ * ```ts
+ * function getDataAsync(input: string): Promise<number> { ... }
+ * const getDataGen = toGeneratorFunction(getDataAsync);
+ *
+ * const someModel.actions(self => ({
+ *   someAction: flow(function*() {
+ *     // value is typed as number
+ *     const value = yield* getDataGen("input value");
+ *     ...
+ *   })
+ * }))
+ * ```
+ */
+export declare function toGeneratorFunction<R, Args extends any[]>(p: (...args: Args) => Promise<R>): (...args: Args) => Generator<Promise<R>, R, R>;
+/**
+ * @experimental
+ * experimental api - might change on minor/patch releases
+ *
+ * Convert a promise to a generator yielding that promise
+ * This is intended to allow for usage of `yield*` in async actions to
+ * retain the promise return type.
+ *
+ * Example:
+ * ```ts
+ * function getDataAsync(input: string): Promise<number> { ... }
+ *
+ * const someModel.actions(self => ({
+ *   someAction: flow(function*() {
+ *     // value is typed as number
+ *     const value = yield* toGenerator(getDataAsync("input value"));
+ *     ...
+ *   })
+ * }))
+ * ```
+ */
+export declare function toGenerator<R>(p: Promise<R>): Generator<Promise<R>, R, R>;

package/dist/core/mst-operations.d.ts

@@ -1,4 +1,4 @@
-import { IAnyStateTreeNode, IType, IAnyModelType, IStateTreeNode, IJsonPatch, IDisposer, IAnyType, ReferenceIdentifier, TypeOfValue, IActionContext } from "../internal";
+import { IAnyStateTreeNode, IType, IAnyModelType, IStateTreeNode, IJsonPatch, IDisposer, IAnyType, ReferenceIdentifier, TypeOfValue, IActionContext, IAnyComplexType } from "../internal";
 /** @hidden */
 export declare type TypeOrStateTreeNodeToStateTreeNode<T extends IAnyType | IAnyStateTreeNode> = T extends IType<any, any, infer TT> ? TT & IStateTreeNode<T> : T;
 /**
@@ -7,7 +7,7 @@ export declare type TypeOrStateTreeNodeToStateTreeNode<T extends IAnyType | IAny
  * @param object
  * @returns
  */
-export declare function getType(object: IAnyStateTreeNode): IAnyType;
+export declare function getType(object: IAnyStateTreeNode): IAnyComplexType;
 /**
  * Returns the _declared_ type of the given sub property of an object, array or map.
  * In the case of arrays and maps the property name is optional and will be ignored.
@@ -171,7 +171,7 @@ export declare function hasParent(target: IAnyStateTreeNode, depth?: number): bo
  * @param depth How far should we look upward? 1 by default.
  * @returns
  */
-export declare function getParent<IT extends IAnyStateTreeNode | IAnyType>(target: IAnyStateTreeNode, depth?: number): TypeOrStateTreeNodeToStateTreeNode<IT>;
+export declare function getParent<IT extends IAnyStateTreeNode | IAnyComplexType>(target: IAnyStateTreeNode, depth?: number): TypeOrStateTreeNodeToStateTreeNode<IT>;
 /**
  * Given a model instance, returns `true` if the object has a parent of given type, that is, is part of another object, map or array
  *
@@ -179,7 +179,7 @@ export declare function getParent<IT extends IAnyStateTreeNode | IAnyType>(targe
  * @param type
  * @returns
  */
-export declare function hasParentOfType(target: IAnyStateTreeNode, type: IAnyType): boolean;
+export declare function hasParentOfType(target: IAnyStateTreeNode, type: IAnyComplexType): boolean;
 /**
  * Returns the target's parent of a given type, or throws.
  *
@@ -187,7 +187,7 @@ export declare function hasParentOfType(target: IAnyStateTreeNode, type: IAnyTyp
  * @param type
  * @returns
  */
-export declare function getParentOfType<IT extends IAnyType>(target: IAnyStateTreeNode, type: IT): IT["Type"];
+export declare function getParentOfType<IT extends IAnyComplexType>(target: IAnyStateTreeNode, type: IT): IT["Type"];
 /**
  * Given an object in a model tree, returns the root object of that tree.
  *
@@ -197,7 +197,7 @@ export declare function getParentOfType<IT extends IAnyType>(target: IAnyStateTr
  * @param target
  * @returns
  */
-export declare function getRoot<IT extends IAnyType | IAnyStateTreeNode>(target: IAnyStateTreeNode): TypeOrStateTreeNodeToStateTreeNode<IT>;
+export declare function getRoot<IT extends IAnyComplexType | IAnyStateTreeNode>(target: IAnyStateTreeNode): TypeOrStateTreeNodeToStateTreeNode<IT>;
 /**
  * Returns the path of the given object in the model tree
  *
@@ -237,7 +237,7 @@ export declare function resolvePath(target: IAnyStateTreeNode, path: string): an
  * @param identifier
  * @returns
  */
-export declare function resolveIdentifier<IT extends IAnyType>(type: IT, target: IAnyStateTreeNode, identifier: ReferenceIdentifier): IT["Type"] | undefined;
+export declare function resolveIdentifier<IT extends IAnyModelType>(type: IT, target: IAnyStateTreeNode, identifier: ReferenceIdentifier): IT["Type"] | undefined;
 /**
  * Returns the identifier of the target node.
  * This is the *string normalized* identifier, which might not match the type of the identifier attribute

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/node-utils.d.ts

@@ -1,4 +1,4 @@
-import { IAnyType } from "../../internal";
+import { IAnyType, STNValue, Instance, IAnyComplexType } from "../../internal";
 /** @hidden */
 declare const $stateTreeNodeType: unique symbol;
 /**
@@ -14,7 +14,7 @@ export declare type TypeOfValue<T extends IAnyStateTreeNode> = T extends IStateT
  * Represents any state tree node instance.
  * @hidden
  */
-export interface IAnyStateTreeNode extends IStateTreeNode<IAnyType> {
+export interface IAnyStateTreeNode extends STNValue<any, IAnyType> {
 }
 /**
  * Returns true if the given value is a node in a state tree.
@@ -24,5 +24,5 @@ export interface IAnyStateTreeNode extends IStateTreeNode<IAnyType> {
  * @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 declare function isStateTreeNode<IT extends IAnyComplexType = IAnyComplexType>(value: any): value is STNValue<Instance<IT>, IT>;
 export {};

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

@@ -1,5 +1,6 @@
 import { IValidationContext, IValidationResult, IStateTreeNode, ModelPrimitive } from "../../internal";
 /**
+ * A state tree node value.
  * @hidden
  */
 export declare type STNValue<T, IT extends IAnyType> = T extends object ? T & IStateTreeNode<IT> : T;

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { IModelType, IAnyModelType, IDisposer, IMSTMap, IMapType, IMSTArray, IArrayType, IType, IAnyType, ModelPrimitive, ISimpleType, IComplexType, IAnyComplexType, IReferenceType, _CustomCSProcessor, _CustomOrOther, _CustomJoin, _NotCustomized, typecheck, escapeJsonPath, unescapeJsonPath, joinJsonPath, splitJsonPath, IJsonPatch, IReversibleJsonPatch, decorate, addMiddleware, IMiddlewareEvent, IActionTrackingMiddleware2Call, IMiddlewareHandler, IMiddlewareEventType, IActionTrackingMiddlewareHooks, IActionTrackingMiddleware2Hooks, process, isStateTreeNode, IStateTreeNode, IAnyStateTreeNode, flow, castFlowReturn, applyAction, onAction, IActionRecorder, ISerializedActionCall, recordActions, createActionTrackingMiddleware, createActionTrackingMiddleware2, setLivelinessChecking, getLivelinessChecking, LivelinessMode, setLivelynessChecking, // to be deprecated
 LivelynessMode, // to be deprecated
-ModelSnapshotType, ModelCreationType, ModelSnapshotType2, ModelCreationType2, ModelInstanceType, ModelInstanceTypeProps, ModelPropertiesDeclarationToProperties, ModelProperties, ModelPropertiesDeclaration, ModelActions, ITypeUnion, CustomTypeOptions, UnionOptions, Instance, SnapshotIn, SnapshotOut, SnapshotOrInstance, TypeOrStateTreeNodeToStateTreeNode, UnionStringArray, getType, getChildType, onPatch, onSnapshot, applyPatch, IPatchRecorder, recordPatches, protect, unprotect, isProtected, applySnapshot, getSnapshot, hasParent, getParent, hasParentOfType, getParentOfType, getRoot, getPath, getPathParts, isRoot, resolvePath, resolveIdentifier, getIdentifier, tryResolve, getRelativePath, clone, detach, destroy, isAlive, addDisposer, getEnv, walk, IModelReflectionData, IModelReflectionPropertiesData, IMaybeIType, IMaybe, IMaybeNull, IOptionalIType, OptionalDefaultValueOrFunction, ValidOptionalValue, ValidOptionalValues, getMembers, getPropertyMembers, TypeOfValue, cast, castToSnapshot, castToReferenceSnapshot, isType, isArrayType, isFrozenType, isIdentifierType, isLateType, isLiteralType, isMapType, isModelType, isOptionalType, isPrimitiveType, isReferenceType, isRefinementType, isUnionType, tryReference, isValidReference, OnReferenceInvalidated, OnReferenceInvalidatedEvent, ReferenceOptions, ReferenceOptionsGetSet, ReferenceOptionsOnInvalidated, ReferenceIdentifier, ISnapshotProcessor, ISnapshotProcessors, getNodeId, IActionContext, getRunningActionContext, isActionContextChildOf, isActionContextThisOrChildOf, types } from "./internal";
+ModelSnapshotType, ModelCreationType, ModelSnapshotType2, ModelCreationType2, ModelInstanceType, ModelInstanceTypeProps, ModelPropertiesDeclarationToProperties, ModelProperties, ModelPropertiesDeclaration, ModelActions, ITypeUnion, CustomTypeOptions, UnionOptions, Instance, SnapshotIn, SnapshotOut, SnapshotOrInstance, TypeOrStateTreeNodeToStateTreeNode, UnionStringArray, getType, getChildType, onPatch, onSnapshot, applyPatch, IPatchRecorder, recordPatches, protect, unprotect, isProtected, applySnapshot, getSnapshot, hasParent, getParent, hasParentOfType, getParentOfType, getRoot, getPath, getPathParts, isRoot, resolvePath, resolveIdentifier, getIdentifier, tryResolve, getRelativePath, clone, detach, destroy, isAlive, addDisposer, getEnv, walk, IModelReflectionData, IModelReflectionPropertiesData, IMaybeIType, IMaybe, IMaybeNull, IOptionalIType, OptionalDefaultValueOrFunction, ValidOptionalValue, ValidOptionalValues, getMembers, getPropertyMembers, TypeOfValue, cast, castToSnapshot, castToReferenceSnapshot, isType, isArrayType, isFrozenType, isIdentifierType, isLateType, isLiteralType, isMapType, isModelType, isOptionalType, isPrimitiveType, isReferenceType, isRefinementType, isUnionType, tryReference, isValidReference, OnReferenceInvalidated, OnReferenceInvalidatedEvent, ReferenceOptions, ReferenceOptionsGetSet, ReferenceOptionsOnInvalidated, ReferenceIdentifier, ISnapshotProcessor, ISnapshotProcessors, getNodeId, IActionContext, getRunningActionContext, isActionContextChildOf, isActionContextThisOrChildOf, types, toGeneratorFunction, toGenerator } from "./internal";