@guardian/ophan-tracker-js 2.1.1 → 2.1.2-next.1

package/{assets → NPM-dist}/fb-instant.js

@@ -1,10 +1,7 @@
 // Generated by CoffeeScript 2.7.0
 import core from './core.js';
-
-import transmit from './transmit.js';
-
+import transmit from './transmit';
 core.init('facebook-instant-article');
-
 export default {
-	viewId: transmit.viewId,
+    viewId: transmit.viewId,
 };

package/NPM-dist/heatmap.js

@@ -0,0 +1,34 @@
+let heatmapFired = false;
+const init = () => {
+    const addHeatmap = () => {
+        let heatmapParam;
+        if (typeof localStorage !== 'undefined' &&
+            localStorage !== null &&
+            !heatmapFired) {
+            heatmapFired = true;
+            heatmapParam = window.location.search.replace(/^(?:.*[&\?]heatmap(?:\=([^&]*))?)?.*$/, '$1');
+            if (heatmapParam === 'experimental') {
+                return (document.body.appendChild(document.createElement('script')).src = '//dashboard.ophan.co.uk/assets/js/react/heatphan/index.js');
+            }
+            if (heatmapParam === 'true' || heatmapParam === 'false') {
+                localStorage['ophan_heatmap'] = heatmapParam;
+            }
+            if (localStorage['ophan_heatmap'] === 'true' || heatmapParam === 'show') {
+                return (document.body.appendChild(document.createElement('script')).src = '//dashboard.ophan.co.uk/assets/js/heatmap-bookmarklet.js');
+            }
+        }
+    };
+    if (document.readyState === 'complete') {
+        return addHeatmap();
+    }
+    else {
+        return typeof window.addEventListener === 'function'
+            ? window.addEventListener('load', function () {
+                return addHeatmap();
+            }, false)
+            : void 0;
+    }
+};
+export default {
+    init,
+};

package/{assets → NPM-dist}/holidays.js

@@ -1,11 +1,8 @@
 // Generated by CoffeeScript 2.7.0
 import core from './core.js';
-
-import transmit from './transmit.js';
-
+import transmit from './transmit';
 core.init('holidays');
-
 export default {
-	record: transmit.sendMore,
-	viewId: transmit.viewId,
+    record: transmit.sendMore,
+    viewId: transmit.viewId,
 };

package/{assets → NPM-dist}/http-status.js

@@ -1,13 +1,11 @@
 import core from './core.js';
-import './transmit.js';
+import './transmit.ts';
 import './click-path-capture.js';
 import './perf.js';
 import './campaign.js';
-
 const reportStatus = (platform, status) => {
-	return core.init(platform, status);
+    return core.init(platform, status);
 };
-
 export default {
-	reportStatus,
-};
+    reportStatus,
+};

package/NPM-dist/iframe-tracking.js

