@guardian/ophan-tracker-js 2.3.2 → 2.4.1

package/NPM-dist/core.js

@@ -9,6 +9,11 @@ let platform = null;
 const MaximumComponentNameLength = 50;
 init = function (servingPlatform, httpStatus) {
     platform = servingPlatform;
+    window.addEventListener('pageshow', function (event) {
+        if (event.persisted) {
+            sendInitialEvent(httpStatus, location.href, window.document.referrer, 'bfcache');
+        }
+    }, false);
     if (visibility.state() !== 'prerender') {
         return sendInitialEvent(httpStatus);
     }
@@ -65,7 +70,7 @@ const getNavigationType = () => {
     }
     return null;
 };
-sendInitialEvent = function (httpStatus, url = location.href, referrer = window.document.referrer) {
+sendInitialEvent = function (httpStatus, url = location.href, referrer = window.document.referrer, loadType = 'normal') {
     const navigationType = getNavigationType();
     // send initial event
     const event = {
@@ -84,6 +89,9 @@ sendInitialEvent = function (httpStatus, url = location.href, referrer = window.
         // Add navigation type as metadata to the event if it's not null
         event.navigationType = navigationType;
     }
+    if (loadType !== 'normal') {
+        event.loadType = loadType;
+    }
     appendContentType(event);
     appendDataFromLocalStorageToEvent(event);
     transmit.sendInitial(event);

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

@@ -1,7 +1,11 @@
 import { _testExports } from '../core.js';
 import transmit from '../transmit';
 const mockSendMore = jest.fn();
+const mockSendInitial = jest.fn();
+const mockBumpViewId = jest.fn();
 transmit.sendMore = mockSendMore;
+transmit.sendInitial = mockSendInitial;
+transmit.bumpViewId = mockBumpViewId;
 const { getQueryParameterValue, appendComponentDataToEvent, trimComponentNamesToUrlSafeLength, onLoadCapture, onLoadCaptures, processCaptures, appendContentType, } = _testExports;
 describe('appendComponentDataToEvent', () => {
     beforeEach(() => {
@@ -159,3 +163,49 @@ 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 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/types/component-event.d.ts

@@ -63,7 +63,11 @@ export type TAction =
 /**
  * The component is returned to its original location
  **/
- | 'RETURN';
+ | 'RETURN'
+/**
+ * The component has detected something
+ */
+ | 'DETECT';
 interface ComponentV2 {
     componentType: TComponentType;
     id?: string;

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';
+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';

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

@@ -31,6 +31,8 @@ interface PageView {
     subscriptionType?: TSubscriptionType;
     membershipTier?: TMembershipTier;
     navigationType?: PerformanceNavigationTiming['type'];
+    /** The type of page load - normal or from cache */
+    loadType?: 'normal' | 'bfcache';
     from?: string;
     to?: string;
     tz?: string;

package/package.json

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