scanbot-web-sdk 6.0.0-dev.6 → 7.0.0-dev.2

package/@types/core/bridge/compiled/{EhicTypes.d.ts → EuropeanHealthInsuranceCardTypes.d.ts}

@@ -1,23 +1,24 @@
 import { DeepPartial, PartiallyConstructible } from "../common";
+import { EuropeanHealthInsuranceCardIssuingCountry } from "./DocumentDataExtractorConfigurationTypes";
 /**
-The result of the health insurance card recognition
+The result of the health insurance card recognition.
 */
-export declare class RecognitionResult extends PartiallyConstructible {
+export declare class EuropeanHealthInsuranceCardRecognitionResult extends PartiallyConstructible {
     /**
     Health insurance card fields
     */
-    readonly fields: RecognitionResult.Field[];
+    readonly fields: EuropeanHealthInsuranceCardRecognitionResult.Field[];
     /**
-    Detection status
+    Recognition status.
     @defaultValue "FAILED_DETECTION";
     */
-    readonly status: RecognitionResult.DetectionStatus;
-    /** @param source {@displayType `DeepPartial<RecognitionResult>`} */
-    constructor(source?: DeepPartial<RecognitionResult>);
+    readonly status: EuropeanHealthInsuranceCardRecognitionResult.RecognitionStatus;
+    /** @param source {@displayType `DeepPartial<EuropeanHealthInsuranceCardRecognitionResult>`} */
+    constructor(source?: DeepPartial<EuropeanHealthInsuranceCardRecognitionResult>);
 }
-export declare namespace RecognitionResult {
+export declare namespace EuropeanHealthInsuranceCardRecognitionResult {
     /**
-    Card detection status
+    Card recognition status.
 
     - `SUCCESS`:
        Detection successful. The fields array is filled with all of the extracted data. All validatable fields have passed validation.
@@ -26,15 +27,16 @@ export declare namespace RecognitionResult {
     - `INCOMPLETE_VALIDATION`:
        A potential EHIC was found but one or more fields failed validation.
     */
-    type DetectionStatus = "SUCCESS" | "FAILED_DETECTION" | "INCOMPLETE_VALIDATION";
+    type RecognitionStatus = "SUCCESS" | "FAILED_DETECTION" | "INCOMPLETE_VALIDATION";
+    const RecognitionStatusValues: RecognitionStatus[];
     /**
-    Health insurance card field
+    Health insurance card field.
     */
     class Field extends PartiallyConstructible {
         /**
         Health insurance card field type
         */
-        readonly type: RecognitionResult.Field.FieldType;
+        readonly type: EuropeanHealthInsuranceCardRecognitionResult.Field.FieldType;
         /**
         Recognized value
         */
@@ -44,117 +46,58 @@ export declare namespace RecognitionResult {
         */
         readonly confidence: number;
         /**
-        Field validation status
+        Field validation status.
         @defaultValue "NOT_VALIDATED";
         */
-        readonly validationStatus: RecognitionResult.Field.ValidationStatus;
+        readonly validationStatus: EuropeanHealthInsuranceCardRecognitionResult.Field.ValidationStatus;
         /** @param source {@displayType `DeepPartial<Field>`} */
         constructor(source?: DeepPartial<Field>);
     }
     namespace Field {
         /**
-        Health insurance card field validation status
+        Health insurance card field validation status.
 
         - `NOT_VALIDATED`:
-           Field shouldn't be validated
+           Field shouldn't be validated.
         - `FAILURE`:
-           Field is not valid
+           Field is not valid.
         - `SUCCESS`:
-           Field is valid
+           Field is valid.
         - `CONFIRMED`:
-           Field is valid and confirmed across multiple frames
+           Field is valid and confirmed across multiple frames.
         */
         type ValidationStatus = "NOT_VALIDATED" | "FAILURE" | "SUCCESS" | "CONFIRMED";
+        const ValidationStatusValues: ValidationStatus[];
         /**
-        Health insurance card field type
+        Health insurance card field type.
 
         - `SURNAME`:
-           Surname
+           Surname.
         - `GIVEN_NAME`:
-           Given name
+           Given name.
         - `DATE_OF_BIRTH`:
-           Date of birth
+           Date of birth.
         - `PERSONAL_IDENTIFICATION_NUMBER`:
-           Personal identification number
+           Personal identification number.
         - `INSTITUTION_NUMBER`:
-           Institution number
+           Institution number.
         - `INSTITUTION_NAME`:
-           Institution name
+           Institution name.
         - `CARD_NUMBER`:
-           Card number
+           Card number.
         - `CARD_EXPIRATION_DATE`:
-           Card expiration date
+           Card expiration date.
         - `COUNTRY`:
-           Country
+           Country.
         */
         type FieldType = "SURNAME" | "GIVEN_NAME" | "DATE_OF_BIRTH" | "PERSONAL_IDENTIFICATION_NUMBER" | "INSTITUTION_NUMBER" | "INSTITUTION_NAME" | "CARD_NUMBER" | "CARD_EXPIRATION_DATE" | "COUNTRY";
+        const FieldTypeValues: FieldType[];
     }
 }
 /**
-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 IssuingCountry = "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";
-/**
-Parameters for frame accumulation
+Configuration for the European health insurance card (EHIC) recognizer.
 */
-export declare class RecognizerParameters extends PartiallyConstructible {
+export declare class EuropeanHealthInsuranceCardRecognizerConfiguration extends PartiallyConstructible {
     /**
     List of allowed countries for the EHIC. If:
     - single country: validation rules for the given country are used starting from the first
@@ -171,48 +114,48 @@ export declare class RecognizerParameters extends PartiallyConstructible {
     If the country cannot be inferred within `maxCountryDetectionAttempts` successive frames in which the
     part of the card number that stores the country code was successfully OCR'd, then the country is
     inferred to be Unknown and no validation rules are applied. Field accumulation then proceeds normally.
-    In this case recognize() can eventually return Success and the document will have a CountryType of Unknown
+    In this case recognize() can eventually return Success and the document will have a CountryType of Unknown.
     @defaultValue [];
     */
-    readonly allowedCountries: IssuingCountry[];
+    allowedCountries: EuropeanHealthInsuranceCardIssuingCountry[];
     /**
-    Minimum year of birth
+    Minimum year of birth.
     @defaultValue 0;
     */
-    readonly minBirthYear: number;
+    minBirthYear: number;
     /**
-    Maximum year of birth
+    Maximum year of birth.
     @defaultValue 2999;
     */
-    readonly maxBirthYear: number;
+    maxBirthYear: number;
     /**
-    Minimum card expiration year
+    Minimum card expiration year.
     @defaultValue 0;
     */
-    readonly minExpirationYear: number;
+    minExpirationYear: number;
     /**
-    Maximum card expiration year
+    Maximum card expiration year.
     @defaultValue 2999;
     */
-    readonly maxExpirationYear: number;
+    maxExpirationYear: number;
     /**
     Maximum number of attempts before giving up on country detection. After the specified number of
     attempts, the country field is considered to be unknown and validation is skipped.
     This option is ignored if allowedCountries is not empty.
     @defaultValue 5;
     */
-    readonly maxCountryDetectionAttempts: number;
+    maxCountryDetectionAttempts: number;
     /**
     Minimum number of accumulated frames that should have equal result for a field.
     Once satisfied, the corresponding field is considered to be successfully-recognized and won't be considered in the subsequent frames.
     @defaultValue 4;
     */
-    readonly minEqualFrameCount: number;
+    minEqualFrameCount: number;
     /**
-    Maximum number of partial frame results to keep in cache while waiting to gather minEqualFrameCount equal results
+    Maximum number of partial frame results to keep in cache while waiting to gather minEqualFrameCount equal results.
     @defaultValue 10;
     */
-    readonly maxAccumulatedFrameCount: number;
-    /** @param source {@displayType `DeepPartial<RecognizerParameters>`} */
-    constructor(source?: DeepPartial<RecognizerParameters>);
+    maxAccumulatedFrameCount: number;
+    /** @param source {@displayType `DeepPartial<EuropeanHealthInsuranceCardRecognizerConfiguration>`} */
+    constructor(source?: DeepPartial<EuropeanHealthInsuranceCardRecognizerConfiguration>);
 }

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

@@ -1,41 +1,64 @@
 import { DeepPartial, PartiallyConstructible } from "../common";
 /**
-Method used to confirm a result
+Method used to confirm a result.
 
 - `EXACT`:
    Require seeing the same result multiple times to confirm it.
-   E.g. if the results are "John B. Doe", "John B.", "B. Doe", "John B. Doe" then the confirmation count for
-   "John B. Doe" is 2.
+   E.g. if the seen values are "John B. Doe", "John B.", "B. Doe", "John B. Doe" then the confirmation count for
+   the value "John B. Doe" is 2 and for the rest it's 1.
+   A field's value is considered CONFIRMED if its confirmation count is greater or equal to minConfirmations.
 - `INTERPOLATE`:
-   Interpolate between results to confirm them.
-   E.g. if the results are "John X. Doe", "John B.", "B. Doe" then the confirmation count for
-   "John B. Doe" is 2 as each substring of "John B. Doe" is least twice.
+   Interpolate between seen values to generate the most likely true value.
+   E.g. if the seen values are "John X. Doe", "John B.", "B. Doe" then the most likely true value
+   can be interpolated to be "John B. Doe".
+   The interpolated value is considered CONFIRMED if each character
+   in it has been seen at least minConfirmations times.
 */
 export type ConfirmationMethod = "EXACT" | "INTERPOLATE";
+export declare const ConfirmationMethodValues: ConfirmationMethod[];
 /**
-Configuration for how to accumulate results
+Configuration for how to accumulate results.
 */
-export declare class ResultAccumulationConfig extends PartiallyConstructible {
+export declare class ResultAccumulationConfiguration extends PartiallyConstructible {
     /**
-    Method used to confirm a result
+    Method used to confirm a result.
     @defaultValue "EXACT";
     */
     confirmationMethod: ConfirmationMethod;
     /**
-    Number of confirmations required to consider a result confirmed (see ConfirmationMethod)
+    Number of confirmations required to consider a result confirmed (see ConfirmationMethod).
+    Requiring more confirmations will increase the reliability of the result but also the time to
+    gather enough confirmations.
     @defaultValue 3;
     */
     minConfirmations: number;
     /**
-    Minimum confidence required to consider a field confirmed
+    Minimum confidence required to consider a field confirmed.
     @defaultValue 0.8;
     */
     minConfidenceForStableField: number;
     /**
-    Will auto-clear the cache if this number of frames have been a different document type or empty
+    Will auto-clear the cache if this number of frames have been a different document type or empty.
     @defaultValue 4;
     */
     autoClearThreshold: number;
-    /** @param source {@displayType `DeepPartial<ResultAccumulationConfig>`} */
-    constructor(source?: DeepPartial<ResultAccumulationConfig>);
+    /** @param source {@displayType `DeepPartial<ResultAccumulationConfiguration>`} */
+    constructor(source?: DeepPartial<ResultAccumulationConfiguration>);
+}
+/**
+Configure the frame accumulation process.
+*/
+export declare class AccumulatedResultsVerifierConfiguration extends PartiallyConstructible {
+    /**
+    Maximum number of accumulated frames to inspect to verify a scan result.
+    @defaultValue 3;
+    */
+    maximumNumberOfAccumulatedFrames: number;
+    /**
+    Minimum number of accumulated frames that have an equal result in order for the result to be considered verified.
+    @defaultValue 2;
+    */
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /** @param source {@displayType `DeepPartial<AccumulatedResultsVerifierConfiguration>`} */
+    constructor(source?: DeepPartial<AccumulatedResultsVerifierConfiguration>);
 }

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

@@ -40,7 +40,6 @@ If the same value is recognized in multiple frames, the value is considered CONF
 it will have the status NONE. This is the least strict validation method, as it does not protect
 from systemic OCR errors, but in practice it still provides good results for most fields.
 
-
 - `INVALID`:
    Field value failed validation. This status is used for fields that have validation rules, like
    IBAN, date fields, etc. that have check digits or a known format that can be validated.
@@ -55,7 +54,7 @@ from systemic OCR errors, but in practice it still provides good results for mos
    A CONFIRMED value gives a strong guarantee that the field value has been read out without errors,
    but not as strong as VALID. The value may still be incorrect, due to systemic OCR errors.
    In case of OCR errors, increase the number of frames needed to confirm the value in the
-   recognizer configuration
+   recognizer configuration.
 - `INFERRED`:
    Field value was inferred from other fields or from domain knowledge.
    The field value may differ from what is actually written in the document in unexpected situations.
@@ -68,10 +67,10 @@ from systemic OCR errors, but in practice it still provides good results for mos
    The value of this field is always empty, although the field may be non-empty in the document.
 */
 export type FieldValidationStatus = "INVALID" | "NONE" | "CONFIRMED" | "INFERRED" | "VALID" | "IGNORED";
+export declare const FieldValidationStatusValues: FieldValidationStatus[];
 /**
 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`:
@@ -86,8 +85,9 @@ Type of parsing applied to field.
    Field value is parsed as "Male", "Female".
 */
 export type FieldDataFormat = "ISO_DATE" | "ISO_COUNTRY_ALPHA_2" | "ISO_COUNTRY_ALPHA_3" | "ISO_COUNTRY_NUMERIC" | "ISO_COUNTRY_NAME" | "GENDER";
+export declare const FieldDataFormatValues: FieldDataFormat[];
 /**
-Parsed data
+Parsed data.
 */
 export declare class FieldParsedData extends PartiallyConstructible {
     /**
@@ -102,7 +102,7 @@ export declare class FieldParsedData extends PartiallyConstructible {
     constructor(source?: DeepPartial<FieldParsedData>);
 }
 /**
-Generic Document Type
+Generic Document Type.
 */
 export declare class FieldType extends PartiallyConstructible {
     /**
@@ -122,7 +122,7 @@ export declare class FieldType extends PartiallyConstructible {
     */
     readonly commonType: CommonFieldType | 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
+    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.
     @defaultValue null;
     */
     readonly listIndex: number | null;
@@ -130,7 +130,7 @@ export declare class FieldType extends PartiallyConstructible {
     constructor(source?: DeepPartial<FieldType>);
 }
 /**
-Generic document field
+Generic document field.
 */
 export declare class Field extends PartiallyConstructible {
     /**
@@ -142,12 +142,12 @@ export declare class Field extends PartiallyConstructible {
     */
     readonly value: OcrResult | null;
     /**
-    Confidence weight
+    Confidence weight.
     @defaultValue 1.0;
     */
     readonly confidenceWeight: number;
     /**
-    Crop of the field
+    Crop of the field.
     @defaultValue null;
     */
     readonly image: RawImage | null;
@@ -161,7 +161,7 @@ export declare class Field extends PartiallyConstructible {
     */
     readonly validationStatus: FieldValidationStatus;
     /**
-    Parsed data
+    Parsed data.
     @defaultValue [];
     */
     readonly parsedData: FieldParsedData[];
@@ -169,7 +169,7 @@ export declare class Field extends PartiallyConstructible {
     constructor(source?: DeepPartial<Field>);
 }
 /**
-Generic Document Type
+Generic Document Type.
 */
 export declare class GenericDocumentType extends PartiallyConstructible {
     /**
@@ -185,7 +185,7 @@ export declare class GenericDocumentType extends PartiallyConstructible {
     */
     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
+    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.
     @defaultValue null;
     */
     readonly listIndex: number | null;
@@ -193,7 +193,7 @@ export declare class GenericDocumentType extends PartiallyConstructible {
     constructor(source?: DeepPartial<GenericDocumentType>);
 }
 /**
-Generic document
+Generic document.
 */
 export declare class GenericDocument extends PartiallyConstructible {
     /**
@@ -211,18 +211,18 @@ export declare class GenericDocument extends PartiallyConstructible {
     /**
     Coordinates of the document in the parent document coordinate system
     */
-    readonly quad: Point[] | null;
+    readonly quad: Point[];
     /**
     Coordinates of the document in the root document coordinate system
     */
-    readonly quadInRoot: Point[] | null;
+    readonly quadInRoot: Point[];
     /**
-    Image crop of the document
+    Image crop of the document.
     @defaultValue null;
     */
     readonly crop: RawImage | null;
     /**
-    The average confidence in the accuracy of the document recognition result
+    The average confidence in the accuracy of the document recognition result.
     @defaultValue 0.0;
     */
     readonly confidence: number;

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

@@ -1,7 +1,7 @@
 import { DeepPartial, PartiallyConstructible } from "../common";
 import { Point } from "../common";
 /**
-Represents a line segment in 2D space
+Represents a line segment in 2D space.
 */
 export declare class LineSegmentInt extends PartiallyConstructible {
     /**
@@ -16,7 +16,7 @@ export declare class LineSegmentInt extends PartiallyConstructible {
     constructor(source?: DeepPartial<LineSegmentInt>);
 }
 /**
-Represents a line segment in 2D space
+Represents a line segment in 2D space.
 */
 export declare class LineSegmentFloat extends PartiallyConstructible {
     /**

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

@@ -11,3 +11,4 @@ Image rotation.
    90 degrees counterclockwise rotation.
 */
 export type ImageRotation = "NONE" | "CLOCKWISE_90" | "CLOCKWISE_180" | "COUNTERCLOCKWISE_90";
+export declare const ImageRotationValues: ImageRotation[];

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

@@ -1,40 +1,41 @@
 import { DeepPartial, PartiallyConstructible } from "../common";
 import { RawImage } from "../common";
 /**
-Type of the scanner internally to scan the license plate
+Type of the scanner internally to scan the license plate.
 
 - `CLASSIC`:
-   Classic scanning strategy
+   Classic scanning strategy.
 - `ML`:
-   ML-based scanning strategy
+   ML-based scanning strategy.
 */
-export type ScannerStrategy = "CLASSIC" | "ML";
+export type LicensePlateScannerStrategy = "CLASSIC" | "ML";
+export declare const LicensePlateScannerStrategyValues: LicensePlateScannerStrategy[];
 /**
-Configuration for the license plate scanner
+Configuration for the license plate scanner.
 */
-export declare class ScannerConfiguration extends PartiallyConstructible {
+export declare class LicensePlateScannerConfiguration extends PartiallyConstructible {
     /**
-    Maximum number of accumulated frames to inspect before actual result is returned
+    Maximum number of accumulated frames to inspect before actual result is returned.
     @defaultValue 3;
     */
     maximumNumberOfAccumulatedFrames: number;
     /**
-    Minimum number of accumulated frames that have equal result
+    Minimum number of accumulated frames that have equal result.
     @defaultValue 2;
     */
     minimumNumberOfRequiredFramesWithEqualScanningResult: number;
     /**
-    Strategy to use for scanning
+    Strategy to use for scanning.
     @defaultValue "ML";
     */
-    scannerStrategy: ScannerStrategy;
-    /** @param source {@displayType `DeepPartial<ScannerConfiguration>`} */
-    constructor(source?: DeepPartial<ScannerConfiguration>);
+    scannerStrategy: LicensePlateScannerStrategy;
+    /** @param source {@displayType `DeepPartial<LicensePlateScannerConfiguration>`} */
+    constructor(source?: DeepPartial<LicensePlateScannerConfiguration>);
 }
 /**
-The result of the license plate scanning
+The result of the license plate scanning.
 */
-export declare class ScannerResult extends PartiallyConstructible {
+export declare class LicensePlateScannerResult extends PartiallyConstructible {
     /**
     Country code
     */
@@ -48,20 +49,20 @@ export declare class ScannerResult extends PartiallyConstructible {
     */
     readonly rawText: string;
     /**
-    Recognition confidence
+    Recognition confidence.
     @defaultValue 0.0;
     */
     readonly confidence: number;
     /**
-    Text validation result
+    Text validation result.
     @defaultValue false;
     */
     readonly validationSuccessful: boolean;
     /**
-    The part of the image on which the plate was detected
+    The part of the image on which the plate was detected.
     @defaultValue null;
     */
     readonly croppedImage: RawImage | null;
-    /** @param source {@displayType `DeepPartial<ScannerResult>`} */
-    constructor(source?: DeepPartial<ScannerResult>);
+    /** @param source {@displayType `DeepPartial<LicensePlateScannerResult>`} */
+    constructor(source?: DeepPartial<LicensePlateScannerResult>);
 }