react-native-scanbot-barcode-scanner-sdk 5.1.2-alpha.1 → 6.1.0-rc.1

package/src/documents/CommonFieldType.ts

@@ -1,112 +1,89 @@
 /**
 Common field types
+
+- `ID`:
+   Document ID
+- `SURNAME`:
+   Person surname field
+- `MAIDEN_NAME`:
+   Person maiden name field
+- `GIVEN_NAMES`:
+   Person given names field
+- `BIRTH_DATE`:
+   Person birth date field
+- `NATIONALITY`:
+   Person nationality field
+- `BIRTHPLACE`:
+   Person birthplace field
+- `EXPIRY_DATE`:
+   Document expiry date field
+- `EYE_COLOR`:
+   Person height field
+- `HEIGHT`:
+   Person height field
+- `ISSUE_DATE`:
+   Document issue date field
+- `ISSUING_AUTHORITY`:
+   Document issuing authority field
+- `ADDRESS`:
+   Address field
+- `PSEUDONYM`:
+   Pseudonym field
+- `MRZ`:
+   MRZ field
+- `COUNTRY_CODE`:
+   Country code (ISO-3166 Alpha-3) field
+- `GENDER`:
+   Gender field
+- `SIGNATURE`:
+   Signature field
+- `PHOTO`:
+   Photo field
+- `VALID_FROM_DATE`:
+   Date of start of validity field
+- `ROUTING_NUMBER`:
+   Check routing number
+- `ACCOUNT_NUMBER`:
+   Check account number
+- `PLACE_OF_ISSUE`:
+   Place of issue for the identity card
+- `TITLE_TYPE`:
+   Type of the title field in the identity document
+- `REMARKS`:
+   Remarks field in the identity document
+- `NAME`:
+   Full name field
+- `CARD_ACCESS_NUMBER`:
+   Card access number field
+- `NONE`:
+   Not valid type
 */
 export type CommonFieldType =
-  /**
-    Document ID
-    */
   | 'ID'
-  /**
-    Person surname field
-    */
   | 'SURNAME'
-  /**
-    Person maiden name field
-    */
   | 'MAIDEN_NAME'
-  /**
-    Person given names field
-    */
   | 'GIVEN_NAMES'
-  /**
-    Person birth date field
-    */
   | 'BIRTH_DATE'
-  /**
-    Person nationality field
-    */
   | 'NATIONALITY'
-  /**
-    Person birthplace field
-    */
   | 'BIRTHPLACE'
-  /**
-    Document expiry date field
-    */
   | 'EXPIRY_DATE'
-  /**
-    Person height field
-    */
   | 'EYE_COLOR'
-  /**
-    Person height field
-    */
   | 'HEIGHT'
-  /**
-    Document issue date field
-    */
   | 'ISSUE_DATE'
-  /**
-    Document issuing authority field
-    */
   | 'ISSUING_AUTHORITY'
-  /**
-    Address field
-    */
   | 'ADDRESS'
-  /**
-    Pseudonym field
-    */
   | 'PSEUDONYM'
-  /**
-    MRZ field
-    */
   | 'MRZ'
-  /**
-    Country code (ISO-3166 Alpha-3) field
-    */
   | 'COUNTRY_CODE'
-  /**
-    Gender field
-    */
   | 'GENDER'
-  /**
-    Signature field
-    */
   | 'SIGNATURE'
-  /**
-    Photo field
-    */
   | 'PHOTO'
-  /**
-    Date of start of validity field
-    */
   | 'VALID_FROM_DATE'
-  /**
-    Check routing number
-    */
   | 'ROUTING_NUMBER'
-  /**
-    Check account number
-    */
   | 'ACCOUNT_NUMBER'
-  /**
-    Place of issue for the identity card
-    */
   | 'PLACE_OF_ISSUE'
-  /**
-    Type of the title field in the identity document
-    */
   | 'TITLE_TYPE'
-  /**
-    Remarks field in the identity document
-    */
   | 'REMARKS'
-  /**
-    Full name field
-    */
   | 'NAME'
-  /**
-    Card access number field
-    */
-  | 'CARD_ACCESS_NUMBER';
+  | 'CARD_ACCESS_NUMBER'
+  | 'NONE';

