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

package/lib/typescript/src/types/core/barcode/BarcodeDocumentTypes.d.ts

@@ -0,0 +1,117 @@
+import { ToJsonConfiguration } from '../common/JsonSerializationTypes';
+import { GenericDocument } from '../generic_document/GenericDocument';
+import { DeepPartial } from '../utils/utils';
+import { BarcodeFormat } from './BarcodeTypes';
+/**
+Type of barcode document format used.
+
+- `AAMVA`:
+   American Association of Motor Vehicle Administrators barcode document.
+- `BOARDING_PASS`:
+   Boarding pass barcode document.
+- `DE_MEDICAL_PLAN`:
+   German medication plan barcode document.
+- `MEDICAL_CERTIFICATE`:
+   German medical certificate barcode document.
+- `ID_CARD_PDF_417`:
+   ID card barcode document.
+- `SEPA`:
+   SEPA barcode (aka GiroCode) document.
+- `SWISS_QR`:
+   Swiss QR barcode document.
+- `VCARD`:
+   VCard barcode document.
+- `GS1`:
+   GS1 barcode document.
+- `HIBC`:
+   Health industry barcode document.
+- `BRITISH_COLUMBIA_DRIVER_LICENSE`:
+   British Columbia driver license barcode document.
+*/
+export type BarcodeDocumentFormat = 
+/**
+  American Association of Motor Vehicle Administrators barcode document.
+  */
+'AAMVA'
+/**
+  Boarding pass barcode document.
+  */
+ | 'BOARDING_PASS'
+/**
+  German medication plan barcode document.
+  */
+ | 'DE_MEDICAL_PLAN'
+/**
+  German medical certificate barcode document.
+  */
+ | 'MEDICAL_CERTIFICATE'
+/**
+  ID card barcode document.
+  */
+ | 'ID_CARD_PDF_417'
+/**
+  SEPA barcode (aka GiroCode) document.
+  */
+ | 'SEPA'
+/**
+  Swiss QR barcode document.
+  */
+ | 'SWISS_QR'
+/**
+  VCard barcode document.
+  */
+ | 'VCARD'
+/**
+  GS1 barcode document.
+  */
+ | 'GS1'
+/**
+  Health industry barcode document.
+  */
+ | 'HIBC'
+/**
+  British Columbia driver license barcode document.
+  */
+ | 'BRITISH_COLUMBIA_DRIVER_LICENSE';
+/** @hidden */
+export declare const BarcodeDocumentFormatValues: ReadonlyArray<BarcodeDocumentFormat>;
+/**
+Barcode document formats.
+*/
+export declare class BarcodeDocumentFormats {
+    /** @param source {@displayType `DeepPartial<BarcodeDocumentFormats>`} */
+    constructor(source?: DeepPartial<BarcodeDocumentFormats>);
+    serialize(config?: ToJsonConfiguration): DeepPartial<BarcodeDocumentFormats>;
+}
+export declare namespace BarcodeDocumentFormats {
+    /**
+      All barcode document formats.
+      */
+    const all: BarcodeDocumentFormat[];
+    /**
+      Barcode types that are used to encode documents.
+      */
+    const documentBarcodeFormats: {
+        [key in BarcodeDocumentFormat]: BarcodeFormat[];
+    };
+}
+/**
+The result of barcode document parsing.
+*/
+export declare class BarcodeDocumentParserResult {
+    /**
+      True if any document was parsed.
+      */
+    readonly success: boolean;
+    /**
+      In case of success, the parsed document.
+      */
+    readonly parsedDocument: GenericDocument | null;
+    /** @param source {@displayType `DeepPartial<BarcodeDocumentParserResult>`} */
+    constructor(source?: DeepPartial<BarcodeDocumentParserResult>);
+    serialize(config?: ToJsonConfiguration): Promise<DeepPartial<BarcodeDocumentParserResult>>;
+    private _released;
+    release(): void;
+    encodeImages(): Promise<void>;
+}
+//# sourceMappingURL=BarcodeDocumentTypes.d.ts.map

