scanbot-web-sdk 2.12.1-alpha.1 → 2.13.0-alpha.1

package/@types/barcode-scanner-view.d.ts

@@ -1,19 +1,41 @@
 /// <reference types="react" />
 import { ScanbotCameraProps, ScanbotCameraState, ScannerView } from "./scanner-view";
 import { BarcodeScannerConfiguration } from "./model/configuration/barcode-scanner-configuration";
+import { BarcodeResult } from "./model/barcode/barcode-result";
 import { ViewFinder } from "./view/view-finder";
+import { Size } from "./utils/dto/Size";
+import { ShutterButtonAction } from "./view/shutter-button";
+import BarcodeCalculationPopup from "./view/barcode-calculation/barcode-calculation-popup";
+import AnimatedBarcodeSelectionOverlay from "./view/barcode-polygon/animated-barcode-selection-overlay";
+import BottomActionBar from "./view/action-bar/bottom-action-bar";
+import ScannedImageWithOverlay from "./view/barcode-calculation/scanned-image-with-overlay";
+import { ImageDataWrapper } from "./model/image-data-wrapper";
+import { Barcode } from "./model/barcode/barcode";
 export declare class BarcodeScannerProps extends ScanbotCameraProps {
     showFinder?: boolean;
 }
 export declare class BarcodeScannerState extends ScanbotCameraState {
     isFinderVisible?: boolean;
     zoom?: number;
+    action: ShutterButtonAction;
+    image?: string;
 }
 export default class BarcodeScannerView extends ScannerView<BarcodeScannerProps, BarcodeScannerState> {
     finder?: ViewFinder;
     shouldComputeSize: boolean;
     private _configuration;
     private paused;
+    finderRect: DOMRect | undefined;
+    recognition: {
+        imageData: ImageDataWrapper;
+        originalImage: any;
+        barcodeResult: BarcodeResult;
+    };
+    overlay?: AnimatedBarcodeSelectionOverlay | undefined;
+    popup: BarcodeCalculationPopup | undefined;
+    scannedImage: ScannedImageWithOverlay | undefined;
+    bottomActionBar: BottomActionBar | undefined;
+    readonly barcodes: Barcode[];
     constructor(props: BarcodeScannerProps);
     get configuration(): BarcodeScannerConfiguration;
     get enabled(): boolean;
@@ -34,6 +56,10 @@ export default class BarcodeScannerView extends ScannerView<BarcodeScannerProps,
     pause(): void;
     computeSize(): boolean;
     detect(): Promise<void>;
+    desiredRecognitionResolution: number | undefined;
+    setRecognitionResolution(resolution: number): void;
+    getResolution(): Promise<Size>;
+    private recognizeBarcodes;
     saveExtractedImageData(): void;
     setFinderVisible(isVisible: boolean): void;
     setZoom(zoom: number): void;

package/@types/model/barcode/barcode.d.ts

@@ -1,10 +1,13 @@
+import { Point } from "../../utils/dto/Point";
 import { BarcodeFormat } from "./barcode-format";
 export declare class Barcode {
     format: BarcodeFormat;
     text: string;
     parsedText: any;
     rawBytes: Uint8Array;
+    points: Point[];
     barcodeImage: Uint8Array;
-    constructor(format: BarcodeFormat, text: string, parsedText: string, bytes: Uint8Array, barcodeImage: Uint8Array);
+    constructor(format: BarcodeFormat, text: string, parsedText: string, bytes: Uint8Array, points: Point[], barcodeImage: Uint8Array);
+    equals(barcode: Barcode): unknown;
     static fromWorker(input: any): Barcode;
 }

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

@@ -3,6 +3,7 @@ import { BarcodeResult } from "../barcode/barcode-result";
 import { EngineMode } from "../barcode/engine-mode";
 import { BarcodeFormat } from "../barcode/barcode-format";
 import { ViewFinderConfiguration } from "./view-finder-configuration";
+import { SelectionOverlayConfiguration } from "./selection-overlay-configuration";
 export declare class BarcodeScannerConfiguration extends ScannerConfiguration {
     constructor();
     /**
@@ -10,15 +11,17 @@ export declare class BarcodeScannerConfiguration extends ScannerConfiguration {
      */
     captureDelay?: number;
     style?: ViewFinderConfiguration;
+    overlay?: SelectionOverlayConfiguration;
     engineMode?: EngineMode;
     barcodeFormats?: BarcodeFormat[];
     returnBarcodeImage?: boolean;
     showFinder?: boolean;
+    manualDetection?: boolean;
     /**
      * Digital zoom level of the video stream. Defaults to 1.0.
      * Please note that this is not the same as the optical zoom of the camera.
      */
-    zoom: number;
+    zoom?: number;
     /**
      */
     onBarcodesDetected?: (e: BarcodeResult) => void;

package/@types/model/configuration/base-configuration.d.ts

@@ -1,6 +1,14 @@
 export declare class BaseConfiguration {
     /**
-     * The container HTML element of Scanbot Web SDK camera. Required when calling any ScanbotSDK createScanner function
+     * The container HTML element of Scanbot Web SDK camera.
+     * Required when 'containerId' property is left undefined when calling any ScanbotSDK createScanner function.
+     * If both are provided, 'container' property takes precedence.
+     */
+    container?: HTMLElement;
+    /**
+     * The container HTML element id of Scanbot Web SDK camera.
+     * Required when 'container' property is left undefined when calling any ScanbotSDK createScanner function
+     * If both are provided, 'container' property takes precedence.
      */
     containerId?: string;
     static mapValues(source: any, destination: {

package/@types/model/configuration/selection-overlay-configuration.d.ts

@@ -0,0 +1,3 @@
+export declare class SelectionOverlayConfiguration {
+    visible?: boolean;
+}

package/@types/scanner-view.d.ts

@@ -13,6 +13,7 @@ export declare class ScanbotCameraState {
 }
 export declare abstract class ScannerView<P extends ScanbotCameraProps, S extends ScanbotCameraState> extends React.Component<P, S> {
     static DEFAULT_DETECTION_RESOLUTION: number;
+    static DETECTION_RESULTION_4K: number;
     camera: ScanbotCameraView | null;
     disposed?: boolean;
     get bridge(): import("./worker/worker-bridge").WorkerBridge;

package/@types/utils/colors.d.ts

@@ -0,0 +1,6 @@
+export default class Colors {
+    static ScanbotPrimary: string;
+    static Orange: string;
+    static White: string;
+    static TransparentGreen: string;
+}

package/@types/utils/date-utils.d.ts

@@ -0,0 +1,3 @@
+export default class DateUtils {
+    static now(): any;
+}

package/@types/utils/dto/Point.d.ts

@@ -6,10 +6,13 @@ export declare class Point {
     constructor(x: number, y: number);
     static toPolygon(points: Point[], size: Size): Polygon;
     static scaleToPoint(pt: Point, x: number, y: number, scale: number): Point;
+    static scaleListToImageElement(points: Point[], original: ImageData, html: HTMLImageElement): Point[];
+    static scaleToImageElement(point: Point, original: ImageData, html: HTMLImageElement): Point;
     static scaleUpTo(pt: Point, size: Size): Point;
     static scaleDownTo(pt: Point, size: Size): Point;
     static fromHtmlElement(element: HTMLElement): Point;
     static withScale(x: number, y: number, scale: number): Point;
     static fromCoordinates(clientX: any, clientY: any, rotations: number, scale: number): Point;
+    static centerOf(points: Point[]): Point;
     static empty(): Point;
 }

package/@types/utils/dto/Size.d.ts

@@ -9,6 +9,10 @@ export declare class Size {
     static isEmpty(size: Size): boolean;
     static toPolygon(size: Size): Point[];
     static fromHtmlElement(element: HTMLElement): Size;
+    static fromJson(json: {
+        width: number;
+        height: number;
+    }): Size;
     static subtractFrom(original: Size, amount: number): Size;
     static empty(): Size;
 }

package/@types/utils/image-utils.d.ts

@@ -6,6 +6,8 @@ export declare class ImageUtils {
     static getObjectFitSize(container: Size, size: Size, contains?: boolean): Frame;
     static loadFromUrl(imageURL: string): Promise<ImageData>;
     static saveImageData(data: ImageData): void;
+    static createImageDataCanvas(data: ImageData): HTMLCanvasElement;
     static saveBlob(blob: Blob, name: string): void;
     static convertImageDataWrapperToImageData(imageDataWrapper: ImageDataWrapper): ImageData;
+    static wrapperToBase64(wrapper: ImageDataWrapper): string;
 }

package/@types/utils/view-utils.d.ts

@@ -1,6 +1,7 @@
 import { MagneticLine } from "./dto/MagneticLine";
 import { Size } from "./dto/Size";
 import { Point } from "./dto/Point";
+import { ScannerConfiguration } from "../model/configuration/scanner-configuration";
 export declare class ViewUtils {
     static convertLinesToViewportLines(elementSize: Size, lines: MagneticLine[]): MagneticLine[];
     static convertToViewportPointsFromParentSize(elementSize: Size, points: any[]): Point[];
@@ -13,4 +14,5 @@ export declare class ViewUtils {
     private static preventDefaultCallback;
     static disableScreenMovement(): void;
     static enableScreenMovement(): void;
+    static findContainerOrThrow(configuration: ScannerConfiguration): HTMLElement;
 }

package/@types/view/action-bar/bottom-action-bar.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { Barcode } from "../../model/barcode/barcode";
+export default class BottomActionBar extends React.Component<any, any> {
+    constructor(props: any);
+    update(barcodes: Barcode[]): void;
+    didScan(): boolean;
+    render(): React.ReactNode;
+}

package/@types/view/barcode-calculation/barcode-calculation-popup-list-item.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+export default class BarcodeCalculationPopupListItem extends React.Component<any, any> {
+    constructor(props: any);
+    componentDidMount(): Promise<void>;
+    render(): React.ReactNode;
+}

package/@types/view/barcode-calculation/barcode-calculation-popup-list.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { Barcode } from "../../model/barcode/barcode";
+export default class BarcodeCalculationPopupList extends React.Component<any, any> {
+    constructor(props: any);
+    toUniqueListWithDuplicateCounter(barcodes: Barcode[]): Barcode[];
+    update(barcodes: any): void;
+    render(): React.ReactNode;
+}

package/@types/view/barcode-calculation/barcode-calculation-popup.d.ts

@@ -0,0 +1,32 @@
+import React, { CSSProperties } from "react";
+import { Barcode } from "../../model/barcode/barcode";
+import BarcodeCalculationPopupList from "./barcode-calculation-popup-list";
+export declare enum AnimationType {
+    None = 0,
+    PushRight = 1,
+    PushBottom = 2,
+    Pop = 3
+}
+export default class BarcodeCalculationPopup extends React.Component<any, any> {
+    list: BarcodeCalculationPopupList;
+    previousDestination?: string;
+    barcodes?: Barcode[];
+    constructor(props: any);
+    containerStyle(transform: string): CSSProperties;
+    render(): React.ReactNode;
+    reset(): void;
+    private _isVisible;
+    isVisible(): boolean;
+    push(type: AnimationType, barcodes: Barcode[]): void;
+    update(barcodes: Barcode[]): void;
+    pop(): void;
+    onAnimationStart(): void;
+    onAnimationEnd(): void;
+    pushType?: AnimationType;
+    updateAnimationType(type: AnimationType, callback?: any): void;
+    animation(type: AnimationType): import("styled-components").StyledComponent<"div", any, {}, never>;
+    from(type: AnimationType): string;
+    to(type: AnimationType): string;
+    translate(axis: "X" | "Y", percentage: number): string;
+    componentWillUnmount(): void;
+}

package/@types/view/barcode-calculation/scanned-image-with-overlay.d.ts

@@ -0,0 +1,12 @@
+import React, { ReactNode } from "react";
+import BarcodeSelectionOverlay from "../barcode-polygon/barcode-selection-overlay";
+import { BarcodeResult } from "../../model/barcode/barcode-result";
+export default class ScannedImageWithOverlay extends React.Component<any, any> {
+    image: HTMLImageElement | undefined;
+    polygons: BarcodeSelectionOverlay[];
+    overlay: BarcodeSelectionOverlay;
+    constructor(props: any);
+    update(result: BarcodeResult): void;
+    reset(): void;
+    render(): ReactNode;
+}

package/@types/view/barcode-calculation/styled-spinner.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare const Spinner: () => JSX.Element;
+export default Spinner;

package/@types/view/barcode-polygon/animated-barcode-selection-overlay.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+import BarcodeSelectionOverlay from "./barcode-selection-overlay";
+import ScanbotCameraView from "../scanbot-camera-view";
+import { ImageDataWrapper } from "../../model/image-data-wrapper";
+import { Barcode } from "../../model/barcode/barcode";
+export default class AnimatedBarcodeSelectionOverlay extends React.Component<any, any> {
+    overlay: BarcodeSelectionOverlay | undefined;
+    constructor(props: any);
+    update(finderRect: DOMRect, camera: ScanbotCameraView, imageData: ImageDataWrapper, container: any, codes: Barcode[]): void;
+    render(): React.ReactNode;
+}

package/@types/view/barcode-polygon/barcode-overlay.d.ts

@@ -0,0 +1,9 @@
+import { Barcode } from "../../model/barcode/barcode";
+import { Point } from "../../utils/dto/Point";
+export declare class BarcodeOverlay {
+    base64Image?: string;
+    code: Barcode;
+    points: Point[];
+    highlighted: boolean;
+    constructor(barcode: Barcode);
+}

package/@types/view/barcode-polygon/barcode-selection-overlay.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+import BarcodePolygon from "./barocode-polygon";
+import { BarcodeOverlay } from "./barcode-overlay";
+export declare class BarcodeSelectionOverlayProps {
+    elements: BarcodeOverlay[];
+}
+export default class BarcodeSelectionOverlay extends React.Component<any, any> {
+    interval: number;
+    update(elements: BarcodeOverlay[]): void;
+    polygons: BarcodePolygon[];
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    startTimer(): void;
+    onTimerElapsed(): void;
+    constructor(props: any);
+    render(): JSX.Element;
+}

package/@types/view/barcode-polygon/barocode-polygon.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { BarcodeOverlay } from "./barcode-overlay";
+export declare class BarcodePolygonProps {
+    element: BarcodeOverlay;
+    onClick?: (e: any, element: BarcodeOverlay) => void;
+}
+export default class BarcodePolygon extends React.Component<BarcodePolygonProps, any> {
+    updatedAt: number;
+    render(): React.ReactNode;
+}

package/@types/view/scanbot-camera-view.d.ts

@@ -28,6 +28,7 @@ export default class ScanbotCameraView extends React.Component<ScanbotCameraView
     reloadCanvas: boolean;
     swapCameraEnabled: boolean;
     private activeCamera;
+    didLoadVideo: any;
     constructor(props: any);
     videoSize(): {
         width: number;

package/@types/view/shutter-button.d.ts

@@ -5,6 +5,7 @@ export declare class ShutterButtonProps {
     color: string;
     action: ShutterButtonAction;
     onClick: any;
+    style?: any;
 }
 declare class AnimationSynchronizer {
     lastTime: number;

package/@types/view/utils/capturing-loader.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+export default class CapturingLoader extends React.Component<any, any> {
+    render(): React.ReactNode;
+}

package/@types/view/utils/icons/bullets-burger.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+export default class BulletsBurger extends React.Component<any, any> {
+    render(): React.ReactNode;
+}

package/@types/view/utils/icons/check-circle.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+export default class CheckCircle extends React.Component<any, any> {
+    render(): React.ReactNode;
+}

package/@types/view/utils/icons/replay.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+export default class Replay extends React.Component<any, any> {
+    render(): React.ReactNode;
+}

package/@types/view/view-finder.d.ts

@@ -5,6 +5,7 @@ import { Point } from "../utils/dto/Point";
 import { ViewFinderConfiguration } from "../model/configuration/view-finder-configuration";
 declare class ViewFinderProps {
     configuration: ViewFinderConfiguration;
+    onSizeChanged?: (rect: DOMRect) => void;
 }
 declare enum ClipDirection {
     Right = 0,