@guardian/commercial-core 7.0.0 → 27.0.0

package/dist/cjs/track-scroll-depth.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initTrackScrollDepth = void 0;
-const libs_1 = require("@guardian/libs");
-const event_timer_1 = require("./event-timer");
-/**
- * Collect commercial metrics on scroll depth
- * Insert hidden elements at intervals of 1 viewport height
- * then use an intersection observer to mark the time when the viewport intersects with these elements.
- * Approach inspired by https://gist.github.com/bgreater/2412517f5a3f9c6fc4cafeb1ca71384f
- */
-const initTrackScrollDepth = () => {
-    const pageHeight = document.body.offsetHeight;
-    const intViewportHeight = window.innerHeight;
-    // how many viewports tall is the page?
-    const pageHeightVH = Math.floor(pageHeight / intViewportHeight);
-    const eventTimer = event_timer_1.EventTimer.get();
-    eventTimer.setProperty('pageHeightVH', pageHeightVH);
-    const observer = new IntersectionObserver(
-    /* istanbul ignore next */
-    (entries) => {
-        entries.forEach((entry) => {
-            if (entry.isIntersecting) {
-                const currentDepthVH = String(entry.target.getAttribute('data-depth'));
-                (0, libs_1.log)('commercial', `current scroll depth ${currentDepthVH}`);
-                eventTimer.trigger(`scroll-depth-vh-${currentDepthVH}`);
-                observer.unobserve(entry.target);
-            }
-        });
-    });
-    for (let depth = 1; depth <= pageHeightVH; depth++) {
-        const div = document.createElement('div');
-        div.dataset.depth = String(depth);
-        div.style.top = String(100 * depth) + '%';
-        div.style.position = 'absolute';
-        div.className = 'scroll-depth-marker';
-        document.body.appendChild(div);
-        observer.observe(div);
-    }
-};
-exports.initTrackScrollDepth = initTrackScrollDepth;

package/dist/esm/__vendor/a9-apstag.d.ts

@@ -1 +0,0 @@
-export function a9Apstag(): void;

package/dist/esm/__vendor/a9-apstag.js

@@ -1,30 +0,0 @@
-/**
- * Load Amazon A9 library as {@link https://ams.amazon.com/webpublisher/uam/docs/web-integration-documentation/integration-guide/javascript-guide/display.html described here}
- */
-export const a9Apstag = () => {
-    (function (a9, a, p, s, t, A, g) {
-        if (a[a9])
-            return;
-        function q(c, r) {
-            a[a9]._Q.push([c, r]);
-        }
-        a[a9] = {
-            init() {
-                q('i', arguments);
-            },
-            fetchBids() {
-                q('f', arguments);
-            },
-            setDisplayBids() { },
-            targetingKeys() {
-                return [];
-            },
-            _Q: [],
-        };
-        A = p.createElement(s);
-        A.async = !0;
-        A.src = t;
-        g = p.getElementsByTagName(s)[0];
-        g.parentNode.insertBefore(A, g);
-    })('apstag', window, document, 'script', '//c.amazon-adsystem.com/aax2/apstag.js');
-};

package/dist/esm/__vendor/ipsos-mori.d.ts

@@ -1 +0,0 @@
-export function ipsosMoriStub(): void;

package/dist/esm/__vendor/ipsos-mori.js

@@ -1,14 +0,0 @@
-/**
- * Load the Ipsos Mori Stub
- *
- * See {@Link https://github.com/guardian/dotcom-rendering/blob/150fc2d81e6a66d9c3336185e874fc8cd0288546/dotcom-rendering/docs/architecture/3rd%20party%20technical%20review/002-ipsos-mori.md documentation here }
- */
-export const ipsosMoriStub = () => {
-    window.dm = window.dm || { AjaxData: [] };
-    window.dm.AjaxEvent = (et, d, ssid, ad) => {
-        dm.AjaxData.push({ et, d, ssid, ad });
-        if (window.DotMetricsObj) {
-            DotMetricsObj.onAjaxDataUpdate();
-        }
-    };
-};

package/dist/esm/__vendor/launchpad.d.ts

@@ -1 +0,0 @@
-export function launchpad(): void;

package/dist/esm/__vendor/launchpad.js

