@guardian/commercial-core 4.21.0 → 4.23.0

package/dist/cjs/event-timer.d.ts

@@ -35,7 +35,7 @@ interface EventTimerProperties {
     hasLabsContainer?: boolean;
     labsUrl?: string;
 }
-export declare class EventTimer {
+declare class EventTimer {
     private _events;
     private static _externallyDefinedEventNames;
     startTS: DOMHighResTimeStamp;
@@ -87,4 +87,4 @@ export declare class EventTimer {
     private mark;
     private trackInGA;
 }
-export {};
+export { EventTimer };

package/dist/cjs/global.d.ts

@@ -2,11 +2,15 @@
 import type { GoogleTagParams, GoogleTrackConversionObject, GuardianWindowConfig } from './types';
 import type { EventTimer } from '.';
 declare global {
+    type ConnectionType = 'bluetooth' | 'cellular' | 'ethernet' | 'mixed' | 'none' | 'other' | 'unknown' | 'wifi';
     interface NetworkInformation extends EventTarget {
-        readonly type: ConnectionType;
+        readonly type?: ConnectionType;
         readonly downlink?: number;
         readonly effectiveType?: string;
     }
+    interface Navigator {
+        readonly connection: NetworkInformation;
+    }
     interface Window {
         google_trackConversion?: (arg0: GoogleTrackConversionObject) => void;
         google_tag_params?: GoogleTagParams;

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

@@ -21,5 +21,5 @@ declare type ValidTargetingObject<Base> = ConditionalExcept<Base, null | undefin
  * 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 | "" | never[] | readonly [] | readonly [""] | null | undefined ? Key : never; }[keyof T]>>;
+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 {};

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

@@ -1,3 +1,4 @@
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
 import type { CustomParams } from '../types';
-declare const buildImaAdTagUrl: (adUnit: string, customParams: CustomParams) => string;
+declare const buildImaAdTagUrl: (adUnit: string, customParams: CustomParams, consentState: ConsentState) => string;
 export { buildImaAdTagUrl };

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

@@ -1,33 +1,44 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildImaAdTagUrl = void 0;
+const libs_1 = require("@guardian/libs");
 const build_page_targeting_1 = require("./build-page-targeting");
 /**
  * @param  {Record<string, MaybeArray<string|number|boolean>>
  * Follows https://support.google.com/admanager/answer/1080597
  */
-const encodeVastTagKeyValues = (query) => {
-    const unencodedUrl = Object.entries(query)
+const encodeCustomParams = (params) => {
+    const encodedParams = Object.entries(params)
         .map(([key, value]) => {
         const queryValue = Array.isArray(value)
             ? value.join(',')
             : String(value);
-        return `${key}=${queryValue}`;
+        return `${key}=${encodeURIComponent(queryValue)}`;
     })
         .join('&');
-    return unencodedUrl
-        .replace(/=/g, '%3D')
-        .replace(/&/g, '%26')
-        .replace(/,/g, '%2C');
+    return encodedParams;
 };
-const buildImaAdTagUrl = (adUnit, customParams) => {
-    // TODO: Add regular build-page-targeting to
-    // get all targeting including ab participations.
-    // For now hardcode adtest (at)
-    const mergedCustomParams = { ...customParams, at: 'fixed-puppies' };
+const mergeCustomParamsWithTargeting = (customParams, consentState) => {
+    let pageTargeting = {};
+    try {
+        pageTargeting = (0, build_page_targeting_1.buildPageTargeting)(consentState, false);
+    }
+    catch (e) {
+        /**
+         * Defensive error handling in case YoutubeAtom is used in an
+         * environment where guardian.config, cookies, localstorage etc
+         * are not available
+         */
+        (0, libs_1.log)('commercial', 'Error building YouTube IMA custom params', e);
+        return customParams;
+    }
+    const mergedCustomParams = { ...customParams, ...pageTargeting };
+    return mergedCustomParams;
+};
+const buildImaAdTagUrl = (adUnit, customParams, consentState) => {
+    const mergedCustomParams = mergeCustomParamsWithTargeting(customParams, consentState);
     const queryParams = {
         iu: adUnit,
-        description_url: '[placeholder]',
         tfcd: '0',
         npa: '0',
         sz: '480x360|480x361|400x300',
@@ -36,10 +47,14 @@ const buildImaAdTagUrl = (adUnit, customParams) => {
         unviewed_position_start: '1',
         env: 'vp',
         impl: 's',
-        correlator: '',
         vad_type: 'linear',
         vpos: 'preroll',
-        cust_params: encodeVastTagKeyValues((0, build_page_targeting_1.filterValues)(mergedCustomParams)),
+        /**
+         * cust_params string is encoded
+         * cust_params values are also encoded so they will get double encoded
+         * this ensures any values with separator chars (=&,) do not conflict with the main string
+         */
+        cust_params: encodeURIComponent(encodeCustomParams((0, build_page_targeting_1.filterValues)(mergedCustomParams))),
     };
     const queryParamsArray = [];
     for (const [k, v] of Object.entries(queryParams)) {

package/dist/esm/event-timer.d.ts

@@ -35,7 +35,7 @@ interface EventTimerProperties {
     hasLabsContainer?: boolean;
     labsUrl?: string;
 }
-export declare class EventTimer {
+declare class EventTimer {
     private _events;
     private static _externallyDefinedEventNames;
     startTS: DOMHighResTimeStamp;
@@ -87,4 +87,4 @@ export declare class EventTimer {
     private mark;
     private trackInGA;
 }
-export {};
+export { EventTimer };

package/dist/esm/event-timer.js

@@ -5,7 +5,7 @@ class Event {
         this.ts = mark.startTime;
     }
 }
-export class EventTimer {
+class EventTimer {
     constructor() {
         this._events = [];
         this.startTS = window.performance.now();
@@ -177,3 +177,4 @@ EventTimer._externallyDefinedEventNames = [
     'cmp-aus-ui-displayed',
     'cmp-aus-got-consent',
 ];
+export { EventTimer };

package/dist/esm/global.d.ts

@@ -2,11 +2,15 @@
 import type { GoogleTagParams, GoogleTrackConversionObject, GuardianWindowConfig } from './types';
 import type { EventTimer } from '.';
 declare global {
+    type ConnectionType = 'bluetooth' | 'cellular' | 'ethernet' | 'mixed' | 'none' | 'other' | 'unknown' | 'wifi';
     interface NetworkInformation extends EventTarget {
-        readonly type: ConnectionType;
+        readonly type?: ConnectionType;
         readonly downlink?: number;
         readonly effectiveType?: string;
     }
+    interface Navigator {
+        readonly connection: NetworkInformation;
+    }
     interface Window {
         google_trackConversion?: (arg0: GoogleTrackConversionObject) => void;
         google_tag_params?: GoogleTagParams;

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

@@ -21,5 +21,5 @@ declare type ValidTargetingObject<Base> = ConditionalExcept<Base, null | undefin
  * 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 | "" | never[] | readonly [] | readonly [""] | null | undefined ? Key : never; }[keyof T]>>;
+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 {};

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

@@ -1,3 +1,4 @@
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
 import type { CustomParams } from '../types';
-declare const buildImaAdTagUrl: (adUnit: string, customParams: CustomParams) => string;
+declare const buildImaAdTagUrl: (adUnit: string, customParams: CustomParams, consentState: ConsentState) => string;
 export { buildImaAdTagUrl };

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

@@ -1,30 +1,41 @@
-import { filterValues } from './build-page-targeting';
+import { log } from '@guardian/libs';
+import { buildPageTargeting, filterValues } from './build-page-targeting';
 /**
  * @param  {Record<string, MaybeArray<string|number|boolean>>
  * Follows https://support.google.com/admanager/answer/1080597
  */
-const encodeVastTagKeyValues = (query) => {
-    const unencodedUrl = Object.entries(query)
+const encodeCustomParams = (params) => {
+    const encodedParams = Object.entries(params)
         .map(([key, value]) => {
         const queryValue = Array.isArray(value)
             ? value.join(',')
             : String(value);
-        return `${key}=${queryValue}`;
+        return `${key}=${encodeURIComponent(queryValue)}`;
     })
         .join('&');
-    return unencodedUrl
-        .replace(/=/g, '%3D')
-        .replace(/&/g, '%26')
-        .replace(/,/g, '%2C');
+    return encodedParams;
 };
-const buildImaAdTagUrl = (adUnit, customParams) => {
-    // TODO: Add regular build-page-targeting to
-    // get all targeting including ab participations.
-    // For now hardcode adtest (at)
-    const mergedCustomParams = { ...customParams, at: 'fixed-puppies' };
+const mergeCustomParamsWithTargeting = (customParams, consentState) => {
+    let pageTargeting = {};
+    try {
+        pageTargeting = buildPageTargeting(consentState, false);
+    }
+    catch (e) {
+        /**
+         * Defensive error handling in case YoutubeAtom is used in an
+         * environment where guardian.config, cookies, localstorage etc
+         * are not available
+         */
+        log('commercial', 'Error building YouTube IMA custom params', e);
+        return customParams;
+    }
+    const mergedCustomParams = { ...customParams, ...pageTargeting };
+    return mergedCustomParams;
+};
+const buildImaAdTagUrl = (adUnit, customParams, consentState) => {
+    const mergedCustomParams = mergeCustomParamsWithTargeting(customParams, consentState);
     const queryParams = {
         iu: adUnit,
-        description_url: '[placeholder]',
         tfcd: '0',
         npa: '0',
         sz: '480x360|480x361|400x300',
@@ -33,10 +44,14 @@ const buildImaAdTagUrl = (adUnit, customParams) => {
         unviewed_position_start: '1',
         env: 'vp',
         impl: 's',
-        correlator: '',
         vad_type: 'linear',
         vpos: 'preroll',
-        cust_params: encodeVastTagKeyValues(filterValues(mergedCustomParams)),
+        /**
+         * cust_params string is encoded
+         * cust_params values are also encoded so they will get double encoded
+         * this ensures any values with separator chars (=&,) do not conflict with the main string
+         */
+        cust_params: encodeURIComponent(encodeCustomParams(filterValues(mergedCustomParams))),
     };
     const queryParamsArray = [];
     for (const [k, v] of Object.entries(queryParams)) {

package/package.json

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