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

package/dist/types/abtest.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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: Set<AbTest>;
+}
+//# sourceMappingURL=abtest.d.ts.map

package/dist/types/acquisition.d.ts

@@ -0,0 +1,148 @@
+import type { AbTestInfo } from "./abtest";
+import type { PrintOptions } from "./printproduct";
+import type { TComponentType } from "./component-type";
+import type { TPlatform } from "./platform";
+import type { TProduct } 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 declare const PaymentFrequency: {
+    readonly ONE_OFF: "ONE_OFF";
+    readonly MONTHLY: "MONTHLY";
+    readonly ANNUALLY: "ANNUALLY";
+    readonly QUARTERLY: "QUARTERLY";
+    readonly SIX_MONTHLY: "SIX_MONTHLY";
+};
+export type TPaymentFrequency = typeof PaymentFrequency[keyof typeof PaymentFrequency];
+export declare const PaymentProvider: {
+    readonly STRIPE: "STRIPE";
+    readonly PAYPAL: "PAYPAL";
+    readonly GOCARDLESS: "GOCARDLESS";
+    readonly IN_APP_PURCHASE: "IN_APP_PURCHASE";
+    readonly STRIPE_APPLE_PAY: "STRIPE_APPLE_PAY";
+    readonly STRIPE_PAYMENT_REQUEST_BUTTON: "STRIPE_PAYMENT_REQUEST_BUTTON";
+    readonly SUBSCRIBE_WITH_GOOGLE: "SUBSCRIBE_WITH_GOOGLE";
+    readonly AMAZON_PAY: "AMAZON_PAY";
+    readonly STRIPE_SEPA: "STRIPE_SEPA";
+};
+export type TPaymentProvider = typeof PaymentProvider[keyof typeof PaymentProvider];
+export declare const AcquisitionSource: {
+    readonly GUARDIAN_WEB: "GUARDIAN_WEB";
+    /**
+     * @deprecated DO NOT USE
+     */
+    readonly GUARDIAN_APPS: "GUARDIAN_APPS";
+    readonly EMAIL: "EMAIL";
+    readonly SOCIAL: "SOCIAL";
+    readonly SEARCH: "SEARCH";
+    readonly PPC: "PPC";
+    readonly DIRECT: "DIRECT";
+    readonly GUARDIAN_APP_IOS: "GUARDIAN_APP_IOS";
+    readonly GUARDIAN_APP_ANDROID: "GUARDIAN_APP_ANDROID";
+    readonly APPLE_NEWS: "APPLE_NEWS";
+    readonly GOOGLE_AMP: "GOOGLE_AMP";
+    readonly YOUTUBE: "YOUTUBE";
+};
+export type TAcquisitionSource = typeof AcquisitionSource[keyof typeof AcquisitionSource];
+/**
+ * Represents monetary contribution made by a reader via this page.
+ */
+export interface Acquisition {
+    /**
+     * Product type
+     */
+    product: TProduct;
+    /**
+     * 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?: Set<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?: Set<string>;
+    /**
+     * The identity id of a user
+     */
+    identityId?: string;
+    /**
+     * Query string parameters associated with an acquisition
+     */
+    queryParameters?: Set<QueryParameter>;
+}
+//# sourceMappingURL=acquisition.d.ts.map

package/dist/types/acquisition.js

@@ -0,0 +1,35 @@
+export const PaymentFrequency = {
+    ONE_OFF: "ONE_OFF",
+    MONTHLY: "MONTHLY",
+    ANNUALLY: "ANNUALLY",
+    QUARTERLY: "QUARTERLY",
+    SIX_MONTHLY: "SIX_MONTHLY",
+};
+export const PaymentProvider = {
+    STRIPE: "STRIPE",
+    PAYPAL: "PAYPAL",
+    GOCARDLESS: "GOCARDLESS",
+    IN_APP_PURCHASE: "IN_APP_PURCHASE",
+    STRIPE_APPLE_PAY: "STRIPE_APPLE_PAY",
+    STRIPE_PAYMENT_REQUEST_BUTTON: "STRIPE_PAYMENT_REQUEST_BUTTON",
+    SUBSCRIBE_WITH_GOOGLE: "SUBSCRIBE_WITH_GOOGLE",
+    AMAZON_PAY: "AMAZON_PAY",
+    STRIPE_SEPA: "STRIPE_SEPA",
+};
+export const AcquisitionSource = {
+    GUARDIAN_WEB: "GUARDIAN_WEB",
+    /**
+     * @deprecated DO NOT USE
+     */
+    GUARDIAN_APPS: "GUARDIAN_APPS",
+    EMAIL: "EMAIL",
+    SOCIAL: "SOCIAL",
+    SEARCH: "SEARCH",
+    PPC: "PPC",
+    DIRECT: "DIRECT",
+    GUARDIAN_APP_IOS: "GUARDIAN_APP_IOS",
+    GUARDIAN_APP_ANDROID: "GUARDIAN_APP_ANDROID",
+    APPLE_NEWS: "APPLE_NEWS",
+    GOOGLE_AMP: "GOOGLE_AMP",
+    YOUTUBE: "YOUTUBE",
+};

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

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

