feat(seo)!: remove explicit dep on ngrx/router-store

libs/seo/package.json

@@ -32,10 +32,12 @@
     "@angular/router": "0.0.0-PLACEHOLDER",
     "@angular/platform-browser": "0.0.0-PLACEHOLDER",
     "@daffodil/core": "0.0.0-PLACEHOLDER",
+    "rxjs": "0.0.0-PLACEHOLDER"
+  },
+  "optionalDependencies": {
     "@ngrx/effects": "0.0.0-PLACEHOLDER",
     "@ngrx/store": "0.0.0-PLACEHOLDER",
-    "@ngrx/router-store": "0.0.0-PLACEHOLDER",
-    "rxjs": "0.0.0-PLACEHOLDER"
+    "@ngrx/router-store": "0.0.0-PLACEHOLDER"
   },
   "devDependencies": {
     "@daffodil/core": "0.0.0-PLACEHOLDER"

libs/seo/router/ng-package.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "../../../node_modules/ng-packagr/ng-entrypoint.schema.json",
+  "lib": {
+    "entryFile": "src/index.ts"
+  }
+}

libs/seo/state/src/injection-tokens/canonical/router/updates.token.spec.ts → libs/seo/router/src/canonical/updates.token.spec.ts

@@ -8,7 +8,8 @@ import {
   daffProvideCanonicalUrlRouterUpdates,
   DAFF_SEO_CANONICAL_URL_ROUTER_UPDATES,
 } from './updates.token';
