@guardian/commercial-core 3.2.1 → 3.5.0

package/dist/cjs/ad-sizes.d.ts

@@ -1,12 +1,30 @@
-export declare type AdSizeString = 'fluid' | `${number},${number}`;
-export declare type AdSize = Readonly<{
+declare type AdSizeString = 'fluid' | `${number},${number}`;
+declare type AdSize = Readonly<{
     width: number;
     height: number;
     toString: () => AdSizeString;
 }>;
-export declare type SizeKeys = '160x600' | '300x1050' | '300x250' | '300x600' | '728x90' | '970x250' | 'billboard' | 'empty' | 'fabric' | 'fluid' | 'googleCard' | 'halfPage' | 'inlineMerchandising' | 'leaderboard' | 'merchandising' | 'merchandisingHigh' | 'merchandisingHighAdFeature' | 'mobilesticky' | 'mpu' | 'outOfPage' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'portrait' | 'skyscraper';
-export declare const adSizes: Record<SizeKeys, AdSize>;
-export declare const getAdSize: (size: SizeKeys) => AdSize;
+declare type SizeKeys = '160x600' | '300x1050' | '300x250' | '300x600' | '728x90' | '970x250' | 'billboard' | 'empty' | 'fabric' | 'fluid' | 'googleCard' | 'halfPage' | 'inlineMerchandising' | 'leaderboard' | 'merchandising' | 'merchandisingHigh' | 'merchandisingHighAdFeature' | 'mobilesticky' | 'mpu' | 'outOfPage' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'portrait' | 'skyscraper';
+interface SizeMapping {
+    mobile?: AdSize[];
+    desktop?: AdSize[];
+    phablet?: AdSize[];
+    tablet?: AdSize[];
+}
+interface SizeMappings {
+    right: SizeMapping;
+    comments: SizeMapping;
+    'top-above-nav': SizeMapping;
+    mostpop: SizeMapping;
+    'merchandising-high': SizeMapping;
+    merchandising: SizeMapping;
+    survey: SizeMapping;
+}
+declare const adSizes: Record<SizeKeys, AdSize>;
+declare const sizeMappings: SizeMappings;
+declare const getAdSize: (size: SizeKeys) => AdSize;
 export declare const _: {
     createAdSize: (width: number, height: number) => AdSize;
 };
+export type { AdSizeString, AdSize, SizeKeys };
+export { adSizes, getAdSize, sizeMappings };

package/dist/cjs/ad-sizes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._ = exports.getAdSize = exports.adSizes = void 0;
+exports.sizeMappings = exports.getAdSize = exports.adSizes = exports._ = void 0;
 const createAdSize = (width, height) => {
     const toString = () => width === 0 && height === 0 ? 'fluid' : `${width},${height}`;
     return Object.freeze({
@@ -33,7 +33,7 @@ const adSizesPartial = {
     outstreamGoogleDesktop: createAdSize(550, 310),
     outstreamMobile: createAdSize(300, 197),
 };
-exports.adSizes = {
+const adSizes = {
     ...adSizesPartial,
     '970x250': adSizesPartial.billboard,
     '728x90': adSizesPartial.leaderboard,
@@ -42,7 +42,122 @@ exports.adSizes = {
     '300x1050': adSizesPartial.portrait,
     '160x600': adSizesPartial.skyscraper,
 };
-const getAdSize = (size) => exports.adSizes[size];
+exports.adSizes = adSizes;
+const sizeMappings = {
+    right: {
+        mobile: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.mpu,
+            adSizes.googleCard,
+            adSizes.halfPage,
+            adSizes.fluid,
+        ],
+    },
+    comments: {
+        mobile: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.halfPage,
+            adSizes.outstreamMobile,
+            adSizes.mpu,
+            adSizes.googleCard,
+            adSizes.fluid,
+        ],
+        desktop: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.mpu,
+            adSizes.googleCard,
+            adSizes.fluid,
+            adSizes.halfPage,
+            adSizes.skyscraper,
+        ],
+        phablet: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.outstreamMobile,
+            adSizes.mpu,
+            adSizes.googleCard,
+            adSizes.fluid,
+        ],
+    },
+    'top-above-nav': {
+        tablet: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.fabric,
+            adSizes.fluid,
+            adSizes.leaderboard,
+        ],
+        desktop: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.leaderboard,
+            createAdSize(940, 230),
+            createAdSize(900, 250),
+            adSizes.billboard,
+            adSizes.fabric,
+            adSizes.fluid,
+        ],
+    },
+    mostpop: {
+        mobile: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.mpu,
+            adSizes.googleCard,
+            adSizes.fluid,
+        ],
+        tablet: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.mpu,
+            adSizes.googleCard,
+            adSizes.halfPage,
+            adSizes.leaderboard,
+            adSizes.fluid,
+        ],
+        phablet: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.outstreamMobile,
+            adSizes.mpu,
+            adSizes.googleCard,
+            adSizes.halfPage,
+            adSizes.fluid,
+        ],
+        desktop: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.mpu,
+            adSizes.googleCard,
+            adSizes.halfPage,
+            adSizes.fluid,
+        ],
+    },
+    'merchandising-high': {
+        mobile: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.merchandisingHigh,
+            adSizes.fluid,
+        ],
+    },
+    merchandising: {
+        mobile: [
+            adSizes.outOfPage,
+            adSizes.empty,
+            adSizes.merchandising,
+            adSizes.fluid,
+        ],
+    },
+    survey: {
+        desktop: [adSizes.outOfPage],
+    },
+};
+exports.sizeMappings = sizeMappings;
+const getAdSize = (size) => adSizes[size];
 exports.getAdSize = getAdSize;
 // Export for testing
 exports._ = { createAdSize };

