scanbot-web-sdk 7.0.0-dev.2 → 7.0.0-dev.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "scanbot-web-sdk",
   "title": "Web Scan SDK",
-  "version": "7.0.0-dev.2",
+  "version": "7.0.0-dev.4",
   "description": "Scanbot Web Document and Barcode Scanner SDK",
   "keywords": [
     "barcode",

package/@types/model/configuration/document-data-extractor-configuration.d.ts

@@ -1,9 +0,0 @@
-import type { DeepPartial, DocumentDataExtractorTypes } from "../../core-types";
-import { ViewFinderScannerConfiguration } from "./view-finder-scanner-configuration";
-export declare class DocumentDataExtractorConfiguration extends ViewFinderScannerConfiguration {
-    constructor();
-    detectorParameters?: DeepPartial<DocumentDataExtractorTypes.DocumentDataExtractorConfiguration>;
-    /** Callback is called for every analyzed frame. */
-    onDocumentDetected?: (result: DocumentDataExtractorTypes.DocumentDataExtractionResult) => void;
-    static fromJson(json: DeepPartial<DocumentDataExtractorConfiguration>): DocumentDataExtractorConfiguration;
-}

package/@types/model/configuration/text-pattern-scanner-configuration.d.ts

@@ -1,9 +0,0 @@
-import { ViewFinderScannerConfiguration } from "./view-finder-scanner-configuration";
-import { TextPatternScannerTypes, DeepPartial } from "../../core-types";
-export type TextDetectionCallback = (e: TextPatternScannerTypes.TextPatternScannerResult) => void;
-export declare class TextPatternScannerConfiguration extends ViewFinderScannerConfiguration {
-    constructor();
-    ocrConfiguration?: DeepPartial<TextPatternScannerTypes.TextPatternScannerConfiguration>;
-    onTextDetected?: TextDetectionCallback;
-    static fromJson(json: any): TextPatternScannerConfiguration;
-}

package/@types/model/configuration/vin-scanner-configuration.d.ts

@@ -1,9 +0,0 @@
-import { ViewFinderScannerConfiguration } from "./view-finder-scanner-configuration";
-import { DeepPartial, VinScannerTypes } from "../../core-types";
-export type VinDetectionCallback = (e: VinScannerTypes.VinScannerResult) => void;
-export declare class VINScannerConfiguration extends ViewFinderScannerConfiguration {
-    constructor();
-    detectionConfiguration?: DeepPartial<VinScannerTypes.VinScannerConfiguration>;
-    onVinDetected?: VinDetectionCallback;
-    static fromJson(json: any): VINScannerConfiguration;
-}

package/@types/ui2/configuration/barcode/ActionBarConfiguration.d.ts

@@ -1,42 +0,0 @@
-import { DeepPartial, PartiallyConstructible } from "../utils";
-import { RoundButton } from "./Common";
-/**
-Configuration of the buttons available in the action bar.
-*/
-export declare class ActionBarConfiguration extends PartiallyConstructible {
-    /**
-      Appearance of the flash button.
-      @defaultValue new RoundButton({
-          "visible": true,
-          "backgroundColor": "?sbColorSurfaceHigh",
-          "foregroundColor": "?sbColorOnPrimary",
-          "activeBackgroundColor": "?sbColorWarning",
-          "activeForegroundColor": "#1C1B1F"
-      });
-      */
-    flashButton: RoundButton;
-    /**
-      Appearance of the zoom button.
-      @defaultValue new RoundButton({
-          "visible": true,
-          "backgroundColor": "?sbColorSurfaceHigh",
-          "foregroundColor": "?sbColorOnPrimary",
-          "activeBackgroundColor": "?sbColorSurfaceHigh",
-          "activeForegroundColor": "?sbColorOnPrimary"
-      });
-      */
-    zoomButton: RoundButton;
-    /**
-      Appearance of the flip camera button.
-      @defaultValue new RoundButton({
-          "visible": true,
-          "backgroundColor": "?sbColorSurfaceHigh",
-          "foregroundColor": "?sbColorOnPrimary",
-          "activeBackgroundColor": "?sbColorSurfaceHigh",
-          "activeForegroundColor": "?sbColorOnPrimary"
-      });
-      */
-    flipCameraButton: RoundButton;
-    /** @param source {@displayType `DeepPartial<ActionBarConfiguration>`} */
-    constructor(source?: DeepPartial<ActionBarConfiguration>);
-}

package/@types/ui2/configuration/barcode/BarcodeItemMapper.d.ts

@@ -1,6 +0,0 @@
-import { BarcodeMappedData } from "./BarcodeInfoMapping";
-import { BarcodeScannerUIItem } from "./BarcodeScannerUIResult";
-/**
- * Maps a barcode's data to the data of the corresponding product.
- * */
-export type BarcodeItemMapper = (BarcodeScannerUIItem: BarcodeScannerUIItem) => Promise<BarcodeMappedData>;

package/@types/ui2/configuration/barcode/BarcodeScannerTypes.d.ts

@@ -1,2 +0,0 @@
-export { BarcodeItem } from "../../../core/bridge/compiled/BarcodeScannerTypes";
-export type { BarcodeScannerEngineMode } from "../../../core/bridge/compiled/BarcodeScannerTypes";

package/@types/ui2/configuration/barcode/BarcodeTypes.d.ts

@@ -1 +0,0 @@
-export type { BarcodeFormat, Gs1Handling, } from "../../../core/bridge/compiled/BarcodeTypes";

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

@@ -1,60 +0,0 @@
-import { DeepPartial, PartiallyConstructible } from "../utils";
-/**
-Ideal resolution of the camera preview.
-*/
-export declare class Resolution extends PartiallyConstructible {
-    /**
-      Width of the resolution.
-      */
-    width: number;
-    /**
-      Height of the resolution.
-      */
-    height: number;
-    /** @param source {@displayType `DeepPartial<Resolution>`} */
-    constructor(source?: DeepPartial<Resolution>);
-}
-/**
-Determine which camera module to use on start-up.
-
-- `FRONT`:
-   Use the front camera.
-- `BACK`:
-   Use the default back camera.
-*/
-export type CameraModule = "FRONT" | "BACK";
-/**
-Configuration of the camera settings to be used while scanning.
-*/
-export declare class CameraConfiguration extends PartiallyConstructible {
-    /**
-      Which camera module to use on start-up.
-      @defaultValue "BACK";
-      */
-    cameraModule: CameraModule;
-    /**
-      The number of zoom steps available to the user.
-      @defaultValue [1.0, 2.0, 5.0];
-      */
-    zoomSteps: number[];
-    /**
-      The default zoom factor on start-up.
-      @defaultValue 1.0;
-      */
-    defaultZoomFactor: number;
-    /**
-      Whether the flash is enabled by default.
-      @defaultValue false;
-      */
-    flashEnabled: boolean;
-    /**
-      The ideal resolution for the camera preview. Actual resolution may vary depending on browser and device capabilities.
-      @defaultValue new Resolution({
-          "width": 1920,
-          "height": 1080
-      });
-      */
-    idealPreviewResolution: Resolution;
-    /** @param source {@displayType `DeepPartial<CameraConfiguration>`} */
-    constructor(source?: DeepPartial<CameraConfiguration>);
-}

package/@types/ui2/configuration/barcode/CameraPermission.d.ts

@@ -1,54 +0,0 @@
-import { ButtonConfiguration } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../utils";
-import { IconStyle } from "./Common";
-import { StyledText } from "./Common";
-/**
-Configuration of the camera permission request view.
-*/
-export declare class CameraPermissionScreen extends PartiallyConstructible {
-    /**
-      Background color of the camera permission request.
-      @defaultValue "?sbColorSurface";
-      */
-    background: string;
-    /**
-      Background color of the icon used in the camera permission request.
-      @defaultValue "?sbColorOutline";
-      */
-    iconBackground: string;
-    /**
-      Configuration of the icon used in the camera permission request.
-      @defaultValue new IconStyle({
-          "visible": true,
-          "color": "?sbColorOnSurface"
-      });
-      */
-    icon: IconStyle;
-    /**
-      Configuration of the camera permission request's close button.
-      @defaultValue new ButtonConfiguration({
-          "text": "Close",
-          "background": new BackgroundStyle({}),
-          "foreground": new ForegroundStyle({})
-      });
-      */
-    closeButton: ButtonConfiguration;
-    /**
-      Configuration of the camera permission request's title.
-      @defaultValue new StyledText({
-          "text": "Camera permission denied!",
-          "color": "?colorOnSurface"
-      });
-      */
-    enableCameraTitle: StyledText;
-    /**
-      Configuration of the camera permission request's explanatory text.
-      @defaultValue new StyledText({
-          "text": "Please allow the usage of the camera to start the scanning process.",
-          "color": "?sbColorOnSurfaceVariant"
-      });
-      */
-    enableCameraExplanation: StyledText;
-    /** @param source {@displayType `DeepPartial<CameraPermissionScreen>`} */
-    constructor(source?: DeepPartial<CameraPermissionScreen>);
-}

package/@types/ui2/configuration/barcode/Common.d.ts

@@ -1,359 +0,0 @@
-import { DeepPartial, PartiallyConstructible } from "../utils";
-/**
-Value palette describing the colors of the scanner screens.
-*/
-export declare class Palette extends PartiallyConstructible {
-    /**
-      Primary color used for enabled elements.
-      @defaultValue "#C8193C";
-      */
-    sbColorPrimary: string;
-    /**
-      Primary color used for disabled elements.
-      @defaultValue "#F5F5F5";
-      */
-    sbColorPrimaryDisabled: string;
-    /**
-      Color used to convey a negative meaning.
-      @defaultValue "#FF3737";
-      */
-    sbColorNegative: string;
-    /**
-      Color used to convey a positive meaning.
-      @defaultValue "#4EFFB4";
-      */
-    sbColorPositive: string;
-    /**
-      Color used to convey warnings.
-      @defaultValue "#FFCE5C";
-      */
-    sbColorWarning: string;
-    /**
-      Secondary color used for enabled elements.
-      @defaultValue "#FFEDEE";
-      */
-    sbColorSecondary: string;
-    /**
-      Secondary color used for disabled elements.
-      @defaultValue "#F5F5F5";
-      */
-    sbColorSecondaryDisabled: string;
-    /**
-      Color used for displaying elements on top of the primary color.
-      @defaultValue "#FFFFFF";
-      */
-    sbColorOnPrimary: string;
-    /**
-      Color used for displaying elements on top of the secondary color.
-      @defaultValue "#C8193C";
-      */
-    sbColorOnSecondary: string;
-    /**
-      Color used for surfaces.
-      @defaultValue "#FFFFFF";
-      */
-    sbColorSurface: string;
-    /**
-      Color used for outlines.
-      @defaultValue "#EFEFEF";
-      */
-    sbColorOutline: string;
-    /**
-      Alternative color used on top of surfaces.
-      @defaultValue "#707070";
-      */
-    sbColorOnSurfaceVariant: string;
-    /**
-      Color used on top of surfaces.
-      @defaultValue "#000000";
-      */
-    sbColorOnSurface: string;
-    /**
-      Transparent color with a low alpha value used for certain surfaces.
-      @defaultValue "#00000026";
-      */
-    sbColorSurfaceLow: string;
-    /**
-      Transparent color with a high alpha value used for certain surfaces.
-      @defaultValue "#0000007A";
-      */
-    sbColorSurfaceHigh: string;
-    /**
-      Transparent color with a very high alpha value used to fill certain overlays.
-      @defaultValue "#000000A3";
-      */
-    sbColorModalOverlay: string;
-    /** @param source {@displayType `DeepPartial<Palette>`} */
-    constructor(source?: DeepPartial<Palette>);
-}
-/**
-Configuration of the text field appearance.
-*/
-export declare class StyledText extends PartiallyConstructible {
-    /**
-      Whether the text field is visible.
-      @defaultValue true;
-      */
-    visible: boolean;
-    /**
-      Value of the text field.
-      @defaultValue "";
-      */
-    text: string;
-    /**
-      Text color.
-      @defaultValue "#FFFFFF";
-      */
-    color: string;
-    /**
-      Whether to enable drop shadows for the text.
-      @defaultValue false;
-      */
-    useShadow: boolean;
-    /** @param source {@displayType `DeepPartial<StyledText>`} */
-    constructor(source?: DeepPartial<StyledText>);
-}
-/**
-Configuration of the icon appearance.
-*/
-export declare class IconStyle extends PartiallyConstructible {
-    /**
-      Whether the icon is visible on the button.
-      @defaultValue true;
-      */
-    visible: boolean;
-    /**
-      Icon color.
-      @defaultValue "#FFFFFF";
-      */
-    color: string;
-    /** @param source {@displayType `DeepPartial<IconStyle>`} */
-    constructor(source?: DeepPartial<IconStyle>);
-}
-/**
-Configuration of the polygon appearance.
-*/
-export declare class PolygonStyle extends PartiallyConstructible {
-    /**
-      Color of the polygon outline.
-      @defaultValue "#FFFFFFFF";
-      */
-    strokeColor: string;
-    /**
-      Polygon color.
-      @defaultValue "#FFFFFF30";
-      */
-    fillColor: string;
-    /**
-      Width of the polygon outline in dp.
-      @defaultValue 2.0;
-      */
-    strokeWidth: number;
-    /**
-      Polygon corner radius in dp.
-      @defaultValue 0.0;
-      */
-    cornerRadius: number;
-    /** @param source {@displayType `DeepPartial<PolygonStyle>`} */
-    constructor(source?: DeepPartial<PolygonStyle>);
-}
-/**
-Appearance of the polygon used for buttons and hint backgrounds.
-*/
-export declare class BackgroundStyle extends PartiallyConstructible {
-    /**
-      Color of the polygon outline.
-      @defaultValue "#FFFFFFFF";
-      */
-    strokeColor: string;
-    /**
-      Polygon color.
-      @defaultValue "#FFFFFF30";
-      */
-    fillColor: string;
-    /**
-      Width of the polygon outline in dp.
-      @defaultValue 2.0;
-      */
-    strokeWidth: number;
-    /** @param source {@displayType `DeepPartial<BackgroundStyle>`} */
-    constructor(source?: DeepPartial<BackgroundStyle>);
-}
-/**
-Configuration of the appearance of foreground elements (e.g. text and/or icons on buttons, etc).
-*/
-export declare class ForegroundStyle extends PartiallyConstructible {
-    /**
-      Whether the icon is visible.
-      @defaultValue true;
-      */
-    iconVisible: boolean;
-    /**
-      Color used for foreground elements.
-      @defaultValue "#FFFFFF";
-      */
-    color: string;
-    /**
-      Whether to use drop shadows for foreground elements.
-      @defaultValue false;
-      */
-    useShadow: boolean;
-    /** @param source {@displayType `DeepPartial<ForegroundStyle>`} */
-    constructor(source?: DeepPartial<ForegroundStyle>);
-}
-/**
-Configuration of the round button.
-*/
-export declare class RoundButton extends PartiallyConstructible {
-    /**
-      Whether to display the button.
-      @defaultValue true;
-      */
-    visible: boolean;
-    /**
-      Color of the button background shape.
-      @defaultValue "#0000007A";
-      */
-    backgroundColor: string;
-    /**
-      Color of the button foreground (icon, text).
-      @defaultValue "#FFFFFF";
-      */
-    foregroundColor: string;
-    /**
-      Color of the button background shape when the button is active (selected, toggled).
-      @defaultValue "#FFCE5C";
-      */
-    activeBackgroundColor: string;
-    /**
-      Color of the button foreground (icon, text) when the button is active (selected, toggled).
-      @defaultValue "#1C1B1F";
-      */
-    activeForegroundColor: string;
-    /** @param source {@displayType `DeepPartial<RoundButton>`} */
-    constructor(source?: DeepPartial<RoundButton>);
-}
-/**
-Configuration of the round button with badge.
-*/
-export declare class BadgedButton extends PartiallyConstructible {
-    /**
-      Color of the badge's background shape.
-      @defaultValue "#FFFFFF";
-      */
-    badgeBackgroundColor: string;
-    /**
-      Color of the badge foreground (icon, text).
-      @defaultValue "#C8193C";
-      */
-    badgeForegroundColor: string;
-    /**
-      Whether the button is visible.
-      @defaultValue true;
-      */
-    visible: boolean;
-    /**
-      Color of the button background shape.
-      @defaultValue "#0000007A";
-      */
-    backgroundColor: string;
-    /**
-      Color of the button foreground (icon, text).
-      @defaultValue "#FFFFFF";
-      */
-    foregroundColor: string;
-    /**
-      Color of the button background shape when the button is active (selected, toggled).
-      @defaultValue "#FFCE5C";
-      */
-    activeBackgroundColor: string;
-    /**
-      Color of the button foreground (icon, text) when the button is active (selected, toggled).
-      @defaultValue "#1C1B1F";
-      */
-    activeForegroundColor: string;
-    /** @param source {@displayType `DeepPartial<BadgedButton>`} */
-    constructor(source?: DeepPartial<BadgedButton>);
-}
-/**
-Button configuration.
-*/
-export declare class ButtonConfiguration extends PartiallyConstructible {
-    /**
-      Whether the button is visible or not.
-      @defaultValue true;
-      */
-    visible: boolean;
-    /**
-      The text to be displayed on the button.
-      @defaultValue "";
-      */
-    text: string;
-    /**
-      The style of the button's background.
-      @defaultValue new BackgroundStyle({});
-      */
-    background: BackgroundStyle;
-    /**
-      The style of the button's foreground (icon, text).
-      @defaultValue new ForegroundStyle({});
-      */
-    foreground: ForegroundStyle;
-    /** @param source {@displayType `DeepPartial<ButtonConfiguration>`} */
-    constructor(source?: DeepPartial<ButtonConfiguration>);
-}
-/**
-The sound selection type.
-
-- `MODERN_BEEP`:
-   To choose a modern beep sound.
-- `CLASSIC_BEEP`:
-   To choose the old classic beep sound.
-*/
-export type SoundType = "MODERN_BEEP" | "CLASSIC_BEEP";
-/**
-Sound configuration.
-*/
-export declare class Sound extends PartiallyConstructible {
-    /**
-      Enable or disable the beep sound when a barcode is detected.
-      @defaultValue true;
-      */
-    successBeepEnabled: boolean;
-    /**
-      The beep type.
-      @defaultValue "MODERN_BEEP";
-      */
-    soundType: SoundType;
-    /** @param source {@displayType `DeepPartial<Sound>`} */
-    constructor(source?: DeepPartial<Sound>);
-}
-/**
-Vibration configuration.
-*/
-export declare class Vibration extends PartiallyConstructible {
-    /**
-      Enable or disable vibration when a barcode is detected.
-      @defaultValue false;
-      */
-    enabled: boolean;
-    /** @param source {@displayType `DeepPartial<Vibration>`} */
-    constructor(source?: DeepPartial<Vibration>);
-}
-/**
-Configuration of timeouts.
-*/
-export declare class Timeouts extends PartiallyConstructible {
-    /**
-      Sets the auto close timer in ms. Default is 0 (disabled).
-      @defaultValue 0;
-      */
-    autoCancelTimeout: number;
-    /**
-      Sets the time in ms the first scan is delayed by. Default is 0 (disabled).
-      @defaultValue 0;
-      */
-    initialScanDelay: number;
-    /** @param source {@displayType `DeepPartial<Timeouts>`} */
-    constructor(source?: DeepPartial<Timeouts>);
-}

package/@types/ui2/configuration/barcode/CommonFieldType.d.ts

@@ -1 +0,0 @@
-export * from "../../../core/bridge/compiled/CommonFieldType";

package/@types/ui2/configuration/barcode/GenericDocument.d.ts

@@ -1 +0,0 @@
-export * from "../../../core/bridge/compiled/GenericDocument";

package/@types/ui2/configuration/barcode/Geometry.d.ts

@@ -1 +0,0 @@
-export * from "../../../core/bridge/compiled/Geometry";

package/@types/ui2/configuration/barcode/ScanbotAlertDialog.d.ts

@@ -1,49 +0,0 @@
-import { ButtonConfiguration } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../utils";
-import { StyledText } from "./Common";
-/**
-Configuration of the the standard alert dialog.
-*/
-export declare class ScanbotAlertDialog extends PartiallyConstructible {
-    /**
-      Title displayed above the message.
-      @defaultValue new StyledText({
-          "text": "Title",
-          "color": "?sbColorOnSurface"
-      });
-      */
-    title: StyledText;
-    /**
-      Explanation message message.
-      @defaultValue new StyledText({
-          "text": "Standard explanation message text.",
-          "color": "?sbColorOnSurfaceVariant"
-      });
-      */
-    subtitle: StyledText;
-    /**
-      Background color of the alert dialog.
-      @defaultValue "?sbColorSurface";
-      */
-    sheetColor: string;
-    /**
-      Dialog overlay color.
-      @defaultValue "?sbColorModalOverlay";
-      */
-    modalOverlayColor: string;
-    /**
-      Color of the divider line.
-      @defaultValue "?sbColorOutline";
-      */
-    dividerColor: string;
-    /**
-      Configuration of the retry button.
-      */
-    okButton: ButtonConfiguration;
-    /**
-      Configuration of the cancel button.
-      */
-    cancelButton: ButtonConfiguration;
-    /** @param source {@displayType `DeepPartial<ScanbotAlertDialog>`} */
-    constructor(source?: DeepPartial<ScanbotAlertDialog>);
-}

package/@types/ui2/configuration/barcode/TopBarConfiguration.d.ts

@@ -1,55 +0,0 @@
-import { ButtonConfiguration } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../utils";
-import { StyledText } from "./Common";
-/**
-Configuration of the top screen bar's appearance.
-*/
-export declare class TopBarConfiguration extends PartiallyConstructible {
-    /**
-      Appearance of the top bar's title.
-      @defaultValue new StyledText({
-          "visible": false,
-          "text": "Scan Item",
-          "color": "?sbColorOnPrimary"
-      });
-      */
-    title: StyledText;
-    /**
-      Visual mode used for the top bar.
-      @defaultValue "SOLID";
-      */
-    mode: TopBarMode;
-    /**
-      Background color of the top bar to be used when the visual mode is specified as SOLID. Otherwise ignored.
-      @defaultValue "?sbColorPrimary";
-      */
-    backgroundColor: string;
-    /**
-      Configuration of the cancel button's appearance.
-      @defaultValue new ButtonConfiguration({
-          "text": "Cancel",
-          "background": new BackgroundStyle({
-              "strokeColor": "#00000000",
-              "fillColor": "#00000000",
-              "strokeWidth": 0.0
-          }),
-          "foreground": new ForegroundStyle({
-              "color": "?sbColorOnPrimary"
-          })
-      });
-      */
-    cancelButton: ButtonConfiguration;
-    /** @param source {@displayType `DeepPartial<TopBarConfiguration>`} */
-    constructor(source?: DeepPartial<TopBarConfiguration>);
-}
-/**
-Visual mode used for the top bar.
-
-- `SOLID`:
-   Display the top bar with a background color or with transparency.
-- `GRADIENT`:
-   Display the top bar with a gradient background color or a transparent gradient. The buttons will still be visible.
-- `HIDDEN`:
-   Hide the top bar completely.
-*/
-export type TopBarMode = "SOLID" | "GRADIENT" | "HIDDEN";