@guardian/ophan-tracker-js 4.0.2 → 5.0.0

package/src/types/media.ts

@@ -0,0 +1,184 @@
+export type TVideoEventType =
+/**
+ * The media has been requested.
+ * Currently, it appears this event is only received for pre-roll videos.
+ */
+    | "video:content:request"
+
+    /**
+     * The media is ready to play.
+     */
+    | "video:content:ready"
+
+    /**
+     * The media has started playing.
+     */
+    | "video:content:play"
+
+    /**
+     * The media has played a quarter of the way through.
+     * Currently, it appears that pre-roll videos do not send this event.
+     */
+    | "video:content:25"
+
+    /**
+     * The media has played half way though.
+     * Currently, it appears that pre-roll videos do not send this event.
+     */
+    | "video:content:50"
+
+    /**
+     * The media has played three quarters of the way though.
+     * Currently, it appears that pre-roll videos do not send this event.
+     */
+    | "video:content:75"
+
+    /**
+     * The media has played to the end.
+     * NB: "END" is a reserved word in thrift apparently
+     */
+    | "video:content:end"
+
+    /**
+     * The media has been paused before the end.
+     **/
+    | "video:content:pause"
+
+    /**
+     * The media player has resumed playing from a paused state.
+     **/
+    | "video:content:resume"
+    | "video:content:skip"
+    | "video:content:cued"
+
+    /**
+     * The media has been muted.
+     */
+    | "video:content:mute"
+
+    /**
+     * The media has been unmuted.
+     */
+    | "video:content:unmute"
+
+    /**
+     * The media has been displayed in fullscreen mode.
+     */
+    | "video:content:enter_fullscreen"
+
+    /**
+     * The media has left fullscreen mode.
+     */
+    | "video:content:exit_fullscreen"
+
+    /**
+     * The media player has been displayed on the screen.
+     * This is separate to the media being played, but may coincide if the player autoplays.
+     */
+    | "video:content:view";
+
+/**
+ * Details about media playback progress
+ * Note: currently only guardian-hosted videos are reported.
+ */
+export interface AudioEvent {
+    /**
+     * The id of the media asset, e.g. gu-audio-454297906
+     * This matches up with the media id within the content api.
+     */
+    id: string;
+
+    /**
+     * The event type.
+     */
+    eventType: TAudioEventType;
+}
+
+export type TAudioEventType =
+/**
+ * The media has been requested.
+ * Currently, it appears this event is only received for pre-roll videos.
+ */
+    | "audio:content:request"
+
+    /**
+     * The media is ready to play.
+     */
+    | "audio:content:ready"
+
+    /**
+     * The media has started playing.
+     */
+    | "audio:content:play"
+
+    /**
+     * The media has played a quarter of the way through.
+     * Currently, it appears that pre-roll videos do not send this event.
+     */
+    | "audio:content:25"
+
+    /**
+     * The media has played half way though.
+     * Currently, it appears that pre-roll videos do not send this event.
+     */
+    | "audio:content:50"
+
+    /**
+     * The media has played three quarters of the way though.
+     * Currently, it appears that pre-roll videos do not send this event.
+     */
+    | "audio:content:75"
+
+    /**
+     * The media has played to the end.
+     * NB: "END" is a reserved word in thrift apparently
+     */
+    | "audio:content:end"
+
+    /**
+     * The media has been paused before the end.
+     **/
+    | "audio:content:pause"
+
+    /**
+     * The media has been muted.
+     */
+    | "audio:content:mute"
+
+    /**
+     * The media has been unmuted.
+     */
+    | "audio:content:unmute"
+
+    /**
+     * The media has been displayed in fullscreen mode.
+     */
+    | "audio:content:enter_fullscreen"
+
+    /**
+     * The media has left fullscreen mode.
+     */
+    | "audio:content:exit_fullscreen"
+
+    /**
+     * The media player has been displayed on the screen.
+     * This is separate to the media being played, but may coincide if the player autoplays.
+     */
+    | "audio:content:view";
+
+/**
+ * Details about media playback progress
+ * Note: currently only guardian-hosted videos are reported.
+ */
+export interface VideoEvent {
+    /**
+     * The id of the media asset, e.g. gu-video-454297906
+     * This matches up with the media id within the content api.
+     */
+    id: string;
+
+    /**
+     * The event type.
+     */
+    eventType: TVideoEventType;
+}

