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

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

@@ -0,0 +1,183 @@
+import { BarcodeConfig } from "./BarcodeConfigs";
+import { BarcodeFormat } from "./BarcodeTypes";
+import { DeepPartial, PartiallyConstructible } from "../common";
+import { GenericDocument } from "./GenericDocument";
+import { Point } from "../common";
+import { RawImage } from "../common";
+/**
+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 {
+    /**
+    Text contained in the barcode. Binary data is returned in the rawBytes field only.
+    */
+    readonly text: string;
+    /**
+    Barcode format
+    @defaultValue "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.
+    */
+    readonly quad: Point[];
+    /**
+    True if this is a 1D barcode that is printed upside-down, that is, the barcode was scanned right-to-left.
+    @defaultValue false;
+    */
+    readonly isUpsideDown: boolean;
+    /**
+    A crop from the input image containing the barcode.
+    @defaultValue null;
+    */
+    readonly sourceImage: RawImage | null;
+    /**
+    Raw bytes of barcode contents. Some formats can contain binary data, which is returned in this field.
+    */
+    readonly rawBytes: Uint8Array;
+    /**
+    If this is a UPC/EAN barcode that has an EAN-2 or EAN-5 extension, this field contains the extension value. Requires the UPC_EAN_EXTENSION format to be enabled in the decoding options.
+    */
+    readonly upcEanExtension: string;
+    /**
+    True if the barcode contains a GS1 message. Requires GS1 handling to be enabled in the decoding option.
+    @defaultValue false;
+    */
+    readonly isGS1Message: boolean;
+    /**
+    True if this result is the 2D part of a GS1 Composite barcode.
+    Can only happen if GS1_COMPOSITE scanning is disabled and a part of the composite (1D) or (2D) is scanned separately.
+    When GS1_COMPOSITE scanning is enabled, parts of the composite barcode are never returned separately, even if their respective
+    format is enabled in the decoding options.
+    @defaultValue false;
+    */
+    readonly isGS1CompositePart: boolean;
+    /**
+    The number of 1D stacks in the barcode. Applies only to DATABAR and DATABAR_EXPANDED barcodes.
+    @defaultValue 1;
+    */
+    readonly dataBarStackSize: number;
+    /**
+    The parsed known document format (if parsed successfully).
+    */
+    readonly parsedDocument: GenericDocument | null;
+    /** @param source {@displayType `DeepPartial<BarcodeItem>`} */
+    constructor(source?: DeepPartial<BarcodeItem>);
+}
+/**
+The engine mode for barcode scanning
+
+- `LEGACY`:
+   Legacy mode. Very fast, significantly less accurate. Doesn't support all barcode types
+- `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.
+- `NEXT_GEN_AR`:
+   Similar to NEXT_GEN, but optimized for AR.
+*/
+export type EngineMode = "LEGACY" | "NEXT_GEN_LOW_POWER" | "NEXT_GEN" | "NEXT_GEN_AR";
+/**
+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
+*/
+export type BarcodeDocumentFormat = "AAMVA" | "BOARDING_PASS" | "DE_MEDICAL_PLAN" | "MEDICAL_CERTIFICATE" | "ID_CARD_PDF_417" | "SEPA" | "SWISS_QR" | "VCARD" | "GS1" | "HIBC";
+/**
+Barcode document formats
+*/
+export declare class BarcodeDocumentFormats extends PartiallyConstructible {
+    /** @param source {@displayType `DeepPartial<BarcodeDocumentFormats>`} */
+    constructor(source?: DeepPartial<BarcodeDocumentFormats>);
+}
+export declare namespace BarcodeDocumentFormats {
+    /**
+    All barcode document formats
+    @defaultValue ["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
+    */
+    const all: BarcodeDocumentFormat[];
+    /**
+    Barcode types that are used to encode documents
+    @defaultValue {
+        "AAMVA": ["PDF_417"],
+        "ID_CARD_PDF_417": ["PDF_417"],
+        "SEPA": ["QR_CODE"],
+        "MEDICAL_CERTIFICATE": ["PDF_417"],
+        "DE_MEDICAL_PLAN": ["DATA_MATRIX"],
+        "BOARDING_PASS": ["PDF_417", "AZTEC"],
+        "VCARD": ["QR_CODE"],
+        "SWISS_QR": ["QR_CODE"],
+        "GS1": ["CODE_128", "AZTEC", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "GS1_COMPOSITE", "ITF", "MICRO_PDF_417", "PDF_417", "QR_CODE", "UPC_A", "UPC_E"],
+        "HIBC": ["CODE_39", "CODE_128", "AZTEC", "DATA_MATRIX", "MICRO_PDF_417", "PDF_417", "QR_CODE"]
+    };
+    */
+    const documentBarcodeFormats: {
+        [key in BarcodeDocumentFormat]: BarcodeFormat[];
+    };
+}
+/**
+Parameters for barcode recognition
+*/
+export declare class BarcodeRecognizerParameters extends PartiallyConstructible {
+    /**
+    Options for barcode decoding
+    @defaultValue [new GroupCommonConfig({})];
+    */
+    configurators: BarcodeConfig[];
+    /**
+    The engine mode for barcode scanning
+    @defaultValue "NEXT_GEN";
+    */
+    engineMode: EngineMode;
+    /**
+    If true, the barcode recognition will be performed in live mode
+    @defaultValue true;
+    */
+    live: boolean;
+    /**
+    List of accepted barcode document formats.
+    @defaultValue ["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
+    */
+    acceptedDocumentFormats: BarcodeDocumentFormat[];
+    /**
+    If true, the barcode image will be returned in the BarcodeItem
+    @defaultValue true;
+    */
+    returnBarcodeImage: boolean;
+    /** @param source {@displayType `DeepPartial<BarcodeRecognizerParameters>`} */
+    constructor(source?: DeepPartial<BarcodeRecognizerParameters>);
+}
+/**
+The result of barcode scanning
+*/
+export declare class BarcodeScannerResult extends PartiallyConstructible {
+    /**
+    List of found barcodes
+    */
+    readonly barcodes: BarcodeItem[];
+    /**
+    True if any barcodes were found
+    */
+    readonly success: boolean;
+    /** @param source {@displayType `DeepPartial<BarcodeScannerResult>`} */
+    constructor(source?: DeepPartial<BarcodeScannerResult>);
+}

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

