mixpanel-react-native 3.0.0-beta.1 → 3.0.0-beta.2

package/CHANGELOG.md

@@ -1,9 +1,29 @@
 #
 
+## [v3.0.0-beta.2](https://github.com/mixpanel/mixpanel-react-native/tree/v3.0.0-beta.2) (2024-03-06)
+
+### Enhancements
+- Add support to use custom storage instead of @react-native-async-storage/async-storage.(https://github.com/mixpanel/mixpanel-react-native/pull/225)
+When JavaScript mode is enabled, Mixpanel utilizes [AsyncStorage](https://reactnative.dev/docs/asyncstorage) to persist data. If you prefer not to use it, or if AsyncStorage is unavailable in your target environment, you can import or define a different storage class. However, it must follow the same interface as [AsyncStorage](https://reactnative.dev/docs/asyncstorage) The following example demonstrates how to use a custom storage solution:
+
+```
+const MyAsyncStorage = require("@my-org/<library-path>/AsyncStorage"); // or your own storage class
+const trackAutomaticEvents = false;
+const useNative = false;
+const mixpanel = new Mixpanel('YOUR_TOKEN', trackAutomaticEvents, useNative, MyAsyncStorage);
+mixpanel.init();
+```
+
+### Fixes
+- Make `optOutTracking` and `optInTracking` consistent with the native SDK.(https://github.com/mixpanel/mixpanel-react-native/pull/225)
+  
+#
+
 ## [v3.0.0-beta.1](https://github.com/mixpanel/mixpanel-react-native/tree/v3.0.0-beta.1) (2024-02-29)
 
 ### Expo and React Native Web support
-This version(PR [\#223](https://github.com/mixpanel/mixpanel-react-native/pull/223)) introduces support for Expo, React Native Web, and any platform using React Native that does not support iOS and Android. To activate this feature, initialize Mixpanel with an additional parameter `useNative` set to false, which will enable JavaScript mode. Currently in beta, we plan to iterate on this to address any issues and add more features. We welcome your feedback.
+
+This version(PR [\#223](https://github.com/mixpanel/mixpanel-react-native/pull/223)) introduces support for Expo, React Native Web, and any platform using React Native that does not support iOS and Android. To activate this, initialize Mixpanel with an additional parameter `useNative` set to false, which will enable JavaScript mode. Currently in beta, we plan to iterate on this to address any issues and add more features. We welcome your feedback.
 
 ```
  const trackAutomaticEvents = false;
@@ -16,14 +36,21 @@ This version(PR [\#223](https://github.com/mixpanel/mixpanel-react-native/pull/2
  mixpanel.init();
 ```
 
-
 To try the Expo sample app, navigate to `Samples/MixpanelExpo`, run `npm install`, and then execute `npm run ios` or `npm run android`
 
 Known limitations and differences compared to the native mode (iOS/Android):
+
 - Automatic Events are currently not supported in this mode. Setting 'trackAutomaticEvents' to 'true' will have no effect.
 - Certain Mixpanel Properties are unavailable in Javascript mode, including detailed information about the device and screen.
 - The default flush interval is set to 10 seconds. The data will not flush automatically when the app moves to the background. We recommend flushing more frequently for key events.
 
+#
+
+## [v2.4.1](https://github.com/mixpanel/mixpanel-react-native/tree/v2.4.1) (2024-03-01)
+
+### Fixes
+
+- Fix mp_lib(Mixpanel Library) not being set as `react-native`
 
 #
 
@@ -98,8 +125,8 @@ Known limitations and differences compared to the native mode (iOS/Android):
 ## [v2.2.0](https://github.com/mixpanel/mixpanel-react-native/tree/v2.2.0) (2023-03-06)
 
 ### NOTE:
-- From this version we will prefix randomly generated device-specific distinct_ids with "$device:". The prefix is applied the next time a new random ID is generated, any IDs generated by previous SDK versions and  persisted on the device will continue to be used as-is until reset is called to generate a new ID. This does not change the value sent for the $device_id property, which will continue to be the randomly-generated ID without a prefix. Mixpanel's $identify endpoint has been updated to accept UUIDs with this prefix to coordinate with this change.
 
+- From this version we will prefix randomly generated device-specific distinct_ids with "$device:". The prefix is applied the next time a new random ID is generated, any IDs generated by previous SDK versions and persisted on the device will continue to be used as-is until reset is called to generate a new ID. This does not change the value sent for the $device_id property, which will continue to be the randomly-generated ID without a prefix. Mixpanel's $identify endpoint has been updated to accept UUIDs with this prefix to coordinate with this change.
 
 ### Enhancements
 
@@ -125,7 +152,8 @@ Known limitations and differences compared to the native mode (iOS/Android):
 
 ## [v2.0.0](https://github.com/mixpanel/mixpanel-react-native/tree/v2.0.0) (2022-09-09)
 
-### BREAKING CHANGE: 
+### BREAKING CHANGE:
+
 This major release removes all remaining calls to Mixpanel's `/decide` API endpoint. The main effect of this is that the SDK no longer fetches the remote status of your [project's "Automatically collect common mobile events" setting](https://help.mixpanel.com/hc/en-us/articles/115004596186#enable-or-disable-common-mobile-events). From this version forward, automatic event tracking can only be controlled by the, now required, parameter `trackAutomaticEvents`. Upon upgrading, existing implementations will need to add this parameter to their Mixpanel initializer calls.
 
 ### Enhancements
@@ -138,7 +166,7 @@ This major release removes all remaining calls to Mixpanel's `/decide` API endpo
 
 ### Enhancements
 
--  bump versions to get millisecond precision for event time property [\#146](https://github.com/mixpanel/mixpanel-react-native/pull/146)
+- bump versions to get millisecond precision for event time property [\#146](https://github.com/mixpanel/mixpanel-react-native/pull/146)
 
 #
 
@@ -164,7 +192,7 @@ This major release removes all remaining calls to Mixpanel's `/decide` API endpo
 
 - Bump to latest ios and android sdk versions and remove android people identify\(deprecated\) [\#137](https://github.com/mixpanel/mixpanel-react-native/pull/137)
 - Allow disable flush on background [\#135](https://github.com/mixpanel/mixpanel-react-native/pull/135)
-- Adds  a new API `getDeviceId` for React Native [\#134](https://github.com/mixpanel/mixpanel-react-native/pull/134)
+- Adds a new API `getDeviceId` for React Native [\#134](https://github.com/mixpanel/mixpanel-react-native/pull/134)
 
 #
 
@@ -201,11 +229,12 @@ This major release removes all remaining calls to Mixpanel's `/decide` API endpo
 #
 
 ## [v1.3.6](https://github.com/mixpanel/mixpanel-react-native/tree/v1.3.6) (2022-01-13)
+
 ### Caution: Please DO NOT use this build! In this version, we have a bug in iOS that event names with `&` or `%` will be rejected by the server. We recommend you update to 1.3.7 or above.
 
 ### Fixes
 
-- Fix common mobile events not showing  'react-native'  as property value for 'Mixpanel Library' [\#122](https://github.com/mixpanel/mixpanel-react-native/pull/122)
+- Fix common mobile events not showing 'react-native' as property value for 'Mixpanel Library' [\#122](https://github.com/mixpanel/mixpanel-react-native/pull/122)
 
 #
 
@@ -290,91 +319,53 @@ This major release removes all remaining calls to Mixpanel's `/decide` API endpo
 ## [v1.2.3](https://github.com/mixpanel/mixpanel-react-native/tree/v1.2.3) (2021-05-20)
 
 - Bump Mixpanel Andriod dependency to 5.9.1 (Migrate to Airship 12.x for the integration)
-https://github.com/mixpanel/mixpanel-react-native/pull/59
+  https://github.com/mixpanel/mixpanel-react-native/pull/59
 
 #
 
 ## [v1.2.2](https://github.com/mixpanel/mixpanel-react-native/tree/v1.2.2) (2021-05-08)
 
 - Fix Mixpanel type conversion for ios
-https://github.com/mixpanel/mixpanel-react-native/pull/48
+  https://github.com/mixpanel/mixpanel-react-native/pull/48
 - Fix iOS compile error
-https://github.com/mixpanel/mixpanel-react-native/pull/53
+  https://github.com/mixpanel/mixpanel-react-native/pull/53
 
 #
 
 ## [v1.2.0](https://github.com/mixpanel/mixpanel-react-native/tree/v1.2.0) (2021-05-03)
 
 - Add new settings APIs: setUseIpAddressForGeolocation, setLoggingEnabled(add android), setServerURL(add android)
-https://github.com/mixpanel/mixpanel-react-native/pull/44
+  https://github.com/mixpanel/mixpanel-react-native/pull/44
 
 #
 
 ## [v1.1.1](https://github.com/mixpanel/mixpanel-react-native/tree/v1.1.1) (2021-03-17)
+
 - Fix the issue of passing boolean value as int in iOS
-https://github.com/mixpanel/mixpanel-react-native/pull/34
+  https://github.com/mixpanel/mixpanel-react-native/pull/34
 
 #
 
 ## [v1.1.0](https://github.com/mixpanel/mixpanel-react-native/tree/v1.1.0) (2021-03-03)
+
 - Add Typescript support
 - https://github.com/mixpanel/mixpanel-react-native/pull/31. thanks @sroy3 !
 
 #
 
 ## [v1.0.2](https://github.com/mixpanel/mixpanel-react-native/tree/v1.0.2) (2021-01-27)
-- Fix dynamic type not being able to convert properly in android that causes some group apis to fail 
-PR: https://github.com/mixpanel/mixpanel-react-native/pull/23
-This is to address issue: https://github.com/mixpanel/mixpanel-react-native/issues/21
+
+- Fix dynamic type not being able to convert properly in android that causes some group apis to fail
+  PR: https://github.com/mixpanel/mixpanel-react-native/pull/23
+  This is to address issue: https://github.com/mixpanel/mixpanel-react-native/issues/21
 
 #
 
 ## [v1.0.0](https://github.com/mixpanel/mixpanel-react-native/tree/v1.0.0) (2020-12-08)
-- This is our first release! :tada::tada::tada: 
-Report issues or give us any feedback is appreciated!
+
+- This is our first release! :tada::tada::tada:
+  Report issues or give us any feedback is appreciated!
 - integration guide: https://developer.mixpanel.com/docs/react-native
 - full API reference: https://mixpanel.github.io/mixpanel-react-native
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/README.md

@@ -100,7 +100,13 @@ const SampleApp = () => {
 export default SampleApp;
 
 ```
-### For Expo support, please refer to this [issue](https://github.com/mixpanel/mixpanel-react-native/issues/82)
+### Expo and React Native for Web support
+Starting from version 3.0.0, we have introduced support for Expo, React Native for Web, and other platforms utilizing React Native that do not support iOS and Android directly. To enable this feature, initialize Mixpanel with an additional parameter, `useNative`, set to false(```const mixpanel = new Mixpanel(
+    "YOUR_MIXPANEL_TOKEN",
+    trackAutomaticEvents,
+    useNative
+  );```). This will activate JavaScript mode. Please note that this functionality is currently in beta testing. For further details and installation guidelines, refer to the release notes available at Mixpanel React Native [v3.0.0-beta.1](https://github.com/mixpanel/mixpanel-react-native/releases/tag/v3.0.0-beta.1).
+
 👋 👋  Tell us about the Mixpanel developer experience! [https://www.mixpanel.com/devnps](https://www.mixpanel.com/devnps) 👍  👎