-import { DaffSeoUpdateEventPair } from '../../../models/update-event-pair.interface';
+import { DaffSeoUpdateEventPair } from '../model/update-event-pair.interface';
+
 
 describe('daffProvideCanonicalUrlUpdates', () => {
   let updates: DaffSeoUpdateEventPair<Event, string>[];

libs/seo/state/src/injection-tokens/canonical/router/updates.token.ts → libs/seo/router/src/canonical/updates.token.ts

@@ -4,8 +4,7 @@ import {
 } from '@angular/core';
 import { Event } from '@angular/router';
 
-import { DaffSeoUpdateEventPair } from '../../../models/update-event-pair.interface';
-
+import { DaffSeoUpdateEventPair } from '../model/update-event-pair.interface';
 
 /**
  * A multi-provider injection token for providing canonical URL update logic.

libs/seo/state/src/effects/router/canonical.effects.ts → libs/seo/router/src/effects/canonical.effects.ts

@@ -10,9 +10,10 @@ import {
 
 import { DaffRestoreableCanonicalService } from '@daffodil/seo';
 
+
 import { DaffSeoPageHookRouterEffects } from './page-hook.effects';
-import { DAFF_SEO_CANONICAL_URL_ROUTER_UPDATES } from '../../injection-tokens/canonical/router/updates.token';
-import { DaffSeoUpdateEventPair } from '../../models/update-event-pair.interface';
+import { DAFF_SEO_CANONICAL_URL_ROUTER_UPDATES } from '../canonical/updates.token';
+import { DaffSeoUpdateEventPair } from '../model/update-event-pair.interface';
 
 /**
  * Page hook effects for the canonical URL.

libs/seo/state/src/effects/router/meta.effects.ts → libs/seo/router/src/effects/meta.effects.ts

@@ -14,9 +14,10 @@ import {
   DaffSeoMetaDefinition,
 } from '@daffodil/seo';
 
+
 import { DaffSeoPageHookRouterEffects } from './page-hook.effects';
-import { DAFF_SEO_META_ROUTER_UPDATES } from '../../injection-tokens/meta/router/updates.token';
-import { DaffSeoUpdateEventPair } from '../../models/update-event-pair.interface';
+import { DAFF_SEO_META_ROUTER_UPDATES } from '../meta/updates.token';
+import { DaffSeoUpdateEventPair } from '../model/update-event-pair.interface';
 
 /**
  * Page hook effects for the page meta tags.

libs/seo/state/src/effects/router/page-hook.effects.ts → libs/seo/router/src/effects/page-hook.effects.ts

@@ -7,7 +7,6 @@ import {
   Event,
   ActivatedRoute,
 } from '@angular/router';
-import { createEffect } from '@ngrx/effects';
 import { EMPTY } from 'rxjs';
 import {
   map,
@@ -18,7 +17,7 @@ import {
 
 import { DaffSeoRestoreableServiceInterface } from '@daffodil/seo';
 
-import { DaffSeoUpdateEventPair } from '../../models/update-event-pair.interface';
+import { DaffSeoUpdateEventPair } from '../model/update-event-pair.interface';
 
 export const shouldHandleEvent = <T extends DaffSeoUpdateEventPair>(routingEvent: Event, operators: T[]): boolean =>
   !!operators.find((trackableEvents) => routingEvent instanceof trackableEvents.event);
@@ -45,71 +44,51 @@ export abstract class DaffSeoPageHookRouterEffects<
    *
    * @docs-private
    */
-  getData$ = createEffect(
-    () => this.router.events.pipe(
-      filter((e) => shouldHandleEvent(e, this.updates)),
-      map(event => this.updates.filter(update =>
-        event instanceof update.event,
-      ).map(({ getData }) =>
-        getData(event, this.activatedRoute),
-      )),
-      tap((data: V[]) => data.forEach(datum => {
-        if (datum) {
-          this.service.upsert(datum);
-        };
-      })),
-      switchMap(() => EMPTY),
-    ),
-    {
-      dispatch: false,
-    },
+  getData$ = () => this.router.events.pipe(
+    filter((e) => shouldHandleEvent(e, this.updates)),
+    map(event => this.updates.filter(update =>
+      event instanceof update.event,
+    ).map(({ getData }) =>
+      getData(event, this.activatedRoute),
+    )),
+    tap((data: V[]) => data.forEach(datum => {
+      if (datum) {
+        this.service.upsert(datum);
+      };
+    })),
+    switchMap(() => EMPTY),
   );
 
   /**
    * Removes SEO data when navigation starts.
    *
    * @docs-private
    */
-  remove$ = createEffect(
-    () => this.router.events.pipe(
-      filter((e) => e instanceof NavigationStart),
-      tap(() => this.service.clear()),
-      switchMap(() => EMPTY),
-    ),
-    {
-      dispatch: false,
-    },
+  remove$ = () => this.router.events.pipe(
+    filter((e) => e instanceof NavigationStart),
+    tap(() => this.service.clear()),
+    switchMap(() => EMPTY),
   );
 
   /**
    * Restores previously removed SEO data when navigation is canceled or fails.
    *
    * @docs-private
    */
-  restore$ = createEffect(
-    () => this.router.events.pipe(
-      filter((e) => e instanceof NavigationCancel || e instanceof NavigationError),
-      tap(() => this.service.restore()),
-      switchMap(() => EMPTY),
-    ),
-    {
-      dispatch: false,
-    },
+  restore$ = () => this.router.events.pipe(
+    filter((e) => e instanceof NavigationCancel || e instanceof NavigationError),
+    tap(() => this.service.restore()),
+    switchMap(() => EMPTY),
   );
 
   /**
    * Empties the SEO data restore cache when navigation completes.
    *
    * @docs-private
    */
-  emptyRestoreCache$ = createEffect(
-    () => this.router.events.pipe(
-      filter((e) => e instanceof NavigationEnd),
-      tap(() => this.service.emptyRestoreCache()),
-      switchMap(() => EMPTY),
-    ),
-    {
-      dispatch: false,
-    },
+  emptyRestoreCache$ = () => this.router.events.pipe(
+    filter((e) => e instanceof NavigationEnd),
+    tap(() => this.service.emptyRestoreCache()),
+    switchMap(() => EMPTY),
   );
 }

libs/seo/state/src/effects/router/title.effects.ts → libs/seo/router/src/effects/title.effects.ts

@@ -11,11 +11,13 @@ import {
 import { DaffRestoreableTitleService } from '@daffodil/seo';
 
 import { DaffSeoPageHookRouterEffects } from './page-hook.effects';
-import { DAFF_SEO_TITLE_ROUTER_UPDATES } from '../../injection-tokens/title/router/updates.token';
-import { DaffSeoUpdateEventPair } from '../../models/update-event-pair.interface';
+import { DaffSeoUpdateEventPair } from '../model/update-event-pair.interface';
+import { DAFF_SEO_TITLE_ROUTER_UPDATES } from '../title/updates.token';
 
 /**
  * Page hook effects for the page title.
+ *
+ * @deprecated since Angular 14. See https://angular.io/api/router/TitleStrategy
  */
 @Injectable()
 export class DaffSeoNativeTitleEffects extends DaffSeoPageHookRouterEffects<

libs/seo/router/src/index.ts

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

libs/seo/state/src/injection-tokens/meta/router/updates.token.spec.ts → libs/seo/router/src/meta/updates.token.spec.ts

@@ -10,7 +10,8 @@ import {
   daffProvideMetaRouterUpdates,
   DAFF_SEO_META_ROUTER_UPDATES,
 } from './updates.token';
-import { DaffSeoUpdateEventPair } from '../../../models/update-event-pair.interface';
+import { DaffSeoUpdateEventPair } from '../model/update-event-pair.interface';
+
 
 describe('daffProvideMetaUpdates', () => {
   let updates: DaffSeoUpdateEventPair<Event, DaffSeoMetaDefinition>[];

libs/seo/state/src/injection-tokens/meta/router/updates.token.ts → libs/seo/router/src/meta/updates.token.ts

@@ -6,7 +6,7 @@ import { Event } from '@angular/router';
 
 import { DaffSeoMetaDefinition } from '@daffodil/seo';
 
-import { DaffSeoUpdateEventPair } from '../../../models/update-event-pair.interface';
+import { DaffSeoUpdateEventPair } from '../model/update-event-pair.interface';
 
 /**
  * A multi-provider injection token for providing page meta update logic.

libs/seo/router/src/providers/canonical-provider.ts

@@ -0,0 +1,34 @@
+import {
+  APP_INITIALIZER,
+  Provider,
+} from '@angular/core';
+
+import { initializeRouterService } from './initializer';
+import { DaffSeoNativeCanonicalUrlEffects } from '../effects/canonical.effects';
+
+/**
+ * Configures an Angular application to track routing configuration
+ * and subsequently set canonical url information in the document.
+ *
+ * This provider is intended to only be imported exactly once in the root of the application.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * @NgModule({
+ *   providers: [
+ *    daffSeoRouterCanonicalProvider()
+ *   ],
+ * })
+ * export class AppModule { }
+ * ```
+ */
+export const daffSeoRouterCanonicalProvider = (): Provider[] => [
+  DaffSeoNativeCanonicalUrlEffects,
+  {
+    provide: APP_INITIALIZER,
+    useFactory: initializeRouterService,
+    deps: [DaffSeoNativeCanonicalUrlEffects],
+    multi: true,
+  },
+];

libs/seo/router/src/providers/initializer.ts

@@ -0,0 +1,8 @@
+import { DaffSeoPageHookRouterEffects } from '../effects/page-hook.effects';
+
+export const initializeRouterService = (effects: DaffSeoPageHookRouterEffects<any, any, any>) => () => {
+  effects.getData$().subscribe();
+  effects.emptyRestoreCache$().subscribe();
+  effects.remove$().subscribe();
+  effects.restore$().subscribe();
+};

libs/seo/router/src/providers/meta-provider.ts

@@ -0,0 +1,33 @@
+import {
+  APP_INITIALIZER,
+  Provider,
+} from '@angular/core';
+
+import { initializeRouterService } from './initializer';
+import { DaffSeoNativeMetaEffects } from '../effects/meta.effects';
+
+/**
+ * Configures an Angular application to track routing configuration and subsequently set meta information in the document.
+ *
+ * This provider is intended to only be imported exactly once in the root of the application.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * @NgModule({
+ *   providers: [
+ *    daffSeoRouterMetaProvider()
+ *   ],
+ * })
+ * export class AppModule { }
+ * ```
+ */
+export const daffSeoRouterMetaProvider = (): Provider[] => [
+  DaffSeoNativeMetaEffects,
+  {
+    provide: APP_INITIALIZER,
+    useFactory: initializeRouterService,
+    deps: [DaffSeoNativeMetaEffects],
+    multi: true,
+  },
+];

libs/seo/router/src/providers/title-provider.ts

@@ -0,0 +1,35 @@
+import {
+  APP_INITIALIZER,
+  Provider,
+} from '@angular/core';
+
+import { initializeRouterService } from './initializer';
+import { DaffSeoNativeTitleEffects } from '../effects/title.effects';
+
+/**
+ * Configures an Angular application to track routing configuration and subsequently set title information in the document.
+ *
+ * This provider is intended to only be imported exactly once in the root of the application.
+ *
+ * @deprecated since Angular 14. See https://angular.io/api/router/TitleStrategy
+ *
+ * ## Usage
+ *
+ * ```ts
+ * @NgModule({
+ *   providers: [
+ *    daffSeoRouterTitleProvider()
+ *   ],
+ * })
+ * export class AppModule { }
+ * ```
+ */
+export const daffSeoRouterTitleProvider = (): Provider[] => [
+  DaffSeoNativeTitleEffects,
+  {
+    provide: APP_INITIALIZER,
+    useFactory: initializeRouterService,
+    deps: [DaffSeoNativeTitleEffects],
+    multi: true,
+  },
+];

libs/seo/router/src/public_api.ts

@@ -0,0 +1,16 @@
+export { DaffSeoUpdateEventPair } from './model/update-event-pair.interface';
+export {
+  DAFF_SEO_META_ROUTER_UPDATES,
+  daffProvideMetaRouterUpdates,
+} from './meta/updates.token';
+export {
+  DAFF_SEO_CANONICAL_URL_ROUTER_UPDATES,
+  daffProvideCanonicalUrlRouterUpdates,
+} from './canonical/updates.token';
+export {
+  DAFF_SEO_TITLE_ROUTER_UPDATES,
+  daffProvideTitleRouterUpdates,
+} from './title/updates.token';
+export { daffSeoRouterTitleProvider } from './providers/title-provider';
+export { daffSeoRouterMetaProvider } from './providers/meta-provider';
+export { daffSeoRouterCanonicalProvider } from './providers/canonical-provider';

libs/seo/state/src/injection-tokens/title/router/updates.token.spec.ts → libs/seo/router/src/title/updates.token.spec.ts

@@ -8,7 +8,8 @@ import {
   daffProvideTitleRouterUpdates,
   DAFF_SEO_TITLE_ROUTER_UPDATES,
 } from './updates.token';
-import { DaffSeoUpdateEventPair } from '../../../models/update-event-pair.interface';
+import { DaffSeoUpdateEventPair } from '../model/update-event-pair.interface';
+
 
 describe('daffProvideTitleUpdates', () => {
   let updates: DaffSeoUpdateEventPair<Event, string>[];

libs/seo/state/src/injection-tokens/title/router/updates.token.ts → libs/seo/router/src/title/updates.token.ts

@@ -4,7 +4,7 @@ import {
 } from '@angular/core';
 import { Event } from '@angular/router';
 
-import { DaffSeoUpdateEventPair } from '../../../models/update-event-pair.interface';
+import { DaffSeoUpdateEventPair } from '../model/update-event-pair.interface';
 
 /**
  * A multi-provider injection token for providing canonical URL update logic.

libs/seo/state/src/injection-tokens/public_api.ts

@@ -2,25 +2,13 @@ export {
   daffProvideTitleUpdates,
   DAFF_SEO_TITLE_UPDATES,
 } from './title/updates.token';
-export {
-  daffProvideTitleRouterUpdates,
-  DAFF_SEO_TITLE_ROUTER_UPDATES,
-} from './title/router/updates.token';
 
 export {
   daffProvideMetaUpdates,
   DAFF_SEO_META_UPDATES,
 } from './meta/updates.token';
-export {
-  daffProvideMetaRouterUpdates,
-  DAFF_SEO_META_ROUTER_UPDATES,
-} from './meta/router/updates.token';
 
 export {
   daffProvideCanonicalUrlUpdates,
   DAFF_SEO_CANONICAL_URL_UPDATES,
 } from './canonical/updates.token';
-export {
-  daffProvideCanonicalUrlRouterUpdates,
-  DAFF_SEO_CANONICAL_URL_ROUTER_UPDATES,
-} from './canonical/router/updates.token';