@guardian/commercial-core 0.36.0 → 0.37.0

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

@@ -4,10 +4,9 @@ export declare type AdSize = Readonly<{
     height: number;
     toString: () => AdSizeString;
 }>;
-export declare type AdSizeTuple = [width: number, height: number];
 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 getTuple: (size: SizeKeys) => AdSizeTuple;
+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.getTuple = 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,11 +43,7 @@ exports.adSizes = {
     '300x1050': adSizesPartial.portrait,
     '160x600': adSizesPartial.skyscraper,
 };
-const getTuple = (size) => {
-    const { width, height } = exports.adSizes[size];
-    const tuple = [width, height];
-    return tuple;
-};
-exports.getTuple = getTuple;
+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/esm/ad-sizes.d.ts

@@ -4,10 +4,9 @@ export declare type AdSize = Readonly<{
     height: number;
     toString: () => AdSizeString;
 }>;
-export declare type AdSizeTuple = [width: number, height: number];
 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 getTuple: (size: SizeKeys) => AdSizeTuple;
+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,10 +40,6 @@ export const adSizes = {
     '300x1050': adSizesPartial.portrait,
     '160x600': adSizesPartial.skyscraper,
 };
-export const getTuple = (size) => {
-    const { width, height } = adSizes[size];
-    const tuple = [width, height];
-    return tuple;
-};
+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/package.json

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