package/src/types/platform.ts

@@ -0,0 +1,32 @@
+/**
+ * The platform that served this request to the reader.
+ **/
+export type TPlatform =
+    | "r2"
+    | "next-gen"
+    | "ios-native-app"
+    | "android-native-app"
+    /**
+     * Served as a result of embedding a media item on a third party site.
+     * Note therefore you should not typically include this as a guardian
+     * "page view".
+     **/
+    | "embed"
+    | "membership"
+    | "facebook-instant-article"
+    /*  https://www.ampproject.org/ */
+    | "amp"
+    | "witness"
+    | "jobs"
+    | "contribution"
+    | "yahoo"
+    | "amazon-echo"
+    | "apple-news"
+    | "windows-native-app"
+    | "scribd"
+    | "support"
+    | "subscribe"
+    | "manage-my-account"
+    | "smart-news"
+    /* also called "The Daily Edition" and other names */
+    | "editions";

package/src/types/printproduct.ts

@@ -0,0 +1,53 @@
+/**
+ * Differentiates between the (many) different types of print product
+ **/
+export type TPrintProduct =
+    | "voucher-saturday"
+    | "voucher-saturday-plus"
+    | "voucher-weekly-and-saturday"
+    | "voucher-weekly-and-saturday-plus"
+    | "voucher-sunday"
+    | "voucher-sunday-plus"
+    /**
+     * DEPRECATED DO NOT USE
+     * This enum has a spelling mistake. Use VOUCHER_WEEKEND (27) instead
+     **/
+    | "voucher-weekend" // Original: VOUCER_WEEKEND - Corrected spelling and adapted to TS syntax
+    /**
+     * DEPRECATED DO NOT USE
+     * This enum has a spelling mistake. Use VOUCHER_WEEKEND_PLUS (28) instead
+     **/
+    | "voucher-weekend-plus" // Original: VOUCER_WEEKEND_PLUS - Corrected spelling and adapted to TS syntax
+    | "voucher-sixday"
+    | "voucher-sixday-plus"
+    | "voucher-everyday"
+    | "voucher-everyday-plus"
+    | "home-delivery-saturday"
+    | "home-delivery-saturday-plus"
+    | "home-delivery-weekly-and-saturday"
+    | "home-delivery-weekly-and-saturday-plus"
+    | "home-delivery-sunday"
+    | "home-delivery-sunday-plus"
+    | "home-delivery-weekend"
+    | "home-delivery-weekend-plus"
+    | "home-delivery-sixday"
+    | "home-delivery-sixday-plus"
+    | "home-delivery-everyday"
+    | "home-delivery-everyday-plus"
+    | "guardian-weekly"
+    | "guardian-weekly-plus";
+
+/**
+ * Extra parameters only applicable to print products
+ */
+export interface PrintOptions {
+    /**
+     * Differentiates between the (many) different types of print product
+     */
+    product: TPrintProduct;
+
+    /**
+     * The delivery country of the print subscription
+     */
+    deliveryCountryCode: string;
+}

package/src/types/product.ts

