scanbot-web-sdk 4.0.1-alpha.2 → 5.0.0-alpha.1

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

@@ -30,4 +30,5 @@ export declare abstract class ScannerView<P extends ScanbotCameraProps, S extend
     switchCamera(deviceId: string, mirrored?: boolean): Promise<void>;
     getActiveCameraInfo(): CameraInfo | undefined;
     fetchAvailableCameras(): Promise<CameraInfo[]>;
+    setTorchState(enabled: boolean): Promise<void>;
 }

package/@types/service/image-processor.d.ts

@@ -0,0 +1,35 @@
+import ScanbotSDK from "../scanbot-sdk";
+import { ParametricFilter } from "../core/compiled/ParametricFilters";
+import { Polygon } from "../utils/dto/Polygon";
+export declare type Rotation = "ROTATION_NONE" | "ROTATION_90_CLOCKWISE" | "ROTATION_180" | "ROTATION_90_COUNTERCLOCKWISE";
+export declare class ImageProcessor {
+    private _sdk;
+    private _token;
+    /** @internal */
+    constructor(_sdk: ScanbotSDK, _token: string);
+    copy(): Promise<ImageProcessor>;
+    /**
+     * Applies the given filter to the image.
+     * See {@link ParametricFilters} for available filters.
+     * @example
+     * imageProcessor.applyFilter(new sdk.imageFilters.ScanbotBinarizationFilter());
+     * */
+    applyFilter(filter: ParametricFilter): Promise<void>;
+    /**
+     * Crops the image to the given polygon.
+     *    The polygon is defined by an array of four points, each point being an object with `x` and `y` coordinates.
+     *    Each coordinate is a floating point number between 0 and 1, representing the percentage of the image width and height, respectively.
+     *    @example
+     *    // Crop an image to the center 80% of the image:
+     *    imageProcessor.crop([{x: 0.1, y: 0.1}, {x: 0.9, y: 0.1}, {x: 0.9, y: 0.9}, {x: 0.1, y: 0.9}])
+     */
+    crop(polygon: Polygon): Promise<void>;
+    /** Resizes image, keeping aspect ratio, so that the biggest side of the image is equal to `destinationSize`. */
+    resize(destinationSize: number): Promise<void>;
+    rotate(rotation: Rotation): Promise<void>;
+    /** Returns the processed image as a JPEG encoded ArrayBuffer. */
+    processedImage(): Promise<ArrayBuffer>;
+    release(): Promise<void>;
+    /** @internal */
+    get __token(): string;
+}

package/@types/service/pdf-generator.d.ts

@@ -1,25 +1,49 @@
 import ScanbotSDK from '../scanbot-sdk';
