@guardian/commercial-core 4.12.0 → 4.14.0

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

@@ -31,6 +31,14 @@ declare type SlotName = 'right' | 'comments' | 'top-above-nav' | 'mostpop' | 'me
 declare type SizeMapping = Partial<Record<Breakpoint, AdSize[]>>;
 declare type SlotSizeMappings = Record<SlotName, SizeMapping>;
 declare const createAdSize: (width: number, height: number) => AdSize;
+declare const standardAdSizes: {
+    '970x250': AdSize;
+    '300x600': AdSize;
+    '728x90': AdSize;
+    '300x250': AdSize;
+    '300x1050': AdSize;
+    '160x600': AdSize;
+};
 declare const adSizes: Record<SizeKeys, AdSize>;
 /**
  * mark: 432b3a46-90c1-4573-90d3-2400b51af8d0
@@ -43,4 +51,4 @@ export declare const _: {
     createAdSize: (width: number, height: number) => AdSize;
 };
 export type { AdSizeString, AdSize, SizeKeys, SizeMapping, SlotSizeMappings, SlotName, };
-export { adSizes, getAdSize, slotSizeMappings, createAdSize };
+export { adSizes, standardAdSizes, 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.adSizes = exports._ = void 0;
+exports.createAdSize = exports.slotSizeMappings = exports.getAdSize = 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.
@@ -43,8 +43,7 @@ const createAdSize = (width, height) => {
     return new AdSize([width, height]);
 };
 exports.createAdSize = createAdSize;
-const adSizesPartial = {
-    // standard ad sizes
+const namedStandardAdSizes = {
     billboard: createAdSize(970, 250),
     halfPage: createAdSize(300, 600),
     leaderboard: createAdSize(728, 90),
@@ -52,11 +51,22 @@ const adSizesPartial = {
     mpu: createAdSize(300, 250),
     portrait: createAdSize(300, 1050),
     skyscraper: createAdSize(160, 600),
-    // dfp proprietary ad sizes
+};
+const standardAdSizes = {
+    '970x250': namedStandardAdSizes.billboard,
+    '300x600': namedStandardAdSizes.halfPage,
+    '728x90': namedStandardAdSizes.leaderboard,
+    '300x250': namedStandardAdSizes.mpu,
+    '300x1050': namedStandardAdSizes.portrait,
+    '160x600': namedStandardAdSizes.skyscraper,
+};
+exports.standardAdSizes = standardAdSizes;
+const dfpProprietaryAdSizes = {
     fluid: createAdSize(0, 0),
     googleCard: createAdSize(300, 274),
     outOfPage: createAdSize(1, 1),
-    // guardian proprietary ad sizes
+};
+const guardianProprietaryAdSizes = {
     empty: createAdSize(2, 2),
     fabric: createAdSize(88, 71),
     inlineMerchandising: createAdSize(88, 85),
@@ -69,13 +79,10 @@ const adSizesPartial = {
     cascade: createAdSize(940, 230),
 };
 const adSizes = {
-    ...adSizesPartial,
-    '970x250': adSizesPartial.billboard,
-    '728x90': adSizesPartial.leaderboard,
-    '300x250': adSizesPartial.mpu,
-    '300x600': adSizesPartial.halfPage,
-    '300x1050': adSizesPartial.portrait,
-    '160x600': adSizesPartial.skyscraper,
+    ...namedStandardAdSizes,
+    ...standardAdSizes,
+    ...dfpProprietaryAdSizes,
+    ...guardianProprietaryAdSizes,
 };
 exports.adSizes = adSizes;
 /**

package/dist/cjs/constants/adLabelHeight.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Unit: pixels
+ */
+export declare const AD_LABEL_HEIGHT = 24;

package/dist/cjs/constants/adLabelHeight.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AD_LABEL_HEIGHT = void 0;
+/**
+ * Unit: pixels
+ */
+exports.AD_LABEL_HEIGHT = 24;

package/dist/cjs/constants/index.d.ts

