@guardian/commercial-core 3.5.0 → 4.0.0

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

@@ -11,7 +11,7 @@ interface SizeMapping {
     phablet?: AdSize[];
     tablet?: AdSize[];
 }
-interface SizeMappings {
+interface SlotSizeMappings {
     right: SizeMapping;
     comments: SizeMapping;
     'top-above-nav': SizeMapping;
@@ -21,10 +21,10 @@ interface SizeMappings {
     survey: SizeMapping;
 }
 declare const adSizes: Record<SizeKeys, AdSize>;
-declare const sizeMappings: SizeMappings;
+declare const slotSizeMappings: SlotSizeMappings;
 declare const getAdSize: (size: SizeKeys) => AdSize;
 export declare const _: {
     createAdSize: (width: number, height: number) => AdSize;
 };
-export type { AdSizeString, AdSize, SizeKeys };
-export { adSizes, getAdSize, sizeMappings };
+export type { AdSizeString, AdSize, SizeKeys, SizeMapping };
+export { adSizes, getAdSize, slotSizeMappings };

package/dist/cjs/ad-sizes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sizeMappings = exports.getAdSize = exports.adSizes = exports._ = void 0;
+exports.slotSizeMappings = exports.getAdSize = exports.adSizes = exports._ = void 0;
 const createAdSize = (width, height) => {
     const toString = () => width === 0 && height === 0 ? 'fluid' : `${width},${height}`;
     return Object.freeze({
@@ -43,7 +43,7 @@ const adSizes = {
     '160x600': adSizesPartial.skyscraper,
 };
 exports.adSizes = adSizes;
-const sizeMappings = {
+const slotSizeMappings = {
     right: {
         mobile: [
             adSizes.outOfPage,
@@ -156,7 +156,7 @@ const sizeMappings = {
         desktop: [adSizes.outOfPage],
     },
 };
-exports.sizeMappings = sizeMappings;
+exports.slotSizeMappings = slotSizeMappings;
 const getAdSize = (size) => adSizes[size];
 exports.getAdSize = getAdSize;
 // Export for testing

package/dist/cjs/create-ad-slot.d.ts

@@ -0,0 +1,9 @@
+import type { AdSize } from './ad-sizes';
+declare type SlotName = 'im' | 'high-merch' | 'high-merch-lucky' | 'high-merch-paid' | 'inline' | 'mostpop' | 'comments' | 'top-above-nav' | 'carrot' | 'epic' | 'mobile-sticky';
+declare type CreateSlotOptions = {
+    classes?: string;
+    name?: string;
+    sizes?: Record<string, AdSize[]>;
+};
+export declare const createAdSlot: (name: SlotName, options?: CreateSlotOptions) => HTMLElement;
+export {};

package/dist/cjs/create-ad-slot.js

@@ -0,0 +1,229 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAdSlot = void 0;
+const ad_sizes_1 = require("./ad-sizes");
+const adSlotIdPrefix = 'dfp-ad--';
+const commonSizeMappings = {
+    mobile: [
+        ad_sizes_1.adSizes.outOfPage,
+        ad_sizes_1.adSizes.empty,
+        ad_sizes_1.adSizes.outstreamMobile,
+        ad_sizes_1.adSizes.mpu,
+        ad_sizes_1.adSizes.googleCard,
+        ad_sizes_1.adSizes.fluid,
+    ],
+    phablet: [
+        ad_sizes_1.adSizes.outOfPage,
+        ad_sizes_1.adSizes.empty,
+        ad_sizes_1.adSizes.outstreamMobile,
+        ad_sizes_1.adSizes.mpu,
+        ad_sizes_1.adSizes.googleCard,
+        ad_sizes_1.adSizes.fluid,
+    ],
+    desktop: [
+        ad_sizes_1.adSizes.outOfPage,
+        ad_sizes_1.adSizes.empty,
+        ad_sizes_1.adSizes.mpu,
+        ad_sizes_1.adSizes.googleCard,
+        ad_sizes_1.adSizes.fluid,
+    ],
+};
+/*
+
+    mark: 432b3a46-90c1-4573-90d3-2400b51af8d0
+
+    The ad sizes which are hardcoded here are also hardcoded in the source code of
+    dotcom-rendering.
+
+    If/when this file is modified, please make sure that updates, if any, are reported to DCR.
+
+    TODO use a map type??
+    want to assert that values are of type AdSlotConfig
+ */
+const adSlotConfigs = {
+    im: {
+        label: false,
+        refresh: false,
+        sizeMappings: {
+            mobile: [
+                ad_sizes_1.adSizes.outOfPage,
+                ad_sizes_1.adSizes.empty,
+                ad_sizes_1.adSizes.inlineMerchandising,
+                ad_sizes_1.adSizes.fluid,
+            ],
+        },
+    },
+    'high-merch': {
+        label: false,
+        refresh: false,
+        name: 'merchandising-high',
+        sizeMappings: {
+            mobile: [
+                ad_sizes_1.adSizes.outOfPage,
+                ad_sizes_1.adSizes.empty,
+                ad_sizes_1.adSizes.merchandisingHigh,
+                ad_sizes_1.adSizes.fluid,
+            ],
+        },
+    },
+    'high-merch-lucky': {
+        label: false,
+        refresh: false,
+        name: 'merchandising-high-lucky',
+        sizeMappings: {
+            mobile: [ad_sizes_1.adSizes.outOfPage, ad_sizes_1.adSizes.empty, ad_sizes_1.adSizes.fluid],
+        },
+    },
+    'high-merch-paid': {
+        label: false,
+        refresh: false,
+        name: 'merchandising-high',
+        sizeMappings: {
+            mobile: [
+                ad_sizes_1.adSizes.outOfPage,
+                ad_sizes_1.adSizes.empty,
+                ad_sizes_1.adSizes.merchandisingHighAdFeature,
+                ad_sizes_1.adSizes.fluid,
+            ],
+        },
+    },
+    inline: {
+        sizeMappings: commonSizeMappings,
+    },
+    mostpop: {
+        sizeMappings: commonSizeMappings,
+    },
+    comments: {
+        sizeMappings: commonSizeMappings,
+    },
+    'top-above-nav': {
+        sizeMappings: {
+            mobile: [
+                ad_sizes_1.adSizes.outOfPage,
+                ad_sizes_1.adSizes.empty,
+                ad_sizes_1.adSizes.fabric,
+                ad_sizes_1.adSizes.outstreamMobile,
+                ad_sizes_1.adSizes.mpu,
+                ad_sizes_1.adSizes.fluid,
+            ],
+        },
+    },
+    carrot: {
+        label: false,
+        refresh: false,
+        name: 'carrot',
+        sizeMappings: {
+            mobile: [ad_sizes_1.adSizes.fluid],
+        },
+    },
+    epic: {
+        label: false,
+        refresh: false,
+        name: 'epic',
+        sizeMappings: {
+            mobile: [ad_sizes_1.adSizes.fluid],
+        },
+    },
+    'mobile-sticky': {
+        label: true,
+        refresh: true,
+        name: 'mobile-sticky',
+        sizeMappings: {
+            mobile: [ad_sizes_1.adSizes.mobilesticky],
+        },
+    },
+};
+/**
+  Returns an adSlot HTMLElement which is the main DFP slot.
+
+  Insert that element as siblings at the place you want adverts to appear.
+
+  Note that for the DFP slot to be filled by GTP, you'll have to
+  use addSlot from add-slot.js
+*/
+const createAdSlotElement = (name, attrs, classes) => {
+    const id = `${adSlotIdPrefix}${name}`;
+    // 3562dc07-78e9-4507-b922-78b979d4c5cb
+    if (window.guardian.config?.isDotcomRendering && name === 'top-above-nav') {
+        // This is to prevent a problem that appeared with DCR.
+        // We are simply making sure that if we are about to
+        // introduce dfp-ad--top-above-nav then there isn't already one.
+        const node = document.getElementById(id);
+        if (node?.parentNode) {
+            const pnode = node.parentNode;
+            console.log(`warning: cleaning up dom node id: dfp-ad--${name}`);
+            pnode.removeChild(node);
+        }
+    }
+    // The 'main' adSlot
+    const adSlot = document.createElement('div');
+    adSlot.id = id;
+    adSlot.className = `js-ad-slot ad-slot ${classes.join(' ')}`;
+    adSlot.setAttribute('data-link-name', `ad slot ${name}`);
+    adSlot.setAttribute('data-name', name);
+    adSlot.setAttribute('aria-hidden', 'true');
+    Object.entries(attrs).forEach(([k, v]) => adSlot.setAttribute(k, v));
+    return adSlot;
+};
+/**
+ * Split class names and prefix all with ad-slot--${className}
+ */
+const createClasses = (slotName, classes) => [...(classes?.split(' ') ?? []), slotName].map((className) => `ad-slot--${className}`);
+/**
+ * Given default size mappings and additional size mappings from
+ * the createAdSlot options parameter.
+ *
+ * 1. Check that the options size mappings use known device names
+ * 2. If so concat the size mappings
+ *
+ */
+const concatSizeMappings = (defaultSizeMappings, optionSizeMappings) => {
+    if (!optionSizeMappings)
+        return defaultSizeMappings;
+    const concatenatedSizeMappings = { ...defaultSizeMappings };
+    const optionDevices = Object.keys(optionSizeMappings); // ['mobile', 'desktop']
+    for (let i = 0; i < optionDevices.length; i++) {
+        const device = optionDevices[i];
+        if (optionSizeMappings[device] && defaultSizeMappings[device]) {
+            const optionSizeMappingsForDevice = optionSizeMappings[device];
+            const defaultSizeMappingsForDevice = defaultSizeMappings[device];
+            if (defaultSizeMappingsForDevice && optionSizeMappingsForDevice) {
+                // TODO can we do concatenatedSizeMappings[device]?.concat ?
+                concatenatedSizeMappings[device] = (concatenatedSizeMappings[device] ?? []).concat(optionSizeMappingsForDevice);
+            }
+        }
+    }
+    return concatenatedSizeMappings;
+};
+/**
+ * Convert size mappings to a string that will be added to the ad slot
+ * data attributes.
+ *
+ * e.g. { desktop: [[320,250], [320, 280]] } => { desktop: '320,250|320,280' }
+ *
+ */
+const covertSizeMappingsToStrings = (sizeMappings) => Object.entries(sizeMappings).reduce((result, [device, sizes]) => {
+    result[device] = sizes.join('|');
+    return result;
+}, {});
+/**
+ * Prefix all object keys with data-${key}
+ */
+const createDataAttributes = (attrs) => Object.entries(attrs).reduce((result, [key, value]) => {
+    result[`data-${key}`] = value;
+    return result;
+}, {});
+const createAdSlot = (name, options = {}) => {
+    const adSlotConfig = adSlotConfigs[name];
+    const slotName = options.name ?? adSlotConfig.name ?? name;
+    const sizeMappings = concatSizeMappings(adSlotConfig.sizeMappings, options.sizes);
+    const attributes = covertSizeMappingsToStrings(sizeMappings);
+    if (adSlotConfig.label === false) {
+        attributes.label = 'false';
+    }
+    if (adSlotConfig.refresh === false) {
+        attributes.refresh = 'false';
+    }
+    return createAdSlotElement(slotName, createDataAttributes(attributes), createClasses(slotName, options.classes));
+};
+exports.createAdSlot = createAdSlot;

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, sizeMappings } from './ad-sizes';
+export { adSizes, getAdSize, slotSizeMappings } from './ad-sizes';
 export type { SizeKeys, AdSizeString, AdSize } from './ad-sizes';
 export { isAdBlockInUse } from './detect-ad-blocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';

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.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackGpcSignal = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = exports.sizeMappings = 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.pickTargetingValues = exports.getViewportTargeting = exports.getSharedTargeting = exports.getSessionTargeting = exports.getPersonalisedTargeting = exports.getContentTargeting = exports.constants = exports.disabledAds = exports.buildAdsConfigWithConsent = exports.initTrackGpcSignal = exports.initTrackScrollDepth = exports.getPermutivePFPSegments = exports.getPermutiveSegments = exports.clearPermutiveSegments = exports.isAdBlockInUse = 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;
 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");
@@ -45,7 +45,7 @@ Object.defineProperty(exports, "initCommercialMetrics", { enumerable: true, get:
 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; } });
-Object.defineProperty(exports, "sizeMappings", { enumerable: true, get: function () { return ad_sizes_1.sizeMappings; } });
+Object.defineProperty(exports, "slotSizeMappings", { enumerable: true, get: function () { return ad_sizes_1.slotSizeMappings; } });
 var detect_ad_blocker_1 = require("./detect-ad-blocker");
 Object.defineProperty(exports, "isAdBlockInUse", { enumerable: true, get: function () { return detect_ad_blocker_1.isAdBlockInUse; } });
 var permutive_2 = require("./permutive");

package/dist/cjs/types.d.ts

@@ -23,6 +23,7 @@ export declare type GuardianAnalyticsConfig = {
 };
 export declare type GuardianWindowConfig = {
     googleAnalytics?: GuardianAnalyticsConfig;
+    isDotcomRendering?: boolean;
 };
 export declare type GoogleTagParams = unknown;
 export declare type GoogleTrackConversionObject = {

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

@@ -11,7 +11,7 @@ interface SizeMapping {
     phablet?: AdSize[];
     tablet?: AdSize[];
 }
-interface SizeMappings {
+interface SlotSizeMappings {
     right: SizeMapping;
     comments: SizeMapping;
     'top-above-nav': SizeMapping;
@@ -21,10 +21,10 @@ interface SizeMappings {
     survey: SizeMapping;
 }
 declare const adSizes: Record<SizeKeys, AdSize>;
-declare const sizeMappings: SizeMappings;
+declare const slotSizeMappings: SlotSizeMappings;
 declare const getAdSize: (size: SizeKeys) => AdSize;
 export declare const _: {
     createAdSize: (width: number, height: number) => AdSize;
 };
-export type { AdSizeString, AdSize, SizeKeys };
-export { adSizes, getAdSize, sizeMappings };
+export type { AdSizeString, AdSize, SizeKeys, SizeMapping };
+export { adSizes, getAdSize, slotSizeMappings };

package/dist/esm/ad-sizes.js

@@ -39,7 +39,7 @@ const adSizes = {
     '300x1050': adSizesPartial.portrait,
     '160x600': adSizesPartial.skyscraper,
 };
-const sizeMappings = {
+const slotSizeMappings = {
     right: {
         mobile: [
             adSizes.outOfPage,
@@ -155,4 +155,4 @@ const sizeMappings = {
 const getAdSize = (size) => adSizes[size];
 // Export for testing
 export const _ = { createAdSize };
-export { adSizes, getAdSize, sizeMappings };
+export { adSizes, getAdSize, slotSizeMappings };

package/dist/esm/create-ad-slot.d.ts

@@ -0,0 +1,9 @@
+import type { AdSize } from './ad-sizes';
+declare type SlotName = 'im' | 'high-merch' | 'high-merch-lucky' | 'high-merch-paid' | 'inline' | 'mostpop' | 'comments' | 'top-above-nav' | 'carrot' | 'epic' | 'mobile-sticky';
+declare type CreateSlotOptions = {
+    classes?: string;
+    name?: string;
+    sizes?: Record<string, AdSize[]>;
+};
+export declare const createAdSlot: (name: SlotName, options?: CreateSlotOptions) => HTMLElement;
+export {};

package/dist/esm/create-ad-slot.js

@@ -0,0 +1,225 @@
+import { adSizes } from './ad-sizes';
+const adSlotIdPrefix = 'dfp-ad--';
+const commonSizeMappings = {
+    mobile: [
+        adSizes.outOfPage,
+        adSizes.empty,
+        adSizes.outstreamMobile,
+        adSizes.mpu,
+        adSizes.googleCard,
+        adSizes.fluid,
+    ],
+    phablet: [
+        adSizes.outOfPage,
+        adSizes.empty,
+        adSizes.outstreamMobile,
+        adSizes.mpu,
+        adSizes.googleCard,
+        adSizes.fluid,
+    ],
+    desktop: [
+        adSizes.outOfPage,
+        adSizes.empty,
+        adSizes.mpu,
+        adSizes.googleCard,
+        adSizes.fluid,
+    ],
+};
+/*
+
+    mark: 432b3a46-90c1-4573-90d3-2400b51af8d0
+
+    The ad sizes which are hardcoded here are also hardcoded in the source code of
+    dotcom-rendering.
+
+    If/when this file is modified, please make sure that updates, if any, are reported to DCR.
+
+    TODO use a map type??
+    want to assert that values are of type AdSlotConfig
+ */
+const adSlotConfigs = {
+    im: {
+        label: false,
+        refresh: false,
+        sizeMappings: {
+            mobile: [
+                adSizes.outOfPage,
+                adSizes.empty,
+                adSizes.inlineMerchandising,
+                adSizes.fluid,
+            ],
+        },
+    },
+    'high-merch': {
+        label: false,
+        refresh: false,
+        name: 'merchandising-high',
+        sizeMappings: {
+            mobile: [
+                adSizes.outOfPage,
+                adSizes.empty,
+                adSizes.merchandisingHigh,
+                adSizes.fluid,
+            ],
+        },
+    },
+    'high-merch-lucky': {
+        label: false,
+        refresh: false,
+        name: 'merchandising-high-lucky',
+        sizeMappings: {
+            mobile: [adSizes.outOfPage, adSizes.empty, adSizes.fluid],
+        },
+    },
+    'high-merch-paid': {
+        label: false,
+        refresh: false,
+        name: 'merchandising-high',
+        sizeMappings: {
+            mobile: [
+                adSizes.outOfPage,
+                adSizes.empty,
+                adSizes.merchandisingHighAdFeature,
+                adSizes.fluid,
+            ],
+        },
+    },
+    inline: {
+        sizeMappings: commonSizeMappings,
+    },
+    mostpop: {
+        sizeMappings: commonSizeMappings,
+    },
+    comments: {
+        sizeMappings: commonSizeMappings,
+    },
+    'top-above-nav': {
+        sizeMappings: {
+            mobile: [
+                adSizes.outOfPage,
+                adSizes.empty,
+                adSizes.fabric,
+                adSizes.outstreamMobile,
+                adSizes.mpu,
+                adSizes.fluid,
+            ],
+        },
+    },
+    carrot: {
+        label: false,
+        refresh: false,
+        name: 'carrot',
+        sizeMappings: {
+            mobile: [adSizes.fluid],
+        },
+    },
+    epic: {
+        label: false,
+        refresh: false,
+        name: 'epic',
+        sizeMappings: {
+            mobile: [adSizes.fluid],
+        },
+    },
+    'mobile-sticky': {
+        label: true,
+        refresh: true,
+        name: 'mobile-sticky',
+        sizeMappings: {
+            mobile: [adSizes.mobilesticky],
+        },
+    },
+};
+/**
+  Returns an adSlot HTMLElement which is the main DFP slot.
+
+  Insert that element as siblings at the place you want adverts to appear.
+
+  Note that for the DFP slot to be filled by GTP, you'll have to
+  use addSlot from add-slot.js
+*/
+const createAdSlotElement = (name, attrs, classes) => {
+    const id = `${adSlotIdPrefix}${name}`;
+    // 3562dc07-78e9-4507-b922-78b979d4c5cb
+    if (window.guardian.config?.isDotcomRendering && name === 'top-above-nav') {
+        // This is to prevent a problem that appeared with DCR.
+        // We are simply making sure that if we are about to
+        // introduce dfp-ad--top-above-nav then there isn't already one.
+        const node = document.getElementById(id);
+        if (node?.parentNode) {
+            const pnode = node.parentNode;
+            console.log(`warning: cleaning up dom node id: dfp-ad--${name}`);
+            pnode.removeChild(node);
+        }
+    }
+    // The 'main' adSlot
+    const adSlot = document.createElement('div');
+    adSlot.id = id;
+    adSlot.className = `js-ad-slot ad-slot ${classes.join(' ')}`;
+    adSlot.setAttribute('data-link-name', `ad slot ${name}`);
+    adSlot.setAttribute('data-name', name);
+    adSlot.setAttribute('aria-hidden', 'true');
+    Object.entries(attrs).forEach(([k, v]) => adSlot.setAttribute(k, v));
+    return adSlot;
+};
+/**
+ * Split class names and prefix all with ad-slot--${className}
+ */
+const createClasses = (slotName, classes) => [...(classes?.split(' ') ?? []), slotName].map((className) => `ad-slot--${className}`);
+/**
+ * Given default size mappings and additional size mappings from
+ * the createAdSlot options parameter.
+ *
+ * 1. Check that the options size mappings use known device names
+ * 2. If so concat the size mappings
+ *
+ */
+const concatSizeMappings = (defaultSizeMappings, optionSizeMappings) => {
+    if (!optionSizeMappings)
+        return defaultSizeMappings;
+    const concatenatedSizeMappings = { ...defaultSizeMappings };
+    const optionDevices = Object.keys(optionSizeMappings); // ['mobile', 'desktop']
+    for (let i = 0; i < optionDevices.length; i++) {
+        const device = optionDevices[i];
+        if (optionSizeMappings[device] && defaultSizeMappings[device]) {
+            const optionSizeMappingsForDevice = optionSizeMappings[device];
+            const defaultSizeMappingsForDevice = defaultSizeMappings[device];
+            if (defaultSizeMappingsForDevice && optionSizeMappingsForDevice) {
+                // TODO can we do concatenatedSizeMappings[device]?.concat ?
+                concatenatedSizeMappings[device] = (concatenatedSizeMappings[device] ?? []).concat(optionSizeMappingsForDevice);
+            }
+        }
+    }
+    return concatenatedSizeMappings;
+};
+/**
+ * Convert size mappings to a string that will be added to the ad slot
+ * data attributes.
+ *
+ * e.g. { desktop: [[320,250], [320, 280]] } => { desktop: '320,250|320,280' }
+ *
+ */
+const covertSizeMappingsToStrings = (sizeMappings) => Object.entries(sizeMappings).reduce((result, [device, sizes]) => {
+    result[device] = sizes.join('|');
+    return result;
+}, {});
+/**
+ * Prefix all object keys with data-${key}
+ */
+const createDataAttributes = (attrs) => Object.entries(attrs).reduce((result, [key, value]) => {
+    result[`data-${key}`] = value;
+    return result;
+}, {});
+export const createAdSlot = (name, options = {}) => {
+    const adSlotConfig = adSlotConfigs[name];
+    const slotName = options.name ?? adSlotConfig.name ?? name;
+    const sizeMappings = concatSizeMappings(adSlotConfig.sizeMappings, options.sizes);
+    const attributes = covertSizeMappingsToStrings(sizeMappings);
+    if (adSlotConfig.label === false) {
+        attributes.label = 'false';
+    }
+    if (adSlotConfig.refresh === false) {
+        attributes.refresh = 'false';
+    }
+    return createAdSlotElement(slotName, createDataAttributes(attributes), createClasses(slotName, options.classes));
+};

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, sizeMappings } from './ad-sizes';
+export { adSizes, getAdSize, slotSizeMappings } from './ad-sizes';
 export type { SizeKeys, AdSizeString, AdSize } from './ad-sizes';
 export { isAdBlockInUse } from './detect-ad-blocker';
 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 './event-timer';
 export { bypassCommercialMetricsSampling, initCommercialMetrics, } from './send-commercial-metrics';
-export { adSizes, getAdSize, sizeMappings } from './ad-sizes';
+export { adSizes, getAdSize, slotSizeMappings } from './ad-sizes';
 export { isAdBlockInUse } from './detect-ad-blocker';
 export { clearPermutiveSegments, getPermutiveSegments, getPermutivePFPSegments, } from './permutive';
 export { initTrackScrollDepth } from './track-scroll-depth';

package/dist/esm/types.d.ts

@@ -23,6 +23,7 @@ export declare type GuardianAnalyticsConfig = {
 };
 export declare type GuardianWindowConfig = {
     googleAnalytics?: GuardianAnalyticsConfig;
+    isDotcomRendering?: boolean;
 };
 export declare type GoogleTagParams = unknown;
 export declare type GoogleTrackConversionObject = {

package/package.json

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