@@ -0,0 +1,183 @@
+import { DeepPartial, PartiallyConstructible } from "../common";
+/**
+Enumerates barcode formats.
+
+- `NONE`:
+   Used as a return value if no valid barcode has been detected
+- `AZTEC`:
+   Aztec (2D)
+- `CODABAR`:
+   CODABAR (1D)
+- `CODE_39`:
+   Code 39 (1D)
+- `CODE_93`:
+   Code 93 (1D)
+- `CODE_128`:
+   Code 128 (1D)
+- `DATA_MATRIX`:
+   Data Matrix (2D)
+- `EAN_8`:
+   EAN-8 (1D)
+- `EAN_13`:
+   EAN-13 (1D)
+- `ITF`:
+   ITF (Interleaved Two of Five) (1D)
+- `MAXICODE`:
+   MaxiCode (2D)
+- `PDF_417`:
+   PDF417 (2D)
+- `QR_CODE`:
+   QR Code (2D)
+- `DATABAR`:
+   GS1 DataBar-14 (formerly RSS-14) (1D)
+- `DATABAR_EXPANDED`:
+   GS1 DataBar Expanded (formerly RSS Expanded) (1D)
+- `UPC_A`:
+   UPC-A (1D)
+- `UPC_E`:
+   UPC-E (1D)
+- `MSI_PLESSEY`:
+   MSI PLESSEY
+- `IATA_2_OF_5`:
+   IATA 2 of 5 (1D)
+- `INDUSTRIAL_2_OF_5`:
+   INDUSTRIAL 2 of 5 (1D)
+- `CODE_25`:
+   CODE 25 (1D)
+- `MICRO_QR_CODE`:
+   Micro QR Code (2D)
+- `USPS_INTELLIGENT_MAIL`:
+   USPS Intelligent Mail, a.k.a. USPS OneCode, USPS-STD-11
+- `ROYAL_MAIL`:
+   Royal Mail Four-State Customer Code, a.k.a. RM4SCC, CBC, BPO 4 State Code
+- `JAPAN_POST`:
+   Japan Post Four-State Barcode
+- `ROYAL_TNT_POST`:
+   Royal TNT Post Four-State Barcode, a.k.a. KIX, Klant IndeX
+- `AUSTRALIA_POST`:
+   Australia Post Four-State Customer Code
+- `DATABAR_LIMITED`:
+   GS1 DataBar Limited
+- `MICRO_PDF_417`:
+   Micro PDF417 (2D)
+- `GS1_COMPOSITE`:
+   GS1 COMPOSITE (combined linear and 2D).
+- `RMQR_CODE`:
+   Rectangular Micro QR Code (2D)
+- `CODE_11`:
+   Code 11 (1D)
+- `CODE_32`:
+   Code 32 (Italian Pharmacode) (1D)
+- `PHARMA_CODE`:
+   Pharmacode, a.k.a. One-Track Pharmacode, Pharmaceutical Binary Code (1D)
+- `PHARMA_CODE_TWO_TRACK`:
+   Two-Track Pharmacode, a.k.a. Pharmaceutical Binary Code
+- `PZN`:
+   Pharmazentralnummer, a.k.a. PZN, PZN8, German Pharmaceutical Central Number (1D)
+*/
+export type BarcodeFormat = "NONE" | "AZTEC" | "CODABAR" | "CODE_39" | "CODE_93" | "CODE_128" | "DATA_MATRIX" | "EAN_8" | "EAN_13" | "ITF" | "MAXICODE" | "PDF_417" | "QR_CODE" | "DATABAR" | "DATABAR_EXPANDED" | "UPC_A" | "UPC_E" | "MSI_PLESSEY" | "IATA_2_OF_5" | "INDUSTRIAL_2_OF_5" | "CODE_25" | "MICRO_QR_CODE" | "USPS_INTELLIGENT_MAIL" | "ROYAL_MAIL" | "JAPAN_POST" | "ROYAL_TNT_POST" | "AUSTRALIA_POST" | "DATABAR_LIMITED" | "MICRO_PDF_417" | "GS1_COMPOSITE" | "RMQR_CODE" | "CODE_11" | "CODE_32" | "PHARMA_CODE" | "PHARMA_CODE_TWO_TRACK" | "PZN";
+/**
+Lists of barcode formats to decode
+*/
+export declare class BarcodeFormats extends PartiallyConstructible {
+    /** @param source {@displayType `DeepPartial<BarcodeFormats>`} */
+    constructor(source?: DeepPartial<BarcodeFormats>);
+}
+export declare namespace BarcodeFormats {
+    /**
+    List of 1D barcode formats
+    @defaultValue ["CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_8", "EAN_13", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "MSI_PLESSEY", "PHARMA_CODE", "PZN", "UPC_A", "UPC_E"];
+    */
+    const oned: BarcodeFormat[];
+    /**
+    List of 2D barcode formats
+    @defaultValue ["AZTEC", "DATA_MATRIX", "MAXICODE", "MICRO_QR_CODE", "MICRO_PDF_417", "PDF_417", "QR_CODE", "RMQR_CODE"];
+    */
+    const twod: BarcodeFormat[];
+    /**
+    List of postal barcode formats
+    @defaultValue ["AUSTRALIA_POST", "JAPAN_POST", "ROYAL_MAIL", "ROYAL_TNT_POST", "USPS_INTELLIGENT_MAIL"];
+    */
+    const postal: BarcodeFormat[];
+    /**
+    List of pharmaceutical barcode formats
+    @defaultValue ["CODE_32", "PHARMA_CODE", "PHARMA_CODE_TWO_TRACK", "PZN"];
+    */
+    const pharma: BarcodeFormat[];
+    /**
+    List of common barcode formats
+    @defaultValue ["AZTEC", "CODABAR", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "ITF", "MICRO_QR_CODE", "PDF_417", "QR_CODE", "UPC_A", "UPC_E"];
+    */
+    const common: BarcodeFormat[];
+    /**
+    List of all barcode formats
+    @defaultValue ["AUSTRALIA_POST", "AZTEC", "CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "GS1_COMPOSITE", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "JAPAN_POST", "MAXICODE", "MICRO_PDF_417", "MICRO_QR_CODE", "MSI_PLESSEY", "PDF_417", "PHARMA_CODE", "PHARMA_CODE_TWO_TRACK", "PZN", "QR_CODE", "RMQR_CODE", "ROYAL_MAIL", "ROYAL_TNT_POST", "UPC_A", "UPC_E", "USPS_INTELLIGENT_MAIL"];
+    */
+    const all: BarcodeFormat[];
+}
+/**
+GS1 message handling options.
+The GS1 standard defines a a key-value format for business-centric data that can be encoded into many 1D and 2D barcode types.
+https://ref.gs1.org/standards/genspecs/
+
+GS1 messages have two representations or formats: a human-readable format and a
+machine-readable format. The human-readable format uses parentheses to wrap the keys in each
+pair. For example, the string "(01)012345678901(37)02(3922)00278" contains three AI keys:
+01, 37, and 3922. The corresponding values are 012345678901, 02, and 00278.
+
+The machine-readable format uses the special ASCII \x1D character to terminate key-value
+pairs in the string in cases where the given key implies that the value is variable-length.
+The equivalent machine-readable string for the above example is
+"010123456789013702\x1D392200278".
+In the above example, the 01 AI key is fixed-length, so the \x1D character is not necessary.
+The 37 AI keys is variable-length, so the \x1D character is necessary after the value in the
+pair. The 3922 AI key is also variable-length, but it is the last pair in the message, so
+the \x1D character is not necessary at the end.
+
+The character \x1D is UNPRINTABLE - this means that if you try to print or otherwise
+visualize a GS1 message containing the \x1D character, you may see a number of different
+results, depending on how the system handles unprintable characters. You may see a question
+mark, a box, an escape sequence, a space or nothing at all.
+
+
+- `NONE`:
+   The (FNC1) character is simply stripped from the result in barcodes that implement this
+   mode.
+   Do not use. Will be removed in a future release.
+- `PARSE`:
+   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.
+- `VALIDATE_STRUCTURE`:
+   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.
+- `DECODE_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.
+- `VALIDATE_FULL`:
+   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.
+- `DECODE_FULL`:
+   Combines the validations of VALIDATE_FULL and the human-readable output format of DECODE_STRUCTURE.
+*/
+export type GS1Handling = "NONE" | "PARSE" | "VALIDATE_STRUCTURE" | "DECODE_STRUCTURE" | "VALIDATE_FULL" | "DECODE_FULL";
+/**
+Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
+
+- `Require2`:
+   Only barcodes with a 2-digit extension are accepted.
+- `Require5`:
+   Only barcodes with a 5-digit extension are accepted.
+- `RequireAny`:
+   Only barcodes with either a 2-digit or a 5-digit extension are accepted.
+- `Ignore`:
+   Always ignore the extension.
+- `Allow2`:
+   Return detected 2-digit extension if present, but do not require it. Ignore the 5-digit extension.
+- `Allow5`:
+   Return detected 5-digit extension if present, but do not require it. Ignore the 2-digit extension.
+- `AllowAny`:
+   Return any detected extension if present, but do not require it.
+*/
+export type UpcEanExtensionBehavior = "Require2" | "Require5" | "RequireAny" | "Ignore" | "Allow2" | "Allow5" | "AllowAny";

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