package/lib/typescript/src/types/core/barcode/BarcodeDocumentTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BarcodeDocumentTypes.d.ts","sourceRoot":"","sources":["../../../../../../src/types/core/barcode/BarcodeDocumentTypes.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;EAyBE;AACF,MAAM,MAAM,qBAAqB;AAC/B;;IAEI;AACF,OAAO;AACT;;IAEI;GACF,eAAe;AACjB;;IAEI;GACF,iBAAiB;AACnB;;IAEI;GACF,qBAAqB;AACvB;;IAEI;GACF,iBAAiB;AACnB;;IAEI;GACF,MAAM;AACR;;IAEI;GACF,UAAU;AACZ;;IAEI;GACF,OAAO;AACT;;IAEI;GACF,KAAK;AACP;;IAEI;GACF,MAAM;AACR;;IAEI;GACF,iCAAiC,CAAC;AAEtC,cAAc;AACd,eAAO,MAAM,2BAA2B,EAAE,aAAa,CAAC,qBAAqB,CAYnE,CAAC;AAEX;;EAEE;AACF,qBAAa,sBAAsB;IACjC,yEAAyE;gBACtD,MAAM,GAAE,WAAW,CAAC,sBAAsB,CAAM;IAE5D,SAAS,CACd,MAAM,GAAE,mBAA+C,GACtD,WAAW,CAAC,sBAAsB,CAAC;CAGvC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;QAEI;IACG,MAAM,GAAG,EAAE,qBAAqB,EAYtC,CAAC;IACF;;QAEI;IACG,MAAM,sBAAsB,EAAE;SAAG,GAAG,IAAI,qBAAqB,GAAG,aAAa,EAAE;KA4BrF,CAAC;CACH;AAED;;EAEE;AACF,qBAAa,2BAA2B;IACtC;;QAEI;IACJ,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC;;QAEI;IACJ,SAAgB,cAAc,EAAE,eAAe,GAAG,IAAI,CAAC;IAEvD,8EAA8E;gBAC3D,MAAM,GAAE,WAAW,CAAC,2BAA2B,CAAM;IAc3D,SAAS,CACpB,MAAM,GAAE,mBAA+C,GACtD,OAAO,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC;IAQpD,OAAO,CAAC,SAAS,CAAkB;IAE5B,OAAO;IAYD,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAK3C"}

package/lib/typescript/src/{barcode → types/core/barcode}/BarcodeScannerTypes.d.ts

@@ -1,14 +1,22 @@
-import { BarcodeFormatConfigurationBase } from '../barcode/BarcodeConfigurationTypes';
-import { BarcodeDocumentFormat } from '../barcode/BarcodeDocumentTypes';
-import { BarcodeFormat, RangeEncoding, StructuredAppendInfo } from '../barcode/BarcodeTypes';
-import { GenericDocument } from '../documents/GenericDocument';
-import { ImageRef } from '../imageRef/image';
-import { ToJsonConfiguration } from '../utils/json/JsonSerializationTypes';
-import { DeepPartial, PartiallyConstructible, Point } from '../utils/utils';
+import { ProcessingMode } from '../common/CommonTypes';
+import { ToJsonConfiguration } from '../common/JsonSerializationTypes';
+import { GenericDocument } from '../generic_document/GenericDocument';
+import { ImageRef } from '../image/image';
+import type { Point } from '../utils/utils';
+import { DeepPartial } from '../utils/utils';
+import { BarcodeFormatConfigurationBase } from './BarcodeConfigurationTypes';
+import { BarcodeDocumentFormat } from './BarcodeDocumentTypes';
+import { BarcodeFormat, RangeEncoding, StructuredAppendInfo } from './BarcodeTypes';
 /**
 A single barcode found in the input image. Barcodes with the same content but different locations in the image are considered separate barcodes.
 */
