mixpanel-react-native 1.3.9 → 1.4.1

package/docs/index.js.html

@@ -134,6 +134,21 @@ export class Mixpanel {
         MixpanelReactNative.setLoggingEnabled(this.token, loggingEnabled);
     }
 
+     /**
+     * This allows enabling or disabling whether or not Mixpanel flushes events
+     * when the app enters the background on iOS. This is set to true by default. 
+     *
+     * @param {boolean} flushOnBackground whether to enable logging
+     *
+     */
+    setFlushOnBackground(flushOnBackground) {
+        if (Platform.OS === 'ios') {
+            MixpanelReactNative.setFlushOnBackground(this.token, flushOnBackground);
+        } else {
+            console.warn('Mixpanel setFlushOnBackground was called and ignored because this method only works on iOS.')
+        }
+    }
+
     /**
      * 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,
@@ -480,6 +495,24 @@ export class Mixpanel {
         return MixpanelReactNative.getDistinctId(this.token);
     }
 
+    /**
+     * Returns the current device id of the device.
+     * This id automatically generated by the library and regenerated when logout or reset is called.
+     *
+     * example of usage:
+     * <pre>
+     * <code>
+     * const deviceId = await mixpanel.getDeviceId();
+     * </code>
+     * </pre>
+     *
+     * @return {Promise<string>} A Promise to the device id
+     *
+     */
+    getDeviceId() {
+        return MixpanelReactNative.getDeviceId(this.token);
+    }
+
     /**
      * Push all queued Mixpanel events and People Analytics changes to Mixpanel servers.
      *
@@ -889,7 +922,7 @@ class ObjectHelper {
 <br class="clear">
 
 <footer>
-    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)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri May 06 2022 10:59:40 GMT-0700 (Pacific Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/index.d.ts

@@ -7,6 +7,8 @@ export class Mixpanel {
     init(optOutTrackingDefault?: boolean, superProperties?: MixpanelProperties): Promise<void>;
     setServerURL(serverURL: string): void;
     setLoggingEnabled(loggingEnabled: boolean): void;
+    setFlushOnBackground(flushOnBackground: boolean): void;
+
     setUseIpAddressForGeolocation(useIpAddressForGeolocation: boolean): void;
     hasOptedOutTracking(): Promise<boolean>;
     optInTracking(): void;
@@ -30,6 +32,7 @@ export class Mixpanel {
     eventElapsedTime(eventName: string): Promise<number>;
     reset(): void;
     getDistinctId(): Promise<string>;
+    getDeviceId(): Promise<string>;
     flush(): void;
 }
 

package/index.js

@@ -106,6 +106,21 @@ export class Mixpanel {
         MixpanelReactNative.setLoggingEnabled(this.token, loggingEnabled);
     }
 
+     /**
+     * This allows enabling or disabling whether or not Mixpanel flushes events
+     * when the app enters the background on iOS. This is set to true by default. 
+     *
+     * @param {boolean} flushOnBackground whether to enable logging
+     *
+     */
+    setFlushOnBackground(flushOnBackground) {
+        if (Platform.OS === 'ios') {
+            MixpanelReactNative.setFlushOnBackground(this.token, flushOnBackground);
+        } else {
+            console.warn('Mixpanel setFlushOnBackground was called and ignored because this method only works on iOS.')
+        }
+    }
+
     /**
      * 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,
@@ -452,6 +467,24 @@ export class Mixpanel {
         return MixpanelReactNative.getDistinctId(this.token);
     }
 
+    /**
+     * Returns the current device id of the device.
+     * This id automatically generated by the library and regenerated when logout or reset is called.
+     *
+     * example of usage:
+     * <pre>
+     * <code>
+     * const deviceId = await mixpanel.getDeviceId();
+     * </code>
+     * </pre>
+     *
+     * @return {Promise<string>} A Promise to the device id
+     *
+     */
+    getDeviceId() {
+        return MixpanelReactNative.getDeviceId(this.token);
+    }
+
     /**
      * Push all queued Mixpanel events and People Analytics changes to Mixpanel servers.
      *

package/ios/MixpanelReactNative.m

@@ -12,6 +12,8 @@ RCT_EXTERN_METHOD(setServerURL:(NSString *)token serverURL:(NSString *)serverURL
 
 RCT_EXTERN_METHOD(setLoggingEnabled:(NSString *)token loggingEnabled:(BOOL)loggingEnabled resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
 
+RCT_EXTERN_METHOD(setFlushOnBackground:(NSString *)token flushOnBackground:(BOOL)flushOnBackground resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+
 RCT_EXTERN_METHOD(setUseIpAddressForGeolocation:(NSString *)token useIpAddressForGeolocation:(BOOL)useIpAddressForGeolocation resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
 
 // MARK: - Opting Users Out of Tracking
@@ -44,6 +46,8 @@ RCT_EXTERN_METHOD(reset:(NSString *)token resolver:(RCTPromiseResolveBlock)resol
 
 RCT_EXTERN_METHOD(getDistinctId:(NSString *)token resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
 
+RCT_EXTERN_METHOD(getDeviceId:(NSString *)token resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+
 // MARK: - Super Properties
 
 RCT_EXTERN_METHOD(registerSuperProperties:(NSString *)token properties:(NSDictionary *)properties resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)

package/ios/MixpanelReactNative.swift

@@ -44,6 +44,16 @@ open class MixpanelReactNative: NSObject {
         resolve(nil)
     }
 
+    @objc
+    func setFlushOnBackground(_ token: String,
+                    flushOnBackground: Bool,
+                    resolver resolve: RCTPromiseResolveBlock,
+                    rejecter reject: RCTPromiseRejectBlock) -> Void {
+        let instance = MixpanelReactNative.getMixpanelInstance(token)
+        instance?.flushOnBackground = flushOnBackground
+        resolve(nil)
+    }
+
     @objc
     func setUseIpAddressForGeolocation(_ token: String,
                     useIpAddressForGeolocation: Bool,
@@ -155,6 +165,13 @@ open class MixpanelReactNative: NSObject {
         let instance = MixpanelReactNative.getMixpanelInstance(token)
         resolve(instance?.distinctId)
     }
+
+    @objc
+    func getDeviceId(_ token: String, resolver resolve: RCTPromiseResolveBlock,
+                       rejecter reject: RCTPromiseRejectBlock) -> Void {
+        let instance = MixpanelReactNative.getMixpanelInstance(token)
+        resolve(instance?.anonymousId)
+    }
     
     // MARK: - Super Properties
     

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mixpanel-react-native",
-    "version": "1.3.9",
+    "version": "1.4.1",
     "description": "Official React Native Tracking Library for Mixpanel Analytics",
     "main": "index.js",
     "scripts": {

package/release.py

@@ -11,14 +11,12 @@ 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;rm -fr node_modules;rm -fr android/app/build', shell=True)
+    subprocess.call('cd Samples/SimpleMixpanel;rm -fr node_modules;rm -fr android/app/build', shell=True)
+    subprocess.call('cd Samples/ContextAPIMixpanel;rm -fr node_modules;rm -fr android/app/build', 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)
-    #subprocess.call('git add Samples/SimpleMixpanel/yarn.lock', shell=True)
-    #subprocess.call('git add Samples/ContextAPIMixpanel/yarn.lock', shell=True)
+
     subprocess.call('git commit -m "Version {}"'.format(args.new), shell=True)
     subprocess.call('git push', shell=True)