scanbot-web-sdk 8.0.0-rc.8 → 8.0.0

package/@types/core/bridge/worker-bridge.d.ts

@@ -58,6 +58,10 @@ export declare class WorkerBridge {
             jpegQuality?: number;
             resamplingMethod?: import("../compiled/PdfConfigurationTypes").ResamplingMethod;
             binarizationFilter?: ({
+                filterType?: number;
+            } & {
+                readonly _type: "LegacyFilter";
+            }) | ({
                 outputMode?: import("../compiled/ParametricFilters").OutputMode;
             } & {
                 readonly _type: "ScanbotBinarizationFilter";
@@ -68,7 +72,16 @@ export declare class WorkerBridge {
                 preset?: import("../compiled/ParametricFilters").BinarizationFilterPreset;
             } & {
                 readonly _type: "CustomBinarizationFilter";
-            }) | ({} & {
+            }) | ({
+                radius?: number;
+                borderWidthFraction?: number;
+                blackOutliersFraction?: number;
+                whiteOutliersFraction?: number;
+                contrastEnhancement?: number;
+                colorEnhancement?: number;
+                paperWhitening?: number;
+                paperWhiteningBias?: number;
+            } & {
                 readonly _type: "ColorDocumentFilter";
             }) | ({
                 brightness?: number;
@@ -117,6 +130,10 @@ export declare class WorkerBridge {
                 });
             }[];
             binarizationFilter?: ({
+                filterType?: number;
+            } & {
+                readonly _type: "LegacyFilter";
+            }) | ({
                 outputMode?: import("../compiled/ParametricFilters").OutputMode;
             } & {
                 readonly _type: "ScanbotBinarizationFilter";
@@ -127,7 +144,16 @@ export declare class WorkerBridge {
                 preset?: import("../compiled/ParametricFilters").BinarizationFilterPreset;
             } & {
                 readonly _type: "CustomBinarizationFilter";
-            }) | ({} & {
+            }) | ({
+                radius?: number;
+                borderWidthFraction?: number;
+                blackOutliersFraction?: number;
+                whiteOutliersFraction?: number;
+                contrastEnhancement?: number;
+                colorEnhancement?: number;
+                paperWhitening?: number;
+                paperWhiteningBias?: number;
+            } & {
                 readonly _type: "ColorDocumentFilter";
             }) | ({
                 brightness?: number;
@@ -191,6 +217,10 @@ export declare class WorkerBridge {
             jpegQuality?: number;
             resamplingMethod?: import("../compiled/PdfConfigurationTypes").ResamplingMethod;
             binarizationFilter?: ({
+                filterType?: number;
+            } & {
+                readonly _type: "LegacyFilter";
+            }) | ({
                 outputMode?: import("../compiled/ParametricFilters").OutputMode;
             } & {
                 readonly _type: "ScanbotBinarizationFilter";
@@ -201,7 +231,16 @@ export declare class WorkerBridge {
                 preset?: import("../compiled/ParametricFilters").BinarizationFilterPreset;
             } & {
                 readonly _type: "CustomBinarizationFilter";
-            }) | ({} & {
+            }) | ({
+                radius?: number;
+                borderWidthFraction?: number;
+                blackOutliersFraction?: number;
+                whiteOutliersFraction?: number;
+                contrastEnhancement?: number;
+                colorEnhancement?: number;
+                paperWhitening?: number;
+                paperWhiteningBias?: number;
+            } & {
                 readonly _type: "ColorDocumentFilter";
             }) | ({
                 brightness?: number;
@@ -250,6 +289,10 @@ export declare class WorkerBridge {
                 });
             }[];
             binarizationFilter?: ({
+                filterType?: number;
+            } & {
+                readonly _type: "LegacyFilter";
+            }) | ({
                 outputMode?: import("../compiled/ParametricFilters").OutputMode;
             } & {
                 readonly _type: "ScanbotBinarizationFilter";
@@ -260,7 +303,16 @@ export declare class WorkerBridge {
                 preset?: import("../compiled/ParametricFilters").BinarizationFilterPreset;
             } & {
                 readonly _type: "CustomBinarizationFilter";
-            }) | ({} & {
+            }) | ({
+                radius?: number;
+                borderWidthFraction?: number;
+                blackOutliersFraction?: number;
+                whiteOutliersFraction?: number;
+                contrastEnhancement?: number;
+                colorEnhancement?: number;
+                paperWhitening?: number;
+                paperWhiteningBias?: number;
+            } & {
                 readonly _type: "ColorDocumentFilter";
             }) | ({
                 brightness?: number;

package/@types/core/compiled/CheckDocumentModel.d.ts

@@ -27,8 +27,12 @@ export declare class USACheck extends Check {
     requiredDocumentType(): string;
     /** Account number */
     get accountNumber(): Field;
-    /** Auxiliary On-Us */
+    /** Auxiliary On-Us field. For business checks this is often the serial number of the check. */
     get auxiliaryOnUs(): Field | undefined;
+    /** This field is often the check number, though it cannot be guaranteed as it is up to the discretion of the
+issuing bank.
+ */
+    get checkNumber(): Field;
     /** Transit number */
     get transitNumber(): Field;
 }

package/@types/core/compiled/DocumentDataExtractorConfigurationTypes.d.ts

@@ -3,7 +3,7 @@ import { MrzDocumentType } from "./MrzTypes";
 /**
 Base class for all document data extraction configuration elements.
 */
-export type DocumentDataExtractorConfigurationElement = DateValidationConfiguration | DeAddressParserConfiguration | EuropeanHealthInsuranceCardConfiguration | MrzFallbackConfiguration | AutoFocusConfiguration | GlareDetectionConfiguration | DocumentDataExtractorCommonConfiguration;
+export type DocumentDataExtractorConfigurationElement = DateValidationConfiguration | EuropeanHealthInsuranceCardConfiguration | MrzFallbackConfiguration | AutoFocusConfiguration | GlareDetectionConfiguration | DocumentDataExtractorCommonConfiguration;
 /** @internal */
 export declare namespace DocumentDataExtractorConfigurationElement {
     /** @internal */
@@ -34,25 +34,6 @@ export declare class DateValidationConfiguration {
     constructor(source?: DeepPartial<DateValidationConfiguration>);
 }
 /**
-German Address Field validation configuration.
-This configuration does not enable the scanning of any document types by itself.
-Add to recognizer configuration to require German Address validation checks for specific document types.
-*/
-export declare class DeAddressParserConfiguration {
-    readonly _type: "DeAddressParserConfiguration";
-    /**
-    List of generic document formats for which German Address validation has to be applied.
-    */
-    documentTypes: string[];
-    /**
-    binary file with address database.
-    @defaultValue "";
-    */
-    binaryFileAddressDatabase: string;
-    /** @param source {@displayType `DeepPartial<DeAddressParserConfiguration>`} */
-    constructor(source?: DeepPartial<DeAddressParserConfiguration>);
-}
-/**
 European Health Insurance Card (EHIC) issuing country.
 
 - `AUSTRIA`:

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

@@ -68,13 +68,26 @@ export declare const BinarizationFilterPresetValues: ReadonlyArray<BinarizationF
 /**
 Base class for all parametric filters.
 */
-export type ParametricFilter = ScanbotBinarizationFilter | CustomBinarizationFilter | ColorDocumentFilter | BrightnessFilter | ContrastFilter | GrayscaleFilter | WhiteBlackPointFilter;
+export type ParametricFilter = LegacyFilter | ScanbotBinarizationFilter | CustomBinarizationFilter | ColorDocumentFilter | BrightnessFilter | ContrastFilter | GrayscaleFilter | WhiteBlackPointFilter;
 /** @internal */
 export declare namespace ParametricFilter {
     /** @internal */
     function from(source: DeepPartial<ParametricFilter>): ParametricFilter;
 }
 /**
+Deprecated. Returns the input image unchanged.
+*/
+export declare class LegacyFilter {
+    readonly _type: "LegacyFilter";
+    /**
+    Ignored.
+    @defaultValue 0;
+    */
+    filterType: number;
+    /** @param source {@displayType `DeepPartial<LegacyFilter>`} */
+    constructor(source?: DeepPartial<LegacyFilter>);
+}
+/**
 Automatic binarization filter. This filter is a good starting point for most use cases.
 */
 export declare class ScanbotBinarizationFilter {
@@ -125,6 +138,64 @@ Color document filter. This filter is a good starting point for most use cases.
 */
 export declare class ColorDocumentFilter {
     readonly _type: "ColorDocumentFilter";
+    /**
+    Filter radius. The bigger the radius, the slower the filter and generally the less noise in the result.
+    The radius is used for both shadows removal and the calculation of local statistics in the main body of the filter.
+    Higher radius usually allows to cope better with regions of light text on dark background.
+    All the values larger than 127 are clamped to 127.
+    @defaultValue 32;
+    */
+    radius: number;
+    /**
+    Ignore this fraction of pixels at the edge of the image when calculating statistics.
+    Pixels at the edge of the image typically have poor statistics. Ignoring them
+    and using only the inner pixels when calculating certain statistics can
+    substantially improve the quality of the result.
+    The value must be less than 0.5 but usually good values are between 0 and 0.15.
+    @defaultValue 0.06;
+    */
+    borderWidthFraction: number;
+    /**
+    Clip this fraction of the darkest pixels in operations such as autocontrast.
+    Increasing the range of middle gray levels at the expense of the brightest and darkest levels
+    may improve the overall contrast and quality of the result.
+    Sum of blackOutliersFraction and whiteOutliersFraction must be less than 1 but usually
+    good values for the parameters do not exceed 0.05;.
+    @defaultValue 0.0;
+    */
+    blackOutliersFraction: number;
+    /**
+    Clip this fraction of the brightest pixels in operations such as autocontrast.
+    Increasing the range of middle gray levels at the expense of the brightest and darkest levels
+    may improve the overall contrast and quality of the result.
+    Sum of blackOutliersFraction and whiteOutliersFraction must be less than 1 but usually
+    good values for the parameters do not exceed 0.05;.
+    @defaultValue 0.02;
+    */
+    whiteOutliersFraction: number;
+    /**
+    Strength of contrast enhancement. Typical values are between 0 and 1, although higher values are possible.
+    @defaultValue 0.5;
+    */
+    contrastEnhancement: number;
+    /**
+    Strength of color saturation enhancement. Typical values are between 0 and 1, although higher values are possible.
+    @defaultValue 0.5;
+    */
+    colorEnhancement: number;
+    /**
+    Paper whitening strength balances color enhancement and paper color improvement.
+    Only relevant if colorEnhancement is above 0. Typical values are between 0 and 2.
+    @defaultValue 1.0;
+    */
+    paperWhitening: number;
+    /**
+    Paper whitening bias balances between whitening more of the paper of preserving more of the colors.
+    Negative values will preserve more colors, positive values will whiten more of the paper.
+    Only relevant if colorEnhancement is above 0. Typical values are between -25 and 25.
+    @defaultValue 0;
+    */
+    paperWhiteningBias: number;
     /** @param source {@displayType `DeepPartial<ColorDocumentFilter>`} */
     constructor(source?: DeepPartial<ColorDocumentFilter>);
 }

package/@types/scanbot-sdk.d.ts

@@ -121,6 +121,10 @@ export default class ScanbotSDK {
             jpegQuality?: number;
             resamplingMethod?: Config.ResamplingMethod;
             binarizationFilter?: ({
+                filterType?: number;
+            } & {
+                readonly _type: "LegacyFilter";
+            }) | ({
                 outputMode?: Config.OutputMode;
             } & {
                 readonly _type: "ScanbotBinarizationFilter";
@@ -131,7 +135,16 @@ export default class ScanbotSDK {
                 preset?: Config.BinarizationFilterPreset;
             } & {
                 readonly _type: "CustomBinarizationFilter";
-            }) | ({} & {
+            }) | ({
+                radius?: number;
+                borderWidthFraction?: number;
+                blackOutliersFraction?: number;
+                whiteOutliersFraction?: number;
+                contrastEnhancement?: number;
+                colorEnhancement?: number;
+                paperWhitening?: number;
+                paperWhiteningBias?: number;
+            } & {
                 readonly _type: "ColorDocumentFilter";
             }) | ({
                 brightness?: number;
@@ -180,6 +193,10 @@ export default class ScanbotSDK {
                 });
             }[];
             binarizationFilter?: ({
+                filterType?: number;
+            } & {
+                readonly _type: "LegacyFilter";
+            }) | ({
                 outputMode?: Config.OutputMode;
             } & {
                 readonly _type: "ScanbotBinarizationFilter";
@@ -190,7 +207,16 @@ export default class ScanbotSDK {
                 preset?: Config.BinarizationFilterPreset;
             } & {
                 readonly _type: "CustomBinarizationFilter";
-            }) | ({} & {
+            }) | ({
+                radius?: number;
+                borderWidthFraction?: number;
+                blackOutliersFraction?: number;
+                whiteOutliersFraction?: number;
+                contrastEnhancement?: number;
+                colorEnhancement?: number;
+                paperWhitening?: number;
+                paperWhiteningBias?: number;
+            } & {
                 readonly _type: "ColorDocumentFilter";
             }) | ({
                 brightness?: number;

package/@types/ui2/barcode/views/action-button/action-button.d.ts

@@ -10,4 +10,5 @@ export declare class Props extends RoundButton {
 }
 export declare const ACTION_BUTTON_HEIGHT = 48;
 export declare const ACTION_BUTTON_PADDING = 16;
+export declare const ACTION_BUTTON_BAR_HEIGHT: number;
 export default function ActionButton(props: Props): React.JSX.Element;

package/@types/ui2/configuration/DocumentDataExtractorConfigurationTypes.d.ts

@@ -1 +1 @@
-export type { AutoFocusConfiguration, DateValidationConfiguration, DeAddressParserConfiguration, DocumentDataExtractorCommonConfiguration, DocumentDataExtractorConfigurationElement, EuropeanHealthInsuranceCardConfiguration, EuropeanHealthInsuranceCardIssuingCountryValues, EuropeanHealthInsuranceCardIssuingCountry, GlareDetectionConfiguration, MrzFallbackConfiguration, } from "../../core-types";
+export type { AutoFocusConfiguration, DateValidationConfiguration, DocumentDataExtractorCommonConfiguration, DocumentDataExtractorConfigurationElement, EuropeanHealthInsuranceCardConfiguration, EuropeanHealthInsuranceCardIssuingCountryValues, EuropeanHealthInsuranceCardIssuingCountry, GlareDetectionConfiguration, MrzFallbackConfiguration, } from "../../core-types";

package/@types/ui2/configuration/common/CameraConfiguration.d.ts

@@ -1,5 +1,5 @@
 import type { DeepPartial } from "../utils";
-import { AnalyzerFrameResolution } from "../sdk/Camera";
+import { CameraLiveScannerResolution } from "../sdk/Camera";
 /**
 The ideal resolution of the camera preview.
 */
@@ -72,10 +72,10 @@ export declare class CameraConfiguration {
       */
     fpsLimit: number;
     /**
-      The size of the image from camera which would be sent to the scanner for analysis.
+      The size of the image from camera which would be sent to the scanner for live scanning.
       @defaultValue "FULL_HD";
       */
-    analyzerFrameResolution: AnalyzerFrameResolution;
+    cameraLiveScannerResolution: CameraLiveScannerResolution;
     /** @param source {@displayType `DeepPartial<CameraConfiguration>`} */
     constructor(source?: DeepPartial<CameraConfiguration>);
 }

package/@types/ui2/configuration/document/CameraScreenConfiguration.d.ts

@@ -549,7 +549,7 @@ export declare class CameraScreenConfiguration {
       */
     backgroundColor: string;
     /**
-      If set to true, images imported from the gallery/photo library will be analyzed and eventually rotated to correct their orientation.
+      If set to true, images captured by the camera or imported from the gallery or photo library will be analyzed and automatically rotated to correct their orientation.
       @defaultValue true;
       */
     autoRotateImages: boolean;

package/@types/ui2/configuration/document/DocumentScannerCameraConfiguration.d.ts

@@ -1,5 +1,5 @@
 import type { DeepPartial } from "../utils";
-import { AnalyzerFrameResolution } from "../sdk/Camera";
+import { CameraLiveScannerResolution } from "../sdk/Camera";
 import { CameraModule } from "../common/CameraConfiguration";
 import { Resolution } from "../common/CameraConfiguration";
 /**
@@ -50,10 +50,10 @@ export declare class DocumentScannerCameraConfiguration {
       */
     fpsLimit: number;
     /**
-      The size of the image from camera which would be sent to the scanner for analysis.
+      The size of the image from camera which would be sent to the scanner for live scanning.
       @defaultValue "FULL_HD";
       */
-    analyzerFrameResolution: AnalyzerFrameResolution;
+    cameraLiveScannerResolution: CameraLiveScannerResolution;
     /** @param source {@displayType `DeepPartial<DocumentScannerCameraConfiguration>`} */
     constructor(source?: DeepPartial<DocumentScannerCameraConfiguration>);
 }

package/@types/ui2/configuration/sdk/Camera.d.ts

@@ -1,31 +1,25 @@
 /**
-The size of the image from camera which would be send to the scanner for analysis.
+The size of the image from camera which would be sent to the scanner for live scanning.
 
-- `HD`:
-   The image is in HD resolution. 1280x720 pixels or close to it.
+- `AUTO`:
+   Select to the image resolution automatically based on device specifics.
 - `FULL_HD`:
    The image is in Full HD resolution. 1920x1080 pixels or close to it.
-- `QHD`:
-   The image is in QHD resolution. 2560x1440 pixels or close to it.
 - `UHD`:
    The image is in UHD resolution. 3840x2160 pixels or close to it.
 */
-export type AnalyzerFrameResolution = 
+export type CameraLiveScannerResolution = 
 /**
-  The image is in HD resolution. 1280x720 pixels or close to it.
+  Select to the image resolution automatically based on device specifics.
   */
-"HD"
+"AUTO"
 /**
   The image is in Full HD resolution. 1920x1080 pixels or close to it.
   */
  | "FULL_HD"
-/**
-  The image is in QHD resolution. 2560x1440 pixels or close to it.
-  */
- | "QHD"
 /**
   The image is in UHD resolution. 3840x2160 pixels or close to it.
   */
  | "UHD";
 /** @hidden */
-export declare const AnalyzerFrameResolutionValues: ReadonlyArray<AnalyzerFrameResolution>;
+export declare const CameraLiveScannerResolutionValues: ReadonlyArray<CameraLiveScannerResolution>;

package/@types/worker/worker-bridge.d.ts

@@ -43,6 +43,10 @@ export declare class WorkerBridge {
             jpegQuality?: number;
             resamplingMethod?: import("../core-types").ResamplingMethod;
             binarizationFilter?: ({
+                filterType?: number;
+            } & {
+                readonly _type: "LegacyFilter";
+            }) | ({
                 outputMode?: import("../core-types").OutputMode;
             } & {
                 readonly _type: "ScanbotBinarizationFilter";
@@ -53,7 +57,16 @@ export declare class WorkerBridge {
                 preset?: import("../core-types").BinarizationFilterPreset;
             } & {
                 readonly _type: "CustomBinarizationFilter";
-            }) | ({} & {
+            }) | ({
+                radius?: number;
+                borderWidthFraction?: number;
+                blackOutliersFraction?: number;
+                whiteOutliersFraction?: number;
+                contrastEnhancement?: number;
+                colorEnhancement?: number;
+                paperWhitening?: number;
+                paperWhiteningBias?: number;
+            } & {
                 readonly _type: "ColorDocumentFilter";
             }) | ({
                 brightness?: number;
@@ -102,6 +115,10 @@ export declare class WorkerBridge {
                 });
             }[];
             binarizationFilter?: ({
+                filterType?: number;
+            } & {
+                readonly _type: "LegacyFilter";
+            }) | ({
                 outputMode?: import("../core-types").OutputMode;
             } & {
                 readonly _type: "ScanbotBinarizationFilter";
@@ -112,7 +129,16 @@ export declare class WorkerBridge {
                 preset?: import("../core-types").BinarizationFilterPreset;
             } & {
                 readonly _type: "CustomBinarizationFilter";
-            }) | ({} & {
+            }) | ({
+                radius?: number;
+                borderWidthFraction?: number;
+                blackOutliersFraction?: number;
+                whiteOutliersFraction?: number;
+                contrastEnhancement?: number;
+                colorEnhancement?: number;
+                paperWhitening?: number;
+                paperWhiteningBias?: number;
+            } & {
                 readonly _type: "ColorDocumentFilter";
             }) | ({
                 brightness?: number;
@@ -176,6 +202,10 @@ export declare class WorkerBridge {
             jpegQuality?: number;
             resamplingMethod?: import("../core-types").ResamplingMethod;
             binarizationFilter?: ({
+                filterType?: number;
+            } & {
+                readonly _type: "LegacyFilter";
+            }) | ({
                 outputMode?: import("../core-types").OutputMode;
             } & {
                 readonly _type: "ScanbotBinarizationFilter";
@@ -186,7 +216,16 @@ export declare class WorkerBridge {
                 preset?: import("../core-types").BinarizationFilterPreset;
             } & {
                 readonly _type: "CustomBinarizationFilter";
-            }) | ({} & {
+            }) | ({
+                radius?: number;
+                borderWidthFraction?: number;
+                blackOutliersFraction?: number;
+                whiteOutliersFraction?: number;
+                contrastEnhancement?: number;
+                colorEnhancement?: number;
+                paperWhitening?: number;
+                paperWhiteningBias?: number;
+            } & {
                 readonly _type: "ColorDocumentFilter";
             }) | ({
                 brightness?: number;
@@ -235,6 +274,10 @@ export declare class WorkerBridge {
                 });
             }[];
             binarizationFilter?: ({
+                filterType?: number;
+            } & {
+                readonly _type: "LegacyFilter";
+            }) | ({
                 outputMode?: import("../core-types").OutputMode;
             } & {
                 readonly _type: "ScanbotBinarizationFilter";
@@ -245,7 +288,16 @@ export declare class WorkerBridge {
                 preset?: import("../core-types").BinarizationFilterPreset;
             } & {
                 readonly _type: "CustomBinarizationFilter";
-            }) | ({} & {
+            }) | ({
+                radius?: number;
+                borderWidthFraction?: number;
+                blackOutliersFraction?: number;
+                whiteOutliersFraction?: number;
+                contrastEnhancement?: number;
+                colorEnhancement?: number;
+                paperWhitening?: number;
+                paperWhiteningBias?: number;
+            } & {
                 readonly _type: "ColorDocumentFilter";
             }) | ({
                 brightness?: number;