-export declare class BarcodeItem extends PartiallyConstructible {
+export declare class BarcodeItem {
+    /**
+      Barcode format.
+      
+      Default is NONE
+      */
+    readonly format: BarcodeFormat;
     /**
       Text contained in the barcode. Binary data is returned in the rawBytes field only.
       */
@@ -31,12 +39,6 @@ export declare class BarcodeItem extends PartiallyConstructible {
       If this barcode is part of a structured append sequence, this field contains information about the sequence.
       */
     readonly structuredAppendInfo: StructuredAppendInfo | null;
-    /**
-      Barcode format.
-      
-      Default is NONE
-      */
-    readonly format: BarcodeFormat;
     /**
       The four corners of the barcode in the input image, in clockwise order starting from the top left, in image coordinates.
       */
@@ -126,9 +128,36 @@ The engine mode for barcode scanning.
    Similar to NEXT_GEN_LOW_POWER, but optimized for scanning from far distances.
 - `NEXT_GEN_FAR_DISTANCE`:
    Similar to NEXT_GEN, but optimized for scanning from far distances.
+- `NEXT_GEN_MAX_DISTANCE`:
+   Similar to NEXT_GEN_FAR_DISTANCE, but optimized for scanning from far distances on very high power devices.
 */
-export type BarcodeScannerEngineMode = 'LEGACY' | 'NEXT_GEN_LOW_POWER' | 'NEXT_GEN' | 'NEXT_GEN_LOW_POWER_FAR_DISTANCE' | 'NEXT_GEN_FAR_DISTANCE';
-export declare const BarcodeScannerEngineModeValues: BarcodeScannerEngineMode[];
+export type BarcodeScannerEngineMode = 
+/**
+  Legacy mode. Very fast, significantly less accurate. Doesn't support all barcode types.
+  */
+'LEGACY'
+/**
+  A faster version of the main engine mode, for use with low-power devices.
+  */
+ | 'NEXT_GEN_LOW_POWER'
+/**
+  Main engine mode for high-power devices. Supports all barcodes types.
+  */
+ | 'NEXT_GEN'
+/**
+  Similar to NEXT_GEN_LOW_POWER, but optimized for scanning from far distances.
+  */
+ | 'NEXT_GEN_LOW_POWER_FAR_DISTANCE'
+/**
+  Similar to NEXT_GEN, but optimized for scanning from far distances.
+  */
+ | 'NEXT_GEN_FAR_DISTANCE'
+/**
+  Similar to NEXT_GEN_FAR_DISTANCE, but optimized for scanning from far distances on very high power devices.
+  */
+ | 'NEXT_GEN_MAX_DISTANCE';
+/** @hidden */
+export declare const BarcodeScannerEngineModeValues: ReadonlyArray<BarcodeScannerEngineMode>;
 /**
 The method how to display barcodes from previous frames.
 
@@ -137,12 +166,21 @@ The method how to display barcodes from previous frames.
 - `INTERPOLATE_BY_CAMERA`:
    The quad of barcode is interpolated by the camera movement. This option is recommended when the camera is moving, but the scanned object is not.
 */
-export type BarcodeAccumulationMethod = 'LAST_VISIBLE' | 'INTERPOLATE_BY_CAMERA';
-export declare const BarcodeAccumulationMethodValues: BarcodeAccumulationMethod[];
+export type BarcodeAccumulationMethod = 
+/**
+  The quad of a barcode is simply given as the last quad when it was detected.
+  */
+'LAST_VISIBLE'
+/**
+  The quad of barcode is interpolated by the camera movement. This option is recommended when the camera is moving, but the scanned object is not.
+  */
+ | 'INTERPOLATE_BY_CAMERA';
+/** @hidden */
+export declare const BarcodeAccumulationMethodValues: ReadonlyArray<BarcodeAccumulationMethod>;
 /**
 Configuration for how to accumulate results.
 */
-export declare class BarcodeAccumulationConfiguration extends PartiallyConstructible {
+export declare class BarcodeAccumulationConfiguration {
     /**
       The time in milliseconds to accumulate barcodes across multiple frames.
       
@@ -169,7 +207,7 @@ export declare class BarcodeAccumulationConfiguration extends PartiallyConstruct
 /**
 Configuration for the barcode scanner.
 */
-export declare class BarcodeScannerConfiguration extends PartiallyConstructible {
+export declare class BarcodeScannerConfiguration {
     /**
       Options for barcode decoding.
       */
@@ -211,13 +249,22 @@ export declare class BarcodeScannerConfiguration extends PartiallyConstructible
       Default is false
       */
     optimizedForOverlays: boolean;
+    /**
+      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.
+      
+      Default is AUTO
+      */
+    processingMode: ProcessingMode;
     /** @param source {@displayType `DeepPartial<BarcodeScannerConfiguration>`} */
     constructor(source?: DeepPartial<BarcodeScannerConfiguration>);
 }
 /**
 The result of barcode scanning.
 */
-export declare class BarcodeScannerResult extends PartiallyConstructible {
+export declare class BarcodeScannerResult {
     /**
       List of found barcodes.
       */

package/lib/typescript/src/types/core/barcode/BarcodeScannerTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BarcodeScannerTypes.d.ts","sourceRoot":"","sources":["../../../../../../src/types/core/barcode/BarcodeScannerTypes.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAEL,8BAA8B,EAC/B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAEpF;;EAEE;AACF,qBAAa,WAAW;IACtB;;;;QAII;IACJ,SAAgB,MAAM,EAAE,aAAa,CAAU;IAC/C;;QAEI;IACJ,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B;;;;;;QAMI;IACJ,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC;;;;QAII;IACJ,SAAgB,iBAAiB,EAAE,aAAa,EAAE,CAAC;IACnD;;QAEI;IACJ,SAAgB,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAClE;;QAEI;IACJ,SAAgB,IAAI,EAAE,KAAK,EAAE,CAAC;IAC9B;;QAEI;IACJ,SAAgB,cAAc,EAAE,KAAK,EAAE,CAAC;IACxC;;QAEI;IACJ,SAAgB,YAAY,EAAE,KAAK,EAAE,CAAC;IACtC;;QAEI;IACJ,SAAgB,sBAAsB,EAAE,KAAK,EAAE,CAAC;IAChD;;;;QAII;IACJ,SAAgB,YAAY,EAAE,OAAO,CAAS;IAC9C;;QAEI;IACJ,SAAgB,WAAW,EAAE,QAAQ,GAAG,IAAI,CAAQ;IACpD;;QAEI;IACJ,SAAgB,eAAe,EAAE,MAAM,CAAC;IACxC;;;;QAII;IACJ,SAAgB,YAAY,EAAE,OAAO,CAAS;IAC9C;;;;;;;QAOI;IACJ,SAAgB,kBAAkB,EAAE,OAAO,CAAS;IACpD;;;;QAII;IACJ,SAAgB,gBAAgB,EAAE,MAAM,CAAK;IAC7C;;;;;QAKI;IACJ,SAAgB,SAAS,EAAE,MAAM,CAAO;IACxC;;QAEI;IACJ,SAAgB,iBAAiB,EAAE,eAAe,GAAG,IAAI,CAAC;IAC1D;;;;;QAKI;IACJ,SAAgB,WAAW,EAAE,MAAM,CAAM;IAEzC,8DAA8D;gBAC3C,MAAM,GAAE,WAAW,CAAC,WAAW,CAAM;IA2F3C,SAAS,CACpB,MAAM,GAAE,mBAA+C,GACtD,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAuCpC,OAAO,CAAC,SAAS,CAAkB;IAE5B,OAAO;IAiBD,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ3C;AAED;;;;;;;;;;;;;;;EAeE;AACF,MAAM,MAAM,wBAAwB;AAClC;;IAEI;AACF,QAAQ;AACV;;IAEI;GACF,oBAAoB;AACtB;;IAEI;GACF,UAAU;AACZ;;IAEI;GACF,iCAAiC;AACnC;;IAEI;GACF,uBAAuB;AACzB;;IAEI;GACF,uBAAuB,CAAC;AAE5B,cAAc;AACd,eAAO,MAAM,8BAA8B,EAAE,aAAa,CAAC,wBAAwB,CAOzE,CAAC;AAEX;;;;;;;EAOE;AACF,MAAM,MAAM,yBAAyB;AACnC;;IAEI;AACF,cAAc;AAChB;;IAEI;GACF,uBAAuB,CAAC;AAE5B,cAAc;AACd,eAAO,MAAM,+BAA+B,EAAE,aAAa,CAAC,yBAAyB,CAG3E,CAAC;AAEX;;EAEE;AACF,qBAAa,gCAAgC;IAC3C;;;;QAII;IACG,gBAAgB,EAAE,MAAM,CAAO;IACtC;;;;;;QAMI;IACG,wBAAwB,EAAE,OAAO,CAAQ;IAChD;;;;QAII;IACG,MAAM,EAAE,yBAAyB,CAA2B;IAEnE,mFAAmF;gBAChE,MAAM,GAAE,WAAW,CAAC,gCAAgC,CAAM;CAW9E;AAED;;EAEE;AACF,qBAAa,2BAA2B;IACtC;;QAEI;IACG,2BAA2B,EAAE,8BAA8B,EAAE,CAElE;IACF;;;;;;QAMI;IACG,wBAAwB,EAAE,qBAAqB,EAAE,CAYtD;IACF;;;;QAII;IACG,mBAAmB,EAAE,OAAO,CAAS;IAC5C;;;;QAII;IACG,kBAAkB,EAAE,OAAO,CAAS;IAC3C;;;;QAII;IACG,UAAU,EAAE,wBAAwB,CAAc;IACzD;;QAEI;IACG,kBAAkB,EAAE,gCAAgC,CAChB;IAC3C;;;;;QAKI;IACG,oBAAoB,EAAE,OAAO,CAAS;IAC7C;;;;;;;QAOI;IACG,cAAc,EAAE,cAAc,CAAU;IAE/C,8EAA8E;gBAC3D,MAAM,GAAE,WAAW,CAAC,2BAA2B,CAAM;CAkCzE;AAED;;EAEE;AACF,qBAAa,oBAAoB;IAC/B;;QAEI;IACJ,SAAgB,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxC;;QAEI;IACJ,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC,uEAAuE;gBACpD,MAAM,GAAE,WAAW,CAAC,oBAAoB,CAAM;IAepD,SAAS,CACpB,MAAM,GAAE,mBAA+C,GACtD,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAW7C,OAAO,CAAC,SAAS,CAAkB;IAE5B,OAAO;IAUD,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAO3C"}