@guardian/commercial-core 4.20.0 → 4.22.0

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

@@ -1,6 +1,5 @@
 import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
-import type { AdsConfig, AdsConfigDisabled, MaybeArray } from './types';
-declare type CustomParams = Record<string, MaybeArray<string | number | boolean>>;
+import type { AdsConfig, AdsConfigDisabled, CustomParams } from './types';
 declare const disabledAds: AdsConfigDisabled;
 declare const buildAdsConfigWithConsent: (isAdFreeUser: boolean, adUnit: string, customParamsToMerge: CustomParams, consentState: ConsentState) => AdsConfig;
 export { buildAdsConfigWithConsent, disabledAds };

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/index.d.ts

@@ -40,3 +40,4 @@ export { a9Apstag } from './__vendor/a9-apstag';
 export { ipsosMoriStub } from './__vendor/ipsos-mori';
 export { launchpad } from './__vendor/launchpad';
 export { pubmatic } from './__vendor/pubmatic';
+export { buildImaAdTagUrl } from './targeting/youtube-ima';

package/dist/cjs/index.js

@@ -24,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pubmatic = exports.launchpad = exports.ipsosMoriStub = exports.a9Apstag = exports.buildPageTargetingConsentless = exports.buildPageTargeting = exports.postMessage = exports.initMessenger = exports.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.concatSizeMappings = exports.createAdSlot = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackGpcSignal = exports.initTrackLabsContainer = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.isBreakpoint = exports.standardAdSizes = exports.slotSizeMappings = exports.outstreamSizes = exports.getAdSize = exports.createAdSize = exports.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.permutive = exports.ias = void 0;
+exports.buildImaAdTagUrl = exports.pubmatic = exports.launchpad = exports.ipsosMoriStub = exports.a9Apstag = exports.buildPageTargetingConsentless = exports.buildPageTargeting = exports.postMessage = exports.initMessenger = exports.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.concatSizeMappings = exports.createAdSlot = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackGpcSignal = exports.initTrackLabsContainer = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.isBreakpoint = exports.standardAdSizes = exports.slotSizeMappings = exports.outstreamSizes = exports.getAdSize = exports.createAdSize = exports.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.permutive = exports.ias = void 0;
 var ias_1 = require("./third-party-tags/ias");
 Object.defineProperty(exports, "ias", { enumerable: true, get: function () { return ias_1.ias; } });
 var permutive_1 = require("./third-party-tags/permutive");
@@ -97,3 +97,5 @@ var launchpad_1 = require("./__vendor/launchpad");
 Object.defineProperty(exports, "launchpad", { enumerable: true, get: function () { return launchpad_1.launchpad; } });
 var pubmatic_1 = require("./__vendor/pubmatic");
 Object.defineProperty(exports, "pubmatic", { enumerable: true, get: function () { return pubmatic_1.pubmatic; } });
+var youtube_ima_1 = require("./targeting/youtube-ima");
+Object.defineProperty(exports, "buildImaAdTagUrl", { enumerable: true, get: function () { return youtube_ima_1.buildImaAdTagUrl; } });

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

@@ -33,6 +33,7 @@ declare type PageTargeting = PartialWithNulls<{
     vl: string;
     [_: string]: string | string[];
 } & SharedTargeting>;
+declare const filterValues: (pageTargets: Record<string, unknown>) => Record<string, string | string[]>;
 declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean) => PageTargeting;
-export { buildPageTargeting };
+export { buildPageTargeting, filterValues };
 export type { PageTargeting };

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildPageTargeting = void 0;
+exports.filterValues = exports.buildPageTargeting = void 0;
 const consent_management_platform_1 = require("@guardian/consent-management-platform");
 const libs_1 = require("@guardian/libs");
 const ab_localstorage_1 = require("../lib/ab-localstorage");
@@ -10,7 +10,7 @@ const personalised_1 = require("./personalised");
 const session_1 = require("./session");
 const shared_1 = require("./shared");
 const viewport_1 = require("./viewport");
