scanbot-web-sdk 6.0.0-dev.2 → 6.0.0-dev.3

package/@types/consume-type.d.ts

@@ -1,7 +1,8 @@
 /**
  * ConsumeImage describes how a SDK method should handle image data.
  *
- * - `CONSUME_IMAGE` - This will use less memory but the caller can no longer access the image data.
+ * - `CONSUME_IMAGE` - This will use less memory but the caller can no longer access the original image data after the call to the SDK function.
+ *                     Internally, the image data is transferred to a web worker, see https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects
  * - `COPY_IMAGE`    - For processing the image, a copy is made. The caller can still access the original image data. This approach uses more memory.
  */
 export type ConsumeType = 'CONSUME_IMAGE' | 'COPY_IMAGE';

package/@types/core/bridge/common.d.ts

@@ -4,7 +4,7 @@ export declare class PartiallyConstructible {
 }
 export type DeepPartial<T> = T extends PartiallyConstructible ? {
     [P in keyof T]?: DeepPartial<T[P]>;
-} : T;
+} : T extends Array<infer I> ? DeepPartial<I>[] : T;
 export type RawImage = {
     width: number;
     height: number;

package/@types/core/bridge/compiled/BarcodeScannerTypes.d.ts

@@ -72,11 +72,13 @@ The engine mode for barcode scanning
 - `NEXT_GEN_LOW_POWER`:
    A faster version of the main engine mode, for use with low-power devices.
 - `NEXT_GEN`:
-   Main engine mode. Supports all barcodes types. Typically produces results faster than NEXT_GEN_LOW_POWER on most devices in live mode.
+   Main engine mode for high-power devices. Supports all barcodes types.
+- `NEXT_GEN_LOW_POWER_AR`:
+   Similar to NEXT_GEN_LOW_POWER, but optimized for AR.
 - `NEXT_GEN_AR`:
    Similar to NEXT_GEN, but optimized for AR.
 */
-export type EngineMode = "LEGACY" | "NEXT_GEN_LOW_POWER" | "NEXT_GEN" | "NEXT_GEN_AR";
+export type EngineMode = "LEGACY" | "NEXT_GEN_LOW_POWER" | "NEXT_GEN" | "NEXT_GEN_LOW_POWER_AR" | "NEXT_GEN_AR";
 /**
 Type of barcode document format used.
 
@@ -145,7 +147,7 @@ export declare class BarcodeRecognizerParameters extends PartiallyConstructible
     configurators: BarcodeConfig[];
     /**
     The engine mode for barcode scanning
-    @defaultValue "NEXT_GEN";
+    @defaultValue "NEXT_GEN_LOW_POWER";
     */
     engineMode: EngineMode;
     /**

package/@types/core/bridge/compiled/GDRTypes.d.ts

@@ -0,0 +1,38 @@
+import { DeepPartial, PartiallyConstructible } from "../common";
+/**
+Enumerates generic document formats.
+
+- `DeIdCardFront`:
+   DeIdCardFront
+- `DeIdCardBack`:
+   DeIdCardBack
+- `DePassport`:
+   DePassport
+- `DeDriverLicenseFront`:
+   DeDriverLicenseFront
+- `DeDriverLicenseBack`:
+   DeDriverLicenseBack
+- `DeResidencePermitFront`:
+   DeResidencePermitFront
+- `DeResidencePermitBack`:
+   DeResidencePermitBack
+- `EuropeanHealthInsuranceCard`:
+   EuropeanHealthInsuranceCard
+- `DeHealthInsuranceCardFront`:
+   DeHealthInsuranceCardFront
+*/
+export type DocumentType = "DeIdCardFront" | "DeIdCardBack" | "DePassport" | "DeDriverLicenseFront" | "DeDriverLicenseBack" | "DeResidencePermitFront" | "DeResidencePermitBack" | "EuropeanHealthInsuranceCard" | "DeHealthInsuranceCardFront";
+/**
+Lists of generic document formats to decode
+*/
+export declare class DocumentTypes extends PartiallyConstructible {
+    /** @param source {@displayType `DeepPartial<DocumentTypes>`} */
+    constructor(source?: DeepPartial<DocumentTypes>);
+}
+export declare namespace DocumentTypes {
+    /**
+    List of all generic document formats
+    @defaultValue ["DeIdCardFront", "DeIdCardBack", "DePassport", "DeDriverLicenseFront", "DeDriverLicenseBack", "DeResidencePermitFront", "DeResidencePermitBack", "EuropeanHealthInsuranceCard", "DeHealthInsuranceCardFront"];
+    */
+    const all: DocumentType[];
+}

package/@types/core/bridge/compiled/GenericDocument.d.ts

@@ -69,6 +69,39 @@ from systemic OCR errors, but in practice it still provides good results for mos
 */
 export type ValidationStatus = "INVALID" | "NONE" | "CONFIRMED" | "INFERRED" | "VALID" | "IGNORED";
 /**
+Type of parsing applied to field.
+
+
+- `ISO_DATE`:
+   Field value is parsed as ISO 8601 date in format YYYY-MM-DD.
+- `ISO_COUNTRY_ALPHA_2`:
+   Field value is parsed as ISO 3166-1 alpha-2 country code. E.g. "DE" for Germany.
+- `ISO_COUNTRY_ALPHA_3`:
+   Field value is parsed as ISO 3166-1 alpha-3 country code. E.g. "DEU" for Germany.
+- `ISO_COUNTRY_NUMERIC`:
+   Field value is parsed as ISO 3166-1 numeric country code. E.g. "276" for Germany.
+- `ISO_COUNTRY_NAME`:
+   Field value is parsed as ISO 3166-1 country name. E.g. "Germany".
+- `GENDER`:
+   Field value is parsed as "Male", "Female".
+*/
+export type DataFormat = "ISO_DATE" | "ISO_COUNTRY_ALPHA_2" | "ISO_COUNTRY_ALPHA_3" | "ISO_COUNTRY_NUMERIC" | "ISO_COUNTRY_NAME" | "GENDER";
+/**
+Parsed data
+*/
+export declare class ParsedData extends PartiallyConstructible {
+    /**
+    Parsing type
+    */
+    readonly type: DataFormat;
+    /**
+    Parsed value
+    */
+    readonly value: string;
+    /** @param source {@displayType `DeepPartial<ParsedData>`} */
+    constructor(source?: DeepPartial<ParsedData>);
+}
+/**
 Generic Document Type
 */
 export declare class FieldType extends PartiallyConstructible {
@@ -127,6 +160,11 @@ export declare class Field extends PartiallyConstructible {
     @defaultValue "NONE";
     */
     readonly validationStatus: ValidationStatus;
+    /**
+    Parsed data
+    @defaultValue [];
+    */
+    readonly parsedData: ParsedData[];
     /** @param source {@displayType `DeepPartial<Field>`} */
     constructor(source?: DeepPartial<Field>);
 }

package/@types/core/bridge/compiled/GenericDocumentRecognizerConfigs.d.ts

@@ -0,0 +1,183 @@
+import { DeepPartial, PartiallyConstructible } from "../common";
+import { DocumentType as GenericDocumentTypesDocumentType } from "./GenericDocumentTypes";
+import { DocumentType as MRZTypesDocumentType } from "./MRZTypes";
+/**
+Base class for all generic document configurations.
+*/
+export type GDRConfig = DateValidationConfig | EuropeanHealthInsuranceCardConfig | MRZFallbackConfig | GDRGroupConfig;
+/** @internal */
+export declare namespace GDRConfig {
+    /** @internal */
+    function From(source: {
+        [key: string]: any;
+    }): GDRConfig;
+}
+/**
+Date validation configuration.
+This configuration does not enable the scanning of any document types by itself.
+Add to recognizer configuration to require date validation checks for specific document types.
+
+*/
+export declare class DateValidationConfig extends PartiallyConstructible {
+    readonly _type: "DateValidationConfig";
+    /**
+    Minimum year of birth
+    @defaultValue 0;
+    */
+    readonly minBirthYear: number;
+    /**
+    Maximum year of birth
+    @defaultValue 2999;
+    */
+    readonly maxBirthYear: number;
+    /**
+    Minimum card expiration year
+    @defaultValue 0;
+    */
+    readonly minExpirationYear: number;
+    /**
+    Maximum card expiration year
+    @defaultValue 2999;
+    */
+    readonly maxExpirationYear: number;
+    /**
+    List of generic document formats for which date validation has to be applied.
+    @defaultValue [];
+    */
+    readonly documentTypes: GenericDocumentTypesDocumentType[];
+    /** @param source {@displayType `DeepPartial<DateValidationConfig>`} */
+    constructor(source?: DeepPartial<DateValidationConfig>);
+}
+/**
+Health insurance card issuing country
+
+- `AUSTRIA`:
+   Austria (Validation on the personal identification number is performed as described in "site:www.sozialversicherung.at Was ist die Versicherungsnummer?")
+- `BELGIUM`:
+   Belgium
+- `BULGARIA`:
+   Bulgaria
+- `CROATIA`:
+   Croatia
+- `CYPRUS`:
+   Cyprus
+- `CZECH_REPUBLIC`:
+   Czech Republic
+- `DENMARK`:
+   Denmark
+- `ESTONIA`:
+   Estonia
+- `FINLAND`:
+   Finland
+- `FRANCE`:
+   France
+- `GERMANY`:
+   Germany (Validation performed according to "Spezifikation für Musterkarten und Testkarten (eGK, HBA, SMC), Anhang A" and "GS1 Struktur der Kenn-Nummer (ICCSN) der elektronischen Gesundheitskarte")
+- `GREECE`:
+   Greece
+- `HUNGARY`:
+   Hungary
+- `IRELAND`:
+   Ireland
+- `ITALY`:
+   Italy
+- `LATVIA`:
+   Latvia
+- `LITHUANIA`:
+   Lithuania
+- `LUXEMBOURG`:
+   Luxembourg
+- `MALTA`:
+   Malta
+- `NETHERLANDS`:
+   Netherlands
+- `POLAND`:
+   Poland
+- `PORTUGAL`:
+   Portugal
+- `ROMANIA`:
+   Romania
+- `SLOVAKIA`:
+   Slovakia
+- `SLOVENIA`:
+   Slovenia
+- `SPAIN`:
+   Spain
+- `SWEDEN`:
+   Sweden
+- `SWITZERLAND`:
+   Switzerland
+*/
+export type EHICIssuingCountry = "AUSTRIA" | "BELGIUM" | "BULGARIA" | "CROATIA" | "CYPRUS" | "CZECH_REPUBLIC" | "DENMARK" | "ESTONIA" | "FINLAND" | "FRANCE" | "GERMANY" | "GREECE" | "HUNGARY" | "IRELAND" | "ITALY" | "LATVIA" | "LITHUANIA" | "LUXEMBOURG" | "MALTA" | "NETHERLANDS" | "POLAND" | "PORTUGAL" | "ROMANIA" | "SLOVAKIA" | "SLOVENIA" | "SPAIN" | "SWEDEN" | "SWITZERLAND";
+/**
+EHIC configuration. Add to recognizer configuration to scan EHIC.
+*/
+export declare class EuropeanHealthInsuranceCardConfig extends PartiallyConstructible {
+    readonly _type: "EuropeanHealthInsuranceCardConfig";
+    /**
+    Minimum year of birth
+    @defaultValue 0;
+    */
+    readonly minBirthYear: number;
+    /**
+    Maximum year of birth
+    @defaultValue 2999;
+    */
+    readonly maxBirthYear: number;
+    /**
+    Minimum card expiration year
+    @defaultValue 0;
+    */
+    readonly minExpirationYear: number;
+    /**
+    Maximum card expiration year
+    @defaultValue 2999;
+    */
+    readonly maxExpirationYear: number;
+    /**
+    If an expected country is selected, validation rules for the given country are used, a
+    and if the expected country cannot be inferred or the inferred country doesn't  match the given country,
+    the result of recognize() will be IncompleteValidation.
+    @defaultValue null;
+    */
+    readonly expectedCountry: EHICIssuingCountry | null;
+    /** @param source {@displayType `DeepPartial<EuropeanHealthInsuranceCardConfig>`} */
+    constructor(source?: DeepPartial<EuropeanHealthInsuranceCardConfig>);
+}
+/**
+MRZ fallback configuration.
+This configuration does not enable the scanning of any document types by itself.
+Add to recognizer configuration to enable recognizing the MRZ only, specifically for documents that are otherwise not supported.
+Note that this may enable scanning of documents that were not enabled through the accepted document types.
+
+*/
+export declare class MRZFallbackConfig extends PartiallyConstructible {
+    readonly _type: "MRZFallbackConfig";
+    /**
+    List of ISO 3166-1 alpha-3 country codes for which MRZ fallback is enabled. (e.g. "DEU" for Germany)
+    @defaultValue [];
+    */
+    readonly acceptedCountries: string[];
+    /**
+    List of MRZ document formats for which MRZ fallback is enabled.
+    @defaultValue [];
+    */
+    readonly acceptedMRZTypes: MRZTypesDocumentType[];
+    /** @param source {@displayType `DeepPartial<MRZFallbackConfig>`} */
+    constructor(source?: DeepPartial<MRZFallbackConfig>);
+}
+/**
+Convenience configuration for enabling the scanning of multiple generic document types with a common configuration.
+Add to recognizer configuration to enable the scanning of multiple generic documents.
+
+*/
+export declare class GDRGroupConfig extends PartiallyConstructible {
+    readonly _type: "GDRGroupConfig";
+    /**
+    List of generic document formats to scan. By default, the list is empty.
+    @defaultValue [];
+    */
+    readonly acceptedDocumentTypes: GenericDocumentTypesDocumentType[];
+    /** @param source {@displayType `DeepPartial<GDRGroupConfig>`} */
+    constructor(source?: DeepPartial<GDRGroupConfig>);
+}

package/@types/core/bridge/compiled/GenericDocumentRecognizerTypes.d.ts

@@ -1,4 +1,5 @@
 import { DeepPartial, PartiallyConstructible } from "../common";
+import { GDRConfig } from "./GenericDocumentRecognizerConfigs";
 import { GenericDocument } from "./GenericDocument";
 import { Point } from "../common";
 /**
@@ -83,7 +84,7 @@ export declare class ResultAccumulationConfig extends PartiallyConstructible {
 /**
 Configuration for the generic document recognizer
 */
-export declare class GenericDocumentRecognizerConfig extends PartiallyConstructible {
+export declare class GenericDocumentRecognizerParameters extends PartiallyConstructible {
     /**
     Configuration for how to accumulate results
     @defaultValue new ResultAccumulationConfig({});
@@ -95,10 +96,10 @@ export declare class GenericDocumentRecognizerConfig extends PartiallyConstructi
     */
     fieldExcludeList: string[];
     /**
-    Names of documents that should be recognized
-    @defaultValue [];
+    Options for generic document decoding
+    @defaultValue [new GDRGroupConfig({})];
     */
-    acceptedDocumentTypes: string[];
-    /** @param source {@displayType `DeepPartial<GenericDocumentRecognizerConfig>`} */
-    constructor(source?: DeepPartial<GenericDocumentRecognizerConfig>);
+    configurations: GDRConfig[];
+    /** @param source {@displayType `DeepPartial<GenericDocumentRecognizerParameters>`} */
+    constructor(source?: DeepPartial<GenericDocumentRecognizerParameters>);
 }

package/@types/core/bridge/compiled/GenericDocumentTypes.d.ts

@@ -0,0 +1,38 @@
+import { DeepPartial, PartiallyConstructible } from "../common";
+/**
+Enumerates generic document formats.
+
+- `DeIdCardFront`:
+   DeIdCardFront
+- `DeIdCardBack`:
+   DeIdCardBack
+- `DePassport`:
+   DePassport
+- `DeDriverLicenseFront`:
+   DeDriverLicenseFront
+- `DeDriverLicenseBack`:
+   DeDriverLicenseBack
+- `DeResidencePermitFront`:
+   DeResidencePermitFront
+- `DeResidencePermitBack`:
+   DeResidencePermitBack
+- `EuropeanHealthInsuranceCard`:
+   EuropeanHealthInsuranceCard
+- `DeHealthInsuranceCardFront`:
+   DeHealthInsuranceCardFront
+*/
+export type DocumentType = "DeIdCardFront" | "DeIdCardBack" | "DePassport" | "DeDriverLicenseFront" | "DeDriverLicenseBack" | "DeResidencePermitFront" | "DeResidencePermitBack" | "EuropeanHealthInsuranceCard" | "DeHealthInsuranceCardFront";
+/**
+Lists of generic document types to decode
+*/
+export declare class DocumentTypes extends PartiallyConstructible {
+    /** @param source {@displayType `DeepPartial<DocumentTypes>`} */
+    constructor(source?: DeepPartial<DocumentTypes>);
+}
+export declare namespace DocumentTypes {
+    /**
+    List of all generic document types
+    @defaultValue ["DeIdCardFront", "DeIdCardBack", "DePassport", "DeDriverLicenseFront", "DeDriverLicenseBack", "DeResidencePermitFront", "DeResidencePermitBack", "EuropeanHealthInsuranceCard", "DeHealthInsuranceCardFront"];
+    */
+    const all: DocumentType[];
+}

package/@types/core/bridge/compiled/ParametricFilters.d.ts

@@ -17,13 +17,15 @@ Preset of parameters for custom binarization filter.
 - `PRESET_1`:
    Usually performs well if there is no shadow.
 - `PRESET_2`:
-   Usually performs well even if there are shadows.
+   Usually performs well even if there are shadows and barcodes.
 - `PRESET_3`:
    Usually performs well even if there are shadows.
 - `PRESET_4`:
    Usually performs well even if there are shadows.
+- `PRESET_5`:
+   Usually performs well even if there are shadows and barcodes.
 */
-export type BinarizationFilterPreset = "PRESET_1" | "PRESET_2" | "PRESET_3" | "PRESET_4";
+export type BinarizationFilterPreset = "PRESET_1" | "PRESET_2" | "PRESET_3" | "PRESET_4" | "PRESET_5";
 /**
 Base class for all parametric filters.
 */