mixpanel-browser 2.39.0 → 2.42.0

package/doc/build-docs.js

@@ -97,6 +97,22 @@ function doxToMD(items) {
   });
 }
 
+// Captures prototype bracket notation property assignment, e.g.:
+// `MixpanelGroup.prototype['delete'] = addOptOutCheckMixpanelGroup(function(callback) {`
+// Based on https://github.com/tj/dox/blob/9fe92e17dfcd31c9b6512f6e5bf0b52c2b6b84d4/lib/dox.js#L592
+dox.contextPatternMatchers.push(function (str) {
+  if (/^\s*([\w$.]+)\s*\.\s*prototype\s*\['\s*([\w$]+)'\]\s*=\s*([^\n;]+)/.exec(str)) {
+    return {
+        type: 'property'
+      , constructor: RegExp.$1
+      , cons: RegExp.$1
+      , name: RegExp.$2
+      , value: RegExp.$3.trim()
+      , string: RegExp.$1 + '.prototype.' + RegExp.$2
+    };
+  }
+});
+
 const rawCode = fs.readFileSync(SOURCE_FILE).toString().trim();
 const parsed = dox.parseComments(rawCode);
 

package/doc/readme.io/javascript-full-api-reference.md

@@ -344,6 +344,9 @@ mixpanel.register({
     'Email': 'jdoe@example.com',
     'Account Type': 'Free'
 });
+
+// register only for the current pageload
+mixpanel.register({'Name': 'Pat'}, {persistent: false});
 ```
 
 
@@ -351,7 +354,13 @@ mixpanel.register({
 | Argument | Type | Description |
 | ------------- | ------------- | ----- |
 | **properties** | <span class="mp-arg-type">Object</span></br></span><span class="mp-arg-required">required</span> | An associative array of properties to store about the user |
-| **days** | <span class="mp-arg-type">Number</span></br></span><span class="mp-arg-optional">optional</span> | How many days since the user's last visit to store the super properties |
+| **days_or_options** | <span class="mp-arg-type">Number or Object</span></br></span><span class="mp-arg-optional">optional</span> | Options object or number of days since the user's last visit to store the super properties (only valid for persisted props) |
+| **days_or_options.days** | <span class="mp-arg-type">boolean</span></br></span><span class="mp-arg-optional">optional</span> | <ul>
+<li>number of days since the user's last visit to store the super properties (only valid for persisted props)</li>
+</ul> |
+| **days_or_options.persistent=true** | <span class="mp-arg-type">boolean</span></br></span><span class="mp-arg-optional">optional</span> | <ul>
+<li>whether to put in persistent storage (cookie/localStorage)</li>
+</ul> |
 
 
 ___
@@ -367,6 +376,11 @@ mixpanel.register_once({
     'First Login Date': new Date().toISOString()
 });
 
+// register once, only for the current pageload
+mixpanel.register_once({
+    'First interaction time': new Date().toISOString()
+}, 'None', {persistent: false});
+
 ```
 
 
@@ -378,7 +392,13 @@ If default_value is specified, current super properties  with that value will be
 | ------------- | ------------- | ----- |
 | **properties** | <span class="mp-arg-type">Object</span></br></span><span class="mp-arg-required">required</span> | An associative array of properties to store about the user |
 | **default_value** | <span class="mp-arg-type">any</span></br></span><span class="mp-arg-optional">optional</span> | Value to override if already set in super properties (ex: 'False') Default: 'None' |
-| **days** | <span class="mp-arg-type">Number</span></br></span><span class="mp-arg-optional">optional</span> | How many days since the users last visit to store the super properties |
+| **days_or_options** | <span class="mp-arg-type">Number or Object</span></br></span><span class="mp-arg-optional">optional</span> | Options object or number of days since the user's last visit to store the super properties (only valid for persisted props) |
+| **days_or_options.days** | <span class="mp-arg-type">boolean</span></br></span><span class="mp-arg-optional">optional</span> | <ul>
+<li>number of days since the user's last visit to store the super properties (only valid for persisted props)</li>
+</ul> |
+| **days_or_options.persistent=true** | <span class="mp-arg-type">boolean</span></br></span><span class="mp-arg-optional">optional</span> | <ul>
+<li>whether to put in persistent storage (cookie/localStorage)</li>
+</ul> |
 
 
 ___
