@guardian/commercial-core 4.14.0 → 4.16.0

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

@@ -23,6 +23,7 @@ declare class AdSize extends Array<number> {
     constructor([width, height]: [number, number]);
     toString(): AdSizeString;
     toArray(): number[];
+    isProxy(): boolean;
     get width(): number;
     get height(): number;
 }
@@ -39,6 +40,11 @@ declare const standardAdSizes: {
     '300x1050': AdSize;
     '160x600': AdSize;
 };
+declare const outstreamSizes: {
+    outstreamDesktop: AdSize;
+    outstreamGoogleDesktop: AdSize;
+    outstreamMobile: AdSize;
+};
 declare const adSizes: Record<SizeKeys, AdSize>;
 /**
  * mark: 432b3a46-90c1-4573-90d3-2400b51af8d0
@@ -51,4 +57,4 @@ export declare const _: {
     createAdSize: (width: number, height: number) => AdSize;
 };
 export type { AdSizeString, AdSize, SizeKeys, SizeMapping, SlotSizeMappings, SlotName, };
-export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize };
+export { adSizes, standardAdSizes, outstreamSizes, getAdSize, slotSizeMappings, createAdSize, };

package/dist/cjs/ad-sizes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAdSize = exports.slotSizeMappings = exports.getAdSize = exports.standardAdSizes = exports.adSizes = exports._ = void 0;
+exports.createAdSize = exports.slotSizeMappings = exports.getAdSize = exports.outstreamSizes = exports.standardAdSizes = exports.adSizes = exports._ = void 0;
 /**
  * Store ad sizes in a way that is compatible with google-tag but also accessible via
  * more semantic `width`/`height` properties and keep things readonly.
@@ -32,6 +32,15 @@ class AdSize extends Array {
     toArray() {
         return [this[0], this[1]];
     }
+    // The advert size is not reflective of the actual size of the advert.
+    // For example, fluid ads and Guardian merch ads are larger than the dimensions
+    isProxy() {
+        const isOutOfPage = this.width === 1 && this.height === 1;
+        const isEmpty = this.width === 2 && this.height === 2;
+        const isFluid = this.toString() === 'fluid';
+        const isMerch = this.width === 88;
+        return isOutOfPage || isEmpty || isFluid || isMerch;
+    }
     get width() {
         return this[0];
     }
@@ -51,6 +60,7 @@ const namedStandardAdSizes = {
     mpu: createAdSize(300, 250),
     portrait: createAdSize(300, 1050),
     skyscraper: createAdSize(160, 600),
+    cascade: createAdSize(940, 230),
 };
 const standardAdSizes = {
     '970x250': namedStandardAdSizes.billboard,
@@ -61,6 +71,12 @@ const standardAdSizes = {
     '160x600': namedStandardAdSizes.skyscraper,
 };
 exports.standardAdSizes = standardAdSizes;
+const outstreamSizes = {
+    outstreamDesktop: createAdSize(620, 350),
+    outstreamGoogleDesktop: createAdSize(550, 310),
+    outstreamMobile: createAdSize(300, 197),
+};
+exports.outstreamSizes = outstreamSizes;
 const dfpProprietaryAdSizes = {
     fluid: createAdSize(0, 0),
     googleCard: createAdSize(300, 274),
@@ -73,14 +89,11 @@ const guardianProprietaryAdSizes = {
     merchandising: createAdSize(88, 88),
     merchandisingHigh: createAdSize(88, 87),
     merchandisingHighAdFeature: createAdSize(88, 89),
-    outstreamDesktop: createAdSize(620, 350),
-    outstreamGoogleDesktop: createAdSize(550, 310),
-    outstreamMobile: createAdSize(300, 197),
-    cascade: createAdSize(940, 230),
 };
 const adSizes = {
     ...namedStandardAdSizes,
     ...standardAdSizes,
+    ...outstreamSizes,
     ...dfpProprietaryAdSizes,
     ...guardianProprietaryAdSizes,
 };

package/dist/cjs/index.d.ts

@@ -7,7 +7,7 @@ export { remarketing } from './third-party-tags/remarketing';
 export { EventTimer } from './event-timer';
 export { bypassCommercialMetricsSampling, initCommercialMetrics, } from './send-commercial-metrics';
 export type { ThirdPartyTag } from './types';
-export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize, } from './ad-sizes';
+export { adSizes, createAdSize, getAdSize, outstreamSizes, slotSizeMappings, standardAdSizes, } from './ad-sizes';
 export { isBreakpoint } from './lib/breakpoint';
 export type { Breakpoint } from './lib/breakpoint';
 export type { SizeKeys, AdSizeString, AdSize, SizeMapping, SlotSizeMappings, SlotName, } from './ad-sizes';
@@ -35,4 +35,5 @@ export { init as initMessenger } from './messenger';
 export type { RegisterListener, RegisterPersistentListener, RespondProxy, } from './messenger';
 export { postMessage } from './messenger/post-message';
 export { buildPageTargeting } from './targeting/build-page-targeting';
+export { buildPageTargetingConsentless } from './targeting/build-page-targeting-consentless';
 export type { PageTargeting } from './targeting/build-page-targeting';

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.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.createAdSize = exports.slotSizeMappings = exports.getAdSize = exports.standardAdSizes = exports.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.fbPixel = exports.permutive = exports.ias = void 0;
+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.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");
@@ -44,10 +44,11 @@ Object.defineProperty(exports, "bypassCommercialMetricsSampling", { enumerable:
 Object.defineProperty(exports, "initCommercialMetrics", { enumerable: true, get: function () { return send_commercial_metrics_1.initCommercialMetrics; } });
 var ad_sizes_1 = require("./ad-sizes");
 Object.defineProperty(exports, "adSizes", { enumerable: true, get: function () { return ad_sizes_1.adSizes; } });
-Object.defineProperty(exports, "standardAdSizes", { enumerable: true, get: function () { return ad_sizes_1.standardAdSizes; } });
+Object.defineProperty(exports, "createAdSize", { enumerable: true, get: function () { return ad_sizes_1.createAdSize; } });
 Object.defineProperty(exports, "getAdSize", { enumerable: true, get: function () { return ad_sizes_1.getAdSize; } });
+Object.defineProperty(exports, "outstreamSizes", { enumerable: true, get: function () { return ad_sizes_1.outstreamSizes; } });
 Object.defineProperty(exports, "slotSizeMappings", { enumerable: true, get: function () { return ad_sizes_1.slotSizeMappings; } });
-Object.defineProperty(exports, "createAdSize", { enumerable: true, get: function () { return ad_sizes_1.createAdSize; } });
+Object.defineProperty(exports, "standardAdSizes", { enumerable: true, get: function () { return ad_sizes_1.standardAdSizes; } });
 var breakpoint_1 = require("./lib/breakpoint");
 Object.defineProperty(exports, "isBreakpoint", { enumerable: true, get: function () { return breakpoint_1.isBreakpoint; } });
 var detect_ad_blocker_1 = require("./detect-ad-blocker");
@@ -87,3 +88,5 @@ var post_message_1 = require("./messenger/post-message");
 Object.defineProperty(exports, "postMessage", { enumerable: true, get: function () { return post_message_1.postMessage; } });
 var build_page_targeting_1 = require("./targeting/build-page-targeting");
 Object.defineProperty(exports, "buildPageTargeting", { enumerable: true, get: function () { return build_page_targeting_1.buildPageTargeting; } });
+var build_page_targeting_consentless_1 = require("./targeting/build-page-targeting-consentless");
+Object.defineProperty(exports, "buildPageTargetingConsentless", { enumerable: true, get: function () { return build_page_targeting_consentless_1.buildPageTargetingConsentless; } });

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

@@ -0,0 +1,19 @@
+import type { Participations } from '@guardian/ab-core';
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
+import type { CountryCode } from '@guardian/libs';
+import type { PageTargeting } from './build-page-targeting';
+declare const consentlessTargetingKeys: readonly ["ab", "at", "bl", "bp", "br", "cc", "ct", "dcre", "edition", "k", "rp", "s", "se", "sens", "sh", "si", "skinsize", "su", "tn", "url", "urlkw"];
+declare type ConsentlessTargetingKeys = typeof consentlessTargetingKeys[number];
+declare type ConsentlessPageTargeting = Partial<Pick<PageTargeting, ConsentlessTargetingKeys>>;
+/**
+ * Call buildPageTargeting then filter out the keys that are not needed for
+ * consentless targeting.
+ *
+ * @param  {ConsentState} consentState
+ * @param  {boolean} adFree
+ * @param  {CountryCode} countryCode
+ * @param  {Participations} clientSideParticipations
+ * @returns ConsentlessPageTargeting
+ */
+declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean, countryCode: CountryCode, clientSideParticipations: Participations) => ConsentlessPageTargeting;
+export { buildPageTargetingConsentless };

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildPageTargetingConsentless = void 0;
+const build_page_targeting_1 = require("./build-page-targeting");
+const consentlessTargetingKeys = [
+    'ab',
+    'at',
+    'bl',
+    'bp',
+    'br',
+    'cc',
+    'ct',
+    'dcre',
+    'edition',
+    'k',
+    'rp',
+    's',
+    'se',
+    'sens',
+    'sh',
+    'si',
+    'skinsize',
+    'su',
+    'tn',
+    'url',
+    'urlkw',
+];
+const isConsentlessKey = (key) => consentlessTargetingKeys.includes(key);
+/**
+ * Call buildPageTargeting then filter out the keys that are not needed for
+ * consentless targeting.
+ *
+ * @param  {ConsentState} consentState
+ * @param  {boolean} adFree
+ * @param  {CountryCode} countryCode
+ * @param  {Participations} clientSideParticipations
+ * @returns ConsentlessPageTargeting
+ */
+const buildPageTargetingConsentless = (consentState, adFree, countryCode, clientSideParticipations) => {
+    const consentedPageTargeting = (0, build_page_targeting_1.buildPageTargeting)(consentState, adFree, countryCode, clientSideParticipations);
+    return Object.fromEntries(Object.entries(consentedPageTargeting).filter(([k]) => isConsentlessKey(k)));
+};
+exports.buildPageTargetingConsentless = buildPageTargetingConsentless;

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

