react-native-scanbot-barcode-scanner-sdk 3.1.0-beta9 → 3.1.0

package/android/src/main/java/io/scanbot/barcodesdk/plugin/reactnative/ObjectMapper.java

@@ -63,6 +63,11 @@ public final class ObjectMapper {
                 continue;
             }
 
+            // The default FRONT camera module should be FRONT_MIRRORED on Android
+            if ("cameraModule".equals(prop) && "FRONT".equals(value)) {
+                value = "FRONT_MIRRORED";
+            }
+
             final String setterName = "set" + prop.substring(0, 1).toUpperCase() + prop.substring(1);
 
             if (methodMap.containsKey(setterName)) {

package/ios/ScanbotBarcodeSdk.m

@@ -149,6 +149,11 @@ RCT_EXPORT_METHOD(startBarcodeScanner:(NSDictionary*)configuration
 
     SBSDKUIBarcodeScannerConfiguration* config = [[SBSDKUIBarcodeScannerConfiguration alloc] initWithUIConfiguration:uiConfig textConfiguration:textConfig behaviorConfiguration:behaviorConfig];
 
+    SBSDKUICameraConfiguration* cameraConfiguration = extractCameraConfiguration(configuration);
+    if (cameraConfiguration) {
+        config.cameraConfiguration.camera = cameraConfiguration.camera;
+    }
+
     bool shouldWaitForGeneratedImage = behaviorConfig.barcodeImageGenerationType != SBSDKBarcodeImageGenerationTypeNone;
     BarcodeScannerPromiseProxy* delegate = [[BarcodeScannerPromiseProxy alloc] initWithResolver: resolve
                                                                     shouldWaitForGeneratedImage: shouldWaitForGeneratedImage];
@@ -211,6 +216,11 @@ RCT_EXPORT_METHOD(startBatchBarcodeScanner:(NSDictionary*)configuration
     NSArray* machineCodeTypes = extractBarcodeTypesFromConfiguration(configuration);
     NSArray* acceptedDocumentTypes = extractBarcodeDocumentTypesFromConfiguration(configuration);
 
+    SBSDKUICameraConfiguration* cameraConfiguration = extractCameraConfiguration(configuration);
+    if (cameraConfiguration) {
+        config.cameraConfiguration.camera = cameraConfiguration.camera;
+    }
+
     BatchBarcodeScannerPromiseProxy* delegate = [[BatchBarcodeScannerPromiseProxy alloc] initWithResolver:resolve];
 
     SBSDKUIBarcodesBatchScannerViewController* viewController = NULL;

package/ios/Utils/BarcodeMapping.h

@@ -138,4 +138,21 @@ static inline SBSDKBarcodeMSIPlesseyChecksumAlgorithm extractPlesseyChecksumAlgo
     return SBSDKBarcodeMSIPlesseyChecksumAlgorithmMod10;
 }
 
+static inline SBSDKUICameraConfiguration* extractCameraConfiguration(NSDictionary* configuration) {
+    SBSDKUICameraConfiguration* cameraConfiguration = [[SBSDKUICameraConfiguration alloc] init];
+    
+    NSString* cameraModule = [configuration objectForKey:@"cameraModule"];
+    if(!cameraModule) {
+        return nil;
+    }
+    
+    if ([cameraModule isEqualToString:@"FRONT"]) {
+        cameraConfiguration.camera = SBSDKCameraDevice.defaultFrontFacingCamera;
+    } else if ([cameraModule isEqualToString:@"BACK"]) {
+        cameraConfiguration.camera = SBSDKCameraDevice.defaultBackFacingCamera;
+    }
+    
+    return cameraConfiguration;
+}
+
 #endif /* BarcodeMapping_h */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-scanbot-barcode-scanner-sdk",
   "title": "Scanbot Barcode Scanner SDK for React Native",
-  "version": "3.1.0-beta9",
+  "version": "3.1.0",
   "description": "React Native plugin for the Scanbot Barcode Scanner SDK on Android and iOS",
   "main": "index.js",
   "files": [

package/src/configuration.ts

@@ -9,18 +9,19 @@ import {
   BarcodeFormat,
   BarcodeImageGenerationType,
   UIInterfaceOrientationMask,
-  EngineMode
+  EngineMode,
+  CameraModule
 } from "./enum";
 import { MSIPlesseyChecksumAlgorithm } from "./enum";
 
 export interface BarcodeScannerConfiguration {
   /**
-   * An optional array of barcode document formats that act as a detection filter.
+   * An optional array of barcode document formats that acts as a detection filter.
    * By default all supported document formats will be detected.
    */
   acceptedDocumentFormats?: BarcodeDocumentFormat[];
   /**
-   * Allowed orientations for automatic interface rotations. *
+   * Allowed orientations for automatic interface rotations.
    */
   allowedInterfaceOrientations?: UIInterfaceOrientationMask;
   /**
@@ -40,11 +41,11 @@ export interface BarcodeScannerConfiguration {
    */
   finderLineColor?: string;
   /**
-   * Width of finder frame border. Default is 2.
+   * Width of the finder frame border. Default is 2.
    */
   finderLineWidth?: number;
   /**
-   * String being displayed as description.
+   * String being displayed as the description label.
    */
   finderTextHint?: string;
   /**
@@ -52,8 +53,8 @@ export interface BarcodeScannerConfiguration {
    */
   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.
+   * Aspect ratio of the finder frame (width \ height), which is used to build the actual finder frame.
+   * Default is 1 - which is a square frame (good for QR capturing).
    */
   finderAspectRatio?: FinderAspectRatio;
   /**
@@ -61,11 +62,11 @@ export interface BarcodeScannerConfiguration {
    */
   flashButtonTitle?: string;
   /**
-   * Foreground color of the flash button when flash is off.
+   * Foreground color of the flash button when the flash is off.
    */
   flashButtonInactiveColor?: string;
   /**
-   * Whether flash is toggled on or off.
+   * Whether the flash is toggled on or off.
    */
   flashEnabled?: boolean;
   /**
@@ -82,13 +83,13 @@ export interface BarcodeScannerConfiguration {
   maximumTextLength?: number,
   /**
    * Optional minimum required quiet zone on the barcode.
-   * Measured in modules (the size of minimal bar on the barcode).
+   * Measured in modules (the size of narrowest bar in the barcode).
    * The default is 10.
    * NOTE: This feature works on ITF and MSI Plessey barcodes only.
    */
   minimum1DBarcodesQuietZone?: number
   /**
-   * Whether scanner screen should make a sound on successful barcode or MRZ detection.
+   * Whether a sound should be played on successful barcode detection.
    */
   successBeepEnabled?: boolean;
   /**
@@ -100,12 +101,12 @@ export interface BarcodeScannerConfiguration {
    */
   topBarButtonsColor?: string;
   /**
-   * Accepted barcode formats
+   * 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.
+   * Specifies the way a barcode image is generated or disables this generation altogether.
+   * Use if you want to receive a full sized image with barcodes. Defaults to NONE.
    */
   barcodeImageGenerationType?: BarcodeImageGenerationType;
   /**
@@ -120,31 +121,34 @@ export interface BarcodeScannerConfiguration {
   cameraZoomFactor?: number;
   /**
    * The engine mode of the barcode recognizer. Defaults to NEXT_GEN.
-   * To use legacy recognizer, please specify LEGACY
+   * To use the 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).
+   * 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 checksum algorithm for MSI Plessey barcodes.
    * The default value is [MSIPlesseyChecksumAlgorithm.Mod10].
    */
   msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm;
   /**
-   * With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes.
+   * With this option enabled, the scanner removes check digits for UPC, EAN and MSI Plessey codes.
    * Has no effect if both single and double digit MSI Plessey checksums are enabled.
-   * The default is `false`
+   * The default is `false`.
    */
   stripCheckDigits?: boolean;
-
   /**
-   * If `true`, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If `false` - mode is disabled.
-   * The default is `false`
+   * The preferred camera module (default: BACK).
+   */
+  cameraModule?: CameraModule;
+  /**
+   * If `true`, enables the mode which slightly decreases the scanning quality and the energy consumption, thus increasing the scanning speed.
+   * The default is `false`.
    * Android only.
    */
   lowPowerMode?: boolean;
@@ -152,16 +156,16 @@ export interface BarcodeScannerConfiguration {
 
 export interface BatchBarcodeScannerConfiguration {
   /**
-   * An optional array of barcode document formats that act as a detection filter.
+   * An optional array of barcode document formats that acts as a detection filter.
    * By default all supported document formats will be detected.
    */
   acceptedDocumentFormats?: BarcodeDocumentFormat[];
   /**
-   * Allowed orientations for automatic interface rotations. *
+   * Allowed orientations for automatic interface rotations.
    */
   allowedInterfaceOrientations?: UIInterfaceOrientationMask;
   /**
-   * String used for displaying amount of scanned barcodes. Use %d for number formatting symbol.
+   * String used for displaying the numer of scanned barcodes. Use %d for number formatting symbol.
    */
   barcodesCountText?: string;
   /**
@@ -173,7 +177,7 @@ export interface BatchBarcodeScannerConfiguration {
    */
   cameraOverlayColor?: string;
   /**
-   * Whether the cancel button is hidden or not. (iOS Only)
+   * Whether the cancel button is hidden or not. (iOS only).
    */
   cancelButtonHidden?: boolean;
   /**
@@ -206,12 +210,12 @@ export interface BatchBarcodeScannerConfiguration {
    */
   detailsPrimaryColor?: string;
   /**
-   * String used to show process of fetching mapped data for barcodes.
+   * String used to show the 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.
+   * Aspect ratio of the finder frame (width \ height), which is used to build the actual finder frame.
+   * Default is 1 - which is a square frame (good for QR capturing).
    */
   finderAspectRatio?: FinderAspectRatio;
   /**
@@ -219,11 +223,11 @@ export interface BatchBarcodeScannerConfiguration {
    */
   finderLineColor?: string;
   /**
-   * Width of finder frame border. Default is 2.
+   * Width of the finder frame border. Default is 2.
    */
   finderLineWidth?: number;
   /**
-   * String being displayed as description.
+   * String being displayed as the description label.
    */
   finderTextHint?: string;
   /**
@@ -231,7 +235,7 @@ export interface BatchBarcodeScannerConfiguration {
    */
   finderTextHintColor?: string;
   /**
-   * Whether flash is toggled on or off.
+   * Whether the flash is toggled on or off.
    */
   flashEnabled?: boolean;
   /**
@@ -243,7 +247,7 @@ export interface BatchBarcodeScannerConfiguration {
    */
   submitButtonTitle?: string;
   /**
-   * Whether scanner screen should make a sound on successful barcode or MRZ detection.
+   * Whether a sound should be played on successful barcode detection.
    */
   successBeepEnabled?: boolean;
   /**
@@ -255,11 +259,11 @@ export interface BatchBarcodeScannerConfiguration {
    */
   topBarButtonsColor?: string;
   /**
-   * Foreground color of the flash button when flash is off.
+   * Foreground color of the flash button when the flash is off.
    */
   topBarButtonsInactiveColor?: string;
   /**
-   * Accepted barcode formats
+   * Accepted barcode formats.
    */
   barcodeFormats?: BarcodeFormat[];
   /**
@@ -281,42 +285,43 @@ export interface BatchBarcodeScannerConfiguration {
   maximumTextLength?: number;
   /**
    * Optional minimum required quiet zone on the barcode.
-   * Measured in modules (the size of minimal bar on the barcode).
+   * Measured in modules (the size of narrowest bar in the barcode).
    * The default is 10.
    * NOTE: This feature works on ITF and MSI Plessey barcodes only.
    */
   minimum1DBarcodesQuietZone?: number;
-
   /**
    * The engine mode of the barcode recognizer. Defaults to NEXT_GEN.
-   * To use legacy recognizer, please specify LEGACY
+   * To use the 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).
+   * 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 checksum algorithm for MSI Plessey barcodes.
    * The default value is [MSIPlesseyChecksumAlgorithm.Mod10].
    */
   msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm;
-
   /**
-   * With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes.
+   * With this option enabled, the scanner removes check digits for UPC, EAN and MSI Plessey codes.
    * Has no effect if both single and double digit MSI Plessey checksums are enabled.
-   * The default is `false`
+   * The default is `false`.
    */
   stripCheckDigits?: boolean;
-
   /**
-   * If `true`, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If `false` - mode is disabled.
-   * The default is `false`
+   * The preferred camera module (default: BACK).
+   */
+  cameraModule?: CameraModule;
+  /**
+   * If `true`, enables the mode which slightly decreases the scanning quality and the energy consumption, thus increasing the scanning speed.
+   * The default is `false`.
    * Android only.
    */
   lowPowerMode?: boolean;
@@ -324,11 +329,11 @@ export interface BatchBarcodeScannerConfiguration {
 
 interface InternalBarcodeDetectionCommonParameters {
   /**
-   * Accepted barcode formats
+   * Accepted barcode formats.
    */
   barcodeFormats?: BarcodeFormat[];
   /**
-   * An optional array of barcode document formats that act as a detection filter.
+   * An optional array of barcode document formats that acts as a detection filter.
    * By default all supported document formats will be detected.
    */
   acceptedDocumentFormats?: BarcodeDocumentFormat[];
@@ -346,15 +351,15 @@ interface InternalBarcodeDetectionCommonParameters {
   maximumTextLength?: number;
   /**
    * Optional minimum required quiet zone on the barcode.
-   * Measured in modules (the size of minimal bar on the barcode).
+   * Measured in modules (the size of narrowest bar in the barcode).
    * The default is 10.
    * NOTE: This feature works on ITF and MSI Plessey barcodes only.
    */
   minimum1DBarcodesQuietZone?: number;
   /**
-   * With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes.
+   * With this option enabled, the scanner removes check digits for UPC, EAN and MSI Plessey codes.
    * Has no effect if both single and double digit MSI Plessey checksums are enabled.
-   * The default is `false`
+   * The default is `false`.
    */
   stripCheckDigits?: boolean;
 }
@@ -362,7 +367,7 @@ interface InternalBarcodeDetectionCommonParameters {
 export interface DetectBarcodesOnImageArguments
   extends InternalBarcodeDetectionCommonParameters {
   /**
-   * The input image file URI
+   * The input image file URI.
    */
   imageFileUri: string;
 }

package/src/enum.ts

@@ -74,3 +74,5 @@ export type MSIPlesseyChecksumAlgorithm =
     "Mod1110IBM" |
     "Mod1110NCR"
     ;
+
+export type CameraModule = 'FRONT' | 'BACK';