react-native-scanbot-barcode-scanner-sdk 3.1.0-alpha2 → 3.1.0-alpha3

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "react-native-scanbot-barcode-scanner-sdk",
   "title": "Scanbot Barcode Scanner SDK for React Native",
-  "version": "3.1.0-alpha2",
+  "version": "3.1.0-alpha3",
   "description": "React Native plugin for the Scanbot Barcode Scanner SDK on Android and iOS",
   "main": "index.js",
   "files": [
     "src/*.js",
+    "src/*.ts",
     "src/components/**/*.ts",
     "src/components/**/*.tsx",
     "src/components/**/*.js",

package/src/configuration.ts

@@ -0,0 +1,316 @@
+/*
+  Scanbot Barcode Scanner SDK React Native Plugin
+  Copyright (c) 2020 doo GmbH. All rights reserved.
+  https://scanbot.io/sdk
+ */
+import { FinderAspectRatio } from "./model";
+import {
+    BarcodeDocumentFormat,
+    BarcodeFormat,
+    BarcodeImageGenerationType,
+    UIInterfaceOrientationMask,
+    EngineMode
+} from "./enum";
+import { MSIPlesseyChecksumAlgorithm } from "react-native-scanbot-barcode-scanner-sdk/src/enum";
+
+export interface BarcodeScannerConfiguration
+{
+    /**
+     * An optional array of barcode document formats that act as a detection filter.
+     * By default all supported document formats will be detected.
+     */
+    acceptedDocumentFormats?: BarcodeDocumentFormat[];
+    /**
+     * Allowed orientations for automatic interface rotations. *
+     */
+    allowedInterfaceOrientations?: UIInterfaceOrientationMask;
+    /**
+     * Background color of the detection overlay.
+     */
+    cameraOverlayColor?: string;
+    /**
+     * Whether the cancel button is hidden or not.
+     */
+    cancelButtonHidden?: boolean;
+    /**
+     * String being displayed on the cancel button.
+     */
+    cancelButtonTitle?: string;
+    /**
+     * Foreground color of the detection overlay.
+     */
+    finderLineColor?: string;
+    /**
+     * Width of finder frame border. Default is 2.
+     */
+    finderLineWidth?: number;
+    /**
+     * String being displayed as description.
+     */
+    finderTextHint?: string;
+    /**
+     * Foreground color of the description label.
+     */
+    finderTextHintColor?: string;
+    /**
+     * Aspect ratio of finder frame (width \ height), which is used to build actual finder frame.
+     * Default is 1 - it is a square frame, which is good for QR capturing.
+     */
+    finderAspectRatio?: FinderAspectRatio;
+    /**
+     * String being displayed on the flash button.
+     */
+    flashButtonTitle?: string;
+    /**
+     * Foreground color of the flash button when flash is off.
+     */
+    flashButtonInactiveColor?: string;
+    /**
+     * Whether flash is toggled on or off.
+     */
+    flashEnabled?: boolean;
+    /**
+     * Optional minimum required text length of the detected barcode.
+     * The default is 0 (setting is turned off).
+     * NOTE: This feature works on ITF barcodes only.
+     */
+    minimumTextLength?: number,
+    /**
+     * Optional maximum required text length of the detected barcode.
+     * The default is 0 (setting is turned off).
+     * NOTE: This feature works on ITF barcodes only.
+     */
+    maximumTextLength?: number,
+    /**
+     * Optional minimum required quiet zone on the barcode.
+     * Measured in modules (the size of minimal bar on the barcode).
+     * The default is 10.
+     * NOTE: This feature works on ITF barcodes only.
+     */
+    minimum1DBarcodesQuietZone?: number
+    /**
+     * Whether scanner screen should make a sound on successful barcode or MRZ detection.
+     */
+    successBeepEnabled?: boolean;
+    /**
+     * Background color of the top bar.
+     */
+    topBarBackgroundColor?: string;
+    /**
+     * Foreground color of the cancel button.
+     */
+    topBarButtonsColor?: string;
+    /**
+     * Accepted barcode formats
+     */
+    barcodeFormats?: BarcodeFormat[];
+    /**
+     * Specifies the way of barcode images generation or disables this generation at all.
+     * Use, if you want to receive a full sized image with barcodes. Defaults to NONE.
+     */
+    barcodeImageGenerationType?: BarcodeImageGenerationType;
+    /**
+     * Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE.
+     * Android only.
+     */
+    useButtonsAllCaps?: boolean;
+    /**
+    * With this option, the scanner assumes that the barcode can be a GS1 barcode, and modify the behavior as needed.
+    * You can set it to 'false', if you don't want to see decoded FNC1 characters ("]C1" and ASCII char 29).
+    * The default is 'true'.
+    * NOTE: Currently works for CODE128 barcodes only!
+    */
+    enableGS1Decoding?: boolean
+    /**
+    * The relative initial zoom level of the camera in the range [0,1], where 0 is zoomed out and 1 is zoomed in.
+    * The default value is 0.
+    */
+    cameraZoomFactor?: number;
+
+    /**
+     * The engine mode of the barcode recognizer. Defaults to NEXT_GEN.
+     * To use legacy recognizer, please specify LEGACY
+     */
+    engineMode?: EngineMode;
+
+    /**
+     * When set to `true`, the scanner assumes that the barcode can be a GS1 barcode.
+     * Turn it off, if you don't want to see decoded FNC1 characters ("]C1" and ASCII char 29).
+     * The default value is `true`.
+     * NOTE: Currently works for CODE128 barcodes only!
+     */
+    gs1DecodingEnabled?: boolean,
+
+    /**
+     * The checksum algorithms for MSI Plessey barcodes.
+     * The default value is [MSIPlesseyChecksumAlgorithm.Mod10].
+     */
+    msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm,
+}
+
+export interface BatchBarcodeScannerConfiguration
+{
+    /**
+     * An optional array of barcode document formats that act as a detection filter.
+     * By default all supported document formats will be detected.
+     *
+     * NOTE: Android only.
+     */
+    acceptedDocumentFormats?: BarcodeDocumentFormat[];
+    /**
+     * Allowed orientations for automatic interface rotations. *
+     */
+    allowedInterfaceOrientations?: UIInterfaceOrientationMask;
+    /**
+     * String used for displaying amount of scanned barcodes. Use %d for number formatting symbol.
+     */
+    barcodesCountText?: string;
+    /**
+     * Text color of the barcodes count label.
+     */
+    barcodesCountTextColor?: string;
+    /**
+     * Background color of the detection overlay.
+     */
+    cameraOverlayColor?: string;
+    /**
+     * Whether the cancel button is hidden or not.
+     */
+    cancelButtonHidden?: boolean;
+    /**
+     * String being displayed on the cancel button.
+     */
+    cancelButtonTitle?: string;
+    /**
+     * String being displayed on the clear button.
+     */
+    clearButtonTitle?: string;
+    /**
+     * String being displayed on the delete button.
+     */
+    deleteButtonTitle?: string;
+    /**
+     * Foreground color of the top bar buttons on the details screen.
+     */
+    detailsActionColor?: string;
+    /**
+     * Background color of the details screen.
+     */
+    detailsBackgroundColor?: string;
+    /**
+     * Text color in the details barcodes list. Also affects image background, separator and progress spinner.
+     */
+    detailsPrimaryColor?: string;
+    /**
+     * String used to show process of fetching mapped data for barcodes.
+     */
+    fetchingStateText?: string;
+    /**
+     * Aspect ratio of finder frame (width \ height), which is used to build actual finder frame.
+     * Default is 1 - it is a square frame, which is good for QR capturing.
+     */
+    finderAspectRatio?: FinderAspectRatio;
+    /**
+     * Foreground color of the detection overlay.
+     */
+    finderLineColor?: string;
+    /**
+     * Width of finder frame border. Default is 2.
+     */
+    finderLineWidth?: number;
+    /**
+     * String being displayed as description.
+     */
+    finderTextHint?: string;
+    /**
+     * Foreground color of the description label.
+     */
+    finderTextHintColor?: string;
+    /**
+     * Whether flash is toggled on or off.
+     */
+    flashEnabled?: boolean;
+    /**
+     * String to show that no barcodes were scanned yet.
+     */
+    noBarcodesTitle?: string;
+    /**
+     * Enables or disables the barcode detection.
+     */
+    recognitionEnabled?: boolean;
+    /**
+     * String being displayed on the submit button.
+     */
+    submitButtonTitle?: string;
+    /**
+     * Whether scanner screen should make a sound on successful barcode or MRZ detection.
+     */
+    successBeepEnabled?: boolean;
+    /**
+     * Background color of the top bar.
+     */
+    topBarBackgroundColor?: string;
+    /**
+     * Foreground color of the top bar buttons on the scanning screen.
+     */
+    topBarButtonsColor?: string;
+    /**
+     * Foreground color of the flash button when flash is off.
+     */
+    topBarButtonsInactiveColor?: string;
+    /**
+     * Accepted barcode formats
+     */
+    barcodeFormats?: BarcodeFormat[];
+    /**
+     * Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE.
+     * Android only.
+     */
+    useButtonsAllCaps?: boolean;
+    /**
+    * Optional minimum required text length of the detected barcode.
+    * The default is 0 (setting is turned off).
+    * NOTE: This feature works on ITF barcodes only.
+    */
+    minimumTextLength?: number,
+   /**
+    * Optional maximum required text length of the detected barcode.
+    * The default is 0 (setting is turned off).
+    * NOTE: This feature works on ITF barcodes only.
+    */
+    maximumTextLength?: number,
+   /**
+    * Optional minimum required quiet zone on the barcode.
+    * Measured in modules (the size of minimal bar on the barcode).
+    * The default is 10.
+    * NOTE: This feature works on ITF barcodes only.
+    */
+    minimum1DBarcodesQuietZone?: number
+    /**
+    * With this option, the scanner assumes that the barcode can be a GS1 barcode, and modify the behavior as needed.
+    * You can set it to 'false', if you don't want to see decoded FNC1 characters ("]C1" and ASCII char 29).
+    * The default is 'true'.
+    * NOTE: Currently works for CODE128 barcodes only!
+    */
+    enableGS1Decoding?: boolean
+
+    /**
+     * The engine mode of the barcode recognizer. Defaults to NEXT_GEN.
+     * To use legacy recognizer, please specify LEGACY
+     */
+    engineMode?: EngineMode;
+
+    /**
+     * When set to `true`, the scanner assumes that the barcode can be a GS1 barcode.
+     * Turn it off, if you don't want to see decoded FNC1 characters ("]C1" and ASCII char 29).
+     * The default value is `true`.
+     * NOTE: Currently works for CODE128 barcodes only!
+     */
+    gs1DecodingEnabled?: boolean,
+
+    /**
+     * The checksum algorithms for MSI Plessey barcodes.
+     * The default value is [MSIPlesseyChecksumAlgorithm.Mod10].
+     */
+    msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm,
+}

package/src/enum.ts

@@ -0,0 +1,76 @@
+/*
+  Scanbot Barcode Scanner SDK React Native Plugin
+  Copyright (c) 2020 doo GmbH. All rights reserved.
+  https://scanbot.io/sdk
+ */
+
+export type Status = "OK" | "CANCELED";
+
+export type LicenseStatus =
+    "Okay" |
+    "Trial" |
+    "Expired" |
+    "WrongOS" |
+    "Corrupted" |
+    "AppIDMismatch" |
+    "NotSet" |
+    "Unknown";
+
+export type CameraImageFormat = "JPG" | "PNG";
+export type DocumentDetectorMode = "EDGE_BASED" | "ML_BASED";
+export type FileEncryptionMode = "AES128" | "AES256";
+
+export type UIInterfaceOrientationMask =
+    "PORTRAIT"
+    | "LANDSCAPE_LEFT"
+    | "LANDSCAPE_RIGHT"
+    | "PORTRAIT_UPSIDE_DOWN"
+    | "LANDSCAPE"
+    | "ALL"
+    | "ALL_BUT_UPSIDE_DOWN";
+
+export type BarcodeImageGenerationType =
+    "NONE"
+    | "VIDEO_FRAME"
+    | "CAPTURED_IMAGE";
+
+export type BarcodeDocumentFormat =
+    "AAMVA" |
+    "BOARDING_PASS" |
+    "DE_MEDICAL_PLAN" |
+    "DISABILITY_CERTIFICATE" |
+    "ID_CARD_PDF_417" |
+    "SEPA" |
+    "SWISS_QR" |
+    "VCARD";
+
+export type BarcodeFormat =
+    "AZTEC" |
+    "CODABAR" |
+    "CODE_39" |
+    "CODE_93" |
+    "CODE_128" |
+    "DATA_MATRIX" |
+    "EAN_8" |
+    "EAN_13" |
+    "ITF" |
+    "PDF_417" |
+    "QR_CODE" |
+    "RSS_14" |
+    "RSS_EXPANDED" |
+    "UPC_A" |
+    "UPC_E" |
+    "UNKNOWN" |
+    "MSI_PLESSEY";
+
+export type EngineMode = "LEGACY" | "NEXT_GEN";
+
+export type MSIPlesseyChecksumAlgorithm =
+    "None" |
+    "Mod10" |
+    "Mod11IBM" |
+    "Mod11NCR" |
+    "Mod1010" |
+    "Mod1110IBM" |
+    "Mod1110NCR"
+    ;

package/src/model.ts

@@ -0,0 +1,20 @@
+import { CameraImageFormat, DocumentDetectorMode, FileEncryptionMode, LicenseStatus } from "./enum";
+
+export interface InitializationOptions {
+    licenseKey: string;
+    loggingEnabled?: boolean;
+    storageImageQuality?: number;
+    storageImageFormat?: CameraImageFormat;
+    storageBaseDirectory?: string;
+}
+
+export interface LicenseInfo {
+    isLicenseValid: boolean;
+    licenseStatus: LicenseStatus;
+    licenseExpirationDate?: number;
+}
+
+export interface FinderAspectRatio {
+    width: number;
+    height: number;
+}

package/src/result.ts

@@ -0,0 +1,24 @@
+import { BarcodeFormat, Status } from "./enum";
+
+export interface BarcodeResultField {
+    /**
+     * The barcode format.
+     */
+    type: BarcodeFormat;
+
+    /**
+     * The raw text encoded in the barcode.
+     */
+    text: string;
+}
+
+export interface BarcodeResult {
+    status: Status;
+    barcodes?: BarcodeResultField[];
+}
+
+export type BarcodeScannerResult = BarcodeResult & {
+    imageFileUri?: string
+}
+
+export type BatchBarcodeScannerResult = BarcodeResult;