package/dist/types/component-event.js

@@ -0,0 +1,67 @@
+export const Action = {
+    /**
+     * The component was inserted into its container (e.g. a web page or view in an app)
+     **/
+    INSERT: "INSERT",
+    /**
+     * The component was in view on screen
+     **/
+    VIEW: "VIEW",
+    /**
+     * The component was expanded (e.g. "see more").
+     * Not a navigation away to another page
+     **/
+    EXPAND: "EXPAND",
+    /**
+     * A "like", thumbs up, etc.
+     **/
+    LIKE: "LIKE",
+    /**
+     * A "dislike", thumbs down, etc.
+     **/
+    DISLIKE: "DISLIKE",
+    /**
+     * A subscription to a service, newsletter, etc.
+     **/
+    SUBSCRIBE: "SUBSCRIBE",
+    /**
+     * Selection of an answer in a quiz
+     **/
+    ANSWER: "ANSWER",
+    /**
+     * A vote in a poll
+     **/
+    VOTE: "VOTE",
+    /**
+     * A single click on the component which is not covered by
+     * any of the existing Actions.
+     **/
+    CLICK: "CLICK",
+    /**
+     * User sign in to Guardian Identity account
+     **/
+    SIGN_IN: "SIGN_IN",
+    /**
+     * User creates a Guardian Identity account
+     **/
+    CREATE_ACCOUNT: "CREATE_ACCOUNT",
+    /**
+     * User Consent
+     **/
+    ACCEPT_DEFAULT_CONSENT: "ACCEPT_DEFAULT_CONSENT",
+    MANAGE_CONSENT: "MANAGE_CONSENT",
+    CONSENT_ACCEPT_ALL: "CONSENT_ACCEPT_ALL",
+    CONSENT_REJECT_ALL: "CONSENT_REJECT_ALL",
+    /**
+     * the component sticks in the screen
+     **/
+    STICK: "STICK",
+    /**
+     * the component is closed
+     **/
+    CLOSE: "CLOSE",
+    /**
+     * the component is returned to its original location
+     **/
+    RETURN: "RETURN",
+};

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

