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

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

@@ -1,395 +1,358 @@
-import { DeepPartial, PartiallyConstructible } from "./utils";
+import { DeepPartial, PartiallyConstructible } from "../common";
 /**
- Value palette describing the colors of the scanner screens.
- */
+Value palette describing the colors of the scanner screens.
+*/
 export declare class Palette extends PartiallyConstructible {
     /**
-     Primary color used for enabled elements.
-     @defaultValue "#C8193C";
-     */
+      Primary color used for enabled elements.
+      @defaultValue "#C8193C";
+      */
     sbColorPrimary: string;
     /**
-     Primary color used for disabled elements.
-     @defaultValue "#F5F5F5";
-     */
+      Primary color used for disabled elements.
+      @defaultValue "#F5F5F5";
+      */
     sbColorPrimaryDisabled: string;
     /**
-     Color used to convey a negative meaning.
-     @defaultValue "#FF3737";
-     */
+      Color used to convey a negative meaning.
+      @defaultValue "#FF3737";
+      */
     sbColorNegative: string;
     /**
-     Color used to convey a positive meaning.
-     @defaultValue "#4EFFB4";
-     */
+      Color used to convey a positive meaning.
+      @defaultValue "#4EFFB4";
+      */
     sbColorPositive: string;
     /**
-     Color used to convey warnings.
-     @defaultValue "#FFCE5C";
-     */
+      Color used to convey warnings.
+      @defaultValue "#FFCE5C";
+      */
     sbColorWarning: string;
     /**
-     Secondary color used for enabled elements.
-     @defaultValue "#FFEDEE";
-     */
+      Secondary color used for enabled elements.
+      @defaultValue "#FFEDEE";
+      */
     sbColorSecondary: string;
     /**
-     Secondary color used for disabled elements.
-     @defaultValue "#F5F5F5";
-     */
+      Secondary color used for disabled elements.
+      @defaultValue "#F5F5F5";
+      */
     sbColorSecondaryDisabled: string;
     /**
-     Color used for displaying elements on top of the primary color.
-     @defaultValue "#FFFFFF";
-     */
+      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";
-     */
+      Color used for displaying elements on top of the secondary color.
+      @defaultValue "#C8193C";
+      */
     sbColorOnSecondary: string;
     /**
-     Color used for surfaces.
-     @defaultValue "#FFFFFF";
-     */
+      Color used for surfaces.
+      @defaultValue "#FFFFFF";
+      */
     sbColorSurface: string;
     /**
-     Color used for outlines.
-     @defaultValue "#EFEFEF";
-     */
+      Color used for outlines.
+      @defaultValue "#EFEFEF";
+      */
     sbColorOutline: string;
     /**
-     Alternative color used on top of surfaces.
-     @defaultValue "#707070";
-     */
+      Alternative color used on top of surfaces.
+      @defaultValue "#707070";
+      */
     sbColorOnSurfaceVariant: string;
     /**
-     Color used on top of surfaces.
-     @defaultValue "#000000";
-     */
+      Color used on top of surfaces.
+      @defaultValue "#000000";
+      */
     sbColorOnSurface: string;
     /**
-     Transparent color with a low alpha value used for certain surfaces.
-     @defaultValue "#00000026";
-     */
+      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";
-     */
+      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";
-     */
+      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.
- */
+Configuration of the text field appearance.
+*/
 export declare class StyledText extends PartiallyConstructible {
     /**
-     Whether the text field is visible.
-     @defaultValue true;
-     */
+      Whether the text field is visible.
+      @defaultValue true;
+      */
     visible: boolean;
     /**
-     Value of the text field.
-     @defaultValue "";
-     */
+      Value of the text field.
+      @defaultValue "";
+      */
     text: string;
     /**
-     Text color.
-     @defaultValue "#FFFFFF";
-     */
+      Text color.
+      @defaultValue "#FFFFFF";
+      */
     color: string;
     /**
-     Whether to enable drop shadows for the text.
-     @defaultValue false;
-     */
+      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.
- */
+Configuration of the icon appearance.
+*/
 export declare class IconStyle extends PartiallyConstructible {
     /**
-     Whether the icon is visible on the button.
-     @defaultValue true;
-     */
+      Whether the icon is visible on the button.
+      @defaultValue true;
+      */
     visible: boolean;
     /**
-     Icon color.
-     @defaultValue "#FFFFFF";
-     */
+      Icon color.
+      @defaultValue "#FFFFFF";
+      */
     color: string;
     /** @param source {@displayType `DeepPartial<IconStyle>`} */
     constructor(source?: DeepPartial<IconStyle>);
 }
 /**
- Configuration of the polygon appearance.
- */
+Configuration of the polygon appearance.
+*/
 export declare class PolygonStyle extends PartiallyConstructible {
     /**
-     Color of the polygon outline.
-     @defaultValue "#FFFFFFFF";
-     */
+      Color of the polygon outline.
+      @defaultValue "#FFFFFFFF";
+      */
     strokeColor: string;
     /**
-     Polygon color.
-     @defaultValue "#30FFFFFF";
-     */
+      Polygon color.
+      @defaultValue "#FFFFFF30";
+      */
     fillColor: string;
     /**
-     Width of the polygon outline in dp.
-     @defaultValue 2.0;
-     */
+      Width of the polygon outline in dp.
+      @defaultValue 2.0;
+      */
     strokeWidth: number;
     /**
-     Polygon corner radius in dp.
-     @defaultValue 0.0;
-     */
+      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.
- */
+Appearance of the polygon used for buttons and hint backgrounds.
+*/
 export declare class BackgroundStyle extends PartiallyConstructible {
     /**
-     Color of the polygon outline.
-     @defaultValue "#FFFFFFFF";
-     */
+      Color of the polygon outline.
+      @defaultValue "#FFFFFFFF";
+      */
     strokeColor: string;
     /**
-     Polygon color.
-     @defaultValue "#FFFFFF30";
-     */
+      Polygon color.
+      @defaultValue "#FFFFFF30";
+      */
     fillColor: string;
     /**
-     Width of the polygon outline in dp.
-     @defaultValue 2.0;
-     */
+      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).
- */
+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;
-     */
+      Whether the icon is visible.
+      @defaultValue true;
+      */
     iconVisible: boolean;
     /**
-     Color used for foreground elements.
-     @defaultValue "#FFFFFF";
-     */
+      Color used for foreground elements.
+      @defaultValue "#FFFFFF";
+      */
     color: string;
     /**
-     Whether to use drop shadows for foreground elements.
-     @defaultValue false;
-     */
+      Whether to use drop shadows for foreground elements.
+      @defaultValue false;
+      */
     useShadow: boolean;
     /** @param source {@displayType `DeepPartial<ForegroundStyle>`} */
     constructor(source?: DeepPartial<ForegroundStyle>);
 }
 /**
- Configuration of the finder's aspect ratio.
- */
-export declare class AspectRatio extends PartiallyConstructible {
-    /**
-     Width component of the aspect ratio.
-     @defaultValue 1.0;
-     */
-    width: number;
-    /**
-     Height component of the aspect ratio.
-     @defaultValue 1.0;
-     */
-    height: number;
-    /** @param source {@displayType `DeepPartial<AspectRatio>`} */
-    constructor(source?: DeepPartial<AspectRatio>);
-}
-/**
- Configuration of the round button.
- */
+Configuration of the round button.
+*/
 export declare class RoundButton extends PartiallyConstructible {
     /**
-     Whether to display the button.
-     @defaultValue true;
-     */
+      Whether to display the button.
+      @defaultValue true;
+      */
     visible: boolean;
     /**
-     Color of the button background shape.
-     @defaultValue "#0000007A";
-     */
+      Color of the button background shape.
+      @defaultValue "#0000007A";
+      */
     backgroundColor: string;
     /**
-     Color of the button foreground (icon, text).
-     @defaultValue "#FFFFFF";
-     */
+      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";
-     */
+      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";
-     */
+      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.
- */
+Configuration of the round button with badge.
+*/
 export declare class BadgedButton extends PartiallyConstructible {
     /**
-     Color of the badge's background shape.
-     @defaultValue "#FFFFFF";
-     */
+      Color of the badge's background shape.
+      @defaultValue "#FFFFFF";
+      */
     badgeBackgroundColor: string;
     /**
-     Color of the badge foreground (icon, text).
-     @defaultValue "#C8193C";
-     */
+      Color of the badge foreground (icon, text).
+      @defaultValue "#C8193C";
+      */
     badgeForegroundColor: string;
     /**
-     Whether the button is visible.
-     @defaultValue true;
-     */
+      Whether the button is visible.
+      @defaultValue true;
+      */
     visible: boolean;
     /**
-     Color of the button background shape.
-     @defaultValue "#0000007A";
-     */
+      Color of the button background shape.
+      @defaultValue "#0000007A";
+      */
     backgroundColor: string;
     /**
-     Color of the button foreground (icon, text).
-     @defaultValue "#FFFFFF";
-     */
+      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";
-     */
+      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";
-     */
+      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.
- */
+Button configuration.
+*/
 export declare class ButtonConfiguration extends PartiallyConstructible {
     /**
-     Whether the button is visible or not.
-     @defaultValue true;
-     */
+      Whether the button is visible or not.
+      @defaultValue true;
+      */
     visible: boolean;
     /**
-     The text to be displayed on the button.
-     @defaultValue "";
-     */
+      The text to be displayed on the button.
+      @defaultValue "";
+      */
     text: string;
     /**
-     The style of the button's background.
-     @defaultValue new BackgroundStyle({});
-     */
+      The style of the button's background.
+      @defaultValue new BackgroundStyle({});
+      */
     background: BackgroundStyle;
     /**
-     The style of the button's foreground (icon, text).
-     @defaultValue new ForegroundStyle({});
-     */
+      The style of the button's foreground (icon, text).
+      @defaultValue new ForegroundStyle({});
+      */
     foreground: ForegroundStyle;
     /** @param source {@displayType `DeepPartial<ButtonConfiguration>`} */
     constructor(source?: DeepPartial<ButtonConfiguration>);
 }
 /**
- Configure the orientation of the interface.
-
- - `NONE`:
- Do not restrict the interface's orientation.
- - `PORTRAIT`:
- Lock the orientation to portrait.
- - `LANDSCAPE`:
- Lock the orientation to landscape.
- */
-export type OrientationLockMode = "NONE" | "PORTRAIT" | "LANDSCAPE";
-/**
- Configuration of the camera preview mode.
-
- - `FIT_IN`:
- In this mode, the camera preview frames will be scaled to the layout view size - the full preview frame content will be visible, but unused edges might appear in the preview layout.
- - `FILL_IN`:
- In this mode, the camera preview frames fill the layout view - the preview frames may contain additional content on the edges that was not visible in the preview layout.
- */
-export type CameraPreviewMode = "FIT_IN" | "FILL_IN";
-/**
- The sound selection type.
+The sound selection type.
 
- - `MODERN_BEEP`:
- To choose a modern beep sound.
- - `CLASSIC_BEEP`:
- To choose the old classic beep sound.
- */
+- `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.
- */
+Sound configuration.
+*/
 export declare class Sound extends PartiallyConstructible {
     /**
-     Enable or disable the beep sound when a barcode is detected.
-     @defaultValue true;
-     */
+      Enable or disable the beep sound when a barcode is detected.
+      @defaultValue true;
+      */
     successBeepEnabled: boolean;
     /**
-     The beep type.
-     @defaultValue "MODERN_BEEP";
-     */
+      The beep type.
+      @defaultValue "MODERN_BEEP";
+      */
     soundType: SoundType;
     /** @param source {@displayType `DeepPartial<Sound>`} */
     constructor(source?: DeepPartial<Sound>);
 }
 /**
- Vibration configuration.
- */
+Vibration configuration.
+*/
 export declare class Vibration extends PartiallyConstructible {
     /**
-     Enable or disable vibration when a barcode is detected.
-     @defaultValue false;
-     */
+      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.
- */
+Configuration of timeouts.
+*/
 export declare class Timeouts extends PartiallyConstructible {
     /**
-     Sets the auto close timer in ms. Default is 0 (disabled).
-     @defaultValue 0;
-     */
+      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;
-     */
+      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/CommonFieldType.d.ts

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