mixpanel-react-native 1.3.5 → 1.3.8

package/docs/index.js.html

@@ -82,11 +82,12 @@ export class Mixpanel {
      * Initializes Mixpanel
      *
      * @param {boolean} Optional Whether or not Mixpanel can start tracking by default. See optOutTracking()
+     * @param {object}  Optional A Map containing the key value pairs of the super properties to register
      *
      */
-    async init(optOutTrackingDefault = DEFAULT_OPT_OUT) {
+    async init(optOutTrackingDefault = DEFAULT_OPT_OUT, superProperties = {}) {
         let metadata = Helper.getMetaData();
-        await MixpanelReactNative.initialize(this.token, optOutTrackingDefault, metadata);
+        await MixpanelReactNative.initialize(this.token, optOutTrackingDefault, {...metadata, ...superProperties});
     }
 
     /**
@@ -96,12 +97,12 @@ export class Mixpanel {
      * const mixpanel = new Mixpanel('your project token');
      * mixpanel.init();
      * </code></pre>
-     * 
+     *
      * Initializes Mixpanel and return an instance of Mixpanel the given project token.
      *
      * @param {string} token your project token.
      * @param {boolean} Optional Whether or not Mixpanel can start tracking by default. See optOutTracking()
-     * 
+     *
      */
     static async init(token, optOutTrackingDefault = DEFAULT_OPT_OUT) {
         let metadata = Helper.getMetaData();
@@ -115,7 +116,7 @@ export class Mixpanel {
      * To route data to Mixpanel's EU servers, set to https://api-eu.mixpanel.com
      *
      * @param {string} serverURL the base URL used for Mixpanel API requests
-     * 
+     *
      */
     setServerURL(serverURL) {
         MixpanelReactNative.setServerURL(this.token, serverURL);
@@ -124,10 +125,10 @@ export class Mixpanel {
     /**
      * This allows enabling or disabling of all Mixpanel logs at run time.
      * All logging is disabled by default. Usually, this is only required if
-     * you are running into issues with the SDK that you want to debug 
-     * 
+     * you are running into issues with the SDK that you want to debug
+     *
      * @param {boolean} loggingEnabled whether to enable logging
-     * 
+     *
      */
     setLoggingEnabled(loggingEnabled) {
         MixpanelReactNative.setLoggingEnabled(this.token, loggingEnabled);
@@ -135,12 +136,12 @@ export class Mixpanel {
 
     /**
      * This controls whether to automatically send the client IP Address as part of event tracking.
-     * With an IP address, geo-location is possible down to neighborhoods within a city, 
+     * With an IP address, geo-location is possible down to neighborhoods within a city,
      * although the Mixpanel Dashboard will just show you city level location specificity.
-     * 
-     * @param {boolean} useIpAddressForGeolocation whether to automatically send the client IP Address. 
+     *
+     * @param {boolean} useIpAddressForGeolocation whether to automatically send the client IP Address.
      * Defaults to true.
-     * 
+     *
      */
     setUseIpAddressForGeolocation(useIpAddressForGeolocation) {
         MixpanelReactNative.setUseIpAddressForGeolocation(this.token, useIpAddressForGeolocation);
@@ -154,7 +155,7 @@ export class Mixpanel {
     hasOptedOutTracking() {
         return MixpanelReactNative.hasOptedOutTracking(this.token);
     }
-  
+
     /**
      * Use this method to opt-in an already opted-out user from tracking. People updates and track
      * calls will be sent to Mixpanel after using this method.
@@ -204,10 +205,10 @@ export class Mixpanel {
     /**
      * The alias method creates an alias which Mixpanel will use to remap one id to another.
      * Multiple aliases can point to the same identifier.
-     * 
+     *
      *  `mixpane.alias("New ID", mixpane.distinctId)`
      *  `mixpane.alias("Newer ID", mixpane.distinctId)`
-     * 
+     *
      * <p>This call does not identify the user after. You must still call both identify() and
      * People.identify() if you wish the new alias to be used for Events and People.
      *
@@ -270,7 +271,7 @@ export class Mixpanel {
      *                   Pass null if no extra properties exist.
      * @param {object} groups A Map containing the group key value pairs for this event.
      *
-     */ 
+     */
     trackWithGroups(eventName, properties, groups) {
         if (!StringHelper.isValid(eventName)) {
             StringHelper.raiseError(PARAMS.EVENT_NAME);
@@ -462,13 +463,13 @@ export class Mixpanel {
     }
 
     /**
-     * Returns the current distinct id of the user. 
+     * Returns the current distinct id of the user.
      * This is either the id automatically generated by the library or the id that has been passed by a call to identify().
-     * 
-     * example of usage: 
+     *
+     * example of usage:
      * <pre>
      * <code>
-     * const distinctId = await mixpanel.getDistinctId(); 
+     * const distinctId = await mixpanel.getDistinctId();
      * </code>
      * </pre>
      *
@@ -758,7 +759,7 @@ export class MixpanelGroup {
 
     /**
      * Permanently removes the property with the given name from the group's profile
-     * 
+     *
      * @param {string} prop name of a property to unset
      */
     unset(prop) {
@@ -772,7 +773,7 @@ export class MixpanelGroup {
      * Remove value from a list-valued property only if it is already present in the list.
      * If the property does not currently exist, the remove will be ignored.
      * If the property exists and is not list-valued, the remove will be ignored.
-     * 
+     *
      * @param {string} name the Group Analytics list-valued property that should have a value removed
      * @param {any} value the value that will be removed from the list
      */
@@ -888,7 +889,7 @@ class ObjectHelper {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon Jan 03 2022 19:43:40 GMT-0800 (Pacific Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Feb 25 2022 13:58:49 GMT-0800 (Pacific Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/index.d.ts

@@ -4,7 +4,7 @@ type MixpanelProperties = { [key: string]: MixpanelType };
 export class Mixpanel {
     constructor(token: string);
     static init(token: string, optOutTrackingDefault?: boolean): Promise<Mixpanel>;
-    init(optOutTrackingDefault?: boolean): Promise<void>;
+    init(optOutTrackingDefault?: boolean, superProperties?: MixpanelProperties): Promise<void>;
     setServerURL(serverURL: string): void;
     setLoggingEnabled(loggingEnabled: boolean): void;
     setUseIpAddressForGeolocation(useIpAddressForGeolocation: boolean): void;
@@ -36,8 +36,11 @@ export class Mixpanel {
 export class People {
     constructor(token: string);
     set(prop: string, to: MixpanelType): void;
+    set(properties: MixpanelProperties): void;
     setOnce(prop: string, to: MixpanelType): void;
+    setOnce(properties: MixpanelProperties): void;
     increment(prop: string, by: number): void;
+    increment(properties: MixpanelProperties): void;
     append(name: string, value: MixpanelType): void;
     union(name: string, value: Array<MixpanelType>): void;
     remove(name: string, value: MixpanelType): void;

package/index.js

@@ -54,11 +54,12 @@ export class Mixpanel {
      * Initializes Mixpanel
      *
      * @param {boolean} Optional Whether or not Mixpanel can start tracking by default. See optOutTracking()
+     * @param {object}  Optional A Map containing the key value pairs of the super properties to register
      *
      */
-    async init(optOutTrackingDefault = DEFAULT_OPT_OUT) {
+    async init(optOutTrackingDefault = DEFAULT_OPT_OUT, superProperties = {}) {
         let metadata = Helper.getMetaData();
-        await MixpanelReactNative.initialize(this.token, optOutTrackingDefault, metadata);
+        await MixpanelReactNative.initialize(this.token, optOutTrackingDefault, {...metadata, ...superProperties});
     }
 
     /**
@@ -68,12 +69,12 @@ export class Mixpanel {
      * const mixpanel = new Mixpanel('your project token');
      * mixpanel.init();
      * </code></pre>
-     * 
+     *
      * Initializes Mixpanel and return an instance of Mixpanel the given project token.
      *
      * @param {string} token your project token.
      * @param {boolean} Optional Whether or not Mixpanel can start tracking by default. See optOutTracking()
-     * 
+     *
      */
     static async init(token, optOutTrackingDefault = DEFAULT_OPT_OUT) {
         let metadata = Helper.getMetaData();
@@ -87,7 +88,7 @@ export class Mixpanel {
      * To route data to Mixpanel's EU servers, set to https://api-eu.mixpanel.com
      *
      * @param {string} serverURL the base URL used for Mixpanel API requests
-     * 
+     *
      */
     setServerURL(serverURL) {
         MixpanelReactNative.setServerURL(this.token, serverURL);
@@ -96,10 +97,10 @@ export class Mixpanel {
     /**
      * This allows enabling or disabling of all Mixpanel logs at run time.
      * All logging is disabled by default. Usually, this is only required if
-     * you are running into issues with the SDK that you want to debug 
-     * 
+     * you are running into issues with the SDK that you want to debug
+     *
      * @param {boolean} loggingEnabled whether to enable logging
-     * 
+     *
      */
     setLoggingEnabled(loggingEnabled) {
         MixpanelReactNative.setLoggingEnabled(this.token, loggingEnabled);
@@ -107,12 +108,12 @@ export class Mixpanel {
 
     /**
      * This controls whether to automatically send the client IP Address as part of event tracking.
-     * With an IP address, geo-location is possible down to neighborhoods within a city, 
+     * With an IP address, geo-location is possible down to neighborhoods within a city,
      * although the Mixpanel Dashboard will just show you city level location specificity.
-     * 
-     * @param {boolean} useIpAddressForGeolocation whether to automatically send the client IP Address. 
+     *
+     * @param {boolean} useIpAddressForGeolocation whether to automatically send the client IP Address.
      * Defaults to true.
-     * 
+     *
      */
     setUseIpAddressForGeolocation(useIpAddressForGeolocation) {
         MixpanelReactNative.setUseIpAddressForGeolocation(this.token, useIpAddressForGeolocation);
@@ -126,7 +127,7 @@ export class Mixpanel {
     hasOptedOutTracking() {
         return MixpanelReactNative.hasOptedOutTracking(this.token);
     }
-  
+
     /**
      * Use this method to opt-in an already opted-out user from tracking. People updates and track
      * calls will be sent to Mixpanel after using this method.
@@ -176,10 +177,10 @@ export class Mixpanel {
     /**
      * The alias method creates an alias which Mixpanel will use to remap one id to another.
      * Multiple aliases can point to the same identifier.
-     * 
+     *
      *  `mixpane.alias("New ID", mixpane.distinctId)`
      *  `mixpane.alias("Newer ID", mixpane.distinctId)`
-     * 
+     *
      * <p>This call does not identify the user after. You must still call both identify() and
      * People.identify() if you wish the new alias to be used for Events and People.
      *
@@ -242,7 +243,7 @@ export class Mixpanel {
      *                   Pass null if no extra properties exist.
      * @param {object} groups A Map containing the group key value pairs for this event.
      *
-     */ 
+     */
     trackWithGroups(eventName, properties, groups) {
         if (!StringHelper.isValid(eventName)) {
             StringHelper.raiseError(PARAMS.EVENT_NAME);
@@ -434,13 +435,13 @@ export class Mixpanel {
     }
 
     /**
-     * Returns the current distinct id of the user. 
+     * Returns the current distinct id of the user.
      * This is either the id automatically generated by the library or the id that has been passed by a call to identify().
-     * 
-     * example of usage: 
+     *
+     * example of usage:
      * <pre>
      * <code>
-     * const distinctId = await mixpanel.getDistinctId(); 
+     * const distinctId = await mixpanel.getDistinctId();
      * </code>
      * </pre>
      *
@@ -730,7 +731,7 @@ export class MixpanelGroup {
 
     /**
      * Permanently removes the property with the given name from the group's profile
-     * 
+     *
      * @param {string} prop name of a property to unset
      */
     unset(prop) {
@@ -744,7 +745,7 @@ export class MixpanelGroup {
      * Remove value from a list-valued property only if it is already present in the list.
      * If the property does not currently exist, the remove will be ignored.
      * If the property exists and is not list-valued, the remove will be ignored.
-     * 
+     *
      * @param {string} name the Group Analytics list-valued property that should have a value removed
      * @param {any} value the value that will be removed from the list
      */

package/ios/MixpanelReactNative.swift

@@ -18,9 +18,9 @@ open class MixpanelReactNative: NSObject {
                     resolver resolve: RCTPromiseResolveBlock,
                     rejecter reject: RCTPromiseRejectBlock) -> Void {
         AutomaticProperties.setAutomaticProperties(properties)
-        Mixpanel.initialize(token: token, flushInterval: Constants.DEFAULT_FLUSH_INTERVAL, instanceName: token, optOutTrackingByDefault: optOutTrackingByDefault)
-        let instance = MixpanelReactNative.getMixpanelInstance(token)
-        instance?.flushInterval = Constants.DEFAULT_FLUSH_INTERVAL
+        Mixpanel.initialize(token: token, flushInterval: Constants.DEFAULT_FLUSH_INTERVAL,
+                            instanceName: token, optOutTrackingByDefault: optOutTrackingByDefault,
+                            superProperties: MixpanelTypeHandler.processProperties(properties: properties, includeLibInfo: true))
         resolve(true)
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mixpanel-react-native",
-    "version": "1.3.5",
+    "version": "1.3.8",
     "description": "Official React Native Tracking Library for Mixpanel Analytics",
     "main": "index.js",
     "scripts": {
@@ -31,31 +31,30 @@
         "mp_lib": "react-native"
     },
     "devDependencies": {
-        "@babel/core": "^7.12.3",
-        "@babel/runtime": "^7.12.1",
-        "@react-native-community/eslint-config": "^2.0.0",
-        "babel-jest": "^26.6.0",
-        "eslint": "^7.11.0",
-        "jest": "^26.6.0",
-        "metro-react-native-babel-preset": "^0.63.0",
-        "react-native": "^0.63.3",
-        "react-native-clean-project": "^3.6.7",
-        "react-test-renderer": "16.13.1"
+      "@babel/core": "^7.12.3",
+      "@babel/runtime": "^7.12.1",
+      "@react-native-community/eslint-config": "^2.0.0",
+      "babel-jest": "^26.6.0",
+      "eslint": "^7.11.0",
+      "jest": "^26.6.0",
+      "metro-react-native-babel-preset": "^0.63.0",
+      "react-test-renderer": "16.13.1",
+      "react-native": "^0.63.3"
     },
     "jest": {
-        "modulePathIgnorePatterns": [
-            "<rootDir>/MixpanelDemo/"
-        ],
-        "testMatch": [
-            "<rootDir>/__tests__/index.test.js"
-        ],
-        "setupFiles": [
-            "<rootDir>/__tests__/jest_setup.js"
-        ],
-        "verbose": true,
-        "preset": "react-native",
-        "transform": {
-            "^.+\\.js$": "<rootDir>/node_modules/react-native/jest/preprocessor.js"
-        }
+      "modulePathIgnorePatterns": [
+        "<rootDir>/MixpanelDemo/"
+      ],
+      "testMatch": [
+        "<rootDir>/__tests__/index.test.js"
+      ],
+      "setupFiles": [
+        "<rootDir>/__tests__/jest_setup.js"
+      ],
+      "verbose": true,
+      "preset": "react-native",
+      "transform": {
+        "^.+\\.js$": "<rootDir>/node_modules/react-native/jest/preprocessor.js"
+      }
     }
 }

package/release.py

@@ -11,9 +11,9 @@ args = parser.parse_args()
 def bump_version():
     replace_version('package.json', "\"version\": \"" + args.old + "\"", "\"version\": \"" + args.new + "\"")
     replace_version('__tests__/index.test.js', "\"$lib_version\": \"" + args.old + "\"", "\"$lib_version\": \"" + args.new + "\"")
-    # subprocess.call('cd Samples/MixpanelDemo;yarn upgrade mixpanel-react-native --latest', shell=True)
-    # subprocess.call('cd Samples/SimpleMixpanel;yarn upgrade mixpanel-react-native --latest', shell=True)
-    # subprocess.call('cd Samples/ContextAPIMixpanel;yarn upgrade mixpanel-react-native --latest', shell=True)
+    subprocess.call('cd Samples/MixpanelDemo;yarn upgrade mixpanel-react-native --latest', shell=True)
+    subprocess.call('cd Samples/SimpleMixpanel;yarn upgrade mixpanel-react-native --latest', shell=True)
+    subprocess.call('cd Samples/ContextAPIMixpanel;yarn upgrade mixpanel-react-native --latest', shell=True)
     subprocess.call('git add package.json', shell=True)
     subprocess.call('git add __tests__/index.test.js', shell=True)
     subprocess.call('git add Samples/MixpanelDemo/yarn.lock', shell=True)