-export declare type PageSize = "LETTER" | // 8.5 x 11 (inches)        612 x 792 (pixels)
-"LEGAL" | // 8.5 x 14 (inches)        612 x 1008 (pixels)
-"A3" | // 297 x 420 (mm)           841.89 x 1199.551 (pixels)
-"A4" | // 210 x 297 (mm)           595.276 x 841.89 (pixels)
-"A5" | // 148 x 210 (mm)           419.528 x 595.276 (pixels)
-"B4" | // 250 x 353 (mm)           708.661 x 1000.63 (pixels)
-"B5" | // 176 x 250 (mm)           498.898 x 708.661 (pixels)
-"EXECUTIVE" | // 7.25 x 10.5 (inches)     522 x 756 (pixels)
-"US4x6" | // 4 x 6 (inches)           288 x 432 (pixels)
-"US4x8" | // 4 x 8 (inches)           288 x 576 (pixels)
-"US5x7" | // 5 x 7 (inches)           360 x 504 (pixels)
-"COMM10" | // 4.125 x 9.5 (inches)     297 x 684 (pixels)
-"CUSTOM";
+/**
+ *     "LETTER"         8.5 x 11 (inches)        612 x 792 (pixels) <br>
+ *     "LEGAL"          8.5 x 14 (inches)        612 x 1008 (pixels) <br>
+ *     "A3"             297 x 420 (mm)           841.89 x 1199.551 (pixels) <br>
+ *     "A4"             210 x 297 (mm)           595.276 x 841.89 (pixels) <br>
+ *     "A5"             148 x 210 (mm)           419.528 x 595.276 (pixels) <br>
+ *     "B4"             250 x 353 (mm)           708.661 x 1000.63 (pixels) <br>
+ *     "B5"             176 x 250 (mm)           498.898 x 708.661 (pixels) <br>
+ *     "EXECUTIVE"      7.25 x 10.5 (inches)     522 x 756 (pixels) <br>
+ *     "US4x6"          4 x 6 (inches)           288 x 432 (pixels) <br>
+ *     "US4x8"          4 x 8 (inches)           288 x 576 (pixels) <br>
+ *     "US5x7"          5 x 7 (inches)           360 x 504 (pixels) <br>
+ *     "COMM10"         4.125 x 9.5 (inches)     297 x 684 (pixels) <br>
+ *     "CUSTOM"         uses image size
+ */
+export declare type PageSize = "LETTER" | "LEGAL" | "A3" | "A4" | "A5" | "B4" | "B5" | "EXECUTIVE" | "US4x6" | "US4x8" | "US5x7" | "COMM10" | "CUSTOM";
+/**
+ * AUTO – decides based on image aspect ratio
+ */
 export declare type PageDirection = "PORTRAIT" | "LANDSCAPE" | "AUTO";
