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

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

@@ -0,0 +1,98 @@
+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";
+/**
+ * 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";
+/**
+ * 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/NPM-dist/types/types/platform.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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" | "amp" | "witness" | "jobs" | "contribution" | "yahoo" | "amazon-echo" | "apple-news" | "windows-native-app" | "scribd" | "support" | "subscribe" | "manage-my-account" | "smart-news" | "editions";

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

@@ -0,0 +1,27 @@
+/**
+ * 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"
+/**
+ * DEPRECATED DO NOT USE
+ * This enum has a spelling mistake. Use VOUCHER_WEEKEND_PLUS (28) instead
+ **/
+ | "voucher-weekend-plus" | "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/NPM-dist/types/types/product.d.ts

@@ -0,0 +1,53 @@
+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.
+ */
+ | "SUPPORTER_PLUS";

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

@@ -0,0 +1,60 @@
+/**
+ * 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
+/**
+ * User has an active subscription via the device's store.
+ *
+ * In json, "play" or "apple" are supported as synonyms of this value.
+ */
+ | 2
+/**
+ * User has an active subscription as part of a print bundle.
+ */
+ | 4
+/**
+ * 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
+/**
+ * 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
+/**
+ * User has an active digital pack subscription.
+ */
+ | 6;
+/**
+ * What tier of membership the user is currently part of.
+ */
+export type TMembershipTier = 
+/**
+ * The user is a friend.
+ */
+1
+/**
+ * The user is a Guardian employee.
+ */
+ | 2
+/**
+ * The user is a supporter.
+ */
+ | 3
+/**
+ * The user is a partner.
+ */
+ | 4
+/**
+ * The user is a patron.
+ */
+ | 5;

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

@@ -0,0 +1,26 @@
+/**
+ * A set of UTM parameters
+ * https://en.wikipedia.org/wiki/UTM_parameters
+ */
+interface UtmParameters {
+    /**
+     * Identifies which site sent the traffic
+     */
+    utmSource?: string;
+    /**
+     * Identifies what type of link was used, such as cost per click or email.
+     */
+    utmMedium?: string;
+    /**
+     * Identifies a specific product promotion or strategic campaign.
+     */
+    utmCampaign?: string;
+    /**
+     * Identifies search terms.
+     */
+    utmTerm?: string;
+    /**
+     * Identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link. It is often used for A/B testing and content-targeted ads.
+     */
+    utmContent?: string;
+}

package/NPM-dist/types/utmparameters.js

@@ -0,0 +1 @@
+"use strict";

package/NPM-dist/types/vendor/adBlockDetectionLib.d.ts

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

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

@@ -0,0 +1,5 @@
+declare namespace _default {
+    function state(): DocumentVisibilityState;
+    let changeEvent: string | undefined;
+}
+export default _default;

package/NPM-dist/types/witness.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/vendor/adBlockDetectionLib.js

