@guardian/commercial-core 4.11.1 → 4.13.0

package/dist/cjs/create-ad-slot.js

@@ -50,7 +50,7 @@ const adSlotConfigs = {
 const createAdSlotElement = (name, attrs, classes) => {
     const id = `${adSlotIdPrefix}${name}`;
     // 3562dc07-78e9-4507-b922-78b979d4c5cb
-    if (window.guardian.config?.isDotcomRendering && name === 'top-above-nav') {
+    if (window.guardian.config.isDotcomRendering && name === 'top-above-nav') {
         // This is to prevent a problem that appeared with DCR.
         // We are simply making sure that if we are about to
         // introduce dfp-ad--top-above-nav then there isn't already one.

package/dist/cjs/global.d.ts

@@ -16,7 +16,7 @@ declare global {
         }>;
         guardian: {
             commercialTimer?: EventTimer;
-            config?: GuardianWindowConfig;
+            config: GuardianWindowConfig;
         };
         ga: UniversalAnalytics.ga | null;
         readonly navigator: Navigator;

package/dist/cjs/google-analytics.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.trackEvent = void 0;
 const trackEvent = (timingCategory, timingVar, timingLabel) => {
     const { ga, guardian } = window;
-    const trackerName = guardian.config?.googleAnalytics?.trackers.editorial;
+    const trackerName = guardian.config.googleAnalytics?.trackers.editorial;
     if (typeof ga !== 'function') {
         return;
     }

package/dist/cjs/index.d.ts

@@ -34,3 +34,5 @@ export { pickTargetingValues } from './targeting/pick-targeting-values';
 export { init as initMessenger } from './messenger';
 export type { RegisterListener, RegisterPersistentListener, RespondProxy, } from './messenger';
 export { postMessage } from './messenger/post-message';
+export { buildPageTargeting } from './targeting/build-page-targeting';
+export type { PageTargeting } from './targeting/build-page-targeting';

package/dist/cjs/index.js

@@ -24,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.postMessage = exports.initMessenger = exports.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.concatSizeMappings = exports.createAdSlot = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackGpcSignal = exports.initTrackLabsContainer = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.isBreakpoint = exports.createAdSize = exports.slotSizeMappings = 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.buildPageTargeting = exports.postMessage = exports.initMessenger = exports.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.concatSizeMappings = exports.createAdSlot = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackGpcSignal = exports.initTrackLabsContainer = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.isBreakpoint = exports.createAdSize = exports.slotSizeMappings = 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");
@@ -84,3 +84,5 @@ var messenger_1 = require("./messenger");
 Object.defineProperty(exports, "initMessenger", { enumerable: true, get: function () { return messenger_1.init; } });
 var post_message_1 = require("./messenger/post-message");
 Object.defineProperty(exports, "postMessage", { enumerable: true, get: function () { return post_message_1.postMessage; } });
+var build_page_targeting_1 = require("./targeting/build-page-targeting");
+Object.defineProperty(exports, "buildPageTargeting", { enumerable: true, get: function () { return build_page_targeting_1.buildPageTargeting; } });

package/dist/cjs/targeting/build-page-targeting.d.ts

@@ -0,0 +1,39 @@
+import type { Participations } from '@guardian/ab-core';
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
+import type { CountryCode } from '@guardian/libs';
+import type { False, True } from '../types';
+import type { AdManagerGroup, Frequency } from './personalised';
+import type { SharedTargeting } from './shared';
+declare type PartialWithNulls<T> = {
+    [P in keyof T]?: T[P] | null;
+};
+declare type TrueOrFalse = True | False;
+declare type PageTargeting = PartialWithNulls<{
+    ab: string[];
+    af: 't';
+    amtgrp: AdManagerGroup;
+    at: string;
+    bp: 'mobile' | 'tablet' | 'desktop';
+    cc: CountryCode;
+    cmp_interaction: string;
+    consent_tcfv2: string;
+    dcre: TrueOrFalse;
+    fr: Frequency;
+    inskin: TrueOrFalse;
+    pa: TrueOrFalse;
+    permutive: string[];
+    pv: string;
+    rdp: string;
+    ref: string;
+    rp: 'dotcom-rendering' | 'dotcom-platform';
+    s: string;
+    sens: TrueOrFalse;
+    si: TrueOrFalse;
+    skinsize: 'l' | 's';
+    urlkw: string[];
+    vl: string;
+    [_: string]: string | string[];
+} & SharedTargeting>;
+declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean, countryCode: CountryCode, clientSideParticipations: Participations) => PageTargeting;
+export { buildPageTargeting };
+export type { PageTargeting };

package/dist/cjs/targeting/build-page-targeting.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildPageTargeting = void 0;
+const consent_management_platform_1 = require("@guardian/consent-management-platform");
+const libs_1 = require("@guardian/libs");
+const content_1 = require("./content");
+const personalised_1 = require("./personalised");
+const session_1 = require("./session");
+const shared_1 = require("./shared");
+const viewport_1 = require("./viewport");
+const filterEmptyValues = (pageTargets) => {
+    const filtered = {};
+    for (const key in pageTargets) {
+        const value = pageTargets[key];
+        if ((0, libs_1.isString)(value)) {
+            filtered[key] = value;
+        }
+        else if (Array.isArray(value) &&
+            value.length > 0 &&
+            value.every(libs_1.isString)) {
+            filtered[key] = value;
+        }
+    }
+    return filtered;
+};
+const buildPageTargeting = (consentState, adFree, countryCode, clientSideParticipations) => {
+    const { page, isDotcomRendering } = window.guardian.config;
+    const adFreeTargeting = adFree ? { af: 't' } : {};
+    const contentTargeting = (0, content_1.getContentTargeting)({
+        eligibleForDCR: isDotcomRendering,
+        path: `/${page.pageId}`,
+        renderingPlatform: isDotcomRendering
+            ? 'dotcom-rendering'
+            : 'dotcom-platform',
+        section: page.section,
+        sensitive: page.isSensitive,
+        videoLength: page.videoDuration,
+    });
+    const getReferrer = () => document.referrer || '';
+    const sessionTargeting = (0, session_1.getSessionTargeting)({
+        adTest: (0, libs_1.getCookie)({ name: 'adtest', shouldMemoize: true }),
+        countryCode,
+        isSignedIn: !!(0, libs_1.getCookie)({ name: 'GU_U' }),
+        pageViewId: window.guardian.config.ophan.pageViewId,
+        participations: {
+            clientSideParticipations,
+            serverSideParticipations: window.guardian.config.tests ?? {},
+        },
+        referrer: getReferrer(),
+    });
+    const getViewport = () => {
+        return {
+            width: window.innerWidth || document.body.clientWidth || 0,
+            height: window.innerHeight || document.body.clientHeight || 0,
+        };
+    };
+    const viewportTargeting = (0, viewport_1.getViewportTargeting)({
+        viewPortWidth: getViewport().width,
+        cmpBannerWillShow: !consent_management_platform_1.cmp.hasInitialised() || consent_management_platform_1.cmp.willShowPrivacyMessageSync(),
+    });
+    const sharedAdTargeting = page.sharedAdTargeting
+        ? (0, shared_1.getSharedTargeting)(page.sharedAdTargeting)
+        : {};
+    const personalisedTargeting = (0, personalised_1.getPersonalisedTargeting)(consentState);
+    const pageTargets = {
+        ...personalisedTargeting,
+        ...sharedAdTargeting,
+        ...adFreeTargeting,
+        ...contentTargeting,
+        ...sessionTargeting,
+        ...viewportTargeting,
+    };
+    // filter out empty values
+    const pageTargeting = filterEmptyValues(pageTargets);
+    return pageTargeting;
+};
+exports.buildPageTargeting = buildPageTargeting;

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

@@ -2,6 +2,7 @@ import type { ConsentState } from '@guardian/consent-management-platform/dist/ty
 import type { TCEventStatusCode } from '@guardian/consent-management-platform/dist/types/tcfv2';
 import type { False, NotApplicable, True } from '../types';
 declare const frequency: readonly ["0", "1", "2", "3", "4", "5", "6-9", "10-15", "16-19", "20-29", "30plus"];
+declare type Frequency = typeof frequency[number];
 declare const adManagerGroups: readonly ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12"];
 declare type AdManagerGroup = typeof adManagerGroups[number];
 /**
@@ -46,7 +47,7 @@ declare type PersonalisedTargeting = {
      *
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=214647
      */
-    fr: typeof frequency[number];
+    fr: Frequency;
     /**
      * **P**ersonalised **A**ds Consent – [see on Ad Manager][gam]
      *
@@ -76,4 +77,4 @@ declare type PersonalisedTargeting = {
 };
 declare const getPersonalisedTargeting: (state: ConsentState) => PersonalisedTargeting;
 export { getPersonalisedTargeting };
-export type { PersonalisedTargeting };
+export type { PersonalisedTargeting, AdManagerGroup, Frequency };

package/dist/cjs/types.d.ts

@@ -23,7 +23,23 @@ export declare type GuardianAnalyticsConfig = {
 };
 export declare type GuardianWindowConfig = {
     googleAnalytics?: GuardianAnalyticsConfig;
-    isDotcomRendering?: boolean;
+    isDotcomRendering: boolean;
+    ophan: {
+        pageViewId: string;
+        browserId?: string;
+    };
+    page: {
+        sharedAdTargeting?: Record<string, string | string[]>;
+        pageAdTargeting?: Record<string, string | string[]>;
+        isSensitive: boolean;
+        pageId: string;
+        section: string;
+        videoDuration: number;
+    };
+    tests?: {
+        [key: `${string}Control`]: 'control';
+        [key: `${string}Variant`]: 'variant';
+    };
 };
 export declare type GoogleTagParams = unknown;
 export declare type GoogleTrackConversionObject = {

package/dist/esm/create-ad-slot.js

@@ -47,7 +47,7 @@ const adSlotConfigs = {
 const createAdSlotElement = (name, attrs, classes) => {
     const id = `${adSlotIdPrefix}${name}`;
     // 3562dc07-78e9-4507-b922-78b979d4c5cb
-    if (window.guardian.config?.isDotcomRendering && name === 'top-above-nav') {
+    if (window.guardian.config.isDotcomRendering && name === 'top-above-nav') {
         // This is to prevent a problem that appeared with DCR.
         // We are simply making sure that if we are about to
         // introduce dfp-ad--top-above-nav then there isn't already one.

package/dist/esm/global.d.ts

@@ -16,7 +16,7 @@ declare global {
         }>;
         guardian: {
             commercialTimer?: EventTimer;
-            config?: GuardianWindowConfig;
+            config: GuardianWindowConfig;
         };
         ga: UniversalAnalytics.ga | null;
         readonly navigator: Navigator;

package/dist/esm/google-analytics.js

@@ -1,6 +1,6 @@
 export const trackEvent = (timingCategory, timingVar, timingLabel) => {
     const { ga, guardian } = window;
-    const trackerName = guardian.config?.googleAnalytics?.trackers.editorial;
+    const trackerName = guardian.config.googleAnalytics?.trackers.editorial;
     if (typeof ga !== 'function') {
         return;
     }

package/dist/esm/index.d.ts

@@ -34,3 +34,5 @@ export { pickTargetingValues } from './targeting/pick-targeting-values';
 export { init as initMessenger } from './messenger';
 export type { RegisterListener, RegisterPersistentListener, RespondProxy, } from './messenger';
 export { postMessage } from './messenger/post-message';
+export { buildPageTargeting } from './targeting/build-page-targeting';
+export type { PageTargeting } from './targeting/build-page-targeting';

package/dist/esm/index.js

@@ -26,3 +26,4 @@ export { getViewportTargeting } from './targeting/viewport';
 export { pickTargetingValues } from './targeting/pick-targeting-values';
 export { init as initMessenger } from './messenger';
 export { postMessage } from './messenger/post-message';
+export { buildPageTargeting } from './targeting/build-page-targeting';

package/dist/esm/targeting/build-page-targeting.d.ts

@@ -0,0 +1,39 @@
+import type { Participations } from '@guardian/ab-core';
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
+import type { CountryCode } from '@guardian/libs';
+import type { False, True } from '../types';
+import type { AdManagerGroup, Frequency } from './personalised';
+import type { SharedTargeting } from './shared';
+declare type PartialWithNulls<T> = {
+    [P in keyof T]?: T[P] | null;
+};
+declare type TrueOrFalse = True | False;
+declare type PageTargeting = PartialWithNulls<{
+    ab: string[];
+    af: 't';
+    amtgrp: AdManagerGroup;
+    at: string;
+    bp: 'mobile' | 'tablet' | 'desktop';
+    cc: CountryCode;
+    cmp_interaction: string;
+    consent_tcfv2: string;
+    dcre: TrueOrFalse;
+    fr: Frequency;
+    inskin: TrueOrFalse;
+    pa: TrueOrFalse;
+    permutive: string[];
+    pv: string;
+    rdp: string;
+    ref: string;
+    rp: 'dotcom-rendering' | 'dotcom-platform';
+    s: string;
+    sens: TrueOrFalse;
+    si: TrueOrFalse;
+    skinsize: 'l' | 's';
+    urlkw: string[];
+    vl: string;
+    [_: string]: string | string[];
+} & SharedTargeting>;
+declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean, countryCode: CountryCode, clientSideParticipations: Participations) => PageTargeting;
+export { buildPageTargeting };
+export type { PageTargeting };

package/dist/esm/targeting/build-page-targeting.js

@@ -0,0 +1,74 @@
+import { cmp } from '@guardian/consent-management-platform';
+import { getCookie, isString } from '@guardian/libs';
+import { getContentTargeting } from './content';
+import { getPersonalisedTargeting } from './personalised';
+import { getSessionTargeting } from './session';
+import { getSharedTargeting } from './shared';
+import { getViewportTargeting } from './viewport';
+const filterEmptyValues = (pageTargets) => {
+    const filtered = {};
+    for (const key in pageTargets) {
+        const value = pageTargets[key];
+        if (isString(value)) {
+            filtered[key] = value;
+        }
+        else if (Array.isArray(value) &&
+            value.length > 0 &&
+            value.every(isString)) {
+            filtered[key] = value;
+        }
+    }
+    return filtered;
+};
+const buildPageTargeting = (consentState, adFree, countryCode, clientSideParticipations) => {
+    const { page, isDotcomRendering } = window.guardian.config;
+    const adFreeTargeting = adFree ? { af: 't' } : {};
+    const contentTargeting = getContentTargeting({
+        eligibleForDCR: isDotcomRendering,
+        path: `/${page.pageId}`,
+        renderingPlatform: isDotcomRendering
+            ? 'dotcom-rendering'
+            : 'dotcom-platform',
+        section: page.section,
+        sensitive: page.isSensitive,
+        videoLength: page.videoDuration,
+    });
+    const getReferrer = () => document.referrer || '';
+    const sessionTargeting = getSessionTargeting({
+        adTest: getCookie({ name: 'adtest', shouldMemoize: true }),
+        countryCode,
+        isSignedIn: !!getCookie({ name: 'GU_U' }),
+        pageViewId: window.guardian.config.ophan.pageViewId,
+        participations: {
+            clientSideParticipations,
+            serverSideParticipations: window.guardian.config.tests ?? {},
+        },
+        referrer: getReferrer(),
+    });
+    const getViewport = () => {
+        return {
+            width: window.innerWidth || document.body.clientWidth || 0,
+            height: window.innerHeight || document.body.clientHeight || 0,
+        };
+    };
+    const viewportTargeting = getViewportTargeting({
+        viewPortWidth: getViewport().width,
+        cmpBannerWillShow: !cmp.hasInitialised() || cmp.willShowPrivacyMessageSync(),
+    });
+    const sharedAdTargeting = page.sharedAdTargeting
+        ? getSharedTargeting(page.sharedAdTargeting)
+        : {};
+    const personalisedTargeting = getPersonalisedTargeting(consentState);
+    const pageTargets = {
+        ...personalisedTargeting,
+        ...sharedAdTargeting,
+        ...adFreeTargeting,
+        ...contentTargeting,
+        ...sessionTargeting,
+        ...viewportTargeting,
+    };
+    // filter out empty values
+    const pageTargeting = filterEmptyValues(pageTargets);
+    return pageTargeting;
+};
+export { buildPageTargeting };

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

@@ -2,6 +2,7 @@ import type { ConsentState } from '@guardian/consent-management-platform/dist/ty
 import type { TCEventStatusCode } from '@guardian/consent-management-platform/dist/types/tcfv2';
 import type { False, NotApplicable, True } from '../types';
 declare const frequency: readonly ["0", "1", "2", "3", "4", "5", "6-9", "10-15", "16-19", "20-29", "30plus"];
+declare type Frequency = typeof frequency[number];
 declare const adManagerGroups: readonly ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12"];
 declare type AdManagerGroup = typeof adManagerGroups[number];
 /**
@@ -46,7 +47,7 @@ declare type PersonalisedTargeting = {
      *
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=214647
      */
-    fr: typeof frequency[number];
+    fr: Frequency;
     /**
      * **P**ersonalised **A**ds Consent – [see on Ad Manager][gam]
      *
@@ -76,4 +77,4 @@ declare type PersonalisedTargeting = {
 };
 declare const getPersonalisedTargeting: (state: ConsentState) => PersonalisedTargeting;
 export { getPersonalisedTargeting };
-export type { PersonalisedTargeting };
+export type { PersonalisedTargeting, AdManagerGroup, Frequency };

package/dist/esm/types.d.ts

@@ -23,7 +23,23 @@ export declare type GuardianAnalyticsConfig = {
 };
 export declare type GuardianWindowConfig = {
     googleAnalytics?: GuardianAnalyticsConfig;
-    isDotcomRendering?: boolean;
+    isDotcomRendering: boolean;
+    ophan: {
+        pageViewId: string;
+        browserId?: string;
+    };
+    page: {
+        sharedAdTargeting?: Record<string, string | string[]>;
+        pageAdTargeting?: Record<string, string | string[]>;
+        isSensitive: boolean;
+        pageId: string;
+        section: string;
+        videoDuration: number;
+    };
+    tests?: {
+        [key: `${string}Control`]: 'control';
+        [key: `${string}Variant`]: 'variant';
+    };
 };
 export declare type GoogleTagParams = unknown;
 export declare type GoogleTrackConversionObject = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "4.11.1",
+  "version": "4.13.0",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial-core#readme",
   "bugs": {