mobx-state-tree 3.15.0 → 3.17.3

package/dist/core/action.d.ts

@@ -1,50 +1,50 @@
-import { IDisposer, IAnyStateTreeNode, IActionContext } from "../internal";
-export declare type IMiddlewareEventType = "action" | "flow_spawn" | "flow_resume" | "flow_resume_error" | "flow_return" | "flow_throw";
-export interface IMiddlewareEvent extends IActionContext {
-    /** Event type */
-    readonly type: IMiddlewareEventType;
-    /** Parent event unique id */
-    readonly parentId: number;
-    /** Parent event object */
-    readonly parentEvent: IMiddlewareEvent | undefined;
-    /** Root event unique id */
-    readonly rootId: number;
-    /** Id of all events, from root until current (excluding current) */
-    readonly allParentIds: number[];
-}
-export declare type IMiddlewareHandler = (actionCall: IMiddlewareEvent, next: (actionCall: IMiddlewareEvent, callback?: (value: any) => any) => void, abort: (value: any) => void) => any;
-/**
- * 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)
- *
- * @param target Node to apply the middleware to.
- * @param middleware Middleware to apply.
- * @returns A callable function to dispose the middleware.
- */
-export declare function addMiddleware(target: IAnyStateTreeNode, handler: IMiddlewareHandler, includeHooks?: boolean): IDisposer;
-/**
- * Binds middleware to a specific action.
- *
- * Example:
- * ```ts
- * type.actions(self => {
- *   function takeA____() {
- *       self.toilet.donate()
- *       self.wipe()
- *       self.wipe()
- *       self.toilet.flush()
- *   }
- *   return {
- *     takeA____: decorate(atomic, takeA____)
- *   }
- * })
- * ```
- *
- * @param handler
- * @param fn
- * @param includeHooks
- * @returns The original function
- */
-export declare function decorate<T extends Function>(handler: IMiddlewareHandler, fn: T, includeHooks?: boolean): T;
+import { IDisposer, IAnyStateTreeNode, IActionContext } from "../internal";
+export declare type IMiddlewareEventType = "action" | "flow_spawn" | "flow_resume" | "flow_resume_error" | "flow_return" | "flow_throw";
+export interface IMiddlewareEvent extends IActionContext {
+    /** Event type */
+    readonly type: IMiddlewareEventType;
+    /** Parent event unique id */
+    readonly parentId: number;
+    /** Parent event object */
+    readonly parentEvent: IMiddlewareEvent | undefined;
+    /** Root event unique id */
+    readonly rootId: number;
+    /** Id of all events, from root until current (excluding current) */
+    readonly allParentIds: number[];
+}
+export declare type IMiddlewareHandler = (actionCall: IMiddlewareEvent, next: (actionCall: IMiddlewareEvent, callback?: (value: any) => any) => void, abort: (value: any) => void) => any;
+/**
+ * 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](concepts/middleware.md)
+ *
+ * @param target Node to apply the middleware to.
+ * @param middleware Middleware to apply.
+ * @returns A callable function to dispose the middleware.
+ */
+export declare function addMiddleware(target: IAnyStateTreeNode, handler: IMiddlewareHandler, includeHooks?: boolean): IDisposer;
+/**
+ * Binds middleware to a specific action.
+ *
+ * Example:
+ * ```ts
+ * type.actions(self => {
+ *   function takeA____() {
+ *       self.toilet.donate()
+ *       self.wipe()
+ *       self.wipe()
+ *       self.toilet.flush()
+ *   }
+ *   return {
+ *     takeA____: decorate(atomic, takeA____)
+ *   }
+ * })
+ * ```
+ *
+ * @param handler
+ * @param fn
+ * @param includeHooks
+ * @returns The original function
+ */
+export declare function decorate<T extends Function>(handler: IMiddlewareHandler, fn: T, includeHooks?: boolean): T;

package/dist/core/actionContext.d.ts

