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

package/NPM-dist/types/inpageclick.js

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

package/NPM-dist/types/interaction.js

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

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

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

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

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

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

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

package/NPM-dist/types/link.js

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

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

@@ -0,0 +1,7 @@
+export default exports;
+declare namespace exports {
+    export { sendInitialEvent };
+    export let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
+    export let viewId: string;
+}
+declare function sendInitialEvent(url?: string, referrer?: string): void;

package/NPM-dist/types/media.js

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

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

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

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

@@ -0,0 +1,26 @@
+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';
+import { EventPayload } from "./types/event";
+interface NG {
+    record: (event: EventPayload, callback?: Function) => void;
+    pageViewId: string;
+    viewId: string;
+    trackComponentAttention: (name: string, el: HTMLElement, visibilityThreshold: number) => void;
+    setEventEmitter: (event: Object) => void;
+}
+declare let ng: NG;
+export default ng;

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

@@ -0,0 +1,2 @@
+export default perf;
+declare const perf: Performance;

package/NPM-dist/types/platform.js

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

package/NPM-dist/types/printproduct.js

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

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

@@ -0,0 +1,6 @@
+declare namespace _default {
+    export function init(): void;
+    export { privateBrowsingMode };
+}
+export default _default;
+declare function privateBrowsingMode(callback: any): void;

package/NPM-dist/types/product.js

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

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

@@ -0,0 +1,4 @@
+declare namespace _default {
+    let viewId: string;
+}
+export default _default;

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

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

package/NPM-dist/types/subscription.js

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

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

@@ -0,0 +1,9 @@
+declare namespace _default {
+    export { init };
+    export { sendInitialEvent };
+    export let record: (obj: import("./ng.js").EventPayload, f?: (() => void) | undefined) => void;
+    export let viewId: string;
+}
+export default _default;
+declare function init(): void;
+declare function sendInitialEvent(url?: string, referrer?: string): void;

package/NPM-dist/types/tests/click-path-capture.test.d.ts

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

package/NPM-dist/types/tests/components.test.d.ts

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

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

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

package/NPM-dist/types/tests/heatmap.test.d.ts

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

package/NPM-dist/types/tests/transmit.test.d.ts

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

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

@@ -0,0 +1,17 @@
+import { EventPayload } from "./types/event";
+declare const _default: {
+    sendInitial: (obj: Record<string, any>) => void;
+    sendMore: (obj: EventPayload, f?: (() => void) | undefined) => void;
+    viewId: string;
+    bumpViewId: () => void;
+};
+export default _default;
+/**
+ * Exports for testing purposes.
+ */
+export declare const _testExports: {
+    generatePageViewId: () => string;
+    smartEncode: (value: string | number) => string;
+    isDefined: (v: any) => boolean;
+    buildQueryString: (obj: Record<string, any>) => string;
+};

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

@@ -0,0 +1,28 @@
+/**
+ * Represents the AbTest on the web and apps
+ */
+export interface AbTest {
+    /**
+     * the test that the user is participating in
+     */
+    name: string;
+    /**
+     * the variant that they are seeing
+     */
+    variant: string;
+    /**
+     * whether the test has been completed or not
+     */
+    complete?: boolean;
+    /**
+     * the campaign codes associated with the variant
+     */
+    campaignCodes?: Array<string>;
+}
+export interface AbTestInfo {
+    /**
+     * On the left-hand side of the map, .
+     * On the right-hand side of the map, the variant that they are seeing.
+     */
+    tests: Array<AbTest>;
+}

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

