@guardian/commercial-core 4.22.0 → 4.24.0

package/dist/cjs/index.d.ts

@@ -15,7 +15,7 @@ export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments,
 export { initTrackScrollDepth } from './track-scroll-depth';
 export { initTrackLabsContainer } from './track-labs-container';
 export { initTrackGpcSignal } from './track-gpc-signal';
-export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';
+export { buildAdsConfigWithConsent, disabledAds } from './targeting/youtube';
 export { createAdSlot, concatSizeMappings } from './create-ad-slot';
 export type { AdsConfig, AdsConfigBasic, AdsConfigDisabled, AdTargetingBuilder, CustomParams, } from './types';
 export * as constants from './constants';

package/dist/cjs/index.js

@@ -61,9 +61,9 @@ var track_labs_container_1 = require("./track-labs-container");
 Object.defineProperty(exports, "initTrackLabsContainer", { enumerable: true, get: function () { return track_labs_container_1.initTrackLabsContainer; } });
 var track_gpc_signal_1 = require("./track-gpc-signal");
 Object.defineProperty(exports, "initTrackGpcSignal", { enumerable: true, get: function () { return track_gpc_signal_1.initTrackGpcSignal; } });
-var ad_targeting_youtube_1 = require("./ad-targeting-youtube");
-Object.defineProperty(exports, "buildAdsConfigWithConsent", { enumerable: true, get: function () { return ad_targeting_youtube_1.buildAdsConfigWithConsent; } });
-Object.defineProperty(exports, "disabledAds", { enumerable: true, get: function () { return ad_targeting_youtube_1.disabledAds; } });
+var youtube_1 = require("./targeting/youtube");
+Object.defineProperty(exports, "buildAdsConfigWithConsent", { enumerable: true, get: function () { return youtube_1.buildAdsConfigWithConsent; } });
+Object.defineProperty(exports, "disabledAds", { enumerable: true, get: function () { return youtube_1.disabledAds; } });
 var create_ad_slot_1 = require("./create-ad-slot");
 Object.defineProperty(exports, "createAdSlot", { enumerable: true, get: function () { return create_ad_slot_1.createAdSlot; } });
 Object.defineProperty(exports, "concatSizeMappings", { enumerable: true, get: function () { return create_ad_slot_1.concatSizeMappings; } });

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

@@ -35,7 +35,10 @@ const isConsentlessKey = (key) => consentlessTargetingKeys.includes(key);
  * @returns ConsentlessPageTargeting
  */
 const buildPageTargetingConsentless = (consentState, adFree) => {
-    const consentedPageTargeting = (0, build_page_targeting_1.buildPageTargeting)(consentState, adFree);
+    const consentedPageTargeting = (0, build_page_targeting_1.buildPageTargeting)({
+        consentState,
+        adFree,
+    });
     return Object.fromEntries(Object.entries(consentedPageTargeting).filter(([k]) => isConsentlessKey(k)));
 };
 exports.buildPageTargetingConsentless = buildPageTargetingConsentless;

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

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

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

@@ -26,7 +26,7 @@ const filterValues = (pageTargets) => {
     return filtered;
 };
 exports.filterValues = filterValues;
