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

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

@@ -0,0 +1,99 @@
+import { BackgroundStyle } from "../common/Common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
+import { StyledText } from "../common/Common";
+import { UserGuidanceVisibility } from "../document/DocumentScannerGuidanceVisibility";
+/**
+Configure the titles of the user guidance hints for different states.
+*/
+export declare class UserGuidanceStates extends PartiallyConstructible {
+    /**
+      The user guidance text displayed when no document is found.
+      @defaultValue "?cameraUserGuidanceNoDocumentFound";
+      */
+    noDocumentFound: string;
+    /**
+      The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa).
+      @defaultValue "?cameraUserGuidanceBadAspectRatio";
+      */
+    badAspectRatio: string;
+    /**
+      The user guidance text displayed when the document pitch/skew angle is unacceptable.
+      @defaultValue "?cameraUserGuidanceBadAngles";
+      */
+    badAngles: string;
+    /**
+      The user guidance text displayed when the document is not centered in the finder view.
+      @defaultValue "?cameraUserGuidanceTextHintOffCenter";
+      */
+    textHintOffCenter: string;
+    /**
+      The user guidance text displayed when the document is too far from camera.
+      @defaultValue "?cameraUserGuidanceTooSmall";
+      */
+    tooSmall: string;
+    /**
+      The user guidance text displayed when the background is too noisy.
+      @defaultValue "?cameraUserGuidanceTooNoisy";
+      */
+    tooNoisy: string;
+    /**
+      The user guidance text displayed when it is too dark to capture an adequate image.
+      @defaultValue "?cameraUserGuidanceTooDark";
+      */
+    tooDark: string;
+    /**
+      The user guidance text displayed when the device is in energy saving mode. iOS only.
+      @defaultValue "?cameraUserGuidanceEnergySaveMode";
+      */
+    energySaveMode: string;
+    /**
+      The user guidance text displayed when the document is ready to be captured in 'auto snapping' mode.
+      @defaultValue "?cameraUserGuidanceReadyToCapture";
+      */
+    readyToCapture: string;
+    /**
+      The user guidance text displayed when the document is being captured and user needs to hold the device still.
+      @defaultValue "?cameraUserGuidanceReadyToCapture";
+      */
+    capturing: string;
+    /**
+      The user guidance text displayed when the document is ready to be captured in 'manual snapping' mode.
+      @defaultValue "?cameraUserGuidanceReadyToCaptureManual";
+      */
+    captureManual: string;
+    /** @param source {@displayType `DeepPartial<UserGuidanceStates>`} */
+    constructor(source?: DeepPartial<UserGuidanceStates>);
+}
+/**
+Configuration of the hints guiding users through the scanning process.
+*/
+export declare class DocumentScannerUserGuidance extends PartiallyConstructible {
+    /**
+      Determines when the user guidance hints should be visible.
+      @defaultValue "ENABLED";
+      */
+    visibility: UserGuidanceVisibility;
+    /**
+      Configure the text style for the user guidance hints.
+      @defaultValue new StyledText({
+          "text": "?cameraUserGuidanceStart",
+          "color": "?sbColorOnPrimary"
+      });
+      */
+    title: StyledText;
+    /**
+      Configure the background style for the user guidance hints.
+      @defaultValue new BackgroundStyle({
+          "strokeColor": "#00000000",
+          "fillColor": "?sbColorSurfaceHigh"
+      });
+      */
+    background: BackgroundStyle;
+    /**
+      Configure the titles of the user guidance hints for different states.
+      @defaultValue new UserGuidanceStates({});
+      */
+    statesTitles: UserGuidanceStates;
+    /** @param source {@displayType `DeepPartial<DocumentScannerUserGuidance>`} */
+    constructor(source?: DeepPartial<DocumentScannerUserGuidance>);
+}

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