@@ -0,0 +1,116 @@
+import type { AbTestInfo } from "./abtest";
+import type { PrintOptions } from "./printproduct";
+import type { TComponentType } from "./component-type";
+import type { TPlatform } from "./platform";
+import type { Product } from "./product";
+/**
+ * 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>;
+}

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

@@ -0,0 +1,86 @@
+import type { AbTest } from "./abtest";
+import type { Product } from "./product";
+import { TComponentType } from "./component-type";
+export type TAction = 
+/**
+ * The component was inserted into its container (e.g. a web page or view in an app)
+ **/
+"INSERT"
+/**
+ * The component was in view on screen
+ **/
+ | "VIEW"
+/**
+ * The component was expanded (e.g. "see more").
+ * Not a navigation away to another page
+ **/
+ | "EXPAND"
+/**
+ * A "like", thumbs up, etc.
+ **/
+ | "LIKE"
+/**
+ * A "dislike", thumbs down, etc.
+ **/
+ | "DISLIKE"
+/**
+ * A subscription to a service, newsletter, etc.
+ **/
+ | "SUBSCRIBE"
+/**
+ * Selection of an answer in a quiz
+ **/
+ | "ANSWER"
+/**
+ * A vote in a poll
+ **/
+ | "VOTE"
+/**
+ * A single click on the component which is not covered by
+ * any of the existing Actions.
+ **/
+ | "CLICK"
+/**
+ * User sign in to Guardian Identity account
+ **/
+ | "SIGN_IN"
+/**
+ * User creates a Guardian Identity account
+ **/
+ | "CREATE_ACCOUNT"
+/**
+ * User Consent
+ **/
+ | "ACCEPT_DEFAULT_CONSENT" | "MANAGE_CONSENT" | "CONSENT_ACCEPT_ALL" | "CONSENT_REJECT_ALL"
+/**
+ * The component sticks in the screen
+ **/
+ | "STICK"
+/**
+ * The component is closed
+ **/
+ | "CLOSE"
+/**
+ * The component is returned to its original location
+ **/
+ | "RETURN";
+export interface Component {
+    name: string;
+    loadTimeMs?: number;
+}
+interface ComponentV2 {
+    componentType: TComponentType;
+    id?: string;
+    products?: Array<Product>;
+    campaignCode?: string;
+    labels?: Array<string>;
+}
+export interface ComponentEvent {
+    component: ComponentV2;
+    action: TAction;
+    value?: string;
+    id?: string;
+    abTest?: AbTest;
+    targetingAbTest?: AbTest;
+}
+export {};

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

@@ -0,0 +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";

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

@@ -0,0 +1,40 @@
+/** A user’s recorded tracking consent. Because the consent data can come in
+ * different formats from different sources, the jurisdiction field determines
+ * the format of consentData.
+ **/
+export interface Consent {
+    /**
+     * The jurisdiction is a tag for the consent data: TCF, CCPA, or AUS if the
+     * consent has been successfully parsed in one of those formats; or
+     * OTHER otherwise.
+     **/
+    consentJurisdiction: TJurisdiction;
+    /**
+     * If the jurisdiction is TCF, CCPA, or AUS, consentData contains a
+     * successfully interpreted consent value the corresponding type (for TCF
+     * this is a base-64-encoded consent string, and for CCPA and AUS it’s
+     * either the string "true" or "false" – where "true" means the user has
+     * given their consent). If the jurisdiction is OTHER, then consentData
+     * contains the unparsed consent data, in the format
+     * key1:value1,key2:value2,….
+     **/
+    consent: string;
+    /**
+     * consentUUID is an identifier for the consent, for debugging.
+     **/
+    consentUUID?: string;
+    /**
+     * cmp version for debugging
+     **/
+    cmpVersion?: string;
+}
+/**
+ * For a recognised/successfully parsed consent, a value of TCF, USNAT, CCPA, or AUS
+ * indicates which jurisdiction the consent is for. OTHER marks a consent
+ * that was not successfully parsed into one of these formats.
+ *
+ * - TCF is Europe’s [Transparency & Consent Framework](https://iabeurope.eu/transparency-consent-framework/).
+ * - CCPA is the [California Consumer Privacy Act](https://oag.ca.gov/privacy/ccpa). This has now been deprecated and replaced by USNAT: https://github.com/guardian/ophan/pull/5974
+ * - AUS is for Australian consents, using a version of the CCPA.
+ **/
+export type TJurisdiction = "TCF" | "USNAT" | "CCPA" | "AUS" | "OTHER";

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

