@guardian/commercial-core 0.34.0 → 0.37.0

package/dist/cjs/ad-sizes.d.ts

@@ -6,6 +6,7 @@ export declare type AdSize = Readonly<{
 }>;
 export declare type SizeKeys = 'billboard' | 'leaderboard' | 'mpu' | 'halfPage' | 'portrait' | 'skyscraper' | 'mobilesticky' | 'fluid' | 'outOfPage' | 'googleCard' | 'video' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'merchandisingHighAdFeature' | 'merchandisingHigh' | 'merchandising' | 'inlineMerchandising' | 'fabric' | 'empty' | '970x250' | '728x90' | '300x250' | '300x600' | '300x1050' | '160x600';
 export declare const adSizes: Record<SizeKeys, AdSize>;
+export declare const getAdSize: (size: SizeKeys) => AdSize;
 export declare const _: {
-    getAdSize: (width: number, height: number) => AdSize;
+    createAdSize: (width: number, height: number) => AdSize;
 };

package/dist/cjs/ad-sizes.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._ = exports.adSizes = void 0;
-const getAdSize = (width, height) => {
+exports._ = exports.getAdSize = exports.adSizes = void 0;
+const createAdSize = (width, height) => {
     const toString = () => width === 0 && height === 0 ? 'fluid' : `${width},${height}`;
     return Object.freeze({
         width,
@@ -11,28 +11,28 @@ const getAdSize = (width, height) => {
 };
 const adSizesPartial = {
     // standard ad sizes
-    billboard: getAdSize(970, 250),
-    leaderboard: getAdSize(728, 90),
-    mpu: getAdSize(300, 250),
-    halfPage: getAdSize(300, 600),
-    portrait: getAdSize(300, 1050),
-    skyscraper: getAdSize(160, 600),
-    mobilesticky: getAdSize(320, 50),
+    billboard: createAdSize(970, 250),
+    leaderboard: createAdSize(728, 90),
+    mpu: createAdSize(300, 250),
+    halfPage: createAdSize(300, 600),
+    portrait: createAdSize(300, 1050),
+    skyscraper: createAdSize(160, 600),
+    mobilesticky: createAdSize(320, 50),
     // dfp proprietary ad sizes
-    fluid: getAdSize(0, 0),
-    outOfPage: getAdSize(1, 1),
-    googleCard: getAdSize(300, 274),
+    fluid: createAdSize(0, 0),
+    outOfPage: createAdSize(1, 1),
+    googleCard: createAdSize(300, 274),
     // guardian proprietary ad sizes
-    video: getAdSize(620, 1),
-    outstreamDesktop: getAdSize(620, 350),
-    outstreamGoogleDesktop: getAdSize(550, 310),
-    outstreamMobile: getAdSize(300, 197),
-    merchandisingHighAdFeature: getAdSize(88, 89),
-    merchandisingHigh: getAdSize(88, 87),
-    merchandising: getAdSize(88, 88),
-    inlineMerchandising: getAdSize(88, 85),
-    fabric: getAdSize(88, 71),
-    empty: getAdSize(2, 2),
+    video: createAdSize(620, 1),
+    outstreamDesktop: createAdSize(620, 350),
+    outstreamGoogleDesktop: createAdSize(550, 310),
+    outstreamMobile: createAdSize(300, 197),
+    merchandisingHighAdFeature: createAdSize(88, 89),
+    merchandisingHigh: createAdSize(88, 87),
+    merchandising: createAdSize(88, 88),
+    inlineMerchandising: createAdSize(88, 85),
+    fabric: createAdSize(88, 71),
+    empty: createAdSize(2, 2),
 };
 exports.adSizes = {
     ...adSizesPartial,
@@ -43,5 +43,7 @@ exports.adSizes = {
     '300x1050': adSizesPartial.portrait,
     '160x600': adSizesPartial.skyscraper,
 };
+const getAdSize = (size) => exports.adSizes[size];
+exports.getAdSize = getAdSize;
 // Export for testing
-exports._ = { getAdSize };
+exports._ = { createAdSize };

package/dist/cjs/index.d.ts

@@ -7,7 +7,7 @@ export { remarketing } from './third-party-tags/remarketing';
 export { EventTimer } from './EventTimer';
 export { sendCommercialMetrics } from './sendCommercialMetrics';
 export type { ThirdPartyTag } from './types';
-export { adSizes } from './ad-sizes';
+export { adSizes, getAdSize } from './ad-sizes';
 export type { SizeKeys, AdSizeString, AdSize } from './ad-sizes';
 export { isAdBlockInUse } from './detectAdBlocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';

package/dist/cjs/index.js

@@ -20,7 +20,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.constants = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.adSizes = exports.sendCommercialMetrics = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.fbPixel = exports.permutive = exports.ias = void 0;
+exports.constants = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.getAdSize = exports.adSizes = exports.sendCommercialMetrics = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.fbPixel = 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");
@@ -39,6 +39,7 @@ var sendCommercialMetrics_1 = require("./sendCommercialMetrics");
 Object.defineProperty(exports, "sendCommercialMetrics", { enumerable: true, get: function () { return sendCommercialMetrics_1.sendCommercialMetrics; } });
 var ad_sizes_1 = require("./ad-sizes");
 Object.defineProperty(exports, "adSizes", { enumerable: true, get: function () { return ad_sizes_1.adSizes; } });
+Object.defineProperty(exports, "getAdSize", { enumerable: true, get: function () { return ad_sizes_1.getAdSize; } });
 var detectAdBlocker_1 = require("./detectAdBlocker");
 Object.defineProperty(exports, "isAdBlockInUse", { enumerable: true, get: function () { return detectAdBlocker_1.isAdBlockInUse; } });
 var permutive_2 = require("./permutive");

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

@@ -58,12 +58,13 @@ export declare type ContentTargeting = {
      */
     vl: null | typeof videoLengths[number];
 };
-export declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }: {
+declare type Content = {
     eligibleForDCR: boolean;
     path: SharedTargeting['url'];
     renderingPlatform: ContentTargeting['rp'];
     section: ContentTargeting['s'];
     sensitive: boolean;
-    videoLength?: number | undefined;
-}) => ContentTargeting;
+    videoLength?: number;
+};
+export declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }: Content) => ContentTargeting;
 export {};

package/dist/cjs/targeting/content.js

@@ -28,7 +28,6 @@ const getUrlKeywords = (url) => {
         .slice(-1)[0];
     return (0, libs_1.isString)(lastSegment) ? lastSegment.split('-').filter(Boolean) : [];
 };
-/* -- Targeting -- */
 const getContentTargeting = ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }) => {
     return {
         dcre: eligibleForDCR ? 't' : 'f',

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

@@ -1,8 +1,5 @@
-declare type ValidTargeting<T, K> = '' extends T ? never : [] extends T ? never : [''] extends T ? never : T extends boolean ? never : T extends NonNullable<T> ? K : never;
-declare type DefinedKeys<T> = {
-    [K in keyof T]-?: ValidTargeting<T[K], K>;
-}[keyof T];
-declare type ObjectWithDefinedValues<T> = Pick<T, DefinedKeys<T>>;
+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:
@@ -24,5 +21,5 @@ declare type ObjectWithDefinedValues<T> = Pick<T, DefinedKeys<T>>;
  * clean.invalid
  * ```
  */
-export declare const pickTargetingValues: <T extends Record<string, string | readonly string[] | undefined>>(obj: T) => ObjectWithDefinedValues<T>;
+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

@@ -37,7 +37,9 @@ const pickTargetingValues = (obj) => {
     return Object.entries(obj).reduce((valid, [key, value]) => {
         if (isValidTargeting(value)) {
             // @ts-expect-error -- isValidTargeting checks this
-            valid[key] = value;
+            valid[key] = Array.isArray(value)
+                ? value.filter(isTargetingString)
+                : value;
         }
         return valid;
     }, initialValue);

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

@@ -92,7 +92,18 @@ export declare type SessionTargeting = {
 };
 export declare type AllParticipations = {
     clientSideParticipations: Participations;
-    serverSideParticipations: Record<string, 'control' | 'variant'>;
+    serverSideParticipations: {
+        [key: `${string}Control`]: 'control';
+        [key: `${string}Variant`]: 'variant';
+    };
 };
-export declare const getSessionTargeting: (referrer: string, participations: AllParticipations, targeting: Omit<SessionTargeting, 'ab' | 'ref'>) => SessionTargeting;
+declare type Session = {
+    adTest: SessionTargeting['at'];
+    countryCode: CountryCode;
+    isSignedIn: boolean;
+    pageViewId: SessionTargeting['pv'];
+    participations: AllParticipations;
+    referrer: string;
+};
+export declare const getSessionTargeting: ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
 export {};

package/dist/cjs/targeting/session.js

@@ -49,10 +49,12 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     }
     return [...clientSideExperiment, ...serverSideExperiments];
 };
-/* -- Targeting -- */
-const getSessionTargeting = (referrer, participations, targeting) => ({
-    ref: getReferrer(referrer),
+const getSessionTargeting = ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }) => ({
     ab: experimentsTargeting(participations),
-    ...targeting,
+    at: adTest,
+    cc: countryCode,
+    pv: pageViewId,
+    ref: getReferrer(referrer),
+    si: isSignedIn ? 't' : 'f',
 });
 exports.getSessionTargeting = getSessionTargeting;

package/dist/esm/ad-sizes.d.ts

@@ -6,6 +6,7 @@ export declare type AdSize = Readonly<{
 }>;
 export declare type SizeKeys = 'billboard' | 'leaderboard' | 'mpu' | 'halfPage' | 'portrait' | 'skyscraper' | 'mobilesticky' | 'fluid' | 'outOfPage' | 'googleCard' | 'video' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'merchandisingHighAdFeature' | 'merchandisingHigh' | 'merchandising' | 'inlineMerchandising' | 'fabric' | 'empty' | '970x250' | '728x90' | '300x250' | '300x600' | '300x1050' | '160x600';
 export declare const adSizes: Record<SizeKeys, AdSize>;
+export declare const getAdSize: (size: SizeKeys) => AdSize;
 export declare const _: {
-    getAdSize: (width: number, height: number) => AdSize;
+    createAdSize: (width: number, height: number) => AdSize;
 };

package/dist/esm/ad-sizes.js

@@ -1,4 +1,4 @@
-const getAdSize = (width, height) => {
+const createAdSize = (width, height) => {
     const toString = () => width === 0 && height === 0 ? 'fluid' : `${width},${height}`;
     return Object.freeze({
         width,
@@ -8,28 +8,28 @@ const getAdSize = (width, height) => {
 };
 const adSizesPartial = {
     // standard ad sizes
-    billboard: getAdSize(970, 250),
-    leaderboard: getAdSize(728, 90),
-    mpu: getAdSize(300, 250),
-    halfPage: getAdSize(300, 600),
-    portrait: getAdSize(300, 1050),
-    skyscraper: getAdSize(160, 600),
-    mobilesticky: getAdSize(320, 50),
+    billboard: createAdSize(970, 250),
+    leaderboard: createAdSize(728, 90),
+    mpu: createAdSize(300, 250),
+    halfPage: createAdSize(300, 600),
+    portrait: createAdSize(300, 1050),
+    skyscraper: createAdSize(160, 600),
+    mobilesticky: createAdSize(320, 50),
     // dfp proprietary ad sizes
-    fluid: getAdSize(0, 0),
-    outOfPage: getAdSize(1, 1),
-    googleCard: getAdSize(300, 274),
+    fluid: createAdSize(0, 0),
+    outOfPage: createAdSize(1, 1),
+    googleCard: createAdSize(300, 274),
     // guardian proprietary ad sizes
-    video: getAdSize(620, 1),
-    outstreamDesktop: getAdSize(620, 350),
-    outstreamGoogleDesktop: getAdSize(550, 310),
-    outstreamMobile: getAdSize(300, 197),
-    merchandisingHighAdFeature: getAdSize(88, 89),
-    merchandisingHigh: getAdSize(88, 87),
-    merchandising: getAdSize(88, 88),
-    inlineMerchandising: getAdSize(88, 85),
-    fabric: getAdSize(88, 71),
-    empty: getAdSize(2, 2),
+    video: createAdSize(620, 1),
+    outstreamDesktop: createAdSize(620, 350),
+    outstreamGoogleDesktop: createAdSize(550, 310),
+    outstreamMobile: createAdSize(300, 197),
+    merchandisingHighAdFeature: createAdSize(88, 89),
+    merchandisingHigh: createAdSize(88, 87),
+    merchandising: createAdSize(88, 88),
+    inlineMerchandising: createAdSize(88, 85),
+    fabric: createAdSize(88, 71),
+    empty: createAdSize(2, 2),
 };
 export const adSizes = {
     ...adSizesPartial,
@@ -40,5 +40,6 @@ export const adSizes = {
     '300x1050': adSizesPartial.portrait,
     '160x600': adSizesPartial.skyscraper,
 };
+export const getAdSize = (size) => adSizes[size];
 // Export for testing
-export const _ = { getAdSize };
+export const _ = { createAdSize };

package/dist/esm/index.d.ts

@@ -7,7 +7,7 @@ export { remarketing } from './third-party-tags/remarketing';
 export { EventTimer } from './EventTimer';
 export { sendCommercialMetrics } from './sendCommercialMetrics';
 export type { ThirdPartyTag } from './types';
-export { adSizes } from './ad-sizes';
+export { adSizes, getAdSize } from './ad-sizes';
 export type { SizeKeys, AdSizeString, AdSize } from './ad-sizes';
 export { isAdBlockInUse } from './detectAdBlocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';

package/dist/esm/index.js

@@ -7,7 +7,7 @@ export { inizio } from './third-party-tags/inizio';
 export { remarketing } from './third-party-tags/remarketing';
 export { EventTimer } from './EventTimer';
 export { sendCommercialMetrics } from './sendCommercialMetrics';
-export { adSizes } from './ad-sizes';
+export { adSizes, getAdSize } from './ad-sizes';
 export { isAdBlockInUse } from './detectAdBlocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';
 export { buildAdsConfigWithConsent, disabledAds } from './ad-targeting-youtube';

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

@@ -58,12 +58,13 @@ export declare type ContentTargeting = {
      */
     vl: null | typeof videoLengths[number];
 };
-export declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }: {
+declare type Content = {
     eligibleForDCR: boolean;
     path: SharedTargeting['url'];
     renderingPlatform: ContentTargeting['rp'];
     section: ContentTargeting['s'];
     sensitive: boolean;
-    videoLength?: number | undefined;
-}) => ContentTargeting;
+    videoLength?: number;
+};
+export declare const getContentTargeting: ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }: Content) => ContentTargeting;
 export {};

package/dist/esm/targeting/content.js

@@ -25,7 +25,6 @@ const getUrlKeywords = (url) => {
         .slice(-1)[0];
     return isString(lastSegment) ? lastSegment.split('-').filter(Boolean) : [];
 };
-/* -- Targeting -- */
 export const getContentTargeting = ({ eligibleForDCR, path, renderingPlatform, section, sensitive, videoLength, }) => {
     return {
         dcre: eligibleForDCR ? 't' : 'f',

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

@@ -1,8 +1,5 @@
-declare type ValidTargeting<T, K> = '' extends T ? never : [] extends T ? never : [''] extends T ? never : T extends boolean ? never : T extends NonNullable<T> ? K : never;
-declare type DefinedKeys<T> = {
-    [K in keyof T]-?: ValidTargeting<T[K], K>;
-}[keyof T];
-declare type ObjectWithDefinedValues<T> = Pick<T, DefinedKeys<T>>;
+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:
@@ -24,5 +21,5 @@ declare type ObjectWithDefinedValues<T> = Pick<T, DefinedKeys<T>>;
  * clean.invalid
  * ```
  */
-export declare const pickTargetingValues: <T extends Record<string, string | readonly string[] | undefined>>(obj: T) => ObjectWithDefinedValues<T>;
+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

@@ -34,7 +34,9 @@ export const pickTargetingValues = (obj) => {
     return Object.entries(obj).reduce((valid, [key, value]) => {
         if (isValidTargeting(value)) {
             // @ts-expect-error -- isValidTargeting checks this
-            valid[key] = value;
+            valid[key] = Array.isArray(value)
+                ? value.filter(isTargetingString)
+                : value;
         }
         return valid;
     }, initialValue);

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

@@ -92,7 +92,18 @@ export declare type SessionTargeting = {
 };
 export declare type AllParticipations = {
     clientSideParticipations: Participations;
-    serverSideParticipations: Record<string, 'control' | 'variant'>;
+    serverSideParticipations: {
+        [key: `${string}Control`]: 'control';
+        [key: `${string}Variant`]: 'variant';
+    };
 };
-export declare const getSessionTargeting: (referrer: string, participations: AllParticipations, targeting: Omit<SessionTargeting, 'ab' | 'ref'>) => SessionTargeting;
+declare type Session = {
+    adTest: SessionTargeting['at'];
+    countryCode: CountryCode;
+    isSignedIn: boolean;
+    pageViewId: SessionTargeting['pv'];
+    participations: AllParticipations;
+    referrer: string;
+};
+export declare const getSessionTargeting: ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }: Session) => SessionTargeting;
 export {};

package/dist/esm/targeting/session.js

@@ -46,9 +46,11 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     }
     return [...clientSideExperiment, ...serverSideExperiments];
 };
-/* -- Targeting -- */
-export const getSessionTargeting = (referrer, participations, targeting) => ({
-    ref: getReferrer(referrer),
+export const getSessionTargeting = ({ adTest, countryCode, isSignedIn, pageViewId, participations, referrer, }) => ({
     ab: experimentsTargeting(participations),
-    ...targeting,
+    at: adTest,
+    cc: countryCode,
+    pv: pageViewId,
+    ref: getReferrer(referrer),
+    si: isSignedIn ? 't' : 'f',
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "0.34.0",
+  "version": "0.37.0",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial-core#readme",
   "bugs": {
@@ -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"
   },