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

package/@types/core/bridge/compiled_schemas_v3/GenericTextLineScannerTypes.d.ts

@@ -0,0 +1,165 @@
+import { DeepPartial, PartiallyConstructible } from "../common";
+import { Rectangle } from "../common";
+/**
+Structure containing recognized word text and bounds
+*/
+export declare class WordBox extends PartiallyConstructible {
+    /**
+    Recognized word text
+    */
+    readonly text: string;
+    /**
+    Bounding rectangle of the recognized word
+    */
+    readonly boundingRect: Rectangle;
+    /**
+    Confidence of the recognition
+    @defaultValue 0.0;
+    */
+    readonly recognitionConfidence: number;
+    /** @param source {@displayType `DeepPartial<WordBox>`} */
+    constructor(source?: DeepPartial<WordBox>);
+}
+/**
+Structure containing recognized symbol text and bounds
+*/
+export declare class SymbolBox extends PartiallyConstructible {
+    /**
+    Recognized symbol text
+    */
+    readonly symbol: string;
+    /**
+    Bounding rectangle of the recognized symbol
+    */
+    readonly boundingRect: Rectangle;
+    /**
+    Confidence of the recognition
+    */
+    readonly recognitionConfidence: number;
+    /** @param source {@displayType `DeepPartial<SymbolBox>`} */
+    constructor(source?: DeepPartial<SymbolBox>);
+}
+/**
+The result of the text line recognition
+*/
+export declare class ScannerResult extends PartiallyConstructible {
+    /**
+    Raw recognized string
+    */
+    readonly rawText: string;
+    /**
+    Boxes for each recognized word
+    */
+    readonly wordBoxes: WordBox[];
+    /**
+    Boxes for each recognized symbol
+    */
+    readonly symbolBoxes: SymbolBox[];
+    /**
+    Confidence of the recognition
+    @defaultValue 0.0;
+    */
+    readonly confidence: number;
+    /**
+    Whether the validation was successful
+    @defaultValue false;
+    */
+    readonly validationSuccessful: boolean;
+    /** @param source {@displayType `DeepPartial<ScannerResult>`} */
+    constructor(source?: DeepPartial<ScannerResult>);
+}
+/**
+Preset for the validation
+
+- `VEHICLE_IDENTIFICATION_NUMBER`:
+   Validation rules for vehicle identification numbers
+*/
+export type ValidatorPreset = "VEHICLE_IDENTIFICATION_NUMBER";
+/**
+Base class for content validators
+*/
+export type ContentValidator = DefaultContentValidator | PresetContentValidator | PatternContentValidator;
+/** @internal */
+export declare namespace ContentValidator {
+    /** @internal */
+    function From(source: {
+        [key: string]: any;
+    }): ContentValidator;
+}
+/**
+Default content validator. Accepts only non-empty strings.
+*/
+export declare class DefaultContentValidator extends PartiallyConstructible {
+    readonly _type: "DefaultContentValidator";
+    /**
+    OCR whitelist. Empty string means no restriction.
+    @defaultValue "";
+    */
+    allowedCharacters: string;
+    /** @param source {@displayType `DeepPartial<DefaultContentValidator>`} */
+    constructor(source?: DeepPartial<DefaultContentValidator>);
+}
+/**
+Preset content validator
+*/
+export declare class PresetContentValidator extends PartiallyConstructible {
+    readonly _type: "PresetContentValidator";
+    /**
+    Validator preset
+    */
+    preset: ValidatorPreset;
+    /** @param source {@displayType `DeepPartial<PresetContentValidator>`} */
+    constructor(source?: DeepPartial<PresetContentValidator>);
+}
+/**
+Pattern content validator
+*/
+export declare class PatternContentValidator extends PartiallyConstructible {
+    readonly _type: "PatternContentValidator";
+    /**
+    OCR whitelist. Empty string means no restriction.
+    @defaultValue "";
+    */
+    allowedCharacters: string;
+    /**
+    Wildcard validation pattern.
+      ? - any character
+      # - any digit
+      all other characters represent themselves
+    */
+    pattern: string;
+    /**
+    Whether the pattern should match the whole string or just a substring
+    @defaultValue false;
+    */
+    matchSubstring: boolean;
+    /** @param source {@displayType `DeepPartial<PatternContentValidator>`} */
+    constructor(source?: DeepPartial<PatternContentValidator>);
+}
+/**
+Configuration for the generic text line scanner
+*/
+export declare class ScannerConfiguration extends PartiallyConstructible {
+    /**
+    Maximum image side (height or width) for OCR process. 0 - do not rescale.
+    @defaultValue 0;
+    */
+    ocrResolutionLimit: number;
+    /**
+    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
+    @defaultValue 2;
+    */
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /**
+    Content validator
+    @defaultValue new DefaultContentValidator({});
+    */
+    validator: ContentValidator;
+    /** @param source {@displayType `DeepPartial<ScannerConfiguration>`} */
+    constructor(source?: DeepPartial<ScannerConfiguration>);
+}

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

