feat(tracker): add new disableCampaignParameters configuration option

projects/ngx-matomo-client/core/tracker/configuration.ts

@@ -21,17 +21,17 @@ export const MATOMO_CONFIGURATION = new InjectionToken<MatomoConfiguration>('MAT
 export const INTERNAL_MATOMO_CONFIGURATION = new InjectionToken<InternalMatomoConfiguration>(
   'INTERNAL_MATOMO_CONFIGURATION',
   {
-    factory: () =>
-      ({
-        disabled: false,
-        enableLinkTracking: true,
-        trackAppInitialLoad: !inject(MATOMO_ROUTER_ENABLED),
-        requireConsent: MatomoConsentMode.NONE,
-        enableJSErrorTracking: false,
-        runOutsideAngularZone: false,
-        acceptDoNotTrack: false,
-        ...requireNonNull(inject(MATOMO_CONFIGURATION, { optional: true }), CONFIG_NOT_FOUND),
-      }) as InternalMatomoConfiguration,
+    factory: (): InternalMatomoConfiguration => ({
+      disabled: false,
+      enableLinkTracking: true,
+      trackAppInitialLoad: !inject(MATOMO_ROUTER_ENABLED),
+      requireConsent: MatomoConsentMode.NONE,
+      enableJSErrorTracking: false,
+      runOutsideAngularZone: false,
+      disableCampaignParameters: false,
+      acceptDoNotTrack: false,
+      ...requireNonNull(inject(MATOMO_CONFIGURATION, { optional: true }), CONFIG_NOT_FOUND),
+    }),
   },
 );
 
@@ -179,6 +179,16 @@ export interface BaseMatomoConfiguration {
 
   /** Set to `true` to run matomo calls outside of angular NgZone. This may fix angular freezes. */
   runOutsideAngularZone?: boolean;
+
+  /**
+   * Set to `true` to avoid sending campaign parameters
+   *
+   * By default, Matomo will send campaign parameters (mtm, utm, etc.) to the tracker and record that information.
+   * Some privacy regulations may not allow for this information to be collected.
+   *
+   * <b>This is available as of Matomo 5.1 only.</b>
+   */
+  disableCampaignParameters?: boolean;
 }
 
 export interface BaseAutoMatomoConfiguration<

projects/ngx-matomo-client/core/tracker/matomo-initializer.service.spec.ts

@@ -202,6 +202,28 @@ describe('MatomoInitializerService', () => {
     expect(tracker.setDoNotTrack).toHaveBeenCalledBefore(tracker.trackPageView);
   });
 
+  it('should disable campaign parameters if enabled', () => {
+    // Given
+    const service = instantiate({
+      mode: MatomoInitializationMode.MANUAL,
+      disableCampaignParameters: true,
+      trackAppInitialLoad: true,
+      enableLinkTracking: false,
+    });
+    const tracker = TestBed.inject(MatomoTracker);
+
+    spyOn(tracker, 'trackPageView');
+    spyOn(tracker, 'disableCampaignParameters');
+
+    // When
+    service.initialize();
+
+    // Then
+    expect(tracker.trackPageView).toHaveBeenCalledOnceWith();
+    expect(tracker.disableCampaignParameters).toHaveBeenCalledTimes(1);
+    expect(tracker.disableCampaignParameters).toHaveBeenCalledBefore(tracker.trackPageView);
+  });
+
   it('should require tracking consent if setting if enabled', () => {
     // Given
     const service = instantiate({

projects/ngx-matomo-client/core/tracker/matomo-initializer.service.ts

@@ -168,6 +168,10 @@ export class MatomoInitializerService {
       this.tracker.enableJSErrorTracking();
     }
 
+    if (this.config.disableCampaignParameters) {
+      this.tracker.disableCampaignParameters();
+    }
+
     if (this.config.trackAppInitialLoad) {
       this.tracker.trackPageView();
     }