heapix-regula-react-bridge

Getting started

npm install heapix-regula-react-bridge --save

Mostly automatic installation

react-native link heapix-regula-react-bridge

iOS

1. Add to Podfile:

  pod 'DocumentReader', '~> 4.0'
  pod 'DocumentReaderFull', '~> 4.0'

1. Generate license for your application bundle ID: https://licensing.regulaforensics.com/. Convert it to a base64 string, e.g.: fs.readFileSync('./path/to/regula.license').toString('base64')
2. Download database from: https://licensing.regulaforensics.com/Customer/Account/Databases. Add it to the iOS project (db.dat).
3. Go to your project Targets -> Builds Settings -> Always Embed Swift Standard Libraries - set to Yes
4. Go to your project Targets -> Info -> Add new key Privacy - Camera Usage Description = “Your message that will be appeared during ask to run camera”.

Android

1. Open your top level build.gradle (android/build.gradle)
2. add the block below:

allprojects {
  repositories {
    maven {
      url "http://maven.regulaforensics.com/RegulaDocumentReader"
    }
  }
}

1. In your app level build.gradle:
2. increate 'minSdkVersion' to 19 (if it's below)
3. Open AndroidManifest.xml file and set: android:allowBackup="true"
4. mkdir -p android/app/src/main/res/raw/
5. Copy regula.license to that folder
6. This project comes bundled with a db.dat, but if you want to use the latest, download it from Regula and copy it to node_modules/heapix-regula-react-bridge/android/src/main/assets/Regula/

Usage

import RegulaDocumentReader, { Scenario } from 'heapix-regula-react-bridge';

// For reduce your package size database (db.dat file) can be obtained 
// from the network. In order to download db.dat file you should know 
// its identifier, all database identifiers you can find on https://licensing.regulaforensics.com.
//
// For getting always the latest version of database you can run autoUpdate
await RegulaDocumentReader.prepareDatabase({ 
    dbID: 'Full',
    runAutoUpdate: true
})

// do this early on to save some time
await RegulaDocumentReader.initialize({
  licenseKey: base64LicenseKeyYouCreatedAbove
}) 

// Scenario is the main setting for DocumentReader SDK. 
// It controls all scanning process of Core framework. 
// Depending on the selected scenario Core will be working in different ways.
// The set of available scenarios is different for each Core type. 
// To get the list, please, use following code after initialization
// Returns {"availableScenarios" : [...DocumentReaderScenario]}  
await RegulaDocumentReader.getAvailableScenarios()

// initialize on the fly, and scan
// set options as you like
// see Regula docs for what they mean
await RegulaDocumentReader.scan({
  functionality: {
    showTorchButton: true,
    showCloseButton: true,
    showCaptureButton: true,
    showCaptureButtonAfterDelay: true,
    showSkipNextPageButton: true,
    videoCaptureMotionControl: true,
    showChangeFrameButton: true,
    showCameraSwitchBtn: true,
  },
  customization: {
    showHintMessages: true,
    showHelpAnimation: true,
    showResultStatusMessages: true,
    showStatusMessages: true,
    cameraFrameBorderWidth: 5,
    cameraFrameDefaultColor: "#00ff00"
  },
  processParams: {
    scenario: RegulaDocumentReader.Scenario.mrz,
    multipageProcessing: false,
    dateFormat: 'dd-mm-yyyy',
  },
})