@@ -0,0 +1,49 @@
+import { DeepPartial, PartiallyConstructible } from "../common";
+import { Point } from "../common";
+/**
+Represents a line segment in 2D space
+*/
+export declare class LineSegmentInt extends PartiallyConstructible {
+    /**
+    Start point of the segment
+    */
+    readonly start: Point;
+    /**
+    End point of the segment
+    */
+    readonly end: Point;
+    /** @param source {@displayType `DeepPartial<LineSegmentInt>`} */
+    constructor(source?: DeepPartial<LineSegmentInt>);
+}
+/**
+Represents a line segment in 2D space
+*/
+export declare class LineSegmentFloat extends PartiallyConstructible {
+    /**
+    Start point of the segment
+    */
+    readonly start: Point;
+    /**
+    End point of the segment
+    */
+    readonly end: Point;
+    /** @param source {@displayType `DeepPartial<LineSegmentFloat>`} */
+    constructor(source?: DeepPartial<LineSegmentFloat>);
+}
+/**
+Aspect ratio is the ratio of the width to the height of an image or screen.
+*/
+export declare class AspectRatio extends PartiallyConstructible {
+    /**
+    Width component of the aspect ratio.
+    @defaultValue 1.0;
+    */
+    readonly width: number;
+    /**
+    Height component of the aspect ratio.
+    @defaultValue 1.0;
+    */
+    readonly height: number;
+    /** @param source {@displayType `DeepPartial<AspectRatio>`} */
+    constructor(source?: DeepPartial<AspectRatio>);
+}

package/@types/core/bridge/compiled_schemas_v3/ImageProcessorTypes.d.ts

@@ -0,0 +1,13 @@
+/**
+Image rotation.
+
+- `ROTATION_NONE`:
+   No rotation.
+- `ROTATION_90_CLOCKWISE`:
+   90 degrees clockwise rotation.
+- `ROTATION_180`:
+   180 degrees rotation.
+- `ROTATION_90_COUNTERCLOCKWISE`:
+   90 degrees counterclockwise rotation.
+*/
+export type ImageRotation = "ROTATION_NONE" | "ROTATION_90_CLOCKWISE" | "ROTATION_180" | "ROTATION_90_COUNTERCLOCKWISE";

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

