scanbot-web-sdk 6.0.0-dev.5 → 7.0.0-dev.1

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

@@ -0,0 +1,141 @@
+import { BarButtonConfiguration } from "../common/Common";
+import { ButtonConfiguration } from "../common/Common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
+import { StyledText } from "../common/Common";
+/**
+Configuration of the bottom bar for the cropping screen.
+*/
+export declare class CroppingBottomBar extends PartiallyConstructible {
+    /**
+      Configuration of the 'detect document' button, located in the bottom bar.
+      @defaultValue new BarButtonConfiguration({
+          "title": new StyledText({
+              "text": "?croppingDetectButtonTitle",
+              "color": "?sbColorOnPrimary"
+          }),
+          "accessibilityDescription": "?accessibilityDescriptionCroppingDetectButton",
+          "background": new BackgroundStyle({
+              "strokeColor": "#00000000",
+              "fillColor": "#00000000",
+              "strokeWidth": 0.0
+          }),
+          "icon": new IconStyle({
+              "color": "?sbColorOnPrimary"
+          })
+      });
+      */
+    detectButton: BarButtonConfiguration;
+    /**
+      Configuration of the 'rotate page' button, located in the bottom bar.
+      @defaultValue new BarButtonConfiguration({
+          "title": new StyledText({
+              "text": "?croppingRotateButtonTitle",
+              "color": "?sbColorOnPrimary"
+          }),
+          "accessibilityDescription": "?accessibilityDescriptionCroppingRotateButton",
+          "background": new BackgroundStyle({
+              "strokeColor": "#00000000",
+              "fillColor": "#00000000",
+              "strokeWidth": 0.0
+          }),
+          "icon": new IconStyle({
+              "color": "?sbColorOnPrimary"
+          })
+      });
+      */
+    rotateButton: BarButtonConfiguration;
+    /**
+      Configuration of the 'reset detection' button, located in the bottom bar.
+      @defaultValue new BarButtonConfiguration({
+          "title": new StyledText({
+              "text": "?croppingResetButtonTitle",
+              "color": "?sbColorOnPrimary"
+          }),
+          "accessibilityDescription": "?accessibilityDescriptionCroppingResetButton",
+          "background": new BackgroundStyle({
+              "strokeColor": "#00000000",
+              "fillColor": "#00000000",
+              "strokeWidth": 0.0
+          }),
+          "icon": new IconStyle({
+              "color": "?sbColorOnPrimary"
+          })
+      });
+      */
+    resetButton: BarButtonConfiguration;
+    /** @param source {@displayType `DeepPartial<CroppingBottomBar>`} */
+    constructor(source?: DeepPartial<CroppingBottomBar>);
+}
+/**
+Configuration of the screen for cropping the scanned pages.
+*/
+export declare class CroppingScreenConfiguration extends PartiallyConstructible {
+    /**
+      Configuration of the 'cancel' button, located in the top bar.
+      @defaultValue new ButtonConfiguration({
+          "visible": true,
+          "text": "?croppingTopBarCancelButtonTitle",
+          "accessibilityDescription": "?accessibilityDescriptionCroppingTopBarCancelButton",
+          "background": new BackgroundStyle({
+              "strokeColor": "#00000000",
+              "fillColor": "#00000000",
+              "strokeWidth": 0.0
+          }),
+          "foreground": new ForegroundStyle({
+              "iconVisible": true,
+              "color": "?sbColorOnPrimary",
+              "useShadow": false
+          })
+      });
+      */
+    topBarBackButton: ButtonConfiguration;
+    /**
+      Configuration of the title, located in the top bar.
+      @defaultValue new StyledText({
+          "text": "?croppingScreenTitle",
+          "color": "?sbColorOnPrimary"
+      });
+      */
+    topBarTitle: StyledText;
+    /**
+      Configuration of the 'confirm' button, located in the top bar.
+      @defaultValue new ButtonConfiguration({
+          "visible": true,
+          "text": "?croppingTopBarConfirmButtonTitle",
+          "accessibilityDescription": "?accessibilityDescriptionCroppingTopBarConfirmButton",
+          "background": new BackgroundStyle({
+              "strokeColor": "#00000000",
+              "fillColor": "#00000000",
+              "strokeWidth": 0.0
+          }),
+          "foreground": new ForegroundStyle({
+              "iconVisible": true,
+              "color": "?sbColorOnPrimary",
+              "useShadow": false
+          })
+      });
+      */
+    topBarConfirmButton: ButtonConfiguration;
+    /**
+      The background color of the cropping screen.
+      @defaultValue "?sbColorOutline";
+      */
+    backgroundColor: string;
+    /**
+      The color of the cropping handles.
+      @defaultValue "?sbColorSurface";
+      */
+    croppingHandlerColor: string;
+    /**
+      The color of the cropping polygon.
+      @defaultValue "?sbColorSurface";
+      */
+    croppingPolygonColor: string;
+    /**
+      Configuration of the bottom bar for the cropping screen.
+      @defaultValue new CroppingBottomBar({});
+      */
+    bottomBar: CroppingBottomBar;
+    /** @param source {@displayType `DeepPartial<CroppingScreenConfiguration>`} */
+    constructor(source?: DeepPartial<CroppingScreenConfiguration>);
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,60 @@
+import { AspectRatio } from "../Geometry";
+import { CameraModule } from "../common/CameraConfiguration";
+import { DeepPartial, PartiallyConstructible } from "../utils";
+/**
+Configuration of the camera behavior.
+*/
+export declare class DocumentScannerCameraConfiguration extends PartiallyConstructible {
+    /**
+      Determines which camera module to use on start-up.
+      @defaultValue "BACK";
+      */
+    cameraModule: CameraModule;
+    /**
+      Determines whether the flashlight is enabled or not on start-up.
+      @defaultValue false;
+      */
+    flashEnabled: boolean;
+    /**
+      The minimum pitch/skew angle of the document to be accepted. The value must be between 0.0 and 1.0.
+      @defaultValue 0.75;
+      */
+    acceptedAngleScore: number;
+    /**
+      The minimum size of the document in relation to the screen preview to be accepted. The value must be between 0.0 and 1.0.
+      @defaultValue 0.75;
+      */
+    acceptedSizeScore: number;
+    /**
+      Controls the auto snapping speed. The sensitivity must be between 0.0 and 1.0. A value of 1.0 triggers auto snapping immediately, while a value of 0.0 delays the auto snapping by 3 seconds. The default value is 0.66 (2 seconds).
+      @defaultValue 0.66;
+      */
+    autoSnappingSensitivity: number;
+    /**
+      After a page has been snapped, the delay in milliseconds before auto snapping resumes for the next page.
+      @defaultValue 200;
+      */
+    autoSnappingDelay: number;
+    /**
+      The minimum brightness value to accept a detected document.
+      @defaultValue 50;
+      */
+    acceptedBrightnessThreshold: number;
+    /**
+      Determines if auto snapping is enabled or not.
+      @defaultValue true;
+      */
+    autoSnappingEnabled: boolean;
+    /**
+      The required aspect ratios for the document to be accepted.
+      @defaultValue [];
+      */
+    requiredAspectRatios: AspectRatio[];
+    /**
+      Determines whether a landscape document will be detected when the camera is in portrait mode (and vice versa) or not. This parameter will be ignored if required aspect ratios have been explicitly defined.
+      @defaultValue true;
+      */
+    ignoreBadAspectRatio: boolean;
+    /** @param source {@displayType `DeepPartial<DocumentScannerCameraConfiguration>`} */
+    constructor(source?: DeepPartial<DocumentScannerCameraConfiguration>);
+}

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

@@ -0,0 +1,11 @@
+/**
+Determines the visibility mode for the document capturing user guidance labels.
+
+- `ENABLED`:
+   Enabled for both 'auto snapping' and 'manual snapping' modes.
+- `AUTO_CAPTURE_ONLY`:
+   Enabled only for the 'auto snapping' mode.
+- `DISABLED`:
+   Disabled for both 'auto snapping' and 'manual snapping' modes.
+*/
+export type UserGuidanceVisibility = "ENABLED" | "AUTO_CAPTURE_ONLY" | "DISABLED";

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

@@ -0,0 +1,38 @@
+import { DeepPartial, PartiallyConstructible } from "../utils";
+import { ParametricFilter } from "../ParametricFilters";
+/**
+Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
+
+- `FILTERED_DOCUMENT`:
+   The quality analysis will run on the filtered document image.
+- `UNFILTERED_DOCUMENT`:
+   The quality analysis will run on the unfiltered document image.
+*/
+export type DocumentAnalysisMode = "FILTERED_DOCUMENT" | "UNFILTERED_DOCUMENT";
+/**
+Configuration of the output settings.
+*/
+export declare class DocumentScannerOutputSettings extends PartiallyConstructible {
+    /**
+      The limit of the number of pages that can be scanned. Default is 0 (no limit).
+      @defaultValue 0;
+      */
+    pagesScanLimit: number;
+    /**
+      The limit of the size of the cropped document images. If one of the dimensions of the cropped image is larger than the limit, the image is downscaled so that its longer dimension matches the limit. The default is 0 (no limit).
+      @defaultValue 0;
+      */
+    documentImageSizeLimit: number;
+    /**
+      Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
+      @defaultValue "UNFILTERED_DOCUMENT";
+      */
+    documentAnalysisMode: DocumentAnalysisMode;
+    /**
+     Determines the image filter to apply by default.
+     @defaultValue null;
+     */
+    defaultFilter: ParametricFilter | null;
+    /** @param source {@displayType `DeepPartial<DocumentScannerOutputSettings>`} */
+    constructor(source?: DeepPartial<DocumentScannerOutputSettings>);
+}

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

@@ -0,0 +1,26 @@
+import { CameraScreenConfiguration } from "../document/CameraScreenConfiguration";
+import { CroppingScreenConfiguration } from "../document/CroppingScreenConfiguration";
+import { DeepPartial, PartiallyConstructible } from "../utils";
+import { ReviewScreenConfiguration } from "../document/ReviewScreenConfiguration";
+/**
+Configuration of the document scanner sub-screens.
+*/
+export declare class DocumentScannerScreens extends PartiallyConstructible {
+    /**
+      Configuration of the screen for scanning the pages with the camera.
+      @defaultValue new CameraScreenConfiguration({});
+      */
+    camera: CameraScreenConfiguration;
+    /**
+      Configuration of the screen for reviewing the scanned pages.
+      @defaultValue new ReviewScreenConfiguration({});
+      */
+    review: ReviewScreenConfiguration;
+    /**
+      Configuration of the screen for cropping the scanned pages.
+      @defaultValue new CroppingScreenConfiguration({});
+      */
+    cropping: CroppingScreenConfiguration;
+    /** @param source {@displayType `DeepPartial<DocumentScannerScreens>`} */
+    constructor(source?: DeepPartial<DocumentScannerScreens>);
+}