v10.3.1 release

Author: RN SDK Release User

CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [10.3.1] - 2023-09-21
+
+### Added:
+
+- Added a helper function `byteArrayStringToBase64` for converting the `fileData` attribute of a `MediaFile`, from a String representation of byte array data, to a Base64 format - in the custom media callbacks use case.
+
+### Changed:
+
+- Updated the `OnfidoMediaResult` type so that `captureType` is visible. This refers to the type of the media capture in each case, which can be `DOCUMENT`, `FACE` or `VIDEO`.
+- Updated the Media Callbacks documentation.
+
 ## [10.3.0] - 2023-09-11
 
 ### Added:

README.md

@@ -19,14 +19,17 @@
     - [4.4 Update your iOS configuration files](#44-update-your-ios-configuration-files)
       - [Enabling NFC extraction](#enabling-nfc-extraction)
 - [Usage](#usage)
-  - [User data](#user-data)
   - [1. Creating the SDK configuration](#1-creating-the-sdk-configuration)
   - [2. Parameter details](#2-parameter-details)
   - [3. Success Response](#3-success-response)
   - [4. Failure Response](#4-failure-response)
   - [5. Localization](#5-localization)
     - [Android](#android)
     - [iOS](#ios)
+- [Media Callbacks](#media-callbacks)
+  - [Introduction](#introduction)
+  - [Implementation](#implementation)
+  - [User data](#user-data)
 - [Creating checks](#creating-checks)
   - [1. Obtaining an API token](#1-obtaining-an-api-token-1)
   - [2. Creating a check](#2-creating-a-check)
@@ -341,73 +344,6 @@ export default class App extends Component {
     );
   }
 }
-
-### Media Callbacks (beta)
-
-### Introduction
-Onfido provides the possibility to integrate with our Smart Capture SDK, without the requirement of using this data only through the Onfido API. Media callbacks enable you to control the end user data collected by the SDK after the end user has submitted their captured media. As a result, you can leverage Onfido’s advanced on-device technology, including image quality validations, while still being able to handle end users’ data directly. This unlocks additional use cases, including compliance requirements and multi-vendor configurations, that require this additional flexibility.
-
-**This feature must be enabled for your account.** Please contact your Onfido Solution Engineer or Customer Success Manager.
-
-### Implementation
-To use this feature, use `Onfido.addCustomMediaCallback` and provide the callback.
-
-```javascript
-Onfido.addCustomMediaCallback(
-  mediaResult => {
-    if (mediaResult.captureType === 'DOCUMENT') {
-      // Callback code here
-    } else if (mediaResult.captureType === 'FACE') {
-      // Callback code here
-    } else if (mediaResult.captureType === 'VIDEO') {
-      // Callback code here
-    }
-  }
-);
-```
-
-### User data
-The callbacks return an object including the information that the SDK normally sends directly to Onfido. The callbacks are invoked when the end user confirms submission of their image through the SDK’s user interface.
-
-**Note:** Currently, end user data will still automatically be sent to the Onfido backend, but you are not required to use Onfido to process this data.
-
-The callback returns 3 possible objects. Please note, `captureType` refers to the type of the media capture in each case.
-These can be `DOCUMENT`, `FACE` or `VIDEO`.
-
-1. For documents(`captureType` is `DOCUMENT`), the callback returns:
-```json5
-     {
-         captureType: String
-         side: String
-         type: String
-         issuingCountry: String?
-         fileData: Data
-         fileName: String
-         fileType: String
-     }
-```
-
-**Note:** `issuingCountry` is optional based on end-user selection, and can be `null`.
-**Note:** If a document was scanned using NFC, the callback will return the passport photo in `file` but no additional data.
-
-2. For live photos (`captureType` is `FACE`), the callback returns:
-```json5
-{
-    captureType: String
-    fileData: Data
-    fileName: String
-    fileType: String
-}
-```
-
-3. For videos(`captureType` is `VIDEO`), the callback returns:
-```json5
-{
-    captureType: String
-    fileData: Data
-    fileName: String
-    fileType: String
-}
 ```
 
 ### 1. Creating the SDK configuration
@@ -457,7 +393,9 @@ config = {
     * Valid values in `OnfidoFaceSelfieCapture`: `type`: OnfidoCaptureType.PHOTO
     * Valid values in `OnfidoFaceVideoCapture`: `type`: OnfidoCaptureType.VIDEO
 
-    **Note**: In the scenario that the Motion variant is not supported on the user's device, if you configure the `motionCaptureFallback` appropriately it will allow the user to capture a Selfie or a Video as a fallback.
+    In the scenario that the Motion variant is not supported on the user's device, if you configure the `motionCaptureFallback` appropriately it will allow the user to capture a Selfie or a Video as a fallback.
+    
+    **Note**: Fallback is not used in Android anymore as Motion is supported in all devices and OS versions specified by the SDK.
 * **`recordAudio`**: Required if captureFace is specified as MOTION.
   * Valid values: `true`, `false`
 * **`localisation`**: Optional. This object contains localisation configuration. See section [Localization](#localization) for the details.
@@ -584,6 +522,84 @@ localisation: {
 3. Follow the instructions for [iOS Localisation](https://medium.com/lean-localization/ios-localization-tutorial-938231f9f881) to add a new custom language or override existing translations.
 4. You can find the keys that need to be translated in the [iOS SDK repo](https://github.com/onfido/onfido-ios-sdk/blob/master/localization/Localizable_EN.strings).
 
+## Media Callbacks
+
+### Introduction
+Onfido provides the possibility to integrate with our Smart Capture SDK, without the requirement of using this data only through the Onfido API. Media callbacks enable you to control the end user data collected by the SDK after the end user has submitted their captured media. As a result, you can leverage Onfido’s advanced on-device technology, including image quality validations, while still being able to handle end users’ data directly. This unlocks additional use cases, including compliance requirements and multi-vendor configurations, that require this additional flexibility.
+
+**This feature must be enabled for your account.** Please contact your Onfido Solution Engineer or Customer Success Manager.
+
+### Implementation
+To use this feature, use `Onfido.addCustomMediaCallback` and provide the callback.
+
+```javascript
+Onfido.addCustomMediaCallback(
+  mediaResult => {
+    if (mediaResult.captureType === 'DOCUMENT') {
+      // Callback code here
+    } else if (mediaResult.captureType === 'FACE') {
+      // Callback code here
+    } else if (mediaResult.captureType === 'VIDEO') {
+      // Callback code here
+    }
+  }
+);
+```
+
+### User data
+The callbacks return an object including the information that the SDK normally sends directly to Onfido. The callbacks are invoked when the end user confirms submission of their image through the SDK’s user interface.
+
+**Note:** Currently, end user data will still automatically be sent to the Onfido backend, but you are not required to use Onfido to process this data.
+
+The callback returns 3 possible objects. Please note that `captureType` refers to the type of the media capture in each case.
+These can be `DOCUMENT`, `FACE` or `VIDEO`.
+
+1. For documents (`captureType` is `DOCUMENT`), the callback returns:
+```json5
+{
+    captureType: String
+    side: String
+    type: String
+    issuingCountry: String?
+    fileData: String
+    fileName: String
+    fileType: String
+}
+```
+
+**Notes:**
+- `issuingCountry` is optional based on end-user selection, and can be `null`.
+- `fileData` is a String representation of the byte array data corresponding to the captured photo of the document.
+- If a document was scanned using NFC, the callback will return the passport photo in `fileData` but no additional data.
+
+2. For live photos (`captureType` is `FACE`), the callback returns:
+```json5
+{
+    captureType: String
+    fileData: String
+    fileName: String
+    fileType: String
+}
+```
+**Note:** `fileData` is a String representation of the byte array data corresponding to the captured live photo.
+
+3. For videos(`captureType` is `VIDEO`), the callback returns:
+```json5
+{
+    captureType: String
+    fileData: String
+    fileName: String
+    fileType: String
+}
+```
+**Note:** `fileData` is a String representation of the byte array data corresponding to the captured video.
+
+Please note that, for your convenience, Onfido provides the `byteArrayStringToBase64` helper function to convert the `fileData` from String to a Base64 format. Here is an example of how to use it:
+```javascript
+let byteArrayString = mediaResult.fileData;
+let base64FileData = Onfido.byteArrayStringToBase64(byteArrayString);
+```
+
 ## Creating checks
 
 As the SDK is only responsible for capturing and uploading photos/videos, you would need to start a check on your backend server using the [Onfido API](https://documentation.onfido.com/).

android/src/main/AndroidManifest.xml

@@ -8,6 +8,6 @@
 
         <meta-data
             android:name="onfido_integration_version"
-            android:value="10.3.0" />
+            android:value="10.3.1" />
     </application>
 </manifest>

ios/CallbackReceiver.swift

@@ -40,9 +40,11 @@ extension CallbackReceiver: MediaCallback {
     }
 
     private func send(dictionary: [String: Any], mediaFile file: MediaFile) {
+        let fileData = getArrayOfBytesFromImage(data: file.fileData as NSData).description
+
         var newDict = dictionary
         newDict[Keys.MediaCallback.fileName] = file.fileName
-        newDict[Keys.MediaCallback.fileData] = file.fileData
+        newDict[Keys.MediaCallback.fileData] = fileData
         newDict[Keys.MediaCallback.fileType] = file.fileType
 
         guard let onMediaCallback = onMediaCallback else {
@@ -51,4 +53,18 @@ extension CallbackReceiver: MediaCallback {
         }
         onMediaCallback(newDict)
     }
+
+    // TODO: Temporary. Removed when introducing breaking change to return Base64 encoded string.
+    // https://stackoverflow.com/a/65265130
+    private func getArrayOfBytesFromImage(data: NSData) -> Array<Int8> {
+        let count = data.length / MemoryLayout<Int8>.size
+        var bytes = [Int8](repeating: 0, count: count)
+        data.getBytes(&bytes, length:count * MemoryLayout<Int8>.size)
+
+        var byteArray:Array = Array<Int8>()
+        for i in 0 ..< count {
+            byteArray.append(bytes[i])
+        }
+        return byteArray
+    }
 }

js/Onfido.ts

@@ -9,6 +9,7 @@ import {
     OnfidoMediaResult,
     OnfidoResult
 } from "./config_constants";
+import { Base64 } from 'js-base64';
 
 const {OnfidoSdk} = NativeModules;
 
@@ -86,6 +87,7 @@ const Onfido = {
             if (config.flowSteps.captureFace && !(config.flowSteps.captureFace.type in OnfidoCaptureType)) {
                 return configError("Capture Face type is invalid");
             }
+            
         }
 
     return OnfidoSdk.start(config).catch((error: any) => {
@@ -101,6 +103,30 @@ const Onfido = {
     eventEmitter.removeAllListeners('onfidoMediaCallback');
 
     return eventEmitter.addListener('onfidoMediaCallback', callback);
+  },
+
+  byteArrayStringToBase64(byteArrayString: String) {
+    let charString = '';
+
+    // Iterate through the string and convert each number to string
+    // Iteration starts from the 1st element to ignore brackets
+    let currentNumber = '';
+    for (let i = 1; i < byteArrayString.length; i++) {
+      const char = byteArrayString.charAt(i);
+      if ((char >= '0' && char <= '9') || char === '-') {
+        currentNumber += char;
+      } else {
+        // Convert the collected number to string
+        if (currentNumber) {
+          const number = parseInt(currentNumber, 10);
+          charString += String.fromCharCode(number & 0xFF);
+          currentNumber = '';
+        }
+      }
+    }
+
+    // Convert to base64
+    return Base64.btoa(charString);
   }
 };
 

js/__tests__/Onfido.spec.ts

@@ -22,12 +22,12 @@ const REJECTED = 'rejected';
 
 const start = (config: OnfidoConfig) => {
   return Onfido.start(config)
-    .then(() => {
-      return RESOLVED
-    })
-    .catch(() => {
-      return REJECTED
-    });
+      .then(() => {
+        return RESOLVED
+      })
+      .catch(() => {
+        return REJECTED
+      });
 };
 
 const flowSteps = {
@@ -71,7 +71,7 @@ testCases.forEach((platform) => {
     test('resolve a capture document object with explicitly null attributes', () => {
       return start({ ...baseConfig, flowSteps: { ...flowSteps, captureDocument: { docType: null, countryCode: null } } } as unknown as OnfidoConfig).then(result => expect(result).toBe(RESOLVED))
     });
-    
+
     test('resolve with a valid workflow runId', () => {
       return start({ ...baseConfig, workflowRunId: workflowRunId }).then(result => expect(result).toBe(RESOLVED))
     });
@@ -116,5 +116,15 @@ testCases.forEach((platform) => {
     test('reject with an empty captureDocument and captureFace', () => {
       return start({ ...baseConfig, flowSteps: { ...flowSteps, captureDocument: {}, captureFace: {} } } as unknown as OnfidoConfig).then(result => expect(result).toBe(REJECTED))
     });
+
+    test('base 64 helper function converts data array correctly to base64', () => {
+      // pass nothing, see nothing
+      const base64DataNothing = Onfido.byteArrayStringToBase64("")
+      expect(base64DataNothing).toBe("")
+
+      // intended use case for this method is that it must contain brackets as well
+      const base64DataFilled = Onfido.byteArrayStringToBase64("[104, 101, 108, 108, 111, 32, 76, 117, 107, 97, 115]")
+      expect(base64DataFilled).toBe("aGVsbG8gTHVrYXM=")
+    });
   });
-});
+});

js/config_constants.ts

@@ -47,6 +47,7 @@ export interface OnfidoError extends Error {
 }
 
 export interface OnfidoMediaResult {
+  captureType: "DOCUMENT" | "FACE" | "VIDEO";
 }
 
 export interface OnfidoDocumentResult extends OnfidoMediaResult {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@onfido/react-native-sdk",
   "title": "React Native Onfido Sdk",
-  "version": "10.3.0",
+  "version": "10.3.1",
   "description": "Onfido React Native SDK",
   "main": "index.ts",
   "scripts": {
@@ -82,7 +82,9 @@
     "react-native": "0.72.1",
     "typescript": "^4.6.4"
   },
-  "dependencies": {},
+  "dependencies": {
+    "js-base64": "3.7.5"
+  },
   "engines": {
     "node": ">=16"
   }

yarn.lock

@@ -4902,6 +4902,11 @@ joi@^17.2.1:
     "@sideway/formula" "^3.0.0"
     "@sideway/pinpoint" "^2.0.0"
 
+[email protected]:
+  version "3.7.5"
+  resolved "https://registry.npmjs.org/js-base64/-/js-base64-3.7.5.tgz#21e24cf6b886f76d6f5f165bfcd69cc55b9e3fca"
+  integrity sha512-3MEt5DTINKqfScXKfJFrRbxkrnk2AxPWGBL/ycjz4dK8iqiSJ06UxD8jh8xuh6p10TX4t2+7FsBYVxxQbMg+qA==
+
 js-tokens@^3.0.0:
   version "3.0.2"
   resolved "https://registry.npmjs.org/js-tokens/-/js-tokens-3.0.2.tgz"