@ngxs/router-plugin 3.7.5 → 3.7.6-dev.master-a585f14

package/fesm5/ngxs-router-plugin.js

@@ -1,4 +1,4 @@
-import { NgZone, Injectable, NgModule } from '@angular/core';
+import { InjectionToken, NgZone, Injector, Injectable, NgModule } from '@angular/core';
 import { Store, Action, Selector, State, NgxsModule } from '@ngxs/store';
 import { __assign, __decorate, __metadata } from 'tslib';
 import { NavigationStart, RoutesRecognized, ResolveEnd, NavigationCancel, NavigationError, NavigationEnd, Router } from '@angular/router';
@@ -47,7 +47,7 @@ if (false) {
  *
  */
 /**
- * An action dispatched when the router navigates.
+ * An action dispatched when the router starts the navigation.
  * @template T
  */
 var  /**
@@ -56,6 +56,42 @@ var  /**
  *
  */
 /**
+ * An action dispatched when the router starts the navigation.
+ * @template T
+ */
+RouterRequest = /** @class */ (function () {
+    function RouterRequest(routerState, event, trigger) {
+        if (trigger === void 0) { trigger = 'none'; }
+        this.routerState = routerState;
+        this.event = event;
+        this.trigger = trigger;
+    }
+    Object.defineProperty(RouterRequest, "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 '[Router] RouterRequest';
+        },
+        enumerable: true,
+        configurable: true
+    });
+    return RouterRequest;
+}());
+if (false) {
+    /** @type {?} */
+    RouterRequest.prototype.routerState;
+    /** @type {?} */
+    RouterRequest.prototype.event;
+    /** @type {?} */
+    RouterRequest.prototype.trigger;
+}
+/**
+ * An action dispatched when the router navigates.
+ * @template T
+ */
+var  /**
  * An action dispatched when the router navigates.
  * @template T
  */
@@ -201,6 +237,42 @@ if (false) {
     /** @type {?} */
     RouterDataResolved.prototype.trigger;
 }
+/**
+ * An action dispatched when the router navigation has been finished successfully.
+ * @template T
+ */
+var  /**
+ * An action dispatched when the router navigation has been finished successfully.
+ * @template T
+ */
+RouterNavigated = /** @class */ (function () {
+    function RouterNavigated(routerState, event, trigger) {
+        if (trigger === void 0) { trigger = 'none'; }
+        this.routerState = routerState;
+        this.event = event;
+        this.trigger = trigger;
+    }
+    Object.defineProperty(RouterNavigated, "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 '[Router] RouterNavigated';
+        },
+        enumerable: true,
+        configurable: true
+    });
+    return RouterNavigated;
+}());
+if (false) {
+    /** @type {?} */
+    RouterNavigated.prototype.routerState;
+    /** @type {?} */
+    RouterNavigated.prototype.event;
+    /** @type {?} */
+    RouterNavigated.prototype.trigger;
+}
 
 /**
  * @fileoverview added by tsickle
@@ -294,6 +366,43 @@ var DefaultRouterStateSerializer = /** @class */ (function () {
     return DefaultRouterStateSerializer;
 }());
 
