klaritics-react-native-sdk 1.0.0

package/README.md

@@ -0,0 +1,334 @@
+<h1 align="center">klaritics-react-native-sdk</h1>
+
+<p align="center">
+  <a href="https://npmjs.com/package/klaritics-react-native-sdk"><img src="https://img.shields.io/npm/v/klaritics-react-native-sdk?style=for-the-badge&labelColor=000000" alt="npm-v"></a>
+  <a href="https://npmjs.com/package/klaritics-react-native-sdk"><img src="https://img.shields.io/npm/dt/klaritics-react-native-sdk.svg?style=for-the-badge&labelColor=000000" alt="npm-d"></a>
+  <a href="https://bundlephobia.com/result?p=klaritics-react-native-sdk"><img src="https://img.shields.io/bundlephobia/minzip/klaritics-react-native-sdk?style=for-the-badge&labelColor=000000" alt="minzip"></a>
+</p>
+
+## Description
+
+React Native wrapper for Apxor SDK. Please refer Plugins section to integrate other Apxor plugins.
+
+---
+
+## 🏁 Getting Started
+
+### A. For `react-native` version `0.59.0` and lower
+
+1. Run the following commands:
+
+```bash
+npm i klaritics-react-native-sdk
+react-native link klaritics-react-native-sdk
+```
+
+2. Open up `android/app/src/main/java/[...]/MainActivity.java`
+
+   - Add `import com.deeptaai.reactnativesdk.KlariticsPackage;` to the imports at the top of the file
+   - Add `new KlariticsPackage()` to the list returned by the `getPackages()` method
+
+   ```java
+   @Override
+   protected List<ReactPackage> getPackages() {
+       return Arrays.<ReactPackage>asList(
+               new MainReactPackage(),
+               ...
+               new KlariticsPackage(), <- ApxorSDK package
+               ...
+       );
+   }
+   ```
+
+3. Append the following lines to `android/settings.gradle`:
+
+```groovy
+include ':klaritics-react-native-sdk'
+project(':klaritics-react-native-sdk').projectDir = new File(rootProject.projectDir, '../node_modules/klaritics-react-native-sdk/android')
+```
+
+### B. For `react-native` version `0.60.0` and higher
+
+Run the following commands:
+
+```bash
+npm i klaritics-react-native-sdk
+```
+
+---
+
+## 🤖 Integrate Apxor React Native Android SDK
+
+1. Insert the following lines inside repositories block in `android/build.gradle`
+
+```groovy
+  maven { url "http://repo.apxor.com/artifactory/list/libs-release-android/" }
+  maven { url "https://dl.bintray.com/apxor/apxor-android" }
+```
+
+2. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
+
+```groovy
+  implementation 'com.apxor.androidx:apxor-android-sdk-core:2.8.3@aar'
+```
+
+3. Add the following `meta-data` tag inside `application` tag of `AndroidManifest.xml` file:
+
+   ```xml
+   <application ...>
+       ...
+       <meta-data android:name="APXOR_APP_ID" android:value=[REPLACE_YOUR_APXOR_APP_ID_HERE] />
+       ...
+   </application>
+   ```
+
+### 🧩 Plugins (Optional)
+
+1. Add following dependencies in the `build.gradle` file.
+
+   ```groovy
+    // Add this to track uninstalls and send push notifications from Apxor dashboard
+    // Note: We don't support firebase-messaging >= 22.0.0 yet
+    implementation('com.apxor.androidx:apxor-android-sdk-push:1.2.7@aar') {
+      exclude group: 'com.google.firebase'
+    }
+
+    // Add these for Realtime Actions and Surveys
+    implementation 'com.apxor.androidx:apxor-android-sdk-qe:1.5.1@aar'
+    implementation 'com.apxor.androidx:apxor-android-sdk-rtm:1.8.9@aar'
+    implementation 'com.apxor.androidx:surveys:1.3.6@aar'
+
+    // Add this to track application crashes
+    implementation 'com.apxor.androidx:apxor-android-crash-reporter:1.0.5@aar'
+
+    // Helper plugin to create walkthroughs
+    implementation 'com.apxor.androidx:wysiwyg:1.2.6@aar'
+
+    // Add this to log events without attributes at runtime
+    implementation 'com.apxor.androidx:jit-log:1.0.0@aar'
+
+    // Getting a "Could not find" error? Make sure that you've added Apxor's Maven repository to your root-level build.gradle file.
+   ```
+
+   > **NOTE**
+   >
+   > If you are using `firebase-messaging >= 22.0.0`, use **`"com.apxor.androidx:apxor-android-sdk-push-v2"`** instead of **`"com.apxor.androidx:apxor-android-sdk-push"`**
+
+   ```groovy
+   implementation('com.apxor.androidx:apxor-android-sdk-push-v2:1.2.7@aar') {
+     exclude group: 'com.google.firebase'
+   }
+   ```
+
+2. Create `plugins.json` file in the `android/app/src/main/assets/` directory.
+
+3. Paste the following JSON code in that file:
+
+   ```json
+   {
+     "plugins": [
+       {
+         "name": "rtm",
+         "class": "com.apxor.androidsdk.plugins.realtimeui.ApxorRealtimeUIPlugin"
+       },
+       {
+         "name": "crash",
+         "class": "com.apxor.androidsdk.plugins.crash.CrashReporterPlugin"
+       },
+       {
+         "name": "push",
+         "class": "com.apxor.androidsdk.plugins.push.PushPlugin"
+       },
+       {
+         "name": "surveys",
+         "class": "com.apxor.androidsdk.plugins.survey.SurveyPlugin"
+       },
+       {
+         "name": "wysiwyg",
+         "class": "com.apxor.androidsdk.plugins.wysiwyg.WYSIWYGPlugin"
+       },
+       {
+         "name": "jitlog",
+         "class": "com.apxor.androidsdk.plugins.jitlog.ApxorJITLogPlugin"
+       }
+     ]
+   }
+   ```
+
+4. If you have extended the `FirebaseMessagingService` in your application, please use the below code in your `extends FirebaseMessagingService` class to receive Push notifications sent from the Apxor dashboard:
+
+   ```java
+   if (remoteMessage.getFrom().equals(YOUR_FCM_SENDER_ID)) {
+       // Your logic goes here
+   } else {
+       if (ApxorPushAPI.isApxorNotification(remoteMessage)) {
+           ApxorPushAPI.handleNotification(remoteMessage, getApplicationContext());
+       } else {
+           // Silent or Data push notification which you can send through Apxor dashboard
+       }
+   }
+   ```
+
+---
+
+## 🍎 Integrate Apxor React Native iOS SDK
+
+1. To **Auto initialize** the SDK (**Recommended**), add the following inside your `application` plist file.
+2. Open your application's `Info.plist` as source code.
+3. Copy and paste the following piece of code, to create an entry for ApxorSDK:
+
+   ```xml
+   <key>Apxor</key>
+   <dict>
+       <key>Core</key>
+       <string>{YOUR_APP_ID}</string>
+       <key>APXSurveyPlugin</key>
+       <true/>
+       <key>APXRTAPlugin</key>
+       <true/>
+       <key>APXWYSIWYGPlugin</key>
+       <true/>
+   </dict>
+   ```
+
+4. To add the **APXWYSIWYGPlugin**, add the following to your application's `.podspec` file:
+
+   ```js
+     s.dependency 'Apxor-WYSIWYG', '1.0.84'
+   ```
+
+   > **NOTE**
+   >
+   > The `APXWYSIWYGPlugin` is only for **debug** builds, make sure to remove it for **production** builds.
+
+---
+
+## 🚀 API & Usage
+
+### Imports
+
+```javascript
+// Import the SDK as a module
+import Klaritics from 'klaritics-react-native-sdk'
+
+// Or, import required modules
+import { ApxNavigationContainer, logAppEvent } from 'klaritics-react-native-sdk'
+```
+
+### Set Custom User IDs
+
+- Refer to the [Apxor Docs](https://docs.apxor.com/docs/APIs/react-native-guide#userid) for more details.
+
+```javascript
+// Syntax
+Klaritics.setUserIdentifier('user_id')
+
+// Example
+Klaritics.setUserIdentifier('john@doe.com')
+```
+
+### Set Custom User and Session Properties
+
+- Refer to the [Apxor Docs](https://docs.apxor.com/docs/APIs/react-native-guide#user-properties) for more details.
+
+```javascript
+// Syntax
+Klaritics.setUserCustomInfo(properties)
+Klaritics.setSessionCustomInfo(properties)
+
+// Example
+Klaritics.setUserCustomInfo({
+  city: 'Hyderabad',
+  age: 12,
+})
+```
+
+### Wrapper Components
+
+#### ApxorView
+
+- A wrapper over React Native's `View` component to track the View changes in the app.
+
+  ```jsx
+  // Syntax
+  <ApxorView
+    tag='<unique_constant_tag>'
+    {...otherViewProps}
+  >
+    // Your code goes here
+  </ApxorView>
+  ```
+
+### Logging Events
+
+- References :
+  - [App and Aggregate Events](https://docs.apxor.com/docs/APIs/react-native-guide#to-track-events)
+  - [Client Events](https://docs.apxor.com/docs/APIs/react-native-guide#to-track-client-events)
+
+```javascript
+// Syntax
+Klaritics.logAppEvent(event_name, properties)
+
+// Example
+Klaritics.logAppEvent('ADD_TO_CART', {
+  userId: 'user@example.com',
+  value: 1299,
+  item: 'Sony Head Phone 1201',
+})
+```
+
+### Tracking Navigation
+
+- References :
+  - [Track Navigation](https://docs.apxor.com/docs/APIs/react-native-guide#track-navigation)
+  - [React Navigation](https://reactnavigation.org/docs/getting-started/#wrapping-your-app-in-navigationcontainer)
+
+#### A. Screen Navigation
+
+##### 1. If you are already using `@react-navigation` for navigation in your app, Apxor SDK automatically tracks screen navigation if you follow the below mentioned steps:
+
+```jsx
+import { useNavigationContainerRef } from '@react-navigation/native'
+
+const navigationRef = useNavigationContainerRef()
+
+return (
+  <NavigationContainer
+    ref={navigationRef}
+    onReady={() => {
+      const currentRoute = navigationRef?.current.getCurrentRoute()
+      if (currentRoute) {
+        Klaritics.trackScreen(currentRoute.name)
+      }
+    }}
+    onStateChange={() => {
+      const currentRoute = navigationRef?.current.getCurrentRoute()
+      if (currentRoute) {
+        Klaritics.trackScreen(currentRoute.name)
+      }
+    }}
+  >
+    // your screens and navigators
+  </NavigationContainer>
+)
+```
+
+##### 2. Otherwise
+
+```javascript
+// Syntax
+Klaritics.logNavigationEvent(screen_name)
+
+// Example
+Klaritics.logNavigationEvent('LoginScreen')
+```
+
+#### B. Tab Navigation
+
+```javascript
+// Syntax
+Klaritics.trackScreen(tab_name)
+
+// Example
+Klaritics.trackScreen('Home')
+```

package/android/build.gradle

@@ -0,0 +1,66 @@
+buildscript {
+    if (project == rootProject) {
+        repositories {
+            google()
+            jcenter()
+        }
+
+        dependencies {
+            classpath 'com.android.tools.build:gradle:3.5.3'
+        }
+    }
+}
+
+apply plugin: 'com.android.library'
+
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+android {
+    compileSdkVersion safeExtGet('Klaritics_compileSdkVersion', 34)
+    defaultConfig {
+        minSdkVersion safeExtGet('Klaritics_minSdkVersion', 16)
+        targetSdkVersion safeExtGet('Klaritics_targetSdkVersion', 29)
+        versionCode 1
+        versionName "1.0"
+
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+        }
+    }
+    lintOptions {
+        disable 'GradleCompatible'
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+}
+
+repositories {
+    mavenLocal()
+    maven {
+        // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
+        url("$rootDir/../node_modules/react-native/android")
+    }
+    // Klaritics Android SDK is published to a private Google Artifact Registry repo.
+    maven {
+        url "https://asia-south1-maven.pkg.dev/org-infra-471907/klaritics-android-sdk"
+    }
+    google()
+    jcenter()
+}
+
+dependencies {
+    //noinspection GradleDynamicVersion
+    implementation "com.facebook.react:react-native:+"  // From node_modules
+
+    // Klaritics Android core SDK. `api` so the host app can access the SDK too.
+    api 'com.deeptaai.klaritics:klaritics-android-sdk:1.0.0'
+
+}

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

package/android/gradlew

@@ -0,0 +1,185 @@
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=`expr $i + 1`
+    done
+    case $i in
+        0) set -- ;;
+        1) set -- "$args0" ;;
+        2) set -- "$args0" "$args1" ;;
+        3) set -- "$args0" "$args1" "$args2" ;;
+        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=`save "$@"`
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+exec "$JAVACMD" "$@"

package/android/gradlew.bat

@@ -0,0 +1,104 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto init
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto init
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:init
+@rem Get command-line arguments, handling Windows variants
+
+if not "%OS%" == "Windows_NT" goto win9xME_args
+
+:win9xME_args
+@rem Slurp the command line arguments.
+set CMD_LINE_ARGS=
+set _SKIP=2
+
+:win9xME_args_slurp
+if "x%~1" == "x" goto execute
+
+set CMD_LINE_ARGS=%*
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.deeptaai.reactnativesdk">
+
+</manifest>