@regulaforensics/document-reader 8.2.186-beta

package/www/react-native/rfid/RFIDNotification.js

@@ -0,0 +1,60 @@
+import { RFIDDataFileType } from "../results/rfid/RFIDDataFileType";
+
+export class RFIDNotification {
+    notificationCode
+    dataFileType
+    progress
+
+    constructor() {
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new RFIDNotification()
+
+        result.notificationCode = jsonObject["notificationCode"]
+        result.dataFileType = jsonObject["dataFileType"]
+        result.progress = jsonObject["progress"]
+
+        return result
+    }
+}
+
+export const RFIDNotificationCodes = {
+    ERROR: 65536,
+    DOCUMENT_READY: 65537,
+    READ_PROTOCOL4: 65539,
+    READ_PROTOCOL3: 65546,
+    PROGRESS: 65547,
+    TA_STEP: 65550,
+    SM_REQUIRED: 65551,
+    ISO_ERROR: 69632,
+    PA_REQUEST: 77824,
+    SM_ESTABLISHED: 81935,
+    PCSC_READER_DISCONNECTED: 131072,
+    PCSC_READER_LIST_CHANGED: 131073,
+    PCSC_BYTES_RECEIVED: 131074,
+    PCSC_TOTAL_READING_TIME: 131075,
+    PCSC_DATA_RECEIVED: 131076,
+    PCSC_BYTES_SENT: 131077,
+    PCSC_TOTAL_READING_SPEED: 131078,
+    PCSC_TOTAL_PROCESS_TIME: 131079,
+    PCSC_READER_LIST_CHANGING: 131080,
+    PCSC_EXT_LENGTH_SUPPORT: 131088,
+    PA_CERTIFICATE_CHAIN: 131089,
+    PA_CERTIFICATE_CHAIN_ITEM: 131090,
+    SCENARIO: 131104,
+    PCSC_READING_DATAGROUP: 196608,
+    PCSC_FILE_NOT_FOUND: 262144,
+    PCSC_END_OF_FILE: 327680,
+    PCSC_FILE_ACCESS_DENIED: 393216,
+    PCSC_APPLICATION_SELECTED: 458752,
+    AC_PROCEDURE_START: 524288,
+    AC_PROCEDURE_FINISH: 589824,
+    PA_SECURITY_OBJECT_CHECK: 655360,
+    PA_FILE_CHECK: 720896,
+    PCSC_UPDATING_DATAGROUP: 786432,
+    AUXILIARY_DATA_VALIDATION: 851968,
+    RI_SECTOR_ID: 917504,
+    BIOMETRICS_EMPTY_PLACEHOLDER: 983040
+}

package/www/react-native/rfid/TAChallenge.js

@@ -0,0 +1,23 @@
+export class TAChallenge {
+    data
+    auxPCD
+    challengePICC
+    hashPK
+    idPICC
+
+    constructor() {
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new TAChallenge()
+
+        result.data = jsonObject["data"]
+        result.auxPCD = jsonObject["auxPCD"] ?? ""
+        result.challengePICC = jsonObject["challengePICC"] ?? ""
+        result.hashPK = jsonObject["hashPK"] ?? ""
+        result.idPICC = jsonObject["idPICC"] ?? ""
+
+        return result
+    }
+}

package/www/react-native/rfid/TccParams.js

@@ -0,0 +1,24 @@
+/** TCC service related parameters for RFID session configuration. */
+export class TccParams {
+    serviceUrlTA
+    serviceUrlPA
+    pfxCertUrl
+    pfxPassPhrase
+    pfxCert
+
+    constructor() {
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new TccParams()
+
+        result.serviceUrlTA = jsonObject["serviceUrlTA"]
+        result.serviceUrlPA = jsonObject["serviceUrlPA"]
+        result.pfxCertUrl = jsonObject["pfxCertUrl"]
+        result.pfxPassPhrase = jsonObject["pfxPassPhrase"]
+        result.pfxCert = jsonObject["pfxCert"]
+
+        return result
+    }
+}

