mixpanel-browser 2.48.0 → 2.49.0

package/.eslintignore

@@ -0,0 +1,2 @@
+src/loaders/mixpanel.js
+src/loaders/mixpanel-jslib-snippet.js

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+**2.49.0** (5 Feb 2024)
+- SPA support in pageview-tracking
+- Support for configurable UTM parameter persistence
+- Initial-referrer profile properties are now stored with `set_once` instead of `set`
+- Ignore AhrefsSiteAudit crawler
+
+**2.48.1** (14 Nov 2023)
+- UTM campaign properties will always be persisted super properties (fixes discrepancy between
+minified and unminified package)
+
 **2.48.0** (7 Nov 2023)
 - API endpoint routes can now be configured individually (i.e. rename /track, /engage, /groups)
 - Event properties object passed to mixpanel.track() will no longer be mutated

package/README.md

@@ -50,7 +50,7 @@ or
 
 2) Recompile the snippet with a custom `MIXPANEL_LIB_URL` using [Closure Compiler](https://developers.google.com/closure/compiler/):
 ```sh
-java -jar compiler.jar --js mixpanel-jslib-snippet.js --js_output_file mixpanel-jslib-snippet.min.js --compilation_level ADVANCED_OPTIMIZATIONS --define='MIXPANEL_LIB_URL="bower_components/mixpanel/mixpanel.js"'
+java -jar compiler.jar --js src/loaders/mixpanel-jslib-snippet.js --js_output_file mixpanel-jslib-snippet.min.js --compilation_level ADVANCED_OPTIMIZATIONS --define='MIXPANEL_LIB_URL="bower_components/mixpanel/mixpanel.js"'
 ```
 
 ### Upgrading from mixpanel-bower v2.2.0 or v2.0.0

package/bower.json

@@ -2,7 +2,7 @@
   "name": "mixpanel",
   "homepage": "https://github.com/mixpanel/mixpanel-js",
   "description": "Mixpanel JavaScript Library",
-  "main": "mixpanel-jslib-snippet.js",
+  "main": "src/loaders/mixpanel-jslib-snippet.js",
   "repository": {
     "type": "git",
     "url": "git@github.com:mixpanel/mixpanel-js.git"

package/build.sh

@@ -8,7 +8,7 @@ if [ ! -z "$DIST" ]; then
 fi
 
 echo 'Building main bundle'
-./node_modules/.bin/rollup -i src/loader-globals.js -f iife -o build/mixpanel.globals.js -n mixpanel -c rollup.config.js
+npx rollup -i src/loaders/loader-globals.js -f iife -o build/mixpanel.globals.js -n mixpanel -c rollup.config.js
 ln -sf mixpanel.globals.js build/mixpanel.js
 
 if [ ! -z "$FULL" ]; then
@@ -16,17 +16,21 @@ if [ ! -z "$FULL" ]; then
     java -jar vendor/closure-compiler/compiler.jar --js build/mixpanel.js --js_output_file build/mixpanel.min.js --compilation_level ADVANCED_OPTIMIZATIONS --output_wrapper "(function() {
 %output%
 })();"
-    java -jar vendor/closure-compiler/compiler.jar --js mixpanel-jslib-snippet.js --js_output_file build/mixpanel-jslib-snippet.min.js --compilation_level ADVANCED_OPTIMIZATIONS
-    java -jar vendor/closure-compiler/compiler.jar --js mixpanel-jslib-snippet.js --js_output_file build/mixpanel-jslib-snippet.min.test.js --compilation_level ADVANCED_OPTIMIZATIONS --define='MIXPANEL_LIB_URL="../build/mixpanel.min.js"'
+    java -jar vendor/closure-compiler/compiler.jar --js src/loaders/mixpanel-jslib-snippet.js --js_output_file build/mixpanel-jslib-snippet.min.js --compilation_level ADVANCED_OPTIMIZATIONS
+    java -jar vendor/closure-compiler/compiler.jar --js src/loaders/mixpanel-jslib-snippet.js --js_output_file build/mixpanel-jslib-snippet.min.test.js --compilation_level ADVANCED_OPTIMIZATIONS --define='MIXPANEL_LIB_URL="../build/mixpanel.min.js"'
+
+    echo 'Building mixpanel-js-wrapper'
+    npx rollup src/loaders/mixpanel-js-wrapper.js -o build/mixpanel-js-wrapper.js -c rollup.config.js
+    java -jar vendor/closure-compiler/compiler.jar --js build/mixpanel-js-wrapper.js --js_output_file build/mixpanel-js-wrapper.min.js --compilation_level ADVANCED_OPTIMIZATIONS
 
     echo 'Building module bundles'