@@ -0,0 +1,80 @@
+import clickCapture from './click-path-capture.js';
+const validIframeDomains = [
+    '.theguardian.com',
+    '.dev-theguardian.com',
+    '.thegulocal.com', // NB - leading dot is essential here to avoid matching on non-Guardian-owned domains
+];
+/**
+ * Handles messages received from iframes, recording events as necessary.
+ * @param {MessageEvent} messageEvent - The message event received from an iframe.
+ */
+const handleIframeMessage = (messageEvent) => {
+    const originDomain = retrieveOriginDomain(messageEvent.origin);
+    if (originDomain &&
+        validIframeDomains.some((domain) => originDomain.endsWith(domain))) {
+        if (messageEvent.data.type === 'ophan-iframe-click-event') {
+            const eventObject = messageEvent.data.value;
+            const iFrame = document.getElementById(messageEvent.data.iframeId);
+            recordIframeClickEvent(iFrame, eventObject);
+        }
+        else if (messageEvent.data.type === 'ophan-iframe-component-event') {
+            const eventObject = messageEvent.data.value;
+            recordIframeComponentEvent(eventObject);
+        }
+    }
+};
+/**
+ * Retrieves the domain from an event's origin URL.
+ * @param {string} eventOrigin - The origin URL of the event.
+ * @returns {(string|null)} The domain of the origin URL or null if it cannot be parsed.
+ */
+const retrieveOriginDomain = (eventOrigin) => {
+    try {
+        const originURL = new URL(eventOrigin);
+        return originURL.host;
+    }
+    catch (error) {
+        if (error instanceof TypeError) {
+            // We failed to parse origin as an URL, we should ignore the event
+            return null;
+        }
+        else {
+            throw error;
+        }
+    }
+};
+/**
+ * Records a click event occurring within an iframe.
+ * @param {HTMLElement} iFrame - The iframe element where the click event occurred.
+ * @param {Object} clickEvent - The click event object to record.
+ */
+const recordIframeClickEvent = (iFrame, clickEvent) => {
+    if (iFrame) {
+        clickEvent.clickLinkNames =
+            clickCapture.getDataLinkNames(iFrame, clickEvent.clickLinkNames) ||
+                clickEvent.clickLinkNames;
+    }
+    window.guardian.ophan.record(clickEvent);
+};
+/**
+ * Validates if an event object is a valid component event.
+ * @param {Object} eventObject - The event object to validate.
+ * @returns {boolean} True if the event object is valid, false otherwise.
+ */
+const componentEventIsValid = (eventObject) => {
+    return (eventObject &&
+        typeof eventObject === 'object' &&
+        eventObject.componentEvent &&
+        typeof eventObject.componentEvent === 'object');
+};
+/**
+ * Records a component event from an iframe.
+ * @param {Object} eventObject - The component event object to record.
+ */
+const recordIframeComponentEvent = (eventObject) => {
+    if (!componentEventIsValid(eventObject)) {
+        return;
+    }
+    window.guardian.ophan.record(eventObject);
+};
+window.addEventListener('message', handleIframeMessage, false);

package/NPM-dist/interactive.js

@@ -0,0 +1,17 @@
+import core from './core.js';
+import transmit from './transmit';
+import attention from './attention.js';
+import './click-path-capture.js';
+if (window.guardian?.ophan) {
+    guardian.ophan;
+}
+else {
+    core.init('embed');
+    window.guardian = guardian || {};
+    guardian.ophan = {
+        setEventEmitter: attention.setEventEmitter,
+        trackComponentAttention: attention.initComponent,
+        record: transmit.sendMore,
+        viewId: transmit.viewId,
+    };
+}

package/{assets → NPM-dist}/jobs-courses.js

@@ -1,11 +1,8 @@
 // Generated by CoffeeScript 2.7.0
 import core from './core.js';
-
-import transmit from './transmit.js';
-
+import transmit from './transmit';
 core.init('jobs-courses');
-
 export default {
-	record: transmit.sendMore,
-	viewId: transmit.viewId,
+    record: transmit.sendMore,
+    viewId: transmit.viewId,
 };

package/{assets → NPM-dist}/jobs.js

@@ -1,11 +1,8 @@
 // Generated by CoffeeScript 2.7.0
 import core from './core.js';
-
-import transmit from './transmit.js';
-
+import transmit from './transmit';
 core.init('jobs');
-
 export default {
-	record: transmit.sendMore,
-	viewId: transmit.viewId,
+    record: transmit.sendMore,
+    viewId: transmit.viewId,
 };

package/NPM-dist/manage-my-account.js

@@ -0,0 +1,29 @@
+// Generated by CoffeeScript 2.7.0
+import core from './core.js';
+import transmit from './transmit';
+import attention from './attention.js';
+import visibility from './visibility.js';
+import './click-path-capture.js';
+import './perf.js';
+import './campaign.js';
+core.init('manage-my-account');
+if (window.addEventListener) {
+    attention.init(visibility);
+}
+const sendInitialEvent = (url = location.href, referrer = document.referrer) => {
+    try {
+        transmit.bumpViewId();
+        core.sendInitialEvent(null, url, referrer);
+    }
+    catch (error) {
+        console.log(error);
+    }
+};
+const exports = {
+    sendInitialEvent,
+    record: transmit.sendMore,
+    viewId: transmit.viewId,
+};
+window.guardian = window.guardian || {};
+window.guardian.ophan = exports;
+export default exports;