@@ -0,0 +1,106 @@
+import type { Consent } from "./consent";
+import type { ComponentEvent } from "./component-event";
+import type { InPageClick } from "./inpageclick";
+import type { AbTestInfo } from "./abtest";
+import type { AudioEvent, VideoEvent } from "./media";
+import type { TMembershipTier, TSubscriptionType } from "./subscription";
+import type { TPlatform } from "./platform";
+import type { Acquisition } from "./acquisition";
+import { Interaction } from "./interaction";
+/**
+ * Details about a page view - only populated for _PAGE_VIEW
+ * event types
+ **/
+interface PageView {
+    /** Url of the page served */
+    url: string;
+    /** The platform that served this page */
+    platform?: TPlatform;
+    /** Some approximation of the content type */
+    contentType?: string;
+    /** URL of the referrer to this page view */
+    ref?: string;
+    /** The number of days in the previous week that the device has had a page view */
+    daysVisitedInLastWeek?: number;
+    /** Total number of days on which this browser has visited the guardian */
+    totalDaysVisited?: number;
+    /** Calculated average days between recent visits */
+    averageDaysBetweenRecentVisits?: number;
+    /** Is this browser a regular visitor to the Guardian */
+    regular?: boolean;
+    subscriptionType?: TSubscriptionType;
+    membershipTier?: TMembershipTier;
+    navigationType?: PerformanceNavigationTiming["type"];
+    from?: string;
+    to?: string;
+    tz?: string;
+    visibilityState?: string;
+}
+export interface AttentionTime {
+    /** Attention time spent on this page view in milliseconds */
+    attentionMs: number;
+    /** Map of component name to time in ms */
+    componentAttention?: {
+        [key: string]: number;
+    };
+}
+interface AssetPerformanceData {
+    /** The name of the metric being captured */
+    name: string;
+    /** Value of window.performance.now at which metric was captured */
+    timing: number;
+}
+interface WebPerformanceData {
+    /** Time in ms that dns lookup took */
+    dns: number;
+    /** Time in ms that connection to the server took */
+    connection: number;
+    /** Time to first byte */
+    firstByte: number;
+    /** First byte to last byte */
+    lastByte: number;
+    /** From last byte of doc to start of domContentLoaded */
+    domContentLoadedEvent: number;
+    /** domContentLoaded to start of load event */
+    loadEvent: number;
+    /** The navigation type */
+    navType: number;
+    /** Number of redirects on current domain */
+    redirectCount: number;
+    /** List of custom Asset performance data */
+    assetsPerformance?: AssetPerformanceData[];
+}
+interface Component {
+    /** The name of this component */
+    name: string;
+    /** How long, in milliseconds, that the component took to load */
+    loadTimeMs?: number;
+}
+interface LazyComponents {
+    /** The set of components that were loaded lazily on this page */
+    components: Component[];
+}
+export type TEdition = "UK" | "US" | "AU" | "International" | "Europe";
+export interface EventPayload extends Partial<Consent> {
+    /** If the user is logged in, the identity user id */
+    userId?: string;
+    pageView?: PageView;
+    attention?: AttentionTime;
+    performance?: WebPerformanceData;
+    audio?: AudioEvent;
+    video?: VideoEvent;
+    ab?: AbTestInfo;
+    lazyComponents?: LazyComponents;
+    inPageClick?: InPageClick;
+    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>;
+    edition?: TEdition;
+    /** The set of component names that were rendered on this page, e.g.: ["nav3","nav2","sub-nav","footer"] */
+    renderedComponents?: Array<string>;
+}
+export {};

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

@@ -0,0 +1,11 @@
+import { LinkName } from "./link";
+export interface InPageClick {
+    /**
+     * the component that contained the item clicked on
+     */
+    component?: string;
+    /**
+     * The link name associated with the element clicked.
+     */
+    linkName?: LinkName;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * Represents an interaction on the web or apps
+ */
+export interface Interaction {
+    /**
+     * Key for the interaction.
+     */
+    component: string;
+    /**
+     * Value associated with the interaction
+     */
+    value?: string;
+    /**
+     * The id of the atom that the interaction has come from
+     */
+    atomId?: string;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Represents the position and location of a link within the Guardian site.
+ * We hope to enhance this structure to include a better representation of what the links
+ * actually mean, but for now we just report exactly what the web site tells us,
+ * which is a hierarchical list of named items e.g.
+ *  "more","container-2 | highlights","Front | /uk"
+ *  "article","news | group-1+ | card-3","container-1 | headlines","Front | /uk"
+ */
+export type LinkName = {
+    /**
+     * List of link names, most specific first
+     */
+    raw?: string[];
+};