react-native-scanbot-barcode-scanner-sdk 7.1.2-rc.2 → 8.0.0-rc.1

package/src/{barcode → types/core/barcode}/BarcodeTypes.ts

@@ -1,8 +1,8 @@
 /// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
 /// Generated from core/schemas/BarcodeTypes.yaml
 
-import { ToJsonConfiguration } from '../utils/json/JsonSerializationTypes';
-import { DeepPartial, PartiallyConstructible } from '../utils/utils';
+import { ToJsonConfiguration } from '../common/JsonSerializationTypes';
+import { DeepPartial } from '../utils/utils';
 
 /**
 Enumerates character encodings.
@@ -77,42 +77,145 @@ Enumerates character encodings.
    Binary data.
 */
 export type CharacterEncoding =
+  /**
+    Unknown encoding.
+    */
   | 'UNKNOWN'
+  /**
+    ASCII (ISO 646).
+    */
   | 'ASCII'
+  /**
+    ISO/IEC 8859 Part 1, a.k.a. Latin-1 Western European.
+    */
   | 'ISO_8859_PART1'
+  /**
+    ISO/IEC 8859 Part 2, a.k.a. Latin-2 Central European.
+    */
   | 'ISO_8859_PART2'
+  /**
+    ISO/IEC 8859 Part 3, a.k.a. Latin-3 South European.
+    */
   | 'ISO_8859_PART3'
+  /**
+    ISO/IEC 8859 Part 4, a.k.a. Latin-4 North European.
+    */
   | 'ISO_8859_PART4'
+  /**
+    ISO/IEC 8859 Part 5, a.k.a. Latin/Cyrillic.
+    */
   | 'ISO_8859_PART5'
+  /**
+    ISO/IEC 8859 Part 6, a.k.a. Latin/Arabic.
+    */
   | 'ISO_8859_PART6'
+  /**
+    ISO/IEC 8859 Part 7, a.k.a. Latin/Greek.
+    */
   | 'ISO_8859_PART7'
+  /**
+    ISO/IEC 8859 Part 8, a.k.a. Latin/Hebrew.
+    */
   | 'ISO_8859_PART8'
+  /**
+    ISO/IEC 8859 Part 9, a.k.a. Latin-5 Turkish.
+    */
   | 'ISO_8859_PART9'
+  /**
+    ISO/IEC 8859 Part 10, a.k.a. Latin-6 Nordic.
+    */
   | 'ISO_8859_PART10'
+  /**
+    ISO/IEC 8859 Part 11, a.k.a. Latin/Thai.
+    */
   | 'ISO_8859_PART11'
+  /**
+    ISO/IEC 8859 Part 13, a.k.a. Latin-7 Baltic Rim.
+    */
   | 'ISO_8859_PART13'
+  /**
+    ISO/IEC 8859 Part 14, a.k.a. Latin-8 Celtic.
+    */
   | 'ISO_8859_PART14'
+  /**
+    ISO/IEC 8859 Part 15, a.k.a. Latin-9.
+    */
   | 'ISO_8859_PART15'
+  /**
+    ISO/IEC 8859 Part 16, a.k.a. Latin-10 South-Eastern European.
+    */
   | 'ISO_8859_PART16'
+  /**
+    CP437 (DOS Latin US).
+    */
   | 'CP_437'
+  /**
+    Windows-1250 (Eastern European).
+    */
   | 'CP_1250'
+  /**
+    Windows-1251 (Cyrillic).
+    */
   | 'CP_1251'
+  /**
+    Windows-1252 (Western European).
+    */
   | 'CP_1252'
+  /**
+    Windows-1256 (Arabic).
+    */
   | 'CP_1256'
+  /**
+    Shift JIS (Japanese).
+    */
   | 'SHIFT_JIS'
+  /**
+    Big5 (Traditional Chinese).
+    */
   | 'BIG_5'
+  /**
+    GB2312 (Simplified Chinese).
+    */
   | 'GB_2312'
+  /**
+    GB18030 (Simplified Chinese).
+    */
   | 'GB_18030'
+  /**
+    EUC-JP (Japanese).
+    */
   | 'EUC_JP'
+  /**
+    EUC-KR (Korean).
+    */
   | 'EUC_KR'
+  /**
+    UTF16BE (UTF-16 Big Endian), a.k.a. UnicodeBig.
+    */
   | 'UTF_16_BE'
+  /**
+    UTF8 (UTF-8).
+    */
   | 'UTF_8'
+  /**
+    UTF16LE (UTF-16 Little Endian).
+    */
   | 'UTF_16_LE'
