refactor: extract PopstateNavigationStart type and type guard

Author: LayZeeDK

packages/router-component-store/src/lib/router-history-store/popstate-navigation-start.ts

@@ -0,0 +1,20 @@
+import { NavigationStart } from '@angular/router';
+import { NonNullish } from '../util-types/non-nullish';
+import { Override } from '../util-types/override';
+
+/**
+ * A `NavigationStart` event triggered by a `popstate` event.
+ */
+export type PopstateNavigationStart = Override<
+  NavigationStart,
+  {
+    navigationTrigger: 'popstate';
+  }
+> &
+  NonNullish<Pick<NavigationStart, 'restoredState'>>;
+
+export function isPopstateNavigationStart(
+  event: NavigationStart
+): event is PopstateNavigationStart {
+  return event.navigationTrigger === 'popstate';
+}

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

@@ -9,6 +9,7 @@ import { NavigationEnd, NavigationStart, Router } from '@angular/router';
 import { ComponentStore, provideComponentStore } from '@ngrx/component-store';
 import { filter, map, Observable, switchMap, take } from 'rxjs';
 import { filterRouterEvents } from '../filter-router-event.operator';
+import { isPopstateNavigationStart } from './popstate-navigation-start';
 
 interface RouterHistoryState {
   /**
@@ -182,14 +183,8 @@ export class RouterHistoryStore extends ComponentStore<RouterHistoryState> {
   ): RouterNavigatedSequence {
     let navigation = history[navigationId];
 
-    while (navigation[0].navigationTrigger === 'popstate') {
-      navigation =
-        history[
-          // Navigation events triggered by `popstate` always have a
-          // `restoredState`
-          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          navigation[0].restoredState!.navigationId
-        ];
+    while (isPopstateNavigationStart(navigation[0])) {
+      navigation = history[navigation[0].restoredState.navigationId];
     }
 
     return navigation;

packages/router-component-store/src/lib/util-types/non-nullish.ts

@@ -0,0 +1,40 @@
+/**
+ * Shallow removal of `null` and `undefined` from the types of all members of a shape.
+ *
+ * @example
+ * interface LaxPerson {
+ *   name?: string;
+ *   address?: Address | null;
+ *   age: number | null;
+ * }
+ * type StrictPerson = NonNullish<LaxPerson>;
+ * // -> interface {
+ * //   name: string;
+ * //   address: Address;
+ * //   age: number;
+ * // }
+ *
+ * @license
+ * Copyright 2022 Lars Gyrup Brink Nielsen
+ *
+ * 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.
+ */
+export type NonNullish<TShape> = {
+  [TMember in keyof Required<TShape>]: NonNullable<TShape[TMember]>;
+};

packages/router-component-store/src/lib/util-types/override.ts

@@ -0,0 +1,47 @@
+/**
+ * Shallow override of one or more members of a shape.
+ *
+ * @example
+ * interface LaxPerson {
+ *   name?: string;
+ *   address?: Address | null;
+ *   age: number | null;
+ * }
+ * type NamedPerson = Override<
+ *   LaxPerson,
+ *   {
+ *     name: string;
+ *   }
+ * >;
+ * // -> interface {
+ * //   name: string;
+ * //   address?: Address | null;
+ * //   age: number | null;
+ * // }
+ *
+ * @license
+ * Copyright 2022 Lars Gyrup Brink Nielsen
+ *
+ * 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.
+ */
+export type Override<TOriginal, TOverrides extends Partial<TOriginal>> = Omit<
+  TOriginal,
+  keyof TOverrides
+> &
+  TOverrides;