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

package/@types/ui2/{views → barcode/views}/drawer/subviews/barcode-list.d.ts

@@ -1,6 +1,6 @@
 import React from "react";
 import { CountedBarcode, CountedBarcodeAction } from "../../../model/counted-barcodes";
-import { ExpectedBarcode, MultipleBarcodesScanningMode, SheetContent } from "../../../configuration";
+import { ExpectedBarcode, MultipleBarcodesScanningMode, SheetContent } from "../../../../configuration";
 interface Props {
     barcodes: CountedBarcode[];
     expectedBarcodes?: ExpectedBarcode[];

package/@types/ui2/{views → barcode/views}/drawer/subviews/drawer-header-content.d.ts

@@ -1,6 +1,6 @@
 import React from "react";
 import { ButtonProps } from "../../../utils/styled-button";
-import { StyledText as StyledTextConfig } from "../../../configuration/Common";
+import { StyledText as StyledTextConfig } from "../../../../configuration/barcode/Common";
 export declare class DrawerHeaderContentProps {
     textReplacementArgs: string[];
     leftButton: ButtonProps;

package/@types/ui2/{views → barcode/views}/drawer/subviews/swipe-underlay.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-import { SwipeToDelete } from "../../../configuration";
+import { SwipeToDelete } from "../../../../configuration";
 export declare class Props {
     visibleOffset: number;
     config: SwipeToDelete;

package/@types/ui2/{views → barcode/views}/form/dialog-button.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-import { ButtonConfiguration } from "../../configuration";
+import { ButtonConfiguration } from "../../../configuration";
 import { ButtonProps } from "@mui/material/Button/Button";
 import { SvgIconComponent } from "@mui/icons-material";
 declare class Props extends ButtonConfiguration {
@@ -7,6 +7,9 @@ declare class Props extends ButtonConfiguration {
     onClick: () => void;
     style: React.CSSProperties;
     type?: ButtonProps['type'];
+    disabled?: boolean;
+    debugName?: string;
+    ariaLabel?: string;
 }
 export declare function DialogButton(props: Props): React.JSX.Element;
 export {};

package/@types/ui2/{views → barcode/views}/navigation-bar.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-import { TopBarConfiguration } from "../configuration/TopBarConfiguration";
+import { TopBarConfiguration } from "../../configuration/barcode/TopBarConfiguration";
 declare class Props extends TopBarConfiguration {
     onBackPress: () => void;
     children: React.ReactNode;

package/@types/ui2/{views → barcode/views}/styled-text.d.ts

@@ -1,9 +1,10 @@
 import React, { Ref } from "react";
-import { StyledText as StyledTextConfig } from "../configuration";
+import { StyledText as StyledTextConfig } from "../../configuration";
 export declare class Props {
     style?: React.CSSProperties;
     config: StyledTextConfig;
     innerRef?: Ref<HTMLSpanElement>;
+    replacementArgs?: string[];
 }
 export declare function styledTextStyle(config: {
     color: string;

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

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

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

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

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

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

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

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

package/@types/ui2/configuration/{ActionBarConfiguration.d.ts → barcode/ActionBarConfiguration.d.ts}

@@ -1,4 +1,4 @@
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { RoundButton } from "./Common";
 /**
 Configuration of the buttons available in the action bar.

package/@types/ui2/configuration/{ArTrackingOverlayConfiguration.d.ts → barcode/ArTrackingOverlayConfiguration.d.ts}

@@ -1,5 +1,5 @@
 import { BackgroundStyle } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { PolygonStyle } from "./Common";
 import { StyledText } from "./Common";
 /**

package/@types/ui2/configuration/{BarcodeInfoMapping.d.ts → barcode/BarcodeInfoMapping.d.ts}

@@ -1,6 +1,6 @@
 import { BarcodeItemMapper } from "./BarcodeItemMapper";
 import { ButtonConfiguration } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { StyledText } from "./Common";
 /**
 Configuration of the the mapper's error dialog.

package/@types/ui2/configuration/{BarcodeRecognizerConfiguration.d.ts → barcode/BarcodeRecognizerConfiguration.d.ts}

@@ -1,7 +1,7 @@
 import { BarcodeFormat } from "./BarcodeTypes";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { BarcodeScannerEngineMode } from "./BarcodeScannerTypes";
-import { GS1Handling } from "./BarcodeTypes";
+import { Gs1Handling } from "./BarcodeTypes";
 /**
 Expected quantity of QR codes in an image.
 
@@ -40,7 +40,7 @@ export declare class BarcodeRecognizerConfiguration extends PartiallyConstructib
       The expected way of handling GS1_COMPOSITE barcodes.
       @defaultValue "PARSE";
       */
-    gs1Handling: GS1Handling;
+    gs1Handling: Gs1Handling;
     /**
       The engine mode to use for barcode recognition.
       @defaultValue "NEXT_GEN_LOW_POWER";

package/@types/ui2/configuration/{BarcodeScannerConfiguration.d.ts → barcode/BarcodeScannerConfiguration.d.ts}

@@ -4,7 +4,7 @@ import { BarcodeTextLocalization } from "./BarcodeTextLocalization";
 import { BarcodeUseCase } from "./BarcodeUseCase";
 import { CameraConfiguration } from "./CameraConfiguration";
 import { CameraPermissionScreen } from "./CameraPermission";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { Palette } from "./Common";
 import { Sound } from "./Common";
 import { Timeouts } from "./Common";

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

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

package/@types/ui2/configuration/{BarcodeScannerUIResult.d.ts → barcode/BarcodeScannerUIResult.d.ts}

@@ -1,5 +1,5 @@
 import { BarcodeItem } from "./BarcodeScannerTypes";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 /**
 Data about the scanned barcode.
 */

package/@types/ui2/configuration/{BarcodeTextLocalization.d.ts → barcode/BarcodeTextLocalization.d.ts}

@@ -1,4 +1,4 @@
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 /**
 Configuration of the all strings for barcode scanner.
 */

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

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

package/@types/ui2/configuration/{CameraConfiguration.d.ts → barcode/CameraConfiguration.d.ts}

@@ -1,4 +1,4 @@
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 /**
 Ideal resolution of the camera preview.
 */

package/@types/ui2/configuration/{CameraPermission.d.ts → barcode/CameraPermission.d.ts}

@@ -1,5 +1,5 @@
 import { ButtonConfiguration } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { IconStyle } from "./Common";
 import { StyledText } from "./Common";
 /**

package/@types/ui2/configuration/{Common.d.ts → barcode/Common.d.ts}

@@ -1,4 +1,4 @@
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 /**
 Value palette describing the colors of the scanner screens.
 */

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

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

package/@types/ui2/configuration/{FindAndPickScanningModeUseCase.d.ts → barcode/FindAndPickScanningModeUseCase.d.ts}

@@ -1,5 +1,5 @@
 import { ArOverlayFindAndPickConfiguration } from "./ArTrackingOverlayConfiguration";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { ManualCountEditDialog } from "./MultipleScanningModeUseCase";
 import { ScanbotAlertDialog } from "./ScanbotAlertDialog";
 import { SheetContent } from "./MultipleScanningModeUseCase";

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

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

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

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

package/@types/ui2/configuration/{MultipleScanningModeUseCase.d.ts → barcode/MultipleScanningModeUseCase.d.ts}

@@ -2,7 +2,7 @@ import { ArOverlayGeneralConfiguration } from "./ArTrackingOverlayConfiguration"
 import { BadgedButton } from "./Common";
 import { BarcodeInfoMapping } from "./BarcodeInfoMapping";
 import { ButtonConfiguration } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { IconStyle } from "./Common";
 import { StyledText } from "./Common";
 /**

package/@types/ui2/configuration/{ScanbotAlertDialog.d.ts → barcode/ScanbotAlertDialog.d.ts}

@@ -1,5 +1,5 @@
 import { ButtonConfiguration } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { StyledText } from "./Common";
 /**
 Configuration of the the standard alert dialog.

package/@types/ui2/configuration/{SingleScanningModeUseCase.d.ts → barcode/SingleScanningModeUseCase.d.ts}

@@ -1,7 +1,7 @@
 import { ArOverlayGeneralConfiguration } from "./ArTrackingOverlayConfiguration";
 import { BarcodeInfoMapping } from "./BarcodeInfoMapping";
 import { ButtonConfiguration } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { StyledText } from "./Common";
 /**
 Configuration of the single barcode scanning mode.

package/@types/ui2/configuration/{TopBarConfiguration.d.ts → barcode/TopBarConfiguration.d.ts}

@@ -1,5 +1,5 @@
 import { ButtonConfiguration } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { StyledText } from "./Common";
 /**
 Configuration of the top screen bar's appearance.

package/@types/ui2/configuration/{UserGuidanceConfiguration.d.ts → barcode/UserGuidanceConfiguration.d.ts}

@@ -1,5 +1,5 @@
 import { BackgroundStyle } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 import { StyledText } from "./Common";
 /**
 Configuration of the hint guiding users through the scanning process.

package/@types/ui2/configuration/{ViewFinderConfiguration.d.ts → barcode/ViewFinderConfiguration.d.ts}

@@ -1,5 +1,5 @@
 import { AspectRatio } from "./Geometry";
-import { DeepPartial, PartiallyConstructible } from "../common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
 /**
 Configuration of the scanning interface's viewfinder, serving as guidance to the user.
 */

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

@@ -0,0 +1,42 @@
+import { DeepPartial, PartiallyConstructible } from "../utils";
+import { RoundButton } from "../common/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/common/CameraConfiguration.d.ts

@@ -0,0 +1,60 @@
+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/common/CameraPermission.d.ts

@@ -0,0 +1,62 @@
+import { ButtonConfiguration } from "../common/Common";
+import { DeepPartial, PartiallyConstructible } from "../utils";
+import { IconStyle } from "../common/Common";
+import { StyledText } from "../common/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({
+              "strokeColor": "#00000000",
+              "fillColor": "#00000000",
+              "strokeWidth": 0.0
+          }),
+          "foreground": new ForegroundStyle({
+              "iconVisible": false,
+              "color": "?sbColorPrimary",
+              "useShadow": false
+          })
+      });
+      */
+    closeButton: ButtonConfiguration;
+    /**
+      Configuration of the camera permission request's title.
+      @defaultValue new StyledText({
+          "text": "Camera permission denied!",
+          "color": "?sbColorOnSurface"
+      });
+      */
+    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>);
+}