@@ -0,0 +1,91 @@
+import { DeepPartial, PartiallyConstructible } from "../utils";
+import { DocumentScannerOutputSettings } from "../document/DocumentScannerOutputSettings";
+import { DocumentScannerScreens } from "../document/DocumentScannerScreens";
+import { DocumentScannerTextLocalization } from "../document/DocumentScannerTextLocalization";
+import { Palette } from "../common/Common";
+/**
+Configuration of the general appearance.
+*/
+export declare class DocumentFlowAppearanceConfiguration extends PartiallyConstructible {
+    /**
+      The background color of the top bar. Only applicable when the visual mode is specified as 'SOLID', otherwise ignored.
+      @defaultValue "?sbColorPrimary";
+      */
+    topBarBackgroundColor: string;
+    /**
+      The background color of the bottom bar.
+      @defaultValue "?sbColorPrimary";
+      */
+    bottomBarBackgroundColor: string;
+    /** @param source {@displayType `DeepPartial<DocumentFlowAppearanceConfiguration>`} */
+    constructor(source?: DeepPartial<DocumentFlowAppearanceConfiguration>);
+}
+/**
+Configuration of the document scanner screen.
+*/
+export declare class DocumentScanningFlow extends PartiallyConstructible {
+    /**
+      Version number of the configuration object.
+      @defaultValue "1.0";
+      */
+    version: string;
+    /**
+      The configuration object should be applied for this screen.
+      @defaultValue "DocumentScanner";
+      */
+    screen: string;
+    /**
+      Define the screen's base color values from which other colors are derived.
+      @defaultValue new Palette({
+          "sbColorPrimary": "#C8193C",
+          "sbColorPrimaryDisabled": "#F5F5F5",
+          "sbColorNegative": "#FF3737",
+          "sbColorPositive": "#4EFFB4",
+          "sbColorWarning": "#FFCE5C",
+          "sbColorSecondary": "#FFEDEE",
+          "sbColorSecondaryDisabled": "#F5F5F5",
+          "sbColorOnPrimary": "#FFFFFF",
+          "sbColorOnSecondary": "#C8193C",
+          "sbColorSurface": "#FFFFFF",
+          "sbColorOutline": "#EFEFEF",
+          "sbColorOnSurfaceVariant": "#707070",
+          "sbColorOnSurface": "#000000",
+          "sbColorSurfaceLow": "#00000026",
+          "sbColorSurfaceHigh": "#0000007A",
+          "sbColorModalOverlay": "#000000A3"
+      });
+      */
+    palette: Palette;
+    /**
+      Configuration of all the strings for the document scanner screen.
+      @defaultValue new DocumentScannerTextLocalization({});
+      */
+    localization: DocumentScannerTextLocalization;
+    /**
+      Configuration of the general appearance.
+      @defaultValue new DocumentFlowAppearanceConfiguration({});
+      */
+    appearance: DocumentFlowAppearanceConfiguration;
+    /**
+      Configuration of the output settings.
+      @defaultValue new DocumentScannerOutputSettings({});
+      */
+    outputSettings: DocumentScannerOutputSettings;
+    /**
+      Configuration of the document scanner sub-screens.
+      @defaultValue new DocumentScannerScreens({});
+      */
+    screens: DocumentScannerScreens;
+    /**
+      The UUID of the existing document to be edited.
+      @defaultValue null;
+      */
+    documentUuid: string | null;
+    /**
+      Clean the existing pages from the scanning session.
+      @defaultValue true;
+      */
+    cleanScanningSession: boolean;
+    /** @param source {@displayType `DeepPartial<DocumentScanningFlow>`} */
+    constructor(source?: DeepPartial<DocumentScanningFlow>);
+}

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

