@guardian/commercial-core 0.0.0-beta-20250716121613

package/dist/cjs/targeting/personalised.js

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPersonalisedTargeting = void 0;
+const libs_1 = require("@guardian/libs");
+const permutive_1 = require("../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 libs_1.storage.local.getRaw(key);
+    }
+    if (state.usnat) {
+        if (!state.usnat.doNotSell)
+            return libs_1.storage.local.getRaw(key);
+    }
+    if (state.aus) {
+        if (state.aus.personalisedAdvertising)
+            return libs_1.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 getCMPTargeting = (state) => {
+    if (state.tcfv2) {
+        return {
+            cmp_interaction: state.tcfv2.eventStatus,
+            pa: state.canTarget ? 't' : 'f',
+            consent_tcfv2: state.canTarget ? 't' : 'f',
+            rdp: 'na',
+        };
+    }
+    if (state.usnat) {
+        return {
+            consent_tcfv2: 'na',
+            rdp: !state.canTarget ? 't' : 'f',
+            pa: state.canTarget ? 't' : 'f',
+        };
+    }
+    if (state.aus) {
+        return {
+            consent_tcfv2: 'na',
+            rdp: 'na',
+            pa: state.canTarget ? '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';
+    libs_1.storage.local.setRaw(AMTGRP_STORAGE_KEY, group);
+    return group;
+};
+const getAdManagerGroup = (state) => {
+    if (!state.framework) {
+        libs_1.storage.local.remove(AMTGRP_STORAGE_KEY);
+        return null;
+    }
+    if (state.tcfv2 && !state.canTarget) {
+        libs_1.storage.local.remove(AMTGRP_STORAGE_KEY);
+        return null;
+    }
+    const existingGroup = libs_1.storage.local.getRaw(AMTGRP_STORAGE_KEY);
+    return isAdManagerGroup(existingGroup)
+        ? existingGroup
+        : createAdManagerGroup();
+};
+const getPermutiveWithState = (state, youtube) => {
+    if (state.canTarget) {
+        return youtube ? (0, permutive_1.getPermutivePFPSegments)() : (0, permutive_1.getPermutiveSegments)();
+    }
+    (0, permutive_1.clearPermutiveSegments)();
+    return [];
+};
+const getPersonalisedTargeting = ({ state, youtube, }) => ({
+    amtgrp: getAdManagerGroup(state),
+    fr: getFrequencyValue(state),
+    permutive: getPermutiveWithState(state, youtube),
+    ...getCMPTargeting(state),
+});
+exports.getPersonalisedTargeting = getPersonalisedTargeting;

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

@@ -0,0 +1,25 @@
+import type { ConditionalExcept } from 'type-fest';
+type ValidTargetingObject<Base> = ConditionalExcept<Base, null | undefined | '' | readonly [] | readonly [''] | never[] | boolean | number>;
+/**
+ * Picks only keys with targeting values from an object.
+ * A targeting values is defined as either:
+ * - a non-empty string
+ * - an array of non-empty strings
+ *
+ * If you object is read-only, you can safely access properties on the result.
+ * For example:
+ *
+ * ```ts
+ * dirty = {
+ *   valid: 'real',
+ *   invalid: undefined,
+ * } as const;
+ *
+ * clean = pickDefinedValues(dirty);
+ *
+ * // @ts-expect-error -- you can’t access this property
+ * clean.invalid
+ * ```
+ */
+export declare const pickTargetingValues: <T extends Record<string, string | readonly string[] | undefined>>(obj: T) => ValidTargetingObject<T>;
+export {};

package/dist/cjs/targeting/pick-targeting-values.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pickTargetingValues = void 0;
+const libs_1 = require("@guardian/libs");
+const isTargetingString = (string) => (0, libs_1.isString)(string) && string !== '';
+const isTargetingArray = (array) => Array.isArray(array) && array.filter(isTargetingString).length > 0;
+const isValidTargeting = (value) => {
+    if (isTargetingString(value))
+        return true;
+    if (isTargetingArray(value))
+        return true;
+    return false;
+};
+/**
+ * Picks only keys with targeting values from an object.
+ * A targeting values is defined as either:
+ * - a non-empty string
+ * - an array of non-empty strings
+ *
+ * If you object is read-only, you can safely access properties on the result.
+ * For example:
+ *
+ * ```ts
+ * dirty = {
+ *   valid: 'real',
+ *   invalid: undefined,
+ * } as const;
+ *
+ * clean = pickDefinedValues(dirty);
+ *
+ * // @ts-expect-error -- you can’t access this property
+ * clean.invalid
+ * ```
+ */
+const pickTargetingValues = (obj) => {
+    const initialValue = {};
+    return Object.entries(obj).reduce((valid, [key, value]) => {
+        if (isValidTargeting(value)) {
+            // @ts-expect-error -- isValidTargeting checks this
+            valid[key] = Array.isArray(value)
+                ? value.filter(isTargetingString)
+                : value;
+        }
+        return valid;
+    }, initialValue);
+};
+exports.pickTargetingValues = pickTargetingValues;

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

@@ -0,0 +1,111 @@
+import type { Participations } from '@guardian/ab-core';
+import type { CountryCode } from '@guardian/libs';
+import type { False, True } from './types';
+declare const referrers: readonly [{
+    readonly id: "facebook";
+    readonly match: "facebook.com";
+}, {
+    readonly id: "google";
+    readonly match: "www.google";
+}, {
+    readonly id: "twitter";
+    readonly match: "/t.co/";
+}, {
+    readonly id: "reddit";
+    readonly match: "reddit.com";
+}];
+/**
+ * Session Targeting is based on the browser session
+ *
+ * Includes information such as the country of origin, referrer, page view ID.
+ *
+ * These values identify a browser session are either generated client-side,
+ * read from a cookie or passed down from the server.
+ */
+type SessionTargeting = {
+    /**
+     * **AB** Tests – [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * Values: typically start with `ab`
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=186327
+     */
+    ab: string[] | null;
+    /**
+     * **A**d **T**est – [see on Ad Manager][gam]
+     *
+     * Used for testing purposes, based on query param and/or cookie.
+     *
+     * Type: _Dynamic_
+     *
+     * [See Current values](https://frontend.gutools.co.uk/commercial/adtests)
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=177567
+     */
+    at: string | null;
+    /**
+     * **C**ountry **C**ode – [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11703293
+     */
+    cc: CountryCode;
+    /**
+     * Ophan **P**age **V**iew id – [see on Ad Manager][gam]
+     *
+     * ID Generated client-side, usually available on
+     * `guardian.config.ophan.pageViewId`
+     *
+     * Used mainly for internal reporting
+     *
+     * Type: _Dynamic_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=206127
+     */
+    pv: string;
+    /**
+     * **Ref**errer – [see on Ad Manager][gam]
+     *
+     * Type: _Dynamic_
+     *
+     * Sample values:
+     * - `facebook`
+     * - `google`
+     * - `googleplus`
+     * - `reddit`
+     * - `twitter`
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=228567
+     */
+    ref: (typeof referrers)[number]['id'] | null;
+    /**
+     * **S**igned **I**n – [see on Ad Manager][gam]
+     *
+     *Whether a user is signed in. Based on presence of a cookie.
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=215727
+     */
+    si: True | False;
+};
+type AllParticipations = {
+    clientSideParticipations: Participations;
+    serverSideParticipations: {
+        [key: `${string}Control`]: 'control';
+        [key: `${string}Variant`]: 'variant';
+    };
+};
+declare const experimentsTargeting: ({ clientSideParticipations, serverSideParticipations, }: AllParticipations) => SessionTargeting["ab"];
+type Session = {
+    adTest: SessionTargeting['at'];
+    countryCode: CountryCode;
+    isSignedIn: boolean;
+    pageViewId: SessionTargeting['pv'];
+    participations: AllParticipations;
+    referrer: string;
+};
+declare const getSessionTargeting: ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
+export type { SessionTargeting, AllParticipations };
+export { getSessionTargeting, experimentsTargeting };

package/dist/cjs/targeting/session.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.experimentsTargeting = 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];
+};
+exports.experimentsTargeting = experimentsTargeting;
+const getSessionTargeting = ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }) => ({
+    ab: experimentsTargeting(participations),
+    at: adTest,
+    cc: countryCode,
+    pv: pageViewId,
+    ref: getReferrer(referrer),
+    si: isSignedIn ? 't' : 'f',
+});
+exports.getSessionTargeting = getSessionTargeting;

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