@@ -0,0 +1,312 @@
+// Generated by CoffeeScript 2.7.0
+// TLDR; This is stripped down from the IAB ad block detection library.
+// https://github.com/InteractiveAdvertisingBureau/AdBlockDetection
+// The aforementioned library is not well maintained
+// and had work in progress network adblocking detection
+var init = function () {
+    var ofs = 'offset', cl = 'client';
+    var noop = function () { };
+    var testedOnce = false;
+    var testExecuting = false;
+    var isOldIEevents = window.addEventListener === undefined;
+    /**
+     * Options set with default options initialized
+     *
+     */
+    var _options = {
+        loopDelay: 50,
+        maxLoop: 5,
+        debug: false,
+        found: noop,
+        notfound: noop,
+        complete: noop,
+    };
+    var listeners = []; // event response listeners
+    var baitNode = null;
+    var quickBait = {
+        cssClass: 'ad-slot pub_300x250 pub_300x250m pub_728x90 text-ad textAd text_ad text_ads text-ads text-ad-links',
+    };
+    var baitTriggers = {
+        nullProps: [ofs + 'Parent'],
+        zeroProps: [],
+    };
+    baitTriggers.zeroProps = [
+        ofs + 'Height',
+        ofs + 'Left',
+        ofs + 'Top',
+        ofs + 'Width',
+        ofs + 'Height',
+        cl + 'Height',
+        cl + 'Width',
+    ];
+    // result object
+    var exeResult = {
+        quick: null,
+        remote: null,
+    };
+    var findResult = null; // result of test for ad blocker
+    var timerIds = {
+        test: 0,
+        download: 0,
+    };
+    function isFunc(fn) {
+        return typeof fn == 'function';
+    }
+    /**
+     * Make a DOM element
+     */
+    function makeEl(tag, attributes) {
+        var k, v, el, attr = attributes;
+        var d = document;
+        el = d.createElement(tag);
+        if (attr) {
+            for (k in attr) {
+                if (attr.hasOwnProperty(k)) {
+                    el.setAttribute(k, attr[k]);
+                }
+            }
+        }
+        return el;
+    }
+    function attachEventListener(dom, eventName, handler) {
+        if (isOldIEevents) {
+            dom.attachEvent('on' + eventName, handler);
+        }
+        else {
+            dom.addEventListener(eventName, handler, false);
+        }
+    }
+    function log(message, isError) {
+        if (!_options.debug && !isError) {
+            return;
+        }
+        if (window.console && window.console.log) {
+            if (isError) {
+                console.error('[ABD] ' + message);
+            }
+            else {
+                console.log('[ABD] ' + message);
+            }
+        }
+    }
+    function beginTest(bait) {
+        log('start beginTest');
+        if (findResult == true) {
+            return;
+        }
+        testExecuting = true;
+        castBait(bait);
+        exeResult.quick = 'testing';
+        timerIds.test = setTimeout(function () {
+            reelIn(bait, 1);
+        }, 5);
+    }
+    /**
+     * Create the bait node to see how the browser page reacts
+     */
+    function castBait(bait) {
+        var i, d = document, b = d.body;
+        var t;
+        var baitStyle = 'width: 1px !important; height: 1px !important; position: absolute !important; left: -10000px !important; top: -1000px !important;';
+        if (bait == null || typeof bait == 'string') {
+            log('invalid bait being cast');
+            return;
+        }
+        if (bait.style != null) {
+            baitStyle += bait.style;
+        }
+        baitNode = makeEl('div', {
+            class: bait.cssClass,
+            style: baitStyle,
+        });
+        log('adding bait node to DOM');
+        b.appendChild(baitNode);
+        // touch these properties
+        for (i = 0; i < baitTriggers.nullProps.length; i++) {
+            t = baitNode[baitTriggers.nullProps[i]];
+        }
+        for (i = 0; i < baitTriggers.zeroProps.length; i++) {
+            t = baitNode[baitTriggers.zeroProps[i]];
+        }
+    }
+    /**
+     * Run tests to see if browser has taken the bait and blocked the bait element
+     */
+    function reelIn(bait, attemptNum) {
+        var i, k, v;
+        var body = document.body;
+        var found = false;
+        if (baitNode == null) {
+            log('recast bait');
+            castBait(bait || quickBait);
+        }
+        if (typeof bait == 'string') {
+            log('invalid bait used', true);
+            if (clearBaitNode()) {
+                setTimeout(function () {
+                    testExecuting = false;
+                }, 5);
+            }
+            return;
+        }
+        if (timerIds.test > 0) {
+            clearTimeout(timerIds.test);
+            timerIds.test = 0;
+        }
+        // test for issues
+        if (body.getAttribute('abp') !== null) {
+            log('found adblock body attribute');
+            found = true;
+        }
+        for (i = 0; i < baitTriggers.nullProps.length; i++) {
+            if (baitNode[baitTriggers.nullProps[i]] == null) {
+                if (attemptNum > 4)
+                    found = true;
+                log('found adblock null attr: ' + baitTriggers.nullProps[i]);
+                break;
+            }
+            if (found == true) {
+                break;
+            }
+        }
+        for (i = 0; i < baitTriggers.zeroProps.length; i++) {
+            if (found == true) {
+                break;
+            }
+            if (baitNode[baitTriggers.zeroProps[i]] == 0) {
+                if (attemptNum > 4)
+                    found = true;
+                log('found adblock zero attr: ' + baitTriggers.zeroProps[i]);
+            }
+        }
+        if (window.getComputedStyle !== undefined) {
+            var baitTemp = window.getComputedStyle(baitNode, null);
+            if (baitTemp.getPropertyValue('display') == 'none' ||
+                baitTemp.getPropertyValue('visibility') == 'hidden') {
+                if (attemptNum > 4)
+                    found = true;
+                log('found adblock computedStyle indicator');
+            }
+        }
+        testedOnce = true;
+        if (found || attemptNum++ >= _options.maxLoop) {
+            findResult = found;
+            log('exiting test loop - value: ' + findResult);
+            notifyListeners();
+            if (clearBaitNode()) {
+                setTimeout(function () {
+                    testExecuting = false;
+                }, 5);
+            }
+        }
+        else {
+            timerIds.test = setTimeout(function () {
+                reelIn(bait, attemptNum);
+            }, _options.loopDelay);
+        }
+    }
+    function clearBaitNode() {
+        if (baitNode === null) {
+            return true;
+        }
+        try {
+            if (isFunc(baitNode.remove)) {
+                baitNode.remove();
+            }
+            document.body.removeChild(baitNode);
+        }
+        catch (ex) { }
+        baitNode = null;
+        return true;
+    }
+    /**
+     * Halt the test and any pending timeouts
+     */
+    function stopFishing() {
+        if (timerIds.test > 0) {
+            clearTimeout(timerIds.test);
+        }
+        if (timerIds.download > 0) {
+            clearTimeout(timerIds.download);
+        }
+        clearBaitNode();
+    }
+    /**
+     * Fire all registered listeners
+     */
+    function notifyListeners() {
+        var i, funcs;
+        if (findResult === null) {
+            return;
+        }
+        for (i = 0; i < listeners.length; i++) {
+            funcs = listeners[i];
+            try {
+                if (funcs != null) {
+                    if (isFunc(funcs['complete'])) {
+                        funcs['complete'](findResult);
+                    }
+                    if (findResult && isFunc(funcs['found'])) {
+                        funcs['found']();
+                    }
+                    else if (findResult === false && isFunc(funcs['notfound'])) {
+                        funcs['notfound']();
+                    }
+                }
+            }
+            catch (ex) {
+                log('Failure in notify listeners ' + ex.Message, true);
+            }
+        }
+    }
+    /**
+     * Attaches event listener or fires if events have already passed.
+     */
+    function attachOrFire() {
+        var fireNow = false;
+        var fn;
+        if (document.readyState) {
+            if (document.readyState == 'complete') {
+                fireNow = true;
+            }
+        }
+        fn = function () {
+            beginTest(quickBait, false);
+        };
+        if (fireNow) {
+            fn();
+        }
+        else {
+            attachEventListener(window, 'load', fn);
+        }
+    }
+    /**
+     * Public interface of adblock detector
+     */
+    return function (options) {
+        var k, v, funcs;
+        if (!options) {
+            return;
+        }
+        funcs = {
+            complete: noop,
+            found: noop,
+            notfound: noop,
+        };
+        for (k in options) {
+            if (options.hasOwnProperty(k)) {
+                if (k == 'complete' || k == 'found' || k == 'notFound') {
+                    funcs[k.toLowerCase()] = options[k];
+                }
+                else {
+                    _options[k] = options[k];
+                }
+            }
+        }
+        listeners.push(funcs);
+        attachOrFire();
+    };
+};
+export default {
+    init: init(),
+};

package/NPM-dist/visibility.js

@@ -0,0 +1,22 @@
+export default {
+    state: () => document.visibilityState ||
+        document.webkitVisibilityState ||
+        document.mozVisibilityState ||
+        document.msVisibilityState,
+    changeEvent: getChangeEvent(),
+};
+function getChangeEvent() {
+    if (document.visibilityState) {
+        return 'visibilitychange';
+    }
+    else if (document.webkitVisibilityState) {
+        return 'webkitvisibilitychange';
+    }
+    else if (document.mozVisibilityState) {
+        return 'mozvisibilitychange';
+    }
+    else if (document.msVisibilityState) {
+        return 'msvisibilitychange';
+    }
+    return undefined;
+}

package/{assets → NPM-dist}/witness.js

@@ -1,11 +1,8 @@
 // Generated by CoffeeScript 2.7.0
 import core from './core.js';
-
-import transmit from './transmit.js';
-
+import transmit from './transmit';
 core.init('witness');
-
 export default {
-	record: transmit.sendMore,
-	viewId: transmit.viewId,
+    record: transmit.sendMore,
+    viewId: transmit.viewId,
 };