@convivainc/conviva-react-native-appanalytics 0.1.4 → 0.2.0

package/CHANGELOG.md

@@ -1,6 +1,15 @@
 
 # Changelog
 
+## 0.2.0 (06/SEP/2024)
+- Introduces API for setting the conviva identifier
+- Internal enhancements for the Android Bridge
+*This feature needs the Android App SDK version of [0.9.5](https://github.com/Conviva/conviva-android-appanalytics)*
+*This feature needs the iOS App SDK version of [0.2.30](https://github.com/Conviva/conviva-ios-appanalytics)*
+
+## 0.1.5 (07/JUN/2024)
+- Supports trackCustomEvent with JSONObject argument for [iOS Bridge](https://github.com/Conviva/conviva-ios-appanalytics)
+
 ## 0.1.4 (05/JAN/2024)
 - Supports the Auto Detection of ScreenView navigation if the application uses the [NavigationContainer](https://reactnavigation.org/docs/5.x/hello-react-navigation)(for react native version 5 and above) or [AppNavigator](https://reactnavigation.org/docs/4.x/hello-react-navigation)(for react native version below 5)<br>
  *Note:Please refer to [ScreenView Auto-Detection](https://github.com/Conviva/conviva-react-native-appanalytics?tab=readme-ov-file#auto-detect-screenview-events-for-tracking-screen-navigation) for more details*

package/README.md

@@ -10,7 +10,7 @@ npm install @convivainc/conviva-react-native-appanalytics --save
 npx pod-install
 ```
 
-## Android Gradle dependency
+## Android Native Sensor dependencies
 Add the following line to app's build.gradle file along with the dependencies:
 ```
 dependencies {
@@ -18,6 +18,28 @@ dependencies {
     implementation 'com.conviva.sdk:conviva-android-tracker:<version>'
 }
 ```
+Android Plugin should be used for the auto collection of **Button Click** and **OkHttp/Retrofit/HTTPSUrlConnection/HTTPUrlConnection** **NetworkRequest Tracking** features. The following example shows how to include the plugin:
+```
+// in the root or project-level build.gradle
+dependencies {
+  ...
+  // For Android Gradle Plugin version 8.0 and above, use
+  classpath 'com.conviva.sdk:android-plugin:0.3.x'
+
+  // For Android Gradle Plugin version below 8.0, use
+  classpath 'com.conviva.sdk:android-plugin:0.2.x'
+  ...
+}
+
+// in the app, build.gradle at the end of plugins add the
+...
+apply plugin: 'com.conviva.sdk.android-plugin'
+
+// in the app, build.gradle.kts at the end of plugins add the
+plugins {
+    id 'com.conviva.sdk.android-plugin'
+}
+```
 
 ## Initialize the tracker
 ```js
@@ -45,15 +67,31 @@ tracker.setSubjectData({userId: viewerId});
 
 ## Report PageView Events for tracking in-app page navigations.
 ```js
-tracker.trackPageViewEvent({pageUrl: string, pageTitle?: string, referrer?: string});
+tracker.trackPageView({pageUrl: string, pageTitle?: string, referrer?: string});
 
 let pageViewEvent = {'pageUrl' : 'https://allpopulated.com',
       'pageTitle' : 'some title',
       'referrer' : 'http://refr.com'};
-tracker.trackPageViewEvent(pageViewEvent);
+tracker.trackPageView(pageViewEvent);
+```
+
+## Auto detect button clicks.
+Even though the React Native components can be natively mapped in Android and iOS, for the Auto detection of button clicks for **Button**, **TouchableHighlight**, **TouchableOpacity**, **TouchableWithoutFeedback** and **TouchableNativeFeedback** Components, needs explicit addition of babel transfomation. Add below plugin code in your application .babel.rc or babel.config.js file:
+
+```js
+
+"plugins": ["./node_modules/@convivainc/conviva-react-native-appanalytics/instrumentation/index.js"]
+
 ```
 
 ## Auto detect ScreenView Events for tracking screen navigation.
+To support Conviva to Auto Detect the Screen Name part of the ScreenView Events, add below plugin code in your application .babel.rc or babel.config.js file:
+```js
+
+"plugins": ["add-react-displayname"]
+
+```
+
 For React Navigation versions 5 and above, to autocapture screenviews, wrap withReactNavigationAutotrack(autocaptureNavigationTrack) around the NavigationContainer:
 
 ```js
@@ -101,7 +139,7 @@ eventName - Name of the custom event. (Mandatory)
 
 eventData - Any JSON Object.
 
-The following example shows the implementation of the 'onClick' event listener to any element.
+The following example shows the implementation of the application using these API's:
 ```js
 tracker.trackCustomEvent(eventName: string, eventData?: any);
 
@@ -115,7 +153,7 @@ Use setCustomTags() API to set all kinds of tags (key value pairs). This API pro
 
 data - Any JSON Object.
 
-The following example shows the implementation of the 'onClick' event listener to any element.
+The following example shows the implementation of the application using this API:
 
 ```js
 tracker.setCustomTags(customTagsToSet: any);
@@ -128,7 +166,7 @@ Use clearCustomTags() API to remove that are set prior. This API provides 1 argu
 
 keys - Array of strings representing tag keys.
 
-The following example shows the implementation of the 'onClick' event listener to any element.
+The following example shows the implementation of the application using this API:
 ```js
 tracker.clearCustomTags(tagKeys: string[]);
 
@@ -138,7 +176,22 @@ tracker.clearCustomTags(customTagKeysToClear);
 
 Use clearAllCustomTags() API to remove all the custom tags that are set prior.
 
-The following example shows the implementation of the 'onClick' event listener to any element.
+The following example shows the implementation of the application using this API:
 ```js
 tracker.clearAllCustomTags();
 ```
+
+<details>
+    <summary><b>Auto-collected Events</b></summary>
+    
+##### Conviva provides a rich set of application performance metrics with the help of autocollected app events, such as _screen_view_ , _button_click_, and _network_request_. 
+
+Event | Occurrence |
+------|------------ |
+network_request | after receiving the network request response ; auto collected from the Native Sensors, Need android-plugin inclusion for Android|
+screen_view | when the screen is interacted on either first launch or relaunch ; auto collected from the Native Sensors + React Native Screens; Need add-react-displayname plugin and wrapping of Navigation Components |
+application_error | when an error occurrs in the application ; auto collected from the Native Sensors|
+button_click | on the button click callback ; auto collected from the Native Sensors + React Native **Button**, **TouchableHighlight**, **TouchableOpacity**, **TouchableWithoutFeedback** and **TouchableNativeFeedback** Components; Need Conviva index.js from the node_modules folder|
+application_background | when the application is taken to the background ; auto collected from the Native Sensors|
+application_foreground | when the application is taken to the foreground ; auto collected from the Native Sensors|
+application_install | when the application is launched for the first time after it's installed. (It's not the exact installed time.) |