@@ -1,21 +0,0 @@
-/**
- *  Loads the Launchpad js tracker (used by Redplanet) into the page,
- *  and creates the global "launchpad" method
- */
-export const launchpad = () => {
-    (function (p, l, o, w, i, n, g) {
-        if (!p[i]) {
-            p.GlobalSnowplowNamespace = p.GlobalSnowplowNamespace || [];
-            p.GlobalSnowplowNamespace.push(i);
-            p[i] = function () {
-                (p[i].q = p[i].q || []).push(arguments);
-            };
-            p[i].q = p[i].q || [];
-            n = l.createElement(o);
-            g = l.getElementsByTagName(o)[0];
-            n.async = 1;
-            n.src = w;
-            g.parentNode.insertBefore(n, g);
-        }
-    }(window, document, "script", "https://lps.qantas.com/sp.js", "launchpad"));
-};

package/dist/esm/__vendor/pubmatic.d.ts

@@ -1 +0,0 @@
-export function pubmatic(bid: any, data: any, acEnabled: any, utils: any, defaultFn: any): void;

package/dist/esm/__vendor/pubmatic.js

@@ -1,45 +0,0 @@
-/**
- * Pubmatic custom override script
- *
- * From {@Link https://gist.github.com/abhinavsinha001/de46bd4ac4f02d98eb50c1f4f995545e}
- */
-export const pubmatic = function (bid, data, acEnabled, utils, defaultFn) {
-    if (defaultFn) {
-        // keep this to move to default function once supported by RTD submodule
-        bid = defaultFn(bid, data, acEnabled);
-    }
-    else {
-        let segments = [];
-        // add all user segments
-        try {
-            const psegs = JSON.parse(localStorage._psegs || '[]').map(String);
-            const ppam = JSON.parse(localStorage._ppam || '[]');
-            const pcrprs = JSON.parse(localStorage._pcrprs || '[]');
-            segments = [...psegs, ...ppam, ...pcrprs];
-        }
-        catch (e) { }
-        // add AC specific segments (these would typically go to a separate key-value, but not sure if we can have 2 lists of segments here?)
-        if (acEnabled && data.ac && data.ac.length > 0) {
-            segments = segments.concat(data.ac);
-        }
-        segments = segments.map(function (seg) {
-            return { id: seg };
-        });
-        pbjs.setBidderConfig({
-            // Note this will replace existing bidder FPD config till merge is supported.
-            bidders: ['pubmatic'],
-            config: {
-                ortb2: {
-                    user: {
-                        data: [
-                            {
-                                name: 'permutive.com',
-                                segment: segments,
-                            },
-                        ],
-                    },
-                },
-            },
-        });
-    }
-};

package/dist/esm/__vendor/twitter-script.d.ts

@@ -1 +0,0 @@
-export function twitterScript(): void;

package/dist/esm/__vendor/twitter-script.js

@@ -1,22 +0,0 @@
-// Twitter universal website tag code
-// How to set up conversion tracking: https://business.twitter.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites.html
-export const twitterScript = () => {
-    !(function (e, t, n, s, u, a) {
-        e.twq ||
-            ((s = e.twq = function () {
-                s.exe ? s.exe(...arguments) : s.queue.push(arguments);
-            }),
-                (s.version = '1.1'),
-                (s.queue = []),
-                (u = t.createElement(n)),
-                (u.async = !0),
-                (u.src = '//static.ads-twitter.com/uwt.js'),
-                (a = t.getElementsByTagName(n)[0]),
-                a.parentNode.insertBefore(u, a));
-    })(window, document, 'script');
-    // Insert Twitter Pixel ID and Standard Event data below
-    twq('init', 'nyl43'); // The Guardian ID
-    twq('track', 'PageView');
-    twq('init', 'ny4k9'); // PHD ID
-    twq('track', 'PageView');
-};

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

@@ -1,17 +0,0 @@
-import type { SizeMapping } from './ad-sizes';
-type SlotName = 'carrot' | 'comments-expanded' | 'comments' | 'epic' | 'exclusion' | 'high-merch-lucky' | 'high-merch-paid' | 'high-merch' | 'im' | 'inline' | 'mobile-sticky' | 'mostpop' | 'top-above-nav';
-type CreateSlotOptions = {
-    classes?: string;
-    name?: string;
-};
-/**
- * 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
- *
- */
-declare const concatSizeMappings: (defaultSizeMappings: SizeMapping, optionSizeMappings?: SizeMapping) => SizeMapping;
-declare const createAdSlot: (name: SlotName, options?: CreateSlotOptions) => HTMLElement;
-export { createAdSlot, concatSizeMappings };

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