-const buildPageTargeting = (consentState, adFree) => {
+const buildPageTargeting = ({ consentState, adFree, youtube = false, }) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
     const contentTargeting = (0, content_1.getContentTargeting)({
@@ -64,7 +64,10 @@ const buildPageTargeting = (consentState, adFree) => {
     const sharedAdTargeting = page.sharedAdTargeting
         ? (0, shared_1.getSharedTargeting)(page.sharedAdTargeting)
         : {};
-    const personalisedTargeting = (0, personalised_1.getPersonalisedTargeting)(consentState);
+    const personalisedTargeting = (0, personalised_1.getPersonalisedTargeting)({
+        state: consentState,
+        youtube,
+    });
     const pageTargets = {
         ...personalisedTargeting,
         ...sharedAdTargeting,

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

@@ -75,6 +75,10 @@ declare type PersonalisedTargeting = {
      */
     rdp: True | False | NotApplicable;
 };
-declare const getPersonalisedTargeting: (state: ConsentState) => PersonalisedTargeting;
+declare type Personalised = {
+    state: ConsentState;
+    youtube: boolean;
+};
+declare const getPersonalisedTargeting: ({ state, youtube, }: Personalised) => PersonalisedTargeting;
 export { getPersonalisedTargeting };
 export type { PersonalisedTargeting, AdManagerGroup, Frequency };

package/dist/cjs/targeting/personalised.js

@@ -124,17 +124,17 @@ const getAdManagerGroup = (state) => {
         ? existingGroup
         : createAdManagerGroup();
 };
-const getPermutiveWithState = (state) => {
-    if (state.canTarget)
-        return (0, permutive_1.getPermutiveSegments)();
+const getPermutiveWithState = (state, youtube) => {
+    if (state.canTarget) {
+        return youtube ? (0, permutive_1.getPermutivePFPSegments)() : (0, permutive_1.getPermutiveSegments)();
+    }
     (0, permutive_1.clearPermutiveSegments)();
     return [];
 };
-/* -- Targeting -- */
-const getPersonalisedTargeting = (state) => ({
+const getPersonalisedTargeting = ({ state, youtube, }) => ({
     amtgrp: getAdManagerGroup(state),
     fr: getFrequencyValue(state),
-    permutive: getPermutiveWithState(state),
+    permutive: getPermutiveWithState(state, youtube),
     ...getCMPTargeting(state),
 });
 exports.getPersonalisedTargeting = getPersonalisedTargeting;

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

@@ -1,6 +1,7 @@
 "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>>
@@ -17,9 +18,28 @@ const encodeCustomParams = (params) => {
         .join('&');
     return encodedParams;
 };
-const buildImaAdTagUrl = (adUnit, customParams, consentState) => {
-    const pageTargeting = (0, build_page_targeting_1.buildPageTargeting)(consentState, false);
+const mergeCustomParamsWithTargeting = (customParams, consentState) => {
+    let pageTargeting = {};
+    try {
+        pageTargeting = (0, build_page_targeting_1.buildPageTargeting)({
+            consentState: consentState,
+            adFree: 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,
         tfcd: '0',

package/dist/cjs/{ad-targeting-youtube.d.ts → targeting/youtube.d.ts}

@@ -1,5 +1,5 @@
 import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
-import type { AdsConfig, AdsConfigDisabled, CustomParams } from './types';
+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/{ad-targeting-youtube.js → targeting/youtube.js}

@@ -1,22 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.disabledAds = exports.buildAdsConfigWithConsent = void 0;
-const libs_1 = require("@guardian/libs");
-const can_use_dom_1 = require("./lib/can-use-dom");
-const construct_query_1 = require("./lib/construct-query");
-const permutive_1 = require("./permutive");
+const construct_query_1 = require("../lib/construct-query");
+const build_page_targeting_1 = require("./build-page-targeting");
 const disabledAds = { disableAds: true };
 exports.disabledAds = disabledAds;
-const buildCustomParamsFromCookies = () => (0, can_use_dom_1.canUseDom)()
-    ? {
-        permutive: (0, permutive_1.getPermutivePFPSegments)(),
-        si: (0, libs_1.getCookie)({ name: 'GU_U' }) ? 't' : 'f',
-    }
-    : {};
 const buildAdsConfig = (cmpConsent, adUnit, customParams) => {
     const mergedCustomParams = {
         ...customParams,
-        ...buildCustomParamsFromCookies(),
+        ...(0, build_page_targeting_1.buildPageTargeting)({
+            consentState: cmpConsent,
+            adFree: false,
+            youtube: true,
+        }),
     };
     const defaultAdsConfig = {
         adTagParameters: {

package/dist/esm/index.d.ts

@@ -15,7 +15,7 @@ export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments,
 export { initTrackScrollDepth } from './track-scroll-depth';
 export { initTrackLabsContainer } from './track-labs-container';
 export { initTrackGpcSignal } from './track-gpc-signal';
-export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';
+export { buildAdsConfigWithConsent, disabledAds } from './targeting/youtube';
 export { createAdSlot, concatSizeMappings } from './create-ad-slot';
 export type { AdsConfig, AdsConfigBasic, AdsConfigDisabled, AdTargetingBuilder, CustomParams, } from './types';
 export * as constants from './constants';

package/dist/esm/index.js

@@ -13,7 +13,7 @@ export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments,
 export { initTrackScrollDepth } from './track-scroll-depth';
 export { initTrackLabsContainer } from './track-labs-container';
 export { initTrackGpcSignal } from './track-gpc-signal';
-export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';
+export { buildAdsConfigWithConsent, disabledAds } from './targeting/youtube';
 export { createAdSlot, concatSizeMappings } from './create-ad-slot';
 import * as constants_1 from './constants';
 export { constants_1 as constants };

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

@@ -32,7 +32,10 @@ const isConsentlessKey = (key) => consentlessTargetingKeys.includes(key);
  * @returns ConsentlessPageTargeting
  */
 const buildPageTargetingConsentless = (consentState, adFree) => {
-    const consentedPageTargeting = buildPageTargeting(consentState, adFree);
+    const consentedPageTargeting = buildPageTargeting({
+        consentState,
+        adFree,
+    });
     return Object.fromEntries(Object.entries(consentedPageTargeting).filter(([k]) => isConsentlessKey(k)));
 };
 export { buildPageTargetingConsentless };

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

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

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

@@ -22,7 +22,7 @@ const filterValues = (pageTargets) => {
     }
     return filtered;
 };
-const buildPageTargeting = (consentState, adFree) => {
+const buildPageTargeting = ({ consentState, adFree, youtube = false, }) => {
     const { page, isDotcomRendering } = window.guardian.config;
     const adFreeTargeting = adFree ? { af: 't' } : {};
     const contentTargeting = getContentTargeting({
@@ -60,7 +60,10 @@ const buildPageTargeting = (consentState, adFree) => {
     const sharedAdTargeting = page.sharedAdTargeting
         ? getSharedTargeting(page.sharedAdTargeting)
         : {};
-    const personalisedTargeting = getPersonalisedTargeting(consentState);
+    const personalisedTargeting = getPersonalisedTargeting({
+        state: consentState,
+        youtube,
+    });
     const pageTargets = {
         ...personalisedTargeting,
         ...sharedAdTargeting,

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

@@ -75,6 +75,10 @@ declare type PersonalisedTargeting = {
      */
     rdp: True | False | NotApplicable;
 };
-declare const getPersonalisedTargeting: (state: ConsentState) => PersonalisedTargeting;
+declare type Personalised = {
+    state: ConsentState;
+    youtube: boolean;
+};
+declare const getPersonalisedTargeting: ({ state, youtube, }: Personalised) => PersonalisedTargeting;
 export { getPersonalisedTargeting };
 export type { PersonalisedTargeting, AdManagerGroup, Frequency };

package/dist/esm/targeting/personalised.js

@@ -1,5 +1,5 @@
 import { storage } from '@guardian/libs';
-import { clearPermutiveSegments, getPermutiveSegments } from '../permutive';
+import { clearPermutiveSegments, getPermutivePFPSegments, getPermutiveSegments, } from '../permutive';
 /* -- Types -- */
 const frequency = [
     '0',
@@ -121,17 +121,17 @@ const getAdManagerGroup = (state) => {
         ? existingGroup
         : createAdManagerGroup();
 };
-const getPermutiveWithState = (state) => {
-    if (state.canTarget)
-        return getPermutiveSegments();
+const getPermutiveWithState = (state, youtube) => {
+    if (state.canTarget) {
+        return youtube ? getPermutivePFPSegments() : getPermutiveSegments();
+    }
     clearPermutiveSegments();
     return [];
 };
-/* -- Targeting -- */
-const getPersonalisedTargeting = (state) => ({
+const getPersonalisedTargeting = ({ state, youtube, }) => ({
     amtgrp: getAdManagerGroup(state),
     fr: getFrequencyValue(state),
-    permutive: getPermutiveWithState(state),
+    permutive: getPermutiveWithState(state, youtube),
     ...getCMPTargeting(state),
 });
 export { getPersonalisedTargeting };

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

@@ -1,3 +1,4 @@
+import { log } from '@guardian/libs';
 import { buildPageTargeting, filterValues } from './build-page-targeting';
 /**
  * @param  {Record<string, MaybeArray<string|number|boolean>>
@@ -14,9 +15,28 @@ const encodeCustomParams = (params) => {
         .join('&');
     return encodedParams;
 };
-const buildImaAdTagUrl = (adUnit, customParams, consentState) => {
-    const pageTargeting = buildPageTargeting(consentState, false);
+const mergeCustomParamsWithTargeting = (customParams, consentState) => {
+    let pageTargeting = {};
+    try {
+        pageTargeting = buildPageTargeting({
+            consentState: consentState,
+            adFree: 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,
         tfcd: '0',

package/dist/esm/{ad-targeting-youtube.d.ts → targeting/youtube.d.ts}

@@ -1,5 +1,5 @@
 import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
-import type { AdsConfig, AdsConfigDisabled, CustomParams } from './types';
+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/{ad-targeting-youtube.js → targeting/youtube.js}

@@ -1,18 +1,14 @@
-import { getCookie } from '@guardian/libs';
-import { canUseDom } from './lib/can-use-dom';
-import { constructQuery } from './lib/construct-query';
-import { getPermutivePFPSegments } from './permutive';
+import { constructQuery } from '../lib/construct-query';
+import { buildPageTargeting } from './build-page-targeting';
 const disabledAds = { disableAds: true };
-const buildCustomParamsFromCookies = () => canUseDom()
-    ? {
-        permutive: getPermutivePFPSegments(),
-        si: getCookie({ name: 'GU_U' }) ? 't' : 'f',
-    }
-    : {};
 const buildAdsConfig = (cmpConsent, adUnit, customParams) => {
     const mergedCustomParams = {
         ...customParams,
-        ...buildCustomParamsFromCookies(),
+        ...buildPageTargeting({
+            consentState: cmpConsent,
+            adFree: false,
+            youtube: true,
+        }),
     };
     const defaultAdsConfig = {
         adTagParameters: {

package/package.json

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