@ngxs/store 3.7.6-dev.master-7c829a7 → 3.7.6-dev.master-fb318b1

package/fesm5/ngxs-store.js

@@ -2563,6 +2563,175 @@ function ensureStateClassIsInjectable(stateClass) {
     }
 }
 
+/**
+ * @fileoverview added by tsickle
+ * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
+ */
+/**
+ * Init action
+ */
+var  /**
+ * Init action
+ */
+InitState = /** @class */ (function () {
+    function InitState() {
+    }
+    Object.defineProperty(InitState, "type", {
+        get: /**
+         * @return {?}
+         */
+        function () {
+            // NOTE: Not necessary to declare the type in this way in your code. See https://github.com/ngxs/store/pull/644#issuecomment-436003138
+            return '@@INIT';
+        },
+        enumerable: true,
+        configurable: true
+    });
+    return InitState;
+}());
+/**
+ * Update action
+ */
+var  /**
+ * Update action
+ */
+UpdateState = /** @class */ (function () {
+    function UpdateState(addedStates) {
+        this.addedStates = addedStates;
+    }
+    Object.defineProperty(UpdateState, "type", {
+        get: /**
+         * @return {?}
+         */
+        function () {
+            // NOTE: Not necessary to declare the type in this way in your code. See https://github.com/ngxs/store/pull/644#issuecomment-436003138
+            return '@@UPDATE_STATE';
+        },
+        enumerable: true,
+        configurable: true
+    });
+    return UpdateState;
+}());
+if (false) {
+    /** @type {?} */
+    UpdateState.prototype.addedStates;
+}
+
+/**
+ * @fileoverview added by tsickle
+ * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
+ */
+/**
+ * @record
+ */
+function NgxsDevelopmentOptions() { }
+if (false) {
+    /** @type {?} */
+    NgxsDevelopmentOptions.prototype.warnOnUnhandledActions;
+}
+/** @type {?} */
+var NGXS_DEVELOPMENT_OPTIONS = new InjectionToken('NGXS_DEVELOPMENT_OPTIONS', {
+    providedIn: 'root',
+    factory: (/**
+     * @return {?}
+     */
+    function () { return ({ warnOnUnhandledActions: true }); })
+});
+
+/**
+ * @fileoverview added by tsickle
+ * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
+ */
+var NgxsUnhandledActionsLogger = /** @class */ (function () {
+    function NgxsUnhandledActionsLogger(options) {
+        /**
+         * These actions should be ignored by default; the user can increase this
+         * list in the future via the `ignoreActions` method.
+         */
+        this._ignoredActions = new Set([InitState.type, UpdateState.type]);
+        if (typeof options.warnOnUnhandledActions === 'object') {
+            this.ignoreActions.apply(this, __spread(options.warnOnUnhandledActions.ignore));
+        }
+    }
+    /**
+     * Adds actions to the internal list of actions that should be ignored.
+     */
+    /**
+     * Adds actions to the internal list of actions that should be ignored.
+     * @param {...?} actions
+     * @return {?}
+     */
+    NgxsUnhandledActionsLogger.prototype.ignoreActions = /**
+     * Adds actions to the internal list of actions that should be ignored.
+     * @param {...?} actions
+     * @return {?}
+     */
+    function () {
+        var actions = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            actions[_i] = arguments[_i];
+        }
+        var e_1, _a;
+        try {
+            for (var actions_1 = __values(actions), actions_1_1 = actions_1.next(); !actions_1_1.done; actions_1_1 = actions_1.next()) {
+                var action = actions_1_1.value;
+                this._ignoredActions.add(action.type);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (actions_1_1 && !actions_1_1.done && (_a = actions_1.return)) _a.call(actions_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    };
+    /** @internal */
+    /**
+     * \@internal
+     * @param {?} action
+     * @return {?}
+     */
+    NgxsUnhandledActionsLogger.prototype.warn = /**
+     * \@internal
+     * @param {?} action
+     * @return {?}
+     */
+    function (action) {
+        /** @type {?} */
+        var actionShouldBeIgnored = Array.from(this._ignoredActions).some((/**
+         * @param {?} type
+         * @return {?}
+         */
+        function (type) { return type === getActionTypeFromInstance(action); }));
+        if (actionShouldBeIgnored) {
+            return;
+        }
+        action =
+            action.constructor && action.constructor.name !== 'Object'
+                ? action.constructor.name
+                : action.type;
+        console.warn("The " + action + " action has been dispatched but hasn't been handled. This may happen if the state with an action handler for this action is not registered.");
+    };
+    NgxsUnhandledActionsLogger.decorators = [
+        { type: Injectable }
+    ];
+    /** @nocollapse */
+    NgxsUnhandledActionsLogger.ctorParameters = function () { return [
+        { type: undefined, decorators: [{ type: Inject, args: [NGXS_DEVELOPMENT_OPTIONS,] }] }
+    ]; };
+    return NgxsUnhandledActionsLogger;
+}());
+if (false) {
+    /**
+     * These actions should be ignored by default; the user can increase this
+     * list in the future via the `ignoreActions` method.
+     * @type {?}
+     * @private
+     */
+    NgxsUnhandledActionsLogger.prototype._ignoredActions;
+}
+
 /**
  * @fileoverview added by tsickle
  * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
@@ -2708,10 +2877,8 @@ var StateFactory = /** @class */ (function () {
      * @return {?}
      */
     function () {
-        // I'm using non-null assertion here since `_actionsSubscrition` will
-        // be 100% defined. This is because `ngOnDestroy()` cannot be invoked
-        // on the `StateFactory` until its initialized :) An it's initialized
-        // for the first time along with the `NgxsRootModule`.
+        // This is being non-null asserted since `_actionsSubscrition` is
+        // initialized within the constructor.
         (/** @type {?} */ (this._actionsSubscription)).unsubscribe();
     };
     /**
@@ -2888,6 +3055,10 @@ var StateFactory = /** @class */ (function () {
         var type = (/** @type {?} */ (getActionTypeFromInstance(action)));
         /** @type {?} */
         var results = [];
+        // Determines whether the dispatched action has been handled, this is assigned
+        // to `true` within the below `for` loop if any `actionMetas` has been found.
+        /** @type {?} */
+        var actionHasBeenHandled = false;
         try {
             for (var _c = __values(this.states), _d = _c.next(); !_d.done; _d = _c.next()) {
                 var metadata = _d.value;
@@ -2940,6 +3111,7 @@ var StateFactory = /** @class */ (function () {
                             catch (e) {
                                 results.push(throwError(e));
                             }
+                            actionHasBeenHandled = true;
                         }
                     }
                     catch (e_3_1) { e_3 = { error: e_3_1 }; }
@@ -2959,6 +3131,18 @@ var StateFactory = /** @class */ (function () {
             }
             finally { if (e_2) throw e_2.error; }
         }
+        // The `NgxsUnhandledActionsLogger` is a tree-shakable class which functions
+        // only during development.
+        if ((typeof ngDevMode === 'undefined' || ngDevMode) && !actionHasBeenHandled) {
+            /** @type {?} */
+            var unhandledActionsLogger = this._injector.get(NgxsUnhandledActionsLogger, null);
+            // The `NgxsUnhandledActionsLogger` will not be resolved by the injector if the
+            // `NgxsDevelopmentModule` is not provided. It's enough to check whether the `injector.get`
+            // didn't return `null` so we may ensure the module has been imported.
+            if (unhandledActionsLogger) {
+                unhandledActionsLogger.warn(action);
+            }
+        }
         if (!results.length) {
             results.push(of({}));
         }
@@ -3839,60 +4023,6 @@ if (false) {
     SelectFactory.config;
 }
 
-/**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
-/**
- * Init action
- */
-var  /**
- * Init action
- */
-InitState = /** @class */ (function () {
-    function InitState() {
-    }
-    Object.defineProperty(InitState, "type", {
-        get: /**
-         * @return {?}
-         */
-        function () {
-            // NOTE: Not necessary to declare the type in this way in your code. See https://github.com/ngxs/store/pull/644#issuecomment-436003138
-            return '@@INIT';
-        },
-        enumerable: true,
-        configurable: true
-    });
-    return InitState;
-}());
-/**
- * Update action
- */
-var  /**
- * Update action
- */
-UpdateState = /** @class */ (function () {
-    function UpdateState(addedStates) {
-        this.addedStates = addedStates;
-    }
-    Object.defineProperty(UpdateState, "type", {
-        get: /**
-         * @return {?}
-         */
-        function () {
-            // NOTE: Not necessary to declare the type in this way in your code. See https://github.com/ngxs/store/pull/644#issuecomment-436003138
-            return '@@UPDATE_STATE';
-        },
-        enumerable: true,
-        configurable: true
-    });
-    return UpdateState;
-}());
-if (false) {
-    /** @type {?} */
-    UpdateState.prototype.addedStates;
-}
-
 /**
  * @fileoverview added by tsickle
  * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
@@ -4599,6 +4729,36 @@ if (false) {
     StateToken.prototype.name;
 }
 
+/**
+ * @fileoverview added by tsickle
+ * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
+ */
+var NgxsDevelopmentModule = /** @class */ (function () {
+    function NgxsDevelopmentModule() {
+    }
+    /**
+     * @param {?} options
+     * @return {?}
+     */
+    NgxsDevelopmentModule.forRoot = /**
+     * @param {?} options
+     * @return {?}
+     */
+    function (options) {
+        return {
+            ngModule: NgxsDevelopmentModule,
+            providers: [
+                NgxsUnhandledActionsLogger,
+                { provide: NGXS_DEVELOPMENT_OPTIONS, useValue: options }
+            ]
+        };
+    };
+    NgxsDevelopmentModule.decorators = [
+        { type: NgModule }
+    ];
+    return NgxsDevelopmentModule;
+}());
+
 /**
  * @fileoverview added by tsickle
  * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
@@ -4619,5 +4779,5 @@ if (false) {
  * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
  */
 
-export { Action, Actions, InitState, NGXS_PLUGINS, NgxsModule, NgxsSimpleChange, NoopNgxsExecutionStrategy, Select, Selector, SelectorOptions, State, StateStream, StateToken, Store, UpdateState, actionMatcher, createSelector, ensureSelectorMetadata$1 as ensureSelectorMetadata, ensureStoreMetadata$1 as ensureStoreMetadata, getActionTypeFromInstance, getSelectorMetadata$1 as getSelectorMetadata, getStoreMetadata$1 as getStoreMetadata, getValue, ofAction, ofActionCanceled, ofActionCompleted, ofActionDispatched, ofActionErrored, ofActionSuccessful, setValue, OrderedSubject as ɵa, InternalActions as ɵb, ROOT_STATE_TOKEN as ɵc, FEATURE_STATE_TOKEN as ɵd, SELECTOR_META_KEY as ɵe, NgxsConfig as ɵf, mergeDeep as ɵg, USER_PROVIDED_NGXS_EXECUTION_STRATEGY as ɵh, NGXS_EXECUTION_STRATEGY as ɵi, NgxsRootModule as ɵj, StateFactory as ɵk, InternalDispatchedActionResults as ɵl, InternalDispatcher as ɵm, StateContextFactory as ɵn, InternalStateOperations as ɵo, PluginManager as ɵp, InternalNgxsExecutionStrategy as ɵq, InternalErrorReporter as ɵr, SelectFactory as ɵs, ensureStoreMetadata as ɵu, getStoreMetadata as ɵv, ensureSelectorMetadata as ɵw, getSelectorMetadata as ɵx, LifecycleStateManager as ɵy, NgxsFeatureModule as ɵz };
+export { Action, Actions, InitState, NGXS_PLUGINS, NgxsDevelopmentModule, NgxsModule, NgxsSimpleChange, NgxsUnhandledActionsLogger, NoopNgxsExecutionStrategy, Select, Selector, SelectorOptions, State, StateStream, StateToken, Store, UpdateState, actionMatcher, createSelector, ensureSelectorMetadata$1 as ensureSelectorMetadata, ensureStoreMetadata$1 as ensureStoreMetadata, getActionTypeFromInstance, getSelectorMetadata$1 as getSelectorMetadata, getStoreMetadata$1 as getStoreMetadata, getValue, ofAction, ofActionCanceled, ofActionCompleted, ofActionDispatched, ofActionErrored, ofActionSuccessful, setValue, OrderedSubject as ɵa, InternalActions as ɵb, NgxsFeatureModule as ɵba, ROOT_STATE_TOKEN as ɵc, FEATURE_STATE_TOKEN as ɵd, SELECTOR_META_KEY as ɵe, NgxsConfig as ɵf, mergeDeep as ɵg, USER_PROVIDED_NGXS_EXECUTION_STRATEGY as ɵh, NGXS_EXECUTION_STRATEGY as ɵi, NGXS_DEVELOPMENT_OPTIONS as ɵj, NgxsRootModule as ɵk, StateFactory as ɵl, InternalDispatchedActionResults as ɵm, InternalDispatcher as ɵn, StateContextFactory as ɵo, InternalStateOperations as ɵp, PluginManager as ɵq, InternalNgxsExecutionStrategy as ɵr, InternalErrorReporter as ɵs, SelectFactory as ɵt, ensureStoreMetadata as ɵv, getStoreMetadata as ɵw, ensureSelectorMetadata as ɵx, getSelectorMetadata as ɵy, LifecycleStateManager as ɵz };
 //# sourceMappingURL=ngxs-store.js.map