@@ -1,103 +0,0 @@
-import { isBreakpoint } from './lib/breakpoint';
-const adSlotIdPrefix = 'dfp-ad--';
-const adSlotConfigs = {
-    im: {
-        label: false,
-        refresh: false,
-    },
-    'high-merch': {
-        label: false,
-        refresh: false,
-        name: 'merchandising-high',
-    },
-    'high-merch-lucky': {
-        label: false,
-        refresh: false,
-        name: 'merchandising-high-lucky',
-    },
-    'high-merch-paid': {
-        label: false,
-        refresh: false,
-        name: 'merchandising-high',
-    },
-    carrot: {
-        label: false,
-        refresh: false,
-        name: 'carrot',
-    },
-    epic: {
-        label: false,
-        refresh: false,
-        name: 'epic',
-    },
-    'mobile-sticky': {
-        label: true,
-        refresh: true,
-        name: 'mobile-sticky',
-    },
-};
-/**
-  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.dataset.linkName = `ad slot ${name}`;
-    adSlot.dataset.name = name;
-    adSlot.setAttribute('aria-hidden', 'true');
-    Object.entries(attrs).forEach(([k, v]) => (adSlot.dataset[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 = {}) => Object.entries(optionSizeMappings).reduce((sizeMappings, [breakpoint, optionSizes]) => {
-    // Only perform concatenation if breakpoint is of the correct type
-    if (isBreakpoint(breakpoint)) {
-        // Concatenate the option sizes onto any existing sizes present for a given breakpoint
-        sizeMappings[breakpoint] = (sizeMappings[breakpoint] ?? []).concat(optionSizes);
-    }
-    return sizeMappings;
-}, { ...defaultSizeMappings });
-const createAdSlot = (name, options = {}) => {
-    const adSlotConfig = adSlotConfigs[name] ?? {};
-    const slotName = options.name ?? adSlotConfig.name ?? name;
-    const dataAttributes = {};
-    if (adSlotConfig.label === false) {
-        dataAttributes.label = 'false';
-    }
-    if (adSlotConfig.refresh === false) {
-        dataAttributes.refresh = 'false';
-    }
-    return createAdSlotElement(slotName, dataAttributes, createClasses(slotName, options.classes));
-};
-export { createAdSlot, concatSizeMappings };

package/dist/esm/google-analytics.d.ts

@@ -1 +0,0 @@
-export declare const trackEvent: (timingCategory: string, timingVar: string, timingLabel: string) => void;

package/dist/esm/google-analytics.js

@@ -1,10 +0,0 @@
-export const trackEvent = (timingCategory, timingVar, timingLabel) => {
-    const { ga, guardian } = window;
-    const trackerName = guardian.config.googleAnalytics?.trackers.editorial;
-    if (typeof ga !== 'function') {
-        return;
-    }
-    const timeSincePageLoad = Math.round(window.performance.now());
-    const send = trackerName ? `${trackerName}.send` : 'send';
-    window.ga(send, 'timing', timingCategory, timingVar, timeSincePageLoad, timingLabel);
-};

package/dist/esm/lib/ab-localstorage.d.ts

@@ -1,2 +0,0 @@
-import type { Participations } from '@guardian/ab-core';
-export declare const getParticipationsFromLocalStorage: () => Participations;

package/dist/esm/lib/ab-localstorage.js

@@ -1,10 +0,0 @@
-import { isObject, isString, storage } from '@guardian/libs';
-const participationsKey = 'gu.ab.participations';
-const isParticipations = (participations) => {
-    return (isObject(participations) &&
-        Object.values(participations).every((participation) => isObject(participation) && isString(participation.variant)));
-};
-export const getParticipationsFromLocalStorage = () => {
-    const participations = storage.local.get(participationsKey);
-    return isParticipations(participations) ? participations : {};
-};

package/dist/esm/lib/breakpoint.d.ts

@@ -1,4 +0,0 @@
-type Breakpoint = 'mobile' | 'desktop' | 'phablet' | 'tablet';
-declare const isBreakpoint: (s: string) => s is Breakpoint;
-export type { Breakpoint };
-export { isBreakpoint };

package/dist/esm/lib/breakpoint.js

@@ -1,2 +0,0 @@
-const isBreakpoint = (s) => s === 'mobile' || s === 'phablet' || s === 'tablet' || s === 'desktop';
-export { isBreakpoint };

package/dist/esm/lib/can-use-dom.d.ts

@@ -1,2 +0,0 @@
-declare const canUseDom: () => boolean;
-export { canUseDom };

package/dist/esm/lib/can-use-dom.js

@@ -1,6 +0,0 @@
-// Based on https://github.com/JedWatson/exenv
-const canUseDom = () => !!(typeof window !== 'undefined' &&
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- ensure we check at runtime
-    window.document &&
-    window.document.createElement);
-export { canUseDom };

package/dist/esm/lib/construct-query.d.ts

@@ -1,3 +0,0 @@
-import type { MaybeArray } from '../types';
-declare const constructQuery: (query: Record<string, MaybeArray<string | number | boolean>>) => string;
-export { constructQuery };

package/dist/esm/lib/construct-query.js

@@ -1,9 +0,0 @@
-const constructQuery = (query) => Object.entries(query)
-    .map(([key, value]) => {
-    const queryValue = Array.isArray(value)
-        ? value.map((v) => encodeURIComponent(v)).join(',')
-        : encodeURIComponent(value);
-    return `${key}=${queryValue}`;
-})
-    .join('&');
-export { constructQuery };

package/dist/esm/messenger.d.ts

@@ -1,97 +0,0 @@
-/**
- * The type of iframe messages we accept
- */
-type MessageType = 'background' | 'click' | 'disable-refresh' | 'get-page-targeting' | 'get-page-url' | 'get-styles' | 'measure-ad-load' | 'passback' | 'resize' | 'set-ad-height' | 'scroll' | 'type' | 'viewport';
-/**
- * Callbacks that can be registered to fire when receiving messages from an iframe
- */
-type ListenerCallback = (
-/**
- * The data payload sent by an iframe, and has type `unknown` because we can't
- * predict what the iframe will send. It is the responsibility of the callback
- * to obtain a value of the desired type (or fail gracefully)
- */
-specs: unknown | undefined, 
-/**
- * Non-persistent callbacks can be chained together. This value is the return
- * value of the previously fired callback in the chain. It is the responsibility
- * of the current callback to either ignore it or use it / pass along
- */
-ret: unknown, 
-/**
- * Reference to the iframe that is the source of the message
- */
-iframe?: HTMLIFrameElement) => unknown;
-type RespondProxy = (error: {
-    message: string;
-} | null, result: unknown) => void;
-/**
- * Persistent callbacks that can be registered to fire when receiving messages from an iframe
- *
- * A persistent callback listener will be passed a RespondProxy function
- *
- * This function allows the listener to call respond (i.e. postMessage the originating iFrame) itself whenever it needs to
- *
- * This is useful for listeners such as viewport or scroll where the values change over time
- */
-type PersistentListenerCallback = (respondProxy: RespondProxy, specs: unknown, 
-/**
- * Reference to the iframe that is the source of the message
- */
-iframe?: HTMLIFrameElement) => void;
-type ListenerOptions = {
-    window?: WindowProxy;
-};
-type MessengerErrorHandler = (err: Error, features: Record<string, string>) => void;
-/**
- * Types of functions to register a listener for a given type of iframe message
- */
-type RegisterListener = (type: MessageType, callback: ListenerCallback, options?: ListenerOptions) => void;
-/**
- * Types of functions to register a persistent listener for a given type of iframe message
- */
-type RegisterPersistentListener = (type: MessageType, callback: PersistentListenerCallback, options?: ListenerOptions) => void;
-/**
- * Types of functions to unregister a listener for a given type of iframe message
- *
- */
-type UnregisterListener = (type: MessageType, callback?: ListenerCallback, options?: ListenerOptions) => void;
-/**
- * Register a listener for a given type of iframe message
- *
- * @param type The `type` of message to register against
- * @param callback The listener callback to register that will receive messages of the given type
- * @param options Options for the target window
- */
-export declare const register: RegisterListener;
-/**
- * Register a persistent listener for a given type of iframe message
- *
- * @param type The `type` of message to register against
- * @param callback The persistent listener callback to register that will receive messages of the given type
- * @param options Options for the target window and whether the callback is persistent
- */
-export declare const registerPersistentListener: RegisterPersistentListener;
-/**
- * Unregister a callback for a given type
- *
- * @param type The type of message to unregister against. An iframe will send
- * messages annotated with the type
- * @param callback Optionally include the original callback. If this is included
- * for a persistent callback this function will be unregistered. If it's
- * included for a non-persistent callback only the matching callback is removed,
- * otherwise all callbacks for that type will be unregistered
- * @param options Option for the target window
- */
-export declare const unregister: UnregisterListener;
-/**
- * Initialize an array of listener callbacks in a batch
- *
- * @param listeners The listener registration functions
- * @param persistentListeners The persistent listener registration functions
- */
-export declare const init: (listeners: ((register: RegisterListener, errorHandler: MessengerErrorHandler) => void)[], persistentListeners: ((register: RegisterPersistentListener, errorHandler: MessengerErrorHandler) => void)[], errorHandler: MessengerErrorHandler) => void;
-export declare const _: {
-    onMessage: (event: MessageEvent) => Promise<void>;
-};
-export type { RespondProxy, RegisterListener, RegisterPersistentListener, UnregisterListener, ListenerOptions, MessengerErrorHandler, };