scanbot-web-sdk 3.0.1 → 3.1.0-alpha.1

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

@@ -19,10 +19,11 @@ export default class DocumentScannerView extends ScannerView<DocumentScannerProp
     polygonMovementPredicate: PolygonMovementPredicate;
     autoCaptureToken: any;
     private _configuration?;
-    constructor(props: ScanbotCameraProps);
+    constructor(props: DocumentScannerProps);
     get defaultAction(): ShutterButtonAction;
     get enabled(): boolean;
     get configuration(): DocumentScannerConfiguration;
+    get autoCaptureDelay(): number;
     /**
      * Public API functions
      */

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

@@ -18,9 +18,10 @@ declare class StyleConfiguration {
     outline?: OutlineStyleConfiguration;
     captureButton?: CaptureButtonStyleConfiguration;
 }
-declare class OutlineStyleConfiguration {
+export declare class OutlineStyleConfiguration {
     constructor();
     polygon?: OutlinePolygonStyleConfiguration;
+    path?: CaptureAnimationStyleConfiguration;
     label?: OutlineLabelStyleConfiguration;
 }
 export declare class OutlinePolygonStyleConfiguration {
@@ -30,6 +31,10 @@ export declare class OutlinePolygonStyleConfiguration {
     fillSearching?: string;
     strokeWidth?: any;
 }
+export declare class CaptureAnimationStyleConfiguration {
+    stroke?: string;
+    strokeWidth?: number;
+}
 declare class OutlineLabelStyleConfiguration {
     position?: any;
     top?: any;
@@ -74,6 +79,16 @@ export declare class DocumentScannerConfiguration extends ScannerConfiguration {
      * By default BadAspectRatio is not ignored.
      */
     ignoreBadAspectRatio?: boolean;
+    /**
+     * Attempts to take a single exposure using the video capture device,
+     * resulting in a high resolution image and potentially greatly improved detection quality.
+     * Relies on the experimental ImageCapture API that: https://developer.mozilla.org/en-US/docs/Web/API/ImageCapture.
+     * Use with caution. At the time of writing this, reliably only works on Android devices with Google Chrome.
+     * If enabled, this only affects extraction after the document outline has been identified.
+     * This may also trigger your device's default "snap" animation, making scanbotSDK.utils.flash(); irrelevant
+     * Defaults to false.
+     */
+    useImageCaptureAPI?: boolean;
     text?: TextConfiguration;
     style?: StyleConfiguration;
     /**

package/@types/service/ocr-engine.d.ts

@@ -6,7 +6,7 @@ export interface Rect {
     width: number;
 }
 export interface OcrData {
-    test: string;
+    text: string;
     confidence: number;
     boundingBox: Rect;
 }

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

@@ -10,4 +10,5 @@ export declare class Frame {
     static empty(): Frame;
     static fromRect(rect: DOMRect): Frame;
     static fromPoint(point: Point, size: number): Frame;
+    static fromDOMRect(rect: DOMRect): Frame;
 }

package/@types/utils/predicate/polygon-movement-predicate.d.ts

@@ -5,7 +5,7 @@ export declare class PolygonMovementPredicate {
     private lastPolygon;
     private maxDistance;
     private sensitivity;
-    constructor(videoSize: VideoSize, sensitivity?: Number);
+    constructor(videoSize: VideoSize, sensitivity?: number);
     check(polygon: Polygon): boolean;
     reset(): void;
     update(polygon: Polygon): void;

package/@types/utils/video-stream.d.ts

@@ -21,4 +21,5 @@ export default class VideoStream extends React.Component<VideoStreamProps, Video
     componentWillUnmount(): void;
     updateTorch(enabled: boolean): Promise<void>;
     getCapabilities(): MediaTrackCapabilities | undefined;
+    getVideoTrack(): MediaStreamTrack | undefined;
 }

package/@types/view/document-outline.d.ts

@@ -1,13 +1,12 @@
 import React from "react";
 import "../styles/main.css";
-import { AnimatedDocumentPolygon } from "./polygon/animated-document-polygon";
+import AnimatedDocumentPolygon from "./polygon/animated-document-polygon";
+import { ShutterButtonAction } from "./shutter-button";
+import { OutlineStyleConfiguration } from "../model/configuration/document-scanner-configuration";
 export interface DocumentOutlineProps {
-    style: {
-        polygon: {};
-        label: {};
-    };
-    showLabel: boolean;
-    visible?: boolean;
+    style?: OutlineStyleConfiguration;
+    action?: ShutterButtonAction;
+    autoCaptureDelay?: number;
 }
 export declare class DocumentOutline extends React.Component<DocumentOutlineProps, any> {
     hintLabelClassName: string;

package/@types/view/polygon/animated-document-polygon.d.ts

@@ -1,9 +1,23 @@
 import React from "react";
 import DocumentPolygon from "./document-polygon";
-export declare class AnimatedDocumentPolygon extends React.Component<any, any> {
+import AnimatedPath from "./animated-path";
+import { ShutterButtonAction } from "../shutter-button";
+import { CaptureAnimationStyleConfiguration, OutlinePolygonStyleConfiguration } from "../../model/configuration/document-scanner-configuration";
+export declare class AnimatedDocumentPolygonProps {
+    action?: ShutterButtonAction;
+    autoCaptureDelay?: number;
+    style?: any;
+    isOk?: boolean;
+    isVisible?: boolean;
+    polygonStyle?: OutlinePolygonStyleConfiguration;
+    pathStyle?: CaptureAnimationStyleConfiguration;
+}
+export default class AnimatedDocumentPolygon extends React.Component<AnimatedDocumentPolygonProps, any> {
     polygon: DocumentPolygon;
     previous: any[];
-    testComponent: React.RefObject<any>;
+    path: AnimatedPath;
     render(): JSX.Element;
-    update(points: any[], isOk: boolean, isVisible: boolean): void;
+    update(points: any[], isOk: boolean, action: ShutterButtonAction): void;
+    animateCapturing(): void;
+    clearAnimation(): void;
 }

package/@types/view/polygon/animated-path.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+import { Point } from "../../utils/dto/Point";
+import { CaptureAnimationStyleConfiguration } from "../../model/configuration/document-scanner-configuration";
+export declare class AnimatedPathProps {
+    duration: number;
+    style?: CaptureAnimationStyleConfiguration;
+}
+export default class AnimatedPath extends React.Component<AnimatedPathProps, any> {
+    constructor(props: any);
+    render(): React.ReactNode;
+    animate(points: Point[]): void;
+    clear(): void;
+}

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

@@ -3,9 +3,10 @@ import VideoStream from "../utils/video-stream";
 import { Size } from "../utils/dto/Size";
 import { Frame } from "../utils/dto/Frame";
 import { WindowStyleConfiguration } from "../model/configuration/window-style-configuration";
-import { ImageDataWrapper } from "../model/image-data-wrapper";
 import { CameraInfo } from "../model/camera-info";
+import { ScannerConfiguration } from "../model/configuration/scanner-configuration";
 export interface ScanbotCameraViewProps {
+    configuration?: ScannerConfiguration;
     windowConfiguration?: WindowStyleConfiguration;
     videoConstraints: MediaTrackConstraints;
     mirrored: boolean;
@@ -37,7 +38,10 @@ export default class ScanbotCameraView extends React.Component<ScanbotCameraView
     save: boolean;
     saveExtractedData(): void;
     zoom(): number;
-    createImageData(maxLargerLength?: number): ImageDataWrapper;
+    private capture?;
+    private imageCapture;
+    createImageData(maxLargerLength?: number, useImageCaptureAPI?: boolean): Promise<ImageData>;
+    windowSize(): Frame;
     calculateClientVideoConstraints(): {
         clientVideoWidth: number;
         clientVideoHeight: number;