mobx-state-tree - npm Package Compare versions

Comparing version 3.15.0 to 3.16.0

dist/core/action.d.ts

@@ -20,3 +20,3 @@ import { IDisposer, IAnyStateTreeNode, IActionContext } from "../internal";
  *
- * For more details, see the [middleware docs](../middleware.md)
+ * For more details, see the [middleware docs](concepts/middleware.md)
  *
@@ -23,0 +23,0 @@ * @param target Node to apply the middleware to.

dist/core/actionContext.d.ts

@@ -0,0 +0,0 @@ import { IAnyStateTreeNode, IMiddlewareEvent } from "../internal";

dist/core/flow.d.ts

 /**
- * See [asynchronous actions](https://github.com/mobxjs/mobx-state-tree/blob/master/docs/async-actions.md).
+ * @hidden
+ */
+export declare type FlowReturn<R> = R extends Promise<infer T> ? T : R;
+/**
+ * See [asynchronous actions](concepts/async-actions.md).
  *
  * @returns The flow as a promise.
  */
-export declare function flow<R, Args extends any[]>(generator: (...args: Args) => Generator<any, R, any>): (...args: Args) => Promise<R>;
+export declare function flow<R, Args extends any[]>(generator: (...args: Args) => Generator<Promise<any>, R, any>): (...args: Args) => Promise<FlowReturn<R>>;
 /**
@@ -8,0 +12,0 @@ * @deprecated Not needed since TS3.6.

dist/core/json-patch.d.ts

@@ -0,0 +0,0 @@ /**

dist/core/mst-operations.d.ts

@@ -0,0 +0,0 @@ import { IAnyStateTreeNode, IType, IAnyModelType, IStateTreeNode, IJsonPatch, IDisposer, IAnyType, ReferenceIdentifier, TypeOfValue, IActionContext, IAnyComplexType } from "../internal";

dist/core/node/BaseNode.d.ts

 export {};

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

 export {};

dist/core/node/Hook.d.ts

@@ -0,0 +0,0 @@ /**

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

 export {};

dist/core/node/livelinessChecking.d.ts

@@ -0,0 +0,0 @@ /**

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

@@ -0,0 +0,0 @@ import { IAnyType, STNValue, Instance, IAnyComplexType } from "../../internal";

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

 export {};

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

 export {};

dist/core/process.d.ts

@@ -0,0 +0,0 @@ /**

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

@@ -0,0 +0,0 @@ import { IAnyType, ExtractCSTWithSTN } from "../../internal";

dist/core/type/type.d.ts

@@ -0,0 +0,0 @@ import { IValidationContext, IValidationResult, IStateTreeNode, ModelPrimitive } from "../../internal";

dist/index.d.ts

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

dist/internal.d.ts

@@ -0,0 +0,0 @@ export * from "./core/node/livelinessChecking";

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

@@ -0,0 +0,0 @@ import { IMiddlewareEvent, IMiddlewareHandler } from "../internal";

dist/middlewares/createActionTrackingMiddleware2.d.ts

@@ -0,0 +0,0 @@ import { IMiddlewareHandler, IActionContext } from "../internal";

dist/middlewares/on-action.d.ts

@@ -0,0 +0,0 @@ import { IDisposer, IAnyStateTreeNode, IActionContext } from "../internal";

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

@@ -0,0 +0,0 @@ import { IObservableArray } from "mobx";

dist/types/complex-types/map.d.ts

@@ -0,0 +0,0 @@ import { IInterceptor, IKeyValueMap, IMapDidChange, IMapWillChange, Lambda } from "mobx";

dist/types/complex-types/model.d.ts

@@ -0,0 +0,0 @@ import { IAnyType, IType, _CustomOrOther, _NotCustomized, Instance } from "../../internal";

dist/types/index.d.ts

@@ -0,0 +0,0 @@ import { enumeration, model, compose, custom, reference, safeReference, union, optional, literal, maybe, maybeNull, refinement, map, array, frozen, late, snapshotProcessor } from "../internal";

dist/types/primitives.d.ts

@@ -0,0 +0,0 @@ import { ISimpleType, IType } from "../internal";

dist/types/utility-types/custom.d.ts

@@ -5,4 +5,4 @@ import { IType } from "../../internal";
     name: string;
-    /** given a serialized value, how to turn it into the target type */
-    fromSnapshot(snapshot: S): T;
+    /** given a serialized value and environment, how to turn it into the target type */
+    fromSnapshot(snapshot: S, env?: any): T;
     /** return the serialization of the current value */