@@ -0,0 +1,67 @@
+import { DeepPartial, PartiallyConstructible } from "../common";
+import { RawImage } from "../common";
+/**
+Type of the scanner internally to scan the license plate
+
+- `CLASSIC`:
+   Classic scanning strategy
+- `ML`:
+   ML-based scanning strategy
+*/
+export type ScannerStrategy = "CLASSIC" | "ML";
+/**
+Configuration for the license plate scanner
+*/
+export declare class ScannerConfiguration extends PartiallyConstructible {
+    /**
+    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
+    @defaultValue 2;
+    */
+    minimumNumberOfRequiredFramesWithEqualScanningResult: number;
+    /**
+    Strategy to use for scanning
+    @defaultValue "ML";
+    */
+    scannerStrategy: ScannerStrategy;
+    /** @param source {@displayType `DeepPartial<ScannerConfiguration>`} */
+    constructor(source?: DeepPartial<ScannerConfiguration>);
+}
+/**
+The result of the license plate scanning
+*/
+export declare class ScannerResult extends PartiallyConstructible {
+    /**
+    Country code
+    */
+    readonly countryCode: string;
+    /**
+    License plate
+    */
+    readonly licensePlate: string;
+    /**
+    Raw recognized string
+    */
+    readonly rawText: string;
+    /**
+    Recognition confidence
+    @defaultValue 0.0;
+    */
+    readonly confidence: number;
+    /**
+    Text validation result
+    @defaultValue false;
+    */
+    readonly validationSuccessful: boolean;
+    /**
+    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>);
+}

package/@types/core/bridge/compiled_schemas_v3/MRZTypes.d.ts

@@ -0,0 +1,52 @@
+import { AccumulatedResultsVerifierConfig } from "./FrameUtilities";
+import { DeepPartial, PartiallyConstructible } from "../common";
+import { GenericDocument } from "./GenericDocument";
+/**
+Type of document containing the MRZ
+
+- `UNKNOWN`:
+   Undefined
+- `CREW_MEMBER_CERTIFICATE`:
+   Crew member certificate
+- `ID_CARD`:
+   ID card
+- `PASSPORT`:
+   Passport
+- `VISA`:
+   Visa card
+- `CH_DRIVING_LICENSE`:
+   Swiss driver license
+*/
+export type DocumentType = "UNKNOWN" | "CREW_MEMBER_CERTIFICATE" | "ID_CARD" | "PASSPORT" | "VISA" | "CH_DRIVING_LICENSE";
+/**
+Container for result of MRZ recognition attempt
+*/
+export declare class RecognitionResult extends PartiallyConstructible {
+    /**
+    Recognition successful
+    @defaultValue false;
+    */
+    readonly recognitionSuccessful: boolean;
+    /**
+    Raw string value of MRZ
+    */
+    readonly rawMRZ: string;
+    /**
+    Generic document containing MRZ data
+    */
+    readonly document: GenericDocument | null;
+    /** @param source {@displayType `DeepPartial<RecognitionResult>`} */
+    constructor(source?: DeepPartial<RecognitionResult>);
+}
+/**
+Configuration for MRZ recognizer
+*/
+export declare class RecognizerConfiguration extends PartiallyConstructible {
+    /**
+    Configure the frame accumulation process
+    @defaultValue new AccumulatedResultsVerifierConfig({});
+    */
+    accumulatedResultsVerifierConfig: AccumulatedResultsVerifierConfig;
+    /** @param source {@displayType `DeepPartial<RecognizerConfiguration>`} */
+    constructor(source?: DeepPartial<RecognizerConfiguration>);
+}

package/@types/core/bridge/compiled_schemas_v3/MedicalCertificateTypes.d.ts

@@ -0,0 +1,306 @@
+import { DeepPartial, PartiallyConstructible } from "../common";
+import { DetectionResult } from "./DocumentDetectorTypes";
+import { Point } from "../common";
+import { RawImage } from "../common";
+/**
+Parameters for the medical certificate recognition. The recognizer supports
+Form 1 (Arbeitsunfähigkeitsbescheinigung) and
+Form 21a (Ärztliche Bescheinigung für den Bezug von Krankengeld bei Erkrankung eines Kindes)
+from the KBV (Kassenärztliche Bundesvereinigung) list of forms.
+
+*/
+export declare class RecognitionParameters extends PartiallyConstructible {
+    /**
+    Document will be detected and cropped before recognition.
+    If false, a cropped image of a document is assumed.
+    @defaultValue true;
+    */
+    shouldCropDocument: boolean;
+    /**
+    All data in the patient info box will be extracted.
+    If false, the patient info box is ignored.
+    @defaultValue true;
+    */
+    recognizePatientInfoBox: boolean;
+    /**
+    Some forms are printed with an extra barcode that encodes the same information as the document.
+    Reading the barcode is more reliable than OCR and is recommended when possible.
+    If false, the barcode will not be scanned.
+    @defaultValue true;
+    */
+    recognizeBarcode: boolean;
+    /**
+    If true, cropped document image will be extracted and returned.
+    @defaultValue false;
+    */
+    extractCroppedImage: boolean;
+    /**
+    If true, the image is sharpened before processing
+    @defaultValue false;
+    */
+    preprocessInput: boolean;
+    /** @param source {@displayType `DeepPartial<RecognitionParameters>`} */
+    constructor(source?: DeepPartial<RecognitionParameters>);
+}
+/**
+Type of the checkbox
+
+- `UNKNOWN`:
+   Unknown checkbox type
+- `WORK_ACCIDENT`:
+   (Form 1) Work accident (Arbeitsunfall, Arbeitsunfall-folgen, Berufskrankheit) checkbox
+- `ASSIGNED_TO_ACCIDENT_INSURANCE_DOCTOR`:
+   (Form 1) Assigned to accident insurance doctor (dem Durchgangsarzt zugewiesen) checkbox
+- `INITIAL_CERTIFICATE`:
+   (Form 1) Initial certificate (Erstbescheinigung) checkbox
+- `RENEWED_CERTIFICATE`:
+   (Form 1) Renewed certificate (Folgebescheinigung) checkbox
+- `INSURED_PAY_CASE`:
+   (Form 1) Insured pay case (ab 7. AU-Woche oder sonstiger Krankengeldfall) checkbox
+- `FINAL_CERTIFICATE`:
+   (Form 1) Final certificate (Endbescheinigung) checkbox
+- `REQUIRES_CARE_YES`:
+   (Form 21a) Requires care yes (Die Art der Erkrankung macht die Betreuung und Beaufsichtigung notwendig... ja) checkbox
+- `REQUIRES_CARE_NO`:
+   (Form 21a) Requires care no (Die Art der Erkrankung macht die Betreuung und Beaufsichtigung notwendig... nein) checkbox
+- `ACCIDENT_YES`:
+   (Form 21a) Accident yes (Unfall... ja) checkbox
+- `ACCIDENT_NO`:
+   (Form 21a) Accident no (Unfall... nein) checkbox
+- `OTHER_ACCIDENT`:
+   (Form 1) Other accident (Sonstiger Unfall, Unfallfolgen) checkbox
+- `ENTITLEMENT_TO_CONTINUED_PAYMENT_YES`:
+   (Form 21a) Entitlement to continued payment yes (Anspruch auf Entgeltfortzahlung) checkbox
+- `ENTITLEMENT_TO_CONTINUED_PAYMENT_NO`:
+   (Form 21a) Entitlement to continued payment no (keinen Anspruch auf Entgeltfortzahlung) checkbox
+- `SICK_PAY_WAS_CLAIMED_NO`:
+   (Form 21a) Sick pay was claimed no (Krankengeld aus Anlass einer früheren Erkrankung des umseitig genannten Kindes wurde in diesem Kalenderjahr NICHT bezogen) checkbox
+- `SICK_PAY_WAS_CLAIMED_YES`:
+   (Form 21a) Sick pay was claimed yes (Krankengeld aus Anlass einer früheren Erkrankung des umseitig genannten Kindes wurde in diesem Kalenderjahr bezogen) checkbox
+- `SINGLE_PARENT_NO`:
+   (Form 21a) Single parent no (Ich bin Alleinerziehende(r)... nein) checkbox
+- `SINGLE_PARENT_YES`:
+   (Form 21a) Single parent yes (Ich bin Alleinerziehende(r)... ja) checkbox
+*/
+export type CheckBoxType = "UNKNOWN" | "WORK_ACCIDENT" | "ASSIGNED_TO_ACCIDENT_INSURANCE_DOCTOR" | "INITIAL_CERTIFICATE" | "RENEWED_CERTIFICATE" | "INSURED_PAY_CASE" | "FINAL_CERTIFICATE" | "REQUIRES_CARE_YES" | "REQUIRES_CARE_NO" | "ACCIDENT_YES" | "ACCIDENT_NO" | "OTHER_ACCIDENT" | "ENTITLEMENT_TO_CONTINUED_PAYMENT_YES" | "ENTITLEMENT_TO_CONTINUED_PAYMENT_NO" | "SICK_PAY_WAS_CLAIMED_NO" | "SICK_PAY_WAS_CLAIMED_YES" | "SINGLE_PARENT_NO" | "SINGLE_PARENT_YES";
+/**
+Structure to contain full information about found box
+*/
+export declare class CheckBox extends PartiallyConstructible {
+    /**
+    Box type
+    @defaultValue "UNKNOWN";
+    */
+    readonly type: CheckBoxType;
+    /**
+    True if the box is checked
+    @defaultValue false;
+    */
+    readonly checked: boolean;
+    /**
+    Confidence of the checked/unchecked prediction
+    @defaultValue 0.0;
+    */
+    readonly checkedConfidence: number;
+    /**
+    Points of the box
+    */
+    readonly quad: Point[];
+    /** @param source {@displayType `DeepPartial<CheckBox>`} */
+    constructor(source?: DeepPartial<CheckBox>);
+}
+/**
+Type of a date record
+
+- `INCAPABLE_OF_WORK_SINCE`:
+   (Form 1) Incapable of work since (arbeitsunfähig seit) date
+- `INCAPABLE_OF_WORK_UNTIL`:
+   (Form 1) Incapable of work until (voraussichtlich arbeitsunfähig bis einschließlich oder letzter Tag der Arbeitsunfähigkeit) date
+- `DIAGNOSED_ON`:
+   (Form 1) Diagnosed on (festgestellt am) date
+- `DOCUMENT_DATE`:
+   Document date
+- `BIRTH_DATE`:
+   Birthdate (geb. am)
+- `CHILD_NEEDS_CARE_FROM`:
+   (Form 21a) Child needs care from (Das genannte Kind bedarf/bedurfte vom) date
+- `CHILD_NEEDS_CARE_UNTIL`:
+   (Form 21a) Child needs care until (Das genannte Kind bedarf/bedurfte bis einschließlich) date
+- `UNDEFINED`:
+   Undefined date type
+*/
+export type DateRecordType = "INCAPABLE_OF_WORK_SINCE" | "INCAPABLE_OF_WORK_UNTIL" | "DIAGNOSED_ON" | "DOCUMENT_DATE" | "BIRTH_DATE" | "CHILD_NEEDS_CARE_FROM" | "CHILD_NEEDS_CARE_UNTIL" | "UNDEFINED";
+/**
+Structure to contain date record information
+*/
+export declare class DateRecord extends PartiallyConstructible {
+    /**
+    Date box
+    */
+    readonly quad: Point[];
+    /**
+    Validated date string
+    @defaultValue "";
+    */
+    readonly value: string;
+    /**
+    Raw date string
+    @defaultValue "";
+    */
+    readonly rawString: string;
+    /**
+    Date type
+    @defaultValue "UNDEFINED";
+    */
+    readonly type: DateRecordType;
+    /**
+    Confidence in the recognized value
+    @defaultValue 0.0;
+    */
+    readonly recognitionConfidence: number;
+    /** @param source {@displayType `DeepPartial<DateRecord>`} */
+    constructor(source?: DeepPartial<DateRecord>);
+}
+/**
+Type of a field in the patient info box
+
+- `INSURANCE_PROVIDER`:
+   Insurance provider (Krankenkasse bzw. Kostenträger)
+- `FIRST_NAME`:
+   First name (Vorname des Versicherten)
+- `LAST_NAME`:
+   Last name (Name des Versicherten)
+- `ADDRESS_STRING1`:
+   First line of address
+- `ADDRESS_STRING2`:
+   Second line of address
+- `DIAGNOSE`:
+   Diagnose
+- `HEALTH_INSURANCE_NUMBER`:
+   Number of the health insurance provider (Kostenträgerkennung)
+- `INSURED_PERSON_NUMBER`:
+   Personal number of the insured person (Versicherten-Nr.)
+- `STATUS`:
+   Status
+- `PLACE_OF_OPERATION_NUMBER`:
+   Number of the place of operation (Betriebsstätten-Nr.)
+- `DOCTOR_NUMBER`:
+   Number of the doctor (Arzt-Nr.)
+- `UNDEFINED`:
+   Undefined
+*/
+export type PatientInfoFieldType = "INSURANCE_PROVIDER" | "FIRST_NAME" | "LAST_NAME" | "ADDRESS_STRING1" | "ADDRESS_STRING2" | "DIAGNOSE" | "HEALTH_INSURANCE_NUMBER" | "INSURED_PERSON_NUMBER" | "STATUS" | "PLACE_OF_OPERATION_NUMBER" | "DOCTOR_NUMBER" | "UNDEFINED";
+/**
+Patient information field
+*/
+export declare class PatientInfoField extends PartiallyConstructible {
+    /**
+    Field type
+    */
+    readonly type: PatientInfoFieldType;
+    /**
+    Field value
+    */
+    readonly value: string;
+    /**
+    Confidence in the recognized value
+    */
+    readonly recognitionConfidence: number;
+    /** @param source {@displayType `DeepPartial<PatientInfoField>`} */
+    constructor(source?: DeepPartial<PatientInfoField>);
+}
+/**
+Patient information box
+*/
+export declare class PatientInfoBox extends PartiallyConstructible {
+    /**
+    Four corners of the patient info box
+    */
+    readonly quad: Point[];
+    /**
+    Vector of found fields
+    */
+    readonly fields: PatientInfoField[];
+    /**
+    Whether the patient info box has contents
+    @defaultValue false;
+    */
+    readonly hasContents: boolean;
+    /** @param source {@displayType `DeepPartial<PatientInfoBox>`} */
+    constructor(source?: DeepPartial<PatientInfoBox>);
+}
+/**
+Type of the medical certificate form
+
+- `UNKNOWN`:
+   Unknown form type
+- `FORM_1A`:
+   Form 1A
+- `FORM_1B`:
+   Form 1B
+- `FORM_1C`:
+   Form 1C
+- `FORM_1D`:
+   Form 1D
+- `FORM_21A`:
+   Form 21A
+- `FORM_21A_BACK`:
+   Form 21A back
+- `FORM_1B_CUSTOM`:
+   Form 1B custom
+*/
+export type FormType = "UNKNOWN" | "FORM_1A" | "FORM_1B" | "FORM_1C" | "FORM_1D" | "FORM_21A" | "FORM_21A_BACK" | "FORM_1B_CUSTOM";
+/**
+The result of the medical certificate recognition
+*/
+export declare class RecognitionResult extends PartiallyConstructible {
+    /**
+    True if recognition was successful
+    @defaultValue false;
+    */
+    readonly recognitionSuccessful: boolean;
+    /**
+    Patient info box
+    */
+    readonly patientInfoBox: PatientInfoBox;
+    /**
+    Found checkboxes
+    */
+    readonly checkBoxes: CheckBox[];
+    /**
+    Found dates
+    */
+    readonly dates: DateRecord[];
+    /**
+    Form type
+    @defaultValue "UNKNOWN";
+    */
+    readonly formType: FormType;
+    /**
+    The number of 90-degree clockwise rotations that were applied to the original image.
+    The same number of counter-clockwise rotations are necessary to make the image upright again.
+    @defaultValue 0;
+    */
+    readonly clockwiseRotations: number;
+    /**
+    The cropped image used for recognition
+    @defaultValue null;
+    */
+    readonly croppedImage: RawImage | null;
+    /**
+    The scale factor used to scale the image to the recognition size
+    @defaultValue 1.0;
+    */
+    readonly scaleX: number;
+    /**
+    The scale factor used to scale the image to the recognition size
+    @defaultValue 1.0;
+    */
+    readonly scaleY: number;
+    /**
+    The region of interest of the document in the original image
+    */
+    readonly documentRoi: DetectionResult;
+    /** @param source {@displayType `DeepPartial<RecognitionResult>`} */
+    constructor(source?: DeepPartial<RecognitionResult>);
+}