@jbrowse/mobx-state-tree 5.4.4 → 5.4.5

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

@@ -0,0 +1,317 @@
+import { BaseNode } from "../../internal.ts";
+import type { AnyNode, AnyObjectNode, IChildNodesMap, IJsonPatch, IStateTreeNode, IValidationContext, IValidationResult, ModelPrimitive, ObjectNode, ScalarNode } from "../../internal.ts";
+/**
+ * @internal
+ * @hidden
+ */
+export declare enum TypeFlags {
+    String = 1,
+    Number = 2,
+    Boolean = 4,
+    Date = 8,
+    Literal = 16,
+    Array = 32,
+    Map = 64,
+    Object = 128,
+    Frozen = 256,
+    Optional = 512,
+    Reference = 1024,
+    Identifier = 2048,
+    Late = 4096,
+    Refinement = 8192,
+    Union = 16384,
+    Null = 32768,
+    Undefined = 65536,
+    Integer = 131072,
+    Custom = 262144,
+    SnapshotProcessor = 524288,
+    Lazy = 1048576,
+    Finite = 2097152,
+    Float = 4194304
+}
+/**
+ * @internal
+ * @hidden
+ */
+export declare const cannotDetermineSubtype = "cannotDetermine";
+/**
+ * A state tree node value.
+ * @hidden
+ */
+export type STNValue<T, IT extends IAnyType> = T extends object ? T & IStateTreeNode<IT> : T;
+/** @hidden */
+declare const $type: unique symbol;
+/**
+ * A type, either complex or simple.
+ */
+export interface IType<C, S, T> {
+    /** @hidden */
+    readonly [$type]: undefined;
+    /**
+     * Friendly type name.
+     */
+    name: string;
+    /**
+     * Name of the identifier attribute or null if none.
+     */
+    readonly identifierAttribute?: string;
+    /**
+     * Creates an instance for the type given an snapshot input.
+     *
+     * @returns An instance of that type.
+     */
+    create(snapshot?: C, env?: any): this["Type"];
+    /**
+     * Checks if a given snapshot / instance is of the given type.
+     *
+     * @param thing Snapshot or instance to be checked.
+     * @returns true if the value is of the current type, false otherwise.
+     */
+    is(thing: any): thing is C | this["Type"];
+    /**
+     * Run's the type's typechecker on the given value with the given validation context.
+     *
+     * @param thing Value to be checked, either a snapshot or an instance.
+     * @param context Validation context, an array of { subpaths, subtypes } that should be validated
+     * @returns The validation result, an array with the list of validation errors.
+     */
+    validate(thing: C, context: IValidationContext): IValidationResult;
+    /**
+     * Gets the textual representation of the type as a string.
+     */
+    describe(): string;
+    /**
+     * @deprecated use `Instance<typeof MyType>` instead.
+     * @hidden
+     */
+    readonly Type: STNValue<T, this>;
+    /**
+     * @deprecated do not use.
+     * @hidden
+     */
+    readonly TypeWithoutSTN: T;
+    /**
+     * @deprecated use `SnapshotOut<typeof MyType>` instead.
+     * @hidden
+     */
+    readonly SnapshotType: S;
+    /**
+     * @deprecated use `SnapshotIn<typeof MyType>` instead.
+     * @hidden
+     */
+    readonly CreationType: C;
+    /**
+     * @internal
+     * @hidden
+     */
+    flags: TypeFlags;
+    /**
+     * @internal
+     * @hidden
+     */
+    isType: true;
+    /**
+     * @internal
+     * @hidden
+     */
+    instantiate(parent: AnyObjectNode | null, subpath: string, environment: any, initialValue: C | T): BaseNode<C, S, T>;
+    /**
+     * @internal
+     * @hidden
+     */
+    reconcile(current: BaseNode<C, S, T>, newValue: C | T, parent: AnyObjectNode, subpath: string): BaseNode<C, S, T>;
+    /**
+     * @internal
+     * @hidden
+     */
+    getSnapshot(node: BaseNode<C, S, T>, applyPostProcess?: boolean): S;
+    /**
+     * @internal
+     * @hidden
+     */
+    isAssignableFrom(type: IAnyType): boolean;
+    /**
+     * @internal
+     * @hidden
+     */
+    getSubTypes(): IAnyType[] | IAnyType | null | typeof cannotDetermineSubtype;
+}
+/**
+ * Any kind of type.
+ */
+export interface IAnyType extends IType<any, any, any> {
+}
+/**
+ * A simple type, this is, a type where the instance and the snapshot representation are the same.
+ */
+export interface ISimpleType<T> extends IType<T, T, T> {
+}
+/** @hidden */
+export type Primitives = ModelPrimitive | null | undefined;
+/**
+ * A complex type.
+ * @deprecated just for compatibility with old versions, could be deprecated on the next major version
+ * @hidden
+ */
+export interface IComplexType<C, S, T> extends IType<C, S, T & object> {
+}
+/**
+ * Any kind of complex type.
+ */
+export interface IAnyComplexType extends IType<any, any, object> {
+}
+/** @hidden */
+export type ExtractCSTWithoutSTN<IT extends {
+    [$type]: undefined;
+    CreationType: any;
+    SnapshotType: any;
+    TypeWithoutSTN: any;
+}> = IT["CreationType"] | IT["SnapshotType"] | IT["TypeWithoutSTN"];
+/** @hidden */
+export type ExtractCSTWithSTN<IT extends {
+    [$type]: undefined;
+    CreationType: any;
+    SnapshotType: any;
+    Type: any;
+}> = IT["CreationType"] | IT["SnapshotType"] | IT["Type"];
+/**
+ * The instance representation of a given type.
+ */
+export type Instance<T> = T extends {
+    [$type]: undefined;
+    Type: any;
+} ? T["Type"] : T;
+/**
+ * The input (creation) snapshot representation of a given type.
+ */
+export type SnapshotIn<T> = T extends {
+    [$type]: undefined;
+    CreationType: any;
+} ? T["CreationType"] : T extends IStateTreeNode<infer IT> ? IT["CreationType"] : T;
+/**
+ * The output snapshot representation of a given type.
+ */
+export type SnapshotOut<T> = T extends {
+    [$type]: undefined;
+    SnapshotType: any;
+} ? T["SnapshotType"] : T extends IStateTreeNode<infer IT> ? IT["SnapshotType"] : T;
+/**
+ * A type which is equivalent to the union of SnapshotIn and Instance types of a given typeof TYPE or typeof VARIABLE.
+ * For primitives it defaults to the primitive itself.
+ *
+ * For example:
+ * - `SnapshotOrInstance<typeof ModelA> = SnapshotIn<typeof ModelA> | Instance<typeof ModelA>`
+ * - `SnapshotOrInstance<typeof self.a (where self.a is a ModelA)> = SnapshotIn<typeof ModelA> | Instance<typeof ModelA>`
+ *
+ * Usually you might want to use this when your model has a setter action that sets a property.
+ *
+ * Example:
+ * ```ts
+ * const ModelA = types.model({
+ *   n: types.number
+ * })
+ *
+ * const ModelB = types.model({
+ *   innerModel: ModelA
+ * }).actions(self => ({
+ *   // this will accept as property both the snapshot and the instance, whichever is preferred
+ *   setInnerModel(m: SnapshotOrInstance<typeof self.innerModel>) {
+ *     self.innerModel = cast(m)
+ *   }
+ * }))
+ * ```
+ */
+export type SnapshotOrInstance<T> = SnapshotIn<T> | Instance<T>;
+/**
+ * A base type produces a MST node (Node in the state tree)
+ *
+ * @internal
+ * @hidden
+ */
+export declare abstract class BaseType<C, S, T, N extends BaseNode<any, any, any> = BaseNode<C, S, T>> implements IType<C, S, T> {
+    [$type]: undefined;
+    readonly C: C;
+    readonly S: S;
+    readonly T: T;
+    readonly N: N;
+    readonly isType = true;
+    readonly name: string;
+    constructor(name: string);
+    create(snapshot?: C, environment?: any): any;
+    getSnapshot(node: N, applyPostProcess?: boolean): S;
+    abstract reconcile(current: N, newValue: C | T, parent: AnyObjectNode, subpath: string): N;
+    abstract instantiate(parent: AnyObjectNode | null, subpath: string, environment: any, initialValue: C | T): N;
+    abstract flags: TypeFlags;
+    abstract describe(): string;
+    abstract isValidSnapshot(value: C, context: IValidationContext): IValidationResult;
+    isAssignableFrom(type: IAnyType): boolean;
+    validate(value: C | T, context: IValidationContext): IValidationResult;
+    is(thing: any): thing is any;
+    get Type(): any;
+    get TypeWithoutSTN(): any;
+    get SnapshotType(): any;
+    get CreationType(): any;
+    abstract getSubTypes(): IAnyType[] | IAnyType | null | typeof cannotDetermineSubtype;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export type AnyBaseType = BaseType<any, any, any, any>;
+/**
+ * @internal
+ * @hidden
+ */
+export type ExtractNodeType<IT extends IAnyType> = IT extends BaseType<any, any, any, infer N> ? N : never;
+/**
+ * A complex type produces a MST node (Node in the state tree)
+ *
+ * @internal
+ * @hidden
+ */
+export declare abstract class ComplexType<C, S, T> extends BaseType<C, S, T, ObjectNode<C, S, T>> {
+    identifierAttribute?: string;
+    constructor(name: string);
+    create(snapshot?: C, environment?: any): any;
+    getValue(node: this["N"]): T;
+    abstract getDefaultSnapshot(): C;
+    abstract createNewInstance(childNodes: IChildNodesMap): T;
+    abstract finalizeNewInstance(node: this["N"], instance: any): void;
+    abstract applySnapshot(node: this["N"], snapshot: C): void;
+    abstract applyPatchLocally(node: this["N"], subpath: string, patch: IJsonPatch): void;
+    abstract processInitialSnapshot(childNodes: IChildNodesMap, snapshot: C): S;
+    abstract getChildren(node: this["N"]): ReadonlyArray<AnyNode>;
+    abstract getChildNode(node: this["N"], key: string): AnyNode;
+    abstract getChildType(propertyName?: string): IAnyType;
+    abstract initializeChildNodes(node: this["N"], snapshot: any): IChildNodesMap;
+    abstract removeChild(node: this["N"], subpath: string): void;
+    isMatchingSnapshotId(current: this["N"], snapshot: C): boolean;
+    private tryToReconcileNode;
+    reconcile(current: this["N"], newValue: C | T, parent: AnyObjectNode, subpath: string): this["N"];
+    getSubTypes(): null;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export declare abstract class SimpleType<C, S, T> extends BaseType<C, S, T, ScalarNode<C, S, T>> {
+    abstract instantiate(parent: AnyObjectNode | null, subpath: string, environment: any, initialValue: C): this["N"];
+    createNewInstance(snapshot: C): T;
+    getValue(node: this["N"]): T;
+    getSnapshot(node: this["N"]): S;
+    reconcile(current: this["N"], newValue: C, parent: AnyObjectNode, subpath: string): this["N"];
+    getSubTypes(): null;
+}
+/**
+ * Returns if a given value represents a type.
+ *
+ * @param value Value to check.
+ * @returns `true` if the value is a type.
+ */
+export declare function isType(value: any): value is IAnyType;
+/**
+ * @internal
+ * @hidden
+ */
+export declare function assertIsType(type: IAnyType, argNumber: number | number[]): void;
+export {};

package/dist/core/type/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../../src/core/type/type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAE7B,OAAO,EAEL,SAAS,EACT,IAAI,EACJ,gBAAgB,EAChB,oBAAoB,EACpB,OAAO,EACP,SAAS,EACT,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAe1B;;;GAGG;AACH,MAAM,CAAN,IAAY,SAwBX;AAxBD,WAAY,SAAS;IACnB,6CAAU,CAAA;IACV,6CAAe,CAAA;IACf,+CAAgB,CAAA;IAChB,yCAAa,CAAA;IACb,gDAAgB,CAAA;IAChB,4CAAc,CAAA;IACd,wCAAY,CAAA;IACZ,+CAAe,CAAA;IACf,+CAAe,CAAA;IACf,mDAAiB,CAAA;IACjB,sDAAmB,CAAA;IACnB,wDAAoB,CAAA;IACpB,4CAAc,CAAA;IACd,wDAAoB,CAAA;IACpB,+CAAe,CAAA;IACf,6CAAc,CAAA;IACd,uDAAmB,CAAA;IACnB,oDAAiB,CAAA;IACjB,kDAAgB,CAAA;IAChB,wEAA2B,CAAA;IAC3B,+CAAc,CAAA;IACd,mDAAgB,CAAA;IAChB,iDAAe,CAAA;AACjB,CAAC,EAxBW,SAAS,KAAT,SAAS,QAwBpB;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAA;AAUvD,cAAc;AACd,MAAM,KAAK,GAAkB,MAAM,CAAC,OAAO,CAAC,CAAA;AA2N5C;;;;;GAKG;AACH,MAAM,OAAgB,QAAQ;IAM5B,CAAC,KAAK,CAAC,CAAY;IAEnB,qEAAqE;IAC5D,CAAC,CAAI;IACL,CAAC,CAAI;IACL,CAAC,CAAI;IACL,CAAC,CAAI;IAEL,MAAM,GAAG,IAAI,CAAA;IACb,IAAI,CAAQ;IAErB,YAAY,IAAY;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,QAAY,EAAE,WAAiB;QACpC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QACjC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,EAAE,QAAS,CAAC,CAAC,KAAK,CAAA;IACjE,CAAC;IAED,WAAW,CAAC,IAAO,EAAE,gBAA0B;QAC7C,uBAAuB;QACvB,MAAM,IAAI,CAAC,sBAAsB,CAAC,CAAA;IACpC,CAAC;IAwBD,gBAAgB,CAAC,IAAc;QAC7B,OAAO,IAAI,KAAK,IAAI,CAAA;IACtB,CAAC;IAED,QAAQ,CAAC,KAAY,EAAE,OAA2B;QAChD,MAAM,IAAI,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAA;QACxC,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;YAChC,OAAO,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;gBACrC,CAAC,CAAC,gBAAgB,EAAE;gBACpB,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;YACpC,iGAAiG;QACnG,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,KAAU,EAAE,OAAO,CAAC,CAAA;IAClD,CAAC;IAED,EAAE,CAAC,KAAU;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAA;IACtE,CAAC;IAED,IAAI,IAAI;QACN,uBAAuB;QACvB,MAAM,IAAI,CACR,uJAAuJ,CACxJ,CAAA;IACH,CAAC;IACD,IAAI,cAAc;QAChB,uBAAuB;QACvB,MAAM,IAAI,CACR,2KAA2K,CAC5K,CAAA;IACH,CAAC;IACD,IAAI,YAAY;QACd,uBAAuB;QACvB,MAAM,IAAI,CACR,uKAAuK,CACxK,CAAA;IACH,CAAC;IACD,IAAI,YAAY;QACd,uBAAuB;QACvB,MAAM,IAAI,CACR,uKAAuK,CACxK,CAAA;IACH,CAAC;CAOF;AACD,QAAQ,CAAC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;AAe7D;;;;;GAKG;AACH,MAAM,OAAgB,WAAqB,SAAQ,QAKlD;IACC,mBAAmB,CAAS;IAE5B,YAAY,IAAY;QACtB,KAAK,CAAC,IAAI,CAAC,CAAA;IACb,CAAC;IAED,MAAM,CAAC,WAAc,IAAI,CAAC,kBAAkB,EAAE,EAAE,WAAiB;QAC/D,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;IAC5C,CAAC;IAED,QAAQ,CAAC,IAAe;QACtB,IAAI,CAAC,gCAAgC,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAqBD,oBAAoB,CAAC,OAAkB,EAAE,QAAW;QAClD,OAAO,CACL,CAAC,OAAO,CAAC,mBAAmB;YAC5B,OAAO,CAAC,UAAU;gBAChB,mBAAmB,CAAE,QAAgB,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CACtE,CAAA;IACH,CAAC;IAEO,kBAAkB,CAAC,OAAkB,EAAE,QAAe;QAC5D,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACxB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAK,OAAO,CAAC,QAAgB,KAAK,QAAQ,EAAE,CAAC;YAC3C,qDAAqD;YACrD,OAAO,IAAI,CAAA;QACb,CAAC;QACD,IAAI,eAAe,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,KAAK,OAAO,EAAE,CAAC;YACxE,8CAA8C;YAC9C,OAAO,IAAI,CAAA;QACb,CAAC;QACD,IACE,OAAO,CAAC,IAAI,KAAK,IAAI;YACrB,SAAS,CAAC,QAAQ,CAAC;YACnB,CAAC,eAAe,CAAC,QAAQ,CAAC;YAC1B,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAe,CAAC,EACnD,CAAC;YACD,8DAA8D;YAC9D,mBAAmB;YACnB,OAAO,CAAC,aAAa,CAAC,QAAa,CAAC,CAAA;YACpC,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,SAAS,CACP,OAAkB,EAClB,QAAe,EACf,MAAqB,EACrB,OAAe;QAEf,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;QACjE,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;YAClC,OAAO,OAAO,CAAA;QAChB,CAAC;QAED,6CAA6C;QAC7C,OAAO,CAAC,GAAG,EAAE,CAAA,CAAC,oBAAoB;QAClC,+BAA+B;QAC/B,IAAI,eAAe,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YAC1E,6CAA6C;YAC7C,MAAM,OAAO,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAA;YAC1C,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;YAClC,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,8CAA8C;QAC9C,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IAC/D,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AACD,WAAW,CAAC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;AAEnE;;;GAGG;AACH,MAAM,OAAgB,UAAoB,SAAQ,QAKjD;IAQC,iBAAiB,CAAC,QAAW;QAC3B,OAAO,QAAe,CAAA;IACxB,CAAC;IAED,QAAQ,CAAC,IAAe;QACtB,iGAAiG;QACjG,gFAAgF;QAChF,qBAAqB;QACrB,qDAAqD;QACrD,IAAI;QACJ,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAED,WAAW,CAAC,IAAe;QACzB,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAED,SAAS,CACP,OAAkB,EAClB,QAAW,EACX,MAAqB,EACrB,OAAe;QAEf,6FAA6F;QAC7F,IACE,CAAC,OAAO,CAAC,WAAW;YACpB,OAAO,CAAC,IAAI,KAAK,IAAI;YACrB,OAAO,CAAC,WAAW,KAAK,QAAQ,EAChC,CAAC;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;QAClE,OAAO,CAAC,GAAG,EAAE,CAAA,CAAC,oBAAoB;QAClC,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,KAAU;IAC/B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,CAAA;AACpE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,IAAc,EAAE,SAA4B;IACvE,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAA;AAC5D,CAAC"}

package/dist/index.d.ts

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

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA8EA,OAAO,EACL,WAAW,EACX,aAAa,EACb,WAAW,EACX,UAAU,EACV,aAAa,EACb,IAAI,EACJ,cAAc,EACd,uBAAuB,EACvB,cAAc,EACd,KAAK,EACL,+BAA+B,EAC/B,8BAA8B,EAC9B,QAAQ,EACR,OAAO,EACP,MAAM,EACN,cAAc,EACd,IAAI,EACJ,YAAY,EACZ,MAAM,EACN,aAAa,EACb,qBAAqB,EACrB,UAAU,EACV,SAAS,EACT,SAAS,EACT,eAAe,EACf,OAAO,EACP,YAAY,EACZ,kBAAkB,EAClB,eAAe,EACf,OAAO,EACP,uBAAuB,EACvB,WAAW,EACX,OAAO,EACP,SAAS,EACT,eAAe,EACf,sBAAsB,EACtB,4BAA4B,EAC5B,OAAO,EACP,WAAW,EACX,YAAY,EACZ,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,SAAS,EACT,WAAW,EACX,cAAc,EACd,eAAe,EACf,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,MAAM,EACN,eAAe,EACf,MAAM,EACN,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,QAAQ,EACR,OAAO,EACP,UAAU,EACV,OAAO,EACP,OAAO,EACP,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,WAAW,EACX,qBAAqB,EACrB,qBAAqB,EACrB,aAAa,EACb,WAAW,EACX,mBAAmB,EACnB,YAAY,EACZ,UAAU,EACV,SAAS,EACT,KAAK,EACL,KAAK,IAAI,CAAC,EACV,gBAAgB,EAChB,SAAS,EACT,IAAI,EACJ,UAAU,EACX,MAAM,eAAe,CAAA"}

package/dist/internal.d.ts

@@ -0,0 +1,38 @@
+export * from "./core/node/livelinessChecking.ts";
+export * from "./core/node/Hook.ts";
+export * from "./core/mst-operations.ts";
+export * from "./core/node/BaseNode.ts";
+export * from "./core/node/scalar-node.ts";
+export * from "./core/node/object-node.ts";
+export * from "./core/type/type.ts";
+export * from "./middlewares/create-action-tracking-middleware.ts";
+export * from "./middlewares/createActionTrackingMiddleware2.ts";
+export * from "./middlewares/on-action.ts";
+export * from "./core/action.ts";
+export * from "./core/actionContext.ts";
+export * from "./core/type/type-checker.ts";
+export * from "./core/node/identifier-cache.ts";
+export * from "./core/node/create-node.ts";
+export * from "./core/node/node-utils.ts";
+export * from "./core/process.ts";
+export * from "./core/flow.ts";
+export * from "./core/json-patch.ts";
+export * from "./utils.ts";
+export * from "./types/utility-types/snapshotProcessor.ts";
+export * from "./types/complex-types/map.ts";
+export * from "./types/complex-types/array.ts";
+export * from "./types/complex-types/model.ts";
+export * from "./types/primitives.ts";
+export * from "./types/utility-types/literal.ts";
+export * from "./types/utility-types/refinement.ts";
+export * from "./types/utility-types/enumeration.ts";
+export * from "./types/utility-types/union.ts";
+export * from "./types/utility-types/optional.ts";
+export * from "./types/utility-types/maybe.ts";
+export * from "./types/utility-types/late.ts";
+export * from "./types/utility-types/lazy.ts";
+export * from "./types/utility-types/frozen.ts";
+export * from "./types/utility-types/reference.ts";
+export * from "./types/utility-types/identifier.ts";
+export * from "./types/utility-types/custom.ts";
+export * from "./types/index.ts";

package/dist/internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.js","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,mCAAmC,CAAA;AACjD,cAAc,qBAAqB,CAAA;AACnC,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,qBAAqB,CAAA;AACnC,cAAc,oDAAoD,CAAA;AAClE,cAAc,kDAAkD,CAAA;AAChE,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kBAAkB,CAAA;AAChC,cAAc,yBAAyB,CAAA;AACvC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,iCAAiC,CAAA;AAC/C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,sBAAsB,CAAA;AACpC,cAAc,YAAY,CAAA;AAC1B,cAAc,4CAA4C,CAAA;AAC1D,cAAc,8BAA8B,CAAA;AAC5C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,uBAAuB,CAAA;AACrC,cAAc,kCAAkC,CAAA;AAChD,cAAc,qCAAqC,CAAA;AACnD,cAAc,sCAAsC,CAAA;AACpD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,mCAAmC,CAAA;AACjD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,iCAAiC,CAAA;AAC/C,cAAc,oCAAoC,CAAA;AAClD,cAAc,qCAAqC,CAAA;AACnD,cAAc,iCAAiC,CAAA;AAC/C,cAAc,kBAAkB,CAAA"}

package/dist/middlewares/create-action-tracking-middleware.d.ts

@@ -0,0 +1,24 @@
+import { type IMiddlewareEvent, type IMiddlewareHandler } from "../internal.ts";
+export interface IActionTrackingMiddlewareHooks<T> {
+    filter?: (call: IMiddlewareEvent) => boolean;
+    onStart: (call: IMiddlewareEvent) => T;
+    onResume: (call: IMiddlewareEvent, context: T) => void;
+    onSuspend: (call: IMiddlewareEvent, context: T) => void;
+    onSuccess: (call: IMiddlewareEvent, context: T, result: any) => void;
+    onFail: (call: IMiddlewareEvent, context: T, error: any) => void;
+}
+/**
+ * Note: Consider migrating to `createActionTrackingMiddleware2`, it is easier to use.
+ *
+ * Convenience utility to create action based middleware that supports async processes more easily.
+ * All hooks are called for both synchronous and asynchronous actions. Except that either `onSuccess` or `onFail` is called
+ *
+ * The create middleware tracks the process of an action (assuming it passes the `filter`).
+ * `onResume` can return any value, which will be passed as second argument to any other hook. This makes it possible to keep state during a process.
+ *
+ * See the `atomic` middleware for an example
+ *
+ * @param hooks
+ * @returns
+ */
+export declare function createActionTrackingMiddleware<T = any>(hooks: IActionTrackingMiddlewareHooks<T>): IMiddlewareHandler;

package/dist/middlewares/create-action-tracking-middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-action-tracking-middleware.js","sourceRoot":"","sources":["../../src/middlewares/create-action-tracking-middleware.ts"],"names":[],"mappings":"AAKA,MAAM,cAAc,GAAG,IAAI,GAAG,EAG3B,CAAA;AAWH;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,8BAA8B,CAC5C,KAAwC;IAExC,OAAO,SAAS,wBAAwB,CACtC,IAAsB,EACtB,IAA2C,EAC3C,KAA0B;QAE1B,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;oBACjD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;oBACnC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;oBAC7B,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE;wBAC1B,IAAI;wBACJ,OAAO;wBACP,KAAK,EAAE,KAAK;qBACb,CAAC,CAAA;oBACF,IAAI,CAAC;wBACH,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;wBACtB,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;wBAC9B,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAE,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;4BACjD,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;4BAC9B,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;wBACrC,CAAC;wBACD,OAAO,GAAG,CAAA;oBACZ,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;wBAC9B,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;wBAC9B,MAAM,CAAC,CAAA;oBACT,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;gBACnB,CAAC;YACH,CAAC;YACD,KAAK,YAAY,CAAC,CAAC,CAAC;gBAClB,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAE,CAAA;gBAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;gBACjB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;YACnB,CAAC;YACD,KAAK,aAAa,CAAC;YACnB,KAAK,mBAAmB,CAAC,CAAC,CAAC;gBACzB,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAE,CAAA;gBAC7C,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;gBAClC,IAAI,CAAC;oBACH,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;gBACnB,CAAC;wBAAS,CAAC;oBACT,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;gBACrC,CAAC;YACH,CAAC;YACD,KAAK,YAAY,CAAC,CAAC,CAAC;gBAClB,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAE,CAAA;gBAC7C,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAClC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;gBAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;YACnB,CAAC;YACD,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAE,CAAA;gBAC7C,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAClC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;gBACjD,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;YACnB,CAAC;QACH,CAAC;IACH,CAAC,CAAA;AACH,CAAC"}

package/dist/middlewares/createActionTrackingMiddleware2.d.ts

@@ -0,0 +1,34 @@
+import { type IActionContext, type IMiddlewareHandler } from "../internal.ts";
+export interface IActionTrackingMiddleware2Call<TEnv> extends Readonly<IActionContext> {
+    env: TEnv | undefined;
+    readonly parentCall?: IActionTrackingMiddleware2Call<TEnv>;
+}
+export interface IActionTrackingMiddleware2Hooks<TEnv> {
+    filter?: (call: IActionTrackingMiddleware2Call<TEnv>) => boolean;
+    onStart: (call: IActionTrackingMiddleware2Call<TEnv>) => void;
+    onFinish: (call: IActionTrackingMiddleware2Call<TEnv>, error?: any) => void;
+}
+/**
+ * Convenience utility to create action based middleware that supports async processes more easily.
+ * The flow is like this:
+ * - for each action: if filter passes -> `onStart` -> (inner actions recursively) -> `onFinish`
+ *
+ * Example: if we had an action `a` that called inside an action `b1`, then `b2` the flow would be:
+ * - `filter(a)`
+ * - `onStart(a)`
+ *   - `filter(b1)`
+ *   - `onStart(b1)`
+ *   - `onFinish(b1)`
+ *   - `filter(b2)`
+ *   - `onStart(b2)`
+ *   - `onFinish(b2)`
+ * - `onFinish(a)`
+ *
+ * The flow is the same no matter if the actions are sync or async.
+ *
+ * See the `atomic` middleware for an example
+ *
+ * @param hooks
+ * @returns
+ */
+export declare function createActionTrackingMiddleware2<TEnv = any>(middlewareHooks: IActionTrackingMiddleware2Hooks<TEnv>): IMiddlewareHandler;

package/dist/middlewares/createActionTrackingMiddleware2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createActionTrackingMiddleware2.js","sourceRoot":"","sources":["../../src/middlewares/createActionTrackingMiddleware2.ts"],"names":[],"mappings":"AAqBA,MAAM,aAAa;IAKC;IACP;IALH,YAAY,GAAG,CAAC,CAAA;IAChB,OAAO,GAAG,IAAI,CAAA;IAEtB,YACkB,KAAuD,EAC9D,IAAyC;QADlC,UAAK,GAAL,KAAK,CAAkD;QAC9D,SAAI,GAAJ,IAAI,CAAqC;QAElD,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrB,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAW;QAChB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;YACpB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YACvC,CAAC;QACH,CAAC;IACH,CAAC;IAED,eAAe;QACb,IAAI,CAAC,YAAY,EAAE,CAAA;IACrB,CAAC;IAED,eAAe;QACb,IAAI,CAAC,YAAY,EAAE,CAAA;IACrB,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;IAC9B,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,+BAA+B,CAC7C,eAAsD;IAEtD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAyB,CAAA;IAEvD,OAAO,SAAS,wBAAwB,CACtC,IAAsB,EACtB,IAA2C;QAE3C,2BAA2B;QAC3B,MAAM,mBAAmB,GAAG,IAAI,CAAC,iBAAiB;YAChD,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC/C,CAAC,CAAC,SAAS,CAAA;QAEb,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAyC;gBACpD,GAAG,IAAI;gBACP,+CAA+C;gBAC/C,GAAG,EAAE,mBAAmB,IAAI,mBAAmB,CAAC,IAAI,CAAC,GAAG;gBACxD,UAAU,EAAE,mBAAmB,IAAI,mBAAmB,CAAC,IAAI;aAC5D,CAAA;YAED,MAAM,YAAY,GAChB,CAAC,eAAe,CAAC,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAC5D,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAA;YAExD,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;YACvD,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,aAAa,CAAC,CAAA;YAE1C,IAAI,GAAG,CAAA;YACP,IAAI,CAAC;gBACH,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;YAClB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBAC9B,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;gBACvB,MAAM,CAAC,CAAA;YACT,CAAC;YACD,uBAAuB;YACvB,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,CAAC;gBACnC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBAC9B,aAAa,CAAC,MAAM,EAAE,CAAA;YACxB,CAAC;YACD,OAAO,GAAG,CAAA;QACZ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;YACnB,CAAC;YAED,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,KAAK,YAAY,CAAC,CAAC,CAAC;oBAClB,mBAAmB,CAAC,eAAe,EAAE,CAAA;oBACrC,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;gBACnB,CAAC;gBACD,KAAK,aAAa,CAAC;gBACnB,KAAK,mBAAmB,CAAC,CAAC,CAAC;oBACzB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;gBACnB,CAAC;gBACD,KAAK,YAAY,CAAC,CAAC,CAAC;oBAClB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;oBAC1B,IAAI,CAAC;wBACH,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;oBACnB,CAAC;4BAAS,CAAC;wBACT,mBAAmB,CAAC,eAAe,EAAE,CAAA;wBACrC,IAAI,CAAC,mBAAmB,CAAC,eAAe,EAAE,CAAC;4BACzC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAkB,CAAC,EAAE,CAAC,CAAA;4BACjD,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;wBACnC,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,KAAK,aAAa,CAAC,CAAC,CAAC;oBACnB,IAAI,CAAC;wBACH,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;oBACnB,CAAC;4BAAS,CAAC;wBACT,mBAAmB,CAAC,eAAe,EAAE,CAAA;wBACrC,IAAI,CAAC,mBAAmB,CAAC,eAAe,EAAE,CAAC;4BACzC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAkB,CAAC,EAAE,CAAC,CAAA;4BACjD,mBAAmB,CAAC,MAAM,EAAE,CAAA;wBAC9B,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC,CAAA;AACH,CAAC"}

package/dist/middlewares/on-action.d.ts

@@ -0,0 +1,87 @@
+import { type IActionContext, type IAnyStateTreeNode, type IDisposer } from "../internal.ts";
+export interface ISerializedActionCall {
+    name: string;
+    path?: string;
+    args?: any[];
+}
+export interface IActionRecorder {
+    actions: ReadonlyArray<ISerializedActionCall>;
+    readonly recording: boolean;
+    stop(): void;
+    resume(): void;
+    replay(target: IAnyStateTreeNode): void;
+}
+/**
+ * Applies an action or a series of actions in a single MobX transaction.
+ * Does not return any value
+ * Takes an action description as produced by the `onAction` middleware.
+ *
+ * @param target
+ * @param actions
+ */
+export declare function applyAction(target: IAnyStateTreeNode, actions: ISerializedActionCall | ISerializedActionCall[]): void;
+/**
+ * Small abstraction around `onAction` and `applyAction`, attaches an action listener to a tree and records all the actions emitted.
+ * Returns an recorder object with the following signature:
+ *
+ * Example:
+ * ```ts
+ * export interface IActionRecorder {
+ *      // the recorded actions
+ *      actions: ISerializedActionCall[]
+ *      // true if currently recording
+ *      recording: boolean
+ *      // stop recording actions
+ *      stop(): void
+ *      // resume recording actions
+ *      resume(): void
+ *      // apply all the recorded actions on the given object
+ *      replay(target: IAnyStateTreeNode): void
+ * }
+ * ```
+ *
+ * The optional filter function allows to skip recording certain actions.
+ *
+ * @param subject
+ * @returns
+ */
+export declare function recordActions(subject: IAnyStateTreeNode, filter?: (action: ISerializedActionCall, actionContext: IActionContext | undefined) => boolean): IActionRecorder;
+/**
+ * Registers a function that will be invoked for each action that is called on the provided model instance, or to any of its children.
+ * See [actions](https://github.com/mobxjs/mobx-state-tree#actions) for more details. onAction events are emitted only for the outermost called action in the stack.
+ * Action can also be intercepted by middleware using addMiddleware to change the function call before it will be run.
+ *
+ * Not all action arguments might be serializable. For unserializable arguments, a struct like `{ $MST_UNSERIALIZABLE: true, type: "someType" }` will be generated.
+ * MST Nodes are considered non-serializable as well (they could be serialized as there snapshot, but it is uncertain whether an replaying party will be able to handle such a non-instantiated snapshot).
+ * Rather, when using `onAction` middleware, one should consider in passing arguments which are 1: an id, 2: a (relative) path, or 3: a snapshot. Instead of a real MST node.
+ *
+ * Example:
+ * ```ts
+ * const Todo = types.model({
+ *   task: types.string
+ * })
+ *
+ * const TodoStore = types.model({
+ *   todos: types.array(Todo)
+ * }).actions(self => ({
+ *   add(todo) {
+ *     self.todos.push(todo);
+ *   }
+ * }))
+ *
+ * const s = TodoStore.create({ todos: [] })
+ *
+ * let disposer = onAction(s, (call) => {
+ *   console.log(call);
+ * })
+ *
+ * s.add({ task: "Grab a coffee" })
+ * // Logs: { name: "add", path: "", args: [{ task: "Grab a coffee" }] }
+ * ```
+ *
+ * @param target
+ * @param listener
+ * @param attachAfter (default false) fires the listener *after* the action has executed instead of before.
+ * @returns
+ */
+export declare function onAction(target: IAnyStateTreeNode, listener: (call: ISerializedActionCall) => void, attachAfter?: boolean): IDisposer;

package/dist/middlewares/on-action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"on-action.js","sourceRoot":"","sources":["../../src/middlewares/on-action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAA;AAElC,OAAO,EAKL,aAAa,EACb,UAAU,EACV,aAAa,EACb,OAAO,EACP,SAAS,EACT,qBAAqB,EACrB,OAAO,EACP,IAAI,EACJ,2BAA2B,EAC3B,uBAAuB,EACvB,gBAAgB,EAChB,OAAO,EACP,OAAO,EACP,aAAa,EACb,WAAW,EACX,WAAW,EACX,MAAM,EACN,eAAe,EACf,UAAU,EACV,SAAS,EACV,MAAM,gBAAgB,CAAA;AAgBvB,SAAS,iBAAiB,CACxB,IAAa,EACb,UAAkB,EAClB,KAAa,EACb,GAAQ;IAER,IAAI,GAAG,YAAY,IAAI,EAAE,CAAC;QACxB,OAAO,EAAE,SAAS,EAAE,GAAG,CAAC,OAAO,EAAE,EAAE,CAAA;IACrC,CAAC;IACD,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,0IAA0I;IAC1I,mJAAmJ;IACnJ,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,OAAO,0BAA0B,CAAC,aAAa,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAA;IACtE,CAAC;IACD,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE,CAAC;QAC9B,OAAO,0BAA0B,CAAC,YAAY,CAAC,CAAA;IACjD,CAAC;IACD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACpE,OAAO,0BAA0B,CAC/B,WACE,CAAC,GAAG,IAAK,GAAW,CAAC,WAAW,IAAK,GAAW,CAAC,WAAW,CAAC,IAAI,CAAC;YAClE,gBACF,GAAG,CACJ,CAAA;IACH,CAAC;IACD,IAAI,CAAC;QACH,2CAA2C;QAC3C,sCAAsC;QACtC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA,CAAC,YAAY;QAChC,OAAO,GAAG,CAAA;IACZ,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,0BAA0B,CAAC,EAAE,GAAG,CAAC,CAAC,CAAA;IAC3C,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAY,EAAE,KAAU;IACnD,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,WAAW,IAAI,KAAK,EAAE,CAAC;QAC/D,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAA;IACrC,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,0BAA0B,CAAC,QAAgB;IAClD,OAAO;QACL,mBAAmB,EAAE,IAAI;QACzB,IAAI,EAAE,QAAQ;KACf,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CACzB,MAAyB,EACzB,OAAwD;IAExD,sBAAsB;IACtB,qBAAqB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAChC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAA;IAEpE,WAAW,CAAC,GAAG,EAAE;QACf,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IACrE,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,eAAe,CACtB,MAAyB,EACzB,MAA6B;IAE7B,MAAM,cAAc,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;IAC5D,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,CAAC,wBAAwB,MAAM,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC,CAAA;IACzD,CAAC;IACD,MAAM,IAAI,GAAG,gBAAgB,CAAC,cAAc,CAAC,CAAA;IAE7C,qBAAqB;IACrB,IAAI,MAAM,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACrC,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,MAAM,CAAC,IAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAC/D,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QACtC,OAAO,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,MAAM,CAAC,IAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAClE,CAAC;IAED,IAAI,CAAC,CAAC,OAAO,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,CAAC,WAAW,MAAM,CAAC,IAAI,wBAAwB,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;IACxE,CAAC;IACD,OAAO,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CACtC,cAAc,EACd,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CACtE,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,aAAa,CAC3B,OAA0B,EAC1B,MAGY;IAEZ,sBAAsB;IACtB,qBAAqB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;IAEjC,MAAM,OAAO,GAA4B,EAAE,CAAA;IAC3C,MAAM,QAAQ,GAAG,CAAC,IAA2B,EAAE,EAAE;QAC/C,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAC1E,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpB,CAAC;IACH,CAAC,CAAA;IAED,IAAI,QAA+B,CAAA;IACnC,MAAM,QAAQ,GAAoB;QAChC,OAAO;QACP,IAAI,SAAS;YACX,OAAO,CAAC,CAAC,QAAQ,CAAA;QACnB,CAAC;QACD,IAAI;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,EAAE,CAAA;gBACV,QAAQ,GAAG,SAAS,CAAA;YACtB,CAAC;QACH,CAAC;QACD,MAAM;YACJ,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAM;YACR,CAAC;YACD,QAAQ,GAAG,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;QACxC,CAAC;QACD,MAAM,CAAC,MAAM;YACX,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC9B,CAAC;KACF,CAAA;IAED,QAAQ,CAAC,MAAM,EAAE,CAAA;IACjB,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAyB,EACzB,QAA+C,EAC/C,WAAW,GAAG,KAAK;IAEnB,sBAAsB;IACtB,qBAAqB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAChC,IAAI,OAAO,EAAE,EAAE,CAAC;QACd,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACpB,SAAS,CACP,8IAA8I,CAC/I,CAAA;QACH,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YACzB,SAAS,CACP,+IAA+I,CAChJ,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAAC,MAAM,EAAE,SAAS,OAAO,CAAC,OAAO,EAAE,IAAI;QACzD,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,CAAC,EAAE,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YACpD,MAAM,IAAI,GAAG;gBACX,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,IAAI,EAAE,2BAA2B,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;gBACvE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,KAAa,EAAE,EAAE,CACjD,iBAAiB,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CACxD;aACF,CAAA;YACD,IAAI,WAAW,EAAE,CAAC;gBAChB,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAA;gBACzB,QAAQ,CAAC,IAAI,CAAC,CAAA;gBACd,OAAO,GAAG,CAAA;YACZ,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CAAC,CAAA;gBACd,OAAO,IAAI,CAAC,OAAO,CAAC,CAAA;YACtB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,OAAO,CAAC,CAAA;QACtB,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/types/complex-types/array.d.ts

@@ -0,0 +1,80 @@
+import { IArrayDidChange, IArraySplice, IArrayWillChange, IArrayWillSplice, IObservableArray } from "mobx";
+import { type AnyNode, type AnyObjectNode, ComplexType, type ExtractCSTWithSTN, type IAnyType, type IChildNodesMap, type IHooksGetter, type IJsonPatch, type IType, type IValidationContext, type IValidationResult, TypeFlags } from "../../internal.ts";
+/** @hidden */
+export interface IMSTArray<IT extends IAnyType> extends IObservableArray<IT["Type"]> {
+    push(...items: IT["Type"][]): number;
+    push(...items: ExtractCSTWithSTN<IT>[]): number;
+    concat(...items: ConcatArray<IT["Type"]>[]): IT["Type"][];
+    concat(...items: ConcatArray<ExtractCSTWithSTN<IT>>[]): IT["Type"][];
+    concat(...items: (IT["Type"] | ConcatArray<IT["Type"]>)[]): IT["Type"][];
+    concat(...items: (ExtractCSTWithSTN<IT> | ConcatArray<ExtractCSTWithSTN<IT>>)[]): IT["Type"][];
+    splice(start: number, deleteCount?: number): IT["Type"][];
+    splice(start: number, deleteCount: number, ...items: IT["Type"][]): IT["Type"][];
+    splice(start: number, deleteCount: number, ...items: ExtractCSTWithSTN<IT>[]): IT["Type"][];
+    unshift(...items: IT["Type"][]): number;
+    unshift(...items: ExtractCSTWithSTN<IT>[]): number;
+}
+/** @hidden */
+export interface IArrayType<IT extends IAnyType> extends IType<readonly IT["CreationType"][] | undefined, IT["SnapshotType"][], IMSTArray<IT>> {
+    hooks(hooks: IHooksGetter<IMSTArray<IAnyType>>): IArrayType<IT>;
+}
+/**
+ * @internal
+ * @hidden
+ */
+export declare class ArrayType<IT extends IAnyType> extends ComplexType<readonly IT["CreationType"][] | undefined, IT["SnapshotType"][], IMSTArray<IT>> {
+    private readonly _subType;
+    readonly flags = TypeFlags.Array;
+    private readonly hookInitializers;
+    constructor(name: string, _subType: IT, hookInitializers?: Array<IHooksGetter<IMSTArray<IT>>>);
+    hooks(hooks: IHooksGetter<IMSTArray<IT>>): ArrayType<IT>;
+    instantiate(parent: AnyObjectNode | null, subpath: string, environment: any, initialValue: this["C"] | this["T"]): this["N"];
+    initializeChildNodes(objNode: this["N"], snapshot?: this["C"]): IChildNodesMap;
+    createNewInstance(childNodes: IChildNodesMap): this["T"];
+    finalizeNewInstance(node: this["N"], instance: this["T"]): void;
+    describe(): string;
+    getChildren(node: this["N"]): AnyNode[];
+    getChildNode(node: this["N"], key: string): AnyNode;
+    willChange(change: IArrayWillChange<AnyNode> | IArrayWillSplice<AnyNode>): IArrayWillChange<AnyNode> | IArrayWillSplice<AnyNode> | null;
+    getSnapshot(node: this["N"]): this["S"];
+    processInitialSnapshot(childNodes: IChildNodesMap): this["S"];
+    didChange(change: IArrayDidChange<AnyNode> | IArraySplice<AnyNode>): void;
+    applyPatchLocally(node: this["N"], subpath: string, patch: IJsonPatch): void;
+    applySnapshot(node: this["N"], snapshot: this["C"]): void;
+    getChildType(): IAnyType;
+    isValidSnapshot(value: this["C"], context: IValidationContext): IValidationResult;
+    getDefaultSnapshot(): this["C"];
+    removeChild(node: this["N"], subpath: string): void;
+}
+/**
+ * `types.array` - Creates an index based collection type who's children are all of a uniform declared type.
+ *
+ * This type will always produce [observable arrays](https://mobx.js.org/api.html#observablearray)
+ *
+ * Example:
+ * ```ts
+ * const Todo = types.model({
+ *   task: types.string
+ * })
+ *
+ * const TodoStore = types.model({
+ *   todos: types.array(Todo)
+ * })
+ *
+ * const s = TodoStore.create({ todos: [] })
+ * unprotect(s) // needed to allow modifying outside of an action
+ * s.todos.push({ task: "Grab coffee" })
+ * console.log(s.todos[0]) // prints: "Grab coffee"
+ * ```
+ *
+ * @param subtype
+ * @returns
+ */
+export declare function array<IT extends IAnyType>(subtype: IT): IArrayType<IT>;
+/**
+ * Returns if a given value represents an array type.
+ *
+ * @param type
+ * @returns `true` if the type is an array type.
+ */
+export declare function isArrayType<Items extends IAnyType = IAnyType>(type: IAnyType): type is IArrayType<Items>;