Release 2.1.1

Author: rohan-devrev

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.1] - 2025-07-25
+
+### Fixed
+- Fixed an issue with manual unmasking of input components. 
+- Fixed an issue with session uploads when the app is rapidly killed.
+
 ## [2.1.0] - 2025-06-27
 
 ### Added

MIGRATION.md

@@ -7,7 +7,7 @@ This guide and chart should help facilitate the transition from the legacy UserE
 |-|-|-|
 | Installation | `cordova plugin add userexperior-cordova-plugin@<version>` | `cordova plugin add @devrev/sdk-cordova@<version>` |
 | Initialization | `UserExperior.startRecording(appID)` | `DevRev.configure(appID, successCallback, errorCallback)` |
-| User Identification | `UserExperior.setUserIdentifier(userIdentifier)` | `DevRev.identifyAnonymousUser(userID, successCallback, errorCallback)`<br> `DevRev.identifyUnverifiedUser(identity, successCallback, errorCallback)`<br> `DevRev.updateUser(identity, successCallback, errorCallback)`<br> `DevRev.logout(deviceID, successCallback, errorCallback)` |
+| User Identification | `UserExperior.setUserIdentifier(userIdentifier)` | `DevRev.identifyAnonymousUser(userID, successCallback, errorCallback)`<br> `DevRev.identifyUnverifiedUser(identity, successCallback, errorCallback)`<br> `DevRev.identifyVerifiedUser(userID, sessionToken, successCallback, errorCallback)`<br> `DevRev.updateUser(identity, successCallback, errorCallback)`<br> `DevRev.logout(deviceID, successCallback, errorCallback)` |
 | Event Tracking | `UserExperior.logEvent(name)` | `DevRev.trackEvent(name, properties, successCallback, errorCallback)` |
 | Session Recording | `UserExperior.stopRecording()`<br />`UserExperior.pauseRecording()`<br />`UserExperior.resumeRecording()` | `DevRev.startRecording(successCallback, errorCallback)`<br />`DevRev.stopRecording(successCallback, errorCallback)`<br />`DevRev.pauseRecording(successCallback, errorCallback)`<br />`DevRev.resumeRecording(successCallback, errorCallback)`<br />`DevRev.processAllOnDemandSessions(successCallback, errorCallback)` |
 | Opting-in or out | `UserExperior.optOut()`<br> `UserExperior.optIn()`<br> `UserExperior.getOptOutStatus()` | `DevRev.stopAllMonitoring(successCallback, errorCallback)`<br> `DevRev.resumeAllMonitoring(successCallback, errorCallback)` |

README.md

@@ -5,13 +5,17 @@ DevRev SDK, used for integrating DevRev services into your Cordova app.
 - [DevRev SDK for Cordova](#devrev-sdk-for-cordova)
   - [Table of contents](#table-of-contents)
   - [Quickstart guide](#quickstart-guide)
+    - [Requirements](#requirements)
     - [Installation](#installation)
     - [Set up the DevRev SDK](#set-up-the-devrev-sdk)
   - [Features](#features)
     - [Identification](#identification)
       - [Anonymous identification](#anonymous-identification)
       - [Unverified identification](#unverified-identification)
       - [Verified identification](#verified-identification)
+        - [Generate an AAT](#generate-an-aat)
+        - [Exchange your AAT for a session token](#exchange-your-aat-for-a-session-token)
+        - [Identifying the verified user](#identifying-the-verified-user)
       - [Updating the user](#updating-the-user)
       - [Logout](#logout)
     - [PLuG support chat](#plug-support-chat)
@@ -43,6 +47,11 @@ DevRev SDK, used for integrating DevRev services into your Cordova app.
   - [Migration guide](#migration-guide)
 
 ## Quickstart guide
+### Requirements
+- Cordova 12.0 or later.
+- On Android, the minimum API level should be 24.
+- On iOS, the minimum deployment target should be 15.0.
+
 ### Installation
 To install the DevRev SDK, run the following command:
 
@@ -90,10 +99,53 @@ DevRev.identifyUnverifiedUser(identity, successCallback, errorCallback)
 ```
 
 #### Verified identification
-The verified identification method identifies users with a unique identifier and verifies their identity with the DevRev backend.
+The verified identification method is used to identify users with an identifier unique to your system within the DevRev platform. The verification is done through a token exchange process between you and the DevRev backend.
+
+The steps to identify a verified user are as follows:
+1. Generate an AAT for your system (preferably through your backend).
+2. Exchange your AAT for a session token for each user of your system.
+3. Pass the user identifier and the exchanged session token to the `DevRev.identifyVerifiedUser(userID, sessionToken, successCallback, errorCallback)` method.
+
+> [!CAUTION]
+> For security reasons we **strongly recommend** that the token exchange is executed on your backend to prevent exposing your application access token (AAT).
+
+##### Generate an AAT
+1. Open the DevRev web app at [https://app.devrev.ai](https://app.devrev.ai) and go to the **Settings** page.
+2. Open the **PLuG Tokens** page.
+3. Under the **Application access tokens** panel, click **New token** and copy the token that's displayed.
+
+> [!IMPORTANT]
+> Ensure that you copy the generated application access token, as you cannot view it again.
+
+##### Exchange your AAT for a session token
+In order to proceed with identifying the user, you need to exchange your AAT for a session token. This step will help you identify a user of your own system within the DevRev platform.
+
+Here is a simple example of an API request to the DevRev backend to exchange your AAT for a session token:
+> [!CAUTION]
+> Make sure that you replace the `<AAT>` and `<YOUR_USER_ID>` with the actual values.
+```bash
+curl \
+--location 'https://api.devrev.ai/auth-tokens.create' \
+--header 'accept: application/json, text/plain, */*' \
+--header 'content-type: application/json' \
+--header 'authorization: <AAT>' \
+--data '{
+  "rev_info": {
+    "user_ref": "<YOUR_USER_ID>"
+  }
+}'
+```
+
+The response of the API call will contain a session token that you can use with the verified identification method in your app.
+
+> [!NOTE]
+> As a good practice, **your** app should retrieve the exchanged session token from **your** backend at app launch or any relevant app lifecycle event.
+
+##### Identifying the verified user
+Pass the user identifier and the exchanged session token to the verified identification method:
 
 ```javascript
-DevRev.identifyVerifiedUser(identity, successCallback, errorCallback)
+DevRev.identifyVerifiedUser(userID, sessionToken, successCallback, errorCallback)
 ```
 
 #### Updating the user

devrev-sdk-cordova-2.1.1.tgz

@@ -24,6 +24,6 @@
     "platforms": []
   },
   "devDependencies": {
-    "@devrev/sdk-cordova": "^2.1.0"
+    "@devrev/sdk-cordova": "^2.1.1"
   }
 }