-    ./node_modules/.bin/rollup -i src/loader-module.js -f amd -o build/mixpanel.amd.js -c rollup.config.js
-    ./node_modules/.bin/rollup -i src/loader-module.js -f cjs -o build/mixpanel.cjs.js -c rollup.config.js
-    ./node_modules/.bin/rollup -i src/loader-module.js -f umd -o build/mixpanel.umd.js -n mixpanel -c rollup.config.js
+    npx rollup -i src/loaders/loader-module.js -f amd -o build/mixpanel.amd.js -c rollup.config.js
+    npx rollup -i src/loaders/loader-module.js -f cjs -o build/mixpanel.cjs.js -c rollup.config.js
+    npx rollup -i src/loaders/loader-module.js -f umd -o build/mixpanel.umd.js -n mixpanel -c rollup.config.js
 
     echo 'Bundling module-loader test runners'
-    ./node_modules/.bin/webpack tests/module-cjs.js tests/module-cjs.bundle.js
-    ./node_modules/.bin/browserify tests/module-es2015.js -t [ babelify --compact false ] --outfile tests/module-es2015.bundle.js
+    npx webpack tests/module-cjs.js tests/module-cjs.bundle.js
+    npx browserify tests/module-es2015.js -t [ babelify --compact false ] --outfile tests/module-es2015.bundle.js
 
     echo 'Bundling module-loader examples'
     pushd examples/commonjs-browserify; npm install && npm run build; popd

package/dist/mixpanel-js-wrapper.js

