@jbrowse/mobx-state-tree 5.6.9 → 5.7.0

package/esm/core/action.d.ts

@@ -0,0 +1,87 @@
+import type { IActionContext, IAnyStateTreeNode, IDisposer } from "../internal.ts";
+export 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 interface FunctionWithFlag extends Function {
+    _isMSTAction?: boolean;
+    _isFlowAction?: boolean;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export type IMiddleware = {
+    handler: IMiddlewareHandler;
+    includeHooks: boolean;
+};
+export type IMiddlewareHandler = (actionCall: IMiddlewareEvent, next: (actionCall: IMiddlewareEvent, callback?: (value: any) => any) => void, abort: (value: any) => void) => any;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function getCurrentActionContext(): IMiddlewareEvent | undefined;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function getNextActionId(): number;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function runWithActionContext(context: IMiddlewareEvent, fn: Function): any;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function getParentActionContext(parentContext: IMiddlewareEvent | undefined): IMiddlewareEvent | undefined;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function createActionInvoker<T extends FunctionWithFlag>(target: IAnyStateTreeNode, name: string, fn: T): (...args: any[]) => 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/esm/core/action.js

@@ -0,0 +1,219 @@
+import { action as mobxAction } from "mobx";
+import { Hook, devMode, fail, getRoot, getStateTreeNode, warnError } from "../internal.js";
+let nextActionId = 1;
+let currentActionContext;
+/**
+ * @internal
+ * @hidden
+ */
+export function getCurrentActionContext() {
+    return currentActionContext;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export function getNextActionId() {
+    return nextActionId++;
+}
+// TODO: optimize away entire action context if there is no middleware in tree?
+/**
+ * @internal
+ * @hidden
+ */
+export function runWithActionContext(context, fn) {
+    const node = getStateTreeNode(context.context);
+    if (context.type === "action") {
+        node.assertAlive({
+            actionContext: context
+        });
+    }
+    const baseIsRunningAction = node._isRunningAction;
+    node._isRunningAction = true;
+    const previousContext = currentActionContext;
+    currentActionContext = context;
+    try {
+        return runMiddleWares(node, context, fn);
+    }
+    finally {
+        currentActionContext = previousContext;
+        node._isRunningAction = baseIsRunningAction;
+    }
+}
+/**
+ * @internal
+ * @hidden
+ */
+export function getParentActionContext(parentContext) {
+    if (!parentContext) {
+        return undefined;
+    }
+    if (parentContext.type === "action") {
+        return parentContext;
+    }
+    return parentContext.parentActionEvent;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export function createActionInvoker(target, name, fn) {
+    const res = function (...args) {
+        const id = getNextActionId();
+        const parentContext = currentActionContext;
+        const parentActionContext = getParentActionContext(parentContext);
+        return runWithActionContext({
+            type: "action",
+            name,
+            id,
+            args,
+            context: target,
+            tree: getRoot(target),
+            rootId: parentContext ? parentContext.rootId : id,
+            parentId: parentContext ? parentContext.id : 0,
+            allParentIds: parentContext
+                ? [...parentContext.allParentIds, parentContext.id]
+                : [],
+            parentEvent: parentContext,
+            parentActionEvent: parentActionContext
+        }, fn);
+    };
+    res._isMSTAction = true;
+    res._isFlowAction = fn._isFlowAction;
+    return res;
+}
+/**
+ * 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 function addMiddleware(target, handler, includeHooks = true) {
+    const node = getStateTreeNode(target);
+    if (devMode()) {
+        if (!node.isProtectionEnabled) {
+            warnError("It is recommended to protect the state tree before attaching action middleware, as otherwise it cannot be guaranteed that all changes are passed through middleware. See `protect`");
+        }
+    }
+    return node.addMiddleWare(handler, includeHooks);
+}
+/**
+ * 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 function decorate(handler, fn, includeHooks = true) {
+    const middleware = { handler, includeHooks };
+    fn.$mst_middleware = fn.$mst_middleware || [];
+    fn.$mst_middleware.push(middleware);
+    return fn;
+}
+class CollectedMiddlewares {
+    arrayIndex = 0;
+    inArrayIndex = 0;
+    middlewares = [];
+    constructor(node, fn) {
+        // we just push middleware arrays into an array of arrays to avoid making copies
+        if (fn.$mst_middleware) {
+            this.middlewares.push(fn.$mst_middleware);
+        }
+        let n = node;
+        // Find all middlewares. Optimization: cache this?
+        while (n) {
+            if (n.middlewares) {
+                this.middlewares.push(n.middlewares);
+            }
+            n = n.parent;
+        }
+    }
+    get isEmpty() {
+        return this.middlewares.length <= 0;
+    }
+    getNextMiddleware() {
+        const array = this.middlewares[this.arrayIndex];
+        if (!array) {
+            return undefined;
+        }
+        const item = array[this.inArrayIndex++];
+        if (!item) {
+            this.arrayIndex++;
+            this.inArrayIndex = 0;
+            return this.getNextMiddleware();
+        }
+        return item;
+    }
+}
+function runMiddleWares(node, baseCall, originalFn) {
+    const middlewares = new CollectedMiddlewares(node, originalFn);
+    // Short circuit
+    if (middlewares.isEmpty) {
+        return mobxAction(originalFn)(...baseCall.args);
+    }
+    let result = null;
+    function runNextMiddleware(call) {
+        const middleware = middlewares.getNextMiddleware();
+        const handler = middleware && middleware.handler;
+        if (!handler) {
+            return mobxAction(originalFn)(...call.args);
+        }
+        // skip hooks if asked to
+        if (!middleware.includeHooks && Hook[call.name]) {
+            return runNextMiddleware(call);
+        }
+        let nextInvoked = false;
+        function next(call2, callback) {
+            nextInvoked = true;
+            // the result can contain
+            // - the non manipulated return value from an action
+            // - the non manipulated abort value
+            // - one of the above but manipulated through the callback function
+            result = runNextMiddleware(call2);
+            if (callback) {
+                result = callback(result);
+            }
+        }
+        let abortInvoked = false;
+        function abort(value) {
+            abortInvoked = true;
+            // overwrite the result
+            // can be manipulated through middlewares earlier in the queue using the callback fn
+            result = value;
+        }
+        handler(call, next, abort);
+        if (devMode()) {
+            if (!nextInvoked && !abortInvoked) {
+                const node2 = getStateTreeNode(call.tree);
+                throw fail(`Neither the next() nor the abort() callback within the middleware ${handler.name} for the action: "${call.name}" on the node: ${node2.type.name} was invoked.`);
+            }
+            else if (nextInvoked && abortInvoked) {
+                const node2 = getStateTreeNode(call.tree);
+                throw fail(`The next() and abort() callback within the middleware ${handler.name} for the action: "${call.name}" on the node: ${node2.type.name} were invoked.`);
+            }
+        }
+        return result;
+    }
+    return runNextMiddleware(baseCall);
+}
+//# sourceMappingURL=action.js.map

package/esm/core/action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.js","sourceRoot":"","sources":["../../src/core/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,MAAM,CAAA;AAE3C,OAAO,EACL,IAAI,EACJ,OAAO,EACP,IAAI,EACJ,OAAO,EACP,gBAAgB,EAChB,SAAS,EACV,MAAM,gBAAgB,CAAA;AAqDvB,IAAI,YAAY,GAAG,CAAC,CAAA;AACpB,IAAI,oBAAkD,CAAA;AAEtD;;;GAGG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO,oBAAoB,CAAA;AAC7B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,YAAY,EAAE,CAAA;AACvB,CAAC;AAED,+EAA+E;AAC/E;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAyB,EAAE,EAAY;IAC1E,MAAM,IAAI,GAAG,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAE9C,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,WAAW,CAAC;YACf,aAAa,EAAE,OAAO;SACvB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,CAAA;IACjD,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAA;IAC5B,MAAM,eAAe,GAAG,oBAAoB,CAAA;IAC5C,oBAAoB,GAAG,OAAO,CAAA;IAC9B,IAAI,CAAC;QACH,OAAO,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,CAAA;IAC1C,CAAC;YAAS,CAAC;QACT,oBAAoB,GAAG,eAAe,CAAA;QACtC,IAAI,CAAC,gBAAgB,GAAG,mBAAmB,CAAA;IAC7C,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CACpC,aAA2C;IAE3C,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,aAAa,CAAA;IACtB,CAAC;IACD,OAAO,aAAa,CAAC,iBAAiB,CAAA;AACxC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAyB,EACzB,IAAY,EACZ,EAAK;IAEL,MAAM,GAAG,GAAG,UAAU,GAAG,IAAW;QAClC,MAAM,EAAE,GAAG,eAAe,EAAE,CAAA;QAC5B,MAAM,aAAa,GAAG,oBAAoB,CAAA;QAC1C,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAA;QAEjE,OAAO,oBAAoB,CACzB;YACE,IAAI,EAAE,QAAQ;YACd,IAAI;YACJ,EAAE;YACF,IAAI;YACJ,OAAO,EAAE,MAAM;YACf,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC;YACrB,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;YACjD,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC9C,YAAY,EAAE,aAAa;gBACzB,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;gBACnD,CAAC,CAAC,EAAE;YACN,WAAW,EAAE,aAAa;YAC1B,iBAAiB,EAAE,mBAAmB;SACvC,EACD,EAAE,CACH,CAAA;IACH,CAAC,CACA;IAAC,GAAwB,CAAC,YAAY,GAAG,IAAI,CAC7C;IAAC,GAAwB,CAAC,aAAa,GAAG,EAAE,CAAC,aAAa,CAAA;IAC3D,OAAO,GAAG,CAAA;AACZ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAyB,EACzB,OAA2B,EAC3B,eAAwB,IAAI;IAE5B,MAAM,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACrC,IAAI,OAAO,EAAE,EAAE,CAAC;QACd,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC9B,SAAS,CACP,oLAAoL,CACrL,CAAA;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;AAClD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,QAAQ,CACtB,OAA2B,EAC3B,EAAK,EACL,YAAY,GAAG,IAAI;IAEnB,MAAM,UAAU,GAAgB,EAAE,OAAO,EAAE,YAAY,EAAE,CACxD;IAAC,EAAU,CAAC,eAAe,GAAI,EAAU,CAAC,eAAe,IAAI,EAAE,CAC/D;IAAC,EAAU,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAC7C,OAAO,EAAE,CAAA;AACX,CAAC;AAED,MAAM,oBAAoB;IAChB,UAAU,GAAG,CAAC,CAAA;IACd,YAAY,GAAG,CAAC,CAAA;IAChB,WAAW,GAAoB,EAAE,CAAA;IAEzC,YAAY,IAAmB,EAAE,EAAY;QAC3C,gFAAgF;QAChF,IAAK,EAAU,CAAC,eAAe,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAE,EAAU,CAAC,eAAe,CAAC,CAAA;QACpD,CAAC;QACD,IAAI,CAAC,GAAyB,IAAI,CAAA;QAClC,kDAAkD;QAClD,OAAO,CAAC,EAAE,CAAC;YACT,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;gBAClB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAA;YACtC,CAAC;YACD,CAAC,GAAG,CAAC,CAAC,MAAM,CAAA;QACd,CAAC;IACH,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,CAAA;IACrC,CAAC;IAED,iBAAiB;QACf,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC/C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAA;QACvC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,UAAU,EAAE,CAAA;YACjB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;YACrB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACjC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,SAAS,cAAc,CACrB,IAAmB,EACnB,QAA0B,EAC1B,UAAoB;IAEpB,MAAM,WAAW,GAAG,IAAI,oBAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IAC9D,gBAAgB;IAChB,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;QACxB,OAAO,UAAU,CAAC,UAAU,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;IACjD,CAAC;IAED,IAAI,MAAM,GAAQ,IAAI,CAAA;IAEtB,SAAS,iBAAiB,CAAC,IAAsB;QAC/C,MAAM,UAAU,GAAG,WAAW,CAAC,iBAAiB,EAAE,CAAA;QAClD,MAAM,OAAO,GAAG,UAAU,IAAI,UAAU,CAAC,OAAO,CAAA;QAEhD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,UAAU,CAAC,UAAU,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;QAC7C,CAAC;QAED,yBAAyB;QACzB,IAAI,CAAC,UAAW,CAAC,YAAY,IAAK,IAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1D,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC;QAED,IAAI,WAAW,GAAG,KAAK,CAAA;QACvB,SAAS,IAAI,CACX,KAAuB,EACvB,QAA8B;YAE9B,WAAW,GAAG,IAAI,CAAA;YAClB,yBAAyB;YACzB,oDAAoD;YACpD,oCAAoC;YACpC,mEAAmE;YACnE,MAAM,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAA;YACjC,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;YAC3B,CAAC;QACH,CAAC;QAED,IAAI,YAAY,GAAG,KAAK,CAAA;QACxB,SAAS,KAAK,CAAC,KAAU;YACvB,YAAY,GAAG,IAAI,CAAA;YACnB,uBAAuB;YACvB,oFAAoF;YACpF,MAAM,GAAG,KAAK,CAAA;QAChB,CAAC;QAED,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;QAC1B,IAAI,OAAO,EAAE,EAAE,CAAC;YACd,IAAI,CAAC,WAAW,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClC,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACzC,MAAM,IAAI,CACR,qEAAqE,OAAO,CAAC,IAAI,qBAAqB,IAAI,CAAC,IAAI,kBAAkB,KAAK,CAAC,IAAI,CAAC,IAAI,eAAe,CAChK,CAAA;YACH,CAAC;iBAAM,IAAI,WAAW,IAAI,YAAY,EAAE,CAAC;gBACvC,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACzC,MAAM,IAAI,CACR,yDAAyD,OAAO,CAAC,IAAI,qBAAqB,IAAI,CAAC,IAAI,kBAAkB,KAAK,CAAC,IAAI,CAAC,IAAI,gBAAgB,CACrJ,CAAA;YACH,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IACD,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAA;AACpC,CAAC","sourcesContent":["import { action as mobxAction } from \"mobx\"\n\nimport {\n  Hook,\n  devMode,\n  fail,\n  getRoot,\n  getStateTreeNode,\n  warnError\n} from \"../internal.ts\"\n\nimport type {\n  AnyObjectNode,\n  IActionContext,\n  IAnyStateTreeNode,\n  IDisposer\n} from \"../internal.ts\"\n\nexport type IMiddlewareEventType =\n  | \"action\"\n  | \"flow_spawn\"\n  | \"flow_resume\"\n  | \"flow_resume_error\"\n  | \"flow_return\"\n  | \"flow_throw\"\n// | \"task_spawn TODO, see #273\"\n\nexport interface IMiddlewareEvent extends IActionContext {\n  /** Event type */\n  readonly type: IMiddlewareEventType\n\n  /** Parent event unique id */\n  readonly parentId: number\n  /** Parent event object */\n  readonly parentEvent: IMiddlewareEvent | undefined\n\n  /** Root event unique id */\n  readonly rootId: number\n  /** Id of all events, from root until current (excluding current) */\n  readonly allParentIds: number[]\n}\n\nexport interface FunctionWithFlag extends Function {\n  _isMSTAction?: boolean\n  _isFlowAction?: boolean\n}\n\n/**\n * @internal\n * @hidden\n */\nexport type IMiddleware = {\n  handler: IMiddlewareHandler\n  includeHooks: boolean\n}\n\nexport type IMiddlewareHandler = (\n  actionCall: IMiddlewareEvent,\n  next: (actionCall: IMiddlewareEvent, callback?: (value: any) => any) => void,\n  abort: (value: any) => void\n) => any\n\nlet nextActionId = 1\nlet currentActionContext: IMiddlewareEvent | undefined\n\n/**\n * @internal\n * @hidden\n */\nexport function getCurrentActionContext() {\n  return currentActionContext\n}\n\n/**\n * @internal\n * @hidden\n */\nexport function getNextActionId() {\n  return nextActionId++\n}\n\n// TODO: optimize away entire action context if there is no middleware in tree?\n/**\n * @internal\n * @hidden\n */\nexport function runWithActionContext(context: IMiddlewareEvent, fn: Function) {\n  const node = getStateTreeNode(context.context)\n\n  if (context.type === \"action\") {\n    node.assertAlive({\n      actionContext: context\n    })\n  }\n\n  const baseIsRunningAction = node._isRunningAction\n  node._isRunningAction = true\n  const previousContext = currentActionContext\n  currentActionContext = context\n  try {\n    return runMiddleWares(node, context, fn)\n  } finally {\n    currentActionContext = previousContext\n    node._isRunningAction = baseIsRunningAction\n  }\n}\n\n/**\n * @internal\n * @hidden\n */\nexport function getParentActionContext(\n  parentContext: IMiddlewareEvent | undefined\n) {\n  if (!parentContext) {\n    return undefined\n  }\n  if (parentContext.type === \"action\") {\n    return parentContext\n  }\n  return parentContext.parentActionEvent\n}\n\n/**\n * @internal\n * @hidden\n */\nexport function createActionInvoker<T extends FunctionWithFlag>(\n  target: IAnyStateTreeNode,\n  name: string,\n  fn: T\n) {\n  const res = function (...args: any[]) {\n    const id = getNextActionId()\n    const parentContext = currentActionContext\n    const parentActionContext = getParentActionContext(parentContext)\n\n    return runWithActionContext(\n      {\n        type: \"action\",\n        name,\n        id,\n        args,\n        context: target,\n        tree: getRoot(target),\n        rootId: parentContext ? parentContext.rootId : id,\n        parentId: parentContext ? parentContext.id : 0,\n        allParentIds: parentContext\n          ? [...parentContext.allParentIds, parentContext.id]\n          : [],\n        parentEvent: parentContext,\n        parentActionEvent: parentActionContext\n      },\n      fn\n    )\n  }\n  ;(res as FunctionWithFlag)._isMSTAction = true\n  ;(res as FunctionWithFlag)._isFlowAction = fn._isFlowAction\n  return res\n}\n\n/**\n * Middleware can be used to intercept any action is invoked on the subtree where it is attached.\n * If a tree is protected (by default), this means that any mutation of the tree will pass through your middleware.\n *\n * For more details, see the [middleware docs](concepts/middleware.md)\n *\n * @param target Node to apply the middleware to.\n * @param middleware Middleware to apply.\n * @returns A callable function to dispose the middleware.\n */\nexport function addMiddleware(\n  target: IAnyStateTreeNode,\n  handler: IMiddlewareHandler,\n  includeHooks: boolean = true\n): IDisposer {\n  const node = getStateTreeNode(target)\n  if (devMode()) {\n    if (!node.isProtectionEnabled) {\n      warnError(\n        \"It is recommended to protect the state tree before attaching action middleware, as otherwise it cannot be guaranteed that all changes are passed through middleware. See `protect`\"\n      )\n    }\n  }\n  return node.addMiddleWare(handler, includeHooks)\n}\n\n/**\n * Binds middleware to a specific action.\n *\n * Example:\n * ```ts\n * type.actions(self => {\n *   function takeA____() {\n *       self.toilet.donate()\n *       self.wipe()\n *       self.wipe()\n *       self.toilet.flush()\n *   }\n *   return {\n *     takeA____: decorate(atomic, takeA____)\n *   }\n * })\n * ```\n *\n * @param handler\n * @param fn\n * @param includeHooks\n * @returns The original function\n */\nexport function decorate<T extends Function>(\n  handler: IMiddlewareHandler,\n  fn: T,\n  includeHooks = true\n): T {\n  const middleware: IMiddleware = { handler, includeHooks }\n  ;(fn as any).$mst_middleware = (fn as any).$mst_middleware || []\n  ;(fn as any).$mst_middleware.push(middleware)\n  return fn\n}\n\nclass CollectedMiddlewares {\n  private arrayIndex = 0\n  private inArrayIndex = 0\n  private middlewares: IMiddleware[][] = []\n\n  constructor(node: AnyObjectNode, fn: Function) {\n    // we just push middleware arrays into an array of arrays to avoid making copies\n    if ((fn as any).$mst_middleware) {\n      this.middlewares.push((fn as any).$mst_middleware)\n    }\n    let n: AnyObjectNode | null = node\n    // Find all middlewares. Optimization: cache this?\n    while (n) {\n      if (n.middlewares) {\n        this.middlewares.push(n.middlewares)\n      }\n      n = n.parent\n    }\n  }\n\n  get isEmpty() {\n    return this.middlewares.length <= 0\n  }\n\n  getNextMiddleware(): IMiddleware | undefined {\n    const array = this.middlewares[this.arrayIndex]\n    if (!array) {\n      return undefined\n    }\n    const item = array[this.inArrayIndex++]\n    if (!item) {\n      this.arrayIndex++\n      this.inArrayIndex = 0\n      return this.getNextMiddleware()\n    }\n    return item\n  }\n}\n\nfunction runMiddleWares(\n  node: AnyObjectNode,\n  baseCall: IMiddlewareEvent,\n  originalFn: Function\n): any {\n  const middlewares = new CollectedMiddlewares(node, originalFn)\n  // Short circuit\n  if (middlewares.isEmpty) {\n    return mobxAction(originalFn)(...baseCall.args)\n  }\n\n  let result: any = null\n\n  function runNextMiddleware(call: IMiddlewareEvent): any {\n    const middleware = middlewares.getNextMiddleware()\n    const handler = middleware && middleware.handler\n\n    if (!handler) {\n      return mobxAction(originalFn)(...call.args)\n    }\n\n    // skip hooks if asked to\n    if (!middleware!.includeHooks && (Hook as any)[call.name]) {\n      return runNextMiddleware(call)\n    }\n\n    let nextInvoked = false\n    function next(\n      call2: IMiddlewareEvent,\n      callback?: (value: any) => any\n    ): void {\n      nextInvoked = true\n      // the result can contain\n      // - the non manipulated return value from an action\n      // - the non manipulated abort value\n      // - one of the above but manipulated through the callback function\n      result = runNextMiddleware(call2)\n      if (callback) {\n        result = callback(result)\n      }\n    }\n\n    let abortInvoked = false\n    function abort(value: any) {\n      abortInvoked = true\n      // overwrite the result\n      // can be manipulated through middlewares earlier in the queue using the callback fn\n      result = value\n    }\n\n    handler(call, next, abort)\n    if (devMode()) {\n      if (!nextInvoked && !abortInvoked) {\n        const node2 = getStateTreeNode(call.tree)\n        throw fail(\n          `Neither the next() nor the abort() callback within the middleware ${handler.name} for the action: \"${call.name}\" on the node: ${node2.type.name} was invoked.`\n        )\n      } else if (nextInvoked && abortInvoked) {\n        const node2 = getStateTreeNode(call.tree)\n        throw fail(\n          `The next() and abort() callback within the middleware ${handler.name} for the action: \"${call.name}\" on the node: ${node2.type.name} were invoked.`\n        )\n      }\n    }\n    return result\n  }\n  return runNextMiddleware(baseCall)\n}\n"]}

package/esm/core/actionContext.d.ts

@@ -0,0 +1,27 @@
+import { type IAnyStateTreeNode, type IMiddlewareEvent } from "../internal.ts";
+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/esm/core/actionContext.js

@@ -0,0 +1,37 @@
+import { getCurrentActionContext } from "./action.js";
+/**
+ * Returns the currently executing MST action context, or undefined if none.
+ */
+export function getRunningActionContext() {
+    let current = getCurrentActionContext();
+    while (current && current.type !== "action") {
+        current = current.parentActionEvent;
+    }
+    return current;
+}
+function _isActionContextThisOrChildOf(actionContext, sameOrParent, includeSame) {
+    const parentId = typeof sameOrParent === "number" ? sameOrParent : sameOrParent.id;
+    let current = includeSame
+        ? actionContext
+        : actionContext.parentActionEvent;
+    while (current) {
+        if (current.id === parentId) {
+            return true;
+        }
+        current = current.parentActionEvent;
+    }
+    return false;
+}
+/**
+ * Returns if the given action context is a parent of this action context.
+ */
+export function isActionContextChildOf(actionContext, parent) {
+    return _isActionContextThisOrChildOf(actionContext, parent, false);
+}
+/**
+ * Returns if the given action context is this or a parent of this action context.
+ */
+export function isActionContextThisOrChildOf(actionContext, parentOrThis) {
+    return _isActionContextThisOrChildOf(actionContext, parentOrThis, true);
+}
+//# sourceMappingURL=actionContext.js.map

package/esm/core/actionContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actionContext.js","sourceRoot":"","sources":["../../src/core/actionContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAqBrD;;GAEG;AACH,MAAM,UAAU,uBAAuB;IACrC,IAAI,OAAO,GAAG,uBAAuB,EAAE,CAAA;IACvC,OAAO,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC5C,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAA;IACrC,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,6BAA6B,CACpC,aAA6B,EAC7B,YAAwD,EACxD,WAAoB;IAEpB,MAAM,QAAQ,GACZ,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAA;IAEnE,IAAI,OAAO,GAAkD,WAAW;QACtE,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAAA;IACnC,OAAO,OAAO,EAAE,CAAC;QACf,IAAI,OAAO,CAAC,EAAE,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAA;IACrC,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACpC,aAA6B,EAC7B,MAAkD;IAElD,OAAO,6BAA6B,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;AACpE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAC1C,aAA6B,EAC7B,YAAwD;IAExD,OAAO,6BAA6B,CAAC,aAAa,EAAE,YAAY,EAAE,IAAI,CAAC,CAAA;AACzE,CAAC","sourcesContent":["import { type IAnyStateTreeNode, type IMiddlewareEvent } from \"../internal.ts\"\nimport { getCurrentActionContext } from \"./action.ts\"\n\nexport interface IActionContext {\n  /** Event name (action name for actions) */\n  readonly name: string\n\n  /** Event unique id */\n  readonly id: number\n\n  /** Parent action event object */\n  readonly parentActionEvent: IMiddlewareEvent | undefined\n\n  /** Event context (node where the action was invoked) */\n  readonly context: IAnyStateTreeNode\n  /** Event tree (root node of the node where the action was invoked) */\n  readonly tree: IAnyStateTreeNode\n\n  /** Event arguments in an array (action arguments for actions) */\n  readonly args: any[]\n}\n\n/**\n * Returns the currently executing MST action context, or undefined if none.\n */\nexport function getRunningActionContext(): IActionContext | undefined {\n  let current = getCurrentActionContext()\n  while (current && current.type !== \"action\") {\n    current = current.parentActionEvent\n  }\n  return current\n}\n\nfunction _isActionContextThisOrChildOf(\n  actionContext: IActionContext,\n  sameOrParent: number | IActionContext | IMiddlewareEvent,\n  includeSame: boolean\n) {\n  const parentId =\n    typeof sameOrParent === \"number\" ? sameOrParent : sameOrParent.id\n\n  let current: IActionContext | IMiddlewareEvent | undefined = includeSame\n    ? actionContext\n    : actionContext.parentActionEvent\n  while (current) {\n    if (current.id === parentId) {\n      return true\n    }\n    current = current.parentActionEvent\n  }\n  return false\n}\n\n/**\n * Returns if the given action context is a parent of this action context.\n */\nexport function isActionContextChildOf(\n  actionContext: IActionContext,\n  parent: number | IActionContext | IMiddlewareEvent\n) {\n  return _isActionContextThisOrChildOf(actionContext, parent, false)\n}\n\n/**\n * Returns if the given action context is this or a parent of this action context.\n */\nexport function isActionContextThisOrChildOf(\n  actionContext: IActionContext,\n  parentOrThis: number | IActionContext | IMiddlewareEvent\n) {\n  return _isActionContextThisOrChildOf(actionContext, parentOrThis, true)\n}\n"]}