+  /**
+    UTF32BE (UTF-32 Big Endian).
+    */
   | 'UTF_32_BE'
+  /**
+    UTF32LE (UTF-32 Little Endian).
+    */
   | 'UTF_32_LE'
+  /**
+    Binary data.
+    */
   | 'BINARY';
 
-export const CharacterEncodingValues: CharacterEncoding[] = [
+/** @hidden */
+export const CharacterEncodingValues: ReadonlyArray<CharacterEncoding> = [
   'UNKNOWN',
   'ASCII',
   'ISO_8859_PART1',
@@ -147,12 +250,12 @@ export const CharacterEncodingValues: CharacterEncoding[] = [
   'UTF_32_BE',
   'UTF_32_LE',
   'BINARY',
-];
+] as const;
 
 /**
 A character encoding for a given range of bytes.
 */
-export class RangeEncoding extends PartiallyConstructible {
+export class RangeEncoding {
   /**
     Start index of the range.
     */
@@ -168,7 +271,6 @@ export class RangeEncoding extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<RangeEncoding>`} */
   public constructor(source: DeepPartial<RangeEncoding> = {}) {
-    super();
     if (source.start !== undefined) {
       this.start = source.start;
     } else {
@@ -200,7 +302,7 @@ export class RangeEncoding extends PartiallyConstructible {
 /**
 The structured append mode can be used to split a message across multiple barcodes.
 */
-export class StructuredAppendInfo extends PartiallyConstructible {
+export class StructuredAppendInfo {
   /**
     The number of barcodes in the structured append set.
     */
@@ -216,7 +318,6 @@ export class StructuredAppendInfo extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<StructuredAppendInfo>`} */
   public constructor(source: DeepPartial<StructuredAppendInfo> = {}) {
-    super();
     if (source.count !== undefined) {
       this.count = source.count;
     } else {
@@ -324,45 +425,157 @@ Enumerates barcode formats.
    PZN8, a.k.a. PZN, Pharmazentralnummer, German Pharmaceutical Central Number (1D).
 */
 export type BarcodeFormat =
+  /**
+    Used as a return value if no valid barcode has been detected.
+    */
   | 'NONE'
+  /**
+    Aztec (2D).
+    */
   | 'AZTEC'
+  /**
+    CODABAR (1D).
+    */
   | 'CODABAR'
+  /**
+    Code 39 (1D).
+    */
   | 'CODE_39'
+  /**
+    Code 93 (1D).
+    */
   | 'CODE_93'
+  /**
+    Code 128 (1D).
+    */
   | 'CODE_128'
+  /**
+    Data Matrix (2D).
+    */
   | 'DATA_MATRIX'
+  /**
+    EAN-8 (1D).
+    */
   | 'EAN_8'
+  /**
+    EAN-13 (1D).
+    */
   | 'EAN_13'
+  /**
+    ITF (Interleaved Two of Five) (1D).
+    */
   | 'ITF'
+  /**
+    MaxiCode (2D).
+    */
   | 'MAXI_CODE'
+  /**
+    PDF417 (2D).
+    */
   | 'PDF_417'
+  /**
+    QR Code (2D).
+    */
   | 'QR_CODE'
+  /**
+    GS1 DataBar-14 (formerly RSS-14) (1D).
+    */
   | 'DATABAR'
+  /**
+    GS1 DataBar Expanded (formerly RSS Expanded) (1D).
+    */
   | 'DATABAR_EXPANDED'
+  /**
+    UPC-A (1D).
+    */
   | 'UPC_A'
+  /**
+    UPC-E (1D).
+    */
   | 'UPC_E'
+  /**
+    MSI PLESSEY.
+    */
   | 'MSI_PLESSEY'
+  /**
+    IATA 2 of 5 (1D).
+    */
   | 'IATA_2_OF_5'
+  /**
+    INDUSTRIAL 2 of 5 (1D).
+    */
   | 'INDUSTRIAL_2_OF_5'
+  /**
+    CODE 25 (1D).
+    */
   | 'CODE_25'
+  /**
+    Micro QR Code (2D).
+    */
   | 'MICRO_QR_CODE'
+  /**
+    USPS Intelligent Mail, a.k.a. USPS OneCode, USPS-STD-11.
+    */
   | 'USPS_INTELLIGENT_MAIL'
+  /**
+    Royal Mail Four-State Customer Code, a.k.a. RM4SCC, CBC, BPO 4 State Code.
+    */
   | 'ROYAL_MAIL'
+  /**
+    Japan Post Four-State Barcode.
+    */
   | 'JAPAN_POST'
+  /**
+    Royal TNT Post Four-State Barcode, a.k.a. KIX, Klant IndeX.
+    */
   | 'ROYAL_TNT_POST'
+  /**
+    Australia Post Four-State Customer Code.
+    */
   | 'AUSTRALIA_POST'
+  /**
+    GS1 DataBar Limited.
+    */
   | 'DATABAR_LIMITED'
+  /**
+    Micro PDF417 (2D).
+    */
   | 'MICRO_PDF_417'
+  /**
+    GS1 COMPOSITE (combined linear and 2D).
+    */
   | 'GS1_COMPOSITE'
+  /**
+    Rectangular Micro QR Code (2D).
+    */
   | 'RMQR_CODE'
+  /**
+    Code 11 (1D).
+    */
   | 'CODE_11'
+  /**
+    Code 32 (Italian Pharmacode) (1D).
+    */
   | 'CODE_32'
+  /**
+    Pharmacode, a.k.a. One-Track Pharmacode, Pharmaceutical Binary Code (1D).
+    */
   | 'PHARMA_CODE'
+  /**
+    Two-Track Pharmacode, a.k.a. Pharmaceutical Binary Code.
+    */
   | 'PHARMA_CODE_TWO_TRACK'
+  /**
+    PZN7, legacy PZN (Pharmazentralnummer), invalid since 01.01.2020 (1D).
+    */
   | 'PZN_7'
+  /**
+    PZN8, a.k.a. PZN, Pharmazentralnummer, German Pharmaceutical Central Number (1D).
+    */
   | 'PZN_8';
 
-export const BarcodeFormatValues: BarcodeFormat[] = [
+/** @hidden */
+export const BarcodeFormatValues: ReadonlyArray<BarcodeFormat> = [
   'NONE',
   'AZTEC',
   'CODABAR',
@@ -400,16 +613,14 @@ export const BarcodeFormatValues: BarcodeFormat[] = [
   'PHARMA_CODE_TWO_TRACK',
   'PZN_7',
   'PZN_8',
-];
+] as const;
 
 /**
 Lists of barcode formats to decode.
 */
-export class BarcodeFormats extends PartiallyConstructible {
+export class BarcodeFormats {
   /** @param source {@displayType `DeepPartial<BarcodeFormats>`} */
-  public constructor(source: DeepPartial<BarcodeFormats> = {}) {
-    super();
-  }
+  public constructor(source: DeepPartial<BarcodeFormats> = {}) {}
 
   public serialize(
     config: ToJsonConfiguration = new ToJsonConfiguration()
@@ -494,7 +705,6 @@ export namespace BarcodeFormats {
     'EAN_13',
     'EAN_8',
     'ITF',
-    'MICRO_QR_CODE',
     'PDF_417',
     'QR_CODE',
     'UPC_A',
@@ -585,19 +795,41 @@ mark, a box, an escape sequence, a space or nothing at all.
    Combines the validations of VALIDATE_FULL and the human-readable output format of DECODE_STRUCTURE.
 */
 export type Gs1Handling =
+  /**
+    This is the default. 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'
+  /**
+    Same as PARSE. Additionally, messages containing unknown AI keys, or containing values
+    that don't fulfill the length, character set or regex requirements for known keys, are rejected.
+    */
   | 'VALIDATE_STRUCTURE'
+  /**
+    Same as VALIDATE_STRUCTURE. Additionally, 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'
+  /**
+    Includes all validations from VALIDATE_STRUCTURE. Additionally, GS1 messages which have missing or incompatible combinations of AI keys are rejected. Additionally, values are checked against a list of known linting rules, e.g. checksums are calculated and verified, dates are checked for validity, etc. Results that fail any of the linter rules are rejected. The complete set of linter rules from the GS1 Syntax Dictionary are implemented.
+    */
   | 'VALIDATE_FULL'
+  /**
+    Combines the validations of VALIDATE_FULL and the human-readable output format of DECODE_STRUCTURE.
+    */
   | 'DECODE_FULL';
 
-export const Gs1HandlingValues: Gs1Handling[] = [
+/** @hidden */
+export const Gs1HandlingValues: ReadonlyArray<Gs1Handling> = [
   'PARSE',
   'VALIDATE_STRUCTURE',
   'DECODE_STRUCTURE',
   'VALIDATE_FULL',
   'DECODE_FULL',
-];
+] as const;
 
 /**
 Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
@@ -618,15 +850,37 @@ Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
    Return any detected extension if present, but do not require it.
 */
 export type UpcEanExtensionBehavior =
+  /**
+    Only barcodes with a 2-digit extension are accepted.
+    */
   | 'REQUIRE_2'
+  /**
+    Only barcodes with a 5-digit extension are accepted.
+    */
   | 'REQUIRE_5'
+  /**
+    Only barcodes with either a 2-digit or a 5-digit extension are accepted.
+    */
   | 'REQUIRE_ANY'
+  /**
+    Always ignore the extension.
+    */
   | 'IGNORE'
+  /**
+    Return detected 2-digit extension if present, but do not require it. Ignore the 5-digit extension.
+    */
   | 'ALLOW_2'
+  /**
+    Return detected 5-digit extension if present, but do not require it. Ignore the 2-digit extension.
+    */
   | 'ALLOW_5'
+  /**
+    Return any detected extension if present, but do not require it.
+    */
   | 'ALLOW_ANY';
 
-export const UpcEanExtensionBehaviorValues: UpcEanExtensionBehavior[] = [
+/** @hidden */
+export const UpcEanExtensionBehaviorValues: ReadonlyArray<UpcEanExtensionBehavior> = [
   'REQUIRE_2',
   'REQUIRE_5',
   'REQUIRE_ANY',
@@ -634,4 +888,46 @@ export const UpcEanExtensionBehaviorValues: UpcEanExtensionBehavior[] = [
   'ALLOW_2',
   'ALLOW_5',
   'ALLOW_ANY',
-];
+] as const;
+
+/**
+Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes.
+Some barcode types are naturally prone to false positives (e.g. MSI Plessey).
+For those barcode types false positives can be drastically reduced (precision can be increased) by requiring that multiple scan-lines in the input scan to the same result.
+However, this stronger condition can lead to missed barcodes (lower recall). 
+Confirmation is avoided for barcode types, which are by design resistant to false positives, (e.g. Code128) to maximize recall.
+
+- `NONE`:
+   No confirmation is required. This mode is the most prone to generating false positives.
+- `MINIMAL`:
+   Minimal confirmation is performed. Compared to no confirmation, it provides a substantial decrease in false positives (increased precision), at the cost of a minimal decrease in recall.
+- `MODERATE`:
+   Moderate confirmation is performed. Compared to minimal confirmation, it provides an additional decrease in false positives, at the cost of a slight decrease in recall.
+- `THOROUGH`:
+   Recommended. Thorough confirmation is performed. Almost completely eliminates false positives, at the cost of an additional slight decrease in recall.
+*/
+export type OneDConfirmationMode =
+  /**
+    No confirmation is required. This mode is the most prone to generating false positives.
+    */
+  | 'NONE'
+  /**
+    Minimal confirmation is performed. Compared to no confirmation, it provides a substantial decrease in false positives (increased precision), at the cost of a minimal decrease in recall.
+    */
+  | 'MINIMAL'
+  /**
+    Moderate confirmation is performed. Compared to minimal confirmation, it provides an additional decrease in false positives, at the cost of a slight decrease in recall.
+    */
+  | 'MODERATE'
+  /**
+    Recommended. Thorough confirmation is performed. Almost completely eliminates false positives, at the cost of an additional slight decrease in recall.
+    */
+  | 'THOROUGH';
+
+/** @hidden */
+export const OneDConfirmationModeValues: ReadonlyArray<OneDConfirmationMode> = [
+  'NONE',
+  'MINIMAL',
+  'MODERATE',
+  'THOROUGH',
+] as const;

package/src/types/core/camera/Camera.ts

@@ -0,0 +1,33 @@
+/// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
+/// Generated from native/schemas/camera/Camera.yaml
+
+/**
+The size of the image from camera which would be sent to the scanner for live scanning.
+
+- `AUTO`:
+   Select to the image resolution automatically based on device specifics.
+- `FULL_HD`:
+   The image is in Full HD resolution. 1920x1080 pixels or close to it.
+- `UHD`:
+   The image is in UHD resolution. 3840x2160 pixels or close to it.
+*/
+export type CameraLiveScannerResolution =
+  /**
+    Select to the image resolution automatically based on device specifics.
+    */
+  | 'AUTO'
+  /**
+    The image is in Full HD resolution. 1920x1080 pixels or close to it.
+    */
+  | 'FULL_HD'
+  /**
+    The image is in UHD resolution. 3840x2160 pixels or close to it.
+    */
+  | 'UHD';
+
+/** @hidden */
+export const CameraLiveScannerResolutionValues: ReadonlyArray<CameraLiveScannerResolution> = [
+  'AUTO',
+  'FULL_HD',
+  'UHD',
+] as const;

package/src/types/core/camera/index.ts

@@ -0,0 +1 @@
+export * from './Camera';

package/src/types/core/common/CommonTypes.ts

@@ -0,0 +1,43 @@
+/// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
+/// Generated from core/schemas/CommonTypes.yaml
+
+/**
+Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it. 
+On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. 
+The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
+
+- `LIVE`:
+   In live mode input images are expected to come from a video source like a camera. 
+   Scanners in live mode typically spend little time on each image and are able to quickly analyze multiple images and combine the individual image results into a final result. 
+   Individual results from a particular image may be less accurate than running the scanner in single-shot mode on that frame, but after aggregating a few images of the same subject, the final result becomes much more accurate.
+- `SINGLE_SHOT`:
+   In single-shot the scanner tries to extract the maximum amount of information possible from each input image. The scanner typically spends much longer on analyzing the image to ensure that all available information has been extracted.
+- `AUTO`:
+   The scanner chooses live or single-shot mode based on the source of the image. An image constructed with RawImageLoadOptions.liveSource equal to true will be processed in live mode, otherwise it will be processed in single-shot mode.
+   On Android liveSource is automatically set to true if the ImageRef is created from Nv21 image data.
+   On iOS liveSource is automatically set to true if the ImageRef is created from a CMSampleBuffer.
+*/
+export type ProcessingMode =
+  /**
+    In live mode input images are expected to come from a video source like a camera. 
+    Scanners in live mode typically spend little time on each image and are able to quickly analyze multiple images and combine the individual image results into a final result. 
+    Individual results from a particular image may be less accurate than running the scanner in single-shot mode on that frame, but after aggregating a few images of the same subject, the final result becomes much more accurate.
+    */
+  | 'LIVE'
+  /**
+    In single-shot the scanner tries to extract the maximum amount of information possible from each input image. The scanner typically spends much longer on analyzing the image to ensure that all available information has been extracted.
+    */
+  | 'SINGLE_SHOT'
+  /**
+    The scanner chooses live or single-shot mode based on the source of the image. An image constructed with RawImageLoadOptions.liveSource equal to true will be processed in live mode, otherwise it will be processed in single-shot mode.
+    On Android liveSource is automatically set to true if the ImageRef is created from Nv21 image data.
+    On iOS liveSource is automatically set to true if the ImageRef is created from a CMSampleBuffer.
+    */
+  | 'AUTO';
+
+/** @hidden */
+export const ProcessingModeValues: ReadonlyArray<ProcessingMode> = [
+  'LIVE',
+  'SINGLE_SHOT',
+  'AUTO',
+] as const;

package/src/{utils/json → types/core/common}/JsonSerializationTypes.ts

@@ -1,12 +1,12 @@
 /// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
 /// Generated from core/schemas/JSONSerializationTypes.yaml
 
-import { DeepPartial, PartiallyConstructible } from '../../utils/utils';
+import { DeepPartial } from '../utils/utils';
 
 /**
 Configuration used to serialize an object to json.
 */
-export class ToJsonConfiguration extends PartiallyConstructible {
+export class ToJsonConfiguration {
   /**
     Serialize images in the object to json. If false, then fields that contain images are not serialized.
     
@@ -22,7 +22,6 @@ export class ToJsonConfiguration extends PartiallyConstructible {
 
   /** @param source {@displayType `DeepPartial<ToJsonConfiguration>`} */
   public constructor(source: DeepPartial<ToJsonConfiguration> = {}) {
-    super();
     if (source.serializeImages !== undefined) {
       this.serializeImages = source.serializeImages;
     }
@@ -49,6 +48,18 @@ Image serialization mode. Applicable only when serializeImages is true.
 - `BUFFER`:
    Images are serialized as base64 encoded buffers.
 */
-export type ImageSerializationMode = 'REFERENCE' | 'BUFFER';
+export type ImageSerializationMode =
+  /**
+    Images are serialized as references to native resources.
+    */
+  | 'REFERENCE'
+  /**
+    Images are serialized as base64 encoded buffers.
+    */
+  | 'BUFFER';
 
-export const ImageSerializationModeValues: ImageSerializationMode[] = ['REFERENCE', 'BUFFER'];
+/** @hidden */
+export const ImageSerializationModeValues: ReadonlyArray<ImageSerializationMode> = [
+  'REFERENCE',
+  'BUFFER',
+] as const;

package/src/types/core/common/index.ts

@@ -0,0 +1,2 @@
+export * from './CommonTypes';
+export * from './JsonSerializationTypes';