mixpanel-browser 2.48.0 → 2.49.0

package/dist/mixpanel.cjs.js

@@ -2,7 +2,7 @@
 
 var Config = {
     DEBUG: false,
-    LIB_VERSION: '2.48.0'
+    LIB_VERSION: '2.49.0'
 };
 
 // since es6 imports are static and we run unit tests from the console, window won't be defined when importing this file
@@ -901,6 +901,7 @@ _.UUID = (function() {
 // sending false tracking data
 var BLOCKED_UA_STRS = [
     'ahrefsbot',
+    'ahrefssiteaudit',
     'baiduspider',
     'bingbot',
     'bingpreview',
@@ -1621,7 +1622,14 @@ _.info = {
         return '';
     },
 
-    properties: function() {
+    currentUrl: function() {
+        return window$1.location.href;
+    },
+
+    properties: function(extra_props) {
+        if (typeof extra_props !== 'object') {
+            extra_props = {};
+        }
         return _.extend(_.strip_empty_properties({
             '$os': _.info.os(),
             '$browser': _.info.browser(userAgent, navigator.vendor, windowOpera),
@@ -1629,7 +1637,7 @@ _.info = {
             '$referring_domain': _.info.referringDomain(document$1.referrer),
             '$device': _.info.device(userAgent)
         }), {
-            '$current_url': window$1.location.href,
+            '$current_url': _.info.currentUrl(),
             '$browser_version': _.info.browserVersion(userAgent, navigator.vendor, windowOpera),
             '$screen_height': screen.height,
             '$screen_width': screen.width,
@@ -1637,7 +1645,7 @@ _.info = {
             '$lib_version': Config.LIB_VERSION,
             '$insert_id': cheap_guid(),
             'time': _.timestamp() / 1000 // epoch time in seconds
-        });
+        }, _.strip_empty_properties(extra_props));
     },
 
     people_properties: function() {
@@ -3203,7 +3211,6 @@ MixpanelPeople.prototype.set = addOptOutCheckMixpanelPeople(function(prop, to, c
     data[SET_ACTION] = _.extend(
         {},
         _.info.people_properties(),
-        this._mixpanel['persistence'].get_referrer_info(),
         data[SET_ACTION]
     );
     return this._send_request(data, callback);
@@ -4163,10 +4170,12 @@ var DEFAULT_CONFIG = {
     'cookie_domain':                     '',
     'cookie_name':                       '',
     'loaded':                            NOOP_FUNC,
+    'mp_loader':                         null,
     'track_marketing':                   true,
     'track_pageview':                    false,
     'skip_first_touch_marketing':        false,
     'store_google':                      true,
+    'stop_utm_persistence':              false,
     'save_referrer':                     true,
     'test':                              false,
     'verbose':                           false,
@@ -4400,8 +4409,9 @@ MixpanelLib.prototype._init = function(token, config, name) {
         }, '');
     }
 
-    if (this.get_config('track_pageview')) {
-        this.track_pageview();
+    var track_pageview_option = this.get_config('track_pageview');
+    if (track_pageview_option) {
+        this._init_url_change_tracking(track_pageview_option);
     }
 };
 
@@ -4410,13 +4420,26 @@ MixpanelLib.prototype._init = function(token, config, name) {
 MixpanelLib.prototype._loaded = function() {
     this.get_config('loaded')(this);
     this._set_default_superprops();
+    this['people'].set_once(this['persistence'].get_referrer_info());
+
+    // The original 'store_google' functionality will be deprecated and the config will be
+    // used to clear previously managed UTM parameters from persistence.
+    // stop_utm_persistence is `false` by default now but will be default `true` in the future.
+    if (this.get_config('store_google') && this.get_config('stop_utm_persistence')) {
+        var utm_params = _.info.campaignParams(null);
+        _.each(utm_params, function(_utm_value, utm_key) {
+            // We need to unregister persisted UTM parameters so old values
+            // are not mixed with the new UTM parameters
+            this.unregister(utm_key);
+        }.bind(this));
+    }
 };
 
 // update persistence with info on referrer, UTM params, etc
 MixpanelLib.prototype._set_default_superprops = function() {
     this['persistence'].update_search_keyword(document$1.referrer);
-    if (this.get_config('store_google')) {
-        this.register(_.info.campaignParams(), {persistent: false});
+    if (this.get_config('store_google') && !this.get_config('stop_utm_persistence')) {
+        this.register(_.info.campaignParams());
     }
     if (this.get_config('save_referrer')) {
         this['persistence'].update_referrer_info(document$1.referrer);
@@ -4453,6 +4476,55 @@ MixpanelLib.prototype._track_dom = function(DomClass, args) {
     return dt.track.apply(dt, args);
 };
 
+MixpanelLib.prototype._init_url_change_tracking = function(track_pageview_option) {
+    var previous_tracked_url = '';
+    var tracked = this.track_pageview();
+    if (tracked) {
+        previous_tracked_url = _.info.currentUrl();
+    }
+
+    if (_.include(['full-url', 'url-with-path-and-query-string', 'url-with-path'], track_pageview_option)) {
+        window$1.addEventListener('popstate', function() {
+            window$1.dispatchEvent(new Event('mp_locationchange'));
+        });
+        window$1.addEventListener('hashchange', function() {
+            window$1.dispatchEvent(new Event('mp_locationchange'));
+        });
+        var nativePushState = window$1.history.pushState;
+        if (typeof nativePushState === 'function') {
+            window$1.history.pushState = function(state, unused, url) {
+                nativePushState.call(window$1.history, state, unused, url);
+                window$1.dispatchEvent(new Event('mp_locationchange'));
+            };
+        }
+        var nativeReplaceState = window$1.history.replaceState;
+        if (typeof nativeReplaceState === 'function') {
+            window$1.history.replaceState = function(state, unused, url) {
+                nativeReplaceState.call(window$1.history, state, unused, url);
+                window$1.dispatchEvent(new Event('mp_locationchange'));
+            };
+        }
+        window$1.addEventListener('mp_locationchange', function() {
+            var current_url = _.info.currentUrl();
+            var should_track = false;
+            if (track_pageview_option === 'full-url') {
+                should_track = current_url !== previous_tracked_url;
+            } else if (track_pageview_option === 'url-with-path-and-query-string') {
+                should_track = current_url.split('#')[0] !== previous_tracked_url.split('#')[0];
+            } else if (track_pageview_option === 'url-with-path') {
+                should_track = current_url.split('#')[0].split('?')[0] !== previous_tracked_url.split('#')[0].split('?')[0];
+            }
+
+            if (should_track) {
+                var tracked = this.track_pageview();
+                if (tracked) {
+                    previous_tracked_url = current_url;
+                }
+            }
+        }.bind(this));
+    }
+};
+
 /**
  * _prepare_callback() should be called by callers of _send_request for use
  * as the callback argument.
@@ -4921,7 +4993,7 @@ MixpanelLib.prototype.track = addOptOutCheckMixpanelLib(function(event_name, pro
     // update properties with pageview info and super-properties
     properties = _.extend(
         {},
-        _.info.properties(),
+        _.info.properties({'mp_loader': this.get_config('mp_loader')}),
         marketing_properties,
         this['persistence'].properties(),
         this.unpersisted_superprops,
@@ -5085,10 +5157,9 @@ MixpanelLib.prototype.get_group = function (group_key, group_id) {
 
 /**
  * Track a default Mixpanel page view event, which includes extra default event properties to
- * improve page view data. The `config.track_pageview` option for <a href="#mixpanelinit">mixpanel.init()</a>
- * may be turned on for tracking page loads automatically.
+ * improve page view data.
  *
- * ### Usage
+ * ### Usage:
  *
  *     // track a default $mp_web_page_view event
  *     mixpanel.track_pageview();
@@ -5105,6 +5176,23 @@ MixpanelLib.prototype.get_group = function (group_key, group_id) {
  *     // views on different products or internal applications that are considered completely separate
  *     mixpanel.track_pageview({'page': 'customer-search'}, {'event_name': '[internal] Admin Page View'});
  *
+ * ### Notes:
+ *
+ * The `config.track_pageview` option for <a href="#mixpanelinit">mixpanel.init()</a>
+ * may be turned on for tracking page loads automatically.
+ *
+ *     // track only page loads
+ *     mixpanel.init(PROJECT_TOKEN, {track_pageview: true});
+ *
+ *     // track when the URL changes in any manner
+ *     mixpanel.init(PROJECT_TOKEN, {track_pageview: 'full-url'});
+ *
+ *     // track when the URL changes, ignoring any changes in the hash part
+ *     mixpanel.init(PROJECT_TOKEN, {track_pageview: 'url-with-path-and-query-string'});
+ *
+ *     // track when the path changes, ignoring any query parameter or hash changes
+ *     mixpanel.init(PROJECT_TOKEN, {track_pageview: 'url-with-path'});
+ *
  * @param {Object} [properties] An optional set of additional properties to send with the page view event
  * @param {Object} [options] Page view tracking options
  * @param {String} [options.event_name] - Alternate name for the tracking event
@@ -5855,7 +5943,7 @@ MixpanelLib.prototype._gdpr_call_func = function(func, options) {
 /**
  * Opt the user in to data tracking and cookies/localstorage for this Mixpanel instance
  *
- * ### Usage
+ * ### Usage:
  *
  *     // opt user in
  *     mixpanel.opt_in_tracking();
@@ -5895,7 +5983,7 @@ MixpanelLib.prototype.opt_in_tracking = function(options) {
 /**
  * Opt the user out of data tracking and cookies/localstorage for this Mixpanel instance
  *
- * ### Usage
+ * ### Usage:
  *
  *     // opt user out
  *     mixpanel.opt_out_tracking();
@@ -5936,7 +6024,7 @@ MixpanelLib.prototype.opt_out_tracking = function(options) {
 /**
  * Check whether the user has opted in to data tracking and cookies/localstorage for this Mixpanel instance
  *
- * ### Usage
+ * ### Usage:
  *
  *     var has_opted_in = mixpanel.has_opted_in_tracking();
  *     // use has_opted_in value
@@ -5953,7 +6041,7 @@ MixpanelLib.prototype.has_opted_in_tracking = function(options) {
 /**
  * Check whether the user has opted out of data tracking and cookies/localstorage for this Mixpanel instance
  *
- * ### Usage
+ * ### Usage:
  *
  *     var has_opted_out = mixpanel.has_opted_out_tracking();
  *     // use has_opted_out value
@@ -5970,7 +6058,7 @@ MixpanelLib.prototype.has_opted_out_tracking = function(options) {
 /**
  * Clear the user's opt in/out status of data tracking and cookies/localstorage for this Mixpanel instance
  *
- * ### Usage
+ * ### Usage:
  *
  *     // clear user's opt-in/out status
  *     mixpanel.clear_opt_in_out_tracking();

package/dist/mixpanel.globals.js

@@ -3,7 +3,7 @@
 
     var Config = {
         DEBUG: false,
-        LIB_VERSION: '2.48.0'
+        LIB_VERSION: '2.49.0'
     };
 
     // since es6 imports are static and we run unit tests from the console, window won't be defined when importing this file
@@ -902,6 +902,7 @@
     // sending false tracking data
     var BLOCKED_UA_STRS = [
         'ahrefsbot',
+        'ahrefssiteaudit',
         'baiduspider',
         'bingbot',
         'bingpreview',
@@ -1622,7 +1623,14 @@
             return '';
         },
 
-        properties: function() {
+        currentUrl: function() {
+            return window$1.location.href;
+        },
+
+        properties: function(extra_props) {
+            if (typeof extra_props !== 'object') {
+                extra_props = {};
+            }
             return _.extend(_.strip_empty_properties({
                 '$os': _.info.os(),
                 '$browser': _.info.browser(userAgent, navigator.vendor, windowOpera),
@@ -1630,7 +1638,7 @@
                 '$referring_domain': _.info.referringDomain(document$1.referrer),
                 '$device': _.info.device(userAgent)
             }), {
-                '$current_url': window$1.location.href,
+                '$current_url': _.info.currentUrl(),
                 '$browser_version': _.info.browserVersion(userAgent, navigator.vendor, windowOpera),
                 '$screen_height': screen.height,
                 '$screen_width': screen.width,
@@ -1638,7 +1646,7 @@
                 '$lib_version': Config.LIB_VERSION,
                 '$insert_id': cheap_guid(),
                 'time': _.timestamp() / 1000 // epoch time in seconds
-            });
+            }, _.strip_empty_properties(extra_props));
         },
 
         people_properties: function() {
@@ -3204,7 +3212,6 @@
         data[SET_ACTION] = _.extend(
             {},
             _.info.people_properties(),
-            this._mixpanel['persistence'].get_referrer_info(),
             data[SET_ACTION]
         );
         return this._send_request(data, callback);
@@ -4164,10 +4171,12 @@
         'cookie_domain':                     '',
         'cookie_name':                       '',
         'loaded':                            NOOP_FUNC,
+        'mp_loader':                         null,
         'track_marketing':                   true,
         'track_pageview':                    false,
         'skip_first_touch_marketing':        false,
         'store_google':                      true,
+        'stop_utm_persistence':              false,
         'save_referrer':                     true,
         'test':                              false,
         'verbose':                           false,
@@ -4401,8 +4410,9 @@
             }, '');
         }
 
-        if (this.get_config('track_pageview')) {
-            this.track_pageview();
+        var track_pageview_option = this.get_config('track_pageview');
+        if (track_pageview_option) {
+            this._init_url_change_tracking(track_pageview_option);
         }
     };
 
@@ -4411,13 +4421,26 @@
     MixpanelLib.prototype._loaded = function() {
         this.get_config('loaded')(this);
         this._set_default_superprops();
+        this['people'].set_once(this['persistence'].get_referrer_info());
+
+        // The original 'store_google' functionality will be deprecated and the config will be
+        // used to clear previously managed UTM parameters from persistence.
+        // stop_utm_persistence is `false` by default now but will be default `true` in the future.
+        if (this.get_config('store_google') && this.get_config('stop_utm_persistence')) {
+            var utm_params = _.info.campaignParams(null);
+            _.each(utm_params, function(_utm_value, utm_key) {
+                // We need to unregister persisted UTM parameters so old values
+                // are not mixed with the new UTM parameters
+                this.unregister(utm_key);
+            }.bind(this));
+        }
     };
 
     // update persistence with info on referrer, UTM params, etc
     MixpanelLib.prototype._set_default_superprops = function() {
         this['persistence'].update_search_keyword(document$1.referrer);
-        if (this.get_config('store_google')) {
-            this.register(_.info.campaignParams(), {persistent: false});
+        if (this.get_config('store_google') && !this.get_config('stop_utm_persistence')) {
+            this.register(_.info.campaignParams());
         }
         if (this.get_config('save_referrer')) {
             this['persistence'].update_referrer_info(document$1.referrer);
@@ -4454,6 +4477,55 @@
         return dt.track.apply(dt, args);
     };
 
+    MixpanelLib.prototype._init_url_change_tracking = function(track_pageview_option) {
+        var previous_tracked_url = '';
+        var tracked = this.track_pageview();
+        if (tracked) {
+            previous_tracked_url = _.info.currentUrl();
+        }
+
+        if (_.include(['full-url', 'url-with-path-and-query-string', 'url-with-path'], track_pageview_option)) {
+            window$1.addEventListener('popstate', function() {
+                window$1.dispatchEvent(new Event('mp_locationchange'));
+            });
+            window$1.addEventListener('hashchange', function() {
+                window$1.dispatchEvent(new Event('mp_locationchange'));
+            });
+            var nativePushState = window$1.history.pushState;
+            if (typeof nativePushState === 'function') {
+                window$1.history.pushState = function(state, unused, url) {
+                    nativePushState.call(window$1.history, state, unused, url);
+                    window$1.dispatchEvent(new Event('mp_locationchange'));
+                };
+            }
+            var nativeReplaceState = window$1.history.replaceState;
+            if (typeof nativeReplaceState === 'function') {
+                window$1.history.replaceState = function(state, unused, url) {
+                    nativeReplaceState.call(window$1.history, state, unused, url);
+                    window$1.dispatchEvent(new Event('mp_locationchange'));
+                };
+            }
+            window$1.addEventListener('mp_locationchange', function() {
+                var current_url = _.info.currentUrl();
+                var should_track = false;
+                if (track_pageview_option === 'full-url') {
+                    should_track = current_url !== previous_tracked_url;
+                } else if (track_pageview_option === 'url-with-path-and-query-string') {
+                    should_track = current_url.split('#')[0] !== previous_tracked_url.split('#')[0];
+                } else if (track_pageview_option === 'url-with-path') {
+                    should_track = current_url.split('#')[0].split('?')[0] !== previous_tracked_url.split('#')[0].split('?')[0];
+                }
+
+                if (should_track) {
+                    var tracked = this.track_pageview();
+                    if (tracked) {
+                        previous_tracked_url = current_url;
+                    }
+                }
+            }.bind(this));
+        }
+    };
+
     /**
      * _prepare_callback() should be called by callers of _send_request for use
      * as the callback argument.
@@ -4922,7 +4994,7 @@
         // update properties with pageview info and super-properties
         properties = _.extend(
             {},
-            _.info.properties(),
+            _.info.properties({'mp_loader': this.get_config('mp_loader')}),
             marketing_properties,
             this['persistence'].properties(),
             this.unpersisted_superprops,
@@ -5086,10 +5158,9 @@
 
     /**
      * Track a default Mixpanel page view event, which includes extra default event properties to
-     * improve page view data. The `config.track_pageview` option for <a href="#mixpanelinit">mixpanel.init()</a>
-     * may be turned on for tracking page loads automatically.
+     * improve page view data.
      *
-     * ### Usage
+     * ### Usage:
      *
      *     // track a default $mp_web_page_view event
      *     mixpanel.track_pageview();
@@ -5106,6 +5177,23 @@
      *     // views on different products or internal applications that are considered completely separate
      *     mixpanel.track_pageview({'page': 'customer-search'}, {'event_name': '[internal] Admin Page View'});
      *
+     * ### Notes:
+     *
+     * The `config.track_pageview` option for <a href="#mixpanelinit">mixpanel.init()</a>
+     * may be turned on for tracking page loads automatically.
+     *
+     *     // track only page loads
+     *     mixpanel.init(PROJECT_TOKEN, {track_pageview: true});
+     *
+     *     // track when the URL changes in any manner
+     *     mixpanel.init(PROJECT_TOKEN, {track_pageview: 'full-url'});
+     *
+     *     // track when the URL changes, ignoring any changes in the hash part
+     *     mixpanel.init(PROJECT_TOKEN, {track_pageview: 'url-with-path-and-query-string'});
+     *
+     *     // track when the path changes, ignoring any query parameter or hash changes
+     *     mixpanel.init(PROJECT_TOKEN, {track_pageview: 'url-with-path'});
+     *
      * @param {Object} [properties] An optional set of additional properties to send with the page view event
      * @param {Object} [options] Page view tracking options
      * @param {String} [options.event_name] - Alternate name for the tracking event
@@ -5856,7 +5944,7 @@
     /**
      * Opt the user in to data tracking and cookies/localstorage for this Mixpanel instance
      *
-     * ### Usage
+     * ### Usage:
      *
      *     // opt user in
      *     mixpanel.opt_in_tracking();
@@ -5896,7 +5984,7 @@
     /**
      * Opt the user out of data tracking and cookies/localstorage for this Mixpanel instance
      *
-     * ### Usage
+     * ### Usage:
      *
      *     // opt user out
      *     mixpanel.opt_out_tracking();
@@ -5937,7 +6025,7 @@
     /**
      * Check whether the user has opted in to data tracking and cookies/localstorage for this Mixpanel instance
      *
-     * ### Usage
+     * ### Usage:
      *
      *     var has_opted_in = mixpanel.has_opted_in_tracking();
      *     // use has_opted_in value
@@ -5954,7 +6042,7 @@
     /**
      * Check whether the user has opted out of data tracking and cookies/localstorage for this Mixpanel instance
      *
-     * ### Usage
+     * ### Usage:
      *
      *     var has_opted_out = mixpanel.has_opted_out_tracking();
      *     // use has_opted_out value
@@ -5971,7 +6059,7 @@
     /**
      * Clear the user's opt in/out status of data tracking and cookies/localstorage for this Mixpanel instance
      *
-     * ### Usage
+     * ### Usage:
      *
      *     // clear user's opt-in/out status
      *     mixpanel.clear_opt_in_out_tracking();