package/www/types/config/InitConfig.d.ts

@@ -0,0 +1,63 @@
+/**
+ * A configuration file for DocumentReader initialization.
+ * Controls initialization time properties such as licenseUpdate and delayedNNLoad.
+ */
+export declare class InitConfig {
+    /**
+     * The license binary file. Base64 string.
+     */
+    readonly license: string;
+
+    /**
+     * Enables automatic license update check during {@link DocumentReader} initialization.
+     * @default true
+     */
+    licenseUpdate: boolean;
+
+    /**
+     * Defines whether the {@link DocumentReader} delays loading of neural networks.
+     *
+     * When set to `true` the initialization starts in the background thread after
+     * the method {@link DocumentReader#initialize} is called. If the document
+     * processing is initiated before all the networks are loaded,
+     * the {@link DocumentReader} will wait for it before starting the handling.
+     *
+     * When set to `false` the initialization is performed during
+     * {@link DocumentReader#initialize} method.
+     * @default false
+     */
+    delayedNNLoad: boolean;
+
+    /**
+     * The path to the database file.
+     *
+     * IOS only. For Android use {@link InitConfig#customDb}.
+     */
+    databasePath?: string;
+
+    /**
+     * Custom database binary. Base64 string.
+     *
+     * Android only. For iOS use {@link InitConfig#databasePath}.
+     */
+    customDb?: string;
+
+    /**
+     * Android only.
+     */
+    blackList?: Record<string, any>;
+
+    /**
+     * Constructor for initialization using a license binary.
+     * @param license The license binary file. Base64 string.
+     */
+    constructor(license: string);
+
+    /**
+     * Constructor for initialization using a ble device.
+     * Doesn't need a license file, it will be fetched automatically from your ble device.
+     *
+     * Requires [btdevice plugin](https://www.npmjs.com/package/@regulaforensics/react-native-document-reader-btdevice).
+     */
+    static withBleDevice(): InitConfig;
+}

package/www/types/config/OnlineProcessingConfig.d.ts

@@ -0,0 +1,22 @@
+import { ProcessParams } from "../params/process_params/ProcessParams";
+
+export declare class OnlineProcessingConfig {
+    mode: OnlineMode;
+    url: string;
+    processParams: ProcessParams;
+    imageFormat: ImageFormat;
+    imageCompressionQuality: number;
+    requestHeaders?: Record<string, string>;
+
+    constructor(mode: OnlineMode);
+}
+
+export declare enum ImageFormat {
+    PNG = 0,
+    JPG = 1,
+}
+
+export declare enum OnlineMode {
+    MANUAL = 0,
+    AUTO = 1,
+}

package/www/types/config/RFIDConfig.d.ts