-const filterEmptyValues = (pageTargets) => {
+const filterValues = (pageTargets) => {
     const filtered = {};
     for (const key in pageTargets) {
         const value = pageTargets[key];
@@ -25,6 +25,7 @@ const filterEmptyValues = (pageTargets) => {
     }
     return filtered;
 };
+exports.filterValues = filterValues;
 const buildPageTargeting = (consentState, adFree) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
@@ -72,8 +73,8 @@ const buildPageTargeting = (consentState, adFree) => {
         ...sessionTargeting,
         ...viewportTargeting,
     };
-    // filter out empty values
-    const pageTargeting = filterEmptyValues(pageTargets);
+    // filter !(string | string[]) and empty values
+    const pageTargeting = filterValues(pageTargets);
     return pageTargeting;
 };
 exports.buildPageTargeting = buildPageTargeting;

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/session.d.ts

@@ -97,6 +97,7 @@ declare type AllParticipations = {
         [key: `${string}Variant`]: 'variant';
     };
 };
+declare const experimentsTargeting: ({ clientSideParticipations, serverSideParticipations, }: AllParticipations) => SessionTargeting['ab'];
 declare type Session = {
     adTest: SessionTargeting['at'];
     countryCode: CountryCode;
@@ -107,4 +108,4 @@ declare type Session = {
 };
 declare const getSessionTargeting: ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
 export type { SessionTargeting, AllParticipations };
-export { getSessionTargeting };
+export { getSessionTargeting, experimentsTargeting };

package/dist/cjs/targeting/session.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSessionTargeting = void 0;
+exports.experimentsTargeting = exports.getSessionTargeting = void 0;
 const libs_1 = require("@guardian/libs");
 /* -- Types -- */
 const referrers = [
@@ -49,6 +49,7 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     }
     return [...clientSideExperiment, ...serverSideExperiments];
 };