@@ -0,0 +1,29 @@
+import { DeepPartial, PartiallyConstructible } from "../common";
+import { GenericDocument } from "./GenericDocument";
+/**
+Check Recognizer Status
+
+- `SUCCESS`:
+   Recognition successful
+- `VALIDATION_FAILED`:
+   A check was recognized, but validation failed, indication a standard violation, unsupported standard, or recognition error
+- `FAIL`:
+   No check was recognized
+*/
+export type RecognitionStatus = "SUCCESS" | "VALIDATION_FAILED" | "FAIL";
+/**
+The result of check recognition
+*/
+export declare class RecognitionResult extends PartiallyConstructible {
+    /**
+    Check recognizer status
+    @defaultValue "FAIL";
+    */
+    readonly status: RecognitionStatus;
+    /**
+    Generic document containing check data. Not present, if status is FAIL.
+    */
+    readonly check: GenericDocument | null;
+    /** @param source {@displayType `DeepPartial<RecognitionResult>`} */
+    constructor(source?: DeepPartial<RecognitionResult>);
+}

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

@@ -0,0 +1,59 @@
+/**
+Common field types
+
+- `ID`:
+   Document ID
+- `SURNAME`:
+   Person surname field
+- `MAIDEN_NAME`:
+   Person maiden name field
+- `GIVEN_NAMES`:
+   Person given names field
+- `BIRTH_DATE`:
+   Person birth date field
+- `NATIONALITY`:
+   Person nationality field
+- `BIRTHPLACE`:
+   Person birthplace field
+- `EXPIRY_DATE`:
+   Document expiry date field
+- `EYE_COLOR`:
+   Person height field
+- `HEIGHT`:
+   Person height field
+- `ISSUE_DATE`:
+   Document issue date field
+- `ISSUING_AUTHORITY`:
+   Document issuing authority field
+- `ADDRESS`:
+   Address field
+- `PSEUDONYM`:
+   Pseudonym field
+- `MRZ`:
+   MRZ field
+- `COUNTRY_CODE`:
+   Country code (ISO-3166 Alpha-3) field
+- `GENDER`:
+   Gender field
+- `SIGNATURE`:
+   Signature field
+- `PHOTO`:
+   Photo field
+- `VALID_FROM_DATE`:
+   Date of start of validity field
+- `ROUTING_NUMBER`:
+   Check routing number
+- `ACCOUNT_NUMBER`:
+   Check account number
+- `PLACE_OF_ISSUE`:
+   Place of issue for the identity card
+- `TITLE_TYPE`:
+   Type of the title field in the identity document
+- `REMARKS`:
+   Remarks field in the identity document
+- `NAME`:
+   Full name field
+- `CARD_ACCESS_NUMBER`:
+   Card access number field
+*/
+export type CommonFieldType = "ID" | "SURNAME" | "MAIDEN_NAME" | "GIVEN_NAMES" | "BIRTH_DATE" | "NATIONALITY" | "BIRTHPLACE" | "EXPIRY_DATE" | "EYE_COLOR" | "HEIGHT" | "ISSUE_DATE" | "ISSUING_AUTHORITY" | "ADDRESS" | "PSEUDONYM" | "MRZ" | "COUNTRY_CODE" | "GENDER" | "SIGNATURE" | "PHOTO" | "VALID_FROM_DATE" | "ROUTING_NUMBER" | "ACCOUNT_NUMBER" | "PLACE_OF_ISSUE" | "TITLE_TYPE" | "REMARKS" | "NAME" | "CARD_ACCESS_NUMBER";

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