package/{assets → NPM-dist}/membership.js

@@ -1,25 +1,16 @@
 // Generated by CoffeeScript 2.7.0
 import core from './core.js';
-
-import transmit from './transmit.js';
-
+import transmit from './transmit';
 import attention from './attention.js';
-
 import visibility from './visibility.js';
-
 import './click-path-capture.js';
-
 import './perf.js';
-
 import './campaign.js';
-
 core.init('membership');
-
 if (window.addEventListener != null) {
-	attention.init(visibility);
+    attention.init(visibility);
 }
-
 export default {
-	record: transmit.sendMore,
-	viewId: transmit.viewId,
+    record: transmit.sendMore,
+    viewId: transmit.viewId,
 };

package/NPM-dist/ng.js

@@ -0,0 +1,46 @@
+import core from './core';
+import transmit from './transmit';
+import attention from './attention';
+import visibility from './visibility';
+import privatebrowsing from './privatebrowsing';
+import heatmap from './heatmap';
+import './click-path-capture';
+import './perf';
+import './iframe-tracking';
+export * from './types/abtest';
+export * from './types/acquisition';
+export * from './types/subscription';
+export * from './types/interaction';
+export * from './types/inpageclick';
+export * from './types/printproduct';
+export * from './types/product';
+export * from './types/platform';
+export * from './types/media';
+export * from './types/consent';
+export * from './types/component-type';
+export * from './types/component-event';
+export * from './types/event';
+let ng;
+if (window.guardian && window.guardian.ophan) {
+    ng = window.guardian.ophan;
+}
+else {
+    core.init('next-gen');
+    privatebrowsing.init();
+    heatmap.init();
+    if (window.addEventListener) {
+        attention.init(visibility);
+    }
+    if (!window.guardian) {
+        window.guardian = {};
+    }
+    window.guardian.ophan = {
+        setEventEmitter: attention.setEventEmitter,
+        trackComponentAttention: attention.initComponent,
+        record: transmit.sendMore,
+        viewId: transmit.viewId,
+        pageViewId: transmit.viewId
+    };
+    ng = window.guardian.ophan;
+}
+export default ng;

package/NPM-dist/perf.js

@@ -0,0 +1,36 @@
+// Generated by CoffeeScript 2.7.0
+import core from './core.js';
+const perf = window.performance ||
+    window.msPerformance ||
+    window.webkitPerformance ||
+    window.mozPerformance;
+const sendTimingData = () => {
+    const t = perf?.timing;
+    if (t) {
+        return {
+            performance: {
+                // Time required for domain lookup.
+                dns: t.domainLookupEnd - t.domainLookupStart,
+                // Time to establish a connection to server.
+                connection: t.connectEnd - t.connectStart,
+                // From connection established to first byte of data.
+                firstByte: t.responseStart - t.connectEnd,
+                // First byte to last byte, or closed, including if from cache.
+                lastByte: t.responseEnd - t.responseStart,
+                // From last byte of doc to start of domContentLoaded
+                domContentLoadedEvent: t.domContentLoadedEventStart - t.responseEnd,
+                // domcontentLoaded to start of load event.
+                loadEvent: t.loadEventStart - t.domContentLoadedEventStart,
+                // click, back/forward, etc...
+                navType: perf.navigation.type,
+                // No. of redirects on current domain.
+                redirectCount: perf.navigation.redirectCount,
+            },
+        };
+    }
+    else {
+        return {};
+    }
+};
+core.onLoadCapture(sendTimingData);
+export default perf;

package/NPM-dist/privatebrowsing.js