@@ -0,0 +1,58 @@
+export declare const ComponentType: {
+    readonly READERS_QUESTIONS_ATOM: "READERS_QUESTIONS_ATOM";
+    readonly QANDA_ATOM: "QANDA_ATOM";
+    readonly PROFILE_ATOM: "PROFILE_ATOM";
+    readonly GUIDE_ATOM: "GUIDE_ATOM";
+    readonly TIMELINE_ATOM: "TIMELINE_ATOM";
+    readonly NEWSLETTER_SUBSCRIPTION: "NEWSLETTER_SUBSCRIPTION";
+    readonly SURVEYS_QUESTIONS: "SURVEYS_QUESTIONS";
+    readonly ACQUISITIONS_EPIC: "ACQUISITIONS_EPIC";
+    readonly ACQUISITIONS_ENGAGEMENT_BANNER: "ACQUISITIONS_ENGAGEMENT_BANNER";
+    readonly ACQUISITIONS_THANK_YOU_EPIC: "ACQUISITIONS_THANK_YOU_EPIC";
+    readonly ACQUISITIONS_HEADER: "ACQUISITIONS_HEADER";
+    readonly ACQUISITIONS_FOOTER: "ACQUISITIONS_FOOTER";
+    readonly ACQUISITIONS_INTERACTIVE_SLICE: "ACQUISITIONS_INTERACTIVE_SLICE";
+    readonly ACQUISITIONS_NUGGET: "ACQUISITIONS_NUGGET";
+    readonly ACQUISITIONS_STANDFIRST: "ACQUISITIONS_STANDFIRST";
+    readonly ACQUISITIONS_THRASHER: "ACQUISITIONS_THRASHER";
+    readonly ACQUISITIONS_EDITORIAL_LINK: "ACQUISITIONS_EDITORIAL_LINK";
+    readonly ACQUISITIONS_MANAGE_MY_ACCOUNT: "ACQUISITIONS_MANAGE_MY_ACCOUNT";
+    readonly ACQUISITIONS_BUTTON: "ACQUISITIONS_BUTTON";
+    readonly ACQUISITIONS_OTHER: "ACQUISITIONS_OTHER";
+    readonly APP_ADVERT: "APP_ADVERT";
+    readonly APP_AUDIO: "APP_AUDIO";
+    readonly APP_BUTTON: "APP_BUTTON";
+    readonly APP_CARD: "APP_CARD";
+    readonly APP_CROSSWORDS: "APP_CROSSWORDS";
+    readonly APP_ENGAGEMENT_BANNER: "APP_ENGAGEMENT_BANNER";
+    readonly APP_EPIC: "APP_EPIC";
+    readonly APP_GALLERY: "APP_GALLERY";
+    readonly APP_LINK: "APP_LINK";
+    readonly APP_NAVIGATION_ITEM: "APP_NAVIGATION_ITEM";
+    readonly APP_SCREEN: "APP_SCREEN";
+    readonly APP_THRASHER: "APP_THRASHER";
+    readonly APP_VIDEO: "APP_VIDEO";
+    readonly AUDIO_ATOM: "AUDIO_ATOM";
+    readonly CHART_ATOM: "CHART_ATOM";
+    readonly ACQUISITIONS_MERCHANDISING: "ACQUISITIONS_MERCHANDISING";
+    readonly ACQUISITIONS_HOUSE_ADS: "ACQUISITIONS_HOUSE_ADS";
+    readonly SIGN_IN_GATE: "SIGN_IN_GATE";
+    readonly ACQUISITIONS_SUBSCRIPTIONS_BANNER: "ACQUISITIONS_SUBSCRIPTIONS_BANNER";
+    readonly MOBILE_STICKY_AD: "MOBILE_STICKY_AD";
+    readonly IDENTITY_AUTHENTICATION: "IDENTITY_AUTHENTICATION";
+    readonly RETENTION_ENGAGEMENT_BANNER: "RETENTION_ENGAGEMENT_BANNER";
+    readonly ACQUISITION_SUPPORT_SITE: "ACQUISITION_SUPPORT_SITE";
+    readonly RETENTION_EPIC: "RETENTION_EPIC";
+    readonly CONSENT: "CONSENT";
+    readonly LIVE_BLOG_PINNED_POST: "LIVE_BLOG_PINNED_POST";
+    readonly STICKY_VIDEO: "STICKY_VIDEO";
+    readonly KEY_EVENT_CARD: "KEY_EVENT_CARD";
+    readonly RETENTION_HEADER: "RETENTION_HEADER";
+    readonly SLIDESHOW: "SLIDESHOW";
+    readonly APP_FEATURE: "APP_FEATURE";
+    readonly CARD: "CARD";
+    readonly CAROUSEL: "CAROUSEL";
+    readonly CONTAINER: "CONTAINER";
+};
+export type TComponentType = typeof ComponentType[keyof typeof ComponentType];
+//# sourceMappingURL=component-type.d.ts.map

package/dist/types/component-type.js