+/**
+ * FIT_IN – fit image into page, preserves aspect ratio  <br>
+ * FILL_IN – fill page with image, preserves aspect ratio  <br>
+ * STRETCH – stretch image to fill page, does NOT preserve aspect ratio  <br>
+ * NONE – no resizing, centers the image
+ */
+export declare type PageFit = "FIT_IN" | "FILL_IN" | "STRETCH" | "NONE";
 export interface PdfGenerationOptions {
     standardPaperSize?: PageSize;
     pageDirection?: PageDirection;
+    pageFit?: PageFit;
+    /**
+     * Note that no resampling of images is done in the PDF generation process.
+     * The dpi value is only used to calculate the images physical dimensions (in inches),
+     * when pageFit="NONE" or pageSize="CUSTOM".
+     *
+     * If you want to create a PDF with smaller file size, try resizing the image using
+     * the {@link ImageProcessor.resize} method before adding it to the PDF.
+     * */
+    dpi?: number;
 }
 export default class PdfGenerator {
     _pdfOperation: string;
     _sdk: ScanbotSDK;
+    /** @internal */
     constructor(sdk: ScanbotSDK, pdfOperation: string);
     addPage(imageBuffer: ArrayBuffer): Promise<void>;
     complete(): Promise<ArrayBuffer>;

package/@types/service/simple-mrz-recognizer.d.ts

@@ -1,10 +1,11 @@
 import { MrzResult } from '../model/mrz/mrz-result';
 import ScanbotSDK from '../scanbot-sdk';
 export default class SimpleMrzRecognizer {
-    _mrzRecognizerToken: string;
-    _sdk: ScanbotSDK;
-    constructor(sdk: ScanbotSDK, mrzRecognizerToken: string);
-    recognize(imageData: ImageData): Promise<MrzResult>;
+    private _sdk;
+    private _mrzRecognizerToken;
+    private enableFrameAccumulation;
+    constructor(_sdk: ScanbotSDK, _mrzRecognizerToken: string, enableFrameAccumulation: boolean);
+    recognize(imageData: ImageData | ArrayBuffer): Promise<MrzResult>;
     recognizeURL(imageURL: string): Promise<MrzResult>;
     release(): Promise<void>;
 }

package/@types/service/tiff-generator.d.ts

@@ -1,13 +1,16 @@
 import ScanbotSDK from '../scanbot-sdk';
-import { BinarizationFilter } from '../model/filter-types';
+import { ImageProcessor } from "./image-processor";
 export interface TiffGenerationOptions {
-    binarizationFilter?: BinarizationFilter;
     dpi?: number;
 }
 export default class TiffGenerator {
-    _tiffOperation: string;
-    _sdk: ScanbotSDK;
+    private _tiffOperation;
+    private _sdk;
+    /** @internal */
     constructor(sdk: ScanbotSDK, tiffOperation: string);
-    addPage(imageBuffer: ArrayBuffer): Promise<void>;
+    /**
+     * @param image Can be either an ArrayBuffer containing the JPEG or PNG encoded image data, or an ImageProcessor instance.
+     */
+    addPage(image: ArrayBuffer | ImageProcessor): Promise<void>;
     complete(): Promise<ArrayBuffer>;
 }

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

@@ -5,6 +5,7 @@ import { ViewFinder } from "./view/view-finder";
 import TextDataScanner from "./service/text-data-recognizer";
 import { ScannerConfiguration } from "./model/configuration/scanner-configuration";
 import { ViewFinderConfiguration } from "./model/configuration/view-finder-configuration";
+import { ITextDataScannerHandle } from "./interfaces/i-text-data-scanner-handle";
 export declare class TextDataScannerProps extends ScanbotCameraProps {
     textDataScanner: TextDataScanner;
     onTextDetected: TextDetectionCallback;
@@ -13,7 +14,7 @@ export declare class TextDataScannerProps extends ScanbotCameraProps {
 export declare class TextDataScannerState extends ScanbotCameraState {
     isFinderVisible?: boolean;
 }
-export default class TextDataScannerView extends ScannerView<TextDataScannerProps, TextDataScannerState> {
+export default class TextDataScannerView extends ScannerView<TextDataScannerProps, TextDataScannerState> implements ITextDataScannerHandle {
     static FRAME_RESOLUTION: number;
     finder?: ViewFinder;
     shouldComputeSize: boolean;

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

@@ -3,5 +3,4 @@ export declare class MagneticLine {
     p1: Point;
     p2: Point;
     constructor(p1: Point, p2: Point);
-    static scaleToLine(line: MagneticLine, x: number, y: number, scale: number): MagneticLine;
 }

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

@@ -25,4 +25,10 @@ export declare class Point {
     static left(points: Point[]): any;
     static right(points: Point[]): any;
     static toSvgString(points: Point[]): string;
+    static distance(pointA: Point, pointB: Point): number;
+    static subtract(a: Point, b: Point): Point;
+    static add(a: Point, b: Point): Point;
+    static multiply(point: Point, scalar: number): Point;
+    static cross(a: Point, b: Point): number;
+    static clamp(point: Point, containerSize: Size): Point;
 }

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

@@ -7,4 +7,5 @@ export declare class MathUtils {
      */
     static isConvex(_vertices: Point[]): boolean;
     static distanceBetweenPoints(point1: Point, point2: Point): number;
+    static intersection(lineA: [Point, Point], lineB: [Point, Point]): Point | undefined;
 }

package/@types/view/cropping/draggable-base-container.d.ts

@@ -1,8 +1,32 @@
 import React, { CSSProperties } from "react";
 import { Point } from "../../utils/dto/Point";
-export declare class DraggableBaseContainer extends React.Component<any, any> {
+import { Size } from "../../utils/dto/Size";
+import { CroppingViewPolygonHandleStyle } from "../../model/configuration/cropping-view-configuration";
+export interface MovingLine {
+    points: {
+        index: number;
+        coordinates: Point;
+    }[];
+    /** The point of the polygon that is clockwise before the moving line */
+    previousPoint: Point;
+    /** The point of the polygon that is clockwise after the moving line */
+    nextPoint: Point;
+    isHorizontal: boolean;
+}
+interface DraggableBaseContainerProps {
+    style: CroppingViewPolygonHandleStyle;
+    containerSize: Size;
+    scale: number;
+    rotations: number;
+    points: Point[];
+    cornerMoveStart?: any;
+    cornerMoved?: any;
+    cornerMoveEnd?: any;
+    lineMoved?: (movingLine: MovingLine) => void;
+}
+export declare class DraggableBaseContainer extends React.Component<DraggableBaseContainerProps, any> {
     POINT_COUNT: number;
-    get pointSize(): any;
+    get pointSize(): number;
     get pointStyle(): CSSProperties;
     items: HTMLDivElement[];
     parentOffset: Point;
@@ -11,4 +35,6 @@ export declare class DraggableBaseContainer extends React.Component<any, any> {
     isHorizontal(index: number): boolean;
     DRAG_BUFFER: number;
     isOutOfBounds(coordinate: number, bound: number): boolean;
+    get invisibleHandleStyle(): CSSProperties;
 }
+export {};

package/@types/view/cropping/draggable-handles-component.d.ts

@@ -2,12 +2,28 @@ import React from "react";
 import { MagneticLine } from "../../utils/dto/MagneticLine";
 import { DraggablePointsContainer } from "./draggable-points-container";
 import { DraggableLinesContainer } from "./draggable-lines-container";
-export declare class DraggableHandlesComponent extends React.Component<any, any> {
+import { Size } from "../../utils/dto/Size";
+import { CroppingViewPolygonHandleStyle } from "../../model/configuration/cropping-view-configuration";
+import type { MovingLine } from "./draggable-base-container";
+interface DraggableHandlesComponentProps {
+    containerSize: Size;
+    coordinatePoints: any;
+    rotations: number;
+    scale: number;
+    style: CroppingViewPolygonHandleStyle;
+    cornerMoveStart: any;
+    cornerMoved: any;
+    cornerMoveEnd: any;
+    lineMoved: (data: MovingLine) => void;
+}
+export declare class DraggableHandlesComponent extends React.Component<DraggableHandlesComponentProps, {}> {
     corners: DraggablePointsContainer;
     lines: DraggableLinesContainer;
-    constructor(props: any);
     render(): JSX.Element;
     setFrame(): void;
-    snapTo(data: any): void;
-    snapToClosest(index: number, anchor: MagneticLine, axis: "x" | "y"): void;
+    snapTo(data: {
+        magneticLine: MagneticLine;
+        polygonLine: MovingLine;
+    }): void;
 }
+export {};

package/@types/view/cropping/draggable-lines-container.d.ts

@@ -4,16 +4,15 @@ import { DraggableBaseContainer } from "./draggable-base-container";
 export declare class DraggableLinesContainer extends DraggableBaseContainer {
     point1Offset: Point;
     point2Offset: Point;
-    point1Start: Point;
-    point2Start: Point;
+    point0Start: Readonly<Point>;
+    point1Start: Readonly<Point>;
+    point2Start: Readonly<Point>;
+    point3Start: Readonly<Point>;
     create(): JSX.Element[];
     lineTouchStart(e: React.PointerEvent<HTMLDivElement>, index: number): void;
     lineTouchMove(e: React.PointerEvent<HTMLDivElement>, index: number): void;
-    lineTouchEnd(): void;
-    MAX_SLOPE_DIFF: number;
-    accountForSlopeCalculationError(potential: number, existing: number): number;
+    lineTouchEnd(e: React.PointerEvent<HTMLDivElement>): void;
     isNearOpposingPoint(start: Point, active: Point, wall: Point, axis: "x" | "y"): boolean;
-    validateCoordinate(value: number, fallback: number): number;
-    limitMinMaxCoordinates(value: number, max: number): number;
+    areEdgesCrossing(edgeAPoint1: Point, edgeAPoint2: Point, edgeBPoint1: Point, edgeBPoint2: Point): boolean;
     render(): JSX.Element;
 }

package/@types/view/cropping/draggable-points-container.d.ts

@@ -1,13 +1,9 @@
 import React from "react";
-import { Point } from "../../utils/dto/Point";
 import { DraggableBaseContainer } from "./draggable-base-container";
 export declare class DraggablePointsContainer extends DraggableBaseContainer {
-    lastPointIndex: number;
     create(): JSX.Element[];
     cornerTouchStart(e: React.PointerEvent<HTMLDivElement>, index: number): void;
     cornerTouchMove(e: React.PointerEvent<HTMLDivElement>, index: number): void;
-    cornerTouchEnd(): void;
-    calculateSlopes(): void;
-    calculateSlope(point1: Point, point2: Point, isHorizontal: boolean): number;
+    cornerTouchEnd(e: React.PointerEvent<HTMLDivElement>): void;
     render(): JSX.Element;
 }

package/@types/view/cropping/magnetic-lines-component.d.ts

@@ -1,13 +1,31 @@
 import React from "react";
 import { MagneticLine } from "../../utils/dto/MagneticLine";
 import { Point } from "../../utils/dto/Point";
-export declare class MagneticLinesComponent extends React.Component<any, any> {
+import type { CroppingViewMagneticLineStyle } from "../../model/configuration/cropping-view-configuration";
+import type { MovingLine } from "./draggable-base-container";
+interface MagneticLinesComponentProps {
+    lines: {
+        horizontal: {
+            scaled: MagneticLine[];
+        };
+        vertical: {
+            scaled: MagneticLine[];
+        };
+    };
+    movingLine: MovingLine;
+    snapTo: (data: {
+        magneticLine: MagneticLine;
+        polygonLine: MovingLine;
+    }) => void;
+    style: CroppingViewMagneticLineStyle;
+}
+export declare class MagneticLinesComponent extends React.Component<MagneticLinesComponentProps, any> {
     fromPoint(point: MagneticLine): JSX.Element;
     componentDidUpdate(prevProps: Readonly<any>, prevState: Readonly<any>, snapshot?: any): void;
     render(): JSX.Element;
-    isNearAny(): void;
-    isLineNearLine(anchor: MagneticLine, other: any[], isHorizontal: boolean): boolean;
-    isPointNearLine(anchor: MagneticLine, other: Point, isHorizontal: boolean): boolean;
     BUFFER: number;
-    isPointNearPoint(anchor: Point, other: Point, isHorizontal: boolean): boolean;
+    snapToClosestIfAnyAreClose(): void;
+    distanceToLine(line: MagneticLine, x: Point): number;
+    midPoint(point1: Point, point2: Point): Point;
 }
+export {};

package/@types/view/cropping/magnifier-view.d.ts

@@ -13,7 +13,6 @@ export declare class MagnifierOptions {
     rotations: number;
     scale: number;
     container: Size;
-    padding: number;
 }
 export declare class MagnifierCrosshair extends React.Component<any, any> {
     render(): JSX.Element;

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

@@ -1,10 +1,32 @@
 import React from "react";
 import { DocumentLineQuad } from "./document-line-quad";
 import { DraggableHandlesComponent } from "../cropping/draggable-handles-component";
-export declare class DraggableDocumentPolygon extends React.Component<any, any> {
+import { Size } from "../../utils/dto/Size";
+import { CroppingViewMagneticLineStyle, CroppingViewPolygonHandleStyle } from "../../model/configuration/cropping-view-configuration";
+import { MovingLine } from "../cropping/draggable-base-container";
+interface DraggableDocumentPolygonProps {
+    size: Size;
+    points: any;
+    rotations: number;
+    scale: number;
+    handleStyle: CroppingViewPolygonHandleStyle;
+    magneticLineStyle: CroppingViewMagneticLineStyle;
+    magneticLines: any;
+    polygonStyle: any;
+    polygonClasses: any;
+    cornerMoveStart: any;
+    cornerMoved: any;
+    cornerMoveEnd: any;
+    style: React.CSSProperties;
+}
+interface DraggableDocumentPolygonState {
+    movingLine: MovingLine;
+}
+export declare class DraggableDocumentPolygon extends React.Component<DraggableDocumentPolygonProps, DraggableDocumentPolygonState> {
     handles: DraggableHandlesComponent;
     polygon: DocumentLineQuad;
     constructor(props: any);
     render(): JSX.Element;
     setFrame(): void;
 }
+export {};

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

@@ -58,4 +58,5 @@ export default class ScanbotCameraView extends React.Component<ScanbotCameraView
     switchCamera(deviceId: string, mirrored?: boolean): Promise<void>;
     private updateCameraInfo;
     getActiveCameraInfo(): CameraInfo | undefined;
+    setTorchState(enabled: boolean): Promise<void>;
 }

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

@@ -7,18 +7,9 @@ export declare class ShutterButtonProps {
     onClick: any;
     style?: any;
 }
-declare class AnimationSynchronizer {
-    lastTime: number;
-    lastDuration: number;
-    t: number;
-    element: HTMLElement;
-    animationClass: string;
-    constructor(animationClass: string);
-    setDuration(duration: number): void;
-}
 export declare class ShutterButton extends React.Component<ShutterButtonProps, {}> {
-    inner1: AnimationSynchronizer;
-    inner2: AnimationSynchronizer;
+    private inner1;
+    private inner2;
     render(): JSX.Element;
     updateAnimationSpeed(action: ShutterButtonAction): void;
     componentDidMount(): void;
@@ -32,4 +23,3 @@ export declare class ShutterButton extends React.Component<ShutterButtonProps, {
         [key: string]: boolean;
     }, child: any, ref?: (ref: any) => void): JSX.Element;
 }
-export {};

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

@@ -1,7 +1,14 @@
 import React from "react";
 import { Size } from "../../utils/dto/Size";
 import { Point } from "../../utils/dto/Point";
-export declare class Animatable extends React.Component<any, any> {
+interface AnimatableProps {
+    size: Size;
+    imageMargin: Point;
+    rotations: number;
+    scale: number;
+    duration: number;
+}
+export declare class Animatable extends React.Component<AnimatableProps, any> {
     previousScale: number;
     container: HTMLDivElement;
     width(): number;
@@ -9,6 +16,7 @@ export declare class Animatable extends React.Component<any, any> {
     private animating;
     isAnimating(): boolean;
     render(): JSX.Element;
-    marginWithAspect(margin: Point, axis: "x" | "y", size: Size): any;
-    calculate(size: Size, margin: number, property: "width" | "height"): any;
+    marginWithAspect(margin: Point, axis: "x" | "y", size: Size): number;
+    calculate(size: Size, property: "width" | "height"): any;
 }
+export {};

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

@@ -0,0 +1,4 @@
+import { Size } from "../../utils/dto/Size";
+import { Point } from "../../utils/dto/Point";
+export declare function clamp(value: number, min: number, max: number): number;
+export declare function clampHandlePosition(handlePosition: Point, handleDiameter: number, containerSize: Size): Point;

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

@@ -3,11 +3,11 @@ import { Frame } from "../utils/dto/Frame";
 import { ClipPath } from "../utils/dto/ClipPath";
 import { Point } from "../utils/dto/Point";
 import { ViewFinderConfiguration } from "../model/configuration/view-finder-configuration";
-declare class ViewFinderProps {
+export declare class ViewFinderProps {
     configuration: ViewFinderConfiguration;
     onSizeChanged?: (rect: DOMRect) => void;
 }
-declare enum ClipDirection {
+export declare enum ClipDirection {
     Right = 0,
     Down = 1,
     Left = 2,
@@ -33,4 +33,3 @@ export declare class ViewFinder extends React.Component<ViewFinderProps, any> {
     roundClipPath(x: string, y: string, direction: ClipDirection): string;
     addIncrements(edge: Point, increments: Point[]): string;
 }
-export {};