mobx 6.2.0 → 6.3.3

package/dist/mobx.d.ts

@@ -1,2 +1,2 @@
-export { IObservable, IDepTreeNode, Reaction, IReactionPublic, IReactionDisposer, untracked, IAtom, createAtom, spy, IComputedValue, IEqualsComparer, comparer, IEnhancer, IInterceptable, IInterceptor, IListenable, IObjectWillChange, IObjectDidChange, isObservableObject, IValueDidChange, IValueWillChange, IObservableValue, isObservableValue as isBoxedObservable, IObservableArray, IArrayWillChange, IArrayWillSplice, IArraySplice, IArrayUpdate, IArrayDidChange, isObservableArray, IKeyValueMap, ObservableMap, IMapEntries, IMapEntry, IMapWillChange, IMapDidChange, isObservableMap, IObservableMapInitialValues, ObservableSet, isObservableSet, ISetDidChange, ISetWillChange, IObservableSetInitialValues, transaction, observable, IObservableFactory, CreateObservableOptions, computed, IComputedFactory, isObservable, isObservableProp, isComputed, isComputedProp, extendObservable, observe, intercept, autorun, IAutorunOptions, reaction, IReactionOptions, when, IWhenOptions, action, isAction, runInAction, IActionFactory, keys, values, entries, set, remove, has, get, configure, onBecomeObserved, onBecomeUnobserved, flow, isFlow, flowResult, FlowCancellationError, isFlowCancellationError, toJS, trace, IObserverTree, IDependencyTree, getDependencyTree, getObserverTree, resetGlobalState as _resetGlobalState, getGlobalState as _getGlobalState, getDebugName, getAtom, getAdministration as _getAdministration, allowStateChanges as _allowStateChanges, runInAction as _allowStateChangesInsideComputed, // This has become the default behavior in Mobx 6
+export { IObservable, IDepTreeNode, Reaction, IReactionPublic, IReactionDisposer, untracked, IAtom, createAtom, spy, IComputedValue, IEqualsComparer, comparer, IEnhancer, IInterceptable, IInterceptor, IListenable, IObjectWillChange, IObjectDidChange, isObservableObject, IValueDidChange, IValueWillChange, IObservableValue, isObservableValue as isBoxedObservable, IObservableArray, IArrayWillChange, IArrayWillSplice, IArraySplice, IArrayUpdate, IArrayDidChange, isObservableArray, IKeyValueMap, ObservableMap, IMapEntries, IMapEntry, IMapWillChange, IMapDidChange, isObservableMap, IObservableMapInitialValues, ObservableSet, isObservableSet, ISetDidChange, ISetWillChange, IObservableSetInitialValues, transaction, observable, IObservableFactory, CreateObservableOptions, computed, IComputedFactory, isObservable, isObservableProp, isComputed, isComputedProp, extendObservable, observe, intercept, autorun, IAutorunOptions, reaction, IReactionOptions, when, IWhenOptions, action, isAction, runInAction, IActionFactory, keys, values, entries, set, remove, has, get, apiOwnKeys as ownKeys, apiDefineProperty as defineProperty, configure, onBecomeObserved, onBecomeUnobserved, flow, isFlow, flowResult, FlowCancellationError, isFlowCancellationError, toJS, trace, IObserverTree, IDependencyTree, getDependencyTree, getObserverTree, resetGlobalState as _resetGlobalState, getGlobalState as _getGlobalState, getDebugName, getAtom, getAdministration as _getAdministration, allowStateChanges as _allowStateChanges, runInAction as _allowStateChangesInsideComputed, // This has become the default behavior in Mobx 6
 Lambda, $mobx, isComputingDerivation as _isComputingDerivation, onReactionError, interceptReads as _interceptReads, IComputedValueOptions, IActionRunInfo, _startAction, _endAction, allowStateReadsStart as _allowStateReadsStart, allowStateReadsEnd as _allowStateReadsEnd, makeObservable, makeAutoObservable, autoAction as _autoAction, AnnotationsMap, AnnotationMapEntry, override } from "./internal";

package/dist/mobx.esm.development.js

@@ -3,6 +3,18 @@ var niceErrors = {
   1: function _(annotationType, key) {
     return "Cannot apply '" + annotationType + "' to '" + key.toString() + "': Field not found.";
   },
+
+  /*
+  2(prop) {
+      return `invalid decorator for '${prop.toString()}'`
+  },
+  3(prop) {
+      return `Cannot decorate '${prop.toString()}': action can only be used on properties with a function value.`
+  },
+  4(prop) {
+      return `Cannot decorate '${prop.toString()}': computed can only be used on getter properties.`
+  },
+  */
   5: "'keys()' can only be used on observable objects, arrays, sets and maps",
   6: "'values()' can only be used on observable objects, arrays, sets and maps",
   7: "'entries()' can only be used on observable objects, arrays and maps",
@@ -59,7 +71,9 @@ var niceErrors = {
   36: "isolateGlobalState should be called before MobX is running any reactions",
   37: function _(method) {
     return "[mobx] `observableArray." + method + "()` mutates the array in-place, which is not allowed inside a derivation. Use `array.slice()." + method + "()` instead";
-  }
+  },
+  38: "'ownKeys()' can only be used on observable objects",
+  39: "'defineProperty()' can only be used on observable objects"
 };
 var errors =  niceErrors ;
 function die(error) {
@@ -496,7 +510,8 @@ function shallowComparer(a, b) {
 }
 
 function defaultComparer(a, b) {
-  return Object.is(a, b);
+  if (Object.is) return Object.is(a, b);
+  return a === b ? a !== 0 || 1 / a === 1 / b : a !== a && b !== b;
 }
 
 var comparer = {
@@ -694,6 +709,8 @@ function createFlowAnnotation(name, options) {
 }
 
 function make_$2(adm, key, descriptor, source) {
+  var _this$options_;
+
   // own
   if (source === adm.target_) {
     return this.extend_(adm, key, descriptor, false) === null ? 0
@@ -702,8 +719,15 @@ function make_$2(adm, key, descriptor, source) {
     /* Continue */
     ;
   } // prototype
+  // bound - must annotate protos to support super.flow()
 
 
+  if (((_this$options_ = this.options_) == null ? void 0 : _this$options_.bound) && !isFlow(adm.target_[key])) {
+    if (this.extend_(adm, key, descriptor, false) === null) return 0
+    /* Cancel */
+    ;
+  }
+
   if (isFlow(descriptor.value)) {
     // A prototype could have been annotated already by other constructor,
     // rest of the proto chain must be annotated already
@@ -712,7 +736,7 @@ function make_$2(adm, key, descriptor, source) {
     ;
   }
 
-  var flowDescriptor = createFlowDescriptor(adm, this, key, descriptor, false);
+  var flowDescriptor = createFlowDescriptor(adm, this, key, descriptor, false, false);
   defineProperty(source, key, flowDescriptor);
   return 2
   /* Continue */
@@ -720,7 +744,9 @@ function make_$2(adm, key, descriptor, source) {
 }
 
 function extend_$2(adm, key, descriptor, proxyTrap) {
-  var flowDescriptor = createFlowDescriptor(adm, this, key, descriptor);
+  var _this$options_2;
+
+  var flowDescriptor = createFlowDescriptor(adm, this, key, descriptor, (_this$options_2 = this.options_) == null ? void 0 : _this$options_2.bound);
   return adm.defineProperty_(key, flowDescriptor, proxyTrap);
 }
 
@@ -733,15 +759,23 @@ function assertFlowDescriptor(adm, _ref, key, _ref2) {
   }
 }
 
-function createFlowDescriptor(adm, annotation, key, descriptor, // provides ability to disable safeDescriptors for prototypes
+function createFlowDescriptor(adm, annotation, key, descriptor, bound, // provides ability to disable safeDescriptors for prototypes
 safeDescriptors) {
   if (safeDescriptors === void 0) {
     safeDescriptors = globalState.safeDescriptors;
   }
 
   assertFlowDescriptor(adm, annotation, key, descriptor);
+  var value = descriptor.value;
+
+  if (bound) {
+    var _adm$proxy_;
+
+    value = value.bind((_adm$proxy_ = adm.proxy_) != null ? _adm$proxy_ : adm.target_);
+  }
+
   return {
-    value: flow(descriptor.value),
+    value: flow(value),
     // Non-configurable for classes
     // prevents accidental field redefinition in subclass
     configurable: safeDescriptors ? adm.isPlainObject_ : true,
@@ -831,7 +865,7 @@ function createAutoAnnotation(options) {
 }
 
 function make_$5(adm, key, descriptor, source) {
-  var _this$options_2, _this$options_3;
+  var _this$options_3, _this$options_4;
 
   // getter -> computed
   if (descriptor.get) {
@@ -866,22 +900,25 @@ function make_$5(adm, key, descriptor, source) {
 
 
   if (source !== adm.target_ && typeof descriptor.value === "function") {
-    var _this$options_;
+    var _this$options_2;
 
     if (isGenerator(descriptor.value)) {
-      return flow.make_(adm, key, descriptor, source);
+      var _this$options_;
+
+      var flowAnnotation = ((_this$options_ = this.options_) == null ? void 0 : _this$options_.autoBind) ? flow.bound : flow;
+      return flowAnnotation.make_(adm, key, descriptor, source);
     }
 
-    var actionAnnotation = ((_this$options_ = this.options_) == null ? void 0 : _this$options_.autoBind) ? autoAction.bound : autoAction;
+    var actionAnnotation = ((_this$options_2 = this.options_) == null ? void 0 : _this$options_2.autoBind) ? autoAction.bound : autoAction;
     return actionAnnotation.make_(adm, key, descriptor, source);
   } // other -> observable
   // Copy props from proto as well, see test:
   // "decorate should work with Object.create"
 
 
-  var observableAnnotation = ((_this$options_2 = this.options_) == null ? void 0 : _this$options_2.deep) === false ? observable.ref : observable; // if function respect autoBind option
+  var observableAnnotation = ((_this$options_3 = this.options_) == null ? void 0 : _this$options_3.deep) === false ? observable.ref : observable; // if function respect autoBind option
 
-  if (typeof descriptor.value === "function" && ((_this$options_3 = this.options_) == null ? void 0 : _this$options_3.autoBind)) {
+  if (typeof descriptor.value === "function" && ((_this$options_4 = this.options_) == null ? void 0 : _this$options_4.autoBind)) {
     var _adm$proxy_;
 
     descriptor.value = descriptor.value.bind((_adm$proxy_ = adm.proxy_) != null ? _adm$proxy_ : adm.target_);
@@ -891,7 +928,7 @@ function make_$5(adm, key, descriptor, source) {
 }
 
 function extend_$5(adm, key, descriptor, proxyTrap) {
-  var _this$options_4, _this$options_5;
+  var _this$options_5, _this$options_6;
 
   // getter -> computed
   if (descriptor.get) {
@@ -909,16 +946,20 @@ function extend_$5(adm, key, descriptor, proxyTrap) {
   // if function respect autoBind option
 
 
-  if (typeof descriptor.value === "function" && ((_this$options_4 = this.options_) == null ? void 0 : _this$options_4.autoBind)) {
+  if (typeof descriptor.value === "function" && ((_this$options_5 = this.options_) == null ? void 0 : _this$options_5.autoBind)) {
     var _adm$proxy_2;
 
     descriptor.value = descriptor.value.bind((_adm$proxy_2 = adm.proxy_) != null ? _adm$proxy_2 : adm.target_);
   }
 
-  var observableAnnotation = ((_this$options_5 = this.options_) == null ? void 0 : _this$options_5.deep) === false ? observable.ref : observable;
+  var observableAnnotation = ((_this$options_6 = this.options_) == null ? void 0 : _this$options_6.deep) === false ? observable.ref : observable;
   return observableAnnotation.extend_(adm, key, descriptor, proxyTrap);
 }
 
+var OBSERVABLE = "observable";
+var OBSERVABLE_REF = "observable.ref";
+var OBSERVABLE_SHALLOW = "observable.shallow";
+var OBSERVABLE_STRUCT = "observable.struct"; // Predefined bags of create observable options, to avoid allocating temporarily option objects
 // in the majority of cases
 
 var defaultCreateObservableOptions = {
@@ -931,14 +972,14 @@ Object.freeze(defaultCreateObservableOptions);
 function asCreateObservableOptions(thing) {
   return thing || defaultCreateObservableOptions;
 }
-var observableAnnotation = /*#__PURE__*/createObservableAnnotation("observable");
-var observableRefAnnotation = /*#__PURE__*/createObservableAnnotation("observable.ref", {
+var observableAnnotation = /*#__PURE__*/createObservableAnnotation(OBSERVABLE);
+var observableRefAnnotation = /*#__PURE__*/createObservableAnnotation(OBSERVABLE_REF, {
   enhancer: referenceEnhancer
 });
-var observableShallowAnnotation = /*#__PURE__*/createObservableAnnotation("observable.shallow", {
+var observableShallowAnnotation = /*#__PURE__*/createObservableAnnotation(OBSERVABLE_SHALLOW, {
   enhancer: shallowEnhancer
 });
-var observableStructAnnotation = /*#__PURE__*/createObservableAnnotation("observable.struct", {
+var observableStructAnnotation = /*#__PURE__*/createObservableAnnotation(OBSERVABLE_STRUCT, {
   enhancer: refStructEnhancer
 });
 var observableDecoratorAnnotation = /*#__PURE__*/createDecoratorAnnotation(observableAnnotation);
@@ -1543,6 +1584,10 @@ var ComputedValue = /*#__PURE__*/function () {
     if (!this.keepAlive_) {
       clearObserving(this);
       this.value_ = undefined; // don't hold on to computed value!
+
+      if ( this.isTracing_ !== TraceMode.NONE) {
+        console.log("[mobx.trace] Computed value '" + this.name_ + "' was suspended and it will recompute on the next access.");
+      }
     }
   };
 
@@ -1575,16 +1620,12 @@ var ComputedValue = /*#__PURE__*/function () {
 
   _proto.warnAboutUntrackedRead_ = function warnAboutUntrackedRead_() {
 
-    if (this.requiresReaction_ === true) {
-      die("[mobx] Computed value " + this.name_ + " is read outside a reactive context");
-    }
-
     if (this.isTracing_ !== TraceMode.NONE) {
-      console.log("[mobx.trace] '" + this.name_ + "' is being read outside a reactive context. Doing a full recompute");
+      console.log("[mobx.trace] Computed value '" + this.name_ + "' is being read outside a reactive context. Doing a full recompute.");
     }
 
-    if (globalState.computedRequiresReaction) {
-      console.warn("[mobx] Computed value " + this.name_ + " is being read outside a reactive context. Doing a full recompute");
+    if (globalState.computedRequiresReaction || this.requiresReaction_) {
+      console.warn("[mobx] Computed value '" + this.name_ + "' is being read outside a reactive context. Doing a full recompute.");
     }
   };
 
@@ -1717,7 +1758,7 @@ function checkIfStateModificationsAreAllowed(atom) {
 }
 function checkIfStateReadsAreAllowed(observable) {
   if ( !globalState.allowStateReads && globalState.observableRequiresReaction) {
-    console.warn("[mobx] Observable " + observable.name_ + " being read outside a reactive context");
+    console.warn("[mobx] Observable '" + observable.name_ + "' being read outside a reactive context.");
   }
 }
 /**
@@ -1761,7 +1802,7 @@ function warnAboutDerivationWithoutDependencies(derivation) {
   if (derivation.observing_.length !== 0) return;
 
   if (globalState.reactionRequiresObservable || derivation.requiresObservable_) {
-    console.warn("[mobx] Derivation " + derivation.name_ + " is created/updated without reading any observable value");
+    console.warn("[mobx] Derivation '" + derivation.name_ + "' is created/updated without reading any observable value.");
   }
 }
 /**
@@ -2781,6 +2822,9 @@ function isFlowCancellationError(error) {
   return error instanceof FlowCancellationError;
 }
 var flowAnnotation = /*#__PURE__*/createFlowAnnotation("flow");
+var flowBoundAnnotation = /*#__PURE__*/createFlowAnnotation("flow.bound", {
+  bound: true
+});
 var flow = /*#__PURE__*/Object.assign(function flow(arg1, arg2) {
   // @flow
   if (isStringish(arg2)) {
@@ -2866,6 +2910,7 @@ var flow = /*#__PURE__*/Object.assign(function flow(arg1, arg2) {
   res.isMobXFlow = true;
   return res;
 }, flowAnnotation);
+flow.bound = /*#__PURE__*/createDecoratorAnnotation(flowBoundAnnotation);
 
 function cancelPromise(promise) {
   if (isFunction(promise.cancel)) promise.cancel();
@@ -3090,6 +3135,20 @@ function get(obj, key) {
 
   die(11);
 }
+function apiDefineProperty(obj, key, descriptor) {
+  if (isObservableObject(obj)) {
+    return obj[$mobx].defineProperty_(key, descriptor);
+  }
+
+  die(39);
+}
+function apiOwnKeys(obj) {
+  if (isObservableObject(obj)) {
+    return obj[$mobx].ownKeys_();
+  }
+
+  die(38);
+}
 
 function observe(thing, propOrCb, cbOrFire, fireImmediately) {
   if (isFunction(cbOrFire)) return observeObservableProperty(thing, propOrCb, cbOrFire, fireImmediately);else return observeObservable(thing, propOrCb, cbOrFire);
@@ -3110,7 +3169,7 @@ function cache(map, key, value) {
 
 function toJSHelper(source, __alreadySeen) {
   if (source == null || typeof source !== "object" || source instanceof Date || !isObservable(source)) return source;
-  if (isObservableValue(source)) return toJSHelper(source.get(), __alreadySeen);
+  if (isObservableValue(source) || isComputedValue(source)) return toJSHelper(source.get(), __alreadySeen);
 
   if (__alreadySeen.has(source)) {
     return __alreadySeen.get(source);
@@ -3144,7 +3203,7 @@ function toJSHelper(source, __alreadySeen) {
     // must be observable object
     var _res3 = cache(__alreadySeen, source, {});
 
-    source[$mobx].ownKeys_().forEach(function (key) {
+    apiOwnKeys(source).forEach(function (key) {
       if (objectPrototype.propertyIsEnumerable.call(source, key)) {
         _res3[key] = toJSHelper(source[key], __alreadySeen);
       }
@@ -3227,10 +3286,10 @@ function _when(predicate, effect, opts) {
   var timeoutHandle;
 
   if (typeof opts.timeout === "number") {
+    var error = new Error("WHEN_TIMEOUT");
     timeoutHandle = setTimeout(function () {
       if (!disposer[$mobx].isDisposed_) {
         disposer();
-        var error = new Error("WHEN_TIMEOUT");
         if (opts.onError) opts.onError(error);else throw error;
       }
     }, opts.timeout);
@@ -3317,7 +3376,7 @@ var objectProxyTraps = {
     return (_getAdm$definePropert = getAdm(target).defineProperty_(name, descriptor)) != null ? _getAdm$definePropert : true;
   },
   ownKeys: function ownKeys(target) {
-    if ( globalState.trackingDerivation) warnAboutProxyRequirement("iterate keys to detect added / removed properties. Use `keys` from 'mobx' instead.");
+    if ( globalState.trackingDerivation) warnAboutProxyRequirement("iterate keys to detect added / removed properties. Use 'keys' from 'mobx' instead.");
     return getAdm(target).ownKeys_();
   },
   preventExtensions: function preventExtensions(target) {
@@ -5680,7 +5739,7 @@ function isAnnotation(thing) {
  * - utils/   Utility stuff.
  *
  */
-["Symbol", "Map", "Set", "Symbol"].forEach(function (m) {
+["Symbol", "Map", "Set"].forEach(function (m) {
   var g = getGlobal();
 
   if (typeof g[m] === "undefined") {
@@ -5699,5 +5758,5 @@ if (typeof __MOBX_DEVTOOLS_GLOBAL_HOOK__ === "object") {
   });
 }
 
-export { $mobx, FlowCancellationError, ObservableMap, ObservableSet, Reaction, allowStateChanges as _allowStateChanges, runInAction as _allowStateChangesInsideComputed, allowStateReadsEnd as _allowStateReadsEnd, allowStateReadsStart as _allowStateReadsStart, autoAction as _autoAction, _endAction, getAdministration as _getAdministration, getGlobalState as _getGlobalState, interceptReads as _interceptReads, isComputingDerivation as _isComputingDerivation, resetGlobalState as _resetGlobalState, _startAction, action, autorun, comparer, computed, configure, createAtom, entries, extendObservable, flow, flowResult, get, getAtom, getDebugName, getDependencyTree, getObserverTree, has, intercept, isAction, isObservableValue as isBoxedObservable, isComputed, isComputedProp, isFlow, isFlowCancellationError, isObservable, isObservableArray, isObservableMap, isObservableObject, isObservableProp, isObservableSet, keys, makeAutoObservable, makeObservable, observable, observe, onBecomeObserved, onBecomeUnobserved, onReactionError, override, reaction, remove, runInAction, set, spy, toJS, trace, transaction, untracked, values, when };
+export { $mobx, FlowCancellationError, ObservableMap, ObservableSet, Reaction, allowStateChanges as _allowStateChanges, runInAction as _allowStateChangesInsideComputed, allowStateReadsEnd as _allowStateReadsEnd, allowStateReadsStart as _allowStateReadsStart, autoAction as _autoAction, _endAction, getAdministration as _getAdministration, getGlobalState as _getGlobalState, interceptReads as _interceptReads, isComputingDerivation as _isComputingDerivation, resetGlobalState as _resetGlobalState, _startAction, action, autorun, comparer, computed, configure, createAtom, apiDefineProperty as defineProperty, entries, extendObservable, flow, flowResult, get, getAtom, getDebugName, getDependencyTree, getObserverTree, has, intercept, isAction, isObservableValue as isBoxedObservable, isComputed, isComputedProp, isFlow, isFlowCancellationError, isObservable, isObservableArray, isObservableMap, isObservableObject, isObservableProp, isObservableSet, keys, makeAutoObservable, makeObservable, observable, observe, onBecomeObserved, onBecomeUnobserved, onReactionError, override, apiOwnKeys as ownKeys, reaction, remove, runInAction, set, spy, toJS, trace, transaction, untracked, values, when };
 //# sourceMappingURL=mobx.esm.development.js.map