@@ -1,27 +1,27 @@
-import { IAnyStateTreeNode, IMiddlewareEvent } from "../internal";
-export interface IActionContext {
-    /** Event name (action name for actions) */
-    readonly name: string;
-    /** Event unique id */
-    readonly id: number;
-    /** Parent action event object */
-    readonly parentActionEvent: IMiddlewareEvent | undefined;
-    /** Event context (node where the action was invoked) */
-    readonly context: IAnyStateTreeNode;
-    /** Event tree (root node of the node where the action was invoked) */
-    readonly tree: IAnyStateTreeNode;
-    /** Event arguments in an array (action arguments for actions) */
-    readonly args: any[];
-}
-/**
- * Returns the currently executing MST action context, or undefined if none.
- */
-export declare function getRunningActionContext(): IActionContext | undefined;
-/**
- * Returns if the given action context is a parent of this action context.
- */
-export declare function isActionContextChildOf(actionContext: IActionContext, parent: number | IActionContext | IMiddlewareEvent): boolean;
-/**
- * Returns if the given action context is this or a parent of this action context.
- */
-export declare function isActionContextThisOrChildOf(actionContext: IActionContext, parentOrThis: number | IActionContext | IMiddlewareEvent): boolean;
+import { IAnyStateTreeNode, IMiddlewareEvent } from "../internal";
+export interface IActionContext {
+    /** Event name (action name for actions) */
+    readonly name: string;
+    /** Event unique id */
+    readonly id: number;
+    /** Parent action event object */
+    readonly parentActionEvent: IMiddlewareEvent | undefined;
+    /** Event context (node where the action was invoked) */
+    readonly context: IAnyStateTreeNode;
+    /** Event tree (root node of the node where the action was invoked) */
+    readonly tree: IAnyStateTreeNode;
+    /** Event arguments in an array (action arguments for actions) */
+    readonly args: any[];
+}
+/**
+ * Returns the currently executing MST action context, or undefined if none.
+ */
+export declare function getRunningActionContext(): IActionContext | undefined;
+/**
+ * Returns if the given action context is a parent of this action context.
+ */
+export declare function isActionContextChildOf(actionContext: IActionContext, parent: number | IActionContext | IMiddlewareEvent): boolean;
+/**
+ * Returns if the given action context is this or a parent of this action context.
+ */
+export declare function isActionContextThisOrChildOf(actionContext: IActionContext, parentOrThis: number | IActionContext | IMiddlewareEvent): boolean;

package/dist/core/flow.d.ts

@@ -1,14 +1,63 @@
-/**
- * See [asynchronous actions](https://github.com/mobxjs/mobx-state-tree/blob/master/docs/async-actions.md).
- *
- * @returns The flow as a promise.
- */
-export declare function flow<R, Args extends any[]>(generator: (...args: Args) => Generator<any, R, any>): (...args: Args) => Promise<R>;
-/**
- * @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): T;
+/**
+ * @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) => Generator<Promise<any>, R, any>): (...args: Args) => Promise<FlowReturn<R>>;
+/**
+ * @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): 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/json-patch.d.ts

@@ -1,36 +1,36 @@
-/**
- * https://tools.ietf.org/html/rfc6902
- * http://jsonpatch.com/
- */
-export interface IJsonPatch {
-    readonly op: "replace" | "add" | "remove";
-    readonly path: string;
-    readonly value?: any;
-}
-export interface IReversibleJsonPatch extends IJsonPatch {
-    readonly oldValue: any;
-}
-/**
- * Escape slashes and backslashes.
- *
- * http://tools.ietf.org/html/rfc6901
- */
-export declare function escapeJsonPath(path: string): string;
-/**
- * Unescape slashes and backslashes.
- */
-export declare function unescapeJsonPath(path: string): string;
-/**
- * Generates a json-path compliant json path from path parts.
- *
- * @param path
- * @returns
- */
-export declare function joinJsonPath(path: string[]): string;
-/**
- * Splits and decodes a json path into several parts.
- *
- * @param path
- * @returns
- */
-export declare function splitJsonPath(path: string): string[];
+/**
+ * https://tools.ietf.org/html/rfc6902
+ * http://jsonpatch.com/
+ */
+export interface IJsonPatch {
+    readonly op: "replace" | "add" | "remove";
+    readonly path: string;
+    readonly value?: any;
+}
+export interface IReversibleJsonPatch extends IJsonPatch {
+    readonly oldValue: any;
+}
+/**
+ * Escape slashes and backslashes.
+ *
+ * http://tools.ietf.org/html/rfc6901
+ */
+export declare function escapeJsonPath(path: string): string;
+/**
+ * Unescape slashes and backslashes.
+ */
+export declare function unescapeJsonPath(path: string): string;
+/**
+ * Generates a json-path compliant json path from path parts.
+ *
+ * @param path
+ * @returns
+ */
+export declare function joinJsonPath(path: string[]): string;
+/**
+ * Splits and decodes a json path into several parts.
+ *
+ * @param path
+ * @returns
+ */
+export declare function splitJsonPath(path: string): string[];