@@ -0,0 +1,188 @@
+import { ButtonConfiguration } from "../common/Common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
+import { StyledText } from "../common/Common";
+/**
+An entry in the list of scanning steps of the introduction screen.
+*/
+export declare class IntroListEntry extends PartiallyConstructible {
+    /**
+      The image of the entry.
+      @defaultValue new NoIntroImage({});
+      */
+    image: IntroImage;
+    /**
+      The text of the entry.
+      @defaultValue new StyledText({
+          "text": "?cameraIntroDescription",
+          "color": "?sbColorOnSurface"
+      });
+      */
+    text: StyledText;
+    /** @param source {@displayType `DeepPartial<IntroListEntry>`} */
+    constructor(source?: DeepPartial<IntroListEntry>);
+}
+/**
+Determines the image for the introduction screen.
+*/
+export type IntroImage = NoIntroImage | ReceiptsIntroImage | MedicalCertificateIntroImage | DocumentIntroImage | CheckIntroImage | IdCardIntroImage | CreditCardIntroImage | CustomImage;
+/** @internal */
+export declare namespace IntroImage {
+    /** @internal */
+    function From(source: {
+        [key: string]: any;
+    }): IntroImage;
+}
+/**
+No image for the introduction screen.
+*/
+export declare class NoIntroImage extends PartiallyConstructible {
+    readonly _type: "NoIntroImage";
+    /** @param source {@displayType `DeepPartial<NoIntroImage>`} */
+    constructor(source?: DeepPartial<NoIntroImage>);
+}
+/**
+The image for the introduction screen with a receipt template.
+*/
+export declare class ReceiptsIntroImage extends PartiallyConstructible {
+    readonly _type: "ReceiptsIntroImage";
+    /** @param source {@displayType `DeepPartial<ReceiptsIntroImage>`} */
+    constructor(source?: DeepPartial<ReceiptsIntroImage>);
+}
+/**
+The image for the introduction screen with a medical certificate template.
+*/
+export declare class MedicalCertificateIntroImage extends PartiallyConstructible {
+    readonly _type: "MedicalCertificateIntroImage";
+    /** @param source {@displayType `DeepPartial<MedicalCertificateIntroImage>`} */
+    constructor(source?: DeepPartial<MedicalCertificateIntroImage>);
+}
+/**
+The image for the introduction screen with a document template.
+*/
+export declare class DocumentIntroImage extends PartiallyConstructible {
+    readonly _type: "DocumentIntroImage";
+    /** @param source {@displayType `DeepPartial<DocumentIntroImage>`} */
+    constructor(source?: DeepPartial<DocumentIntroImage>);
+}
+/**
+The image for the introduction screen with a check template.
+*/
+export declare class CheckIntroImage extends PartiallyConstructible {
+    readonly _type: "CheckIntroImage";
+    /** @param source {@displayType `DeepPartial<CheckIntroImage>`} */
+    constructor(source?: DeepPartial<CheckIntroImage>);
+}
+/**
+The image for the introduction screen with an ID card template.
+*/
+export declare class IdCardIntroImage extends PartiallyConstructible {
+    readonly _type: "IdCardIntroImage";
+    /** @param source {@displayType `DeepPartial<IdCardIntroImage>`} */
+    constructor(source?: DeepPartial<IdCardIntroImage>);
+}
+/**
+The image for the introduction screen with a credit card template.
+*/
+export declare class CreditCardIntroImage extends PartiallyConstructible {
+    readonly _type: "CreditCardIntroImage";
+    /** @param source {@displayType `DeepPartial<CreditCardIntroImage>`} */
+    constructor(source?: DeepPartial<CreditCardIntroImage>);
+}
+/**
+A custom image for the introduction screen.
+*/
+export declare class CustomImage extends PartiallyConstructible {
+    readonly _type: "CustomImage";
+    /**
+      The web or file URI to the image.
+      */
+    uri: string;
+    /** @param source {@displayType `DeepPartial<CustomImage>`} */
+    constructor(source?: DeepPartial<CustomImage>);
+}
+/**
+Configuration of the introduction screen for the document scanner.
+*/
+export declare class IntroductionScreenConfiguration extends PartiallyConstructible {
+    /**
+      The background color of the introduction screen.
+      @defaultValue "?sbColorSurface";
+      */
+    backgroundColor: string;
+    /**
+      The divider color of the introduction screen.
+      @defaultValue "?sbColorOutline";
+      */
+    dividerColor: string;
+    /**
+      Determines whether the introduction screen should automatically be shown or not when the scanning session starts.
+      @defaultValue false;
+      */
+    showAutomatically: boolean;
+    /**
+      Configuration of the 'done' button, located in the top bar.
+      @defaultValue new ButtonConfiguration({
+          "visible": true,
+          "text": "?cameraIntroDoneButton",
+          "accessibilityDescription": "?accessibilityDescriptionCameraIntroDoneButton",
+          "background": new BackgroundStyle({
+              "strokeColor": "#00000000",
+              "fillColor": "#00000000",
+              "strokeWidth": 0.0
+          }),
+          "foreground": new ForegroundStyle({
+              "iconVisible": true,
+              "color": "?sbColorPrimary",
+              "useShadow": false
+          })
+      });
+      */
+    topBarDoneButton: ButtonConfiguration;
+    /**
+      The title of the introduction screen, located in the top bar.
+      @defaultValue new StyledText({
+          "text": "?cameraIntroTitle",
+          "color": "?sbColorOnSurface"
+      });
+      */
+    title: StyledText;
+    /**
+      The subtitle of the introduction screen.
+      @defaultValue new StyledText({
+          "text": "?cameraIntroSubtitle",
+          "color": "?sbColorOnSurface"
+      });
+      */
+    subtitle: StyledText;
+    /**
+      Configure the scanning steps of the introduction screen.
+      @defaultValue [new IntroListEntry({
+          "image": new DocumentIntroImage({}),
+          "text": new StyledText({
+              "text": "?cameraIntroItem1",
+              "color": "?sbColorOnSurface"
+          })
+      }), new IntroListEntry({
+          "image": new NoIntroImage({}),
+          "text": new StyledText({
+              "text": "?cameraIntroItem2",
+              "color": "?sbColorOnSurface"
+          })
+      }), new IntroListEntry({
+          "image": new NoIntroImage({}),
+          "text": new StyledText({
+              "text": "?cameraIntroItem3",
+              "color": "?sbColorOnSurface"
+          })
+      }), new IntroListEntry({
+          "image": new NoIntroImage({}),
+          "text": new StyledText({
+              "text": "?cameraIntroItem4",
+              "color": "?sbColorOnSurface"
+          })
+      })];
+      */
+    items: IntroListEntry[];
+    /** @param source {@displayType `DeepPartial<IntroductionScreenConfiguration>`} */
+    constructor(source?: DeepPartial<IntroductionScreenConfiguration>);
+}

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

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