@guardian/ophan-tracker-js 2.6.1 → 2.6.3

package/NPM-dist/core.js

@@ -87,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) {
@@ -198,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/manage-my-account.js

@@ -33,7 +33,6 @@ 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';

package/NPM-dist/ng.js

@@ -8,7 +8,6 @@ import './click-path-capture.js';
 import './perf.js';
 import './iframe-tracking.js';
 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';

package/NPM-dist/support.js

@@ -32,7 +32,6 @@ 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';

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/manage-my-account.d.ts

@@ -15,7 +15,6 @@ 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';

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

@@ -2,7 +2,6 @@ import './click-path-capture.js';
 import './perf.js';
 import './iframe-tracking.js';
 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';

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

@@ -15,7 +15,6 @@ 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';

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

@@ -19,10 +19,19 @@ export interface AbTest {
      */
     campaignCodes?: Array<string>;
 }
-export interface AbTestInfo {
+export interface AbTestRegisterEntry {
     /**
-     * On the left-hand side of the map, .
-     * On the right-hand side of the map, the variant that they are seeing.
+     * Variant assigned to the user for this test
      */
-    tests: Array<AbTest>;
+    variantName: string;
+    /**
+     * Whether this test has completed for the user
+     */
+    complete: boolean;
+    /**
+     * Campaign codes associated with this variant
+     */
+    campaignCodes?: Array<string>;
 }
+export type AbTestRegisterValue = AbTestRegisterEntry | string;
+export type AbTestRegister = Record<string, AbTestRegisterValue>;

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

@@ -1,5 +1,4 @@
-import type { AbTestInfo } from './abtest.js';
-import type { Acquisition } from './acquisition.js';
+import type { AbTestRegister } from './abtest.js';
 import type { ComponentEvent } from './component-event.js';
 import type { Consent } from './consent.js';
 import type { InPageClick } from './inpageclick.js';
@@ -91,12 +90,11 @@ export interface EventPayload extends Partial<Consent>, Partial<InPageClick> {
     performance?: WebPerformanceData;
     audio?: AudioEvent;
     video?: VideoEvent;
-    ab?: AbTestInfo;
+    abTestRegister?: AbTestRegister;
     lazyComponents?: LazyComponents;
     interaction?: Interaction;
     inPrivateBrowsingMode?: boolean;
     adUnitWasHidden?: boolean;
-    acquisition?: Acquisition;
     componentEvent?: ComponentEvent;
     /** Experience contains information about the rendering of the page, e.g.: dotcom-rendering */
     experiences?: Array<string>;

package/package.json

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

package/NPM-dist/types/acquisition.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,116 +0,0 @@
-import type { AbTestInfo } from './abtest.js';
-import type { PrintOptions } from './printproduct.js';
-import type { TComponentType } from './component-type.js';
-import type { TPlatform } from './platform.js';
-import type { Product } from './product.js';
-/**
- * A query string parameter
- */
-export type QueryParameter = {
-    /**
-     * The name of the query string parameter
-     */
-    name: string;
-    /**
-     * The value of the query string parameter
-     */
-    value: string;
-};
-export type TPaymentFrequency = 'ONE_OFF' | 'MONTHLY' | 'ANNUALLY' | 'QUARTERLY' | 'SIX_MONTHLY';
-export type TPaymentProvider = 'STRIPE' | 'PAYPAL' | 'GOCARDLESS' | 'IN_APP_PURCHASE' | 'STRIPE_APPLE_PAY' | 'STRIPE_PAYMENT_REQUEST_BUTTON' | 'SUBSCRIBE_WITH_GOOGLE' | 'AMAZON_PAY' | 'STRIPE_SEPA';
-export type TAcquisitionSource = 'GUARDIAN_WEB'
-/**
- * @deprecated DO NOT USE
- */
- | 'GUARDIAN_APPS' | 'EMAIL' | 'SOCIAL' | 'SEARCH' | 'PPC' | 'DIRECT' | 'GUARDIAN_APP_IOS' | 'GUARDIAN_APP_ANDROID' | 'APPLE_NEWS' | 'GOOGLE_AMP' | 'YOUTUBE';
-/**
- * Represents monetary contribution made by a reader via this page.
- */
-export interface Acquisition {
-    /**
-     * Product type
-     */
-    product: Product;
-    /**
-     * If the payment is a one off or reccuring
-     */
-    paymentFrequency: TPaymentFrequency;
-    /**
-     * Currency code (ISO 4217 3-character, upper-case, eg USD, GBP)
-     */
-    currency: string;
-    /**
-     * Contributed amount in units of the currency received
-     */
-    amount: number;
-    /**
-     * The payment provider the user paid with
-     */
-    paymentProvider?: TPaymentProvider;
-    /**
-     * The campaign code of the campaign that the user came from
-     */
-    campaignCode?: Array<string>;
-    /**
-     * The ab tests the user was in on dotcom
-     */
-    abTests?: AbTestInfo;
-    /**
-     * ISO-3166-aplha-2 country code representing where the user is from. It is either the country of the card used, or the country of the contributor's address
-     */
-    countryCode?: string;
-    /**
-     * Page view id of the page the reader was on that lead them through to the contribution page e.g. by clicking on the Contribute Now button in the Epic component
-     */
-    referrerPageViewId?: string;
-    /**
-     * Url of the page the reader was on that lead them through to the contribution page e.g. by clicking on the Contribute Now button in the Epic component
-     */
-    referrerUrl?: string;
-    /**
-     * An ID that can be used to distinguish different instances of a given component type
-     */
-    componentId?: string;
-    /**
-     * The type of component that the acquisition came from
-     */
-    componentTypeV2?: TComponentType;
-    /**
-     * The source of the acquisition
-     */
-    source?: TAcquisitionSource;
-    /**
-     * Extra parameters only applicable to print products
-     */
-    printOptions?: PrintOptions;
-    /**
-     * Platform on which the acquisition occurred e.g. Contributions, S&C
-     */
-    platform?: TPlatform;
-    /**
-     * Length of the discount in months
-     */
-    discountLengthInMonths?: number;
-    /**
-     * Amount of discount, as a percentage
-     */
-    discountPercentage?: number;
-    /**
-     * Promo code for the acquisition. Only applicable to subscriptions.
-     */
-    promoCode?: string;
-    /**
-     * Any additional labels.
-     * In particular, extra information that is needed to calculate Annualised Value
-     * for this Acquisition (e.g. promotions like Guardian Weekly Six For Six) can go here.
-     */
-    labels?: Array<string>;
-    /**
-     * The identity id of a user
-     */
-    identityId?: string;
-    /**
-     * Query string parameters associated with an acquisition
-     */
-    queryParameters?: Array<QueryParameter>;
-}