@@ -0,0 +1,66 @@
+import transmit from './transmit';
+/*
+    TO-DO:
+    This function could probably be simplified with an async function.
+    It basically returns a `boolean`, but uses a callback to do so... I can only guess it’s because of [`requestFileSystem`’s signature](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestFileSystem).
+ */
+const privateBrowsingMode = (callback) => {
+    const reportNormalMode = () => callback(false);
+    const reportPrivateMode = () => callback(true);
+    const tryLocalStorage = () => {
+        try {
+            if (localStorage.length) {
+                reportNormalMode();
+            }
+            else {
+                localStorage.x = 1;
+                localStorage.removeItem('x');
+                reportNormalMode();
+            }
+        }
+        catch (error) {
+            reportPrivateMode();
+        }
+    };
+    const tryIndexedDB = () => {
+        try {
+            const db = indexedDB.open('test');
+            db.onsuccess = reportNormalMode;
+            db.onerror = reportPrivateMode;
+        }
+        catch (error) {
+            reportPrivateMode();
+        }
+    };
+    // Blink
+    if (window.webkitRequestFileSystem) {
+        window.webkitRequestFileSystem(window.TEMPORARY, 1, reportNormalMode, reportPrivateMode);
+        // Firefox
+    }
+    else if ('MozAppearance' in document.documentElement.style) {
+        tryIndexedDB();
+        // Safari
+    }
+    else if (/constructor/i.test(window.HTMLElement)) {
+        tryLocalStorage();
+    }
+    else if (!window.indexedDB &&
+        (window.PointerEvent || window.MSPointerEvent)) {
+        reportPrivateMode();
+    }
+    else {
+        // Rest
+        reportNormalMode();
+    }
+};
+export default {
+    init() {
+        privateBrowsingMode((value) => {
+            const report = {
+                inPrivateBrowsingMode: value,
+            };
+            transmit.sendMore(report);
+        });
+    },
+    privateBrowsingMode,
+};

package/{assets → NPM-dist}/r2.js

@@ -1,24 +1,15 @@
 // Generated by CoffeeScript 2.7.0
 import core from './core.js';
-
-import transmit from './transmit.js';
-
+import transmit from './transmit';
 import attention from './attention.js';
-
 import visibility from './visibility.js';
-
 import './click-path-capture.js';
-
 import './perf.js';
-
 import './campaign.js';
-
 core.init('r2');
-
 if (window.addEventListener != null) {
-	attention.init(visibility);
+    attention.init(visibility);
 }
-
 export default {
-	viewId: transmit.viewId,
+    viewId: transmit.viewId,
 };

package/{assets → NPM-dist}/smart-news.js

@@ -1,19 +1,13 @@
 // Generated by CoffeeScript 2.7.0
 import core from './core.js';
-
-import transmit from './transmit.js';
-
+import transmit from './transmit';
 import attention from './attention.js';
-
 import visibility from './visibility.js';
-
 core.init('smart-news');
-
 if (window.addEventListener != null) {
-	attention.init(visibility);
+    attention.init(visibility);
 }
-
 export default {
-	record: transmit.sendMore,
-	viewId: transmit.viewId,
+    record: transmit.sendMore,
+    viewId: transmit.viewId,
 };

package/NPM-dist/support.js

@@ -0,0 +1,28 @@
+import core from './core.js';
+import transmit from './transmit';
+import attention from './attention.js';
+import visibility from './visibility.js';
+import './click-path-capture.js';
+import './perf.js';
+import './campaign.js';
+const init = () => {
+    core.init('support');
+    if (window.addEventListener) {
+        attention.init(visibility);
+    }
+};
+const sendInitialEvent = (url = location.href, referrer = document.referrer) => {
+    try {
+        transmit.bumpViewId();
+        core.sendInitialEvent(null, url, referrer);
+    }
+    catch (error) {
+        console.log(error);
+    }
+};
+export default {
+    init,
+    sendInitialEvent,
+    record: transmit.sendMore,
+    viewId: transmit.viewId,
+};

package/NPM-dist/tests/click-path-capture.test.js