package/esm/core/flow.d.ts

@@ -0,0 +1,69 @@
+import type { FunctionWithFlag } from "./action.ts";
+/**
+ * @hidden
+ */
+export 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<PromiseLike<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>;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function createFlowSpawner(name: string, generator: FunctionWithFlag): (this: any, ...flowArgs: any[]) => Promise<unknown>;

package/esm/core/flow.js

@@ -0,0 +1,173 @@
+import { fail, setImmediateWithFallback } from "../utils.js";
+import { getCurrentActionContext, getNextActionId, getParentActionContext, runWithActionContext } from "./action.js";
+/**
+ * See [asynchronous actions](concepts/async-actions.md).
+ *
+ * @returns The flow as a promise.
+ */
+export function flow(generator) {
+    return createFlowSpawner(generator.name, generator);
+}
+/**
+ * @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 function castFlowReturn(val) {
+    return val;
+}
+/**
+ * @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 function toGeneratorFunction(p) {
+    return function* (...args) {
+        return (yield p(...args));
+    };
+}
+/**
+ * @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 function* toGenerator(p) {
+    return (yield p);
+}
+/**
+ * @internal
+ * @hidden
+ */
+export function createFlowSpawner(name, generator) {
+    const spawner = function flowSpawner(...flowArgs) {
+        // Implementation based on https://github.com/tj/co/blob/master/index.js
+        const runId = getNextActionId();
+        const parentContext = getCurrentActionContext();
+        if (!parentContext) {
+            throw fail("a mst flow must always have a parent context");
+        }
+        const parentActionContext = getParentActionContext(parentContext);
+        if (!parentActionContext) {
+            throw fail("a mst flow must always have a parent action context");
+        }
+        const contextBase = {
+            name,
+            id: runId,
+            tree: parentContext.tree,
+            context: parentContext.context,
+            parentId: parentContext.id,
+            allParentIds: [...parentContext.allParentIds, parentContext.id],
+            rootId: parentContext.rootId,
+            parentEvent: parentContext,
+            parentActionEvent: parentActionContext
+        };
+        function wrap(fn, type, arg) {
+            fn.$mst_middleware = spawner.$mst_middleware; // pick up any middleware attached to the flow
+            return runWithActionContext({
+                ...contextBase,
+                type,
+                args: [arg]
+            }, fn);
+        }
+        return new Promise(function (resolve, reject) {
+            let gen;
+            const init = function asyncActionInit(...initArgs) {
+                gen = generator(...initArgs);
+                onFulfilled(undefined); // kick off the flow
+            };
+            init.$mst_middleware = spawner.$mst_middleware;
+            runWithActionContext({
+                ...contextBase,
+                type: "flow_spawn",
+                args: flowArgs
+            }, init);
+            function onFulfilled(res) {
+                let ret;
+                try {
+                    // prettier-ignore
+                    const cancelError = wrap((_r) => { ret = gen.next(_r); }, "flow_resume", res);
+                    if (cancelError instanceof Error) {
+                        ret = gen.throw(cancelError);
+                    }
+                }
+                catch (e) {
+                    // prettier-ignore
+                    setImmediateWithFallback(() => {
+                        wrap((_r) => { reject(e); }, "flow_throw", e);
+                    });
+                    return;
+                }
+                next(ret);
+                return;
+            }
+            function onRejected(err) {
+                let ret;
+                try {
+                    // prettier-ignore
+                    wrap((_r) => { ret = gen.throw(_r); }, "flow_resume_error", err); // or yieldError?
+                }
+                catch (e) {
+                    // prettier-ignore
+                    setImmediateWithFallback(() => {
+                        wrap((_r) => { reject(e); }, "flow_throw", e);
+                    });
+                    return;
+                }
+                next(ret);
+            }
+            function next(ret) {
+                if (ret.done) {
+                    // prettier-ignore
+                    setImmediateWithFallback(() => {
+                        wrap((r) => { resolve(r); }, "flow_return", ret.value);
+                    });
+                    return;
+                }
+                // TODO: support more type of values? See https://github.com/tj/co/blob/249bbdc72da24ae44076afd716349d2089b31c4c/index.js#L100
+                if (!ret.value || typeof ret.value.then !== "function") {
+                    // istanbul ignore next
+                    throw fail("Only promises can be yielded to `async`, got: " + ret);
+                }
+                return ret.value.then(onFulfilled, onRejected);
+            }
+        });
+    };
+    spawner._isFlowAction = true;
+    return spawner;
+}
+//# sourceMappingURL=flow.js.map

