fix(RouterStore): Replace RouterStateSnapshot with SerializedRouterStateSnapshot

BREAKING CHANGE:

Default router state is serialized to a shape that removes cycles

BEFORE:

Full RouterStateSnapshot is returned

AFTER:

Router state snapshot is returned as a SerializedRouterStateSnapshot with cyclical dependencies removed

Author: brandonroberts

modules/router-store/src/index.ts

@@ -21,4 +21,5 @@ export {
 export {
   RouterStateSerializer,
   DefaultRouterStateSerializer,
+  SerializedRouterStateSnapshot,
 } from './serializer';

modules/router-store/src/router_store_module.ts

@@ -17,6 +17,7 @@ import { of } from 'rxjs';
 import {
   DefaultRouterStateSerializer,
   RouterStateSerializer,
+  SerializedRouterStateSnapshot,
 } from './serializer';
 
 /**
@@ -35,7 +36,7 @@ export type RouterNavigationPayload<T> = {
 /**
  * An action dispatched when the router navigates.
  */
-export type RouterNavigationAction<T = RouterStateSnapshot> = {
+export type RouterNavigationAction<T = SerializedRouterStateSnapshot> = {
   type: typeof ROUTER_NAVIGATION;
   payload: RouterNavigationPayload<T>;
 };
@@ -57,7 +58,7 @@ export type RouterCancelPayload<T, V> = {
 /**
  * An action dispatched when the router cancel navigation.
  */
-export type RouterCancelAction<T, V = RouterStateSnapshot> = {
+export type RouterCancelAction<T, V = SerializedRouterStateSnapshot> = {
   type: typeof ROUTER_CANCEL;
   payload: RouterCancelPayload<T, V>;
 };
@@ -79,25 +80,25 @@ export type RouterErrorPayload<T, V> = {
 /**
  * An action dispatched when the router errors.
  */
-export type RouterErrorAction<T, V = RouterStateSnapshot> = {
+export type RouterErrorAction<T, V = SerializedRouterStateSnapshot> = {
   type: typeof ROUTER_ERROR;
   payload: RouterErrorPayload<T, V>;
 };
 
 /**
  * An union type of router actions.
  */
-export type RouterAction<T, V = RouterStateSnapshot> =
+export type RouterAction<T, V = SerializedRouterStateSnapshot> =
   | RouterNavigationAction<V>
   | RouterCancelAction<T, V>
   | RouterErrorAction<T, V>;
 
-export type RouterReducerState<T = RouterStateSnapshot> = {
+export type RouterReducerState<T = SerializedRouterStateSnapshot> = {
   state: T;
   navigationId: number;
 };
 
-export function routerReducer<T = RouterStateSnapshot>(
+export function routerReducer<T = SerializedRouterStateSnapshot>(
   state: RouterReducerState<T> | undefined,
   action: RouterAction<any, T>
 ): RouterReducerState<T> {
@@ -153,7 +154,7 @@ export type StoreRouterConfigFunction = () => StoreRouterConfig;
  *
  * ```
  * export type RouterNavigationPayload = {
- *   routerState: RouterStateSnapshot,
+ *   routerState: SerializedRouterStateSnapshot,
  *   event: RoutesRecognized
  * }
  * ```
@@ -221,7 +222,7 @@ export class StoreRouterConnectingModule {
     };
   }
 
-  private routerState: RouterStateSnapshot;
+  private routerState: SerializedRouterStateSnapshot;
   private storeState: any;
   private lastRoutesRecognized: RoutesRecognized;
 
@@ -232,7 +233,7 @@ export class StoreRouterConnectingModule {
   constructor(
     private store: Store<any>,
     private router: Router,
-    private serializer: RouterStateSerializer<RouterStateSnapshot>,
+    private serializer: RouterStateSerializer<SerializedRouterStateSnapshot>,
     @Inject(ROUTER_CONFIG) private config: StoreRouterConfig
   ) {
     this.stateKey = this.config.stateKey as string;