@@ -0,0 +1,196 @@
+import { AspectRatio } from "./Geometry";
+import { DeepPartial, PartiallyConstructible } from "../common";
+import { LineSegmentFloat } from "./Geometry";
+import { LineSegmentInt } from "./Geometry";
+import { Point } from "../common";
+import { Rectangle } from "../common";
+/**
+Engines for document detection
+
+- `ML`:
+   Use the ML document detector
+- `LEGACY`:
+   Use the legacy edge-based document detector
+*/
+export type EngineMode = "ML" | "LEGACY";
+/**
+Parameters for the document detector
+*/
+export declare class DetectionParameters extends PartiallyConstructible {
+    /**
+    The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document.
+    Set lower values to accept more perspective distortion.
+    
+    Warning: Lower values result in more blurred document images.
+    @defaultValue 75.0;
+    */
+    acceptedAngleScore: number;
+    /**
+    The minimum size in percent (0 - 100) of the screen size to accept a detected document.
+    It is sufficient that height or width match the score.
+    
+    Warning: Lower values result in low resolution document images.
+    @defaultValue 80.0;
+    */
+    acceptedSizeScore: number;
+    /**
+    The minimum brightness value (0-255) to accept a detected document.
+    @defaultValue 0;
+    */
+    acceptedBrightnessThreshold: number;
+    /**
+    The required aspect ratios for the detected document.
+    A document matches if its aspect ratio matches any of the given aspect ratios.
+    If empty, no aspect ratio is required.
+    @defaultValue [];
+    */
+    requiredAspectRatios: AspectRatio[];
+    /**
+    The rectangle of interest in normalized coordinates.
+    The document detector will only search for documents in this area.
+    If the rectangle is empty, the whole image is used.
+    @defaultValue {
+        "x": 0,
+        "y": 0,
+        "width": 0,
+        "height": 0
+    };
+    */
+    rectangleOfInterest: Rectangle;
+    /** @param source {@displayType `DeepPartial<DetectionParameters>`} */
+    constructor(source?: DeepPartial<DetectionParameters>);
+}
+/**
+Configuration for the document detector
+*/
+export declare class DetectorConfiguration extends PartiallyConstructible {
+    /**
+    The engine to use for document detection
+    @defaultValue "ML";
+    */
+    engineMode: EngineMode;
+    /**
+    Initial parameters for the document detector
+    @defaultValue new DetectionParameters({});
+    */
+    parameters: DetectionParameters;
+    /** @param source {@displayType `DeepPartial<DetectorConfiguration>`} */
+    constructor(source?: DeepPartial<DetectorConfiguration>);
+}
+/**
+Status of the document contour detection
+
+- `NOT_ACQUIRED`:
+   Detection has not yet happened
+- `OK`:
+   An acceptable polygon was detected
+- `OK_SMALL_SIZE`:
+   A polygon was detected, but it has too much perspective distortion
+- `OK_BAD_ANGLES`:
+   A polygon was detected, but its aspect ratio should be landscape/portrait but is portrait/landscape
+- `OK_BAD_ASPECT_RATIO`:
+   A polygon was detected, but its aspect ratio is not within the expected range
+- `OK_OFF_CENTER`:
+   A polygon was detected, but its center is too far away from the image center.
+- `ERROR_NOTHING_DETECTED`:
+   No polygon was detected
+- `ERROR_TOO_DARK`:
+   The image is too dark
+- `ERROR_NOISE`:
+   The image is too noisy (background)
+*/
+export type DetectionStatus = "NOT_ACQUIRED" | "OK" | "OK_SMALL_SIZE" | "OK_BAD_ANGLES" | "OK_BAD_ASPECT_RATIO" | "OK_OFF_CENTER" | "ERROR_NOTHING_DETECTED" | "ERROR_TOO_DARK" | "ERROR_NOISE";
+/**
+The total and partial scores for the detected document contour
+*/
+export declare class DetectionScores extends PartiallyConstructible {
+    /**
+    Weighted sum of all partial scores
+    */
+    readonly totalScore: number;
+    /**
+    100 points, if the center of the contour is exactly in the image center
+    */
+    readonly distanceScore: number;
+    /**
+    100 points, if all angles are 90 degrees
+    */
+    readonly angleScore: number;
+    /**
+    100 points if the contour occupies at least 50% of the area of the image
+    */
+    readonly sizeScore: number;
+    /**
+    100 points, if the aspect ratio matches exactly one of the given aspect ratios
+    */
+    readonly aspectRatioScore: number;
+    /**
+    Percentage of the document contour that the edge detector was able to find (in LEGACY engine mode only)
+    */
+    readonly lineCoverageScore: number;
+    /**
+    Percentage of the image width taken by the detected document
+    */
+    readonly widthScore: number;
+    /**
+    Percentage of the image height taken by the detected document
+    */
+    readonly heightScore: number;
+    /** @param source {@displayType `DeepPartial<DetectionScores>`} */
+    constructor(source?: DeepPartial<DetectionScores>);
+}
+/**
+Result of the document contour detection
+*/
+export declare class DetectionResult extends PartiallyConstructible {
+    /**
+    Detection status
+    @defaultValue "NOT_ACQUIRED";
+    */
+    readonly status: DetectionStatus;
+    /**
+    The total and partial scores for the detected quad
+    */
+    readonly detectionScores: DetectionScores;
+    /**
+    Absolute coordinates of the detected document contour in image space
+    sorted in clockwise order, starting from the top left corner
+    */
+    readonly points: Point[];
+    /**
+    All detected horizontal lines in image space
+    */
+    readonly horizontalLines: LineSegmentInt[];
+    /**
+    All detected vertical lines in image space
+    */
+    readonly verticalLines: LineSegmentInt[];
+    /**
+    Normalized coordinates of the detected document contour in image space
+    sorted in clockwise order, starting from the top left corner
+    */
+    readonly pointsNormalized: Point[];
+    /**
+    Normalized horizontal lines in image space
+    */
+    readonly horizontalLinesNormalized: LineSegmentFloat[];
+    /**
+    Normalized vertical lines in image space
+    */
+    readonly verticalLinesNormalized: LineSegmentFloat[];
+    /**
+    Aspect ratio of the detected document contour
+    */
+    readonly aspectRatio: number;
+    /**
+    Average brightness, calculated as the average
+    of the Value channel in the HSV color space of:
+    - the whole image, if no document was detected
+    - the document crop, if a document was detected
+    Ranges from 0 to 255
+    @defaultValue 0;
+    */
+    readonly averageBrightness: number;
+    /** @param source {@displayType `DeepPartial<DetectionResult>`} */
+    constructor(source?: DeepPartial<DetectionResult>);
+}