@@ -0,0 +1,247 @@
+// ==ClosureCompiler==
+// @compilation_level SIMPLE_OPTIMIZATIONS
+// @output_file_name mixpanel-jslib-2.2-snippet.min.js
+// ==/ClosureCompiler==
+
+/** @define {string} */
+var MIXPANEL_LIB_URL = '//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js';
+
+(function(document, mixpanel) {
+    // Only stub out if this is the first time running the snippet.
+    if (!mixpanel['__SV']) {
+        var script, first_script, gen_fn, functions, i, lib_name = "mixpanel";
+        window[lib_name] = mixpanel;
+
+        mixpanel['_i'] = [];
+
+        mixpanel['init'] = function (token, config, name) {
+            // support multiple mixpanel instances
+            var target = mixpanel;
+            if (typeof(name) !== 'undefined') {
+                target = mixpanel[name] = [];
+            } else {
+                name = lib_name;
+            }
+
+            // Pass in current people object if it exists
+            target['people'] = target['people'] || [];
+            target['toString'] = function(no_stub) {
+                var str = lib_name;
+                if (name !== lib_name) {
+                    str += "." + name;
+                }
+                if (!no_stub) {
+                    str += " (stub)";
+                }
+                return str;
+            };
+            target['people']['toString'] = function() {
+                // 1 instead of true for minifying
+                return target.toString(1) + ".people (stub)";
+            };
+
+            function _set_and_defer(target, fn) {
+                var split = fn.split(".");
+                if (split.length == 2) {
+                    target = target[split[0]];
+                    fn = split[1];
+                }
+                target[fn] = function() {
+                    target.push([fn].concat(Array.prototype.slice.call(arguments, 0)));
+                };
+            }
+
+            // create shallow clone of the public mixpanel interface
+            // Note: only supports 1 additional level atm, e.g. mixpanel.people.set, not mixpanel.people.set.do_something_else.
+            functions = "disable time_event track track_pageview track_links track_forms track_with_groups add_group set_group remove_group register register_once alias unregister identify name_tag set_config reset opt_in_tracking opt_out_tracking has_opted_in_tracking has_opted_out_tracking clear_opt_in_out_tracking start_batch_senders people.set people.set_once people.unset people.increment people.append people.union people.track_charge people.clear_charges people.delete_user people.remove".split(' ');
+            for (i = 0; i < functions.length; i++) {
+                _set_and_defer(target, functions[i]);
+            }
+
+            // special case for get_group(): chain method calls like mixpanel.get_group('foo', 'bar').unset('baz')
+            var group_functions = "set set_once union unset remove delete".split(' ');
+            target['get_group'] = function() {
+                var mock_group = {};
+
+                var call1_args = arguments;
+                var call1 = ['get_group'].concat(Array.prototype.slice.call(call1_args, 0));
+
+                function _set_and_defer_chained(fn_name) {
+                    mock_group[fn_name] = function() {
+                        var call2_args = arguments;
+                        var call2 = [fn_name].concat(Array.prototype.slice.call(call2_args, 0));
+                        target.push([call1, call2]);
+                    };
+                }
+                for (var i = 0; i < group_functions.length; i++) {
+                    _set_and_defer_chained(group_functions[i]);
+                }
+                return mock_group;
+            };
+
+            // register mixpanel instance
+            mixpanel['_i'].push([token, config, name]);
+        };
+
+        // Snippet version, used to fail on new features w/ old snippet
+        mixpanel['__SV'] = 1.2;
+
+        script = document.createElement("script");
+        script.type = "text/javascript";
+        script.async = true;
+
+        if (typeof MIXPANEL_CUSTOM_LIB_URL !== 'undefined') {
+            script.src = MIXPANEL_CUSTOM_LIB_URL;
+        } else if (document.location.protocol === 'file:' && MIXPANEL_LIB_URL.match(/^\/\//)) {
+            script.src = 'https:' + MIXPANEL_LIB_URL;
+        } else {
+            script.src = MIXPANEL_LIB_URL;
+        }
+
+        first_script = document.getElementsByTagName("script")[0];
+        first_script.parentNode.insertBefore(script, first_script);
+    }
+// Pass in current Mixpanel object if it exists (for ppl like Optimizely)
+})(document, window['mixpanel'] || []);
+
+/*
+ * @see src/loaders/mixpanel-js-wrapper.md
+ */
+(function (win, wrapper) {
+
+    // If window.mixpanel doesn't exist, return
+    if (!win['mixpanel'] || typeof win['mixpanel']['init'] !== 'function') return;
+
+    // Enumerate available commands
+    var commandEnum = [
+        'add_group',
+        'alias',
+        'clear_opt_in_out_tracking',
+        'disable',
+        /* Ignore getters
+        'get_config',
+        'get_distinct_id',
+        'get_group',
+        'get_property',
+        'has_opted_in_tracking',
+        'has_opted_out_tracking',
+        */
+        /* Ignore init
+        'init'
+        */
+        'identify',
+        'opt_in_tracking',
+        'opt_out_tracking',
+        /* Ignore push
+        'push',
+        */
+        'register',
+        'register_once',
+        'remove_group',
+        'reset',
+        'set_config',
+        'set_group',
+        'time_event',
+        'track',
+        'track_forms',
+        'track_links',
+        'track_pageview',
+        'track_with_groups',
+        'unregister',
+        'people.append',
+        'people.clear_charges',
+        'people.delete_user',
+        'people.increment',
+        'people.remove',
+        'people.set',
+        'people.set_once',
+        'people.track_charge',
+        'people.union',
+        'people.unset',
+        'group.remove',
+        'group.set',
+        'group.set_once',
+        'group.union',
+        'group.unset'
+    ];
+
+    /* The people API can't be used with the .push() interface, so it requires its
+     * own helper method. To interact with it, simply use the _mixpanel interface
+     * as before.
+     *
+     * window._mixpanel('<libraryName.>people.set', 'gender', 'm');
+     *
+     */
+    var people = function (mp, cmd, args) {
+        // Extract the command
+        var peopleCmd = cmd.split('.').pop();
+
+        // Call the respective mixpanel method
+        mp['people'][peopleCmd].apply(mp['people'], args);
+    };
+
+    /* To utilize the group API, the command must include the group key and ID as
+     * an array in the second argument.
+     *
+     * window._mixpanel('<libraryName.>.group.set', ['group_key', 'group_id'], {
+     *   someGroupProperty: 'someGroupValue'
+     * });
+     *
+     */
+    var group = function (mp, cmd, args) {
+        // Extract the command
+        var groupCmd = cmd.split('.').pop();
+
+        // Extract the group info
+        var groupInfo = args.shift();
+
+        // Validate the group array
+        if (!Array.isArray(groupInfo) || groupInfo.length !== 2) return;
+
+        // Get group reference
+        var group = mp['get_group'].apply(mp, groupInfo);
+
+        // Call the respective group method
+        group[groupCmd].apply(group, args);
+
+    };
+
+    // Build the command wrapper logic
+    win[wrapper] = win[wrapper] || function () {
+
+        // Build array out of arguments
+        var args = [].slice.call(arguments, 0);
+
+        // Pick the first argument as the command
+        var cmd = args.shift();
+
+        /* Commands can be passed to different namespaces with syntax:
+         * window._mixpanel('libraryName.command', arguments)
+         */
+        var libraryName = null;
+        var cmdParts = cmd.match(/^([^.]+)\.(.+)$/);
+        if (cmdParts && cmdParts.length === 3 && !/people|group/.test(cmdParts[1])) {
+            libraryName = cmdParts[1];
+            cmd = cmdParts[2];
+        }
+
+        // If libraryName is set, use that as the mixpanel interface
+        var mp = libraryName ? window['mixpanel'][libraryName] : window['mixpanel'];
+
+        // Return if namespace not found
+        if (!mp) return;
+
+        // If cmd is not one of the available ones, return
+        if (commandEnum.indexOf(cmd) === -1) return;
+
+        // Handle people command
+        if (/^people\./.test(cmd)) return people(mp, cmd, args);
+
+        // Handle group command
+        if (/^group\./.test(cmd)) return group(mp, cmd, args);
+
+        // Push the command to mixpanel
+        return mp.push.apply(mp, [[cmd].concat(args)]);
+
+    };
+})(window, '_mixpanel');

package/dist/mixpanel-js-wrapper.min.js

@@ -0,0 +1,5 @@
+(function(d,c){if(!c.__SV){var e,g,b,a;window.mixpanel=c;c._i=[];c.init=function(i,g,d){function e(b,a){var d=a.split(".");2==d.length&&(b=b[d[0]],a=d[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,0)))}}var f=c;"undefined"!==typeof d?f=c[d]=[]:d="mixpanel";f.people=f.people||[];f.toString=function(b){var a="mixpanel";"mixpanel"!==d&&(a+="."+d);b||(a+=" (stub)");return a};f.people.toString=function(){return f.toString(1)+".people (stub)"};b="disable time_event track track_pageview track_links track_forms track_with_groups add_group set_group remove_group register register_once alias unregister identify name_tag set_config reset opt_in_tracking opt_out_tracking has_opted_in_tracking has_opted_out_tracking clear_opt_in_out_tracking start_batch_senders people.set people.set_once people.unset people.increment people.append people.union people.track_charge people.clear_charges people.delete_user people.remove".split(" ");
+for(a=0;a<b.length;a++)e(f,b[a]);var h="set set_once union unset remove delete".split(" ");f.get_group=function(){function a(c){b[c]=function(){var a=[c].concat(Array.prototype.slice.call(arguments,0));f.push([d,a])}}for(var b={},d=["get_group"].concat(Array.prototype.slice.call(arguments,0)),c=0;c<h.length;c++)a(h[c]);return b};c._i.push([i,g,d])};c.__SV=1.2;e=d.createElement("script");e.type="text/javascript";e.async=!0;e.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:
+"file:"===d.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";g=d.getElementsByTagName("script")[0];g.parentNode.insertBefore(e,g)}})(document,window.mixpanel||[]);
+(function(d,c){if(d.mixpanel&&"function"===typeof d.mixpanel.init){var e="add_group,alias,clear_opt_in_out_tracking,disable,identify,opt_in_tracking,opt_out_tracking,register,register_once,remove_group,reset,set_config,set_group,time_event,track,track_forms,track_links,track_pageview,track_with_groups,unregister,people.append,people.clear_charges,people.delete_user,people.increment,people.remove,people.set,people.set_once,people.track_charge,people.union,people.unset,group.remove,group.set,group.set_once,group.union,group.unset".split(",");d[c]=
+d[c]||function(){var d=[].slice.call(arguments,0),b=d.shift(),a=null,c=b.match(/^([^.]+)\.(.+)$/);c&&3===c.length&&!/people|group/.test(c[1])&&(a=c[1],b=c[2]);if((a=a?window.mixpanel[a]:window.mixpanel)&&-1!==e.indexOf(b))return/^people\./.test(b)?(b=b.split(".").pop(),a.people[b].apply(a.people,d),b=void 0):/^group\./.test(b)?(b=b.split(".").pop(),c=d.shift(),Array.isArray(c)&&2===c.length&&(a=a.get_group.apply(a,c),a[b].apply(a,d)),b=void 0):b=a.push.apply(a,[[b].concat(d)]),b}}})(window,"_mixpanel");

package/dist/mixpanel.amd.js

@@ -2,7 +2,7 @@ define(function () { 'use strict';
 
     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 @@ define(function () { 'use strict';
     // sending false tracking data
     var BLOCKED_UA_STRS = [
         'ahrefsbot',
+        'ahrefssiteaudit',
         'baiduspider',
         'bingbot',
         'bingpreview',
@@ -1621,7 +1622,14 @@ define(function () { 'use strict';
             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 @@ define(function () { 'use strict';
                 '$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 @@ define(function () { 'use strict';
                 '$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 @@ define(function () { 'use strict';
         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 @@ define(function () { 'use strict';
         '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 @@ define(function () { 'use strict';
             }, '');
         }
 
-        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 @@ define(function () { 'use strict';
     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 @@ define(function () { 'use strict';
         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 @@ define(function () { 'use strict';
         // 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 @@ define(function () { 'use strict';
 
     /**
      * 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 @@ define(function () { 'use strict';
      *     // 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 @@ define(function () { 'use strict';
     /**
      * 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 @@ define(function () { 'use strict';
     /**
      * 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 @@ define(function () { 'use strict';
     /**
      * 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 @@ define(function () { 'use strict';
     /**
      * 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 @@ define(function () { 'use strict';
     /**
      * 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();