package/dist/cjs/constants/index.d.ts

@@ -1,2 +1,2 @@
-export { PREBID_TIMEOUT } from './prebidTimeout';
-export { TOP_ABOVE_NAV_HEIGHT } from './topAboveNavHeight';
+export { PREBID_TIMEOUT } from './prebid-timeout';
+export { TOP_ABOVE_NAV_HEIGHT } from './top-above-nav-height';

package/dist/cjs/constants/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TOP_ABOVE_NAV_HEIGHT = exports.PREBID_TIMEOUT = void 0;
-var prebidTimeout_1 = require("./prebidTimeout");
-Object.defineProperty(exports, "PREBID_TIMEOUT", { enumerable: true, get: function () { return prebidTimeout_1.PREBID_TIMEOUT; } });
-var topAboveNavHeight_1 = require("./topAboveNavHeight");
-Object.defineProperty(exports, "TOP_ABOVE_NAV_HEIGHT", { enumerable: true, get: function () { return topAboveNavHeight_1.TOP_ABOVE_NAV_HEIGHT; } });
+var prebid_timeout_1 = require("./prebid-timeout");
+Object.defineProperty(exports, "PREBID_TIMEOUT", { enumerable: true, get: function () { return prebid_timeout_1.PREBID_TIMEOUT; } });
+var top_above_nav_height_1 = require("./top-above-nav-height");
+Object.defineProperty(exports, "TOP_ABOVE_NAV_HEIGHT", { enumerable: true, get: function () { return top_above_nav_height_1.TOP_ABOVE_NAV_HEIGHT; } });

package/dist/cjs/{detectAdBlocker.d.ts → detect-ad-blocker.d.ts}

@@ -1,7 +1,8 @@
 /**
 Detect whether or not the user has an ad blocking extension enabled.
 A few ad blockers are not detectable with this approach e.g. Safari / Adblock
-Code inspired by just-detect-adblock's: https://git.io/JgL4L
+Code inspired by just-detect-adblock's:
+https://github.com/wmcmurray/just-detect-adblock/blob/master/src/helpers.js
 */
 /**
  * Determines whether or not the user has an ad blocking extension enabled.

package/dist/cjs/{detectAdBlocker.js → detect-ad-blocker.js}

@@ -2,7 +2,8 @@
 /**
 Detect whether or not the user has an ad blocking extension enabled.
 A few ad blockers are not detectable with this approach e.g. Safari / Adblock
-Code inspired by just-detect-adblock's: https://git.io/JgL4L
+Code inspired by just-detect-adblock's:
+https://github.com/wmcmurray/just-detect-adblock/blob/master/src/helpers.js
 */
 /*istanbul ignore file -- adElementBlocked can't be tested without patching each of the properties of
 HTMLElement.prototype that it accesses, defeating the purpose of the test! */

