@guardian/commercial-core 0.31.0 → 0.34.1

package/README.md

@@ -24,7 +24,7 @@
 [![Generic badge](https://img.shields.io/badge/google-chat-259082.svg)](https://chat.google.com/room/AAAAPL2MBvE)
 
 ```bash
-pnpm add @guardian/commercial-core
+yarn add @guardian/commercial-core
 ```
 
 or
@@ -44,7 +44,7 @@ If your target environment does not support that, make sure you transpile this p
 ### Requirements
 
 1. [Node 14](https://nodejs.org/en/download/) ([nvm][] or [fnm][] recommended)
-2. [PNPM](https://pnpm.io/installation)
+2. [Yarn](https://classic.yarnpkg.com/en/docs/install/)
 
 [nvm]: https://github.com/nvm-sh/nvm
 [fnm]: https://github.com/Schniz/fnm

package/dist/cjs/EventTimer.d.ts

@@ -58,7 +58,6 @@ export declare class EventTimer {
      */
     get events(): Event[];
     constructor();
-    mark(name: string): void;
     /**
      * Creates a new performance mark
      * For slot events also ensures each TYPE of event event is marked only once for 'first'
@@ -68,6 +67,7 @@ export declare class EventTimer {
      * @param {origin} [origin=page] - Either 'page' (default) or the name of the slot
      */
     trigger(eventName: string, origin?: string): void;
-    trackInGA(eventName: string, label?: string): void;
+    private mark;
+    private trackInGA;
 }
 export {};

package/dist/cjs/EventTimer.js

@@ -102,20 +102,6 @@ class EventTimer {
             ]
             : this._events;
     }
-    mark(name) {
-        const longName = `gu.commercial.${name}`;
-        if (typeof window.performance !== 'undefined' &&
-            'mark' in window.performance) {
-            window.performance.mark(longName);
-            // Most recent mark with this name is the event we just created.
-            const mark = window.performance
-                .getEntriesByName(longName, 'mark')
-                .slice(-1)[0];
-            if (typeof mark !== 'undefined') {
-                this._events.push(new Event(name, mark));
-            }
-        }
-    }
     /**
      * Creates a new performance mark
      * For slot events also ensures each TYPE of event event is marked only once for 'first'
@@ -148,6 +134,20 @@ class EventTimer {
             }
         }
     }
+    mark(name) {
+        const longName = `gu.commercial.${name}`;
+        if (typeof window.performance !== 'undefined' &&
+            'mark' in window.performance) {
+            window.performance.mark(longName);
+            // Most recent mark with this name is the event we just created.
+            const mark = window.performance
+                .getEntriesByName(longName, 'mark')
+                .slice(-1)[0];
+            if (typeof mark !== 'undefined') {
+                this._events.push(new Event(name, mark));
+            }
+        }
+    }
     trackInGA(eventName, label = '') {
         const gaEvent = this.gaConfig.logEvents.find((e) => e.timingVariable === eventName);
         if (gaEvent) {

package/dist/cjs/detectAdBlocker.js

@@ -16,8 +16,9 @@ function adElementBlocked(ad) {
         ad.offsetTop === 0 ||
         ad.offsetWidth === 0 ||
         ad.clientHeight === 0 ||
-        ad.clientWidth === 0)
+        ad.clientWidth === 0) {
         return true;
+    }
     const adStyles = window.getComputedStyle(ad);
     if (adStyles.getPropertyValue('display') === 'none')
         return true;

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

@@ -1,31 +1,6 @@
 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";
-};
+import type { SharedTargeting } from './shared';
 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
  *
@@ -38,40 +13,6 @@ declare const contentTypes: readonly ["article", "audio", "crossword", "gallery"
  *
  */
 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]
      *
@@ -80,34 +21,6 @@ export declare type ContentTargeting = {
      * [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]
      *
@@ -120,42 +33,12 @@ export declare type ContentTargeting = {
      * [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]
      *
@@ -175,15 +58,12 @@ export declare type ContentTargeting = {
      */
     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;
+export declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }: {
+    eligibleForDCR: boolean;
+    path: SharedTargeting['url'];
+    renderingPlatform: ContentTargeting['rp'];
+    section: ContentTargeting['s'];
     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;
+}) => ContentTargeting;
 export {};

package/dist/cjs/targeting/content.js

@@ -3,17 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getContentTargeting = void 0;
 const libs_1 = require("@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',
@@ -27,32 +16,6 @@ const videoLengths = [
     '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);
@@ -65,24 +28,13 @@ const getUrlKeywords = (url) => {
         .slice(-1)[0];
     return (0, libs_1.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 -- */
-const getContentTargeting = ({ branding, contentType, contributors, platform, sensitive, tones, path, videoLength, surging, }, targeting) => {
+const getContentTargeting = ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }) => {
     return {
-        ...targeting,
-        br: branding ? brands[branding] : null,
-        co: contributors,
-        ct: contentType,
-        p: platforms[platform],
+        dcre: eligibleForDCR ? 't' : 'f',
+        rp: renderingPlatform,
+        s: section,
         sens: sensitive ? 't' : 'f',
-        tn: tones,
-        su: getSurgingParam(surging),
-        url: path,
         urlkw: getUrlKeywords(path),
         vl: videoLength ? getVideoLength(videoLength) : null,
     };

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

@@ -0,0 +1,25 @@
+import type { ConditionalExcept } from 'type-fest';
+declare type ValidTargetingObject<Base> = ConditionalExcept<Base, null | undefined | '' | readonly [] | readonly [''] | 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) => import("type-fest").Except<T, NonNullable<{ [Key in keyof T]: T[Key] extends number | boolean | "" | readonly [] | readonly [""] | null | undefined ? Key : never; }[keyof 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.js

@@ -44,8 +44,9 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     const serverSideExperiments = Object.entries(serverSideParticipations)
         .map((test) => testToParams(...test))
         .filter(libs_1.isString);
-    if (clientSideExperiment.length + serverSideExperiments.length === 0)
+    if (clientSideExperiment.length + serverSideExperiments.length === 0) {
         return null;
+    }
     return [...clientSideExperiment, ...serverSideExperiments];
 };
 /* -- Targeting -- */

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

@@ -0,0 +1,142 @@
+declare const brands: {
+    readonly Foundation: "f";
+    readonly Paid: "p";
+    readonly 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";
+};
+declare const platforms: {
+    readonly R2: "r2";
+    readonly NextGen: "ng";
+    readonly MobileApp: "app";
+    readonly 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://git.io/JDJ6W
+ *
+ * It is generated in `commercial-shared` https://git.io/JDJ62
+ *
+ *
+ *
+ */
+export declare 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: typeof brands[keyof typeof 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: typeof 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: 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';
+    /**
+     * **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];
+    /**
+     * **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
+ */
+export declare const getSharedTargeting: (shared: Partial<SharedTargeting>) => Partial<SharedTargeting>;
+export declare const _: {
+    getSurgingParam: (surging: number) => SharedTargeting['su'];
+};
+export {};

package/dist/cjs/targeting/shared.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._ = exports.getSharedTargeting = void 0;
+const pick_targeting_values_1 = require("./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',
+    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/esm/EventTimer.d.ts

@@ -58,7 +58,6 @@ export declare class EventTimer {
      */
     get events(): Event[];
     constructor();
-    mark(name: string): void;
     /**
      * Creates a new performance mark
      * For slot events also ensures each TYPE of event event is marked only once for 'first'
@@ -68,6 +67,7 @@ export declare class EventTimer {
      * @param {origin} [origin=page] - Either 'page' (default) or the name of the slot
      */
     trigger(eventName: string, origin?: string): void;
-    trackInGA(eventName: string, label?: string): void;
+    private mark;
+    private trackInGA;
 }
 export {};

package/dist/esm/EventTimer.js

@@ -99,20 +99,6 @@ export class EventTimer {
             ]
             : this._events;
     }
-    mark(name) {
-        const longName = `gu.commercial.${name}`;
-        if (typeof window.performance !== 'undefined' &&
-            'mark' in window.performance) {
-            window.performance.mark(longName);
-            // Most recent mark with this name is the event we just created.
-            const mark = window.performance
-                .getEntriesByName(longName, 'mark')
-                .slice(-1)[0];
-            if (typeof mark !== 'undefined') {
-                this._events.push(new Event(name, mark));
-            }
-        }
-    }
     /**
      * Creates a new performance mark
      * For slot events also ensures each TYPE of event event is marked only once for 'first'
@@ -145,6 +131,20 @@ export class EventTimer {
             }
         }
     }
+    mark(name) {
+        const longName = `gu.commercial.${name}`;
+        if (typeof window.performance !== 'undefined' &&
+            'mark' in window.performance) {
+            window.performance.mark(longName);
+            // Most recent mark with this name is the event we just created.
+            const mark = window.performance
+                .getEntriesByName(longName, 'mark')
+                .slice(-1)[0];
+            if (typeof mark !== 'undefined') {
+                this._events.push(new Event(name, mark));
+            }
+        }
+    }
     trackInGA(eventName, label = '') {
         const gaEvent = this.gaConfig.logEvents.find((e) => e.timingVariable === eventName);
         if (gaEvent) {

package/dist/esm/detectAdBlocker.js

@@ -13,8 +13,9 @@ function adElementBlocked(ad) {
         ad.offsetTop === 0 ||
         ad.offsetWidth === 0 ||
         ad.clientHeight === 0 ||
-        ad.clientWidth === 0)
+        ad.clientWidth === 0) {
         return true;
+    }
     const adStyles = window.getComputedStyle(ad);
     if (adStyles.getPropertyValue('display') === 'none')
         return true;

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

@@ -1,31 +1,6 @@
 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";
-};
+import type { SharedTargeting } from './shared';
 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
  *
@@ -38,40 +13,6 @@ declare const contentTypes: readonly ["article", "audio", "crossword", "gallery"
  *
  */
 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]
      *
@@ -80,34 +21,6 @@ export declare type ContentTargeting = {
      * [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]
      *
@@ -120,42 +33,12 @@ export declare type ContentTargeting = {
      * [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]
      *
@@ -175,15 +58,12 @@ export declare type ContentTargeting = {
      */
     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;
+export declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }: {
+    eligibleForDCR: boolean;
+    path: SharedTargeting['url'];
+    renderingPlatform: ContentTargeting['rp'];
+    section: ContentTargeting['s'];
     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;
+}) => ContentTargeting;
 export {};

package/dist/esm/targeting/content.js

@@ -1,16 +1,5 @@
 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',
@@ -24,32 +13,6 @@ const videoLengths = [
     '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);
@@ -62,24 +25,13 @@ const getUrlKeywords = (url) => {
         .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) => {
+export const getContentTargeting = ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }) => {
     return {
-        ...targeting,
-        br: branding ? brands[branding] : null,
-        co: contributors,
-        ct: contentType,
-        p: platforms[platform],
+        dcre: eligibleForDCR ? 't' : 'f',
+        rp: renderingPlatform,
+        s: section,
         sens: sensitive ? 't' : 'f',
-        tn: tones,
-        su: getSurgingParam(surging),
-        url: path,
         urlkw: getUrlKeywords(path),
         vl: videoLength ? getVideoLength(videoLength) : null,
     };

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

@@ -0,0 +1,25 @@
+import type { ConditionalExcept } from 'type-fest';
+declare type ValidTargetingObject<Base> = ConditionalExcept<Base, null | undefined | '' | readonly [] | readonly [''] | 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) => import("type-fest").Except<T, NonNullable<{ [Key in keyof T]: T[Key] extends number | boolean | "" | readonly [] | readonly [""] | null | undefined ? Key : never; }[keyof T]>>;
+export {};

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

@@ -0,0 +1,43 @@
+import { isString } from '@guardian/libs';
+const isTargetingString = (string) => 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
+ * ```
+ */
+export 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);
+};

package/dist/esm/targeting/session.js

@@ -41,8 +41,9 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     const serverSideExperiments = Object.entries(serverSideParticipations)
         .map((test) => testToParams(...test))
         .filter(isString);
-    if (clientSideExperiment.length + serverSideExperiments.length === 0)
+    if (clientSideExperiment.length + serverSideExperiments.length === 0) {
         return null;
+    }
     return [...clientSideExperiment, ...serverSideExperiments];
 };
 /* -- Targeting -- */

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

@@ -0,0 +1,142 @@
+declare const brands: {
+    readonly Foundation: "f";
+    readonly Paid: "p";
+    readonly 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";
+};
+declare const platforms: {
+    readonly R2: "r2";
+    readonly NextGen: "ng";
+    readonly MobileApp: "app";
+    readonly 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://git.io/JDJ6W
+ *
+ * It is generated in `commercial-shared` https://git.io/JDJ62
+ *
+ *
+ *
+ */
+export declare 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: typeof brands[keyof typeof 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: typeof 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: 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';
+    /**
+     * **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];
+    /**
+     * **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
+ */
+export declare const getSharedTargeting: (shared: Partial<SharedTargeting>) => Partial<SharedTargeting>;
+export declare const _: {
+    getSurgingParam: (surging: number) => SharedTargeting['su'];
+};
+export {};

package/dist/esm/targeting/shared.js

@@ -0,0 +1,54 @@
+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',
+    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
+ */
+export const getSharedTargeting = (shared) => pickTargetingValues(shared);
+export const _ = {
+    getSurgingParam,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "0.31.0",
+  "version": "0.34.1",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial-core#readme",
   "bugs": {
@@ -57,7 +57,7 @@
     "@typescript-eslint/parser": "^5.5.0",
     "commitizen": "^4.2.4",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.3.0",
+    "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.25.3",
@@ -71,6 +71,7 @@
     "prettier": "^2.5.0",
     "semantic-release": "^18.0.1",
     "ts-jest": "^27.0.7",
+    "type-fest": "^2.8.0",
     "typescript": "^4.5.2",
     "web-vitals": "^2.1.2"
   },