package/esm/core/flow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.js","sourceRoot":"","sources":["../../src/core/flow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAC5D,OAAO,EACL,uBAAuB,EACvB,eAAe,EACf,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,aAAa,CAAA;AASpB;;;;GAIG;AACH,MAAM,UAAU,IAAI,CAClB,SAAiE;IAEjE,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAQ,CAAA;AAC5D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAI,GAAM;IACtC,OAAO,GAAU,CAAA;AACnB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,mBAAmB,CACjC,CAAgC;IAEhC,OAAO,QAAQ,CAAC,EAAE,GAAG,IAAU;QAC7B,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,CAAM,CAAA;IAChC,CAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,SAAS,CAAC,CAAC,WAAW,CAAI,CAAa;IAC3C,OAAO,CAAC,MAAM,CAAC,CAAM,CAAA;AACvB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAY,EAAE,SAA2B;IACzE,MAAM,OAAO,GAAG,SAAS,WAAW,CAAY,GAAG,QAAe;QAChE,wEAAwE;QACxE,MAAM,KAAK,GAAG,eAAe,EAAE,CAAA;QAC/B,MAAM,aAAa,GAAG,uBAAuB,EAAG,CAAA;QAChD,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,CAAC,8CAA8C,CAAC,CAAA;QAC5D,CAAC;QACD,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAA;QACjE,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC,qDAAqD,CAAC,CAAA;QACnE,CAAC;QAED,MAAM,WAAW,GAAG;YAClB,IAAI;YACJ,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,QAAQ,EAAE,aAAa,CAAC,EAAE;YAC1B,YAAY,EAAE,CAAC,GAAG,aAAa,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;YAC/D,MAAM,EAAE,aAAa,CAAC,MAAM;YAC5B,WAAW,EAAE,aAAa;YAC1B,iBAAiB,EAAE,mBAAmB;SACvC,CAAA;QAED,SAAS,IAAI,CAAC,EAAO,EAAE,IAA0B,EAAE,GAAQ;YACzD,EAAE,CAAC,eAAe,GAAI,OAAe,CAAC,eAAe,CAAA,CAAC,8CAA8C;YACpG,OAAO,oBAAoB,CACzB;gBACE,GAAG,WAAW;gBACd,IAAI;gBACJ,IAAI,EAAE,CAAC,GAAG,CAAC;aACZ,EACD,EAAE,CACH,CAAA;QACH,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,UAAU,OAAO,EAAE,MAAM;YAC1C,IAAI,GAAQ,CAAA;YACZ,MAAM,IAAI,GAAG,SAAS,eAAe,CAAC,GAAG,QAAe;gBACtD,GAAG,GAAG,SAAS,CAAC,GAAG,QAAQ,CAAC,CAAA;gBAC5B,WAAW,CAAC,SAAS,CAAC,CAAA,CAAC,oBAAoB;YAC7C,CAAC,CACA;YAAC,IAAY,CAAC,eAAe,GAAI,OAAe,CAAC,eAAe,CAAA;YAEjE,oBAAoB,CAClB;gBACE,GAAG,WAAW;gBACd,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,QAAQ;aACf,EACD,IAAI,CACL,CAAA;YAED,SAAS,WAAW,CAAC,GAAQ;gBAC3B,IAAI,GAAG,CAAA;gBACP,IAAI,CAAC;oBACH,kBAAkB;oBAClB,MAAM,WAAW,GAAQ,IAAI,CAAC,CAAC,EAAO,EAAE,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA,CAAC,CAAC,EAAE,aAAa,EAAE,GAAG,CAAC,CAAA;oBACtF,IAAI,WAAW,YAAY,KAAK,EAAE,CAAC;wBACjC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;oBAC9B,CAAC;gBACH,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,kBAAkB;oBAClB,wBAAwB,CAAC,GAAG,EAAE;wBAChB,IAAI,CAAC,CAAC,EAAO,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAA;oBACrD,CAAC,CAAC,CAAA;oBACZ,OAAM;gBACR,CAAC;gBACD,IAAI,CAAC,GAAG,CAAC,CAAA;gBACT,OAAM;YACR,CAAC;YAED,SAAS,UAAU,CAAC,GAAQ;gBAC1B,IAAI,GAAG,CAAA;gBACP,IAAI,CAAC;oBACH,kBAAkB;oBAClB,IAAI,CAAC,CAAC,EAAO,EAAE,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA,CAAC,CAAC,EAAE,mBAAmB,EAAE,GAAG,CAAC,CAAA,CAAC,iBAAiB;gBACxF,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,kBAAkB;oBAClB,wBAAwB,CAAC,GAAG,EAAE;wBAChB,IAAI,CAAC,CAAC,EAAO,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAA;oBACrD,CAAC,CAAC,CAAA;oBACZ,OAAM;gBACR,CAAC;gBACD,IAAI,CAAC,GAAG,CAAC,CAAA;YACX,CAAC;YAED,SAAS,IAAI,CAAC,GAAQ;gBACpB,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;oBACb,kBAAkB;oBAClB,wBAAwB,CAAC,GAAG,EAAE;wBAChB,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA,CAAC,CAAC,EAAE,aAAa,EAAE,GAAG,CAAC,KAAK,CAAC,CAAA;oBAC9D,CAAC,CAAC,CAAA;oBACZ,OAAM;gBACR,CAAC;gBACD,8HAA8H;gBAC9H,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBACvD,uBAAuB;oBACvB,MAAM,IAAI,CAAC,gDAAgD,GAAG,GAAG,CAAC,CAAA;gBACpE,CAAC;gBACD,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;YAChD,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CACA;IAAC,OAA4B,CAAC,aAAa,GAAG,IAAI,CAAA;IACnD,OAAO,OAAO,CAAA;AAChB,CAAC","sourcesContent":["import { fail, setImmediateWithFallback } from \"../utils.ts\"\nimport {\n  getCurrentActionContext,\n  getNextActionId,\n  getParentActionContext,\n  runWithActionContext\n} from \"./action.ts\"\n\nimport type { FunctionWithFlag, IMiddlewareEventType } from \"./action.ts\"\n\n/**\n * @hidden\n */\nexport type FlowReturn<R> = R extends Promise<infer T> ? T : R\n\n/**\n * See [asynchronous actions](concepts/async-actions.md).\n *\n * @returns The flow as a promise.\n */\nexport function flow<R, Args extends any[]>(\n  generator: (...args: Args) => Generator<PromiseLike<any>, R, any>\n): (...args: Args) => Promise<FlowReturn<R>> {\n  return createFlowSpawner(generator.name, generator) as any\n}\n\n/**\n * @deprecated Not needed since TS3.6.\n * Used for TypeScript to make flows that return a promise return the actual promise result.\n *\n * @param val\n * @returns\n */\nexport function castFlowReturn<T>(val: T): T {\n  return val as any\n}\n\n/**\n * @experimental\n * experimental api - might change on minor/patch releases\n *\n * Convert a promise-returning function to a generator-returning one.\n * This is intended to allow for usage of `yield*` in async actions to\n * retain the promise return type.\n *\n * Example:\n * ```ts\n * function getDataAsync(input: string): Promise<number> { ... }\n * const getDataGen = toGeneratorFunction(getDataAsync);\n *\n * const someModel.actions(self => ({\n *   someAction: flow(function*() {\n *     // value is typed as number\n *     const value = yield* getDataGen(\"input value\");\n *     ...\n *   })\n * }))\n * ```\n */\nexport function toGeneratorFunction<R, Args extends any[]>(\n  p: (...args: Args) => Promise<R>\n) {\n  return function* (...args: Args) {\n    return (yield p(...args)) as R\n  }\n}\n\n/**\n * @experimental\n * experimental api - might change on minor/patch releases\n *\n * Convert a promise to a generator yielding that promise\n * This is intended to allow for usage of `yield*` in async actions to\n * retain the promise return type.\n *\n * Example:\n * ```ts\n * function getDataAsync(input: string): Promise<number> { ... }\n *\n * const someModel.actions(self => ({\n *   someAction: flow(function*() {\n *     // value is typed as number\n *     const value = yield* toGenerator(getDataAsync(\"input value\"));\n *     ...\n *   })\n * }))\n * ```\n */\nexport function* toGenerator<R>(p: Promise<R>) {\n  return (yield p) as R\n}\n\n/**\n * @internal\n * @hidden\n */\nexport function createFlowSpawner(name: string, generator: FunctionWithFlag) {\n  const spawner = function flowSpawner(this: any, ...flowArgs: any[]) {\n    // Implementation based on https://github.com/tj/co/blob/master/index.js\n    const runId = getNextActionId()\n    const parentContext = getCurrentActionContext()!\n    if (!parentContext) {\n      throw fail(\"a mst flow must always have a parent context\")\n    }\n    const parentActionContext = getParentActionContext(parentContext)\n    if (!parentActionContext) {\n      throw fail(\"a mst flow must always have a parent action context\")\n    }\n\n    const contextBase = {\n      name,\n      id: runId,\n      tree: parentContext.tree,\n      context: parentContext.context,\n      parentId: parentContext.id,\n      allParentIds: [...parentContext.allParentIds, parentContext.id],\n      rootId: parentContext.rootId,\n      parentEvent: parentContext,\n      parentActionEvent: parentActionContext\n    }\n\n    function wrap(fn: any, type: IMiddlewareEventType, arg: any) {\n      fn.$mst_middleware = (spawner as any).$mst_middleware // pick up any middleware attached to the flow\n      return runWithActionContext(\n        {\n          ...contextBase,\n          type,\n          args: [arg]\n        },\n        fn\n      )\n    }\n\n    return new Promise(function (resolve, reject) {\n      let gen: any\n      const init = function asyncActionInit(...initArgs: any[]) {\n        gen = generator(...initArgs)\n        onFulfilled(undefined) // kick off the flow\n      }\n      ;(init as any).$mst_middleware = (spawner as any).$mst_middleware\n\n      runWithActionContext(\n        {\n          ...contextBase,\n          type: \"flow_spawn\",\n          args: flowArgs\n        },\n        init\n      )\n\n      function onFulfilled(res: any) {\n        let ret\n        try {\n          // prettier-ignore\n          const cancelError: any = wrap((_r: any) => { ret = gen.next(_r) }, \"flow_resume\", res)\n          if (cancelError instanceof Error) {\n            ret = gen.throw(cancelError)\n          }\n        } catch (e) {\n          // prettier-ignore\n          setImmediateWithFallback(() => {\n                        wrap((_r: any) => { reject(e) }, \"flow_throw\", e)\n                    })\n          return\n        }\n        next(ret)\n        return\n      }\n\n      function onRejected(err: any) {\n        let ret\n        try {\n          // prettier-ignore\n          wrap((_r: any) => { ret = gen.throw(_r) }, \"flow_resume_error\", err) // or yieldError?\n        } catch (e) {\n          // prettier-ignore\n          setImmediateWithFallback(() => {\n                        wrap((_r: any) => { reject(e) }, \"flow_throw\", e)\n                    })\n          return\n        }\n        next(ret)\n      }\n\n      function next(ret: any) {\n        if (ret.done) {\n          // prettier-ignore\n          setImmediateWithFallback(() => {\n                        wrap((r: any) => { resolve(r) }, \"flow_return\", ret.value)\n                    })\n          return\n        }\n        // TODO: support more type of values? See https://github.com/tj/co/blob/249bbdc72da24ae44076afd716349d2089b31c4c/index.js#L100\n        if (!ret.value || typeof ret.value.then !== \"function\") {\n          // istanbul ignore next\n          throw fail(\"Only promises can be yielded to `async`, got: \" + ret)\n        }\n        return ret.value.then(onFulfilled, onRejected)\n      }\n    })\n  }\n  ;(spawner as FunctionWithFlag)._isFlowAction = true\n  return spawner\n}\n"]}