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

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

@@ -1,95 +1,95 @@
 import { BarcodeItemMapper } from "./BarcodeItemMapper";
 import { ButtonConfiguration } from "./Common";
-import { DeepPartial, PartiallyConstructible } from "./utils";
+import { DeepPartial, PartiallyConstructible } from "../common";
 import { StyledText } from "./Common";
 /**
- Configuration of the the mapper's error dialog.
- */
+Configuration of the the mapper's error dialog.
+*/
 export declare class BarcodeItemErrorState extends PartiallyConstructible {
     /**
-     Title displayed above the error message.
-     @defaultValue new StyledText({
-      "text": "Connection Error!",
-      "color": "?sbColorOnSurface"
+      Title displayed above the error message.
+      @defaultValue new StyledText({
+          "text": "Connection Error!",
+          "color": "?sbColorOnSurface"
       });
-     */
+      */
     title: StyledText;
     /**
-     Error message.
-     @defaultValue new StyledText({
-        "text": "There was an issue and the data requested was not fetched. You could try again or discard this result to start a new scan.",
-        "color": "?sbColorOnSurfaceVariant"
-    });
-     */
+      Error message.
+      @defaultValue new StyledText({
+          "text": "There was an issue and the data requested was not fetched. You could try again or discard this result to start a new scan.",
+          "color": "?sbColorOnSurfaceVariant"
+      });
+      */
     subtitle: StyledText;
     /**
-     Configuration of the retry button.
-     @defaultValue new ButtonConfiguration({});
-     */
+      Configuration of the retry button.
+      @defaultValue new ButtonConfiguration({});
+      */
     retryButton: ButtonConfiguration;
     /**
-     Configuration of the cancel button.
-     @defaultValue new ButtonConfiguration({});
-     */
+      Configuration of the cancel button.
+      @defaultValue new ButtonConfiguration({});
+      */
     cancelButton: ButtonConfiguration;
     /** @param source {@displayType `DeepPartial<BarcodeItemErrorState>`} */
     constructor(source?: DeepPartial<BarcodeItemErrorState>);
 }
 /**
- Format of the mapped barcode data.
- */
+Format of the mapped barcode data.
+*/
 export declare class BarcodeMappedData extends PartiallyConstructible {
     /**
-     Title of the barcode.
-     */
+      Title of the barcode.
+      */
     title: string;
     /**
-     Subtitle of the barcode.
-     */
+      Subtitle of the barcode.
+      */
     subtitle: string;
     /**
-     Image of the barcode.
-     */
+      Image of the barcode.
+      */
     barcodeImage: string;
     /** @param source {@displayType `DeepPartial<BarcodeMappedData>`} */
     constructor(source?: DeepPartial<BarcodeMappedData>);
 }
 /**
- Configuration of the barcode data mapping.
- */
+Configuration of the barcode data mapping.
+*/
 export declare class BarcodeInfoMapping extends PartiallyConstructible {
     /**
-     Callback to map the barcode data to the data of the corresponding product.
-     @defaultValue null;
-     */
+      Callback to map the barcode data to the data of the corresponding product.
+      @defaultValue null;
+      */
     barcodeItemMapper: BarcodeItemMapper | null;
     /**
-     Background color of the barcode info dialog.
-     @defaultValue "?sbColorSurface";
-     */
+      Background color of the barcode info dialog.
+      @defaultValue "?sbColorSurface";
+      */
     sheetColor: string;
     /**
-     Color of the divider and separator lines in the barcode info dialog.
-     @defaultValue "?sbColorOutline";
-     */
+      Color of the divider and separator lines in the barcode info dialog.
+      @defaultValue "?sbColorOutline";
+      */
     dividerColor: string;
     /**
-     Background color of the overlay surrounding the barcode mapping error dialog.
-     @defaultValue "?sbColorModalOverlay";
-     */
+      Background color of the overlay surrounding the barcode mapping error dialog.
+      @defaultValue "?sbColorModalOverlay";
+      */
     modalOverlayColor: string;
     /**
-     Text being displayed while a barcode is being mapped.
-     @defaultValue new StyledText({
-        "text": "Loading message for barcode info mapping.",
-        "color": "?sbColorPrimary"
-    });
-     */
+      Text being displayed while a barcode is being mapped.
+      @defaultValue new StyledText({
+          "text": "Loading message for barcode info mapping.",
+          "color": "?sbColorPrimary"
+      });
+      */
     loadingMessage: StyledText;
     /**
-     Configuration of the error state displayed when processing a barcode fails.
-     @defaultValue new BarcodeItemErrorState({});
-     */
+      Configuration of the error state displayed when processing a barcode fails.
+      @defaultValue new BarcodeItemErrorState({});
+      */
     errorState: BarcodeItemErrorState;
     /** @param source {@displayType `DeepPartial<BarcodeInfoMapping>`} */
     constructor(source?: DeepPartial<BarcodeInfoMapping>);

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

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

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

@@ -1,55 +1,55 @@
 import { BarcodeFormat } from "./BarcodeTypes";
-import { DeepPartial, PartiallyConstructible } from "./utils";
+import { DeepPartial, PartiallyConstructible } from "../common";
 import { EngineMode } from "./BarcodeScannerTypes";
 import { GS1Handling } from "./BarcodeTypes";
 /**
- Expected quantity of QR codes in an image.
+Expected quantity of QR codes in an image.
 
- - `LOW`:
- Up to 6 QR codes per image.
- - `HIGH`:
- Up to 24 QR codes per image.
- */
+- `LOW`:
+   Up to 6 QR codes per image.
+- `HIGH`:
+   Up to 24 QR codes per image.
+*/
 export type CodeDensity = "LOW" | "HIGH";
 /**
- Filter for extended EAN and UPC barcodes.
+Filter for extended EAN and UPC barcodes.
 
- - `NO_FILTER`:
- EAN and UPC codes are not filtered. Both are returned regardless if they have an extension or not.
- - `ONLY_WITH_EXTENSIONS`:
- Only EAN and UPC codes with extensions are returned.
- - `ONLY_WITHOUT_EXTENSIONS`:
- Only EAN and UPC codes without extensions are returned.
- */
+- `NO_FILTER`:
+   EAN and UPC codes are not filtered. Both are returned regardless if they have an extension or not.
+- `ONLY_WITH_EXTENSIONS`:
+   Only EAN and UPC codes with extensions are returned.
+- `ONLY_WITHOUT_EXTENSIONS`:
+   Only EAN and UPC codes without extensions are returned.
+*/
 export type BarcodesExtensionFilter = "NO_FILTER" | "ONLY_WITH_EXTENSIONS" | "ONLY_WITHOUT_EXTENSIONS";
 /**
- Configuration of the scanning behavior.
- */
+Configuration of the scanning behavior.
+*/
 export declare class BarcodeRecognizerConfiguration extends PartiallyConstructible {
     /**
-     Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). This option overrides `barcodesExtensionFilter` option.
-     @defaultValue "";
-     */
+      Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). This option overrides `barcodesExtensionFilter` option.
+      @defaultValue "";
+      */
     barcodesRegexFilter: string;
     /**
-     List of accepted barcode symbologies.
-     @defaultValue [];
-     */
+      List of accepted barcode symbologies.
+      @defaultValue [];
+      */
     barcodeFormats: BarcodeFormat[];
     /**
-     The expected way of handling GS1_COMPOSITE barcodes.
-     @defaultValue "PARSE";
-     */
+      The expected way of handling GS1_COMPOSITE barcodes.
+      @defaultValue "PARSE";
+      */
     gs1Handling: GS1Handling;
     /**
-     The engine mode to use for barcode recognition.
-     @defaultValue "NEXT_GEN_LOW_POWER";
-     */
+      The engine mode to use for barcode recognition.
+      @defaultValue "NEXT_GEN_LOW_POWER";
+      */
     engineMode: EngineMode;
     /**
-     Maximum resolution of the image processed by the barcode recognizer. Smaller values mean faster processing but lower recognition quality. The value is limited by the resolution of the preview.
-     @defaultValue 600;
-     */
+      Maximum resolution of the image processed by the barcode recognizer. Smaller values mean faster processing but lower recognition quality. The value is limited by the resolution of the preview.
+      @defaultValue 600;
+      */
     maximumRecognizerResolution: number;
     /** @param source {@displayType `DeepPartial<BarcodeRecognizerConfiguration>`} */
     constructor(source?: DeepPartial<BarcodeRecognizerConfiguration>);

package/@types/ui2/configuration/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 "./utils";
+import { DeepPartial, PartiallyConstructible } from "../common";
 import { Palette } from "./Common";
 import { Sound } from "./Common";
 import { Timeouts } from "./Common";
@@ -13,208 +13,208 @@ import { UserGuidanceConfiguration } from "./UserGuidanceConfiguration";
 import { Vibration } from "./Common";
 import { ViewFinderConfiguration } from "./ViewFinderConfiguration";
 /**
- Configuration of the barcode scanner screen.
- */
+Configuration of the barcode scanner screen.
+*/
 export declare class BarcodeScannerConfiguration extends PartiallyConstructible {
     /**
-     Version number of the configuration object.
-     @defaultValue "1.0";
-     */
+      Version number of the configuration object.
+      @defaultValue "1.0";
+      */
     readonly version: string;
     /**
-     The configuration object should be applied for this screen.
-     @defaultValue "BarcodeScanner";
-     */
+      The configuration object should be applied for this screen.
+      @defaultValue "BarcodeScanner";
+      */
     readonly 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"
-    });
-     */
+      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 the all strings for barcode scanner.
-     @defaultValue new BarcodeTextLocalization({});
-     */
+      Configuration of the all strings for barcode scanner.
+      @defaultValue new BarcodeTextLocalization({});
+      */
     localization: BarcodeTextLocalization;
     /**
-     Color of the screen's background.
-     @defaultValue "?sbColorSurfaceLow";
-     */
+      Color of the screen's background.
+      @defaultValue "?sbColorSurfaceLow";
+      */
     backgroundColor: string;
     /**
-     Configuration of the top bar.
-     @defaultValue new TopBarConfiguration({
-        "title": new StyledText({
-            "text": "?topBarTitle",
-            "color": "?sbColorOnPrimary"
-        }),
-        "mode": "SOLID",
-        "backgroundColor": "?sbColorPrimary",
-        "cancelButton": new ButtonConfiguration({
-            "visible": true,
-            "text": "?topBarCancelButton",
-            "background": new BackgroundStyle({
-                "strokeColor": "#00000000",
-                "fillColor": "#00000000",
-                "strokeWidth": 0.0
-            }),
-      "foreground": new ForegroundStyle({
-      "iconVisible": true,
-      "color": "?sbColorOnPrimary",
-      "useShadow": false
-      })
-        })
-    });
-     */
+      Configuration of the top bar.
+      @defaultValue new TopBarConfiguration({
+          "title": new StyledText({
+              "text": "?topBarTitle",
+              "color": "?sbColorOnPrimary"
+          }),
+          "mode": "SOLID",
+          "backgroundColor": "?sbColorPrimary",
+          "cancelButton": new ButtonConfiguration({
+              "visible": true,
+              "text": "?topBarCancelButton",
+              "background": new BackgroundStyle({
+                  "strokeColor": "#00000000",
+                  "fillColor": "#00000000",
+                  "strokeWidth": 0.0
+              }),
+              "foreground": new ForegroundStyle({
+                  "iconVisible": true,
+                  "color": "?sbColorOnPrimary",
+                  "useShadow": false
+              })
+          })
+      });
+      */
     topBar: TopBarConfiguration;
     /**
-     Configuration of the action bar.
-     @defaultValue new ActionBarConfiguration({
-        "flashButton": new RoundButton({
-            "visible": true,
-            "backgroundColor": "?sbColorSurfaceHigh",
-            "foregroundColor": "?sbColorOnPrimary",
-            "activeBackgroundColor": "?sbColorWarning",
-            "activeForegroundColor": "#1C1B1F"
-        }),
-        "zoomButton": new RoundButton({
-            "visible": true,
-            "backgroundColor": "?sbColorSurfaceHigh",
-            "foregroundColor": "?sbColorOnPrimary",
-            "activeBackgroundColor": "?sbColorSurfaceHigh",
-            "activeForegroundColor": "?sbColorOnPrimary"
-        }),
-        "flipCameraButton": new RoundButton({
-            "visible": true,
-            "backgroundColor": "?sbColorSurfaceHigh",
-            "foregroundColor": "?sbColorOnPrimary",
-            "activeBackgroundColor": "?sbColorSurfaceHigh",
-            "activeForegroundColor": "?sbColorOnPrimary"
-        })
-    });
-     */
+      Configuration of the action bar.
+      @defaultValue new ActionBarConfiguration({
+          "flashButton": new RoundButton({
+              "visible": true,
+              "backgroundColor": "?sbColorSurfaceHigh",
+              "foregroundColor": "?sbColorOnPrimary",
+              "activeBackgroundColor": "?sbColorWarning",
+              "activeForegroundColor": "#1C1B1F"
+          }),
+          "zoomButton": new RoundButton({
+              "visible": true,
+              "backgroundColor": "?sbColorSurfaceHigh",
+              "foregroundColor": "?sbColorOnPrimary",
+              "activeBackgroundColor": "?sbColorSurfaceHigh",
+              "activeForegroundColor": "?sbColorOnPrimary"
+          }),
+          "flipCameraButton": new RoundButton({
+              "visible": true,
+              "backgroundColor": "?sbColorSurfaceHigh",
+              "foregroundColor": "?sbColorOnPrimary",
+              "activeBackgroundColor": "?sbColorSurfaceHigh",
+              "activeForegroundColor": "?sbColorOnPrimary"
+          })
+      });
+      */
     actionBar: ActionBarConfiguration;
     /**
-     Configuration of the view finder.
-     @defaultValue new ViewFinderConfiguration({
-        "visible": true,
-        "style": new FinderCorneredStyle({
-            "strokeColor": "?sbColorSurface",
-            "strokeWidth": 2.0,
-            "cornerRadius": 10.0
-        }),
-        "overlayColor": "?sbColorSurfaceLow",
-      "aspectRatio": new AspectRatio({
-      "width": 1.0,
-      "height": 1.0
-      })
-    });
-     */
+      Configuration of the view finder.
+      @defaultValue new ViewFinderConfiguration({
+          "visible": true,
+          "style": new FinderCorneredStyle({
+              "strokeColor": "?sbColorSurface",
+              "strokeWidth": 2.0,
+              "cornerRadius": 10.0
+          }),
+          "overlayColor": "?sbColorSurfaceLow",
+          "aspectRatio": new AspectRatio({
+              "width": 1.0,
+              "height": 1.0
+          })
+      });
+      */
     viewFinder: ViewFinderConfiguration;
     /**
-     Configuration of the text hint guiding users to move the view finder over a barcode.
-     @defaultValue new UserGuidanceConfiguration({
-        "visible": true,
-      "title": new StyledText({
-      "text": "?userGuidance",
-      "color": "?sbColorOnPrimary"
-      }),
-        "background": new BackgroundStyle({
-            "strokeColor": "#00000000",
-            "fillColor": "?sbColorSurfaceLow",
-            "strokeWidth": 0.0
-        })
-    });
-     */
+      Configuration of the text hint guiding users to move the view finder over a barcode.
+      @defaultValue new UserGuidanceConfiguration({
+          "visible": true,
+          "title": new StyledText({
+              "text": "?userGuidance",
+              "color": "?sbColorOnPrimary"
+          }),
+          "background": new BackgroundStyle({
+              "strokeColor": "#00000000",
+              "fillColor": "?sbColorSurfaceLow",
+              "strokeWidth": 0.0
+          })
+      });
+      */
     userGuidance: UserGuidanceConfiguration;
     /**
-     Configuration of the dialog for requesting camera permissions.
-     @defaultValue new CameraPermissionScreen({
-        "background": "?sbColorSurface",
-        "iconBackground": "?sbColorOutline",
-      "icon": new IconStyle({
-      "visible": true,
-      "color": "?sbColorOnSurface"
-        }),
-        "closeButton": new ButtonConfiguration({
-            "visible": true,
-            "text": "?cameraPermissionCloseButton",
-            "background": new BackgroundStyle({
-                "strokeColor": "#00000000",
-                "fillColor": "#00000000",
-                "strokeWidth": 0.0
-            }),
-      "foreground": new ForegroundStyle({
-      "iconVisible": false,
-      "color": "?sbColorPrimary",
-      "useShadow": false
-      })
-        }),
-        "enableCameraTitle": new StyledText({
-            "text": "?cameraPermissionEnableCameraTitle",
-            "color": "?sbColorOnSurface"
-        }),
-        "enableCameraExplanation": new StyledText({
-            "text": "?cameraPermissionEnableCameraExplanation",
-            "color": "?sbColorOnSurfaceVariant"
-        })
-    });
-     */
+      Configuration of the dialog for requesting camera permissions.
+      @defaultValue new CameraPermissionScreen({
+          "background": "?sbColorSurface",
+          "iconBackground": "?sbColorOutline",
+          "icon": new IconStyle({
+              "visible": true,
+              "color": "?sbColorOnSurface"
+          }),
+          "closeButton": new ButtonConfiguration({
+              "visible": true,
+              "text": "?cameraPermissionCloseButton",
+              "background": new BackgroundStyle({
+                  "strokeColor": "#00000000",
+                  "fillColor": "#00000000",
+                  "strokeWidth": 0.0
+              }),
+              "foreground": new ForegroundStyle({
+                  "iconVisible": false,
+                  "color": "?sbColorPrimary",
+                  "useShadow": false
+              })
+          }),
+          "enableCameraTitle": new StyledText({
+              "text": "?cameraPermissionEnableCameraTitle",
+              "color": "?sbColorOnSurface"
+          }),
+          "enableCameraExplanation": new StyledText({
+              "text": "?cameraPermissionEnableCameraExplanation",
+              "color": "?sbColorOnSurfaceVariant"
+          })
+      });
+      */
     cameraPermission: CameraPermissionScreen;
     /**
-     Configuration of the camera behavior.
-     @defaultValue new CameraConfiguration({});
-     */
+      Configuration of the camera behavior.
+      @defaultValue new CameraConfiguration({});
+      */
     cameraConfiguration: CameraConfiguration;
     /**
-     Configuration of the scanning behavior.
-     @defaultValue new BarcodeRecognizerConfiguration({});
-     */
+      Configuration of the scanning behavior.
+      @defaultValue new BarcodeRecognizerConfiguration({});
+      */
     recognizerConfiguration: BarcodeRecognizerConfiguration;
     /**
-     Configuration of the barcode scanner screen's behavior.
-     @defaultValue new SingleScanningMode({});
-     */
+      Configuration of the barcode scanner screen's behavior.
+      @defaultValue new SingleScanningMode({});
+      */
     useCase: BarcodeUseCase;
     /**
-     Configuration of the scan confirmation sound.
-     @defaultValue new Sound({
-      "successBeepEnabled": true,
-      "soundType": "MODERN_BEEP"
+      Configuration of the scan confirmation sound.
+      @defaultValue new Sound({
+          "successBeepEnabled": true,
+          "soundType": "MODERN_BEEP"
       });
-     */
+      */
     sound: Sound;
     /**
-     Configuration of the scan scan confirmation vibration.
-     @defaultValue new Vibration({
-      "enabled": true
+      Configuration of the scan scan confirmation vibration.
+      @defaultValue new Vibration({
+          "enabled": true
       });
-     */
+      */
     vibration: Vibration;
     /**
-     Configuration of timeouts.
-     @defaultValue new Timeouts({
-      "autoCancelTimeout": 0,
-      "initialScanDelay": 0
+      Configuration of timeouts.
+      @defaultValue new Timeouts({
+          "autoCancelTimeout": 0,
+          "initialScanDelay": 0
       });
-     */
+      */
     timeouts: Timeouts;
     /** @param source {@displayType `DeepPartial<BarcodeScannerConfiguration>`} */
     constructor(source?: DeepPartial<BarcodeScannerConfiguration>);

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

@@ -1,6 +1 @@
-import { BarcodeItem } from "./BarcodeItem";
-export type { EngineMode } from "../../core/bridge/compiled/BarcodeScannerTypes";
-export declare class BarcodeScannerResult {
-    items: BarcodeItem[];
-    constructor(items: BarcodeItem[]);
-}
+export { BarcodeItem, type EngineMode, type BarcodeDocumentFormat, BarcodeDocumentFormats } from "../../core/bridge/compiled/BarcodeScannerTypes";