feat(router): add merge strategy config for route data service (#3443)

Author: griest024

libs/router/src/data/config/public_api.ts

@@ -0,0 +1,2 @@
+export * from './token';
+export * from './type';

libs/router/src/data/config/token.ts

@@ -0,0 +1,8 @@
+import { createConfigInjectionToken } from '@daffodil/core';
+
+import { DaffRouterDataServiceConfig } from './type';
+
+export const {
+  token: DAFF_ROUTER_DATA_SERVICE_CONFIG,
+  provider: provideDaffRouterDataServiceConfig,
+} = createConfigInjectionToken<DaffRouterDataServiceConfig>({}, 'DAFF_ROUTER_DATA_SERVICE_CONFIG');

libs/router/src/data/config/type.ts

@@ -0,0 +1,13 @@
+import { ActivatedRouteSnapshot } from '@angular/router';
+
+import { DaffMergeStrategy } from '@daffodil/core';
+
+/**
+ * Configuration for {@link DaffRouterDataService}.
+ */
+export interface DaffRouterDataServiceConfig<T extends ActivatedRouteSnapshot['data'] = ActivatedRouteSnapshot['data']> {
+  /**
+   * The strategy to use for merging route data.
+   */
+  mergeStrategy?: DaffMergeStrategy<T>;
+}

libs/router/src/data/helpers/collect-data.ts

@@ -1,24 +1,14 @@
-import {
-  ActivatedRouteSnapshot,
-  Route,
-} from '@angular/router';
+import { ActivatedRouteSnapshot } from '@angular/router';
 
-import { collect } from '@daffodil/core';
+import {
+  collect,
+  daffMerge,
+  DaffMergeStrategy,
+} from '@daffodil/core';
 
 /**
  * Collects data defined in the entire tree of routes.
  * Shallow merges data, preferring fields of more deeply nested routes.
  */
-export const daffRouterDataCollect = <T extends Route['data'] = Route['data']>(route: ActivatedRouteSnapshot): T => {
-  const ary = collect(route, (r) => r.children);
-  const ret = ary.reduce(
-    (acc, r) => r.data
-      ? {
-        ...acc,
-        ...r.data,
-      }
-      : acc,
-    <T>{},
-  );
-  return ret;
-};
+export const daffRouterDataCollect = <T extends ActivatedRouteSnapshot['data'] = ActivatedRouteSnapshot['data']>(route: ActivatedRouteSnapshot, mergeStrategy?: DaffMergeStrategy<T>): T =>
+  daffMerge(collect(route, (r) => r.children).map((r) => <T>r.data), mergeStrategy);

libs/router/src/data/public_api.ts

@@ -1,2 +1,3 @@
 export * from './helpers/public_api';
+export * from './config/public_api';
 export * from './service/data.service';

libs/router/src/data/service/data.service.ts

@@ -1,8 +1,11 @@
-import { Injectable } from '@angular/core';
+import {
+  Inject,
+  Injectable,
+} from '@angular/core';
 import {
   ActivatedRoute,
+  ActivatedRouteSnapshot,
   NavigationEnd,
-  Route,
   Router,
 } from '@angular/router';
 import {
@@ -12,12 +15,16 @@ import {
   merge,
 } from 'rxjs';
 
+import {
+  DAFF_ROUTER_DATA_SERVICE_CONFIG,
+  DaffRouterDataServiceConfig,
+} from '../config/public_api';
 import { daffRouterDataCollect } from '../helpers/collect-data';
 
 @Injectable({
   providedIn: 'root',
 })
-export class DaffRouterDataService<T extends Route['data'] = Route['data']> {
+export class DaffRouterDataService<T extends ActivatedRouteSnapshot['data'] = ActivatedRouteSnapshot['data']> {
   /**
    * A collection of all the route data defined in any part of the currently activated route's tree.
    * Child route's data takes precendence over parent data.
@@ -27,6 +34,7 @@ export class DaffRouterDataService<T extends Route['data'] = Route['data']> {
   constructor(
     private route: ActivatedRoute,
     private router: Router,
+    @Inject(DAFF_ROUTER_DATA_SERVICE_CONFIG) private config: DaffRouterDataServiceConfig,
   ) {
     /**
      * Because data won't reemit for route changes and
@@ -46,7 +54,7 @@ export class DaffRouterDataService<T extends Route['data'] = Route['data']> {
       this.route.url,
     ).pipe(
       map(() => this.route.snapshot),
-      map(daffRouterDataCollect<T>),
+      map((r) => daffRouterDataCollect<T>(r, this.config.mergeStrategy)),
     );
   }
 }