@@ -0,0 +1,156 @@
+type Brands = {
+    Foundation: 'f';
+    Paid: 'p';
+    Sponsored: 's';
+};
+type ContentTypes = [
+    'article',
+    'audio',
+    'crossword',
+    'gallery',
+    'interactive',
+    'liveblog',
+    'network-front',
+    'section',
+    'tag',
+    'video'
+];
+type Editions = {
+    UnitedKingdom: 'uk';
+    UnitedStates: 'us';
+    Australia: 'au';
+    International: 'int';
+};
+type Platforms = {
+    R2: 'r2';
+    NextGen: 'ng';
+    MobileApp: 'app';
+    AcceleratedMobilePages: 'amp';
+};
+declare const surges: {
+    readonly 0: "0";
+    readonly 50: "5";
+    readonly 100: "4";
+    readonly 200: "3";
+    readonly 300: "2";
+    readonly 400: "1";
+};
+/**
+ * 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://github.com/guardian/commercial-shared/blob/a692e8b2eba6e79eeeb666e5594f2193663f6514/src/main/scala/com/gu/commercial/display/AdTargetParam.scala
+ *
+ *
+ *
+ */
+type SharedTargeting = {
+    /**
+     * **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: Brands[keyof Brands];
+    /**
+     * **Co**ntributors and Authors - [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: ContentTypes[number];
+    /**
+     * **Edition** - [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=174207
+     */
+    edition: Editions[keyof 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';
+    /**
+     * **P**latform - [see on Ad Manager][gam]
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=180207
+     */
+    p: Platforms[keyof Platforms];
+    /**
+     * **Se**ries - [see on Ad Manager][gam]
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=180447
+     */
+    se: string[];
+    /**
+     * **Sh**ort URL - [see on Ad Manager][gam]
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=286047
+     */
+    sh: `https://www.theguardian.com/p/${string}`;
+    /**
+     * **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}`;
+};
+/**
+ * What goes in comes out
+ */
+declare const getSharedTargeting: (shared: Partial<SharedTargeting>) => Partial<SharedTargeting>;
+export declare const _: {
+    getSurgingParam: (surging: number) => SharedTargeting["su"];
+};
+export type { SharedTargeting };
+export { getSharedTargeting };

package/dist/cjs/targeting/shared.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSharedTargeting = exports._ = void 0;
+const pick_targeting_values_1 = require("./pick-targeting-values");
+const surges = {
+    0: '0',
+    50: '5',
+    100: '4',
+    200: '3',
+    300: '2',
+    400: '1',
+};
+/* -- Methods -- */
+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 -- */
+/**
+ * What goes in comes out
+ */
+const getSharedTargeting = (shared) => (0, pick_targeting_values_1.pickTargetingValues)(shared);
+exports.getSharedTargeting = getSharedTargeting;
+exports._ = {
+    getSurgingParam,
+};

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

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

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEligibleForTeads = void 0;
+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;
+};
+exports.isEligibleForTeads = isEligibleForTeads;

package/dist/cjs/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/cjs/targeting/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,48 @@
+import type { False, True } from './types';
+/**
+ * Viewport Targeting
+ *
+ * Includes values related to the viewport:
+ * - breakpoint (deprecated?)
+ * - whether a CMP banner will show
+ * - size of page skin
+ */
+type ViewportTargeting = {
+    /**
+     * **B**reak**p**oint – [see on Ad Manager][gam]
+     *
+     * Type: _Predefined_
+     *
+     * TODO: remove 'wide'
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=180327
+     */
+    bp: 'mobile' | 'tablet' | 'desktop';
+    /**
+     * InSkin (CMP Banner shown) – [see on Ad Manager][gam]
+     *
+     * Australia-specific (via Bonzai?)
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=11916570
+     * */
+    inskin: True | False;
+    /**
+     * **Skin size** – [see on Ad Manager][gam]
+     *
+     * Large or Small. Used for InSkin page skins
+     *
+     * Type: _Predefined_
+     *
+     * [gam]: https://admanager.google.com/59666047#inventory/custom_targeting/detail/custom_key_id=12312030
+     */
+    skinsize: 'l' | 's';
+};
+type Viewport = {
+    viewPortWidth: number;
+    cmpBannerWillShow: boolean;
+};
+declare const getViewportTargeting: ({ viewPortWidth, cmpBannerWillShow, }: Viewport) => ViewportTargeting;
+export type { ViewportTargeting };
+export { getViewportTargeting };

package/dist/cjs/targeting/viewport.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getViewportTargeting = void 0;
+/* -- Methods -- */
+const findBreakpoint = (width) => {
+    if (width >= 980)
+        return 'desktop';
+    if (width >= 660)
+        return 'tablet';
+    return 'mobile';
+};
+const getViewportTargeting = ({ viewPortWidth, cmpBannerWillShow, }) => {
+    // Don’t show inskin if if a privacy message will be shown or on preview
+    const isPreview = window.guardian.config.page.isPreview;
+    const inskin = cmpBannerWillShow || isPreview ? 'f' : 't';
+    return {
+        bp: findBreakpoint(viewPortWidth),
+        skinsize: viewPortWidth >= 1560 ? 'l' : 's',
+        inskin,
+    };
+};
+exports.getViewportTargeting = getViewportTargeting;

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

@@ -0,0 +1,12 @@
+import type { Participations } from '@guardian/ab-core';
+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, isSignedIn, }: BuildImaAdTagUrl) => string;
+export { buildImaAdTagUrl };