@@ -703,6 +723,10 @@ Delete a super property stored with the current user.
 | Argument | Type | Description |
 | ------------- | ------------- | ----- |
 | **property** | <span class="mp-arg-type">String</span></br></span><span class="mp-arg-required">required</span> | The name of the super property to remove |
+| **options** | <span class="mp-arg-type">Object</span></br></span><span class="mp-arg-optional">optional</span> |  |
+| **options.persistent=true** | <span class="mp-arg-type">boolean</span></br></span><span class="mp-arg-optional">optional</span> | <ul>
+<li>whether to look in persistent storage (cookie/localStorage)</li>
+</ul> |
 
 
 
@@ -966,6 +990,24 @@ mixpanel.people.unset(['gender', 'Company']);
 # mixpanel.group
 
 
+___
+## mixpanel.group.delete
+Permanently delete a group.
+
+
+### Usage:
+
+```javascript
+mixpanel.get_group('company', 'mixpanel').delete();
+```
+
+
+
+| Argument | Type | Description |
+| ------------- | ------------- | ----- |
+| **callback** | <span class="mp-arg-type">Function</span></br></span><span class="mp-arg-optional">optional</span> | If provided, the callback will be called after the tracking event |
+
+
 ___
 ## mixpanel.group.remove
 Remove a property from a group. The value will be ignored if doesn't exist.

package/mixpanel-jslib-snippet.js

@@ -9,25 +9,6 @@ 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 win = window;
-
-        // grab the hash params for ce editor immediately in case
-        // host website changes hash after init
-        try {
-          var getHashParam, matches, state, loc = win.location, hash = loc.hash;
-          getHashParam = function(hash, param) {
-              matches = hash.match(new RegExp(param + '=([^&]*)'));
-              return matches ? matches[1] : null;
-          };
-          if (hash && getHashParam(hash, 'state')) {
-              state = JSON.parse(decodeURIComponent(getHashParam(hash, 'state')));
-              if (state['action'] === 'mpeditor') {
-                win.sessionStorage.setItem('_mpcehash', hash);
-                history.replaceState(state['desiredHash'] || '', document.title, loc.pathname + loc.search); // remove ce editor hash
-              }
-          }
-        } catch (e) {}
-
         var script, first_script, gen_fn, functions, i, lib_name = "mixpanel";
         window[lib_name] = mixpanel;
 
@@ -72,7 +53,7 @@ var MIXPANEL_LIB_URL = '//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js';
 
             // 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 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(' ');
+            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]);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mixpanel-browser",
-  "version": "2.39.0",
+  "version": "2.42.0",
   "description": "The official Mixpanel JavaScript browser client library",
   "main": "dist/mixpanel.cjs.js",
   "directories": {
@@ -46,10 +46,10 @@
     "jsdom": "11.12.0",
     "jsdom-global": "3.0.2",
     "localStorage": "1.0.4",
-    "lodash": "4.17.19",
+    "lodash": "4.17.21",
     "mocha": "7.1.1",
     "morgan": "1.9.1",
-    "rdme": "3.0.0",
+    "rdme": "4.0.0",
     "request": "2.88.0",
     "rollup": "0.25.8",
     "rollup-plugin-npm": "1.4.0",

package/src/config.js

@@ -1,6 +1,6 @@
 var Config = {
     DEBUG: false,
-    LIB_VERSION: '2.39.0'
+    LIB_VERSION: '2.42.0'
 };
 
 export default Config;

package/src/gdpr-utils.js

@@ -11,7 +11,7 @@
  * These functions are used internally by the SDK and are not intended to be publicly exposed.
  */
 
-import { _, window } from './utils';
+import { _, console, window } from './utils';
 
 /**
  * A function used to track a Mixpanel event (e.g. MixpanelLib.track)
@@ -83,9 +83,14 @@ export function hasOptedIn(token, options) {
  */
 export function hasOptedOut(token, options) {
     if (_hasDoNotTrackFlagOn(options)) {
+        console.warn('This browser has "Do Not Track" enabled. This will prevent the Mixpanel SDK from sending any data. To ignore the "Do Not Track" browser setting, initialize the Mixpanel instance with the config "ignore_dnt: true"');
         return true;
     }
-    return _getStorageValue(token, options) === '0';
+    var optedOut = _getStorageValue(token, options) === '0';
+    if (optedOut) {
+        console.warn('You are opted out of Mixpanel tracking. This will prevent the Mixpanel SDK from sending any data.');
+    }
+    return optedOut;
 }
 
 /**