@guardian/commercial-core 0.27.0 → 0.31.0

package/dist/cjs/targeting/session.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSessionTargeting = void 0;
+const libs_1 = require("@guardian/libs");
+/* -- Types -- */
+const referrers = [
+    {
+        id: 'facebook',
+        match: 'facebook.com',
+    },
+    {
+        id: 'google',
+        match: 'www.google',
+    },
+    {
+        id: 'twitter',
+        match: '/t.co/',
+    },
+    {
+        id: 'reddit',
+        match: 'reddit.com',
+    },
+];
+/* -- Methods -- */
+const getReferrer = (referrer) => {
+    if (referrer === '')
+        return null;
+    const matchedRef = referrers.find((referrerType) => referrer.includes(referrerType.match)) ?? null;
+    return matchedRef ? matchedRef.id : null;
+};
+const experimentsTargeting = ({ clientSideParticipations, serverSideParticipations, }) => {
+    const testToParams = (testName, variant) => {
+        if (variant === 'notintest')
+            return null;
+        // GAM key-value pairs accept value strings up to 40 characters long
+        return `${testName}-${variant}`.substring(0, 40);
+    };
+    const clientSideExperiment = Object.entries(clientSideParticipations)
+        .map((test) => {
+        const [name, variant] = test;
+        return testToParams(name, variant.variant);
+    })
+        .filter(libs_1.isString);
+    const serverSideExperiments = Object.entries(serverSideParticipations)
+        .map((test) => testToParams(...test))
+        .filter(libs_1.isString);
+    if (clientSideExperiment.length + serverSideExperiments.length === 0)
+        return null;
+    return [...clientSideExperiment, ...serverSideExperiments];
+};
+/* -- Targeting -- */
+const getSessionTargeting = (referrer, participations, targeting) => ({
+    ref: getReferrer(referrer),
+    ab: experimentsTargeting(participations),
+    ...targeting,
+});
+exports.getSessionTargeting = getSessionTargeting;

package/dist/cjs/types.d.ts