@@ -0,0 +1,131 @@
+import { DocumentReaderCompletion, DocReaderAction } from "../index";
+import { Results } from "../results/Results";
+import { RFIDException } from "../info/RFIDException";
+import { RFIDNotification } from "../rfid/RFIDNotification";
+import { PAResourcesIssuer } from "../rfid/PAResourcesIssuer";
+import { PKDCertificate } from "../rfid/PKDCertificate";
+import { TAChallenge } from "../rfid/TAChallenge";
+
+/**
+ * A configuration file for the RFID chip processing.
+ */
+export declare class RFIDConfig {
+    /**
+     * Callback for reveiving notification about RFID reading process.
+     */
+    onProgress?: RFIDProgressCompletion;
+
+    /**
+     * Callback for receiving signal when RFID chip is recognized
+     * by a phone and chip reading is started.
+     *
+     * Only used with default constructor. If {@link RFIDConfig.withoutUI} was used,
+     * you will receive this update via {@link DocumentReaderCompletion}.
+     */
+    onChipDetected?: ChipDetectedCompletion;
+
+    /**
+     * Fires when RFID chip reading was interrupted with no severe reasons
+     * (for example connection to the chip was lost) and will be reestablished automatically.
+     *
+     * Only used with default constructor. If {@link RFIDConfig.withoutUI} was used,
+     * you will receive this update via {@link DocumentReaderCompletion}
+     * and chip reading will not be reestablished.
+     */
+    onRetryReadChip?: RetryReadChipCompletion;
+
+    /**
+     * Callback for receiving RFID request data
+     */
+    onRequestPACertificates?: PaCertificateCompletion;
+
+    /**
+     * Callback for receiving RFID request data
+     */
+    onRequestTACertificates?: TaCertificateCompletion;
+
+    /**
+     * Callback for receiving RFID request data
+     */
+    onRequestTASignature?: TaSignatureCompletion;
+
+    /**
+     * Regular RFID chip reading.
+     *
+     * @param completion - block to execute after the chip reading process finishes.
+     */
+    constructor(completion: DocumentReaderCompletion);
+
+    /**
+     * RFID chip reading with no UI.
+     *
+     * User is supposed to implement the UI.
+     *
+     * Since this constructor accepts {@link RFIDCompletion}
+     * instead of {@link DocumentReaderCompletion}, user will be provided
+     * with more in-depth error information.
+     *
+     * @param completion - block to execute after the chip reading process finishes.
+     */
+    static withoutUI(completion: RFIDCompletion): RFIDConfig;
+}
+
+/**
+ * Callback for receiving answer from processing engine.
+ *
+ * @param action - defines current processing status.
+ * @param results - defines current processing results.
+ * @param error - in case of anything is wrong - brief message for developer, `null` otherwise.
+ */
+export type RFIDCompletion = (action: DocReaderAction, results: Results | null, error: RFIDException | null) => void;
+
+/**
+ * Completion for reveiving notification about RFID reading process.
+ */
+export type RFIDProgressCompletion = (notification: RFIDNotification) => void;
+
+/**
+ * Callback for receiving signal when RFID chip is recognized
+ * by a phone and chip reading is started.
+ *
+ * Only used with default constructor. If {@link RFIDConfig.withoutUI} was used,
+ * you will receive this update via {@link DocumentReaderCompletion}.
+ */
+export type ChipDetectedCompletion = () => void;
+
+/**
+ * Fires when RFID chip reading was interrupted with no severe reasons
+ * (for example connection to the chip was lost) and will be reestablished automatically.
+ *
+ * Only used with default constructor. If {@link RFIDConfig.withoutUI} was used,
+ * you will receive this update via {@link DocumentReaderCompletion}
+ * and chip reading will not be reestablished.
+ *
+ * @param error - a brief message for developer.
+ */
+export type RetryReadChipCompletion = (error: RFIDException) => void;
+
+/**
+ * Callback for receiving RFID request data
+ */
+export type PaCertificateCompletion = (serialNumber: string, issuer: PAResourcesIssuer | null, request: PKDCertificateRequest) => void;
+
+/**
+ * Callback for receiving RFID request data
+ */
+export type TaCertificateCompletion = (keyCAR: string | null, request: PKDCertificateRequest) => void;
+
+/**
+ * Provided to a user for passing PKDCertificates to the native part of DocumentReader.
+ */
+export type PKDCertificateRequest = (certificates?: PKDCertificate[]) => Promise<void>;
+
+/**
+ * Callback for receiving RFID request data
+ */
+export type TaSignatureCompletion = (challenge: TAChallenge | null, request: TASignatureRequest) => void;
+
+/**
+ * Provided to a user for passing TASignature to the native part of DocumentReader. Base64 string.
+ */
+export type TASignatureRequest = (signature?: string) => Promise<void>; 

package/www/types/config/RecognizeConfig.d.ts

