mobx-state-tree 5.3.1-alpha.1 → 5.4.0

package/README.md

@@ -28,51 +28,51 @@ See the [Getting started](https://mobx-state-tree.js.org/intro/getting-started)
 There's nothing quite like looking at some code to get a feel for a library. Check out this small example of an author and list of tweets by that author.
 
 ```js
-import { types } from "mobx-state-tree"
+import { types } from "mobx-state-tree" // alternatively: import { t } from "mobx-state-tree"
 
 // Define a couple models
 const Author = types.model({
-    id: types.identifier,
-    firstName: types.string,
-    lastName: types.string
+  id: types.identifier,
+  firstName: types.string,
+  lastName: types.string
 })
 const Tweet = types.model({
-    id: types.identifier,
-    author: types.reference(Author), // stores just the `id` reference!
-    body: types.string,
-    timestamp: types.number
+  id: types.identifier,
+  author: types.reference(Author), // stores just the `id` reference!
+  body: types.string,
+  timestamp: types.number
 })
 
 // Define a store just like a model
 const RootStore = types.model({
-    authors: types.array(Author),
-    tweets: types.array(Tweet)
+  authors: types.array(Author),
+  tweets: types.array(Tweet)
 })
 
 // Instantiate a couple model instances
 const jamon = Author.create({
-    id: "jamon",
-    firstName: "Jamon",
-    lastName: "Holmgren"
+  id: "jamon",
+  firstName: "Jamon",
+  lastName: "Holmgren"
 })
 
 const tweet = Tweet.create({
-    id: "1",
-    author: jamon.id, // just the ID needed here
-    body: "Hello world!",
-    timestamp: Date.now()
+  id: "1",
+  author: jamon.id, // just the ID needed here
+  body: "Hello world!",
+  timestamp: Date.now()
 })
 
 // Now instantiate the store!
 const rootStore = RootStore.create({
-    authors: [jamon],
-    tweets: [tweet]
+  authors: [jamon],
+  tweets: [tweet]
 })
 
 // Ready to use in a React component, if that's your target.
 import { observer } from "mobx-react-lite"
 const MyComponent = observer((props) => {
-    return <div>Hello, {rootStore.authors[0].firstName}!</div>
+  return <div>Hello, {rootStore.authors[0].firstName}!</div>
 })
 
 // Note: since this component is "observed", any changes to rootStore.authors[0].firstName
@@ -82,9 +82,9 @@ const MyComponent = observer((props) => {
 
 ## Thanks!
 
--   [Michel Weststrate](https://twitter.com/mweststrate) for creating MobX, MobX-State-Tree, and MobX-React.
--   [Infinite Red](https://infinite.red) for supporting ongoing maintenance on MST.
--   [Mendix](https://mendix.com) for sponsoring and providing the opportunity to work on exploratory projects like MST.
--   [Dan Abramov](https://twitter.com/dan_abramov)'s work on [Redux](http://redux.js.org) has strongly influenced the idea of snapshots and transactional actions in MST.
--   [Giulio Canti](https://twitter.com/GiulioCanti)'s work on [tcomb](http://github.com/gcanti/tcomb) and type systems in general has strongly influenced the type system of MST.
--   All the early adopters encouraging to pursue this whole idea and proving it is something feasible.
+- [Michel Weststrate](https://twitter.com/mweststrate) for creating MobX, MobX-State-Tree, and MobX-React.
+- [Infinite Red](https://infinite.red) for supporting ongoing maintenance on MST.
+- [Mendix](https://mendix.com) for sponsoring and providing the opportunity to work on exploratory projects like MST.
+- [Dan Abramov](https://twitter.com/dan_abramov)'s work on [Redux](http://redux.js.org) has strongly influenced the idea of snapshots and transactional actions in MST.
+- [Giulio Canti](https://twitter.com/GiulioCanti)'s work on [tcomb](http://github.com/gcanti/tcomb) and type systems in general has strongly influenced the type system of MST.
+- All the early adopters encouraging to pursue this whole idea and proving it is something feasible.

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 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, toGeneratorFunction, toGenerator } from "./internal";
+ModelSnapshotType, ModelCreationType, ModelSnapshotType2, ModelCreationType2, ModelInstanceType, ModelInstanceTypeProps, ModelPropertiesDeclarationToProperties, ModelProperties, ModelPropertiesDeclaration, ModelActions, ITypeUnion, CustomTypeOptions, UnionOptions, Instance, SnapshotIn, SnapshotOut, SnapshotOrInstance, TypeOrStateTreeNodeToStateTreeNode, UnionStringArray, getType, getChildType, onPatch, onSnapshot, applyPatch, IPatchRecorder, recordPatches, protect, unprotect, isProtected, applySnapshot, getSnapshot, hasParent, getParent, hasParentOfType, getParentOfType, getRoot, getPath, getPathParts, isRoot, resolvePath, resolveIdentifier, getIdentifier, tryResolve, getRelativePath, clone, detach, destroy, isAlive, addDisposer, getEnv, walk, IModelReflectionData, IModelReflectionPropertiesData, IMaybeIType, IMaybe, IMaybeNull, IOptionalIType, OptionalDefaultValueOrFunction, ValidOptionalValue, ValidOptionalValues, getMembers, getPropertyMembers, TypeOfValue, cast, castToSnapshot, castToReferenceSnapshot, isType, isArrayType, isFrozenType, isIdentifierType, isLateType, isLiteralType, isMapType, isModelType, isOptionalType, isPrimitiveType, isReferenceType, isRefinementType, isUnionType, tryReference, isValidReference, OnReferenceInvalidated, OnReferenceInvalidatedEvent, ReferenceOptions, ReferenceOptionsGetSet, ReferenceOptionsOnInvalidated, ReferenceIdentifier, ISnapshotProcessor, ISnapshotProcessors, getNodeId, IActionContext, getRunningActionContext, isActionContextChildOf, isActionContextThisOrChildOf, types, types as t, // We do this as a less ambiguous term for the traditional types module, which sometimes gets confused when discussing "types" in general
+toGeneratorFunction, toGenerator } from "./internal";

package/dist/mobx-state-tree.js

@@ -1462,6 +1462,12 @@ var ObjectNode = /** @class */ (function (_super) {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(_this, "hasSnapshotPostProcessor", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
         Object.defineProperty(_this, "_applyPatches", {
             enumerable: true,
             configurable: true,
@@ -1792,6 +1798,9 @@ var ObjectNode = /** @class */ (function (_super) {
     Object.defineProperty(ObjectNode.prototype, "snapshot", {
         // advantage of using computed for a snapshot is that nicely respects transactions etc.
         get: function () {
+            if (this.hasSnapshotPostProcessor) {
+                this.createObservableInstanceIfNeeded();
+            }
             return this._snapshotComputed.get();
         },
         enumerable: false,
@@ -4704,9 +4713,9 @@ var SnapshotProcessor = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true,
         writable: true,
-        value: function (sn) {
+        value: function (sn, node) {
             if (this._processors.postProcessor) {
-                return this._processors.postProcessor.call(null, sn);
+                return this._processors.postProcessor.call(null, sn, node.storedValue);
             }
             return sn;
         }
@@ -4719,10 +4728,11 @@ var SnapshotProcessor = /** @class */ (function (_super) {
             var _this = this;
             // the node has to use these methods rather than the original type ones
             proxyNodeTypeMethods(node.type, this, "create");
+            if (node instanceof ObjectNode) {
+                node.hasSnapshotPostProcessor = !!this._processors.postProcessor;
+            }
             var oldGetSnapshot = node.getSnapshot;
-            node.getSnapshot = function () {
-                return _this.postProcessSnapshot(oldGetSnapshot.call(node));
-            };
+            node.getSnapshot = function () { return _this.postProcessSnapshot(oldGetSnapshot.call(node), node); };
             if (!isUnionType(this._subtype)) {
                 node.getReconciliationType = function () {
                     return _this;
@@ -4762,7 +4772,7 @@ var SnapshotProcessor = /** @class */ (function (_super) {
         value: function (node, applyPostProcess) {
             if (applyPostProcess === void 0) { applyPostProcess = true; }
             var sn = this._subtype.getSnapshot(node);
-            return applyPostProcess ? this.postProcessSnapshot(sn) : sn;
+            return applyPostProcess ? this.postProcessSnapshot(sn, node) : sn;
         }
     });
     Object.defineProperty(SnapshotProcessor.prototype, "isValidSnapshot", {
@@ -4853,15 +4863,17 @@ function proxyNodeTypeMethods(nodeType, snapshotProcessorType) {
  * interface BackendTodo {
  *     text: string | null
  * }
+ *
  * const Todo2 = types.snapshotProcessor(Todo1, {
  *     // from snapshot to instance
- *     preProcessor(sn: BackendTodo) {
+ *     preProcessor(snapshot: BackendTodo) {
  *         return {
  *             text: sn.text || "";
  *         }
  *     },
+ *
  *     // from instance to snapshot
- *     postProcessor(sn): BackendTodo {
+ *     postProcessor(snapshot, node): BackendTodo {
  *         return {
  *             text: !sn.text ? null : sn.text
  *         }
@@ -5859,27 +5871,34 @@ function toPropertiesObject(declaredProps) {
         if (key in Hook) {
             throw fail$1("Hook '" + key + "' was defined as property. Hooks should be defined as part of the actions");
         }
+        // the user intended to use a view
         var descriptor = Object.getOwnPropertyDescriptor(declaredProps, key);
         if ("get" in descriptor) {
             throw fail$1("Getters are not supported as properties. Please use views instead");
         }
+        // undefined and null are not valid
         var value = descriptor.value;
         if (value === null || value === undefined) {
             throw fail$1("The default value of an attribute cannot be null or undefined as the type cannot be inferred. Did you mean `types.maybe(someType)`?");
         }
+        // its a primitive, convert to its type
         else if (isPrimitive(value)) {
             props[key] = optional(getPrimitiveFactoryFromValue(value), value);
         }
+        // map defaults to empty object automatically for models
         else if (value instanceof MapType) {
             props[key] = optional(value, {});
         }
         else if (value instanceof ArrayType) {
             props[key] = optional(value, []);
         }
+        // its already a type
         else if (isType(value)) ;
+        // its a function, maybe the user wanted a view?
         else if (devMode() && typeof value === "function") {
             throw fail$1("Invalid type definition for property '" + key + "', it looks like you passed a function. Did you forget to invoke it, or did you intend to declare a view / action?");
         }
+        // no other complex values
         else if (devMode() && typeof value === "object") {
             throw fail$1("Invalid type definition for property '" + key + "', it looks like you passed an object. Try passing another model type or a types.frozen.");
         }
@@ -8596,6 +8615,7 @@ exports.resolvePath = resolvePath;
 exports.setLivelinessChecking = setLivelinessChecking;
 exports.setLivelynessChecking = setLivelynessChecking;
 exports.splitJsonPath = splitJsonPath;
+exports.t = types;
 exports.toGenerator = toGenerator;
 exports.toGeneratorFunction = toGeneratorFunction;
 exports.tryReference = tryReference;