@guardian/ophan-tracker-js 2.6.0 → 2.6.2

package/NPM-dist/core.js

@@ -9,12 +9,6 @@ let platform = null;
 const MaximumComponentNameLength = 50;
 init = function (servingPlatform, httpStatus) {
     platform = servingPlatform;
-    window.addEventListener('pageshow', function (event) {
-        if (event.persisted) {
-            transmit.bumpViewId();
-            sendInitialEvent(httpStatus, location.href, window.document.referrer, 'bfcache');
-        }
-    }, false);
     if (visibility.state() !== 'prerender') {
         return sendInitialEvent(httpStatus);
     }
@@ -93,7 +87,7 @@ sendInitialEvent = function (httpStatus, url = location.href, referrer = window.
     if (loadType !== 'normal') {
         event.loadType = loadType;
     }
-    appendContentType(event);
+    appendContentType(event, platform, window.guardian);
     appendDataFromLocalStorageToEvent(event);
     transmit.sendInitial(event);
     return adblockDetection.run().then(function (adBlockerEnabled) {
@@ -204,13 +198,13 @@ storeDataToSendOnNextEvent = function (newData) {
 /**
  * Determines the 'content type' based on the platform and guardian object.
  * @param {Record<string, unknown>} event - The event object that will be updated with contentType.
- * @param {string} platform - The current platform ('next-gen', 'embed' or other).
- * @param {Record<string, unknown>} guardian - The guardian object.
+ * @param {string} localPlatform - The current platform ('next-gen', 'embed' or other).
+ * @param {Record<string, unknown>} localGuardian - The guardian object.
  */
-const appendContentType = (event, platform, guardian) => {
-    const contentType = platform === 'next-gen' || platform === 'embed'
-        ? guardian?.config?.page?.contentType
-        : guardian?.page?.contentTypes;
+const appendContentType = (event, localPlatform, localGuardian) => {
+    const contentType = localPlatform === 'next-gen' || localPlatform === 'embed'
+        ? localGuardian?.config?.page?.contentType
+        : localGuardian?.page?.contentTypes;
     if (contentType) {
         event.contentType = contentType.toLowerCase();
     }

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

@@ -163,57 +163,3 @@ describe('appendContentType', () => {
         expect(event.contentType).toBeUndefined();
     });
 });
-describe('loadType pageshow handling', () => {
-    let mockAddEventListener;
-    let pageShowHandler;
-    let originalSendInitial;
-    beforeEach(() => {
-        jest.clearAllMocks();
-        mockAddEventListener = jest.fn();
-        window.addEventListener = mockAddEventListener;
-        originalSendInitial = transmit.sendInitial;
-        transmit.sendInitial = jest.fn();
-        const core = require('../core.js').default;
-        core.init('next-gen', 200);
-        const pageShowCall = mockAddEventListener.mock.calls.find(call => call[0] === 'pageshow');
-        pageShowHandler = pageShowCall ? pageShowCall[1] : null;
-    });
-    afterEach(() => {
-        transmit.sendInitial = originalSendInitial;
-    });
-    it('should register pageshow event listener during init', () => {
-        expect(mockAddEventListener).toHaveBeenCalledWith('pageshow', expect.any(Function), false);
-    });
-    it('should call sendInitialEvent with loadType=bfcache when pageshow event has persisted=true', () => {
-        expect(pageShowHandler).toBeTruthy();
-        transmit.sendInitial.mockClear();
-        // Simulate a bfcache restore event
-        const mockEvent = { persisted: true };
-        pageShowHandler(mockEvent);
-        expect(transmit.sendInitial).toHaveBeenCalledWith(expect.objectContaining({
-            loadType: 'bfcache'
-        }));
-    });
-    it('should call bumpViewId when pageshow event has persisted=true', () => {
-        expect(pageShowHandler).toBeTruthy();
-        transmit.bumpViewId.mockClear();
-        // Simulate a bfcache restore event
-        const mockEvent = { persisted: true };
-        pageShowHandler(mockEvent);
-        expect(transmit.bumpViewId).toHaveBeenCalledTimes(1);
-    });
-    it('should not call sendInitialEvent when pageshow event has persisted=false', () => {
-        expect(pageShowHandler).toBeTruthy();
-        transmit.sendInitial.mockClear();
-        const mockEvent = { persisted: false };
-        pageShowHandler(mockEvent);
-        expect(transmit.sendInitial).not.toHaveBeenCalled();
-    });
-    it('should handle pageshow event without persisted property', () => {
-        expect(pageShowHandler).toBeTruthy();
-        transmit.sendInitial.mockClear();
-        const mockEvent = {};
-        pageShowHandler(mockEvent);
-        expect(transmit.sendInitial).not.toHaveBeenCalled();
-    });
-});

package/NPM-dist/types/core.d.ts

@@ -58,7 +58,7 @@ declare function processCaptures(): void;
 /**
  * Determines the 'content type' based on the platform and guardian object.
  * @param {Record<string, unknown>} event - The event object that will be updated with contentType.
- * @param {string} platform - The current platform ('next-gen', 'embed' or other).
- * @param {Record<string, unknown>} guardian - The guardian object.
+ * @param {string} localPlatform - The current platform ('next-gen', 'embed' or other).
+ * @param {Record<string, unknown>} localGuardian - The guardian object.
  */
-declare function appendContentType(event: Record<string, unknown>, platform: string, guardian: Record<string, unknown>): void;
+declare function appendContentType(event: Record<string, unknown>, localPlatform: string, localGuardian: Record<string, unknown>): void;

package/NPM-dist/types/types/component-type.d.ts

@@ -1 +1 @@
-export type TComponentType = 'READERS_QUESTIONS_ATOM' | 'QANDA_ATOM' | 'PROFILE_ATOM' | 'GUIDE_ATOM' | 'TIMELINE_ATOM' | 'NEWSLETTER_SUBSCRIPTION' | 'SURVEYS_QUESTIONS' | 'ACQUISITIONS_EPIC' | 'ACQUISITIONS_ENGAGEMENT_BANNER' | 'ACQUISITIONS_THANK_YOU_EPIC' | 'ACQUISITIONS_HEADER' | 'ACQUISITIONS_FOOTER' | 'ACQUISITIONS_INTERACTIVE_SLICE' | 'ACQUISITIONS_NUGGET' | 'ACQUISITIONS_STANDFIRST' | 'ACQUISITIONS_THRASHER' | 'ACQUISITIONS_EDITORIAL_LINK' | 'ACQUISITIONS_MANAGE_MY_ACCOUNT' | 'ACQUISITIONS_BUTTON' | 'ACQUISITIONS_OTHER' | 'APP_ADVERT' | 'APP_AUDIO' | 'APP_BUTTON' | 'APP_CARD' | 'APP_CROSSWORDS' | 'APP_ENGAGEMENT_BANNER' | 'APP_EPIC' | 'APP_GALLERY' | 'APP_LINK' | 'APP_NAVIGATION_ITEM' | 'APP_SCREEN' | 'APP_THRASHER' | 'APP_VIDEO' | 'AUDIO_ATOM' | 'CHART_ATOM' | 'ACQUISITIONS_MERCHANDISING' | 'ACQUISITIONS_HOUSE_ADS' | 'SIGN_IN_GATE' | 'ACQUISITIONS_SUBSCRIPTIONS_BANNER' | 'MOBILE_STICKY_AD' | 'IDENTITY_AUTHENTICATION' | 'RETENTION_ENGAGEMENT_BANNER' | 'ACQUISITION_SUPPORT_SITE' | 'RETENTION_EPIC' | 'CONSENT' | 'LIVE_BLOG_PINNED_POST' | 'STICKY_VIDEO' | 'KEY_EVENT_CARD' | 'RETENTION_HEADER' | 'SLIDESHOW' | 'APP_FEATURE' | 'CARD' | 'CAROUSEL' | 'CONTAINER' | 'MENU' | 'ACQUISITIONS_GUTTER' | 'INTERACTIVE_ATOM' | 'LOOP_VIDEO' | 'AD_BLOCK_RECOVERY' | 'SIGN_IN_GOOGLE_ONE_TAP';
+export type TComponentType = 'READERS_QUESTIONS_ATOM' | 'QANDA_ATOM' | 'PROFILE_ATOM' | 'GUIDE_ATOM' | 'TIMELINE_ATOM' | 'NEWSLETTER_SUBSCRIPTION' | 'SURVEYS_QUESTIONS' | 'ACQUISITIONS_EPIC' | 'ACQUISITIONS_ENGAGEMENT_BANNER' | 'ACQUISITIONS_THANK_YOU_EPIC' | 'ACQUISITIONS_HEADER' | 'ACQUISITIONS_FOOTER' | 'ACQUISITIONS_INTERACTIVE_SLICE' | 'ACQUISITIONS_NUGGET' | 'ACQUISITIONS_STANDFIRST' | 'ACQUISITIONS_THRASHER' | 'ACQUISITIONS_EDITORIAL_LINK' | 'ACQUISITIONS_MANAGE_MY_ACCOUNT' | 'ACQUISITIONS_BUTTON' | 'ACQUISITIONS_OTHER' | 'APP_ADVERT' | 'APP_AUDIO' | 'APP_BUTTON' | 'APP_CARD' | 'APP_CROSSWORDS' | 'APP_ENGAGEMENT_BANNER' | 'APP_EPIC' | 'APP_GALLERY' | 'APP_LINK' | 'APP_NAVIGATION_ITEM' | 'APP_SCREEN' | 'APP_THRASHER' | 'APP_VIDEO' | 'AUDIO_ATOM' | 'CHART_ATOM' | 'ACQUISITIONS_MERCHANDISING' | 'ACQUISITIONS_HOUSE_ADS' | 'SIGN_IN_GATE' | 'ACQUISITIONS_SUBSCRIPTIONS_BANNER' | 'MOBILE_STICKY_AD' | 'IDENTITY_AUTHENTICATION' | 'RETENTION_ENGAGEMENT_BANNER' | 'ACQUISITION_SUPPORT_SITE' | 'RETENTION_EPIC' | 'CONSENT' | 'LIVE_BLOG_PINNED_POST' | 'STICKY_VIDEO' | 'KEY_EVENT_CARD' | 'RETENTION_HEADER' | 'SLIDESHOW' | 'APP_FEATURE' | 'CARD' | 'CAROUSEL' | 'CONTAINER' | 'MENU' | 'ACQUISITIONS_GUTTER' | 'INTERACTIVE_ATOM' | 'LOOP_VIDEO' | 'AD_BLOCK_RECOVERY' | 'SIGN_IN_GOOGLE_ONE_TAP' | 'BF_CACHE';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@guardian/ophan-tracker-js",
-	"version": "2.6.0",
+	"version": "2.6.2",
 	"type": "module",
 	"engines": {
 		"node": ">=16"