@@ -0,0 +1,56 @@
+export const ComponentType = {
+    READERS_QUESTIONS_ATOM: "READERS_QUESTIONS_ATOM",
+    QANDA_ATOM: "QANDA_ATOM",
+    PROFILE_ATOM: "PROFILE_ATOM",
+    GUIDE_ATOM: "GUIDE_ATOM",
+    TIMELINE_ATOM: "TIMELINE_ATOM",
+    NEWSLETTER_SUBSCRIPTION: "NEWSLETTER_SUBSCRIPTION",
+    SURVEYS_QUESTIONS: "SURVEYS_QUESTIONS",
+    ACQUISITIONS_EPIC: "ACQUISITIONS_EPIC",
+    ACQUISITIONS_ENGAGEMENT_BANNER: "ACQUISITIONS_ENGAGEMENT_BANNER",
+    ACQUISITIONS_THANK_YOU_EPIC: "ACQUISITIONS_THANK_YOU_EPIC",
+    ACQUISITIONS_HEADER: "ACQUISITIONS_HEADER",
+    ACQUISITIONS_FOOTER: "ACQUISITIONS_FOOTER",
+    ACQUISITIONS_INTERACTIVE_SLICE: "ACQUISITIONS_INTERACTIVE_SLICE",
+    ACQUISITIONS_NUGGET: "ACQUISITIONS_NUGGET",
+    ACQUISITIONS_STANDFIRST: "ACQUISITIONS_STANDFIRST",
+    ACQUISITIONS_THRASHER: "ACQUISITIONS_THRASHER",
+    ACQUISITIONS_EDITORIAL_LINK: "ACQUISITIONS_EDITORIAL_LINK",
+    ACQUISITIONS_MANAGE_MY_ACCOUNT: "ACQUISITIONS_MANAGE_MY_ACCOUNT",
+    ACQUISITIONS_BUTTON: "ACQUISITIONS_BUTTON",
+    ACQUISITIONS_OTHER: "ACQUISITIONS_OTHER",
+    APP_ADVERT: "APP_ADVERT",
+    APP_AUDIO: "APP_AUDIO",
+    APP_BUTTON: "APP_BUTTON",
+    APP_CARD: "APP_CARD",
+    APP_CROSSWORDS: "APP_CROSSWORDS",
+    APP_ENGAGEMENT_BANNER: "APP_ENGAGEMENT_BANNER",
+    APP_EPIC: "APP_EPIC",
+    APP_GALLERY: "APP_GALLERY",
+    APP_LINK: "APP_LINK",
+    APP_NAVIGATION_ITEM: "APP_NAVIGATION_ITEM",
+    APP_SCREEN: "APP_SCREEN",
+    APP_THRASHER: "APP_THRASHER",
+    APP_VIDEO: "APP_VIDEO",
+    AUDIO_ATOM: "AUDIO_ATOM",
+    CHART_ATOM: "CHART_ATOM",
+    ACQUISITIONS_MERCHANDISING: "ACQUISITIONS_MERCHANDISING",
+    ACQUISITIONS_HOUSE_ADS: "ACQUISITIONS_HOUSE_ADS",
+    SIGN_IN_GATE: "SIGN_IN_GATE",
+    ACQUISITIONS_SUBSCRIPTIONS_BANNER: "ACQUISITIONS_SUBSCRIPTIONS_BANNER",
+    MOBILE_STICKY_AD: "MOBILE_STICKY_AD",
+    IDENTITY_AUTHENTICATION: "IDENTITY_AUTHENTICATION",
+    RETENTION_ENGAGEMENT_BANNER: "RETENTION_ENGAGEMENT_BANNER",
+    ACQUISITION_SUPPORT_SITE: "ACQUISITION_SUPPORT_SITE",
+    RETENTION_EPIC: "RETENTION_EPIC",
+    CONSENT: "CONSENT",
+    LIVE_BLOG_PINNED_POST: "LIVE_BLOG_PINNED_POST",
+    STICKY_VIDEO: "STICKY_VIDEO",
+    KEY_EVENT_CARD: "KEY_EVENT_CARD",
+    RETENTION_HEADER: "RETENTION_HEADER",
+    SLIDESHOW: "SLIDESHOW",
+    APP_FEATURE: "APP_FEATURE",
+    CARD: "CARD",
+    CAROUSEL: "CAROUSEL",
+    CONTAINER: "CONTAINER",
+};

package/dist/types/consent.d.ts

@@ -0,0 +1,47 @@
+/** 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,….
+     **/
+    consentData: 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, 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).
+ * - AUS is for Australian consents, using a version of the CCPA.
+ **/
+export declare const Jurisdiction: {
+    TCF: string;
+    CCPA: string;
+    AUS: string;
+    OTHER: string;
+};
+export type TJurisdiction = typeof Jurisdiction[keyof typeof Jurisdiction];
+//# sourceMappingURL=consent.d.ts.map

package/dist/types/consent.js

@@ -0,0 +1,15 @@
+/**
+ * For a recognised/successfully parsed consent, a value of TCF, 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).
+ * - AUS is for Australian consents, using a version of the CCPA.
+ **/
+export const Jurisdiction = {
+    TCF: "TCF",
+    CCPA: "CCPA",
+    AUS: "AUS",
+    OTHER: "OTHER",
+};

package/dist/types/event.d.ts

@@ -0,0 +1,115 @@
+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 declare const Edition: {
+    readonly UK: "UK";
+    readonly US: "US";
+    readonly AU: "AU";
+    readonly International: "International";
+    readonly Europe: "Europe";
+};
+export type TEdition = typeof Edition[keyof typeof Edition];
+export interface EventPayload {
+    /** 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?: Set<string>;
+    edition?: TEdition;
+    /** The set of component names that were rendered on this page, e.g.: ["nav3","nav2","sub-nav","footer"] */
+    renderedComponents?: Set<string>;
+    consent?: Consent;
+}
+export {};
+//# sourceMappingURL=event.d.ts.map

package/dist/types/event.js

@@ -0,0 +1,7 @@
+export const Edition = {
+    UK: "UK",
+    US: "US",
+    AU: "AU",
+    International: "International",
+    Europe: "Europe",
+};