@@ -1,2 +1,3 @@
+export { AD_LABEL_HEIGHT } from './adLabelHeight';
 export { PREBID_TIMEOUT } from './prebid-timeout';
 export { TOP_ABOVE_NAV_HEIGHT } from './top-above-nav-height';

package/dist/cjs/constants/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TOP_ABOVE_NAV_HEIGHT = exports.PREBID_TIMEOUT = void 0;
+exports.TOP_ABOVE_NAV_HEIGHT = exports.PREBID_TIMEOUT = exports.AD_LABEL_HEIGHT = void 0;
+var adLabelHeight_1 = require("./adLabelHeight");
+Object.defineProperty(exports, "AD_LABEL_HEIGHT", { enumerable: true, get: function () { return adLabelHeight_1.AD_LABEL_HEIGHT; } });
 var prebid_timeout_1 = require("./prebid-timeout");
 Object.defineProperty(exports, "PREBID_TIMEOUT", { enumerable: true, get: function () { return prebid_timeout_1.PREBID_TIMEOUT; } });
 var top_above_nav_height_1 = require("./top-above-nav-height");

package/dist/cjs/constants/prebid-timeout.d.ts

@@ -1,6 +1,4 @@
 /**
- * Unit: milliseconds.
- *
- * This value is currently being investigated.
+ * Unit: milliseconds
  */
 export declare const PREBID_TIMEOUT = 1500;

package/dist/cjs/constants/prebid-timeout.js

@@ -2,13 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PREBID_TIMEOUT = void 0;
 /**
- * Unit: milliseconds.
- *
- * This value is currently being investigated.
+ * Unit: milliseconds
  */
 exports.PREBID_TIMEOUT = 1500;
-/*
-
-cc @chrislomaxjones
-
-*/

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, getAdSize, slotSizeMappings, createAdSize } from './ad-sizes';
+export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize, } 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,3 +35,4 @@ 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 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.adSizes = exports.initCommercialMetrics = exports.bypassCommercialMetricsSampling = exports.EventTimer = exports.remarketing = exports.inizio = exports.twitter = exports.fbPixel = exports.permutive = exports.ias = void 0;
+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;
 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,6 +44,7 @@ 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, "getAdSize", { enumerable: true, get: function () { return ad_sizes_1.getAdSize; } });
 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; } });

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

@@ -31,6 +31,14 @@ declare type SlotName = 'right' | 'comments' | 'top-above-nav' | 'mostpop' | 'me
 declare type SizeMapping = Partial<Record<Breakpoint, AdSize[]>>;
 declare type SlotSizeMappings = Record<SlotName, SizeMapping>;
 declare const createAdSize: (width: number, height: number) => AdSize;