@@ -23,6 +23,7 @@ declare class AdSize extends Array<number> {
     constructor([width, height]: [number, number]);
     toString(): AdSizeString;
     toArray(): number[];
+    isProxy(): boolean;
     get width(): number;
     get height(): number;
 }
@@ -39,6 +40,11 @@ declare const standardAdSizes: {
     '300x1050': AdSize;
     '160x600': AdSize;
 };
+declare const outstreamSizes: {
+    outstreamDesktop: AdSize;
+    outstreamGoogleDesktop: AdSize;
+    outstreamMobile: AdSize;
+};
 declare const adSizes: Record<SizeKeys, AdSize>;
 /**
  * mark: 432b3a46-90c1-4573-90d3-2400b51af8d0
@@ -51,4 +57,4 @@ export declare const _: {
     createAdSize: (width: number, height: number) => AdSize;
 };
 export type { AdSizeString, AdSize, SizeKeys, SizeMapping, SlotSizeMappings, SlotName, };
-export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize };
+export { adSizes, standardAdSizes, outstreamSizes, getAdSize, slotSizeMappings, createAdSize, };

package/dist/esm/ad-sizes.js

@@ -29,6 +29,15 @@ class AdSize extends Array {
     toArray() {
         return [this[0], this[1]];
     }
+    // The advert size is not reflective of the actual size of the advert.
+    // For example, fluid ads and Guardian merch ads are larger than the dimensions
+    isProxy() {
+        const isOutOfPage = this.width === 1 && this.height === 1;
+        const isEmpty = this.width === 2 && this.height === 2;
+        const isFluid = this.toString() === 'fluid';
+        const isMerch = this.width === 88;
+        return isOutOfPage || isEmpty || isFluid || isMerch;
+    }
     get width() {
         return this[0];
     }
@@ -47,6 +56,7 @@ const namedStandardAdSizes = {
     mpu: createAdSize(300, 250),
     portrait: createAdSize(300, 1050),
     skyscraper: createAdSize(160, 600),
+    cascade: createAdSize(940, 230),
 };
 const standardAdSizes = {
     '970x250': namedStandardAdSizes.billboard,
@@ -56,6 +66,11 @@ const standardAdSizes = {
     '300x1050': namedStandardAdSizes.portrait,
     '160x600': namedStandardAdSizes.skyscraper,
 };
+const outstreamSizes = {
+    outstreamDesktop: createAdSize(620, 350),
+    outstreamGoogleDesktop: createAdSize(550, 310),
+    outstreamMobile: createAdSize(300, 197),
+};
 const dfpProprietaryAdSizes = {
     fluid: createAdSize(0, 0),
     googleCard: createAdSize(300, 274),
@@ -68,14 +83,11 @@ const guardianProprietaryAdSizes = {
     merchandising: createAdSize(88, 88),
     merchandisingHigh: createAdSize(88, 87),
     merchandisingHighAdFeature: createAdSize(88, 89),
-    outstreamDesktop: createAdSize(620, 350),
-    outstreamGoogleDesktop: createAdSize(550, 310),
-    outstreamMobile: createAdSize(300, 197),
-    cascade: createAdSize(940, 230),
 };
 const adSizes = {
     ...namedStandardAdSizes,
     ...standardAdSizes,
+    ...outstreamSizes,
     ...dfpProprietaryAdSizes,
     ...guardianProprietaryAdSizes,
 };
@@ -257,4 +269,4 @@ const slotSizeMappings = {
 const getAdSize = (size) => adSizes[size];
 // Export for testing
 export const _ = { createAdSize };
-export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize };
+export { adSizes, standardAdSizes, outstreamSizes, getAdSize, slotSizeMappings, createAdSize, };

package/dist/esm/index.d.ts

@@ -7,7 +7,7 @@ export { remarketing } from './third-party-tags/remarketing';
 export { EventTimer } from './event-timer';
 export { bypassCommercialMetricsSampling, initCommercialMetrics, } from './send-commercial-metrics';
 export type { ThirdPartyTag } from './types';
-export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize, } from './ad-sizes';
+export { adSizes, createAdSize, getAdSize, outstreamSizes, slotSizeMappings, standardAdSizes, } from './ad-sizes';
 export { isBreakpoint } from './lib/breakpoint';
 export type { Breakpoint } from './lib/breakpoint';
 export type { SizeKeys, AdSizeString, AdSize, SizeMapping, SlotSizeMappings, SlotName, } from './ad-sizes';
@@ -35,4 +35,5 @@ export { init as initMessenger } from './messenger';
 export type { RegisterListener, RegisterPersistentListener, RespondProxy, } from './messenger';
 export { postMessage } from './messenger/post-message';
 export { buildPageTargeting } from './targeting/build-page-targeting';
+export { buildPageTargetingConsentless } from './targeting/build-page-targeting-consentless';
 export type { PageTargeting } from './targeting/build-page-targeting';

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 './event-timer';
 export { bypassCommercialMetricsSampling, initCommercialMetrics, } from './send-commercial-metrics';
-export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize, } from './ad-sizes';
+export { adSizes, createAdSize, getAdSize, outstreamSizes, slotSizeMappings, standardAdSizes, } from './ad-sizes';
 export { isBreakpoint } from './lib/breakpoint';
 export { isAdBlockInUse } from './detect-ad-blocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';
@@ -27,3 +27,4 @@ export { pickTargetingValues } from './targeting/pick-targeting-values';
 export { init as initMessenger } from './messenger';
 export { postMessage } from './messenger/post-message';
 export { buildPageTargeting } from './targeting/build-page-targeting';
+export { buildPageTargetingConsentless } from './targeting/build-page-targeting-consentless';

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

@@ -0,0 +1,19 @@
+import type { Participations } from '@guardian/ab-core';
+import type { ConsentState } from '@guardian/consent-management-platform/dist/types';
+import type { CountryCode } from '@guardian/libs';
+import type { PageTargeting } from './build-page-targeting';
+declare const consentlessTargetingKeys: readonly ["ab", "at", "bl", "bp", "br", "cc", "ct", "dcre", "edition", "k", "rp", "s", "se", "sens", "sh", "si", "skinsize", "su", "tn", "url", "urlkw"];
+declare type ConsentlessTargetingKeys = typeof consentlessTargetingKeys[number];
+declare type ConsentlessPageTargeting = Partial<Pick<PageTargeting, ConsentlessTargetingKeys>>;
+/**
+ * Call buildPageTargeting then filter out the keys that are not needed for
+ * consentless targeting.
+ *
+ * @param  {ConsentState} consentState
+ * @param  {boolean} adFree
+ * @param  {CountryCode} countryCode
+ * @param  {Participations} clientSideParticipations
+ * @returns ConsentlessPageTargeting
+ */
+declare const buildPageTargetingConsentless: (consentState: ConsentState, adFree: boolean, countryCode: CountryCode, clientSideParticipations: Participations) => ConsentlessPageTargeting;
+export { buildPageTargetingConsentless };

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

