feat(router): add DaffRouterActivatedRoute service (#2949)

Author: griest024

libs/router/src/activated-route/public_api.ts

@@ -0,0 +1 @@
+export * from './service';

libs/router/src/activated-route/service.spec.ts

@@ -0,0 +1,61 @@
+import { Component } from '@angular/core';
+import { TestBed } from '@angular/core/testing';
+import {
+  provideRouter,
+  Router,
+} from '@angular/router';
+
+import { DaffRouterActivatedRoute } from './service';
+
+@Component({})
+class TestComponent {}
+
+describe('@daffodil/router | DaffRouterActivatedRoute', () => {
+  let service: DaffRouterActivatedRoute;
+  let router: Router;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      providers: [
+        provideRouter([
+          {
+            path: '',
+            children: [
+              {
+                path: '',
+                data: {
+                  test: 'foo',
+                },
+                children: [
+                  {
+                    path: '',
+                    data: {
+                      foo: 'bar',
+                    },
+                    component: TestComponent,
+                  },
+                ],
+              },
+            ],
+          },
+        ]),
+      ],
+    });
+
+    service = TestBed.inject(DaffRouterActivatedRoute);
+    router = TestBed.inject(Router);
+  });
+
+  it('should be created', () => {
+    expect(service).toBeTruthy();
+  });
+
+  it('should return the activated route for the current tree', (done) => {
+    service.route$.subscribe((route) => {
+      expect(route.snapshot.data['foo']).toEqual('bar');
+      expect(route.snapshot.data['test']).toEqual('foo');
+      done();
+    });
+    router.initialNavigation();
+  });
+});

libs/router/src/activated-route/service.ts

@@ -0,0 +1,44 @@
+import { Injectable } from '@angular/core';
+import {
+  ActivatedRoute,
+  NavigationEnd,
+  Router,
+  RouterState,
+} from '@angular/router';
+import {
+  filter,
+  map,
+  Observable,
+  shareReplay,
+} from 'rxjs';
+
+const getActivatedRoute = (routerState: RouterState): ActivatedRoute => {
+  let route = routerState.root;
+  while (route.firstChild) {
+    route = route.firstChild;
+  }
+  return route;
+};
+
+/**
+ * Allows accessing the currently activated route from anywhere in the DI hierarchy.
+ * Contrasted to simply injecting `ActivatedRoute`, this will be accurate even from outside the router outlet.
+ *
+ * Note that this service operates by listening to router events. It is therefore recommended to
+ * inject this service in the root and subscribe to `route$` on app init so that all routing events are captured.
+ * The consumer can then subscribe at any later time (after all navigations) and the emission stream will be replayed.
+ */
+@Injectable({
+  providedIn: 'root',
+})
+export class DaffRouterActivatedRoute {
+  route$: Observable<ActivatedRoute> = this.router.events.pipe(
+    filter((event) => event instanceof NavigationEnd),
+    map(() => getActivatedRoute(this.router.routerState)),
+    shareReplay(),
+  );
+
+  constructor(
+    private router: Router,
+  ) {}
+}

libs/router/src/public_api.ts

@@ -1,3 +1,4 @@
 export * from './named-view/public_api';
 export * from './data/public_api';
 export * from './guards/public_api';
+export * from './activated-route/public_api';