@@ -0,0 +1,119 @@
+import { OnlineProcessingConfig } from "./OnlineProcessingConfig";
+import { Scenario } from "../info/DocReaderScenario";
+import { Lights } from "../results/visual_results/Lights";
+
+/**
+ * Image processing configuration.
+ */
+export declare class RecognizeConfig {
+    /**
+     * Documents processing scenario.
+     */
+    readonly scenario?: Scenario;
+
+    /**
+     * Configuration class for online processing.
+     *
+     * Requires network connection.
+     */
+    readonly onlineProcessingConfig?: OnlineProcessingConfig;
+
+    /**
+     * Image for processing. Base64 string.
+     */
+    image?: string;
+
+    /**
+     * Images for processing. Array of base64 strings.
+     */
+    images?: string[];
+
+    /**
+     * Binary for processing. Base64 string.
+     */
+    data?: string;
+
+    /**
+     * Images(with input data) for processing.
+     */
+    imageInputData?: ImageInputData[];
+
+    /**
+     * DTC file for processing. Base64 string.
+     */
+    dtc?: string;
+
+    /**
+     * Live portrait photo.
+     *
+     * Requires network connection.
+     */
+    livePortrait?: string;
+
+    /**
+     * Portrait photo from an external source.
+     *
+     * Requires network connection.
+     */
+    extPortrait?: string;
+
+    /**
+     * This parameter is for processing an image that contains a person and
+     * a document and compare the portrait photo from the document with
+     * the person's face. It works only in the single-frame processing,
+     * but not in the video frame processing. Requires network connection.
+     * @default false
+     */
+    oneShotIdentification: boolean;
+
+    private constructor();
+
+    static withScenario(
+        scenario: Scenario,
+        options?: {
+            image?: string,
+            images?: string[],
+            data?: string,
+            imageInputData?: ImageInputData[],
+            dtc?: string,
+            livePortrait?: string,
+            extPortrait?: string,
+            oneShotIdentification?: boolean,
+        }
+    ): RecognizeConfig;
+
+    static withOnlineProcessingConfig(
+        onlineProcessingConfig: OnlineProcessingConfig,
+        options?: {
+            image?: string,
+            images?: string[],
+            data?: string,
+            imageInputData?: ImageInputData[],
+            dtc?: string,
+            livePortrait?: string,
+            extPortrait?: string,
+            oneShotIdentification?: boolean,
+        }
+    ): RecognizeConfig;
+}
+
+export declare class ImageInputData {
+    /**
+     * An image. Base64 string.
+     */
+    readonly image: string;
+
+    /**
+     * Light type, one of RGLGraphicFieldLight values.
+     * @default {@link Lights.WHITE_FULL}
+     */
+    light: Lights;
+
+    /**
+     * An index of the document page whence the graphic field is extracted.
+     * @default 0
+     */
+    pageIndex: number;
+
+    constructor(image: string, options?: { light?: Lights, pageIndex?: number });
+}

package/www/types/config/ScannerConfig.d.ts

@@ -0,0 +1,54 @@
+import { Scenario } from "../info/DocReaderScenario";
+import { OnlineProcessingConfig } from "./OnlineProcessingConfig";
+
+/**
+ * A configuration file for the scanner screen.
+ */
+export declare class ScannerConfig {
+    /**
+     * Documents processing scenario.
+     */
+    readonly scenario?: Scenario;
+
+    /**
+     * Configuration class for online processing.
+     *
+     * Requires network connection.
+     */
+    readonly onlineProcessingConfig?: OnlineProcessingConfig;
+
+    /**
+     * Live portrait photo. Base64 string.
+     *
+     * Requires network connection.
+     */
+    livePortrait?: string;
+
+    /**
+     * Portrait photo from an external source. Base64 string.
+     *
+     * Requires network connection.
+     */
+    extPortrait?: string;
+
+    /**
+     * Camera id.
+     *
+     * Android only.
+     */
+    cameraId?: number;
+
+    constructor(scenario: Scenario, onlineProcessingConfig: OnlineProcessingConfig);
+
+    /**
+     * Creates a configuration with a specific processing scenario.
+     * @param scenario The documents processing scenario.
+     */
+    static withScenario(scenario: Scenario): ScannerConfig;
+
+    /**
+     * Creates a configuration for online processing.
+     * @param onlineProcessingConfig The configuration for online processing.
+     */
+    static withOnlineProcessingConfig(onlineProcessingConfig: OnlineProcessingConfig): ScannerConfig;
+}