refactor: extract types and utilities from minimal serializer ES module (#292)

# Build
- Add Browserslist configuration matching Angular CLI defaults
- Configure TypeScript target and lib types

# Refactors
- Extract types from `minimal_serializer.ts` to separate files:
  - `OmitSymbolIndex` utility type
  - `MinimalRouteData`
  - `MinimalActivatedRouteSnapshot`
  - `MinimalRouterStateSnapshot`

Author: LayZeeDK

.browserslistrc

@@ -0,0 +1,8 @@
+# Matches Angular CLI's default Browserslist configuration
+# See https://angular.io/guide/build#configuring-browser-compatibility
+last 1 Chrome version
+last 1 Firefox version
+last 2 Edge major versions
+last 2 Safari major versions
+last 2 iOS major versions
+Firefox ESR

packages/router-component-store/src/index.ts

@@ -8,4 +8,4 @@ export * from './lib/local-router-store/provide-local-router-store';
 export * from './lib/router-store';
 
 // Serializable route state
-export { MinimalActivatedRouteSnapshot } from './lib/@ngrx/router-store/minimal_serializer';
+export * from './lib/@ngrx/router-store/minimal-activated-route-state-snapshot';

packages/router-component-store/src/lib/@ngrx/router-store/minimal-activated-route-state-snapshot.ts

@@ -0,0 +1,87 @@
+/**
+ * @license
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Brandon Roberts, Mike Ryan, Victor Savkin, Rob Wormald
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+import { ActivatedRouteSnapshot } from '@angular/router';
+import { OmitSymbolIndex } from '../../util-types/omit-symbol-index';
+
+/**
+ * Contains the information about a route associated with a component loaded in
+ * an outlet at a particular moment in time. MinimalActivatedRouteSnapshot can
+ * also be used to traverse the router state tree.
+ */
+export interface MinimalActivatedRouteSnapshot {
+  /**
+   * The configuration used to match this route.
+   */
+  readonly routeConfig: ActivatedRouteSnapshot['routeConfig'];
+  /**
+   * The URL segments matched by this route.
+   */
+  readonly url: ActivatedRouteSnapshot['url'];
+  /**
+   * The matrix parameters scoped to this route.
+   */
+  readonly params: ActivatedRouteSnapshot['params'];
+  /**
+   * The query parameters shared by all the routes.
+   */
+  readonly queryParams: ActivatedRouteSnapshot['queryParams'];
+  /**
+   * The URL fragment shared by all the routes.
+   */
+  readonly fragment: ActivatedRouteSnapshot['fragment'];
+  /**
+   * The static and resolved data of this route.
+   *
+   * @remarks
+   * Contains serializable route `Data` without its symbol index, in particular
+   * without the `Symbol.for(RouteTitle)` key as this is an internal value for
+   * the Angular `Router`. Instead, we access the resolved route title through
+   * `MinimalActivatedRouteSnapshot['title']`.
+   */
+  readonly data: OmitSymbolIndex<ActivatedRouteSnapshot['data']>;
+  /**
+   * The outlet name of the route.
+   */
+  readonly outlet: ActivatedRouteSnapshot['outlet'];
+  /**
+   * The resolved route title.
+   */
+  readonly title: ActivatedRouteSnapshot['title'];
+  /**
+   * The first child of this route in the router state tree
+   */
+  readonly firstChild?: MinimalActivatedRouteSnapshot;
+  /**
+   * The children of this route in the router state tree.
+   */
+  readonly children: MinimalActivatedRouteSnapshot[];
+}

packages/router-component-store/src/lib/@ngrx/router-store/minimal-router-state-snapshot.ts

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Brandon Roberts, Mike Ryan, Victor Savkin, Rob Wormald
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { MinimalActivatedRouteSnapshot } from './minimal-activated-route-state-snapshot';
+
+export interface MinimalRouterStateSnapshot {
+  readonly root: MinimalActivatedRouteSnapshot;
+  readonly url: string;
+}

packages/router-component-store/src/lib/@ngrx/router-store/minimal_serializer.spec.ts

@@ -1,3 +1,27 @@
+/**
+ * @license
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Brandon Roberts, Mike Ryan, Victor Savkin, Rob Wormald
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
 import { RouterStateSnapshot } from '@angular/router';
 
 import { MinimalRouterStateSerializer } from './minimal_serializer';

packages/router-component-store/src/lib/@ngrx/router-store/minimal_serializer.ts

@@ -22,100 +22,15 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-/**
- * @license
- * Copyright Google LLC All Rights Reserved.
- *
- * Use of this source code is governed by an MIT-style license that can be
- * found in the LICENSE file at https://angular.io/license
- */
 import { Injectable } from '@angular/core';
 import {
   ActivatedRouteSnapshot,
   Data,
   RouterStateSnapshot,
 } from '@angular/router';
-
-type OmitSymbolIndex<TShape> = {
-  [TShapeKey in keyof TShape as symbol extends TShapeKey
-    ? never
-    : TShapeKey]: TShape[TShapeKey];
-};
-
-/**
- * Serializable route `Data` without its symbol index, in particular without the
- * `Symbol.for(RouteTitle)` key as this is an internal value for the Angular
- * `Router`.
- */
-export type MinimalRouteData = OmitSymbolIndex<Data>;
-
-/**
- * Contains the information about a route associated with a component loaded in
- * an outlet at a particular moment in time. MinimalActivatedRouteSnapshot can
- * also be used to traverse the router state tree.
- */
-export interface MinimalActivatedRouteSnapshot {
-  /**
-   * The configuration used to match this route.
-   */
-  readonly routeConfig: ActivatedRouteSnapshot['routeConfig'];
-  /**
-   * The URL segments matched by this route.
-   */
-  readonly url: ActivatedRouteSnapshot['url'];
-  /**
-   * The matrix parameters scoped to this route.
-   */
-  readonly params: ActivatedRouteSnapshot['params'];
-  /**
-   * The query parameters shared by all the routes.
-   */
-  readonly queryParams: ActivatedRouteSnapshot['queryParams'];
-  /**
-   * The URL fragment shared by all the routes.
-   */
-  readonly fragment: ActivatedRouteSnapshot['fragment'];
-  /**
-   * The static and resolved data of this route.
-   *
-   * @remarks
-   * Contains serializable route `Data` without its symbol index, in particular
-   * without the `Symbol.for(RouteTitle)` key as this is an internal value for
-   * the Angular `Router`. Instead, we access the resolved route title through
-   * `MinimalActivatedRouteSnapshot['title']`.
-   */
-  readonly data: OmitSymbolIndex<ActivatedRouteSnapshot['data']>;
-  /**
-   * The outlet name of the route.
-   */
-  readonly outlet: ActivatedRouteSnapshot['outlet'];
-  /**
-   * The resolved route title.
-   */
-  readonly title: ActivatedRouteSnapshot['title'];
-  /**
-   * The first child of this route in the router state tree
-   */
-  readonly firstChild?: MinimalActivatedRouteSnapshot;
-  /**
-   * The children of this route in the router state tree.
-   */
-  readonly children: MinimalActivatedRouteSnapshot[];
-}
-
-export interface MinimalRouterStateSnapshot {
-  readonly root: MinimalActivatedRouteSnapshot;
-  readonly url: string;
-}
-
-function objectFromEntries<TValue>(entries: [string, TValue][]): {
-  [key: string]: TValue;
-} {
-  return entries.reduce(
-    (object, [key, value]) => ({ ...object, [key]: value }),
-    {}
-  );
-}
+import { MinimalRouteData } from '../../minimal-route-data';
+import { MinimalActivatedRouteSnapshot } from './minimal-activated-route-state-snapshot';
+import { MinimalRouterStateSnapshot } from './minimal-router-state-snapshot';
 
 @Injectable({
   providedIn: 'root',
@@ -129,7 +44,7 @@ export class MinimalRouterStateSerializer {
   }
 
   #serializeRouteData(routeData: Data): MinimalRouteData {
-    return objectFromEntries(Object.entries(routeData));
+    return Object.fromEntries(Object.entries(routeData));
   }
 
   #serializeRouteSnapshot(

packages/router-component-store/src/lib/global-router-store/global-router-store.ts

@@ -2,11 +2,9 @@ import { Injectable } from '@angular/core';
 import { Data, Params, Router } from '@angular/router';
 import { ComponentStore } from '@ngrx/component-store';
 import { map, Observable } from 'rxjs';
-import {
-  MinimalActivatedRouteSnapshot,
-  MinimalRouterStateSerializer,
-  MinimalRouterStateSnapshot,
-} from '../@ngrx/router-store/minimal_serializer';
+import { MinimalActivatedRouteSnapshot } from '../@ngrx/router-store/minimal-activated-route-state-snapshot';
+import { MinimalRouterStateSnapshot } from '../@ngrx/router-store/minimal-router-state-snapshot';
+import { MinimalRouterStateSerializer } from '../@ngrx/router-store/minimal_serializer';
 import { RouterStore } from '../router-store';
 
 interface GlobalRouterState {

packages/router-component-store/src/lib/local-router-store/local-router-store.ts

@@ -2,11 +2,9 @@ import { Injectable } from '@angular/core';
 import { ActivatedRoute, Data, Params, Router } from '@angular/router';
 import { ComponentStore } from '@ngrx/component-store';
 import { map, Observable } from 'rxjs';
-import {
-  MinimalActivatedRouteSnapshot,
-  MinimalRouterStateSerializer,
-  MinimalRouterStateSnapshot,
-} from '../@ngrx/router-store/minimal_serializer';
+import { MinimalActivatedRouteSnapshot } from '../@ngrx/router-store/minimal-activated-route-state-snapshot';
+import { MinimalRouterStateSnapshot } from '../@ngrx/router-store/minimal-router-state-snapshot';
+import { MinimalRouterStateSerializer } from '../@ngrx/router-store/minimal_serializer';
 import { RouterStore } from '../router-store';
 
 interface LocalRouterState {

packages/router-component-store/src/lib/minimal-route-data.ts

@@ -0,0 +1,9 @@
+import { Data } from '@angular/router';
+import { OmitSymbolIndex } from './util-types/omit-symbol-index';
+
+/**
+ * Serializable route `Data` without its symbol index, in particular without the
+ * `Symbol.for(RouteTitle)` key as this is an internal value for the Angular
+ * `Router`.
+ */
+export type MinimalRouteData = OmitSymbolIndex<Data>;

packages/router-component-store/src/lib/router-store.ts

@@ -1,7 +1,7 @@
 import { Injectable } from '@angular/core';
 import { Data, Params } from '@angular/router';
 import { Observable } from 'rxjs';
-import { MinimalActivatedRouteSnapshot } from './@ngrx/router-store/minimal_serializer';
+import { MinimalActivatedRouteSnapshot } from './@ngrx/router-store/minimal-activated-route-state-snapshot';
 
 /**
  * An Angular Router-connecting NgRx component store.