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

package/CHANGELOG.md

@@ -1,6 +1,9 @@
 
 # Changelog
 
+## 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
@@ -95,13 +133,14 @@ let App = withReactNavigationAutotrack(autocaptureNavigationTrack)(AppNavigator)
 
 
 ## Custom event tracking to track your application specific events and state changes
+<strong>_*** Note: Supported only in Android right now ***_<br></strong><br>
 Use trackCustomEvent() API to track all kinds of events. This API provides 2 fields to describe the tracked events.
 
 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 +154,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 +167,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 +177,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.) |

package/android/src/main/java/com/conviva/react/apptracker/util/TrackerVersion.java

@@ -4,6 +4,6 @@ import com.conviva.react.apptracker.BuildConfig;
 
 public class TrackerVersion {
 
-    public final static String RN_CONVIVA_TRACKER_VERSION = "rn-0.1.4";
+    public final static String RN_CONVIVA_TRACKER_VERSION = "rn-0.1.5";
 
 }

package/ios/RNConvivaAppAnalytics.m

@@ -637,10 +637,10 @@ RCT_EXPORT_METHOD(trackCustomEvent:
 
     if (trackerController != nil) {
         NSString *eventName = [details objectForKey:@"eventName"];
-        NSString *eventData = [details objectForKey:@"eventData"];
+        NSDictionary *eventData = [details objectForKey:@"eventData"];
 
         if(0 < eventName.length){
-            [trackerController trackCustomEvent:eventName data:eventData];
+            [trackerController trackCustomEvent:eventName eventData:eventData];
         }
         
         resolve(@YES);
@@ -1011,13 +1011,20 @@ RCT_EXPORT_METHOD(getIsInBackground:
                   (NSDictionary *)details
                   resolver:(RCTPromiseResolveBlock)resolve
                   rejecter:(RCTPromiseRejectBlock)reject) {
-    NSString *namespace = [details objectForKey:@"tracker"];
-    id<CATTrackerController> trackerController = [self trackerByNamespace:namespace];
-
-    if (trackerController != nil) {
-        BOOL isInBg = [trackerController.session isInBackground];
-        resolve(@(isInBg));
-    } else {
+//    NSString *namespace = [details objectForKey:@"tracker"];
+//    id<CATTrackerController> trackerController = [self trackerByNamespace:namespace];
+//
+//    if (trackerController != nil) {
+//        BOOL isInBg = [trackerController.session isInBackground];
+//        resolve(@(isInBg));
+//    } else {
+//        NSError* error = [NSError errorWithDomain:@"ConvivaAppAnalytics" code:200 userInfo:nil];
+//        reject(@"ERROR", @"tracker with given namespace not found", error);
+//    }
+
+    @try {
+        resolve(@(YES));
+    } @catch (NSException *exception) {
         NSError* error = [NSError errorWithDomain:@"ConvivaAppAnalytics" code:200 userInfo:nil];
         reject(@"ERROR", @"tracker with given namespace not found", error);
     }
@@ -1027,13 +1034,19 @@ RCT_EXPORT_METHOD(getBackgroundIndex:
                   (NSDictionary *)details
                   resolver:(RCTPromiseResolveBlock)resolve
                   rejecter:(RCTPromiseRejectBlock)reject) {
-    NSString *namespace = [details objectForKey:@"tracker"];
-    id<CATTrackerController> trackerController = [self trackerByNamespace:namespace];
-
-    if (trackerController != nil) {
-        NSInteger bgIdx = [trackerController.session backgroundIndex];
-        resolve(@(bgIdx));
-    } else {
+//    NSString *namespace = [details objectForKey:@"tracker"];
+//    id<CATTrackerController> trackerController = [self trackerByNamespace:namespace];
+//
+//    if (trackerController != nil) {
+//        NSInteger bgIdx = [trackerController.session backgroundIndex];
+//        resolve(@(bgIdx));
+//    } else {
+//        NSError* error = [NSError errorWithDomain:@"ConvivaAppAnalytics" code:200 userInfo:nil];
+//        reject(@"ERROR", @"tracker with given namespace not found", error);
+//    }
+    @try {
+        resolve(@(YES));
+    } @catch (NSException *exception) {
         NSError* error = [NSError errorWithDomain:@"ConvivaAppAnalytics" code:200 userInfo:nil];
         reject(@"ERROR", @"tracker with given namespace not found", error);
     }
@@ -1043,13 +1056,19 @@ RCT_EXPORT_METHOD(getForegroundIndex:
                   (NSDictionary *)details
                   resolver:(RCTPromiseResolveBlock)resolve
                   rejecter:(RCTPromiseRejectBlock)reject) {
-    NSString *namespace = [details objectForKey:@"tracker"];
-    id<CATTrackerController> trackerController = [self trackerByNamespace:namespace];
-
-    if (trackerController != nil) {
-        NSInteger fgIdx = [trackerController.session foregroundIndex];
-        resolve(@(fgIdx));
-    } else {
+//    NSString *namespace = [details objectForKey:@"tracker"];
+//    id<CATTrackerController> trackerController = [self trackerByNamespace:namespace];
+//
+//    if (trackerController != nil) {
+//        NSInteger fgIdx = [trackerController.session foregroundIndex];
+//        resolve(@(fgIdx));
+//    } else {
+//        NSError* error = [NSError errorWithDomain:@"ConvivaAppAnalytics" code:200 userInfo:nil];
+//        reject(@"ERROR", @"tracker with given namespace not found", error);
+//    }
+    @try {
+        resolve(@(YES));
+    } @catch (NSException *exception) {
         NSError* error = [NSError errorWithDomain:@"ConvivaAppAnalytics" code:200 userInfo:nil];
         reject(@"ERROR", @"tracker with given namespace not found", error);
     }

package/ios/Util/RNTrackerVersion.m

@@ -22,6 +22,6 @@
 
 @implementation RNTrackerVersion
 
-NSString * const kRNTrackerVersion = @"rn-0.1.4";
+NSString * const kRNTrackerVersion = @"rn-0.1.5";
 
 @end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@convivainc/conviva-react-native-appanalytics",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Conviva React Native Application Analytics Library",
   "main": "conviva-react-native-appanalytics.js",
   "repository": {

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -1,2 +0,0 @@
-#Mon Dec 18 17:16:15 IST 2023
-gradle.version=7.5

package/android/.gradle/config.properties

@@ -1,2 +0,0 @@
-#Mon Dec 18 17:16:12 IST 2023
-java.home=/private/var/folders/k4/74893875541dtbxdz44z6zbr0000gn/T/AppTranslocation/4A54960E-0028-414A-AF27-0F092C67D374/d/Android Studio.app/Contents/jbr/Contents/Home

package/android/.idea/compiler.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CompilerConfiguration">
-    <bytecodeTargetLevel target="11" />
-  </component>
-</project>

package/android/.idea/gradle.xml

@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GradleMigrationSettings" migrationVersion="1" />
-  <component name="GradleSettings">
-    <option name="linkedExternalProjectsSettings">
-      <GradleProjectSettings>
-        <option name="testRunner" value="GRADLE" />
-        <option name="externalProjectPath" value="$PROJECT_DIR$" />
-        <option name="gradleJvm" value="Embedded JDK" />
-        <option name="modules">
-          <set>
-            <option value="$PROJECT_DIR$" />
-          </set>
-        </option>
-        <option name="resolveExternalAnnotations" value="false" />
-      </GradleProjectSettings>
-    </option>
-  </component>
-</project>

package/android/.idea/migrations.xml

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectMigrations">
-    <option name="MigrateToGradleLocalJavaHome">
-      <set>
-        <option value="$PROJECT_DIR$" />
-      </set>
-    </option>
-  </component>
-</project>

package/android/.idea/misc.xml

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ExternalStorageConfigurationManager" enabled="true" />
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" project-jdk-name="11" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/build/classes" />
-  </component>
-  <component name="ProjectType">
-    <option name="id" value="Android" />
-  </component>
-</project>

package/android/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$/.." vcs="Git" />
-  </component>
-</project>

package/android/local.properties

@@ -1,8 +0,0 @@
-## This file must *NOT* be checked into Version Control Systems,
-# as it contains information specific to your local configuration.
-#
-# Location of the SDK. This is only used by Gradle.
-# For customization when using a Version Control System, please read the
-# header note.
-#Mon Dec 18 17:16:12 IST 2023
-sdk.dir=/Users/sramachandra/Library/Android/sdk