posthog-js 1.76.0 → 1.77.1

package/lib/src/gdpr-utils.js

@@ -0,0 +1,236 @@
+/**
+ * GDPR utils
+ *
+ * The General Data Protection Regulation (GDPR) is a regulation in EU law on data protection
+ * and privacy for all individuals within the European Union. It addresses the export of personal
+ * data outside the EU. The GDPR aims primarily to give control back to citizens and residents
+ * over their personal data and to simplify the regulatory environment for international business
+ * by unifying the regulation within the EU.
+ *
+ * This set of utilities is intended to enable opt in/out functionality in the PostHog JS SDK.
+ * These functions are used internally by the SDK and are not intended to be publicly exposed.
+ */
+import { _each, _includes, _isNumber, _isString, window } from './utils';
+import { cookieStore, localStore, localPlusCookieStore } from './storage';
+/**
+ * A function used to capture a PostHog event (e.g. PostHogLib.capture)
+ * @callback captureFunction
+ * @param {String} event_name The name of the event. This can be anything the user does - 'Button Click', 'Sign Up', 'Item Purchased', etc.
+ * @param {Object} [properties] A set of properties to include with the event you're sending. These describe the user who did the event or details about the event itself.
+ * @param {Function} [callback] If provided, the callback function will be called after capturing the event.
+ */
+/** Public **/
+var GDPR_DEFAULT_PERSISTENCE_PREFIX = '__ph_opt_in_out_';
+/**
+ * Opt the user in to data capturing and cookies/localstorage for the given token
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {captureFunction} [options.capture] - function used for capturing a PostHog event to record the opt-in action
+ * @param {string} [options.captureEventName] - event name to be used for capturing the opt-in action
+ * @param {Object} [options.captureProperties] - set of properties to be captured along with the opt-in action
+ * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @param {Number} [options.cookieExpiration] - number of days until the opt-in cookie expires
+ * @param {boolean} [options.crossSubdomainCookie] - whether the opt-in cookie is set as cross-subdomain or not
+ * @param {boolean} [options.secureCookie] - whether the opt-in cookie is set as secure or not
+ */
+export function optIn(token, options) {
+    _optInOut(true, token, options);
+}
+/**
+ * Opt the user out of data capturing and cookies/localstorage for the given token
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @param {Number} [options.cookieExpiration] - number of days until the opt-out cookie expires
+ * @param {boolean} [options.crossSubdomainCookie] - whether the opt-out cookie is set as cross-subdomain or not
+ * @param {boolean} [options.secureCookie] - whether the opt-out cookie is set as secure or not
+ */
+export function optOut(token, options) {
+    _optInOut(false, token, options);
+}
+/**
+ * Check whether the user has opted in to data capturing and cookies/localstorage for the given token
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @returns {boolean} whether the user has opted in to the given opt type
+ */
+export function hasOptedIn(token, options) {
+    return _getStorageValue(token, options) === '1';
+}
+/**
+ * Check whether the user has opted out of data capturing and cookies/localstorage for the given token
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @param {boolean} [options.respectDnt] - flag to take browser DNT setting into account
+ * @returns {boolean} whether the user has opted out of the given opt type
+ */
+export function hasOptedOut(token, options) {
+    if (_hasDoNotTrackFlagOn(options)) {
+        return true;
+    }
+    return _getStorageValue(token, options) === '0';
+}
+/**
+ * Clear the user's opt in/out status of data capturing and cookies/localstorage for the given token
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @param {Number} [options.cookieExpiration] - number of days until the opt-in cookie expires
+ * @param {boolean} [options.crossSubdomainCookie] - whether the opt-in cookie is set as cross-subdomain or not
+ * @param {boolean} [options.secureCookie] - whether the opt-in cookie is set as secure or not
+ */
+export function clearOptInOut(token, options) {
+    options = options || {};
+    _getStorage(options).remove(_getStorageKey(token, options), !!options.crossSubdomainCookie);
+}
+/** Private **/
+/**
+ * Get storage util
+ * @param {Object} [options]
+ * @param {string} [options.persistenceType]
+ * @returns {object} either cookieStore or localStore
+ */
+function _getStorage(options) {
+    options = options || {};
+    if (options.persistenceType === 'localStorage') {
+        return localStore;
+    }
+    if (options.persistenceType === 'localStorage+cookie') {
+        return localPlusCookieStore;
+    }
+    return cookieStore;
+}
+/**
+ * Get the name of the cookie that is used for the given opt type (capturing, cookie, etc.)
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @returns {string} the name of the cookie for the given opt type
+ */
+function _getStorageKey(token, options) {
+    options = options || {};
+    return (options.persistencePrefix || GDPR_DEFAULT_PERSISTENCE_PREFIX) + token;
+}
+/**
+ * Get the value of the cookie that is used for the given opt type (capturing, cookie, etc.)
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @returns {string} the value of the cookie for the given opt type
+ */
+function _getStorageValue(token, options) {
+    return _getStorage(options).get(_getStorageKey(token, options));
+}
+/**
+ * Check whether the user has set the DNT/doNotTrack setting to true in their browser
+ * @param {Object} [options]
+ * @param {string} [options.window] - alternate window object to check; used to force various DNT settings in browser tests
+ * @param {boolean} [options.respectDnt] - flag to take browser DNT setting into account
+ * @returns {boolean} whether the DNT setting is true
+ */
+function _hasDoNotTrackFlagOn(options) {
+    if (options && options.respectDnt) {
+        var win = (options && options.window) || window;
+        var nav = win['navigator'] || {};
+        var hasDntOn_1 = false;
+        _each([
+            nav['doNotTrack'],
+            nav['msDoNotTrack'],
+            win['doNotTrack'],
+        ], function (dntValue) {
+            if (_includes([true, 1, '1', 'yes'], dntValue)) {
+                hasDntOn_1 = true;
+            }
+        });
+        return hasDntOn_1;
+    }
+    return false;
+}
+/**
+ * Set cookie/localstorage for the user indicating that they are opted in or out for the given opt type
+ * @param {boolean} optValue - whether to opt the user in or out for the given opt type
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {captureFunction} [options.capture] - function used for capturing a PostHog event to record the opt-in action
+ * @param {string} [options.captureEventName] - event name to be used for capturing the opt-in action
+ * @param {Object} [options.captureProperties] - set of properties to be captured along with the opt-in action
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @param {Number} [options.cookieExpiration] - number of days until the opt-in cookie expires
+ * @param {boolean} [options.crossSubdomainCookie] - whether the opt-in cookie is set as cross-subdomain or not
+ * @param {boolean} [options.secureCookie] - whether the opt-in cookie is set as secure or not
+ */
+function _optInOut(optValue, token, options) {
+    if (!_isString(token) || !token.length) {
+        console.error('gdpr.' + (optValue ? 'optIn' : 'optOut') + ' called with an invalid token');
+        return;
+    }
+    options = options || {};
+    _getStorage(options).set(_getStorageKey(token, options), optValue ? 1 : 0, _isNumber(options.cookieExpiration) ? options.cookieExpiration : null, options.crossSubdomainCookie, options.secureCookie);
+    if (options.capture && optValue) {
+        // only capture event if opting in (optValue=true)
+        options.capture(options.captureEventName || '$opt_in', options.captureProperties || {}, {
+            send_instantly: true,
+        });
+    }
+}
+export function userOptedOut(posthog, silenceErrors) {
+    var optedOut = false;
+    try {
+        var token = posthog.get_config('token');
+        var respectDnt = posthog.get_config('respect_dnt');
+        var persistenceType = posthog.get_config('opt_out_capturing_persistence_type');
+        var persistencePrefix = posthog.get_config('opt_out_capturing_cookie_prefix') || undefined;
+        var win = posthog.get_config('window'); // used to override window during browser tests
+        if (token) {
+            // if there was an issue getting the token, continue method execution as normal
+            optedOut = hasOptedOut(token, {
+                respectDnt: respectDnt,
+                persistenceType: persistenceType,
+                persistencePrefix: persistencePrefix,
+                window: win,
+            });
+        }
+    }
+    catch (err) {
+        if (!silenceErrors) {
+            console.error('Unexpected error when checking capturing opt-out status: ' + err);
+        }
+    }
+    return optedOut;
+}
+/**
+ * Wrap a method with a check for whether the user is opted out of data capturing and cookies/localstorage for the given token
+ * If the user has opted out, return early instead of executing the method.
+ * If a callback argument was provided, execute it passing the 0 error code.
+ * @param {PostHog} posthog - the posthog instance
+ * @param {function} method - wrapped method to be executed if the user has not opted out
+ * @param silenceErrors
+ * @returns {*} the result of executing method OR undefined if the user has opted out
+ */
+export function addOptOutCheck(posthog, method, silenceErrors) {
+    return function () {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        var optedOut = userOptedOut(posthog, silenceErrors);
+        if (!optedOut) {
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            return method.apply(this, args);
+        }
+        var callback = args[args.length - 1];
+        if (typeof callback === 'function') {
+            callback(0);
+        }
+        return;
+    };
+}
+//# sourceMappingURL=gdpr-utils.js.map

