@guardian/commercial-core 7.1.0 → 27.0.0

package/dist/esm/send-commercial-metrics.js

@@ -1,5 +1,4 @@
-import { onConsent } from '@guardian/consent-management-platform';
-import { log } from '@guardian/libs';
+import { getMeasures, isNonNullable, log, onConsent } from '@guardian/libs';
 import { EventTimer } from './event-timer';
 var Endpoints;
 (function (Endpoints) {
@@ -15,7 +14,6 @@ let commercialMetricsPayload = {
 };
 let devProperties = [];
 let adBlockerProperties = [];
-let initialised = false;
 let endpoint;
 const setEndpoint = (isDev) => (endpoint = isDev ? Endpoints.CODE : Endpoints.PROD);
 const setDevProperties = (isDev) => (devProperties = isDev
@@ -42,15 +40,26 @@ const mapEventTimerPropertiesToString = (properties) => {
         value: String(value),
     }));
 };
-const roundTimeStamp = (events) => {
-    return events.map(({ name, ts }) => ({
+const roundTimeStamp = (events, measures) => {
+    const roundedEvents = events.map(({ name, ts }) => ({
         name,
         value: Math.ceil(ts),
     }));
+    const roundedMeasures = measures.map(({ name, duration }) => ({
+        name,
+        value: Math.ceil(duration),
+    }));
+    return [...roundedEvents, ...roundedMeasures];
 };
 function sendMetrics() {
     log('commercial', 'About to send commercial metrics', commercialMetricsPayload);
-    return navigator.sendBeacon(endpoint, JSON.stringify(commercialMetricsPayload));
+    void fetch(endpoint, {
+        method: 'POST',
+        body: JSON.stringify(commercialMetricsPayload),
+        keepalive: true,
+        cache: 'no-store',
+        mode: 'no-cors',
+    });
 }
 /**
  * Gather how many times the user has experienced the “offline” event
@@ -69,6 +78,15 @@ const getOfflineCount = () => typeof window.guardian.offlineCount === 'number'
         },
     ]
     : [];
+/**
+ * Measures added with @guardian/libs’s `startPerformanceMeasure`
+ *
+ * Allows for more granular monitoring of web page performance.
+ */
+const getPerformanceMeasures = (...teams) => getMeasures(teams).map(({ detail: { subscription, name, action }, duration }) => ({
+    name: [subscription, name, action].filter(isNonNullable).join('_'),
+    value: duration,
+}));
 function gatherMetricsOnPageUnload() {
     // Assemble commercial properties and metrics
     const eventTimer = EventTimer.get();
@@ -79,20 +97,24 @@ function gatherMetricsOnPageUnload() {
         .concat(devProperties)
         .concat(adBlockerProperties);
     commercialMetricsPayload.properties = properties;
-    const metrics = roundTimeStamp(eventTimer.events).concat(getOfflineCount());
+    const metrics = roundTimeStamp(eventTimer.marks, eventTimer.measures)
+        .concat(getOfflineCount())
+        .concat(getPerformanceMeasures('dotcom'));
     commercialMetricsPayload.metrics = metrics;
     sendMetrics();
 }
 const listener = (e) => {
-    switch (e.type) {
-        case 'visibilitychange':
-            if (document.visibilityState === 'hidden') {
+    if (window.guardian.config.shouldSendCommercialMetrics) {
+        switch (e.type) {
+            case 'visibilitychange':
+                if (document.visibilityState === 'hidden') {
+                    gatherMetricsOnPageUnload();
+                }
+                return;
+            case 'pagehide':
                 gatherMetricsOnPageUnload();
-            }
-            return;
-        case 'pagehide':
-            gatherMetricsOnPageUnload();
-            return;
+                return;
+        }
     }
 };
 const addVisibilityListeners = () => {
@@ -116,13 +138,13 @@ const checkConsent = async () => {
  * A method to asynchronously send metrics after initialization.
  */
 async function bypassCommercialMetricsSampling() {
-    if (!initialised) {
+    if (!window.guardian.config.commercialMetricsInitialised) {
         console.warn('initCommercialMetrics not yet initialised');
         return;
     }
     const consented = await checkConsent();
     if (consented) {
-        addVisibilityListeners();
+        window.guardian.config.shouldSendCommercialMetrics = true;
     }
     else {
         log('commercial', "Metrics won't be sent because consent wasn't given");
@@ -130,6 +152,7 @@ async function bypassCommercialMetricsSampling() {
 }
 /**
  * A method to initialise metrics.
+ * Note: this is initialised in the frontend/DCR bundles, not the commercial bundle.
  * @param init.pageViewId - identifies the page view. Usually available on `guardian.config.ophan.pageViewId`. Defaults to `null`
  * @param init.browserId - identifies the browser. Usually available via `getCookie({ name: 'bwid' })`. Defaults to `null`
  * @param init.isDev - used to determine whether to use CODE or PROD endpoints.
@@ -142,20 +165,19 @@ async function initCommercialMetrics({ pageViewId, browserId, isDev, adBlockerIn
     setEndpoint(isDev);
     setDevProperties(isDev);
     setAdBlockerProperties(adBlockerInUse);
-    if (initialised) {
+    addVisibilityListeners();
+    if (window.guardian.config.commercialMetricsInitialised) {
         return false;
     }
-    initialised = true;
+    window.guardian.config.commercialMetricsInitialised = true;
     const userIsInSamplingGroup = Math.random() <= sampling;
     if (isDev || userIsInSamplingGroup) {
         const consented = await checkConsent();
         if (consented) {
-            addVisibilityListeners();
+            window.guardian.config.shouldSendCommercialMetrics = true;
             return true;
         }
-        else {
-            log('commercial', "Metrics won't be sent because consent wasn't given");
-        }
+        log('commercial', "Metrics won't be sent because consent wasn't given");
     }
     return false;
 }
@@ -166,7 +188,8 @@ export const _ = {
     roundTimeStamp,
     transformToObjectEntries,
     reset: () => {
-        initialised = false;
+        window.guardian.config.commercialMetricsInitialised = false;
+        window.guardian.config.shouldSendCommercialMetrics = false;
         commercialMetricsPayload = {
             page_view_id: undefined,
             browser_id: undefined,
@@ -178,4 +201,4 @@ export const _ = {
         removeEventListener('pagehide', listener);
     },
 };
-export { bypassCommercialMetricsSampling, initCommercialMetrics };
+export { bypassCommercialMetricsSampling, initCommercialMetrics, checkConsent };

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

@@ -1,13 +1,11 @@
 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 { ConsentState, CountryCode } from '@guardian/libs';
 import type { AdManagerGroup, Frequency } from './personalised';
 import type { SharedTargeting } from './shared';
+import type { TrueOrFalse } from './types';
 type PartialWithNulls<T> = {
     [P in keyof T]?: T[P] | null;
 };
-type TrueOrFalse = True | False;
 type PageTargeting = PartialWithNulls<{
     ab: string[];
     af: 't';
@@ -41,8 +39,9 @@ type BuildPageTargetingParams = {
     adFree: boolean;
     clientSideParticipations: Participations;
     consentState: ConsentState;
+    isSignedIn?: boolean;
     youtube?: boolean;
 };
-declare const buildPageTargeting: ({ adFree, clientSideParticipations, consentState, youtube, }: BuildPageTargetingParams) => Record<string, string | string[]>;
+declare const buildPageTargeting: ({ adFree, clientSideParticipations, consentState, isSignedIn, youtube, }: BuildPageTargetingParams) => Record<string, string | string[]>;
 export { buildPageTargeting, filterValues };
 export type { PageTargeting };

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

@@ -1,6 +1,6 @@
-import { cmp } from '@guardian/consent-management-platform';
-import { getCookie, isString } from '@guardian/libs';
-import { getLocale } from '../lib/get-locale';
+import { cmp, getConsentFor, getCookie, isString } from '@guardian/libs';
+import { supportsPerformanceAPI } from '../event-timer';
+import { getLocale } from '../geo/get-locale';
 import { getContentTargeting } from './content';
 import { getPersonalisedTargeting } from './personalised';
 import { getSessionTargeting } from './session';
@@ -21,7 +21,30 @@ const filterValues = (pageTargets) => {
     }
     return filtered;
 };
-const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, youtube = false, }) => {
+const lastPerformanceEntryIsNavigationType = () => {
+    if (!supportsPerformanceAPI()) {
+        return false;
+    }
+    const navigationEvents = performance.getEntriesByType('navigation');
+    const lastNavigationEvent = navigationEvents[navigationEvents.length - 1];
+    // https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEntry/entryType#navigation
+    return lastNavigationEvent?.entryType === 'navigation';
+};
+const referrerMatchesHost = (referrer) => {
+    if (!referrer) {
+        return false;
+    }
+    const referrerUrl = new URL(referrer);
+    return referrerUrl.hostname === window.location.hostname;
+};
+// A consentless friendly way of determining if this is the users first visit to the page
+const isFirstVisit = (referrer) => {
+    if (supportsPerformanceAPI() && !lastPerformanceEntryIsNavigationType()) {
+        return false;
+    }
+    return !referrerMatchesHost(referrer);
+};
+const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, isSignedIn = false, youtube = false, }) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
     const sharedAdTargeting = page.sharedAdTargeting
@@ -39,17 +62,17 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, yo
         videoLength: page.videoDuration,
         keywords: sharedAdTargeting.k ?? [],
     });
-    const getReferrer = () => document.referrer || '';
+    const referrer = document.referrer || '';
     const sessionTargeting = getSessionTargeting({
         adTest: getCookie({ name: 'adtest', shouldMemoize: true }),
         countryCode: getLocale(),
-        isSignedIn: !!getCookie({ name: 'GU_U' }),
+        isSignedIn,
         pageViewId: window.guardian.config.ophan.pageViewId,
         participations: {
             clientSideParticipations,
             serverSideParticipations: window.guardian.config.tests ?? {},
         },
-        referrer: getReferrer(),
+        referrer,
     });
     const getViewport = () => {
         return {
@@ -65,6 +88,10 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, yo
         state: consentState,
         youtube,
     });
+    const consentlessTargeting = {};
+    if (!getConsentFor('googletag', consentState)) {
+        consentlessTargeting.firstvisit = isFirstVisit(referrer) ? 't' : 'f';
+    }
     const pageTargets = {
         ...personalisedTargeting,
         ...sharedAdTargeting,
@@ -72,6 +99,7 @@ const buildPageTargeting = ({ adFree, clientSideParticipations, consentState, yo
         ...contentTargeting,
         ...sessionTargeting,
         ...viewportTargeting,
+        ...consentlessTargeting,
     };
     // filter !(string | string[]) and empty values
     const pageTargeting = filterValues(pageTargets);

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

@@ -1,5 +1,5 @@
-import type { False, True } from '../types';
 import type { SharedTargeting } from './shared';
+import type { False, True } from './types';
 declare const videoLengths: readonly ["25", "30", "60", "90", "120", "150", "180", "210", "240", "270", "300"];
 /**
  * Content Targeting comes from the server

package/dist/esm/targeting/content.js

@@ -1,7 +1,7 @@
 import { isString } from '@guardian/libs';
 /* -- Types -- */
 const videoLengths = [
-    '25',
+    '25', // TODO: confirm this is a real value
     '30',
     '60',
     '90',

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

@@ -1,6 +1,5 @@
-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';
+import type { ConsentState, TCEventStatusCode } from '@guardian/libs';
+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"];
 type Frequency = (typeof frequency)[number];
 declare const adManagerGroups: readonly ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12"];

package/dist/esm/targeting/personalised.js

@@ -35,8 +35,8 @@ const getRawWithConsent = (key, state) => {
         if (state.tcfv2.consents['1'])
             return storage.local.getRaw(key);
     }
-    if (state.ccpa) {
-        if (!state.ccpa.doNotSell)
+    if (state.usnat) {
+        if (!state.usnat.doNotSell)
             return storage.local.getRaw(key);
     }
     if (state.aus) {
@@ -79,7 +79,7 @@ const getCMPTargeting = (state) => {
             rdp: 'na',
         };
     }
-    if (state.ccpa) {
+    if (state.usnat) {
         return {
             consent_tcfv2: 'na',
             rdp: !state.canTarget ? 't' : 'f',

package/dist/esm/targeting/pick-targeting-values.d.ts

@@ -21,5 +21,5 @@ type ValidTargetingObject<Base> = ConditionalExcept<Base, null | undefined | ''
  * clean.invalid
  * ```
  */
-export declare const pickTargetingValues: <T extends Record<string, string | readonly string[] | undefined>>(obj: T) => import("type-fest").Except<T, import("type-fest").ConditionalKeys<T, number | boolean | "" | never[] | readonly [] | readonly [""] | null | undefined>>;
+export declare const pickTargetingValues: <T extends Record<string, string | readonly string[] | undefined>>(obj: T) => ValidTargetingObject<T>;
 export {};

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

@@ -1,6 +1,6 @@
 import type { Participations } from '@guardian/ab-core';
 import type { CountryCode } from '@guardian/libs';
-import type { False, True } from '../types';
+import type { False, True } from './types';
 declare const referrers: readonly [{
     readonly id: "facebook";
     readonly match: "facebook.com";
@@ -97,7 +97,7 @@ type AllParticipations = {
         [key: `${string}Variant`]: 'variant';
     };
 };
-declare const experimentsTargeting: ({ clientSideParticipations, serverSideParticipations, }: AllParticipations) => SessionTargeting['ab'];
+declare const experimentsTargeting: ({ clientSideParticipations, serverSideParticipations, }: AllParticipations) => SessionTargeting["ab"];
 type Session = {
     adTest: SessionTargeting['at'];
     countryCode: CountryCode;

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

@@ -1,20 +1,31 @@
-declare const brands: {
-    readonly Foundation: "f";
-    readonly Paid: "p";
-    readonly Sponsored: "s";
+type Brands = {
+    Foundation: 'f';
+    Paid: 'p';
+    Sponsored: 's';
 };
-declare const contentTypes: readonly ["article", "audio", "crossword", "gallery", "interactive", "liveblog", "network-front", "section", "tag", "video"];
-declare const editions: {
-    readonly UnitedKingdom: "uk";
-    readonly UnitedStates: "us";
-    readonly Australia: "au";
-    readonly International: "int";
+type ContentTypes = [
+    'article',
+    'audio',
+    'crossword',
+    'gallery',
+    'interactive',
+    'liveblog',
+    'network-front',
+    'section',
+    'tag',
+    'video'
+];
+type Editions = {
+    UnitedKingdom: 'uk';
+    UnitedStates: 'us';
+    Australia: 'au';
+    International: 'int';
 };
-declare const platforms: {
-    readonly R2: "r2";
-    readonly NextGen: "ng";
-    readonly MobileApp: "app";
-    readonly AcceleratedMobilePages: "amp";
+type Platforms = {
+    R2: 'r2';
+    NextGen: 'ng';
+    MobileApp: 'app';
+    AcceleratedMobilePages: 'amp';
 };
 declare const surges: {
     readonly 0: "0";
@@ -50,7 +61,7 @@ type SharedTargeting = {
      *
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=259767
      */
-    br: (typeof brands)[keyof typeof brands];
+    br: Brands[keyof Brands];
     /**
      * **Co**ntributors and Authors - [see on Ad Manager][gam]
      *
@@ -68,7 +79,7 @@ type SharedTargeting = {
      *
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=177807
      */
-    ct: (typeof contentTypes)[number];
+    ct: ContentTypes[number];
     /**
      * **Edition** - [see on Ad Manager][gam]
      *
@@ -76,7 +87,7 @@ type SharedTargeting = {
      *
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=174207
      */
-    edition: (typeof editions)[keyof typeof editions];
+    edition: Editions[keyof Editions];
     /**
      * **K**eywords - [see on Ad Manager][gam]
      *
@@ -96,7 +107,7 @@ type SharedTargeting = {
      *
      * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=180207
      */
-    p: (typeof platforms)[keyof typeof platforms];
+    p: Platforms[keyof Platforms];
     /**
      * **Se**ries - [see on Ad Manager][gam]
      *
@@ -139,7 +150,7 @@ type SharedTargeting = {
  */
 declare const getSharedTargeting: (shared: Partial<SharedTargeting>) => Partial<SharedTargeting>;
 export declare const _: {
-    getSurgingParam: (surging: number) => SharedTargeting['su'];
+    getSurgingParam: (surging: number) => SharedTargeting["su"];
 };
 export type { SharedTargeting };
 export { getSharedTargeting };

package/dist/esm/targeting/shared.js

@@ -1,34 +1,4 @@
 import { pickTargetingValues } from './pick-targeting-values';
-/* -- Types -- */
-const brands = {
-    Foundation: 'f',
-    Paid: 'p',
-    Sponsored: 's',
-};
-const contentTypes = [
-    'article',
-    'audio',
-    'crossword',
-    'gallery',
-    'interactive',
-    'liveblog',
-    'network-front',
-    'section',
-    'tag',
-    'video',
-];
-const editions = {
-    UnitedKingdom: 'uk',
-    UnitedStates: 'us',
-    Australia: 'au',
-    International: 'int',
-};
-const platforms = {
-    R2: 'r2',
-    NextGen: 'ng',
-    MobileApp: 'app',
-    AcceleratedMobilePages: 'amp',
-};
 const surges = {
     0: '0',
     50: '5',

package/dist/esm/targeting/teads-eligibility.d.ts

@@ -0,0 +1,2 @@
+declare const isEligibleForTeads: (slotId: string) => boolean;
+export { isEligibleForTeads };

package/dist/esm/targeting/teads-eligibility.js

@@ -0,0 +1,17 @@
+const allowedContentTypes = ['Article', 'LiveBlog'];
+const isEligibleForTeads = (slotId) => {
+    const { contentType, isSensitive } = window.guardian.config.page;
+    // This IAS value is returned when a page is thought to contain content which is not brand safe
+    const isBrandSafe = !window.googletag
+        .pubads()
+        .getTargeting('ias-kw')
+        .includes('IAS_16425_KW');
+    if (slotId === 'dfp-ad--inline1' &&
+        allowedContentTypes.includes(contentType) &&
+        !isSensitive &&
+        isBrandSafe) {
+        return true;
+    }
+    return false;
+};
+export { isEligibleForTeads };

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

@@ -0,0 +1,6 @@
+export type False = 'f';
+export type True = 't';
+export type TrueOrFalse = True | False;
+export type NotApplicable = 'na';
+export type MaybeArray<T> = T | T[];
+export type CustomParams = Record<string, MaybeArray<string | number | boolean>>;

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

@@ -1,4 +1,4 @@
-import type { False, True } from '../types';
+import type { False, True } from './types';
 /**
  * Viewport Targeting
  *

package/dist/esm/targeting/youtube-ima.d.ts

@@ -1,11 +1,12 @@
 import type { Participations } from '@guardian/ab-core';
-import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
-import type { CustomParams } from '../types';
+import type { ConsentState } from '@guardian/libs';
+import type { CustomParams } from './types';
 type BuildImaAdTagUrl = {
     adUnit: string;
     customParams: CustomParams;
     consentState: ConsentState;
     clientSideParticipations: Participations;
+    isSignedIn: boolean;
 };
-declare const buildImaAdTagUrl: ({ adUnit, clientSideParticipations, consentState, customParams, }: BuildImaAdTagUrl) => string;
+declare const buildImaAdTagUrl: ({ adUnit, clientSideParticipations, consentState, customParams, isSignedIn, }: BuildImaAdTagUrl) => string;
 export { buildImaAdTagUrl };

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

@@ -15,13 +15,14 @@ const encodeCustomParams = (params) => {
         .join('&');
     return encodedParams;
 };
-const mergeCustomParamsWithTargeting = (customParams, consentState, clientSideParticipations) => {
+const mergeCustomParamsWithTargeting = (customParams, consentState, clientSideParticipations, isSignedIn) => {
     let pageTargeting = {};
     try {
         pageTargeting = buildPageTargeting({
             adFree: false,
             clientSideParticipations,
             consentState: consentState,
+            isSignedIn: isSignedIn,
         });
     }
     catch (e) {
@@ -39,8 +40,8 @@ const mergeCustomParamsWithTargeting = (customParams, consentState, clientSidePa
     };
     return mergedCustomParams;
 };
-const buildImaAdTagUrl = ({ adUnit, clientSideParticipations, consentState, customParams, }) => {
-    const mergedCustomParams = mergeCustomParamsWithTargeting(customParams, consentState, clientSideParticipations);
+const buildImaAdTagUrl = ({ adUnit, clientSideParticipations, consentState, customParams, isSignedIn, }) => {
+    const mergedCustomParams = mergeCustomParamsWithTargeting(customParams, consentState, clientSideParticipations, isSignedIn);
     const queryParams = {
         iu: adUnit,
         tfcd: '0',
@@ -53,6 +54,8 @@ const buildImaAdTagUrl = ({ adUnit, clientSideParticipations, consentState, cust
         impl: 's',
         vad_type: 'linear',
         vpos: 'preroll',
+        plcmt: '1',
+        description_url: encodeURIComponent(`${window.guardian.config.page.host}/${window.guardian.config.page.pageId}`),
         /**
          * cust_params string is encoded
          * cust_params values are also encoded so they will get double encoded
@@ -64,7 +67,7 @@ const buildImaAdTagUrl = ({ adUnit, clientSideParticipations, consentState, cust
     for (const [k, v] of Object.entries(queryParams)) {
         queryParamsArray.push(`${k}=${v}`);
     }
-    return ('https://pubads.g.doubleclick.net/gampad/ads?' +
+    return ('https://securepubads.g.doubleclick.net/gampad/ads?' +
         queryParamsArray.join('&'));
 };
 export { buildImaAdTagUrl };