mobx 5.13.1 → 5.14.0

package/CHANGELOG.md

@@ -1,4 +1,9 @@
-# 5.13.1 / 4.13.1 (TO BE RELEASED)
+# 5.14.0 / 4.14.0
+
+* Added experimental `reactionRequiresObservable` & `observableRequiresReaction` config [#2079](https://github.com/mobxjs/mobx/pull/2079), [Docs](https://github.com/mobxjs/mobx/pull/2082)
+* Added experimental `requiresObservable` config to `reaction`, `autorun` & `when` options [#2079](https://github.com/mobxjs/mobx/pull/2079), [Docs](https://github.com/mobxjs/mobx/pull/2082)
+
+# 5.13.1 / 4.13.1
 
 * Don't use `global` and `self` keywords unless defined. Fixes [#2070](https://github.com/mobxjs/mobx/issues/2070).
 * onBecome(Un)Observed didn't trigger when using number as key of observable map. Fixes [#2067](https://github.com/mobxjs/mobx/issues/2067).

package/lib/api/autorun.d.ts

@@ -2,6 +2,11 @@ import { IEqualsComparer, IReactionDisposer, IReactionPublic } from "../internal
 export interface IAutorunOptions {
     delay?: number;
     name?: string;
+    /**
+     * Experimental.
+     * Warns if the view doesn't track observables
+     */
+    requiresObservable?: boolean;
     scheduler?: (callback: () => void) => any;
     onError?: (error: any) => void;
 }

package/lib/api/configure.d.ts

@@ -1,6 +1,16 @@
 export declare function configure(options: {
     enforceActions?: boolean | "strict" | "never" | "always" | "observed";
     computedRequiresReaction?: boolean;
+    /**
+     * (Experimental)
+     * Warn if you try to create to derivation / reactive context without accessing any observable.
+     */
+    reactionRequiresObservable?: boolean;
+    /**
+     * (Experimental)
+     * Warn if observables are accessed outside a reactive context
+     */
+    observableRequiresReaction?: boolean;
     computedConfigurable?: boolean;
     isolateGlobalState?: boolean;
     disableErrorBoundaries?: boolean;

package/lib/api/when.d.ts

@@ -2,6 +2,11 @@ import { IReactionDisposer, Lambda } from "../internal";
 export interface IWhenOptions {
     name?: string;
     timeout?: number;
+    /**
+     * Experimental.
+     * Warns if the view doesn't track observables
+     */
+    requiresObservable?: boolean;
     onError?: (error: any) => void;
 }
 export declare function when(predicate: () => boolean, opts?: IWhenOptions): Promise<void> & {

package/lib/core/action.d.ts

@@ -7,6 +7,7 @@ export declare function executeAction(actionName: string, fn: Function, scope?:
 export interface IActionRunInfo {
     prevDerivation: IDerivation | null;
     prevAllowStateChanges: boolean;
+    prevAllowStateReads: boolean;
     notifySpy: boolean;
     startTime: number;
     error?: any;

package/lib/core/derivation.d.ts

@@ -30,6 +30,10 @@ export interface IDerivation extends IDepTreeNode {
     __mapid: string;
     onBecomeStale(): void;
     isTracing: TraceMode;
+    /**
+     *  warn if the derivation has no dependencies after creation/update
+     */
+    requiresObservable?: boolean;
 }
 export declare class CaughtException {
     cause: any;
@@ -50,6 +54,7 @@ export declare function isCaughtException(e: any): e is CaughtException;
 export declare function shouldCompute(derivation: IDerivation): boolean;
 export declare function isComputingDerivation(): boolean;
 export declare function checkIfStateModificationsAreAllowed(atom: IAtom): void;
+export declare function checkIfStateReadsAreAllowed(observable: IObservable): void;
 /**
  * Executes the provided function `f` and tracks which observables are being accessed.
  * The tracking information is stored on the `derivation` object and the derivation is registered
@@ -60,6 +65,8 @@ export declare function clearObserving(derivation: IDerivation): void;
 export declare function untracked<T>(action: () => T): T;
 export declare function untrackedStart(): IDerivation | null;
 export declare function untrackedEnd(prev: IDerivation | null): void;
+export declare function allowStateReadsStart(allowStateReads: boolean): boolean;
+export declare function allowStateReadsEnd(prev: boolean): void;
 /**
  * needed to keep `lowestObserverState` correct. when changing from (2 or 1) to 0
  *

package/lib/core/globalstate.d.ts

@@ -55,6 +55,11 @@ export declare class MobXGlobals {
      * To ensure that those functions stay pure.
      */
     allowStateChanges: boolean;
+    /**
+     * Is it allowed to read observables at this point?
+     * Used to hold the state needed for `observableRequiresReaction`
+     */
+    allowStateReads: boolean;
     /**
      * If strict mode is enabled, state changes are by default not allowed
      */
@@ -73,6 +78,16 @@ export declare class MobXGlobals {
      * Warn if computed values are accessed outside a reactive context
      */
     computedRequiresReaction: boolean;
+    /**
+     * (Experimental)
+     * Warn if you try to create to derivation / reactive context without accessing any observable.
+     */
+    reactionRequiresObservable: boolean;
+    /**
+     * (Experimental)
+     * Warn if observables are accessed outside a reactive context
+     */
+    observableRequiresReaction: boolean;
     /**
      * Allows overwriting of computed properties, useful in tests but not prod as it can cause
      * memory leaks. See https://github.com/mobxjs/mobx/issues/1867

package/lib/core/reaction.d.ts

@@ -29,6 +29,7 @@ export declare class Reaction implements IDerivation, IReactionPublic {
     name: string;
     private onInvalidate;
     private errorHandler?;
+    requiresObservable: boolean;
     observing: IObservable[];
     newObserving: IObservable[];
     dependenciesState: IDerivationState;
@@ -41,7 +42,7 @@ export declare class Reaction implements IDerivation, IReactionPublic {
     _isTrackPending: boolean;
     _isRunning: boolean;
     isTracing: TraceMode;
-    constructor(name: string, onInvalidate: () => void, errorHandler?: ((error: any, derivation: IDerivation) => void) | undefined);
+    constructor(name: string, onInvalidate: () => void, errorHandler?: ((error: any, derivation: IDerivation) => void) | undefined, requiresObservable?: boolean);
     onBecomeStale(): void;
     schedule(): void;
     isScheduled(): boolean;