package/dist/cjs/{EventTimer.d.ts → event-timer.d.ts}

@@ -30,6 +30,7 @@ interface EventTimerProperties {
     adSlotsInline?: number;
     adSlotsTotal?: number;
     pageHeightVH?: number;
+    gpcSignal?: number;
     lazyLoadMarginPercent?: number;
 }
 export declare class EventTimer {
@@ -71,7 +72,7 @@ export declare class EventTimer {
      * @param {string} name - the property's name
      * @param {value} number - the property's value
      */
-    setProperty(name: 'adSlotsInline' | 'adSlotsTotal' | 'pageHeightVH' | 'lazyLoadMarginPercent', value: number): void;
+    setProperty(name: 'adSlotsInline' | 'adSlotsTotal' | 'pageHeightVH' | 'gpcSignal' | 'lazyLoadMarginPercent', value: number): void;
     /**
      * Creates a new performance mark
      * For slot events also ensures each TYPE of event event is marked only once for 'first'

package/dist/cjs/{EventTimer.js → event-timer.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventTimer = void 0;
-const GoogleAnalytics_1 = require("./GoogleAnalytics");
+const google_analytics_1 = require("./google-analytics");
 class Event {
     constructor(name, mark) {
         this.name = name;
@@ -165,7 +165,7 @@ class EventTimer {
         const gaEvent = this.gaConfig.logEvents.find((e) => e.timingVariable === eventName);
         if (gaEvent) {
             const labelToUse = gaEvent.timingLabel ?? label;
-            (0, GoogleAnalytics_1.trackEvent)('Commercial Events', gaEvent.timingVariable, labelToUse);
+            (0, google_analytics_1.trackEvent)('Commercial Events', gaEvent.timingVariable, labelToUse);
         }
     }
 }

package/dist/cjs/index.d.ts

@@ -4,14 +4,15 @@ export { fbPixel } from './third-party-tags/facebook-pixel';
 export { twitter } from './third-party-tags/twitter-uwt';
 export { inizio } from './third-party-tags/inizio';
 export { remarketing } from './third-party-tags/remarketing';
-export { EventTimer } from './EventTimer';
-export { bypassCommercialMetricsSampling, initCommercialMetrics, } from './sendCommercialMetrics';
+export { EventTimer } from './event-timer';
+export { bypassCommercialMetricsSampling, initCommercialMetrics, } from './send-commercial-metrics';
 export type { ThirdPartyTag } from './types';
-export { adSizes, getAdSize } from './ad-sizes';
+export { adSizes, getAdSize, sizeMappings } from './ad-sizes';
 export type { SizeKeys, AdSizeString, AdSize } from './ad-sizes';
-export { isAdBlockInUse } from './detectAdBlocker';
+export { isAdBlockInUse } from './detect-ad-blocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';
 export { initTrackScrollDepth } from './track-scroll-depth';
+export { initTrackGpcSignal } from './track-gpc-signal';
 export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';
 export type { AdsConfig, AdsConfigBasic, AdsConfigDisabled, AdTargetingBuilder, CustomParams, } from './types';
 export * as constants from './constants';

package/dist/cjs/index.js

@@ -2,7 +2,11 @@
 /* istanbul ignore file -- there's no point check this for test coverage */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -20,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.getAdSize = exports.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.fbPixel = exports.permutive = exports.ias = void 0;
+exports.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackGpcSignal = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.sizeMappings = exports.getAdSize = exports.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.fbPixel = exports.permutive = exports.ias = void 0;
 var ias_1 = require("./third-party-tags/ias");
 Object.defineProperty(exports, "ias", { enumerable: true, get: function () { return ias_1.ias; } });
 var permutive_1 = require("./third-party-tags/permutive");
@@ -33,22 +37,25 @@ var inizio_1 = require("./third-party-tags/inizio");
 Object.defineProperty(exports, "inizio", { enumerable: true, get: function () { return inizio_1.inizio; } });
 var remarketing_1 = require("./third-party-tags/remarketing");
 Object.defineProperty(exports, "remarketing", { enumerable: true, get: function () { return remarketing_1.remarketing; } });
-var EventTimer_1 = require("./EventTimer");
-Object.defineProperty(exports, "EventTimer", { enumerable: true, get: function () { return EventTimer_1.EventTimer; } });
-var sendCommercialMetrics_1 = require("./sendCommercialMetrics");
-Object.defineProperty(exports, "bypassCommercialMetricsSampling", { enumerable: true, get: function () { return sendCommercialMetrics_1.bypassCommercialMetricsSampling; } });
-Object.defineProperty(exports, "initCommercialMetrics", { enumerable: true, get: function () { return sendCommercialMetrics_1.initCommercialMetrics; } });
+var event_timer_1 = require("./event-timer");
+Object.defineProperty(exports, "EventTimer", { enumerable: true, get: function () { return event_timer_1.EventTimer; } });
+var send_commercial_metrics_1 = require("./send-commercial-metrics");
+Object.defineProperty(exports, "bypassCommercialMetricsSampling", { enumerable: true, get: function () { return send_commercial_metrics_1.bypassCommercialMetricsSampling; } });
+Object.defineProperty(exports, "initCommercialMetrics", { enumerable: true, get: function () { return send_commercial_metrics_1.initCommercialMetrics; } });
 var ad_sizes_1 = require("./ad-sizes");
 Object.defineProperty(exports, "adSizes", { enumerable: true, get: function () { return ad_sizes_1.adSizes; } });
 Object.defineProperty(exports, "getAdSize", { enumerable: true, get: function () { return ad_sizes_1.getAdSize; } });
-var detectAdBlocker_1 = require("./detectAdBlocker");
-Object.defineProperty(exports, "isAdBlockInUse", { enumerable: true, get: function () { return detectAdBlocker_1.isAdBlockInUse; } });
+Object.defineProperty(exports, "sizeMappings", { enumerable: true, get: function () { return ad_sizes_1.sizeMappings; } });
+var detect_ad_blocker_1 = require("./detect-ad-blocker");
+Object.defineProperty(exports, "isAdBlockInUse", { enumerable: true, get: function () { return detect_ad_blocker_1.isAdBlockInUse; } });
 var permutive_2 = require("./permutive");
 Object.defineProperty(exports, "clearPermutiveSegments", { enumerable: true, get: function () { return permutive_2.clearPermutiveSegments; } });
 Object.defineProperty(exports, "getPermutiveSegments", { enumerable: true, get: function () { return permutive_2.getPermutiveSegments; } });
 Object.defineProperty(exports, "getPermutivePFPSegments", { enumerable: true, get: function () { return permutive_2.getPermutivePFPSegments; } });
 var track_scroll_depth_1 = require("./track-scroll-depth");
 Object.defineProperty(exports, "initTrackScrollDepth", { enumerable: true, get: function () { return track_scroll_depth_1.initTrackScrollDepth; } });
+var track_gpc_signal_1 = require("./track-gpc-signal");
+Object.defineProperty(exports, "initTrackGpcSignal", { enumerable: true, get: function () { return track_gpc_signal_1.initTrackGpcSignal; } });
 var ad_targeting_youtube_1 = require("./ad-targeting-youtube");
 Object.defineProperty(exports, "buildAdsConfigWithConsent", { enumerable: true, get: function () { return ad_targeting_youtube_1.buildAdsConfigWithConsent; } });
 Object.defineProperty(exports, "disabledAds", { enumerable: true, get: function () { return ad_targeting_youtube_1.disabledAds; } });

package/dist/cjs/permutive.d.ts

@@ -1,8 +1,9 @@
-export declare const getPermutiveSegments: () => string[];
-export declare const getPermutivePFPSegments: () => string[];
-export declare const clearPermutiveSegments: () => void;
+declare const getPermutiveSegments: () => string[];
+declare const getPermutivePFPSegments: () => string[];
+declare const clearPermutiveSegments: () => void;
 export declare const _: {
     PERMUTIVE_KEY: string;
     PERMUTIVE_PFP_KEY: string;
     getSegments: (key: string) => string[];
 };
+export { getPermutiveSegments, getPermutivePFPSegments, clearPermutiveSegments, };

package/dist/cjs/permutive.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._ = exports.clearPermutiveSegments = exports.getPermutivePFPSegments = exports.getPermutiveSegments = void 0;
+exports.clearPermutiveSegments = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports._ = void 0;
 const libs_1 = require("@guardian/libs");
 const PERMUTIVE_KEY = `_papns`;
 const PERMUTIVE_PFP_KEY = `_pdfps`;

package/dist/{esm/sendCommercialMetrics.d.ts → cjs/send-commercial-metrics.d.ts}

@@ -22,7 +22,7 @@ declare enum Endpoints {
 /**
  * A method to asynchronously send metrics after initialization.
  */
-export declare function bypassCommercialMetricsSampling(): void;
+declare function bypassCommercialMetricsSampling(): Promise<void>;
 interface InitCommercialMetricsArgs {
     pageViewId: string;
     browserId: string | undefined;
@@ -38,14 +38,14 @@ interface InitCommercialMetricsArgs {
  * @param init.adBlockerInUse - indicates whether or not an adblocker is being used.
  * @param init.sampling - rate at which to sample commercial metrics - the default is to send for 1% of pageviews
  */
-export declare function initCommercialMetrics({ pageViewId, browserId, isDev, adBlockerInUse, sampling, }: InitCommercialMetricsArgs): boolean;
+declare function initCommercialMetrics({ pageViewId, browserId, isDev, adBlockerInUse, sampling, }: InitCommercialMetricsArgs): Promise<boolean>;
 export declare const _: {
     Endpoints: typeof Endpoints;
     setEndpoint: (isDev: boolean) => Endpoints;
-    filterUndefinedProperties: <T>(transformedProperties: [string, T | undefined][]) => [string, T][];
     mapEventTimerPropertiesToString: (properties: Array<[string, string | number]>) => Property[];
     roundTimeStamp: (events: TimedEvent[]) => Metric[];
     transformToObjectEntries: (eventTimerProperties: EventProperties) => Array<[string, string | number | undefined]>;
     reset: () => void;
 };
 export type { Property, TimedEvent, Metric };
+export { bypassCommercialMetricsSampling, initCommercialMetrics };

package/dist/cjs/{sendCommercialMetrics.js → send-commercial-metrics.js}

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._ = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = void 0;
+exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports._ = void 0;
+const consent_management_platform_1 = require("@guardian/consent-management-platform");
 const libs_1 = require("@guardian/libs");
-const EventTimer_1 = require("./EventTimer");
+const event_timer_1 = require("./event-timer");
 var Endpoints;
 (function (Endpoints) {
     Endpoints["CODE"] = "//performance-events.code.dev-guardianapis.com/commercial-metrics";
@@ -38,12 +39,6 @@ const transformToObjectEntries = (eventTimerProperties) => {
     // Transforms object {key: value} pairs into an array of [key, value] arrays
     return Object.entries(eventTimerProperties);
 };
-const filterUndefinedProperties = (transformedProperties) => transformedProperties.reduce((acc, [key, value]) => {
-    if (typeof value !== 'undefined') {
-        acc.push([key, value]);
-    }
-    return acc;
-}, []);
 const mapEventTimerPropertiesToString = (properties) => {
     return properties.map(([name, value]) => ({
         name: String(name),
@@ -62,9 +57,9 @@ function sendMetrics() {
 }
 function gatherMetricsOnPageUnload() {
     // Assemble commercial properties and metrics
-    const eventTimer = EventTimer_1.EventTimer.get();
+    const eventTimer = event_timer_1.EventTimer.get();
     const transformedEntries = transformToObjectEntries(eventTimer.properties);
-    const filteredEventTimerProperties = filterUndefinedProperties(transformedEntries);
+    const filteredEventTimerProperties = transformedEntries.filter((item) => typeof item[1] !== 'undefined');
     const mappedEventTimerProperties = mapEventTimerPropertiesToString(filteredEventTimerProperties);
     const properties = mappedEventTimerProperties
         .concat(devProperties)
@@ -92,15 +87,32 @@ const addVisibilityListeners = () => {
     // Safari does not reliably fire the `visibilitychange` on page unload.
     window.addEventListener('pagehide', listener);
 };
+const checkConsent = async () => {
+    const consentState = await (0, consent_management_platform_1.onConsent)();
+    if (consentState.tcfv2) {
+        // TCFv2 mode - check for consent
+        const consents = consentState.tcfv2.consents;
+        const REQUIRED_CONSENTS = [7, 8];
+        return REQUIRED_CONSENTS.every((consent) => consents[consent]);
+    }
+    // non-TCFv2 mode - don't check for consent
+    return true;
+};
 /**
  * A method to asynchronously send metrics after initialization.
  */
-function bypassCommercialMetricsSampling() {
+async function bypassCommercialMetricsSampling() {
     if (!initialised) {
         console.warn('initCommercialMetrics not yet initialised');
         return;
     }
-    addVisibilityListeners();
+    const consented = await checkConsent();
+    if (consented) {
+        addVisibilityListeners();
+    }
+    else {
+        (0, libs_1.log)('commercial', "Metrics won't be sent because consent wasn't given");
+    }
 }
 exports.bypassCommercialMetricsSampling = bypassCommercialMetricsSampling;
 /**
@@ -111,7 +123,7 @@ exports.bypassCommercialMetricsSampling = bypassCommercialMetricsSampling;
  * @param init.adBlockerInUse - indicates whether or not an adblocker is being used.
  * @param init.sampling - rate at which to sample commercial metrics - the default is to send for 1% of pageviews
  */
-function initCommercialMetrics({ pageViewId, browserId, isDev, adBlockerInUse, sampling = 1 / 100, }) {
+async function initCommercialMetrics({ pageViewId, browserId, isDev, adBlockerInUse, sampling = 1 / 100, }) {
     commercialMetricsPayload.page_view_id = pageViewId;
     commercialMetricsPayload.browser_id = browserId;
     setEndpoint(isDev);
@@ -123,8 +135,14 @@ function initCommercialMetrics({ pageViewId, browserId, isDev, adBlockerInUse, s
     initialised = true;
     const userIsInSamplingGroup = Math.random() <= sampling;
     if (isDev || userIsInSamplingGroup) {
-        addVisibilityListeners();
-        return true;
+        const consented = await checkConsent();
+        if (consented) {
+            addVisibilityListeners();
+            return true;
+        }
+        else {
+            (0, libs_1.log)('commercial', "Metrics won't be sent because consent wasn't given");
+        }
     }
     return false;
 }
@@ -132,7 +150,6 @@ exports.initCommercialMetrics = initCommercialMetrics;
 exports._ = {
     Endpoints,
     setEndpoint,
-    filterUndefinedProperties,
     mapEventTimerPropertiesToString,
     roundTimeStamp,
     transformToObjectEntries,

package/dist/cjs/targeting/content.d.ts

@@ -12,7 +12,7 @@ declare const videoLengths: readonly ["25", "30", "60", "90", "120", "150", "180
  * - a surge in page views per minute
  *
  */
-export declare type ContentTargeting = {
+declare type ContentTargeting = {
     /**
      * **D**ot**c**om-**r**endering **E**ligible - [see on Ad Manager][gam]
      *
@@ -66,5 +66,6 @@ declare type Content = {
     sensitive: boolean;
     videoLength?: number;
 };
-export declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }: Content) => ContentTargeting;
-export {};
+declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }: Content) => ContentTargeting;
+export { getContentTargeting };
+export type { ContentTargeting };

package/dist/cjs/targeting/personalised.d.ts

@@ -10,7 +10,7 @@ declare type AdManagerGroup = typeof adManagerGroups[number];
  * It allows or prevents personalised advertising, restrict data processing
  * and handles access to cookies and local storage
  */
-export declare type PersonalisedTargeting = {
+declare type PersonalisedTargeting = {
     /**
      * **A**d **M**anager **T**argeting **Gr**ou**p** – [see on Ad Manager][gam]
      *
@@ -76,3 +76,4 @@ export declare type PersonalisedTargeting = {
 };
 declare const getPersonalisedTargeting: (state: ConsentState) => PersonalisedTargeting;
 export { getPersonalisedTargeting };
+export type { PersonalisedTargeting };

package/dist/cjs/targeting/session.d.ts

@@ -22,7 +22,7 @@ declare const referrers: readonly [{
  * These values identify a browser session are either generated client-side,
  * read from a cookie or passed down from the server.
  */
-export declare type SessionTargeting = {
+declare type SessionTargeting = {
     /**
      * **AB** Tests – [see on Ad Manager][gam]
      *
@@ -90,7 +90,7 @@ export declare type SessionTargeting = {
      */
     si: True | False;
 };
-export declare type AllParticipations = {
+declare type AllParticipations = {
     clientSideParticipations: Participations;
     serverSideParticipations: {
         [key: `${string}Control`]: 'control';
@@ -105,5 +105,6 @@ declare type Session = {
     participations: AllParticipations;
     referrer: string;
 };
-export declare const getSessionTargeting: ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
-export {};
+declare const getSessionTargeting: ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
+export type { SessionTargeting, AllParticipations };
+export { getSessionTargeting };

package/dist/cjs/targeting/shared.d.ts

@@ -25,14 +25,16 @@ declare const surges: {
     readonly 400: "1";
 };
 /**
- * Shared Targeting is passed by `frontend` https://git.io/JDJ6W
+ * Shared Targeting is passed by `frontend`:
+ * https://github.com/guardian/frontend/blob/5b970cd7308175cfc1bcae2d4fb8c06ee13c5fa0/common/app/common/commercial/EditionAdTargeting.scala
  *
- * It is generated in `commercial-shared` https://git.io/JDJ62
+ * It is generated in `commercial-shared`:
+ * https://github.com/guardian/commercial-shared/blob/a692e8b2eba6e79eeeb666e5594f2193663f6514/src/main/scala/com/gu/commercial/display/AdTargetParam.scala
  *
  *
  *
  */
-export declare type SharedTargeting = {
+declare type SharedTargeting = {
     /**
      * **Bl**og tags – [see on Ad Manager][gam]
      *
@@ -135,8 +137,9 @@ export declare type SharedTargeting = {
 /**
  * What goes in comes out
  */
-export declare const getSharedTargeting: (shared: Partial<SharedTargeting>) => Partial<SharedTargeting>;
+declare const getSharedTargeting: (shared: Partial<SharedTargeting>) => Partial<SharedTargeting>;
 export declare const _: {
     getSurgingParam: (surging: number) => SharedTargeting['su'];
 };
-export {};
+export type { SharedTargeting };
+export { getSharedTargeting };

package/dist/cjs/targeting/shared.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._ = exports.getSharedTargeting = void 0;
+exports.getSharedTargeting = exports._ = void 0;
 const pick_targeting_values_1 = require("./pick-targeting-values");
 /* -- Types -- */
 const brands = {

package/dist/cjs/targeting/viewport.d.ts

@@ -7,7 +7,7 @@ import type { False, True } from '../types';
  * - whether a CMP banner will show
  * - size of page skin
  */
-export declare type ViewportTargeting = {
+declare type ViewportTargeting = {
     /**
      * **B**reak**p**oint – [see on Ad Manager][gam]
      *
@@ -43,5 +43,6 @@ declare type Viewport = {
     viewPortWidth: number;
     cmpBannerWillShow: boolean;
 };
-export declare const getViewportTargeting: ({ viewPortWidth, cmpBannerWillShow, }: Viewport) => ViewportTargeting;
-export {};
+declare const getViewportTargeting: ({ viewPortWidth, cmpBannerWillShow, }: Viewport) => ViewportTargeting;
+export type { ViewportTargeting };
+export { getViewportTargeting };

package/dist/cjs/track-gpc-signal.d.ts

@@ -0,0 +1,7 @@
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
+/**
+ * Collect metrics on gpcSignal presence and value
+ * https://globalprivacycontrol.github.io/gpc-spec/
+ */
+declare const initTrackGpcSignal: (consentState: ConsentState) => void;
+export { initTrackGpcSignal };