add metrics config

Author: FrancescoMolinaro

src/app/shared/cookies/browser-klaro.service.ts

@@ -19,9 +19,12 @@ import { CAPTCHA_NAME } from '../../core/google-recaptcha/google-recaptcha.servi
 import isEqual from 'lodash/isEqual';
 
 export interface CookieConsents {
-  acknowledgement: boolean;
-  authentication: boolean;
-  preferences: boolean;
+  [key: string]: boolean;
+}
+
+export interface ThirdPartyMetric {
+  key: string;
+  enabled: boolean
 }
 /**
  * Metadata field to store a user's cookie consent preferences in
@@ -108,6 +111,20 @@ export class BrowserKlaroService extends KlaroService {
       this.klaroConfig.translations.zz.consentNotice.description = 'cookies.consent.content-notice.description.no-privacy';
     }
 
+    if(environment.metricsConsents) {
+      environment.metricsConsents.forEach((metric) => {
+        if(metric.enabled) {
+          this.klaroConfig.services.push(
+            {
+              name: metric.key,
+              purposes: ['thirdPartiesJs'],
+              required: false,
+            }
+          )
+        }
+      })
+    }
+
     const hideGoogleAnalytics$ = this.configService.findByPropertyName(this.GOOGLE_ANALYTICS_KEY).pipe(
       getFirstCompletedRemoteData(),
       map(remoteData => !remoteData.hasSucceeded || !remoteData.payload || isEmpty(remoteData.payload.values)),

src/app/shared/cookies/klaro-configuration.ts

@@ -135,21 +135,6 @@ export const klaroConfiguration: any = {
         HAS_AGREED_END_USER
       ]
     },
-    {
-      name: 'plumX',
-      purposes: ['thirdPartiesJs'],
-      required: false,
-    },
-    {
-      name: 'altmetric',
-      purposes: ['thirdPartiesJs'],
-      required: false,
-    },
-    {
-      name: 'dimensions',
-      purposes: ['thirdPartiesJs'],
-      required: false,
-    },
     {
       name: GOOGLE_ANALYTICS_KLARO_KEY,
       purposes: ['statistical'],

src/config/app-config.interface.ts

@@ -31,6 +31,7 @@ import { FollowAuthorityMetadata } from './search-follow-metadata.interface';
 import { AdvancedAttachmentRenderingConfig } from './advanced-attachment-rendering.config';
 import { AttachmentRenderingConfig } from './attachment-rendering.config';
 import { SearchResultConfig } from './search-result-config.interface';
+import { CookieConsents, ThirdPartyMetric } from "../app/shared/cookies/browser-klaro.service";
 
 interface AppConfig extends Config {
   ui: UIServerConfig;
@@ -68,6 +69,7 @@ interface AppConfig extends Config {
   attachmentRendering: AttachmentRenderingConfig;
   advancedAttachmentRendering: AdvancedAttachmentRenderingConfig;
   searchResult: SearchResultConfig;
+  metricsConsents: ThirdPartyMetric[];
 }
 
 /**

src/config/default-app-config.ts

@@ -34,6 +34,7 @@ import {
 } from './advanced-attachment-rendering.config';
 import { AttachmentRenderingConfig } from './attachment-rendering.config';
 import { SearchResultConfig } from './search-result-config.interface';
+import { CookieConsents, ThirdPartyMetric } from "../app/shared/cookies/browser-klaro.service";
 
 export class DefaultAppConfig implements AppConfig {
   production = false;
@@ -735,4 +736,20 @@ export class DefaultAppConfig implements AppConfig {
     additionalMetadataFields: [],
     authorMetadata: ['dc.contributor.author', 'dc.creator', 'dc.contributor.*'],
   };
+
+  //Configuration for third-party metrics in Klaro
+  metricsConsents: ThirdPartyMetric[] = [
+    {
+      key: 'plumX',
+      enabled: true
+    },
+    {
+      key: 'altmetric',
+      enabled: true
+    },
+    {
+      key: 'dimensions',
+      enabled: true
+    },
+  ];
 }

src/environments/environment.test.ts

@@ -3,6 +3,7 @@ import { BuildConfig } from 'src/config/build-config.interface';
 import { RestRequestMethod } from '../app/core/data/rest-request-method';
 import { NotificationAnimationsType } from '../app/shared/notifications/models/notification-animations-type';
 import { AdvancedAttachmentElementType } from '../config/advanced-attachment-rendering.config';
+import { ThirdPartyMetric } from "../app/shared/cookies/browser-klaro.service";
 
 export const environment: BuildConfig = {
   production: false,
@@ -553,4 +554,20 @@ export const environment: BuildConfig = {
     ],
     authorMetadata: ['dc.contributor.author', 'dc.contributor.editor', 'dc.contributor.contributor', 'dc.creator'],
   },
+
+  //Configuration for third-party metrics in Klaro
+  metricsConsents: [
+    {
+      key: 'plumX',
+      enabled: true
+    },
+    {
+      key: 'altmetric',
+      enabled: true
+    },
+    {
+      key: 'dimensions',
+      enabled: true
+    },
+  ],
 };