+declare const standardAdSizes: {
+    '970x250': AdSize;
+    '300x600': AdSize;
+    '728x90': AdSize;
+    '300x250': AdSize;
+    '300x1050': AdSize;
+    '160x600': AdSize;
+};
 declare const adSizes: Record<SizeKeys, AdSize>;
 /**
  * mark: 432b3a46-90c1-4573-90d3-2400b51af8d0
@@ -43,4 +51,4 @@ export declare const _: {
     createAdSize: (width: number, height: number) => AdSize;
 };
 export type { AdSizeString, AdSize, SizeKeys, SizeMapping, SlotSizeMappings, SlotName, };
-export { adSizes, getAdSize, slotSizeMappings, createAdSize };
+export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize };

package/dist/esm/ad-sizes.js

@@ -39,8 +39,7 @@ class AdSize extends Array {
 const createAdSize = (width, height) => {
     return new AdSize([width, height]);
 };
-const adSizesPartial = {
-    // standard ad sizes
+const namedStandardAdSizes = {
     billboard: createAdSize(970, 250),
     halfPage: createAdSize(300, 600),
     leaderboard: createAdSize(728, 90),
@@ -48,11 +47,21 @@ const adSizesPartial = {
     mpu: createAdSize(300, 250),
     portrait: createAdSize(300, 1050),
     skyscraper: createAdSize(160, 600),
-    // dfp proprietary ad sizes
+};
+const standardAdSizes = {
+    '970x250': namedStandardAdSizes.billboard,
+    '300x600': namedStandardAdSizes.halfPage,
+    '728x90': namedStandardAdSizes.leaderboard,
+    '300x250': namedStandardAdSizes.mpu,
+    '300x1050': namedStandardAdSizes.portrait,
+    '160x600': namedStandardAdSizes.skyscraper,
+};
+const dfpProprietaryAdSizes = {
     fluid: createAdSize(0, 0),
     googleCard: createAdSize(300, 274),
     outOfPage: createAdSize(1, 1),
-    // guardian proprietary ad sizes
+};
+const guardianProprietaryAdSizes = {
     empty: createAdSize(2, 2),
     fabric: createAdSize(88, 71),
     inlineMerchandising: createAdSize(88, 85),
@@ -65,13 +74,10 @@ const adSizesPartial = {
     cascade: createAdSize(940, 230),
 };
 const adSizes = {
-    ...adSizesPartial,
-    '970x250': adSizesPartial.billboard,
-    '728x90': adSizesPartial.leaderboard,
-    '300x250': adSizesPartial.mpu,
-    '300x600': adSizesPartial.halfPage,
-    '300x1050': adSizesPartial.portrait,
-    '160x600': adSizesPartial.skyscraper,
+    ...namedStandardAdSizes,
+    ...standardAdSizes,
+    ...dfpProprietaryAdSizes,
+    ...guardianProprietaryAdSizes,
 };
 /**
  * mark: 432b3a46-90c1-4573-90d3-2400b51af8d0
@@ -251,4 +257,4 @@ const slotSizeMappings = {
 const getAdSize = (size) => adSizes[size];
 // Export for testing
 export const _ = { createAdSize };
-export { adSizes, getAdSize, slotSizeMappings, createAdSize };
+export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize };

package/dist/esm/constants/adLabelHeight.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Unit: pixels
+ */
+export declare const AD_LABEL_HEIGHT = 24;

package/dist/esm/constants/adLabelHeight.js

@@ -0,0 +1,4 @@
+/**
+ * Unit: pixels
+ */
+export const AD_LABEL_HEIGHT = 24;

package/dist/esm/constants/index.d.ts

@@ -1,2 +1,3 @@
+export { AD_LABEL_HEIGHT } from './adLabelHeight';
 export { PREBID_TIMEOUT } from './prebid-timeout';
 export { TOP_ABOVE_NAV_HEIGHT } from './top-above-nav-height';

package/dist/esm/constants/index.js

@@ -1,2 +1,3 @@
+export { AD_LABEL_HEIGHT } from './adLabelHeight';
 export { PREBID_TIMEOUT } from './prebid-timeout';
 export { TOP_ABOVE_NAV_HEIGHT } from './top-above-nav-height';

package/dist/esm/constants/prebid-timeout.d.ts

@@ -1,6 +1,4 @@
 /**
- * Unit: milliseconds.
- *
- * This value is currently being investigated.
+ * Unit: milliseconds
  */
 export declare const PREBID_TIMEOUT = 1500;

package/dist/esm/constants/prebid-timeout.js

@@ -1,11 +1,4 @@
 /**
- * Unit: milliseconds.
- *
- * This value is currently being investigated.
+ * Unit: milliseconds
  */
 export const PREBID_TIMEOUT = 1500;
-/*
-
-cc @chrislomaxjones
-
-*/

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, getAdSize, slotSizeMappings, createAdSize } from './ad-sizes';
+export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize, } 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,3 +35,4 @@ 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 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, getAdSize, slotSizeMappings, createAdSize } from './ad-sizes';
+export { adSizes, standardAdSizes, getAdSize, slotSizeMappings, createAdSize, } from './ad-sizes';
 export { isBreakpoint } from './lib/breakpoint';
 export { isAdBlockInUse } from './detect-ad-blocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';

package/package.json

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