@@ -23,4 +23,4 @@ toSnapshot(value: T): S;
  *     name: string
- *     // given a serialized value, how to turn it into the target type
- *     fromSnapshot(snapshot: S): T
+ *     // given a serialized value and environment, how to turn it into the target type
+ *     fromSnapshot(snapshot: S, env: any): T
  *     // return the serialization of the current value
@@ -27,0 +27,0 @@ *     toSnapshot(value: T): S

dist/types/utility-types/enumeration.d.ts

@@ -0,0 +0,0 @@ import { ISimpleType } from "../../internal";

dist/types/utility-types/frozen.d.ts

@@ -0,0 +0,0 @@ import { IType } from "../../internal";

dist/types/utility-types/identifier.d.ts

@@ -0,0 +0,0 @@ import { ISimpleType } from "../../internal";

dist/types/utility-types/late.d.ts

@@ -0,0 +0,0 @@ import { IAnyType } from "../../internal";

dist/types/utility-types/literal.d.ts

@@ -0,0 +0,0 @@ import { ISimpleType, Primitives } from "../../internal";

dist/types/utility-types/maybe.d.ts

@@ -0,0 +0,0 @@ import { IType, IAnyType } from "../../internal";

dist/types/utility-types/optional.d.ts

@@ -0,0 +0,0 @@ import { IType, IAnyType, ExtractCSTWithSTN } from "../../internal";

dist/types/utility-types/reference.d.ts

@@ -0,0 +0,0 @@ import { IType, IAnyType, IAnyStateTreeNode, IAnyComplexType, IMaybe, ReferenceIdentifier, IStateTreeNode } from "../../internal";

dist/types/utility-types/refinement.d.ts

@@ -0,0 +0,0 @@ import { IAnyType } from "../../internal";

dist/types/utility-types/snapshotProcessor.d.ts

@@ -0,0 +0,0 @@ import { IType, IAnyType } from "../../internal";

dist/types/utility-types/union.d.ts

@@ -0,0 +0,0 @@ import { IType, IAnyType, IModelType, ModelProperties, ModelInstanceType, ModelSnapshotType2, ModelCreationType2, _NotCustomized } from "../../internal";

dist/utils.d.ts

@@ -0,0 +0,0 @@ /**

package.json

 {
     "name": "mobx-state-tree",
-    "version": "3.15.0",
+    "version": "3.16.0",
     "description": "Opinionated, transactional, MobX powered state container",
@@ -16,2 +16,3 @@ "main": "dist/mobx-state-tree.js",
     "typings": "dist/index.d.ts",
+    "sideEffects": false,
     "scripts": {
@@ -30,5 +31,4 @@ "clean": "shx rm -rf dist && shx rm -rf lib",
         "_prepublish": "yarn build && yarn build-docs",
-        "fix-docs": "concat -o ../../docs/API/README.md ../../docs/API_header.md ../../docs/API/README.md",
         "fix-typedoc": "shx rm -rf ../../node_modules/typedoc/node_modules/typescript",
-        "build-docs": "yarn run fix-typedoc && shx rm -rf ../../docs/API && typedoc --options ./typedocconfig.js && yarn fix-docs",
+        "build-docs": "yarn run fix-typedoc && shx rm -rf ../../docs/API && typedoc --options ./typedocconfig.js",
         "lint": "tslint -c ./tslint.json 'src/**/*.ts'"
@@ -42,2 +42,6 @@ },
     "license": "MIT",
+    "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/mobx"
+    },
     "bugs": {
@@ -88,3 +92,4 @@ "url": "https://github.com/mobxjs/mobx-state-tree/issues"
         "state management"
-    ]
+    ],
+    "gitHead": "19012c2c0f50a8b89cecdd045cb5ce98db950287"
 }

No alert changes

Improved metrics

Number of package files

47

increased by2.17%

Lines of code

21808

increased by0.34%

Worsened metrics

Total package byte prevSize

1006318

decreased by-11.72%

Number of lines in readme file

26

decreased by-98.54%

No dependency changes