@@ -0,0 +1,40 @@
+import { buildPageTargeting } from './build-page-targeting';
+const consentlessTargetingKeys = [
+    'ab',
+    'at',
+    'bl',
+    'bp',
+    'br',
+    'cc',
+    'ct',
+    'dcre',
+    'edition',
+    'k',
+    'rp',
+    's',
+    'se',
+    'sens',
+    'sh',
+    'si',
+    'skinsize',
+    'su',
+    'tn',
+    'url',
+    'urlkw',
+];
+const isConsentlessKey = (key) => consentlessTargetingKeys.includes(key);
+/**
+ * Call buildPageTargeting then filter out the keys that are not needed for
+ * consentless targeting.
+ *
+ * @param  {ConsentState} consentState
+ * @param  {boolean} adFree
+ * @param  {CountryCode} countryCode
+ * @param  {Participations} clientSideParticipations
+ * @returns ConsentlessPageTargeting
+ */
+const buildPageTargetingConsentless = (consentState, adFree, countryCode, clientSideParticipations) => {
+    const consentedPageTargeting = buildPageTargeting(consentState, adFree, countryCode, clientSideParticipations);
+    return Object.fromEntries(Object.entries(consentedPageTargeting).filter(([k]) => isConsentlessKey(k)));
+};
+export { buildPageTargetingConsentless };

package/package.json

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