+exports.experimentsTargeting = experimentsTargeting;
 const getSessionTargeting = ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }) => ({
     ab: experimentsTargeting(participations),
     at: adTest,

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

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

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

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildImaAdTagUrl = void 0;
+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 encodeCustomParams = (params) => {
+    const encodedParams = Object.entries(params)
+        .map(([key, value]) => {
+        const queryValue = Array.isArray(value)
+            ? value.join(',')
+            : String(value);
+        return `${key}=${encodeURIComponent(queryValue)}`;
+    })
+        .join('&');
+    return encodedParams;
+};
+const buildImaAdTagUrl = (adUnit, customParams, consentState) => {
+    const pageTargeting = (0, build_page_targeting_1.buildPageTargeting)(consentState, false);
+    const mergedCustomParams = { ...customParams, ...pageTargeting };
+    const queryParams = {
+        iu: adUnit,
+        tfcd: '0',
+        npa: '0',
+        sz: '480x360|480x361|400x300',
+        gdfp_req: '1',
+        output: 'vast',
+        unviewed_position_start: '1',
+        env: 'vp',
+        impl: 's',
+        vad_type: 'linear',
+        vpos: 'preroll',
+        /**
+         * 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)) {
+        queryParamsArray.push(`${k}=${v}`);
+    }
+    return ('https://pubads.g.doubleclick.net/gampad/ads?' +
+        queryParamsArray.join('&'));
+};
+exports.buildImaAdTagUrl = buildImaAdTagUrl;

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

@@ -1,6 +1,5 @@
 import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
-import type { AdsConfig, AdsConfigDisabled, MaybeArray } from './types';
-declare type CustomParams = Record<string, MaybeArray<string | number | boolean>>;
+import type { AdsConfig, AdsConfigDisabled, CustomParams } from './types';
 declare const disabledAds: AdsConfigDisabled;
 declare const buildAdsConfigWithConsent: (isAdFreeUser: boolean, adUnit: string, customParamsToMerge: CustomParams, consentState: ConsentState) => AdsConfig;
 export { buildAdsConfigWithConsent, disabledAds };

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/index.d.ts

@@ -40,3 +40,4 @@ export { a9Apstag } from './__vendor/a9-apstag';
 export { ipsosMoriStub } from './__vendor/ipsos-mori';
 export { launchpad } from './__vendor/launchpad';
 export { pubmatic } from './__vendor/pubmatic';
+export { buildImaAdTagUrl } from './targeting/youtube-ima';

package/dist/esm/index.js

@@ -32,3 +32,4 @@ export { a9Apstag } from './__vendor/a9-apstag';
 export { ipsosMoriStub } from './__vendor/ipsos-mori';
 export { launchpad } from './__vendor/launchpad';
 export { pubmatic } from './__vendor/pubmatic';
+export { buildImaAdTagUrl } from './targeting/youtube-ima';

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

@@ -33,6 +33,7 @@ declare type PageTargeting = PartialWithNulls<{
     vl: string;
     [_: string]: string | string[];
 } & SharedTargeting>;
+declare const filterValues: (pageTargets: Record<string, unknown>) => Record<string, string | string[]>;
 declare const buildPageTargeting: (consentState: ConsentState, adFree: boolean) => PageTargeting;
-export { buildPageTargeting };
+export { buildPageTargeting, filterValues };
 export type { PageTargeting };

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

@@ -7,7 +7,7 @@ import { getPersonalisedTargeting } from './personalised';
 import { getSessionTargeting } from './session';
 import { getSharedTargeting } from './shared';
 import { getViewportTargeting } from './viewport';
-const filterEmptyValues = (pageTargets) => {
+const filterValues = (pageTargets) => {
     const filtered = {};
     for (const key in pageTargets) {
         const value = pageTargets[key];
@@ -69,8 +69,8 @@ const buildPageTargeting = (consentState, adFree) => {
         ...sessionTargeting,
         ...viewportTargeting,
     };
-    // filter out empty values
-    const pageTargeting = filterEmptyValues(pageTargets);
+    // filter !(string | string[]) and empty values
+    const pageTargeting = filterValues(pageTargets);
     return pageTargeting;
 };
-export { buildPageTargeting };
+export { buildPageTargeting, filterValues };

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/session.d.ts

@@ -97,6 +97,7 @@ declare type AllParticipations = {
         [key: `${string}Variant`]: 'variant';
     };
 };
+declare const experimentsTargeting: ({ clientSideParticipations, serverSideParticipations, }: AllParticipations) => SessionTargeting['ab'];
 declare type Session = {
     adTest: SessionTargeting['at'];
     countryCode: CountryCode;
@@ -107,4 +108,4 @@ declare type Session = {
 };
 declare const getSessionTargeting: ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
 export type { SessionTargeting, AllParticipations };
-export { getSessionTargeting };
+export { getSessionTargeting, experimentsTargeting };

package/dist/esm/targeting/session.js

@@ -54,4 +54,4 @@ const getSessionTargeting = ({ adTest, countryCode, isSignedIn, pageViewId, part
     ref: getReferrer(referrer),
     si: isSignedIn ? 't' : 'f',
 });
-export { getSessionTargeting };
+export { getSessionTargeting, experimentsTargeting };

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

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

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

@@ -0,0 +1,46 @@
+import { buildPageTargeting, filterValues } from './build-page-targeting';
+/**
+ * @param  {Record<string, MaybeArray<string|number|boolean>>
+ * Follows https://support.google.com/admanager/answer/1080597
+ */
+const encodeCustomParams = (params) => {
+    const encodedParams = Object.entries(params)
+        .map(([key, value]) => {
+        const queryValue = Array.isArray(value)
+            ? value.join(',')
+            : String(value);
+        return `${key}=${encodeURIComponent(queryValue)}`;
+    })
+        .join('&');
+    return encodedParams;
+};
+const buildImaAdTagUrl = (adUnit, customParams, consentState) => {
+    const pageTargeting = buildPageTargeting(consentState, false);
+    const mergedCustomParams = { ...customParams, ...pageTargeting };
+    const queryParams = {
+        iu: adUnit,
+        tfcd: '0',
+        npa: '0',
+        sz: '480x360|480x361|400x300',
+        gdfp_req: '1',
+        output: 'vast',
+        unviewed_position_start: '1',
+        env: 'vp',
+        impl: 's',
+        vad_type: 'linear',
+        vpos: 'preroll',
+        /**
+         * 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)) {
+        queryParamsArray.push(`${k}=${v}`);
+    }
+    return ('https://pubads.g.doubleclick.net/gampad/ads?' +
+        queryParamsArray.join('&'));
+};
+export { buildImaAdTagUrl };

package/package.json

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