@@ -0,0 +1,44 @@
+import clickPathCapture, { validAncestorAnchorElement, getContainingComponent } from '../click-path-capture.js';
+const { getDataLinkNames } = clickPathCapture;
+describe('click-path-capture.js', () => {
+    beforeAll(() => {
+        document.body.innerHTML = `
+            <div data-component="component1">
+                <a href="#" data-link-name="link1">
+                    <span id="testElement1"></span>
+                </a>
+            </div>
+            <div id="testElement2" data-component="component2"></div>
+        `;
+    });
+    describe('validAncestorAnchorElement', () => {
+        test('should return the ancestor anchor element', () => {
+            const element = document.getElementById('testElement1');
+            expect(validAncestorAnchorElement(element)).toBe(element.closest('a'));
+        });
+        test('should return null when no anchor ancestor is present', () => {
+            const element = document.getElementById('testElement2');
+            expect(validAncestorAnchorElement(element)).toBeNull();
+        });
+    });
+    describe('getContainingComponent', () => {
+        test('should find the parent element with data-component attribute', () => {
+            const element = document.getElementById('testElement1');
+            expect(getContainingComponent(element)).toBe('component1');
+        });
+        test('should return null if no data-component parent is found', () => {
+            const element = document.createElement('div');
+            expect(getContainingComponent(element)).toBeNull();
+        });
+    });
+    describe('getDataLinkNames', () => {
+        test('should collect data-link-name attributes from ancestors', () => {
+            const element = document.getElementById('testElement1');
+            expect(getDataLinkNames(element)).toEqual(['link1']);
+        });
+        test('should return an empty array when no data-link-name attributes are present', () => {
+            const element = document.getElementById('testElement2');
+            expect(getDataLinkNames(element)).toEqual([]);
+        });
+    });
+});

package/NPM-dist/tests/components.test.js

@@ -0,0 +1,47 @@
+import { default as testExports } from '../components.js';
+import { components } from "../components.js";
+const { startMonitoring, stopMonitoring, getAttentionTimes } = testExports;
+describe('components.js', () => {
+    beforeEach(() => {
+        components.length = 0;
+        components.push({
+            name: 'comp1',
+            isVisible: jest.fn().mockReturnValue(true),
+            makeActive: jest.fn(),
+            makeInactive: jest.fn(),
+            hadAttentionSinceLastGet: jest.fn().mockReturnValue(true),
+            getAttentionTime: jest.fn().mockReturnValue(123),
+        });
+        components.push({
+            name: 'comp2',
+            isVisible: jest.fn().mockReturnValue(true),
+            makeActive: jest.fn(),
+            makeInactive: jest.fn(),
+            hadAttentionSinceLastGet: jest.fn().mockReturnValue(true),
+            getAttentionTime: jest.fn().mockReturnValue(123),
+        });
+    });
+    test('startMonitoring activates visible components', () => {
+        components[0].isVisible.mockReturnValue(true);
+        components[1].isVisible.mockReturnValue(false);
+        const results = startMonitoring();
+        expect(components[0].makeActive).toHaveBeenCalled();
+        expect(components[1].makeActive).not.toHaveBeenCalled();
+        expect(results).toHaveLength(1);
+    });
+    test('stopMonitoring deactivates all components', () => {
+        const results = stopMonitoring();
+        components.forEach((component) => {
+            expect(component.makeInactive).toHaveBeenCalled();
+        });
+        expect(results).toHaveLength(components.length);
+    });
+    test('getAttentionTimes returns attention times for components with attention', () => {
+        components[0].hadAttentionSinceLastGet.mockReturnValue(true);
+        components[0].getAttentionTime.mockReturnValue(123);
+        components[1].hadAttentionSinceLastGet.mockReturnValue(false);
+        const attentionTimes = getAttentionTimes();
+        expect(attentionTimes).toEqual({ comp1: 123 });
+        expect(components[1].getAttentionTime).not.toHaveBeenCalled();
+    });
+});