@@ -0,0 +1,72 @@
+/**
+ * Guardian product associated with an acquisition or subscription component.
+ *
+ * Product values are intentionally constrained because they are used for
+ * downstream reporting. Additions should be coordinated with the Ophan model.
+ */
+export type Product =
+/**
+ * A one-off contribution
+ */
+    | "CONTRIBUTION"
+
+    /**
+     * A recurring contribution
+     */
+    | "RECURRING_CONTRIBUTION"
+
+    /**
+     * A Membership Supporter signup
+     */
+    | "MEMBERSHIP_SUPPORTER"
+
+    /**
+     * A Membership Patron signup
+     */
+    | "MEMBERSHIP_PATRON"
+
+    /**
+     * A Membership Partner signup
+     */
+    | "MEMBERSHIP_PARTNER"
+
+    /**
+     * A digital subscription
+     */
+    | "DIGITAL_SUBSCRIPTION"
+
+    /**
+     * DEPRECATED DO NOT USE
+     */
+    | "PAPER_SUBSCRIPTION_EVERYDAY"
+
+    /**
+     * DEPRECATED DO NOT USE
+     */
+    | "PAPER_SUBSCRIPTION_SIXDAY"
+
+    /**
+     * DEPRECATED DO NOT USE
+     */
+    | "PAPER_SUBSCRIPTION_WEEKEND"
+
+    /**
+     * DEPRECATED DO NOT USE
+     */
+    | "PAPER_SUBSCRIPTION_SUNDAY"
+
+    /**
+     * A paper subscription
+     */
+    | "PRINT_SUBSCRIPTION"
+
+    /**
+     * An app premium tier signup
+     */
+    | "APP_PREMIUM_TIER"
+
+    /**
+     * Supporter plus tier.
+     */
+    | "GUARDIAN_PATRON"
+    | "SUPPORTER_PLUS";

package/src/types/subscription.ts

@@ -0,0 +1,70 @@
+/**
+ * What type of subscription the user has (or had) for the app
+ */
+export type TSubscriptionType =
+/**
+ * No subscription in place, and no previous record of a subscription on this device.
+ */
+    | 1 // FREE
+
+    /**
+     * User has an active subscription via the device's store.
+     *
+     * In json, "play" or "apple" are supported as synonyms of this value.
+     */
+    | 2 // STORE
+
+    /**
+     * User has an active subscription as part of a print bundle.
+     */
+    | 4 // PRINT
+
+    /**
+     * No subscription in place, but user did previously have a subscription via the
+     * device's store which is now expired.
+     *
+     * In json, "play:expired" and "apple:expired" are supported as synonyms of this value.
+     */
+    | 3 // FREE_WITH_EXPIRED_STORE
+
+    /**
+     * No subscription in place, but user did previously have a subscription as
+     * part of a print bundle which is now expired.
+     *
+     * In json, "print:expired" is supported as a synonym of this value.
+     */
+    | 5 // FREE_WITH_EXPIRED_PRINT
+
+    /**
+     * User has an active digital pack subscription.
+     */
+    | 6; // DIGITAL_PACK
+
+/**
+ * What tier of membership the user is currently part of.
+ */
+export type TMembershipTier =
+/**
+ * The user is a friend.
+ */
+    | 1 // FRIEND
+
+    /**
+     * The user is a Guardian employee.
+     */
+    | 2 // STAFF
+
+    /**
+     * The user is a supporter.
+     */
+    | 3 // SUPPORTER
+
+    /**
+     * The user is a partner.
+     */
+    | 4 // PARTNER
+
+    /**
+     * The user is a patron.
+     */
+    | 5; // PATRON

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

@@ -1,46 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-import core from './core.js';
-import transmit from './transmit.js';
-import attention from './attention.js';
-import visibility from './visibility.js';
-import './click-path-capture.js';
-import './perf.js';
-import './campaign.js';
-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);
-    }
-    catch (error) {
-        console.log(error);
-    }
-};
-const exports = {
-    init,
-    sendInitialEvent,
-    record: transmit.sendMore,
-    get viewId() { return transmit.viewId; },
-};
-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/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

@@ -1,45 +0,0 @@
-import core from './core.js';
-import transmit from './transmit.js';
-import attention from './attention.js';
-import visibility from './visibility.js';
-import './click-path-capture.js';
-import './perf.js';
-import './campaign.js';
-export const init = () => {
-    core.init('support');
-    if (window.addEventListener) {
-        attention.init(visibility);
-    }
-};
-export const sendInitialEvent = (url = location.href, referrer = document.referrer) => {
-    try {
-        transmit.bumpViewId();
-        core.sendInitialEvent(null, url, referrer);
-    }
-    catch (error) {
-        console.log(error);
-    }
-};
-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/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/manage-my-account.d.ts

@@ -1,28 +0,0 @@
-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 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/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/support.d.ts

@@ -1,28 +0,0 @@
-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;
-}
-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/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';