package/src/documents/GenericDocument.ts

@@ -1,19 +1,20 @@
 import { CommonFieldType } from './CommonFieldType';
-import { DeepPartial, PartiallyConstructible } from '../utils';
+import { DeepPartial, PartiallyConstructible, Point } from '../utils';
 
 /**
-Result of OCR text recognition.
-*/
+ Result of OCR text recognition.
+ */
 export class OcrResult extends PartiallyConstructible {
   /**
-    Maximum number of accumulated frames to inspect before actual result is returned.
-    */
-  public text: string;
+   Maximum number of accumulated frames to inspect before actual result is returned.
+   */
+  public readonly text: string;
   /**
-    Minimum number of accumulated frames that have equal result.
-    */
-  public confidence: number;
+   Minimum number of accumulated frames that have equal result.
+   */
+  public readonly confidence: number;
 
+  /** @param source {@displayType `DeepPartial<OcrResult>`} */
   public constructor(source: DeepPartial<OcrResult> = {}) {
     super();
     if (source.text !== undefined) {
@@ -30,39 +31,36 @@ export class OcrResult extends PartiallyConstructible {
 }
 
 /**
-Field validation status.
-*/
-export type ValidationStatus =
-  /**
-    Field value failed validation.
-    */
-  | 'INVALID'
-  /**
-    Field value passed validation.
-    */
-  | 'VALID'
-  /**
-    Field value was confirmed.
-    */
-  | 'CONFIRMED';
+ Field validation status.
+ - `UNDEFINED`: Field value was not considered during validation. iOS only
+ - `INVALID`: Field value failed validation.
+ - `VALID`: Field value passed validation.
+ - `CONFIRMED`: Field value was confirmed.
+ */
+export type ValidationStatus = 'UNDEFINED' | 'INVALID' | 'VALID' | 'CONFIRMED';
 
-/**
-Generic document field
-*/
+/**`
+ Generic document field
+ */
 export class Field extends PartiallyConstructible {
   /**
-    The type of the field.
-    */
-  public type: Field.Type;
+   The type of the field.
+   */
+  public readonly type: Field.Type;
+  /**
+   Value of the field. Applicable only to text fields.
+   */
+  public readonly value: OcrResult | null;
   /**
-    Value of the field. Applicable only to text fields.
-    */
-  public value: OcrResult | null;
+   Coordinates of the field in the root document coordinate system. Android only.
+   */
+  public readonly polygonInRoot?: Point[];
   /**
-    Field validation status. Applicable only to fields that support some kind of validation.
-    */
-  public validationStatus: ValidationStatus | null;
+   Field validation status. Applicable only to fields that support some kind of validation.
+   */
+  public readonly validationStatus: ValidationStatus | null;
 
+  /** @param source {@displayType `DeepPartial<Field>`} */
   public constructor(source: DeepPartial<Field> = {}) {
     super();
     if (source.type !== undefined) {
@@ -75,6 +73,9 @@ export class Field extends PartiallyConstructible {
     } else {
       throw new Error('value must be present in constructor argument');
     }
+    if (source.polygonInRoot !== undefined) {
+      this.polygonInRoot = source.polygonInRoot.map((it) => new Point(it.x, it.y));
+    }
     if (source.validationStatus !== undefined) {
       this.validationStatus = source.validationStatus != null ? source.validationStatus : null;
     } else {
@@ -85,30 +86,35 @@ export class Field extends PartiallyConstructible {
 
 export namespace Field {
   /**
-    Generic Document Type
-    */
+   Generic Document Type
+   */
   export class Type extends PartiallyConstructible {
     /**
-        Local field type name scoped to the containing document type
-        */
-    public name: string;
+     Local field type name scoped to the containing document type
+     */
+    public readonly name: string;
+    /**
+     Unique global field type name prefixed with the document types of all containing documents
+     */
+    public readonly fullName: string;
     /**
-        Unique global field type name prefixed with the document types of all containing documents
-        */
-    public fullName: string;
+     Normalized global field type name. Fields in document types derived from the same base document type in the schema will have the same normalized name.
+     */
+    public readonly normalizedName: string;
     /**
-        Normalized global field type name. Fields in document types derived from the same base document type in the schema will have the same normalized name.
-        */
-    public normalizedName: string;
+     Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.
+     */
+    public readonly commonType: CommonFieldType | null;
     /**
-        Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.
-        */
-    public commonType: CommonFieldType | null;
+     The friendly, human-readable display name of this field type in English. iOS only.
+     */
+    public displayText?: string | null = null;
     /**
-        A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field
-        */
-    public listIndex: number | null = null;
+     A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field
+     */
+    public readonly listIndex: number | null = null;
 
+    /** @param source {@displayType `DeepPartial<Type>`} */
     public constructor(source: DeepPartial<Type> = {}) {
       super();
       if (source.name !== undefined) {
@@ -131,6 +137,9 @@ export namespace Field {
       } else {
         throw new Error('commonType must be present in constructor argument');
       }
+      if (source.displayText !== undefined) {
+        this.displayText = source.displayText;
+      }
       if (source.listIndex !== undefined) {
         this.listIndex = source.listIndex != null ? source.listIndex : null;
       }
@@ -139,32 +148,33 @@ export namespace Field {
 }
 
 /**
-Generic document
-*/
+ Generic document
+ */
 export class GenericDocument extends PartiallyConstructible {
   /**
-    Document type
-    */
-  public type: GenericDocument.Type;
+   Document type
+   */
+  public readonly type: GenericDocument.Type;
   /**
-    List of document fields
-    */
-  public fields: Field[];
+   List of document fields
+   */
+  public readonly fields: Field[];
   /**
-    List of document sub-documents
-    */
-  public children: GenericDocument[];
+   List of document sub-documents
+   */
+  public readonly children: GenericDocument[];
   /**
-    The average confidence in the accuracy of the document recognition result
-    Default is 0
-    */
-  public confidence: number = 0.0;
+   The average confidence in the accuracy of the document recognition result
+   Default is 0
+   */
+  public readonly confidence: number = 0.0;
   /**
-    The weight of the confidence. Can be used to calculate the weighted average confidence of two documents.
-    Default is 0
-    */
-  public confidenceWeight: number = 0.0;
+   The weight of the confidence. Can be used to calculate the weighted average confidence of two documents.
+   Default is 0
+   */
+  public readonly confidenceWeight: number = 0.0;
 
+  /** @param source {@displayType `DeepPartial<GenericDocument>`} */
   public constructor(source: DeepPartial<GenericDocument> = {}) {
     super();
     if (source.type !== undefined) {
@@ -197,26 +207,31 @@ export class GenericDocument extends PartiallyConstructible {
 
 export namespace GenericDocument {
   /**
-    Generic Document Type
-    */
+   Generic Document Type
+   */
   export class Type extends PartiallyConstructible {
     /**
-        Local document type name
-        */
-    public name: string;
+     Local document type name
+     */
+    public readonly name: string;
     /**
-        Unique global document type name prefixed with the document types of all containing documents
-        */
-    public fullName: string;
+     Unique global document type name prefixed with the document types of all containing documents
+     */
+    public readonly fullName: string;
     /**
-        Normalized global document type name. Common document types appearing as child documents in different places will often have the same normalized type name.
-        */
-    public normalizedName: string;
+     Normalized global document type name. Common document types appearing as child documents in different places will often have the same normalized type name.
+     */
+    public readonly normalizedName: string;
     /**
-        A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field
-        */
-    public listIndex: number | null = null;
+     The friendly, human-readable display name of this document type in English. iOS only.
+     */
+    public displayText?: string | null = null;
+    /**
+     A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field
+     */
+    public readonly listIndex: number | null = null;
 
+    /** @param source {@displayType `DeepPartial<Type>`} */
     public constructor(source: DeepPartial<Type> = {}) {
       super();
       if (source.name !== undefined) {
@@ -234,6 +249,9 @@ export namespace GenericDocument {
       } else {
         throw new Error('normalizedName must be present in constructor argument');
       }
+      if (source.displayText !== undefined) {
+        this.displayText = source.displayText;
+      }
       if (source.listIndex !== undefined) {
         this.listIndex = source.listIndex != null ? source.listIndex : null;
       }

package/src/index.ts

@@ -123,6 +123,12 @@ const ScanbotBarcodeSDK = {
   extractImagesFromPDF: (args: ExtractImagesFromPdfArguments): Promise<ResultWrapper<string[]>> => {
     return ScanbotBarcodeSDKImpl.extractImagesFromPDF(args);
   },
+  /**
+   * Returns the Base 64 encoded representation of the image data.
+   */
+  getImageData(imageFileUri: string): Promise<ResultWrapper<string>> {
+    return ScanbotBarcodeSDKImpl.getImageData(imageFileUri);
+  },
 };
 
 export default ScanbotBarcodeSDK;
@@ -132,11 +138,11 @@ export * from './customTypes';
 export * from './results';
 export * from './configurations';
 export * from './customConfigurations';
+export { Point } from './utils';
 
 export * from './documents/BarcodeDocumentModel';
 export * from './documents/CommonFieldType';
 export * from './documents/GenericDocument';
-export * from './documents/Point';
 
 export * from './component/barcode-camera-view/ScanbotBarcodeCameraViewProperties';
 export { ScanbotBarcodeCameraView };

package/src/results.ts

@@ -1,4 +1,4 @@
-import { BarcodeResultField, DetectBarcodesOnImagesField, LicenseStatus } from './types';
+import { BarcodeResultField, LicenseStatus } from './types';
 
 export interface BarcodeScannerResult {
   /** The array of detected barcodes */
@@ -7,21 +7,6 @@ export interface BarcodeScannerResult {
 
 export interface BatchBarcodeScannerResult extends BarcodeScannerResult {}
 
-export interface DetectBarcodesOnImageResult {
-  /** The detected barcodes */
-  barcodes: BarcodeResultField[];
-}
-
-export interface DetectBarcodesOnImagesResult {
-  /** An array for which each element has a imageUri and the list of detected barcodes */
-  results: DetectBarcodesOnImagesField[];
-}
-
-export interface ExtractImagesFromPdfResult {
-  /** The URIs of the extracted images */
-  imageFilesUrls: string[];
-}
-
 export interface LicenseInfoResult {
   /** True if the license is valid, false otherwise */
   isLicenseValid: boolean;

package/src/types.ts

@@ -99,7 +99,15 @@ export type BarcodeFormat =
   /** GS1 DataBar Composite */
   | 'GS1_COMPOSITE'
   /** Micro pdf 417 */
-  | 'MICRO_PDF_417';
+  | 'MICRO_PDF_417'
+  /** Maxicode */
+  | 'MAXI_CODE'
+  /** rMQR Code */
+  | 'RMQR_CODE'
+  /** Code 11 */
+  | 'CODE_11'
+  /** Code 32 */
+  | 'CODE_32';
 
 /** A filter for extended EAN and UPC barcodes. */
 export type BarcodesExtensionFilter =
@@ -136,6 +144,13 @@ export type MSIPlesseyChecksumAlgorithm =
   /** Mod1110NCR checksum algorithm */
   | 'MOD_1110_NCR';
 
+/** The customer format used in AUSTRALIA_POST codes. Only relevant for format codes 59 and 62. */
+export type AustraliaPostCustomerFormat =
+  /** The numeric format. */
+  | 'NUMERIC'
+  /** The alphanumeric format. */
+  | 'ALPHA_NUMERIC';
+
 /** Barcode scanner engine mode */
 export type EngineMode =
   /** Recommended barcode scanning mode. Used by default */
@@ -170,13 +185,6 @@ export interface Size {
   height: number;
 }
 
-/** The expected density of QR codes in an image. */
-export type CodeDensity =
-  /** Up to 6 QR codes per image. */
-  | 'LOW'
-  /** Up to 24 QR codes per image. */
-  | 'HIGH';
-
 /** Represents camera preview modes */
 export type CameraPreviewMode =
   /** In this mode camera preview frames will be downscaled to the layout view size - full preview frame content will be visible, but unused edges could be appeared in the preview layout. */
@@ -195,14 +203,18 @@ export type BarcodeOverlayTextFormat =
 
 /** GS1 handling mode */
 export type Gs1HandlingMode =
-  /** No special handling for GS1-formatted results. Special (FNC1) characters are stripped. Equivalent to assumeGS1=false in ZXing for Code128 results. */
+  /** The (FNC1) character is simply stripped from the result in barcodes that implement this mode. Do not use. Will be removed in a future release. */
   | 'NONE'
-  /** GS1 messages are converted to machine-readable format per the GS1 spec (the special character is converted to ASCII \x1D). Message is not validated. This is the default. The implied 01 AI key is prepended to DataBar results. Equivalent to assumeGS1=true in ZXing for Code128 results. */
+  /** GS1 messages are converted to the machine-readable format per the GS1 spec (the special FNC1 character is converted to ASCII \x1D). The implied 01 AI key is prepended to DataBar results. No validation is performed. */
   | 'PARSE'
-  /** GS1 messages are converted to machine-readable format per the GS1 spec (the special character is converted to ASCII \x1D) and validated. The implied 01 AI key is prepended to DataBar results. Invalid messages are not returned. */
-  | 'VALIDATE'
-  /** GS1 strings are converted to human-readable format and validated. The implied (01) AI key is prepended to DataBar results. Invalid messages are not returned. */
-  | 'DECODE';
+  /** Same as PARSE. Additionally, messages containing unknown AI keys, or containing values of incorrect format for known keys, are not returned. */
+  | 'VALIDATE_STRUCTURE'
+  /** Same as VALIDATE_STRUCTURE, except that GS1 strings are converted to the human-readable format, instead (with parentheses used to wrap AI keys, e.g. (01)123456789). The \x1D character is never used in this representation. */
+  | 'DECODE_STRUCTURE'
+  /** Full validation including linting and checksums. This is the most strict mode. */
+  | 'VALIDATE_FULL'
+  /** Same as DECODE_STRUCTURE, but with full validation. */
+  | 'DECODE_FULL';
 
 /** Barcode Selection Overlay configuration */
 export interface SelectionOverlayConfiguration {
@@ -409,15 +421,6 @@ export type LicenseStatus =
   /** No license set yet. The SDKs trial mode is over. */
   | 'NotSet';
 
-/** Detect Barcodes On Images Result Field */
-export interface DetectBarcodesOnImagesField {
-  /** The URI of the image file the barcodes have been detected on */
-  imageFileUri: string;
-
-  /** The array of detected barcodes */
-  barcodeResults: BarcodeResultField[];
-}
-
 /** File encryption mode, 'AES128' or 'AES256'. */
 export type FileEncryptionMode =
   /** AES128 encryption mode */

package/src/ui_v2/barcode/ArTrackingOverlayConfiguration.ts

@@ -1,5 +1,6 @@
 import { BackgroundStyle } from '../common/Common';
 import { DeepPartial, PartiallyConstructible } from '../../utils';
+import { BadgeStyle } from '../common/Common';
 import { PolygonStyle } from '../common/Common';
 import { StyledText } from '../common/Common';
 
@@ -143,42 +144,6 @@ export class BarcodeItemConfiguration extends PartiallyConstructible {
   }
 }
 
-/**
-Configuration of the round button.
-*/
-export class BadgeStyle extends PartiallyConstructible {
-  /**
-    Control the visibility of the badge.
-    Default is true
-    */
-  public visible: boolean = true;
-  /**
-    The style of the button's background.
-    */
-  public background: BackgroundStyle;
-  /**
-    Color of the button foreground (icon, text).
-    Default is "?sbColorOnSurface"
-    */
-  public foregroundColor: string = '?sbColorOnSurface';
-
-  /** @param source {@displayType `DeepPartial<BadgeStyle>`} */
-  public constructor(source: DeepPartial<BadgeStyle> = {}) {
-    super();
-    if (source.visible !== undefined) {
-      this.visible = source.visible;
-    }
-    if (source.background !== undefined) {
-      this.background = new BackgroundStyle(source.background);
-    } else {
-      throw new Error('background must be present in constructor argument');
-    }
-    if (source.foregroundColor !== undefined) {
-      this.foregroundColor = source.foregroundColor;
-    }
-  }
-}
-
 /**
 Configuration of the AR overlay displayed on top of barcodes in the camera preview.
 */