@@ -1,13 +1,10 @@
-export declare type TagAtrribute = {
+export declare type TagAttribute = {
     name: string;
     value: string;
 };
-export declare type GetThirdPartyTag = (arg0: {
-    shouldRun: boolean;
-}) => ThirdPartyTag;
 export declare type ThirdPartyTag = {
     async?: boolean;
-    attrs?: TagAtrribute[];
+    attrs?: TagAttribute[];
     beforeLoad?: () => void;
     insertSnippet?: () => void;
     loaded?: boolean;
@@ -17,6 +14,9 @@ export declare type ThirdPartyTag = {
     url?: string;
     useImage?: boolean;
 };
+export declare type GetThirdPartyTag = (arg0: {
+    shouldRun: boolean;
+}) => ThirdPartyTag;
 export declare type GuardianAnalyticsConfig = {
     trackers: Record<string, string>;
 };

package/dist/esm/EventTimer.d.ts

@@ -37,10 +37,10 @@ export declare class EventTimer {
         effectiveType?: string;
     };
     /**
-     * Initalise the EventTimer class on page.
+     * Initialise the EventTimer class on page.
      * Returns the singleton instance of the EventTimer class and binds
      * to window.guardian.commercialTimer. If it's been previously
-     * initalised and bound it returns the original instance
+     * initialised and bound it returns the original instance
      * Note: We save to window.guardian.commercialTimer because
      * different bundles (DCR / DCP) can use commercial core, and we want
      * all timer events saved to a single instance per-page

package/dist/esm/EventTimer.js

@@ -63,10 +63,10 @@ export class EventTimer {
                 : {};
     }
     /**
-     * Initalise the EventTimer class on page.
+     * Initialise the EventTimer class on page.
      * Returns the singleton instance of the EventTimer class and binds
      * to window.guardian.commercialTimer. If it's been previously
-     * initalised and bound it returns the original instance
+     * initialised and bound it returns the original instance
      * Note: We save to window.guardian.commercialTimer because
      * different bundles (DCR / DCP) can use commercial core, and we want
      * all timer events saved to a single instance per-page
@@ -122,7 +122,7 @@ export class EventTimer {
      * @param {origin} [origin=page] - Either 'page' (default) or the name of the slot
      */
     trigger(eventName, origin = 'page') {
-        const TRACKEDSLOTNAME = 'top-above-nav';
+        const TRACKED_SLOT_NAME = 'top-above-nav';
         if (origin === 'page' &&
             !this.triggers.page[eventName]) {
             this.mark(eventName);
@@ -136,12 +136,12 @@ export class EventTimer {
             this.trackInGA(eventName, trackLabel);
             this.triggers.first[eventName] = true;
         }
-        if (origin === TRACKEDSLOTNAME) {
-            if (!this.triggers[TRACKEDSLOTNAME][eventName]) {
-                const trackLabel = `${TRACKEDSLOTNAME}-${eventName}`;
+        if (origin === TRACKED_SLOT_NAME) {
+            if (!this.triggers[TRACKED_SLOT_NAME][eventName]) {
+                const trackLabel = `${TRACKED_SLOT_NAME}-${eventName}`;
                 this.mark(trackLabel);
                 this.trackInGA(eventName, trackLabel);
-                this.triggers[TRACKEDSLOTNAME][eventName] = true;
+                this.triggers[TRACKED_SLOT_NAME][eventName] = true;
             }
         }
     }
@@ -155,9 +155,12 @@ export class EventTimer {
 }
 EventTimer._externallyDefinedEventNames = [
     'cmp-tcfv2-init',
+    'cmp-tcfv2-ui-displayed',
     'cmp-tcfv2-got-consent',
     'cmp-ccpa-init',
+    'cmp-ccpa-ui-displayed',
     'cmp-ccpa-got-consent',
     'cmp-aus-init',
+    'cmp-aus-ui-displayed',
     'cmp-aus-got-consent',
 ];

package/dist/esm/ad-targeting-youtube.js

@@ -2,6 +2,7 @@ import { getCookie } from '@guardian/libs';
 import { canUseDom } from './lib/can-use-dom';
 import { constructQuery } from './lib/construct-query';
 import { getPermutivePFPSegments } from './permutive';
+const disabledAds = { disableAds: true };
 const buildCustomParamsFromCookies = () => canUseDom()
     ? {
         permutive: getPermutivePFPSegments(),
@@ -51,7 +52,6 @@ const buildAdsConfig = (cmpConsent, adUnit, customParams) => {
     // Shouldn't happen but handle if no matching framework
     return disabledAds;
 };
-const disabledAds = { disableAds: true };
 const buildAdsConfigWithConsent = (isAdFreeUser, adUnit, customParamsToMerge, consentState) => {
     if (isAdFreeUser) {
         return disabledAds;

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

@@ -0,0 +1,189 @@
+import type { False, True } from '../types';
+declare const brands: {
+    readonly Foundation: "f";
+    readonly Paid: "p";
+    readonly Sponsored: "s";
+};
+declare const editions: {
+    readonly UnitedKingdom: "uk";
+    readonly UnitedStates: "us";
+    readonly Australia: "au";
+    readonly International: "int";
+};
+declare const videoLengths: readonly ["25", "30", "60", "90", "120", "150", "180", "210", "240", "270", "300"];
+declare const surges: {
+    readonly 0: "0";
+    readonly 50: "5";
+    readonly 100: "4";
+    readonly 200: "3";
+    readonly 300: "2";
+    readonly 400: "1";
+};
+declare const platforms: {
+    readonly R2: "r2";
+    readonly NextGen: "ng";
+    readonly MobileApp: "app";
+    readonly AcceleratedMobilePages: "amp";
+};
+declare const contentTypes: readonly ["article", "audio", "crossword", "gallery", "interactive", "liveblog", "network-front", "section", "tag", "video"];
+/**
+ * Content Targeting comes from the server
+ *
+ * For a specific URL, it will only change on
+ * - a Composer/CAPI update
+ * - a rendering platform capability update
+ * - a main media update
+ * - a series tag update
+ * - a surge in page views per minute
+ *
+ */
+export declare type ContentTargeting = {
+    /**
+     * **Bl**og tags – [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=186687
+     */
+    bl: string[];
+    /**
+     * **Br**anding - [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=259767
+     */
+    br: typeof brands[keyof typeof brands] | null;
+    /**
+     * **Co**ntributor - [see on Ad Manager][gam]
+     *
+     * Array of all contributors to the content on the page
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=186207
+     */
+    co: string[];
+    /**
+     * **C**ontent **T**ype - [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=177807
+     */
+    ct: typeof contentTypes[number];
+    /**
+     * **D**ot**c**om-**r**endering **E**ligible - [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11958028
+     */
+    dcre: True | False;
+    /**
+     * **Edition** - [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=174207
+     */
+    edition: typeof editions[keyof typeof editions];
+    /**
+     * **K**eywords - [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=177687
+     */
+    k: string[];
+    /**
+     * **Ob**server Content - [see on Ad Manager][gam]
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=256887
+     */
+    ob: 't' | null;
+    /**
+     * **P**latform - [see on Ad Manager][gam]
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=180207
+     */
+    p: typeof platforms[keyof typeof platforms];
+    /**
+     * Rendering Platform - [see on Ad Manager][gam]
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11881005
+     */
+    rp: 'dotcom-rendering' | 'dotcom-platform';
+    /**
+     * Site **S**ection - [see on Ad Manager][gam]
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=173967
+     */
+    s: string;
+    /**
+     * **Se**ries - [see on Ad Manager][gam]
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=180447
+     */
+    se: string[];
+    /**
+     * **Sens**itive - [see on Ad Manager][gam]
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11654206
+     */
+    sens: True | False;
+    /**
+     * **Su**rging Article - [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=185007
+     */
+    su: Array<typeof surges[keyof typeof surges]>;
+    /**
+     * **T**o**n**es - [see on Ad Manager][gam]
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=191487
+     */
+    tn: string[];
+    /**
+     * **U**niform **R**esource **L**ocator - [see on Ad Manager][gam]
+     *
+     * Relative to `www.theguardian.com`, starts with `/`
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=174327
+     */
+    url: `/${string}`;
+    /**
+     * URL Keywords - [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=12058265
+     */
+    urlkw: string[];
+    /**
+     * **V**ideo **L**ength - [see on Ad Manager][gam]
+     *
+     * Video.JS only (?)
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=195087
+     */
+    vl: null | typeof videoLengths[number];
+};
+export declare const getContentTargeting: ({ branding, contentType, contributors, platform, sensitive, tones, path, videoLength, surging, }: {
+    branding?: "Foundation" | "Paid" | "Sponsored" | undefined;
+    contentType: typeof contentTypes[number];
+    contributors: string[];
+    platform: keyof typeof platforms;
+    sensitive: boolean;
+    tones: ContentTargeting['tn'];
+    path: ContentTargeting['url'];
+    videoLength?: number | undefined;
+    surging: number;
+}, targeting: Omit<ContentTargeting, 'br' | 'ct' | 'co' | 'p' | 'sens' | 'tn' | 'url' | 'urlkw' | 'vl' | 'su'>) => ContentTargeting;
+export {};

package/dist/esm/targeting/content.js

@@ -0,0 +1,86 @@
+import { isString } from '@guardian/libs';
+/* -- Types -- */
+const brands = {
+    Foundation: 'f',
+    Paid: 'p',
+    Sponsored: 's',
+};
+const editions = {
+    UnitedKingdom: 'uk',
+    UnitedStates: 'us',
+    Australia: 'au',
+    International: 'int',
+};
+const videoLengths = [
+    '25',
+    '30',
+    '60',
+    '90',
+    '120',
+    '150',
+    '180',
+    '210',
+    '240',
+    '270',
+    '300',
+];
+const surges = {
+    0: '0',
+    50: '5',
+    100: '4',
+    200: '3',
+    300: '2',
+    400: '1',
+};
+const platforms = {
+    R2: 'r2',
+    NextGen: 'ng',
+    MobileApp: 'app',
+    AcceleratedMobilePages: 'amp',
+};
+const contentTypes = [
+    'article',
+    'audio',
+    'crossword',
+    'gallery',
+    'interactive',
+    'liveblog',
+    'network-front',
+    'section',
+    'tag',
+    'video',
+];
+/* -- Methods -- */
+const getVideoLength = (videoLength) => {
+    const index = Math.min(Math.ceil(videoLength / 30), 10);
+    return videoLengths[index] ?? null;
+};
+const getUrlKeywords = (url) => {
+    const lastSegment = url
+        .split('/')
+        .filter(Boolean) // This handles a trailing slash
+        .slice(-1)[0];
+    return isString(lastSegment) ? lastSegment.split('-').filter(Boolean) : [];
+};
+const getSurgingParam = (surging) => {
+    if (surging < 50 || isNaN(surging))
+        return ['0'];
+    const thresholds = [400, 300, 200, 100, 50];
+    return thresholds.filter((n) => n <= surging).map((s) => surges[s]);
+};
+/* -- Targeting -- */
+export const getContentTargeting = ({ branding, contentType, contributors, platform, sensitive, tones, path, videoLength, surging, }, targeting) => {
+    return {
+        ...targeting,
+        br: branding ? brands[branding] : null,
+        co: contributors,
+        ct: contentType,
+        p: platforms[platform],
+        sens: sensitive ? 't' : 'f',
+        tn: tones,
+        su: getSurgingParam(surging),
+        url: path,
+        urlkw: getUrlKeywords(path),
+        vl: videoLength ? getVideoLength(videoLength) : null,
+    };
+};

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

@@ -0,0 +1,78 @@
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
+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 const adManagerGroups: readonly ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12"];
+declare type AdManagerGroup = typeof adManagerGroups[number];
+/**
+ * Personalised Targeting requires user consent
+ *
+ * It allows or prevents personalised advertising, restrict data processing
+ * and handles access to cookies and local storage
+ */
+export declare type PersonalisedTargeting = {
+    /**
+     * **A**d **M**anager **T**argeting **Gr**ou**p** – [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * Sample values:
+     * -
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=12318099
+     * */
+    amtgrp: AdManagerGroup | null;
+    /**
+     * Interaction with TCFv2 banner – [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=12083384
+     */
+    cmp_interaction?: TCEventStatusCode | NotApplicable;
+    /**
+     * **TCFv2 Consent** to [all purposes] – [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [all purposes]: https://vendor-list.consensu.org/v2/vendor-list.json
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=12080297
+     * */
+    consent_tcfv2: True | False | NotApplicable;
+    /**
+     * **Fr**equency – [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=214647
+     */
+    fr: typeof frequency[number];
+    /**
+     * **P**ersonalised **A**ds Consent – [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11701767
+     */
+    pa: True | False;
+    /**
+     * **Permutive** user segments – [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * Values: 900+ number IDs
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11958727
+     */
+    permutive: string[];
+    /**
+     * **R**estrict **D**ata **P**rocessing Flag – [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11701767
+     */
+    rdp: True | False | NotApplicable;
+};
+declare const getPersonalisedTargeting: (state: ConsentState) => PersonalisedTargeting;
+export { getPersonalisedTargeting };

package/dist/esm/targeting/personalised.js

@@ -0,0 +1,145 @@
+import { storage } from '@guardian/libs';
+import { clearPermutiveSegments, getPermutiveSegments } from '../permutive';
+/* -- Types -- */
+const frequency = [
+    '0',
+    '1',
+    '2',
+    '3',
+    '4',
+    '5',
+    '6-9',
+    '10-15',
+    '16-19',
+    '20-29',
+    '30plus',
+];
+const AMTGRP_STORAGE_KEY = 'gu.adManagerGroup';
+const adManagerGroups = [
+    '1',
+    '2',
+    '3',
+    '4',
+    '5',
+    '6',
+    '7',
+    '8',
+    '9',
+    '10',
+    '11',
+    '12',
+];
+/* -- Methods -- */
+const getRawWithConsent = (key, state) => {
+    if (state.tcfv2) {
+        if (state.tcfv2.consents['1'])
+            return storage.local.getRaw(key);
+    }
+    if (state.ccpa) {
+        if (!state.ccpa.doNotSell)
+            return storage.local.getRaw(key);
+    }
+    if (state.aus) {
+        if (state.aus.personalisedAdvertising)
+            return storage.local.getRaw(key);
+    }
+    return null;
+};
+const getFrequencyValue = (state) => {
+    const rawValue = getRawWithConsent('gu.alreadyVisited', state);
+    if (!rawValue)
+        return '0';
+    const visitCount = parseInt(rawValue, 10);
+    if (visitCount <= 5) {
+        return frequency[visitCount] ?? '0';
+    }
+    else if (visitCount >= 6 && visitCount <= 9) {
+        return '6-9';
+    }
+    else if (visitCount >= 10 && visitCount <= 15) {
+        return '10-15';
+    }
+    else if (visitCount >= 16 && visitCount <= 19) {
+        return '16-19';
+    }
+    else if (visitCount >= 20 && visitCount <= 29) {
+        return '20-29';
+    }
+    else if (visitCount >= 30) {
+        return '30plus';
+    }
+    return '0';
+};
+const tcfv2AllPurposesConsented = (consents) => Object.keys(consents).length > 0 && Object.values(consents).every(Boolean);
+const personalisedAdvertising = (state) => {
+    if (state.tcfv2)
+        return tcfv2AllPurposesConsented(state.tcfv2.consents);
+    if (state.ccpa)
+        return !state.ccpa.doNotSell;
+    if (state.aus)
+        return state.aus.personalisedAdvertising;
+    return false;
+};
+const getCMPTargeting = (state) => {
+    if (state.tcfv2) {
+        return {
+            cmp_interaction: state.tcfv2.eventStatus,
+            pa: tcfv2AllPurposesConsented(state.tcfv2.consents) ? 't' : 'f',
+            consent_tcfv2: tcfv2AllPurposesConsented(state.tcfv2.consents)
+                ? 't'
+                : 'f',
+            rdp: 'na',
+        };
+    }
+    if (state.ccpa) {
+        return {
+            consent_tcfv2: 'na',
+            rdp: state.ccpa.doNotSell ? 't' : 'f',
+            pa: state.ccpa.doNotSell ? 'f' : 't',
+        };
+    }
+    if (state.aus) {
+        return {
+            consent_tcfv2: 'na',
+            rdp: 'na',
+            pa: state.aus.personalisedAdvertising ? 't' : 'f',
+        };
+    }
+    return {
+        cmp_interaction: 'na',
+        consent_tcfv2: 'na',
+        rdp: 'na',
+        pa: 'f',
+    };
+};
+const isAdManagerGroup = (s) => adManagerGroups.some((g) => g === s);
+const createAdManagerGroup = () => {
+    const index = Math.floor(Math.random() * adManagerGroups.length);
+    const group = adManagerGroups[index] ?? '12';
+    storage.local.setRaw(AMTGRP_STORAGE_KEY, group);
+    return group;
+};
+const getAdManagerGroup = (state) => {
+    if (!personalisedAdvertising(state)) {
+        storage.local.remove(AMTGRP_STORAGE_KEY);
+        return null;
+    }
+    const existingGroup = storage.local.getRaw(AMTGRP_STORAGE_KEY);
+    return isAdManagerGroup(existingGroup)
+        ? existingGroup
+        : createAdManagerGroup();
+};
+const getPermutiveWithState = (state) => {
+    if (personalisedAdvertising(state))
+        return getPermutiveSegments();
+    clearPermutiveSegments();
+    return [];
+};
+/* -- Targeting -- */
+const getPersonalisedTargeting = (state) => ({
+    amtgrp: getAdManagerGroup(state),
+    fr: getFrequencyValue(state),
+    permutive: getPermutiveWithState(state),
+    ...getCMPTargeting(state),
+});
+export { getPersonalisedTargeting };