@guardian/ophan-tracker-js 2.4.4 → 2.6.0

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

@@ -6,11 +6,13 @@ 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) => {
+export const init = () => {
+    core.init('manage-my-account');
+    if (window.addEventListener) {
+        attention.init(visibility);
+    }
+};
+export const sendInitialEvent = (url = location.href, referrer = document.referrer) => {
     try {
         transmit.bumpViewId();
         core.sendInitialEvent(null, url, referrer);
@@ -20,10 +22,26 @@ const sendInitialEvent = (url = location.href, referrer = document.referrer) =>
     }
 };
 const exports = {
+    init,
     sendInitialEvent,
     record: transmit.sendMore,
     get viewId() { return transmit.viewId; },
 };
-window.guardian = window.guardian || {};
-window.guardian.ophan = exports;
 export default exports;
+// Named exports for convenience
+export const record = exports.record;
+export const viewId = exports.viewId;
+// Type exports
+export * from './types/abtest.js';
+export * from './types/acquisition.js';
+export * from './types/subscription.js';
+export * from './types/interaction.js';
+export * from './types/inpageclick.js';
+export * from './types/printproduct.js';
+export * from './types/product.js';
+export * from './types/platform.js';
+export * from './types/media.js';
+export * from './types/consent.js';
+export * from './types/component-type.js';
+export * from './types/component-event.js';
+export * from './types/event.js';

package/NPM-dist/support.js

@@ -5,13 +5,13 @@ import visibility from './visibility.js';
 import './click-path-capture.js';
 import './perf.js';
 import './campaign.js';
-const init = () => {
+export const init = () => {
     core.init('support');
     if (window.addEventListener) {
         attention.init(visibility);
     }
 };
-const sendInitialEvent = (url = location.href, referrer = document.referrer) => {
+export const sendInitialEvent = (url = location.href, referrer = document.referrer) => {
     try {
         transmit.bumpViewId();
         core.sendInitialEvent(null, url, referrer);
@@ -20,9 +20,27 @@ const sendInitialEvent = (url = location.href, referrer = document.referrer) =>
         console.log(error);
     }
 };
-export default {
+const supportExports = {
     init,
     sendInitialEvent,
     record: transmit.sendMore,
     get viewId() { return transmit.viewId; },
 };
+export default supportExports;
+// Named exports for convenience
+export const record = supportExports.record;
+export const viewId = supportExports.viewId;
+// Type exports
+export * from './types/abtest.js';
+export * from './types/acquisition.js';
+export * from './types/subscription.js';
+export * from './types/interaction.js';
+export * from './types/inpageclick.js';
+export * from './types/printproduct.js';
+export * from './types/product.js';
+export * from './types/platform.js';
+export * from './types/media.js';
+export * from './types/consent.js';
+export * from './types/component-type.js';
+export * from './types/component-event.js';
+export * from './types/event.js';

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

@@ -1,5 +1,5 @@
 declare namespace _default {
-    let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
+    let record: (obj: import("./manage-my-account.js").EventPayload, f?: (() => void) | undefined) => void;
     const viewId: string;
 }
 export default _default;

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

@@ -1,5 +1,5 @@
 declare namespace _default {
-    let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
+    let record: (obj: import("./manage-my-account.js").EventPayload, f?: (() => void) | undefined) => void;
     const viewId: string;
 }
 export default _default;

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

@@ -1,5 +1,5 @@
 declare namespace _default {
-    let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
+    let record: (obj: import("./manage-my-account.js").EventPayload, f?: (() => void) | undefined) => void;
     const viewId: string;
 }
 export default _default;

package/NPM-dist/types/jobs-courses.d.ts

@@ -1,5 +1,5 @@
 declare namespace _default {
-    let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
+    let record: (obj: import("./manage-my-account.js").EventPayload, f?: (() => void) | undefined) => void;
     const viewId: string;
 }
 export default _default;

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

@@ -1,5 +1,5 @@
 declare namespace _default {
-    let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
+    let record: (obj: import("./manage-my-account.js").EventPayload, f?: (() => void) | undefined) => void;
     const viewId: string;
 }
 export default _default;

package/NPM-dist/types/manage-my-account.d.ts

@@ -1,7 +1,29 @@
-export default exports;
-declare namespace exports {
-    export { sendInitialEvent };
-    export let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
-    export const viewId: string;
+import './click-path-capture.js';
+import './perf.js';
+import './campaign.js';
+import { EventPayload } from './types/event.js';
+export declare const init: () => void;
+export declare const sendInitialEvent: (url?: string, referrer?: string) => void;
+interface MMAExports {
+    init: () => void;
+    sendInitialEvent: (url?: string, referrer?: string) => void;
+    record: (event: EventPayload, callback?: () => void) => void;
+    viewId: string;
 }
-declare function sendInitialEvent(url?: string, referrer?: string): void;
+declare const exports: MMAExports;
+export default exports;
+export declare const record: (event: EventPayload, callback?: () => void) => void;
+export declare const viewId: string;
+export * from './types/abtest.js';
+export * from './types/acquisition.js';
+export * from './types/subscription.js';
+export * from './types/interaction.js';
+export * from './types/inpageclick.js';
+export * from './types/printproduct.js';
+export * from './types/product.js';
+export * from './types/platform.js';
+export * from './types/media.js';
+export * from './types/consent.js';
+export * from './types/component-type.js';
+export * from './types/component-event.js';
+export * from './types/event.js';

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

@@ -1,5 +1,5 @@
 declare namespace _default {
-    let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
+    let record: (obj: import("./manage-my-account.js").EventPayload, f?: (() => void) | undefined) => void;
     const viewId: string;
 }
 export default _default;

package/NPM-dist/types/smart-news.d.ts

@@ -1,5 +1,5 @@
 declare namespace _default {
-    let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
+    let record: (obj: import("./manage-my-account.js").EventPayload, f?: (() => void) | undefined) => void;
     const viewId: string;
 }
 export default _default;

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

@@ -1,9 +1,29 @@
-declare namespace _default {
-    export { init };
-    export { sendInitialEvent };
-    export let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
-    export const viewId: string;
+import './click-path-capture.js';
+import './perf.js';
+import './campaign.js';
+import { EventPayload } from './types/event.js';
+export declare const init: () => void;
+export declare const sendInitialEvent: (url?: string, referrer?: string) => void;
+interface SupportExports {
+    init: () => void;
+    sendInitialEvent: (url?: string, referrer?: string) => void;
+    record: (event: EventPayload, callback?: () => void) => void;
+    viewId: string;
 }
-export default _default;
-declare function init(): void;
-declare function sendInitialEvent(url?: string, referrer?: string): void;
+declare const supportExports: SupportExports;
+export default supportExports;
+export declare const record: (event: EventPayload, callback?: () => void) => void;
+export declare const viewId: string;
+export * from './types/abtest.js';
+export * from './types/acquisition.js';
+export * from './types/subscription.js';
+export * from './types/interaction.js';
+export * from './types/inpageclick.js';
+export * from './types/printproduct.js';
+export * from './types/product.js';
+export * from './types/platform.js';
+export * from './types/media.js';
+export * from './types/consent.js';
+export * from './types/component-type.js';
+export * from './types/component-event.js';
+export * from './types/event.js';

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

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

@@ -1,5 +1,5 @@
 declare namespace _default {
-    let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
+    let record: (obj: import("./manage-my-account.js").EventPayload, f?: (() => void) | undefined) => void;
     const viewId: string;
 }
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@guardian/ophan-tracker-js",
-	"version": "2.4.4",
+	"version": "2.6.0",
 	"type": "module",
 	"engines": {
 		"node": ">=16"
@@ -19,12 +19,19 @@
 		"./MMA": {
 			"types": "./NPM-dist/types/manage-my-account.d.ts",
 			"default": "./NPM-dist/manage-my-account.js"
+		},
+		"./support": {
+			"types": "./NPM-dist/types/support.d.ts",
+			"default": "./NPM-dist/support.js"
 		}
 	},
 	"typesVersions": {
 		"*": {
 			"MMA": [
 				"NPM-dist/types/manage-my-account.d.ts"
+			],
+			"support": [
+				"NPM-dist/types/support.d.ts"
 			]
 		}
 	},
@@ -50,7 +57,8 @@
 		"build-for-npm": "tsc",
 		"pretest": "tsc",
 		"test": "jest",
-		"format": "npx prettier --write ."
+		"format": "npx prettier --write .",
+		"changeset:publish:canary": "changeset publish --tag canary"
 	},
 	"dependencies": {
 		"@guardian/tsconfig": "^1.0.0"

package/readme.md

@@ -129,11 +129,11 @@ The TypeScript compiler is configured to generate compiled JavaScript files and
 
 ## Publish
 
-#### Two formats for release
+### Two formats for release
 
 When you make a change to Tracker JS, you must release on *both* these systems:
 
-##### NPM
+#### NPM
 
 We use `changesets` for automated publishing of the NPM package:
 
@@ -147,10 +147,17 @@ We use `changesets` for automated publishing of the NPM package:
 
 3. When the PR is merged, the [`changesets` github action](https://github.com/changesets/action) will create a new PR, [example here](https://github.com/guardian/ophan/pull/5626). On merging this generated PR, the action will publish to NPM. (This checks the subdirectory correctly.)
 
-##### S3 Bucket
+#### S3 Bucket
 
 * [https://j.ophan.co.uk/](https://j.ophan.co.uk/jobs.js) - CDN/S3, [deployed through RiffRaff](https://riffraff.gutools.co.uk/deployment/history?projectName=ophan%3A%3Aophan-tracker-js&page=1) and used by some Guardian sites like https://jobs.theguardian.com/. An advantage of this approach is that sites using it immediately get Tracker JS updates, without developer intervention.
 
-##### Rollup
+#### Rollup
 
-The generated files from Rollup (using the `build-for-cdn` script in `package.json`) are only used for publishing to the CDN to use SystemJS / AMD
+The generated files from Rollup (using the `build-for-cdn` script in `package.json`) are only used for publishing to the CDN to use SystemJS / AMD
+
+## Post publish
+Post publish it would be good practice to inform the teams using Tracker-JS about the update.
+
+See the [google doc ](https://docs.google.com/document/d/1MndFG-DLDQAMHIi55T4kZkGq4ONcded1-MDd9QS_NZE/edit?tab=t.0) for a list of teams depending on tracker-js.
+
+If the change to tracker-js is small, we could raise a quick PR in the relevant repo and ask the team to review it.