react-native-scanbot-barcode-scanner-sdk 3.2.1 → 3.3.0-alpha1

package/src/configuration.ts

@@ -3,7 +3,7 @@
   Copyright (c) 2020 doo GmbH. All rights reserved.
   https://scanbot.io/sdk
  */
-import { FinderAspectRatio } from "./model";
+import { FinderAspectRatio, SelectionOverlayConfiguration } from "./model";
 import {
   BarcodeDocumentFormat,
   BarcodeFormat,
@@ -11,53 +11,15 @@ import {
   UIInterfaceOrientationMask,
   EngineMode,
   CameraModule,
-  BarcodeFilter
+  BarcodeFilter,
+  CodeDensity
 } from "./enum";
 import { MSIPlesseyChecksumAlgorithm } from "./enum";
 
-export interface BarcodeScannerConfiguration {
-  /**
-   * 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.
-   */
-  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 the finder frame border. Default is 2.
-   */
-  finderLineWidth?: number;
-  /**
-   * String being displayed as the description label.
-   */
-  finderTextHint?: string;
-  /**
-   * Foreground color of the description label.
-   */
-  finderTextHintColor?: string;
-  /**
-   * 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;
+/**
+ * An interface that contains all the Barcode Scanning configurations.
+ */
+export interface BarcodeScannerConfiguration extends InternalBarcodeDetectionCommonParameters, BarcodeAdditionalParameters {
   /**
    * String being displayed on the flash button.
    */
@@ -66,115 +28,17 @@ export interface BarcodeScannerConfiguration {
    * Foreground color of the flash button when the flash is off.
    */
   flashButtonInactiveColor?: string;
-  /**
-   * Whether the 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 and MSI Plessey 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 and MSI Plessey barcodes only.
-   */
-  maximumTextLength?: number,
-  /**
-   * Optional minimum required quiet zone 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
-  /** 
-   * Use a filter to determine which type of barcode can be detected; see `BarcodeFilter`
-   */
-  barcodeFilter?: BarcodeFilter;
-  /**
-   * Whether a sound should be played on successful barcode 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 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;
-  /**
-   * Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE.
-   * Android only.
-   */
-  useButtonsAllCaps?: 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 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).
-   * The default value is `true`.
-   * NOTE: Currently works for CODE128 barcodes only!
-   */
-  gs1DecodingEnabled?: boolean;
-  /**
-   * The checksum algorithm for MSI Plessey barcodes.
-   * The default value is [MSIPlesseyChecksumAlgorithm.Mod10].
-   */
-  msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm;
-  /**
-   * 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`.
-   */
-  stripCheckDigits?: boolean;
-  /**
-   * 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;
-  /**
-   * If `true`, replaces the cancel button in the top bar with a back arrow icon
-   * The default is `false`.
-   * Android only.
-   */
-  replaceCancelButtonWithIcon?: boolean;
 }
 
-export interface BatchBarcodeScannerConfiguration {
-  /**
-   * 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.
-   */
-  allowedInterfaceOrientations?: UIInterfaceOrientationMask;
+/**
+ * An interface that contains all the Batch Barcode Scanning configurations.
+ */
+export interface BatchBarcodeScannerConfiguration extends InternalBarcodeDetectionCommonParameters, BarcodeAdditionalParameters {
   /**
    * String used for displaying the numer of scanned barcodes. Use %d for number formatting symbol.
    */
@@ -183,23 +47,6 @@ export interface BatchBarcodeScannerConfiguration {
    * 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. (iOS only).
-   */
-  cancelButtonHidden?: 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;
-  /**
-   * String being displayed on the cancel button.
-   */
-  cancelButtonTitle?: string;
   /**
    * String being displayed on the clear button.
    */
@@ -225,147 +72,147 @@ export interface BatchBarcodeScannerConfiguration {
    */
   fetchingStateText?: string;
   /**
-   * 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).
+   * String to show that no barcodes were scanned yet.
    */
-  finderAspectRatio?: FinderAspectRatio;
+  noBarcodesTitle?: string;
   /**
-   * Foreground color of the detection overlay.
+   * String being displayed on the submit button.
    */
-  finderLineColor?: string;
+  submitButtonTitle?: string;
   /**
-   * Width of the finder frame border. Default is 2.
+   * Foreground color of the flash button when the flash is off.
    */
-  finderLineWidth?: number;
+  topBarButtonsInactiveColor?: string;
+}
+
+
+/**
+ * An interface that contains parameters for Detection of barcodes from images.
+ */
+export interface DetectBarcodesOnImageArguments
+  extends InternalBarcodeDetectionCommonParameters {
   /**
-   * String being displayed as the description label.
+   * The input image file URI.
    */
-  finderTextHint?: string;
+  imageFileUri: string;
+}
+
+/**
+ * An interface that contains Common parameters for barcodes detection and filtering.
+ */
+interface InternalBarcodeDetectionCommonParameters {
   /**
-   * Foreground color of the description label.
+   * An optional array of barcode document formats that acts as a detection filter.
+   * By default all supported document formats will be detected.
    */
-  finderTextHintColor?: string;
+  acceptedDocumentFormats?: BarcodeDocumentFormat[];
   /**
-   * Whether the flash is toggled on or off.
+   * Allowed orientations for automatic interface rotations.
    */
-  flashEnabled?: boolean;
+  allowedInterfaceOrientations?: UIInterfaceOrientationMask;
   /**
-   * String to show that no barcodes were scanned yet.
-   */
-  noBarcodesTitle?: string;
+  * Background color of the detection overlay.
+  */
+  cameraOverlayColor?: string;
   /**
-   * String being displayed on the submit button.
-   */
-  submitButtonTitle?: string;
+  * Whether the cancel button is hidden or not.
+  */
+  cancelButtonHidden?: boolean;
   /**
-   * Whether a sound should be played on successful barcode detection.
+   * String being displayed on the cancel button.
    */
-  successBeepEnabled?: boolean;
+  cancelButtonTitle?: string;
   /**
-   * Background color of the top bar.
-   */
-  topBarBackgroundColor?: string;
+  * Foreground color of the detection overlay.
+  */
+  finderLineColor?: string;
   /**
-   * Foreground color of the top bar buttons on the scanning screen.
+   * Width of the finder frame border. Default is 2.
    */
-  topBarButtonsColor?: string;
+  finderLineWidth?: number;
   /**
-   * Foreground color of the flash button when the flash is off.
+   * String being displayed as the description label.
    */
-  topBarButtonsInactiveColor?: string;
+  finderTextHint?: string;
   /**
-   * Accepted barcode formats.
+   * Foreground color of the description label.
    */
-  barcodeFormats?: BarcodeFormat[];
+  finderTextHintColor?: string;
   /**
-   * Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE.
-   * Android only.
+   * 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).
    */
-  useButtonsAllCaps?: boolean;
+  finderAspectRatio?: FinderAspectRatio;
   /**
-  * Optional minimum required text length of the detected barcode.
-  * The default is 0 (setting is turned off).
-  * NOTE: This feature works on ITF and MSI Plessey barcodes only.
+  * Whether the flash is toggled on or off.
   */
-  minimumTextLength?: number;
+  flashEnabled?: boolean;
   /**
-   * Optional maximum required text length of the detected barcode.
-   * The default is 0 (setting is turned off).
-   * NOTE: This feature works on ITF and MSI Plessey barcodes only.
+   * iOS Only: Whether the flash button shouldn be visible or not in the UI.
    */
-  maximumTextLength?: number;
+  flashButtonHidden?: boolean;
   /**
-   * Optional minimum required quiet zone 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.
+   * Accepted barcode formats.
    */
-  minimum1DBarcodesQuietZone?: number;
+  barcodeFormats?: BarcodeFormat[];
   /** 
    * Use a filter to determine which type of barcode can be detected; see `BarcodeFilter`
    */
   barcodeFilter?: BarcodeFilter;
   /**
-   * The engine mode of the barcode recognizer. Defaults to NEXT_GEN.
-   * To use the legacy recognizer, please specify LEGACY.
+   * Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE.
+   * Android only.
    */
-  engineMode?: EngineMode;
+  useButtonsAllCaps?: boolean;
   /**
-   * 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!
+   * The preferred camera module (default: BACK).
    */
-  gs1DecodingEnabled?: boolean;
+  cameraModule?: CameraModule;
   /**
-   * The checksum algorithm for MSI Plessey barcodes.
-   * The default value is [MSIPlesseyChecksumAlgorithm.Mod10].
+   * Background color of the top bar.
    */
-  msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm;
+  topBarBackgroundColor?: string;
   /**
-   * 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`.
+   * Foreground color of the top bar buttons on the scanning screen.
    */
-  stripCheckDigits?: boolean;
+  topBarButtonsColor?: string;
   /**
-   * The preferred camera module (default: BACK).
+   * 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.
    */
-  cameraModule?: CameraModule;
+  cameraZoomFactor?: number;
   /**
-   * 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.
+   * The engine mode of the barcode recognizer. Defaults to NEXT_GEN.
+   * To use the legacy recognizer, please specify LEGACY.
    */
-  lowPowerMode?: boolean;
+  engineMode?: EngineMode;
+  /**
+   * Whether a sound should be played on successful barcode detection.
+   */
+  successBeepEnabled?: boolean;
   /**
    * If `true`, replaces the cancel button in the top bar with a back arrow icon
    * The default is `false`.
    * Android only.
    */
   replaceCancelButtonWithIcon?: boolean;
-}
 
-interface InternalBarcodeDetectionCommonParameters {
   /**
-   * Accepted barcode formats.
-   */
-  barcodeFormats?: BarcodeFormat[];
-  /**
-   * An optional array of barcode document formats that acts as a detection filter.
-   * By default all supported document formats will be detected.
-   */
-  acceptedDocumentFormats?: BarcodeDocumentFormat[];
-  /** 
-   * Use a filter to determine which type of barcode can be detected; see `BarcodeFilter`
+   * The configuration for barcode overlays.
    */
-  barcodeFilter?: BarcodeFilter;
+  overlayConfiguration?: SelectionOverlayConfiguration;
+}
+
+/**
+ * An interface that contains additional parameters for barcodes detection and filtering.
+ */
+export interface BarcodeAdditionalParameters {
   /**
-   * 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; 
+  * 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;
   /**
    * Optional minimum required text length of the detected barcode.
    * The default is 0 (setting is turned off).
@@ -399,16 +246,13 @@ interface InternalBarcodeDetectionCommonParameters {
    */
   gs1DecodingEnabled?: boolean;
   /**
-  * The checksum algorithm for MSI Plessey barcodes.
-  * The default value is [MSIPlesseyChecksumAlgorithm.Mod10].
-  */
+   * The checksum algorithm for MSI Plessey barcodes.
+   * The default value is [MSIPlesseyChecksumAlgorithm.Mod10].
+   */
   msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm;
-}
-
-export interface DetectBarcodesOnImageArguments
-  extends InternalBarcodeDetectionCommonParameters {
   /**
-   * The input image file URI.
+   * Low density. Finds up to 6 QR codes in one image or video frame. This is the default value.
+   * High density. Finds up to 24 QR codes in one image or video frame.
    */
-  imageFileUri: string;
+  codeDensity?: CodeDensity;
 }

package/src/enum.ts

@@ -21,14 +21,10 @@ 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";
-
+      "ALL"
+    | "PORTRAIT"
+    | "LANDSCAPE";
+    
 export type BarcodeImageGenerationType =
     "NONE"
     | "VIDEO_FRAME"
@@ -82,3 +78,9 @@ export type BarcodeFilter =
     'WithExtension' |
     'WithEAN2Extension' |
     'WithEAN5Extension';
+
+export type CodeDensity = 'LOW' | 'HIGH';
+
+export type BarcodeOverlayFormat =  'NONE' |
+                                    'CODE' |
+                                    'CODEANDTYPE';

package/src/model.ts

@@ -1,4 +1,4 @@
-import { CameraImageFormat, LicenseStatus } from "./enum";
+import { BarcodeOverlayFormat, CameraImageFormat, LicenseStatus } from "./enum";
 
 export interface InitializationOptions {
     /**
@@ -54,4 +54,43 @@ export interface LicenseInfo {
 export interface FinderAspectRatio {
     width: number;
     height: number;
+}
+
+/**
+ * The Selection Overlay configuration interface for setting overlay over the barcode while ongoing detection.
+ */
+export interface SelectionOverlayConfiguration {
+    /**
+     * Displays an augmented reality view that draws the frames, content and type text 
+     * of the found barcodes when it finds them. Defaults to NO.
+     */
+    overlayEnabled: boolean;
+    /**
+     * The text format for the results overlays.
+     */
+    overlayTextFormat?: BarcodeOverlayFormat;
+    /**
+     * The color for the results overlays polygons.
+     */
+    polygonColor: string;
+    /**
+     * The text color for the results overlays.
+     */
+    textColor: string;
+    /**
+     * The text background color for the results overlays.
+     */
+    textContainerColor: string;
+    /**
+     * The highlighted color for the results overlays polygons.
+     */
+    highlightedPolygonColor?: string;
+    /**
+     * The highlighted color for the results overlays polygons.
+     */
+    highlightedTextColor?: string;
+    /**
+     * The highlighted color for the results overlays polygons.
+     */
+    highlightedTextContainerColor?: string;
 }

package/android/.idea/compiler.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CompilerConfiguration">
-    <bytecodeTargetLevel target="1.8" />
-  </component>
-</project>

package/android/.idea/gradle.xml

@@ -1,22 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GradleSettings">
-    <option name="linkedExternalProjectsSettings">
-      <GradleProjectSettings>
-        <option name="testRunner" value="PLATFORM" />
-        <option name="disableWrapperSourceDistributionNotification" value="true" />
-        <option name="distributionType" value="DEFAULT_WRAPPED" />
-        <option name="externalProjectPath" value="$PROJECT_DIR$" />
-        <option name="gradleHome" value="/usr/local/Cellar/gradle/6.8.3/libexec" />
-        <option name="gradleJvm" value="1.8 (2)" />
-        <option name="modules">
-          <set>
-            <option value="$PROJECT_DIR$" />
-          </set>
-        </option>
-        <option name="resolveModulePerSourceSet" value="false" />
-        <option name="useQualifiedModuleNames" value="true" />
-      </GradleProjectSettings>
-    </option>
-  </component>
-</project>

package/android/.idea/jarRepositories.xml

@@ -1,50 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="RemoteRepositoriesConfiguration">
-    <remote-repository>
-      <option name="id" value="central" />
-      <option name="name" value="Maven Central repository" />
-      <option name="url" value="https://repo1.maven.org/maven2" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="jboss.community" />
-      <option name="name" value="JBoss Community repository" />
-      <option name="url" value="https://repository.jboss.org/nexus/content/repositories/public/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="maven2" />
-      <option name="name" value="maven2" />
-      <option name="url" value="file:$PROJECT_DIR$/../node_modules/jsc-android/dist/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="MavenLocal" />
-      <option name="name" value="MavenLocal" />
-      <option name="url" value="file:$USER_HOME$/.m2/repository/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="maven" />
-      <option name="name" value="maven" />
-      <option name="url" value="file:$PROJECT_DIR$/../node_modules/react-native/android/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="maven4" />
-      <option name="name" value="maven4" />
-      <option name="url" value="https://nexus.scanbot.io/nexus/content/repositories/snapshots/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="BintrayJCenter" />
-      <option name="name" value="BintrayJCenter" />
-      <option name="url" value="https://jcenter.bintray.com/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="maven3" />
-      <option name="name" value="maven3" />
-      <option name="url" value="https://nexus.scanbot.io/nexus/content/repositories/releases/" />
-    </remote-repository>
-    <remote-repository>
-      <option name="id" value="Google" />
-      <option name="name" value="Google" />
-      <option name="url" value="https://dl.google.com/dl/android/maven2/" />
-    </remote-repository>
-  </component>
-</project>