+/**
+ * @fileoverview added by tsickle
+ * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
+ */
+/** @enum {number} */
+var NavigationActionTiming = {
+    PreActivation: 1,
+    PostActivation: 2,
+};
+/**
+ * @record
+ */
+function NgxsRouterPluginOptions() { }
+if (false) {
+    /** @type {?|undefined} */
+    NgxsRouterPluginOptions.prototype.navigationActionTiming;
+}
+/** @type {?} */
+var USER_OPTIONS = new InjectionToken('USER_OPTIONS', { providedIn: 'root', factory: (/**
+     * @return {?}
+     */
+    function () { return undefined; }) });
+/** @type {?} */
+var NGXS_ROUTER_PLUGIN_OPTIONS = new InjectionToken('NGXS_ROUTER_PLUGIN_OPTIONS', { providedIn: 'root', factory: (/**
+     * @return {?}
+     */
+    function () { return ({}); }) });
+/**
+ * @param {?} options
+ * @return {?}
+ */
+function createRouterPluginOptions(options) {
+    return {
+        navigationActionTiming: (options && options.navigationActionTiming) || 1 /* PreActivation */
+    };
+}
+
 /**
  * @fileoverview added by tsickle
  * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
@@ -312,7 +421,7 @@ if (false) {
     RouterStateModel.prototype.trigger;
 }
 var RouterState = /** @class */ (function () {
-    function RouterState(_store, _router, _serializer, _ngZone) {
+    function RouterState(_store, _router, _serializer, _ngZone, injector) {
         this._store = _store;
         this._router = _router;
         this._serializer = _serializer;
@@ -330,10 +439,14 @@ var RouterState = /** @class */ (function () {
          * That's the value of the `RouterState` state
          */
         this._storeState = null;
-        this._lastRoutesRecognized = (/** @type {?} */ (null));
+        this._lastEvent = null;
         this._subscription = new Subscription();
-        this.setUpStoreListener();
-        this.setUpRouterEventsListener();
+        this._options = null;
+        // Note: do not use `@Inject` since it fails on lower versions of Angular with Jest
+        // integration, it cannot resolve the token provider.
+        this._options = injector.get(NGXS_ROUTER_PLUGIN_OPTIONS, null);
+        this._setUpStoreListener();
+        this._setUpRouterEventsListener();
     }
     RouterState_1 = RouterState;
     /**
@@ -399,13 +512,17 @@ var RouterState = /** @class */ (function () {
      * @return {?}
      */
     function (ctx, action) {
-        ctx.setState(__assign({}, ctx.getState(), { trigger: action.trigger, state: action.routerState, navigationId: action.event.id }));
+        ctx.setState({
+            trigger: action.trigger,
+            state: action.routerState,
+            navigationId: action.event.id
+        });
     };
     /**
      * @private
      * @return {?}
      */
-    RouterState.prototype.setUpStoreListener = /**
+    RouterState.prototype._setUpStoreListener = /**
      * @private
      * @return {?}
      */
@@ -419,160 +536,201 @@ var RouterState = /** @class */ (function () {
          * @return {?}
          */
         function (state) {
-            _this.navigateIfNeeded(state);
+            _this._navigateIfNeeded(state);
         }));
         this._subscription.add(subscription);
     };
+    /**
+     * @private
+     * @param {?} routerState
+     * @return {?}
+     */
+    RouterState.prototype._navigateIfNeeded = /**
+     * @private
+     * @param {?} routerState
+     * @return {?}
+     */
+    function (routerState) {
+        var _this = this;
+        if (routerState && routerState.trigger === 'devtools') {
+            this._storeState = this._store.selectSnapshot(RouterState_1);
+        }
+        /** @type {?} */
+        var canSkipNavigation = !this._storeState ||
+            !this._storeState.state ||
+            !routerState ||
+            routerState.trigger === 'router' ||
+            this._router.url === this._storeState.state.url ||
+            this._lastEvent instanceof NavigationStart;
+        if (canSkipNavigation) {
+            return;
+        }
+        this._storeState = this._store.selectSnapshot(RouterState_1);
+        this._trigger = 'store';
+        this._ngZone.run((/**
+         * @return {?}
+         */
+        function () { return _this._router.navigateByUrl((/** @type {?} */ ((/** @type {?} */ (_this._storeState)).state)).url); }));
+    };
     /**
      * @private
      * @return {?}
      */
-    RouterState.prototype.setUpRouterEventsListener = /**
+    RouterState.prototype._setUpRouterEventsListener = /**
      * @private
      * @return {?}
      */
     function () {
         var _this = this;
         /** @type {?} */
+        var dispatchRouterNavigationLate = this._options != null &&
+            this._options.navigationActionTiming === 2 /* PostActivation */;
+        /** @type {?} */
+        var lastRoutesRecognized;
+        /** @type {?} */
         var subscription = this._router.events.subscribe((/**
          * @param {?} event
          * @return {?}
          */
         function (event) {
+            _this._lastEvent = event;
             if (event instanceof NavigationStart) {
-                _this.navigationStart();
+                _this._navigationStart(event);
             }
             else if (event instanceof RoutesRecognized) {
-                _this._lastRoutesRecognized = event;
+                lastRoutesRecognized = event;
+                if (!dispatchRouterNavigationLate && _this._trigger !== 'store') {
+                    _this._dispatchRouterNavigation(lastRoutesRecognized);
+                }
             }
             else if (event instanceof ResolveEnd) {
-                _this.dispatchRouterDataResolved(event);
+                _this._dispatchRouterDataResolved(event);
             }
             else if (event instanceof NavigationCancel) {
-                _this.dispatchRouterCancel(event);
-                _this.reset();
+                _this._dispatchRouterCancel(event);
+                _this._reset();
             }
             else if (event instanceof NavigationError) {
-                _this.dispatchRouterError(event);
-                _this.reset();
+                _this._dispatchRouterError(event);
+                _this._reset();
             }
             else if (event instanceof NavigationEnd) {
-                _this.navigationEnd();
-                _this.reset();
+                if (_this._trigger !== 'store') {
+                    if (dispatchRouterNavigationLate) {
+                        _this._dispatchRouterNavigation(lastRoutesRecognized);
+                    }
+                    _this._dispatchRouterNavigated(event);
+                }
+                _this._reset();
             }
         }));
         this._subscription.add(subscription);
     };
+    /** Reacts to `NavigationStart`. */
     /**
+     * Reacts to `NavigationStart`.
      * @private
+     * @param {?} event
      * @return {?}
      */
-    RouterState.prototype.navigationStart = /**
+    RouterState.prototype._navigationStart = /**
+     * Reacts to `NavigationStart`.
      * @private
+     * @param {?} event
      * @return {?}
      */
-    function () {
+    function (event) {
         this._routerState = this._serializer.serialize(this._router.routerState.snapshot);
         if (this._trigger !== 'none') {
             this._storeState = this._store.selectSnapshot(RouterState_1);
+            this._dispatchRouterAction(new RouterRequest(this._routerState, event, this._trigger));
         }
     };
+    /** Reacts to `ResolveEnd`. */
     /**
+     * Reacts to `ResolveEnd`.
      * @private
+     * @param {?} event
      * @return {?}
      */
-    RouterState.prototype.navigationEnd = /**
-     * @private
-     * @return {?}
-     */
-    function () {
-        if (this.shouldDispatchRouterNavigation()) {
-            this.dispatchRouterNavigation();
-        }
-    };
-    /**
-     * @private
-     * @return {?}
-     */
-    RouterState.prototype.shouldDispatchRouterNavigation = /**
+    RouterState.prototype._dispatchRouterDataResolved = /**
+     * Reacts to `ResolveEnd`.
      * @private
+     * @param {?} event
      * @return {?}
      */
-    function () {
-        if (!this._storeState)
-            return true;
-        return this._trigger !== 'store';
+    function (event) {
+        /** @type {?} */
+        var routerState = this._serializer.serialize(event.state);
+        this._dispatchRouterAction(new RouterDataResolved(routerState, event, this._trigger));
     };
+    /** Reacts to `RoutesRecognized` or `NavigationEnd`, depends on the `navigationActionTiming`. */
     /**
+     * Reacts to `RoutesRecognized` or `NavigationEnd`, depends on the `navigationActionTiming`.
      * @private
-     * @param {?} state
+     * @param {?} lastRoutesRecognized
      * @return {?}
      */
-    RouterState.prototype.navigateIfNeeded = /**
+    RouterState.prototype._dispatchRouterNavigation = /**
+     * Reacts to `RoutesRecognized` or `NavigationEnd`, depends on the `navigationActionTiming`.
      * @private
-     * @param {?} state
+     * @param {?} lastRoutesRecognized
      * @return {?}
      */
-    function (state) {
-        var _this = this;
-        if (state && state.trigger === 'devtools') {
-            this._storeState = this._store.selectSnapshot(RouterState_1);
-        }
+    function (lastRoutesRecognized) {
         /** @type {?} */
-        var canSkipNavigation = !this._storeState ||
-            !this._storeState.state ||
-            !state ||
-            state.trigger === 'router' ||
-            this._router.url === this._storeState.state.url;
-        if (canSkipNavigation) {
-            return;
-        }
-        this._trigger = 'store';
-        this._ngZone.run((/**
-         * @return {?}
-         */
-        function () {
-            _this._router.navigateByUrl((/** @type {?} */ ((/** @type {?} */ (_this._storeState)).state)).url);
-        }));
+        var nextRouterState = this._serializer.serialize(lastRoutesRecognized.state);
+        this._dispatchRouterAction(new RouterNavigation(nextRouterState, new RoutesRecognized(lastRoutesRecognized.id, lastRoutesRecognized.url, lastRoutesRecognized.urlAfterRedirects, nextRouterState), this._trigger));
     };
+    /** Reacts to `NavigationCancel`. */
     /**
+     * Reacts to `NavigationCancel`.
      * @private
+     * @param {?} event
      * @return {?}
      */
-    RouterState.prototype.dispatchRouterNavigation = /**
+    RouterState.prototype._dispatchRouterCancel = /**
+     * Reacts to `NavigationCancel`.
      * @private
+     * @param {?} event
      * @return {?}
      */
-    function () {
-        /** @type {?} */
-        var nextRouterState = this._serializer.serialize(this._lastRoutesRecognized.state);
-        this.dispatchRouterAction(new RouterNavigation(nextRouterState, new RoutesRecognized(this._lastRoutesRecognized.id, this._lastRoutesRecognized.url, this._lastRoutesRecognized.urlAfterRedirects, nextRouterState), this._trigger));
+    function (event) {
+        this._dispatchRouterAction(new RouterCancel((/** @type {?} */ (this._routerState)), this._storeState, event, this._trigger));
     };
+    /** Reacts to `NavigationEnd`. */
     /**
+     * Reacts to `NavigationEnd`.
      * @private
      * @param {?} event
      * @return {?}
      */
-    RouterState.prototype.dispatchRouterCancel = /**
+    RouterState.prototype._dispatchRouterError = /**
+     * Reacts to `NavigationEnd`.
      * @private
      * @param {?} event
      * @return {?}
      */
     function (event) {
-        this.dispatchRouterAction(new RouterCancel((/** @type {?} */ (this._routerState)), this._storeState, event, this._trigger));
+        this._dispatchRouterAction(new RouterError((/** @type {?} */ (this._routerState)), this._storeState, new NavigationError(event.id, event.url, "" + event), this._trigger));
     };
+    /** Reacts to `NavigationEnd`. */
     /**
+     * Reacts to `NavigationEnd`.
      * @private
      * @param {?} event
      * @return {?}
      */
-    RouterState.prototype.dispatchRouterError = /**
+    RouterState.prototype._dispatchRouterNavigated = /**
+     * Reacts to `NavigationEnd`.
      * @private
      * @param {?} event
      * @return {?}
      */
     function (event) {
-        this.dispatchRouterAction(new RouterError((/** @type {?} */ (this._routerState)), this._storeState, new NavigationError(event.id, event.url, "" + event), this._trigger));
+        /** @type {?} */
+        var routerState = this._serializer.serialize(this._router.routerState.snapshot);
+        this._dispatchRouterAction(new RouterNavigated(routerState, event, this._trigger));
     };
     /**
      * @private
@@ -580,7 +738,7 @@ var RouterState = /** @class */ (function () {
      * @param {?} action
      * @return {?}
      */
-    RouterState.prototype.dispatchRouterAction = /**
+    RouterState.prototype._dispatchRouterAction = /**
      * @private
      * @template T
      * @param {?} action
@@ -595,26 +753,11 @@ var RouterState = /** @class */ (function () {
             this._trigger = 'none';
         }
     };
-    /**
-     * @private
-     * @param {?} event
-     * @return {?}
-     */
-    RouterState.prototype.dispatchRouterDataResolved = /**
-     * @private
-     * @param {?} event
-     * @return {?}
-     */
-    function (event) {
-        /** @type {?} */
-        var routerState = this._serializer.serialize(event.state);
-        this.dispatchRouterAction(new RouterDataResolved(routerState, event, this._trigger));
-    };
     /**
      * @private
      * @return {?}
      */
-    RouterState.prototype.reset = /**
+    RouterState.prototype._reset = /**
      * @private
      * @return {?}
      */
@@ -628,7 +771,8 @@ var RouterState = /** @class */ (function () {
         { type: Store },
         { type: Router },
         { type: RouterStateSerializer },
-        { type: NgZone }
+        { type: NgZone },
+        { type: Injector }
     ]; };
     RouterState.decorators = [
         { type: Injectable }
@@ -638,7 +782,8 @@ var RouterState = /** @class */ (function () {
         { type: Store },
         { type: Router },
         { type: RouterStateSerializer },
-        { type: NgZone }
+        { type: NgZone },
+        { type: Injector }
     ]; };
     __decorate([
         Action(Navigate),
@@ -647,7 +792,14 @@ var RouterState = /** @class */ (function () {
         __metadata("design:returntype", void 0)
     ], RouterState.prototype, "navigate", null);
     __decorate([
-        Action([RouterNavigation, RouterError, RouterCancel, RouterDataResolved]),
+        Action([
+            RouterRequest,
+            RouterNavigation,
+            RouterError,
+            RouterCancel,
+            RouterDataResolved,
+            RouterNavigated
+        ]),
         __metadata("design:type", Function),
         __metadata("design:paramtypes", [Object, Object]),
         __metadata("design:returntype", void 0)
@@ -676,7 +828,8 @@ var RouterState = /** @class */ (function () {
         __metadata("design:paramtypes", [Store,
             Router,
             RouterStateSerializer,
-            NgZone])
+            NgZone,
+            Injector])
     ], RouterState);
     return RouterState;
 }());
@@ -704,12 +857,17 @@ if (false) {
      * @type {?}
      * @private
      */
-    RouterState.prototype._lastRoutesRecognized;
+    RouterState.prototype._lastEvent;
     /**
      * @type {?}
      * @private
      */
     RouterState.prototype._subscription;
+    /**
+     * @type {?}
+     * @private
+     */
+    RouterState.prototype._options;
     /**
      * @type {?}
      * @private
@@ -740,15 +898,25 @@ var NgxsRouterPluginModule = /** @class */ (function () {
     function NgxsRouterPluginModule() {
     }
     /**
+     * @param {?=} options
      * @return {?}
      */
     NgxsRouterPluginModule.forRoot = /**
+     * @param {?=} options
      * @return {?}
      */
-    function () {
+    function (options) {
         return {
             ngModule: NgxsRouterPluginModule,
-            providers: [{ provide: RouterStateSerializer, useClass: DefaultRouterStateSerializer }]
+            providers: [
+                { provide: USER_OPTIONS, useValue: options },
+                {
+                    provide: NGXS_ROUTER_PLUGIN_OPTIONS,
+                    useFactory: createRouterPluginOptions,
+                    deps: [USER_OPTIONS]
+                },
+                { provide: RouterStateSerializer, useClass: DefaultRouterStateSerializer }
+            ]
         };
     };
     NgxsRouterPluginModule.decorators = [
@@ -774,5 +942,5 @@ var NgxsRouterPluginModule = /** @class */ (function () {
  * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
  */
 
-export { DefaultRouterStateSerializer, Navigate, NgxsRouterPluginModule, RouterCancel, RouterDataResolved, RouterError, RouterNavigation, RouterState, RouterStateSerializer };
+export { DefaultRouterStateSerializer, Navigate, NgxsRouterPluginModule, RouterCancel, RouterDataResolved, RouterError, RouterNavigated, RouterNavigation, RouterRequest, RouterState, RouterStateSerializer, USER_OPTIONS as ɵb, NGXS_ROUTER_PLUGIN_OPTIONS as ɵc, createRouterPluginOptions as ɵd };
 //# sourceMappingURL=ngxs-router-plugin.js.map