package/lib/src/gdpr-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gdpr-utils.js","sourceRoot":"","sources":["../../src/gdpr-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACxE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA;AAIzE;;;;;;GAMG;AAEH,cAAc;AAEd,IAAM,+BAA+B,GAAG,kBAAkB,CAAA;AAE1D;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,KAAK,CAAC,KAAa,EAAE,OAAoB;IACrD,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM,CAAC,KAAa,EAAE,OAAoB;IACtD,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa,EAAE,OAAoB;IAC1D,OAAO,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,CAAA;AACnD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,OAA6B;IACpE,IAAI,oBAAoB,CAAC,OAAO,CAAC,EAAE;QAC/B,OAAO,IAAI,CAAA;KACd;IACD,OAAO,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,CAAA;AACnD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa,EAAE,OAAoB;IAC7D,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;IACvB,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;AAC/F,CAAC;AAED,eAAe;AAEf;;;;;GAKG;AACH,SAAS,WAAW,CAAC,OAAoB;IACrC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;IACvB,IAAI,OAAO,CAAC,eAAe,KAAK,cAAc,EAAE;QAC5C,OAAO,UAAU,CAAA;KACpB;IACD,IAAI,OAAO,CAAC,eAAe,KAAK,qBAAqB,EAAE;QACnD,OAAO,oBAAoB,CAAA;KAC9B;IACD,OAAO,WAAW,CAAA;AACtB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,KAAa,EAAE,OAAoB;IACvD,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;IACvB,OAAO,CAAC,OAAO,CAAC,iBAAiB,IAAI,+BAA+B,CAAC,GAAG,KAAK,CAAA;AACjF,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAa,EAAE,OAAoB;IACzD,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AACnE,CAAC;AAED;;;;;;GAMG;AACH,SAAS,oBAAoB,CAAC,OAAoB;IAC9C,IAAI,OAAO,IAAI,OAAO,CAAC,UAAU,EAAE;QAC/B,IAAM,GAAG,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAA;QACjD,IAAM,GAAG,GAAG,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,CAAA;QAClC,IAAI,UAAQ,GAAG,KAAK,CAAA;QACpB,KAAK,CACD;YACI,GAAG,CAAC,YAAY,CAAC;YAChB,GAAW,CAAC,cAAc,CAAC;YAC3B,GAAW,CAAC,YAAY,CAAC;SAC7B,EACD,UAAU,QAAQ;YACd,IAAI,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,EAAE;gBAC5C,UAAQ,GAAG,IAAI,CAAA;aAClB;QACL,CAAC,CACJ,CAAA;QACD,OAAO,UAAQ,CAAA;KAClB;IACD,OAAO,KAAK,CAAA;AAChB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,SAAS,CAAC,QAAiB,EAAE,KAAa,EAAE,OAAoB;IACrE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;QACpC,OAAO,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,+BAA+B,CAAC,CAAA;QAC1F,OAAM;KACT;IAED,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;IAEvB,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,CACpB,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,EAC9B,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAChB,SAAS,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,EACrE,OAAO,CAAC,oBAAoB,EAC5B,OAAO,CAAC,YAAY,CACvB,CAAA;IAED,IAAI,OAAO,CAAC,OAAO,IAAI,QAAQ,EAAE;QAC7B,kDAAkD;QAClD,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,IAAI,SAAS,EAAE,OAAO,CAAC,iBAAiB,IAAI,EAAE,EAAE;YACpF,cAAc,EAAE,IAAI;SACvB,CAAC,CAAA;KACL;AACL,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,OAAgB,EAAE,aAAkC;IAC7E,IAAI,QAAQ,GAAG,KAAK,CAAA;IAEpB,IAAI;QACA,IAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QACzC,IAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;QACpD,IAAM,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,oCAAoC,CAAC,CAAA;QAChF,IAAM,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,iCAAiC,CAAC,IAAI,SAAS,CAAA;QAC5F,IAAM,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,QAAe,CAAuB,CAAA,CAAC,+CAA+C;QAErH,IAAI,KAAK,EAAE;YACP,+EAA+E;YAC/E,QAAQ,GAAG,WAAW,CAAC,KAAK,EAAE;gBAC1B,UAAU,YAAA;gBACV,eAAe,iBAAA;gBACf,iBAAiB,mBAAA;gBACjB,MAAM,EAAE,GAAG;aACd,CAAC,CAAA;SACL;KACJ;IAAC,OAAO,GAAG,EAAE;QACV,IAAI,CAAC,aAAa,EAAE;YAChB,OAAO,CAAC,KAAK,CAAC,2DAA2D,GAAG,GAAG,CAAC,CAAA;SACnF;KACJ;IACD,OAAO,QAAQ,CAAA;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAC1B,OAAgB,EAChB,MAAS,EACT,aAAuB;IAEvB,OAAO;QAAU,cAAO;aAAP,UAAO,EAAP,qBAAO,EAAP,IAAO;YAAP,yBAAO;;QACpB,IAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;QAErD,IAAI,CAAC,QAAQ,EAAE;YACX,6DAA6D;YAC7D,aAAa;YACb,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;SAClC;QAED,IAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACtC,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;YAChC,QAAQ,CAAC,CAAC,CAAC,CAAA;SACd;QAED,OAAM;IACV,CAAM,CAAA;AACV,CAAC","sourcesContent":["/**\n * GDPR utils\n *\n * The General Data Protection Regulation (GDPR) is a regulation in EU law on data protection\n * and privacy for all individuals within the European Union. It addresses the export of personal\n * data outside the EU. The GDPR aims primarily to give control back to citizens and residents\n * over their personal data and to simplify the regulatory environment for international business\n * by unifying the regulation within the EU.\n *\n * This set of utilities is intended to enable opt in/out functionality in the PostHog JS SDK.\n * These functions are used internally by the SDK and are not intended to be publicly exposed.\n */\n\nimport { _each, _includes, _isNumber, _isString, window } from './utils'\nimport { cookieStore, localStore, localPlusCookieStore } from './storage'\nimport { GDPROptions, PersistentStore } from './types'\nimport { PostHog } from './posthog-core'\n\n/**\n * A function used to capture a PostHog event (e.g. PostHogLib.capture)\n * @callback captureFunction\n * @param {String} event_name The name of the event. This can be anything the user does - 'Button Click', 'Sign Up', 'Item Purchased', etc.\n * @param {Object} [properties] A set of properties to include with the event you're sending. These describe the user who did the event or details about the event itself.\n * @param {Function} [callback] If provided, the callback function will be called after capturing the event.\n */\n\n/** Public **/\n\nconst GDPR_DEFAULT_PERSISTENCE_PREFIX = '__ph_opt_in_out_'\n\n/**\n * Opt the user in to data capturing and cookies/localstorage for the given token\n * @param {string} token - PostHog project capturing token\n * @param {Object} [options]\n * @param {captureFunction} [options.capture] - function used for capturing a PostHog event to record the opt-in action\n * @param {string} [options.captureEventName] - event name to be used for capturing the opt-in action\n * @param {Object} [options.captureProperties] - set of properties to be captured along with the opt-in action\n * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage\n * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name\n * @param {Number} [options.cookieExpiration] - number of days until the opt-in cookie expires\n * @param {boolean} [options.crossSubdomainCookie] - whether the opt-in cookie is set as cross-subdomain or not\n * @param {boolean} [options.secureCookie] - whether the opt-in cookie is set as secure or not\n */\nexport function optIn(token: string, options: GDPROptions): void {\n    _optInOut(true, token, options)\n}\n\n/**\n * Opt the user out of data capturing and cookies/localstorage for the given token\n * @param {string} token - PostHog project capturing token\n * @param {Object} [options]\n * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage\n * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name\n * @param {Number} [options.cookieExpiration] - number of days until the opt-out cookie expires\n * @param {boolean} [options.crossSubdomainCookie] - whether the opt-out cookie is set as cross-subdomain or not\n * @param {boolean} [options.secureCookie] - whether the opt-out cookie is set as secure or not\n */\nexport function optOut(token: string, options: GDPROptions): void {\n    _optInOut(false, token, options)\n}\n\n/**\n * Check whether the user has opted in to data capturing and cookies/localstorage for the given token\n * @param {string} token - PostHog project capturing token\n * @param {Object} [options]\n * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage\n * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name\n * @returns {boolean} whether the user has opted in to the given opt type\n */\nexport function hasOptedIn(token: string, options: GDPROptions): boolean {\n    return _getStorageValue(token, options) === '1'\n}\n\n/**\n * Check whether the user has opted out of data capturing and cookies/localstorage for the given token\n * @param {string} token - PostHog project capturing token\n * @param {Object} [options]\n * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage\n * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name\n * @param {boolean} [options.respectDnt] - flag to take browser DNT setting into account\n * @returns {boolean} whether the user has opted out of the given opt type\n */\nexport function hasOptedOut(token: string, options: Partial<GDPROptions>): boolean {\n    if (_hasDoNotTrackFlagOn(options)) {\n        return true\n    }\n    return _getStorageValue(token, options) === '0'\n}\n\n/**\n * Clear the user's opt in/out status of data capturing and cookies/localstorage for the given token\n * @param {string} token - PostHog project capturing token\n * @param {Object} [options]\n * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage\n * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name\n * @param {Number} [options.cookieExpiration] - number of days until the opt-in cookie expires\n * @param {boolean} [options.crossSubdomainCookie] - whether the opt-in cookie is set as cross-subdomain or not\n * @param {boolean} [options.secureCookie] - whether the opt-in cookie is set as secure or not\n */\nexport function clearOptInOut(token: string, options: GDPROptions) {\n    options = options || {}\n    _getStorage(options).remove(_getStorageKey(token, options), !!options.crossSubdomainCookie)\n}\n\n/** Private **/\n\n/**\n * Get storage util\n * @param {Object} [options]\n * @param {string} [options.persistenceType]\n * @returns {object} either cookieStore or localStore\n */\nfunction _getStorage(options: GDPROptions): PersistentStore {\n    options = options || {}\n    if (options.persistenceType === 'localStorage') {\n        return localStore\n    }\n    if (options.persistenceType === 'localStorage+cookie') {\n        return localPlusCookieStore\n    }\n    return cookieStore\n}\n\n/**\n * Get the name of the cookie that is used for the given opt type (capturing, cookie, etc.)\n * @param {string} token - PostHog project capturing token\n * @param {Object} [options]\n * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name\n * @returns {string} the name of the cookie for the given opt type\n */\nfunction _getStorageKey(token: string, options: GDPROptions) {\n    options = options || {}\n    return (options.persistencePrefix || GDPR_DEFAULT_PERSISTENCE_PREFIX) + token\n}\n\n/**\n * Get the value of the cookie that is used for the given opt type (capturing, cookie, etc.)\n * @param {string} token - PostHog project capturing token\n * @param {Object} [options]\n * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name\n * @returns {string} the value of the cookie for the given opt type\n */\nfunction _getStorageValue(token: string, options: GDPROptions) {\n    return _getStorage(options).get(_getStorageKey(token, options))\n}\n\n/**\n * Check whether the user has set the DNT/doNotTrack setting to true in their browser\n * @param {Object} [options]\n * @param {string} [options.window] - alternate window object to check; used to force various DNT settings in browser tests\n * @param {boolean} [options.respectDnt] - flag to take browser DNT setting into account\n * @returns {boolean} whether the DNT setting is true\n */\nfunction _hasDoNotTrackFlagOn(options: GDPROptions) {\n    if (options && options.respectDnt) {\n        const win = (options && options.window) || window\n        const nav = win['navigator'] || {}\n        let hasDntOn = false\n        _each(\n            [\n                nav['doNotTrack'], // standard\n                (nav as any)['msDoNotTrack'],\n                (win as any)['doNotTrack'],\n            ],\n            function (dntValue) {\n                if (_includes([true, 1, '1', 'yes'], dntValue)) {\n                    hasDntOn = true\n                }\n            }\n        )\n        return hasDntOn\n    }\n    return false\n}\n\n/**\n * Set cookie/localstorage for the user indicating that they are opted in or out for the given opt type\n * @param {boolean} optValue - whether to opt the user in or out for the given opt type\n * @param {string} token - PostHog project capturing token\n * @param {Object} [options]\n * @param {captureFunction} [options.capture] - function used for capturing a PostHog event to record the opt-in action\n * @param {string} [options.captureEventName] - event name to be used for capturing the opt-in action\n * @param {Object} [options.captureProperties] - set of properties to be captured along with the opt-in action\n * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name\n * @param {Number} [options.cookieExpiration] - number of days until the opt-in cookie expires\n * @param {boolean} [options.crossSubdomainCookie] - whether the opt-in cookie is set as cross-subdomain or not\n * @param {boolean} [options.secureCookie] - whether the opt-in cookie is set as secure or not\n */\nfunction _optInOut(optValue: boolean, token: string, options: GDPROptions) {\n    if (!_isString(token) || !token.length) {\n        console.error('gdpr.' + (optValue ? 'optIn' : 'optOut') + ' called with an invalid token')\n        return\n    }\n\n    options = options || {}\n\n    _getStorage(options).set(\n        _getStorageKey(token, options),\n        optValue ? 1 : 0,\n        _isNumber(options.cookieExpiration) ? options.cookieExpiration : null,\n        options.crossSubdomainCookie,\n        options.secureCookie\n    )\n\n    if (options.capture && optValue) {\n        // only capture event if opting in (optValue=true)\n        options.capture(options.captureEventName || '$opt_in', options.captureProperties || {}, {\n            send_instantly: true,\n        })\n    }\n}\n\nexport function userOptedOut(posthog: PostHog, silenceErrors: boolean | undefined) {\n    let optedOut = false\n\n    try {\n        const token = posthog.get_config('token')\n        const respectDnt = posthog.get_config('respect_dnt')\n        const persistenceType = posthog.get_config('opt_out_capturing_persistence_type')\n        const persistencePrefix = posthog.get_config('opt_out_capturing_cookie_prefix') || undefined\n        const win = posthog.get_config('window' as any) as Window | undefined // used to override window during browser tests\n\n        if (token) {\n            // if there was an issue getting the token, continue method execution as normal\n            optedOut = hasOptedOut(token, {\n                respectDnt,\n                persistenceType,\n                persistencePrefix,\n                window: win,\n            })\n        }\n    } catch (err) {\n        if (!silenceErrors) {\n            console.error('Unexpected error when checking capturing opt-out status: ' + err)\n        }\n    }\n    return optedOut\n}\n\n/**\n * Wrap a method with a check for whether the user is opted out of data capturing and cookies/localstorage for the given token\n * If the user has opted out, return early instead of executing the method.\n * If a callback argument was provided, execute it passing the 0 error code.\n * @param {PostHog} posthog - the posthog instance\n * @param {function} method - wrapped method to be executed if the user has not opted out\n * @param silenceErrors\n * @returns {*} the result of executing method OR undefined if the user has opted out\n */\nexport function addOptOutCheck<M extends (...args: any[]) => any = (...args: any[]) => any>(\n    posthog: PostHog,\n    method: M,\n    silenceErrors?: boolean\n): M {\n    return function (...args) {\n        const optedOut = userOptedOut(posthog, silenceErrors)\n\n        if (!optedOut) {\n            // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n            // @ts-ignore\n            return method.apply(this, args)\n        }\n\n        const callback = args[args.length - 1]\n        if (typeof callback === 'function') {\n            callback(0)\n        }\n\n        return\n    } as M\n}\n"]}

package/lib/src/loader-globals-full.d.ts

@@ -0,0 +1 @@
+import './loader-recorder';

package/lib/src/loader-globals-full.js

@@ -0,0 +1,5 @@
+// Same as loader-globals.ts except includes rrweb scripts.
+import './loader-recorder';
+import { init_from_snippet } from './posthog-core';
+init_from_snippet();
+//# sourceMappingURL=loader-globals-full.js.map

package/lib/src/loader-globals-full.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader-globals-full.js","sourceRoot":"","sources":["../../src/loader-globals-full.ts"],"names":[],"mappings":"AAAA,2DAA2D;AAE3D,OAAO,mBAAmB,CAAA;AAC1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAElD,iBAAiB,EAAE,CAAA","sourcesContent":["// Same as loader-globals.ts except includes rrweb scripts.\n\nimport './loader-recorder'\nimport { init_from_snippet } from './posthog-core'\n\ninit_from_snippet()\n"]}

package/lib/src/loader-globals.d.ts

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

package/lib/src/loader-globals.js

@@ -0,0 +1,3 @@
+import { init_from_snippet } from './posthog-core';
+init_from_snippet();
+//# sourceMappingURL=loader-globals.js.map

package/lib/src/loader-globals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader-globals.js","sourceRoot":"","sources":["../../src/loader-globals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAElD,iBAAiB,EAAE,CAAA","sourcesContent":["import { init_from_snippet } from './posthog-core'\n\ninit_from_snippet()\n"]}

package/lib/src/loader-module.d.ts

@@ -0,0 +1,4 @@
+export { PostHog } from './posthog-core';
+export * from './types';
+export declare const posthog: import("./posthog-core").PostHog;
+export default posthog;

package/lib/src/loader-module.js

@@ -0,0 +1,6 @@
+import { init_as_module } from './posthog-core';
+export { PostHog } from './posthog-core';
+export * from './types';
+export var posthog = init_as_module();
+export default posthog;
+//# sourceMappingURL=loader-module.js.map

package/lib/src/loader-module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader-module.js","sourceRoot":"","sources":["../../src/loader-module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AACxC,cAAc,SAAS,CAAA;AACvB,MAAM,CAAC,IAAM,OAAO,GAAG,cAAc,EAAE,CAAA;AACvC,eAAe,OAAO,CAAA","sourcesContent":["import { init_as_module } from './posthog-core'\nexport { PostHog } from './posthog-core'\nexport * from './types'\nexport const posthog = init_as_module()\nexport default posthog\n"]}

package/lib/src/loader-recorder-v2.d.ts

@@ -0,0 +1,2 @@
+import rrwebRecord from 'rrweb/es/rrweb/packages/rrweb/src/record';
+export default rrwebRecord;

package/lib/src/loader-recorder-v2.js

@@ -0,0 +1,15 @@
+import { version } from 'rrweb/package.json';
+// Same as loader-globals.ts except includes rrweb2 scripts.
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import rrwebRecord from 'rrweb/es/rrweb/packages/rrweb/src/record';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import { getRecordConsolePlugin } from 'rrweb/es/rrweb/packages/rrweb/src/plugins/console/record';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+var win = typeof window !== 'undefined' ? window : {};
+win.rrweb = { record: rrwebRecord, version: 'v2', rrwebVersion: version };
+win.rrwebConsoleRecord = { getRecordConsolePlugin: getRecordConsolePlugin };
+export default rrwebRecord;
+//# sourceMappingURL=loader-recorder-v2.js.map

package/lib/src/loader-recorder-v2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader-recorder-v2.js","sourceRoot":"","sources":["../../src/loader-recorder-v2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAE5C,4DAA4D;AAC5D,6DAA6D;AAC7D,aAAa;AACb,OAAO,WAAW,MAAM,0CAA0C,CAAA;AAClE,6DAA6D;AAC7D,aAAa;AACb,OAAO,EAAE,sBAAsB,EAAE,MAAM,0DAA0D,CAAA;AACjG,6DAA6D;AAC7D,aAAa;AAEb,IAAM,GAAG,GAA+B,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,EAAoB,CAErG;AAAC,GAAW,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,CAClF;AAAC,GAAW,CAAC,kBAAkB,GAAG,EAAE,sBAAsB,wBAAA,EAAE,CAAA;AAE7D,eAAe,WAAW,CAAA","sourcesContent":["import { version } from 'rrweb/package.json'\n\n// Same as loader-globals.ts except includes rrweb2 scripts.\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\nimport rrwebRecord from 'rrweb/es/rrweb/packages/rrweb/src/record'\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\nimport { getRecordConsolePlugin } from 'rrweb/es/rrweb/packages/rrweb/src/plugins/console/record'\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\n\nconst win: Window & typeof globalThis = typeof window !== 'undefined' ? window : ({} as typeof window)\n\n;(win as any).rrweb = { record: rrwebRecord, version: 'v2', rrwebVersion: version }\n;(win as any).rrwebConsoleRecord = { getRecordConsolePlugin }\n\nexport default rrwebRecord\n"]}

package/lib/src/loader-recorder.d.ts

@@ -0,0 +1,2 @@
+import rrwebRecord from 'rrweb-v1/es/rrweb/packages/rrweb/src/record';
+export default rrwebRecord;

package/lib/src/loader-recorder.js

@@ -0,0 +1,15 @@
+import { version } from 'rrweb-v1/package.json';
+// Same as loader-globals.ts except includes rrweb scripts.
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import rrwebRecord from 'rrweb-v1/es/rrweb/packages/rrweb/src/record';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import { getRecordConsolePlugin } from 'rrweb-v1/es/rrweb/packages/rrweb/src/plugins/console/record';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+var win = typeof window !== 'undefined' ? window : {};
+win.rrweb = { record: rrwebRecord, version: 'v1', rrwebVersion: version };
+win.rrwebConsoleRecord = { getRecordConsolePlugin: getRecordConsolePlugin };
+export default rrwebRecord;
+//# sourceMappingURL=loader-recorder.js.map

package/lib/src/loader-recorder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader-recorder.js","sourceRoot":"","sources":["../../src/loader-recorder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAE/C,2DAA2D;AAC3D,6DAA6D;AAC7D,aAAa;AACb,OAAO,WAAW,MAAM,6CAA6C,CAAA;AACrE,6DAA6D;AAC7D,aAAa;AACb,OAAO,EAAE,sBAAsB,EAAE,MAAM,6DAA6D,CAAA;AACpG,6DAA6D;AAC7D,aAAa;AAEb,IAAM,GAAG,GAA+B,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,EAAoB,CAErG;AAAC,GAAW,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,CAClF;AAAC,GAAW,CAAC,kBAAkB,GAAG,EAAE,sBAAsB,wBAAA,EAAE,CAAA;AAE7D,eAAe,WAAW,CAAA","sourcesContent":["import { version } from 'rrweb-v1/package.json'\n\n// Same as loader-globals.ts except includes rrweb scripts.\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\nimport rrwebRecord from 'rrweb-v1/es/rrweb/packages/rrweb/src/record'\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\nimport { getRecordConsolePlugin } from 'rrweb-v1/es/rrweb/packages/rrweb/src/plugins/console/record'\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\n\nconst win: Window & typeof globalThis = typeof window !== 'undefined' ? window : ({} as typeof window)\n\n;(win as any).rrweb = { record: rrwebRecord, version: 'v1', rrwebVersion: version }\n;(win as any).rrwebConsoleRecord = { getRecordConsolePlugin }\n\nexport default rrwebRecord\n"]}

package/lib/src/page-view.d.ts

@@ -0,0 +1,38 @@
+interface PageViewData {
+    pathname: string;
+    maxScrollHeight?: number;
+    maxScrollY?: number;
+    lastScrollY?: number;
+    maxContentHeight?: number;
+    maxContentY?: number;
+    lastContentY?: number;
+}
+interface ScrollProperties {
+    $prev_pageview_last_scroll?: number;
+    $prev_pageview_last_scroll_percentage?: number;
+    $prev_pageview_max_scroll?: number;
+    $prev_pageview_max_scroll_percentage?: number;
+    $prev_pageview_last_content?: number;
+    $prev_pageview_last_content_percentage?: number;
+    $prev_pageview_max_content?: number;
+    $prev_pageview_max_content_percentage?: number;
+}
+interface PageViewEventProperties extends ScrollProperties {
+    $prev_pageview_pathname?: string;
+}
+export declare class PageViewManager {
+    _pageViewData: PageViewData | undefined;
+    _hasSeenPageView: boolean;
+    _createPageViewData(): PageViewData;
+    doPageView(): PageViewEventProperties;
+    doPageLeave(): PageViewEventProperties;
+    _calculatePrevPageScrollProperties(prevPageViewData: PageViewData | undefined): ScrollProperties;
+    _updateScrollData: () => void;
+    startMeasuringScrollPosition(): void;
+    stopMeasuringScrollPosition(): void;
+    _scrollHeight(): number;
+    _scrollY(): number;
+    _contentHeight(): number;
+    _contentY(): number;
+}
+export {};

package/lib/src/page-view.js

@@ -0,0 +1,127 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { window } from './utils';
+var PageViewManager = /** @class */ (function () {
+    function PageViewManager() {
+        var _this = this;
+        this._hasSeenPageView = false;
+        this._updateScrollData = function () {
+            var _a, _b, _c, _d;
+            if (!_this._pageViewData) {
+                _this._pageViewData = _this._createPageViewData();
+            }
+            var pageViewData = _this._pageViewData;
+            var scrollY = _this._scrollY();
+            var scrollHeight = _this._scrollHeight();
+            var contentY = _this._contentY();
+            var contentHeight = _this._contentHeight();
+            pageViewData.lastScrollY = scrollY;
+            pageViewData.maxScrollY = Math.max(scrollY, (_a = pageViewData.maxScrollY) !== null && _a !== void 0 ? _a : 0);
+            pageViewData.maxScrollHeight = Math.max(scrollHeight, (_b = pageViewData.maxScrollHeight) !== null && _b !== void 0 ? _b : 0);
+            pageViewData.lastContentY = contentY;
+            pageViewData.maxContentY = Math.max(contentY, (_c = pageViewData.maxContentY) !== null && _c !== void 0 ? _c : 0);
+            pageViewData.maxContentHeight = Math.max(contentHeight, (_d = pageViewData.maxContentHeight) !== null && _d !== void 0 ? _d : 0);
+        };
+    }
+    PageViewManager.prototype._createPageViewData = function () {
+        return {
+            pathname: window.location.pathname,
+        };
+    };
+    PageViewManager.prototype.doPageView = function () {
+        var prevPageViewData;
+        // if there were events created before the first PageView, we would have created a
+        // pageViewData for them. If this happened, we don't want to create a new pageViewData
+        if (!this._hasSeenPageView) {
+            this._hasSeenPageView = true;
+            prevPageViewData = undefined;
+            if (!this._pageViewData) {
+                this._pageViewData = this._createPageViewData();
+            }
+        }
+        else {
+            prevPageViewData = this._pageViewData;
+            this._pageViewData = this._createPageViewData();
+        }
+        // update the scroll properties for the new page, but wait until the next tick
+        // of the event loop
+        setTimeout(this._updateScrollData, 0);
+        return __assign({ $prev_pageview_pathname: prevPageViewData === null || prevPageViewData === void 0 ? void 0 : prevPageViewData.pathname }, this._calculatePrevPageScrollProperties(prevPageViewData));
+    };
+    PageViewManager.prototype.doPageLeave = function () {
+        var prevPageViewData = this._pageViewData;
+        return __assign({ $prev_pageview_pathname: prevPageViewData === null || prevPageViewData === void 0 ? void 0 : prevPageViewData.pathname }, this._calculatePrevPageScrollProperties(prevPageViewData));
+    };
+    PageViewManager.prototype._calculatePrevPageScrollProperties = function (prevPageViewData) {
+        if (!prevPageViewData ||
+            prevPageViewData.maxScrollHeight == null ||
+            prevPageViewData.lastScrollY == null ||
+            prevPageViewData.maxScrollY == null ||
+            prevPageViewData.maxContentHeight == null ||
+            prevPageViewData.lastContentY == null ||
+            prevPageViewData.maxContentY == null) {
+            return {};
+        }
+        var maxScrollHeight = prevPageViewData.maxScrollHeight, lastScrollY = prevPageViewData.lastScrollY, maxScrollY = prevPageViewData.maxScrollY, maxContentHeight = prevPageViewData.maxContentHeight, lastContentY = prevPageViewData.lastContentY, maxContentY = prevPageViewData.maxContentY;
+        // Use ceil, so that e.g. scrolling 999.5px of a 1000px page is considered 100% scrolled
+        maxScrollHeight = Math.ceil(maxScrollHeight);
+        lastScrollY = Math.ceil(lastScrollY);
+        maxScrollY = Math.ceil(maxScrollY);
+        maxContentHeight = Math.ceil(maxContentHeight);
+        lastContentY = Math.ceil(lastContentY);
+        maxContentY = Math.ceil(maxContentY);
+        // if the maximum scroll height is near 0, then the percentage is 1
+        var lastScrollPercentage = maxScrollHeight <= 1 ? 1 : clamp(lastScrollY / maxScrollHeight, 0, 1);
+        var maxScrollPercentage = maxScrollHeight <= 1 ? 1 : clamp(maxScrollY / maxScrollHeight, 0, 1);
+        var lastContentPercentage = maxContentHeight <= 1 ? 1 : clamp(lastContentY / maxContentHeight, 0, 1);
+        var maxContentPercentage = maxContentHeight <= 1 ? 1 : clamp(maxContentY / maxContentHeight, 0, 1);
+        return {
+            $prev_pageview_last_scroll: lastScrollY,
+            $prev_pageview_last_scroll_percentage: lastScrollPercentage,
+            $prev_pageview_max_scroll: maxScrollY,
+            $prev_pageview_max_scroll_percentage: maxScrollPercentage,
+            $prev_pageview_last_content: lastContentY,
+            $prev_pageview_last_content_percentage: lastContentPercentage,
+            $prev_pageview_max_content: maxContentY,
+            $prev_pageview_max_content_percentage: maxContentPercentage,
+        };
+    };
+    PageViewManager.prototype.startMeasuringScrollPosition = function () {
+        window.addEventListener('scroll', this._updateScrollData);
+        window.addEventListener('scrollend', this._updateScrollData);
+        window.addEventListener('resize', this._updateScrollData);
+    };
+    PageViewManager.prototype.stopMeasuringScrollPosition = function () {
+        window.removeEventListener('scroll', this._updateScrollData);
+        window.removeEventListener('scrollend', this._updateScrollData);
+        window.removeEventListener('resize', this._updateScrollData);
+    };
+    PageViewManager.prototype._scrollHeight = function () {
+        return Math.max(0, window.document.documentElement.scrollHeight - window.document.documentElement.clientHeight);
+    };
+    PageViewManager.prototype._scrollY = function () {
+        return window.scrollY || window.pageYOffset || window.document.documentElement.scrollTop || 0;
+    };
+    PageViewManager.prototype._contentHeight = function () {
+        return window.document.documentElement.scrollHeight || 0;
+    };
+    PageViewManager.prototype._contentY = function () {
+        var clientHeight = window.document.documentElement.clientHeight || 0;
+        return this._scrollY() + clientHeight;
+    };
+    return PageViewManager;
+}());
+export { PageViewManager };
+function clamp(x, min, max) {
+    return Math.max(min, Math.min(x, max));
+}
+//# sourceMappingURL=page-view.js.map

package/lib/src/page-view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view.js","sourceRoot":"","sources":["../../src/page-view.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AA+BhC;IAAA;QAAA,iBAoIC;QAlIG,qBAAgB,GAAG,KAAK,CAAA;QAkFxB,sBAAiB,GAAG;;YAChB,IAAI,CAAC,KAAI,CAAC,aAAa,EAAE;gBACrB,KAAI,CAAC,aAAa,GAAG,KAAI,CAAC,mBAAmB,EAAE,CAAA;aAClD;YACD,IAAM,YAAY,GAAG,KAAI,CAAC,aAAa,CAAA;YAEvC,IAAM,OAAO,GAAG,KAAI,CAAC,QAAQ,EAAE,CAAA;YAC/B,IAAM,YAAY,GAAG,KAAI,CAAC,aAAa,EAAE,CAAA;YACzC,IAAM,QAAQ,GAAG,KAAI,CAAC,SAAS,EAAE,CAAA;YACjC,IAAM,aAAa,GAAG,KAAI,CAAC,cAAc,EAAE,CAAA;YAE3C,YAAY,CAAC,WAAW,GAAG,OAAO,CAAA;YAClC,YAAY,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,MAAA,YAAY,CAAC,UAAU,mCAAI,CAAC,CAAC,CAAA;YACzE,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,MAAA,YAAY,CAAC,eAAe,mCAAI,CAAC,CAAC,CAAA;YAExF,YAAY,CAAC,YAAY,GAAG,QAAQ,CAAA;YACpC,YAAY,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAA,YAAY,CAAC,WAAW,mCAAI,CAAC,CAAC,CAAA;YAC5E,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,MAAA,YAAY,CAAC,gBAAgB,mCAAI,CAAC,CAAC,CAAA;QAC/F,CAAC,CAAA;IA8BL,CAAC;IAhIG,6CAAmB,GAAnB;QACI,OAAO;YACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ;SACrC,CAAA;IACL,CAAC;IAED,oCAAU,GAAV;QACI,IAAI,gBAA0C,CAAA;QAC9C,kFAAkF;QAClF,sFAAsF;QACtF,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACxB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAA;YAC5B,gBAAgB,GAAG,SAAS,CAAA;YAC5B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;gBACrB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAA;aAClD;SACJ;aAAM;YACH,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAA;YACrC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAA;SAClD;QAED,8EAA8E;QAC9E,oBAAoB;QACpB,UAAU,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAA;QAErC,kBACI,uBAAuB,EAAE,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ,IAChD,IAAI,CAAC,kCAAkC,CAAC,gBAAgB,CAAC,EAC/D;IACL,CAAC;IAED,qCAAW,GAAX;QACI,IAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAA;QAC3C,kBACI,uBAAuB,EAAE,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ,IAChD,IAAI,CAAC,kCAAkC,CAAC,gBAAgB,CAAC,EAC/D;IACL,CAAC;IAED,4DAAkC,GAAlC,UAAmC,gBAA0C;QACzE,IACI,CAAC,gBAAgB;YACjB,gBAAgB,CAAC,eAAe,IAAI,IAAI;YACxC,gBAAgB,CAAC,WAAW,IAAI,IAAI;YACpC,gBAAgB,CAAC,UAAU,IAAI,IAAI;YACnC,gBAAgB,CAAC,gBAAgB,IAAI,IAAI;YACzC,gBAAgB,CAAC,YAAY,IAAI,IAAI;YACrC,gBAAgB,CAAC,WAAW,IAAI,IAAI,EACtC;YACE,OAAO,EAAE,CAAA;SACZ;QAEK,IAAA,eAAe,GAA2E,gBAAgB,gBAA3F,EAAE,WAAW,GAA8D,gBAAgB,YAA9E,EAAE,UAAU,GAAkD,gBAAgB,WAAlE,EAAE,gBAAgB,GAAgC,gBAAgB,iBAAhD,EAAE,YAAY,GAAkB,gBAAgB,aAAlC,EAAE,WAAW,GAAK,gBAAgB,YAArB,CAAqB;QAEhH,wFAAwF;QACxF,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QAC5C,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACpC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAClC,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAC9C,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACtC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAEpC,mEAAmE;QACnE,IAAM,oBAAoB,GAAG,eAAe,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,GAAG,eAAe,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAClG,IAAM,mBAAmB,GAAG,eAAe,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,GAAG,eAAe,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAChG,IAAM,qBAAqB,GAAG,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,GAAG,gBAAgB,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACtG,IAAM,oBAAoB,GAAG,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,GAAG,gBAAgB,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAEpG,OAAO;YACH,0BAA0B,EAAE,WAAW;YACvC,qCAAqC,EAAE,oBAAoB;YAC3D,yBAAyB,EAAE,UAAU;YACrC,oCAAoC,EAAE,mBAAmB;YACzD,2BAA2B,EAAE,YAAY;YACzC,sCAAsC,EAAE,qBAAqB;YAC7D,0BAA0B,EAAE,WAAW;YACvC,qCAAqC,EAAE,oBAAoB;SAC9D,CAAA;IACL,CAAC;IAsBD,sDAA4B,GAA5B;QACI,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;QACzD,MAAM,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;QAC5D,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAC7D,CAAC;IAED,qDAA2B,GAA3B;QACI,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;QAC5D,MAAM,CAAC,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;QAC/D,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAChE,CAAC;IAED,uCAAa,GAAb;QACI,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,CAAA;IACnH,CAAC;IAED,kCAAQ,GAAR;QACI,OAAO,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,SAAS,IAAI,CAAC,CAAA;IACjG,CAAC;IAED,wCAAc,GAAd;QACI,OAAO,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,YAAY,IAAI,CAAC,CAAA;IAC5D,CAAC;IAED,mCAAS,GAAT;QACI,IAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,YAAY,IAAI,CAAC,CAAA;QACtE,OAAO,IAAI,CAAC,QAAQ,EAAE,GAAG,YAAY,CAAA;IACzC,CAAC;IACL,sBAAC;AAAD,CAAC,AApID,IAoIC;;AAED,SAAS,KAAK,CAAC,CAAS,EAAE,GAAW,EAAE,GAAW;IAC9C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAA;AAC1C,CAAC","sourcesContent":["import { window } from './utils'\n\ninterface PageViewData {\n    pathname: string\n    // scroll is how far down the page the user has scrolled,\n    // content is how far down the page the user can view content\n    // (e.g. if the page is 1000 tall, but the user's screen is only 500 tall,\n    // and they don't scroll at all, then scroll is 0 and content is 500)\n    maxScrollHeight?: number\n    maxScrollY?: number\n    lastScrollY?: number\n    maxContentHeight?: number\n    maxContentY?: number\n    lastContentY?: number\n}\n\ninterface ScrollProperties {\n    $prev_pageview_last_scroll?: number\n    $prev_pageview_last_scroll_percentage?: number\n    $prev_pageview_max_scroll?: number\n    $prev_pageview_max_scroll_percentage?: number\n    $prev_pageview_last_content?: number\n    $prev_pageview_last_content_percentage?: number\n    $prev_pageview_max_content?: number\n    $prev_pageview_max_content_percentage?: number\n}\n\ninterface PageViewEventProperties extends ScrollProperties {\n    $prev_pageview_pathname?: string\n}\n\nexport class PageViewManager {\n    _pageViewData: PageViewData | undefined\n    _hasSeenPageView = false\n\n    _createPageViewData(): PageViewData {\n        return {\n            pathname: window.location.pathname,\n        }\n    }\n\n    doPageView(): PageViewEventProperties {\n        let prevPageViewData: PageViewData | undefined\n        // if there were events created before the first PageView, we would have created a\n        // pageViewData for them. If this happened, we don't want to create a new pageViewData\n        if (!this._hasSeenPageView) {\n            this._hasSeenPageView = true\n            prevPageViewData = undefined\n            if (!this._pageViewData) {\n                this._pageViewData = this._createPageViewData()\n            }\n        } else {\n            prevPageViewData = this._pageViewData\n            this._pageViewData = this._createPageViewData()\n        }\n\n        // update the scroll properties for the new page, but wait until the next tick\n        // of the event loop\n        setTimeout(this._updateScrollData, 0)\n\n        return {\n            $prev_pageview_pathname: prevPageViewData?.pathname,\n            ...this._calculatePrevPageScrollProperties(prevPageViewData),\n        }\n    }\n\n    doPageLeave(): PageViewEventProperties {\n        const prevPageViewData = this._pageViewData\n        return {\n            $prev_pageview_pathname: prevPageViewData?.pathname,\n            ...this._calculatePrevPageScrollProperties(prevPageViewData),\n        }\n    }\n\n    _calculatePrevPageScrollProperties(prevPageViewData: PageViewData | undefined): ScrollProperties {\n        if (\n            !prevPageViewData ||\n            prevPageViewData.maxScrollHeight == null ||\n            prevPageViewData.lastScrollY == null ||\n            prevPageViewData.maxScrollY == null ||\n            prevPageViewData.maxContentHeight == null ||\n            prevPageViewData.lastContentY == null ||\n            prevPageViewData.maxContentY == null\n        ) {\n            return {}\n        }\n\n        let { maxScrollHeight, lastScrollY, maxScrollY, maxContentHeight, lastContentY, maxContentY } = prevPageViewData\n\n        // Use ceil, so that e.g. scrolling 999.5px of a 1000px page is considered 100% scrolled\n        maxScrollHeight = Math.ceil(maxScrollHeight)\n        lastScrollY = Math.ceil(lastScrollY)\n        maxScrollY = Math.ceil(maxScrollY)\n        maxContentHeight = Math.ceil(maxContentHeight)\n        lastContentY = Math.ceil(lastContentY)\n        maxContentY = Math.ceil(maxContentY)\n\n        // if the maximum scroll height is near 0, then the percentage is 1\n        const lastScrollPercentage = maxScrollHeight <= 1 ? 1 : clamp(lastScrollY / maxScrollHeight, 0, 1)\n        const maxScrollPercentage = maxScrollHeight <= 1 ? 1 : clamp(maxScrollY / maxScrollHeight, 0, 1)\n        const lastContentPercentage = maxContentHeight <= 1 ? 1 : clamp(lastContentY / maxContentHeight, 0, 1)\n        const maxContentPercentage = maxContentHeight <= 1 ? 1 : clamp(maxContentY / maxContentHeight, 0, 1)\n\n        return {\n            $prev_pageview_last_scroll: lastScrollY,\n            $prev_pageview_last_scroll_percentage: lastScrollPercentage,\n            $prev_pageview_max_scroll: maxScrollY,\n            $prev_pageview_max_scroll_percentage: maxScrollPercentage,\n            $prev_pageview_last_content: lastContentY,\n            $prev_pageview_last_content_percentage: lastContentPercentage,\n            $prev_pageview_max_content: maxContentY,\n            $prev_pageview_max_content_percentage: maxContentPercentage,\n        }\n    }\n\n    _updateScrollData = () => {\n        if (!this._pageViewData) {\n            this._pageViewData = this._createPageViewData()\n        }\n        const pageViewData = this._pageViewData\n\n        const scrollY = this._scrollY()\n        const scrollHeight = this._scrollHeight()\n        const contentY = this._contentY()\n        const contentHeight = this._contentHeight()\n\n        pageViewData.lastScrollY = scrollY\n        pageViewData.maxScrollY = Math.max(scrollY, pageViewData.maxScrollY ?? 0)\n        pageViewData.maxScrollHeight = Math.max(scrollHeight, pageViewData.maxScrollHeight ?? 0)\n\n        pageViewData.lastContentY = contentY\n        pageViewData.maxContentY = Math.max(contentY, pageViewData.maxContentY ?? 0)\n        pageViewData.maxContentHeight = Math.max(contentHeight, pageViewData.maxContentHeight ?? 0)\n    }\n\n    startMeasuringScrollPosition() {\n        window.addEventListener('scroll', this._updateScrollData)\n        window.addEventListener('scrollend', this._updateScrollData)\n        window.addEventListener('resize', this._updateScrollData)\n    }\n\n    stopMeasuringScrollPosition() {\n        window.removeEventListener('scroll', this._updateScrollData)\n        window.removeEventListener('scrollend', this._updateScrollData)\n        window.removeEventListener('resize', this._updateScrollData)\n    }\n\n    _scrollHeight(): number {\n        return Math.max(0, window.document.documentElement.scrollHeight - window.document.documentElement.clientHeight)\n    }\n\n    _scrollY(): number {\n        return window.scrollY || window.pageYOffset || window.document.documentElement.scrollTop || 0\n    }\n\n    _contentHeight(): number {\n        return window.document.documentElement.scrollHeight || 0\n    }\n\n    _contentY(): number {\n        const clientHeight = window.document.documentElement.clientHeight || 0\n        return this._scrollY() + clientHeight\n    }\n}\n\nfunction clamp(x: number, min: number, max: number) {\n    return Math.max(min, Math.min(x, max))\n}\n"]}