scanbot-web-sdk 8.1.0-beta.5 → 8.1.0-beta.7

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

@@ -21,6 +21,7 @@ export default class BarcodeScannerView extends FinderScannerView<BarcodeScanner
     barcodeScannerHandle: BarcodeScanner | null;
     readonly barcodes: BarcodeItem[];
     private detectionRunning;
+    private fpsLimiter;
     constructor(props: BarcodeScannerProps);
     get configuration(): BarcodeScannerViewConfiguration;
     get enabled(): boolean;

package/@types/index.d.ts

@@ -94,6 +94,7 @@ export { PageImageSource } from "./ui2/configuration/native/PageImageSource";
 export { SBStorageError } from "./service/storage/utils/sb-storage-error";
 export { SBDocumentData } from "./ui2/document/model/utils/sb-document-data";
 export { SBPageData } from "./ui2/document/model/utils/sb-page-data";
+export { DocumentDetectionUIResult } from "./ui2/document/model/document-detection-ui-result";
 
 export { default as ScanbotSDKUI2 } from "./ui2/scanbot-sdk-ui";
 export * as UIConfig from "./ui2/configuration";

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

@@ -33,5 +33,12 @@ export declare class BarcodeScannerViewConfiguration extends ViewFinderScannerCo
      * A lower value will result in faster processing times but may reduce recognition quality.
      */
     desiredRecognitionResolution?: number;
+    /**
+     * The rate of detections/recognitions per second in normal performance mode.
+     * If the number is equal or greater than the video frame rate, no frames will be skipped.
+     * A lower value will result in improved overall performance on lower-end devices, but may reduce recognition speed.
+     * In seconds. Defaults to 60.
+     */
+    fpsLimit?: number;
     static fromJson(json: any): BarcodeScannerViewConfiguration;
 }

package/@types/ui2/barcode/views/camera-permission-denied.d.ts

@@ -1,9 +1,11 @@
 import React from "react";
 import type { CameraPermissionScreen } from "../../configuration/common/CameraPermission";
+import { NavigationBarSize } from "../../document/views/camera-screen/top-bar";
 interface Props {
     visible: boolean;
     onCloseClick: () => void;
     config: CameraPermissionScreen;
+    navigationBarSize: NavigationBarSize;
 }
 export declare function CameraPermissionDenied(props: Props): React.JSX.Element;
 export {};

package/@types/ui2/document/controller/acknowledgment-screen-controller.d.ts

@@ -1,10 +1,10 @@
 import React from "react";
 import { DocumentScanningFlow } from "../../configuration/document/DocumentScanningFlow";
 import ScanbotSDK from "../../../scanbot-sdk";
-import { DocumentDetectionUIResult, RtuDocumentDetectionResultPromise } from "../model/document-detection-ui-result";
+import { DocumentDetectionUIResult } from "../model/document-detection-ui-result";
 import { DocumentQuality } from "../../../core-types";
 declare class Props {
-    croppedDetectionResult: RtuDocumentDetectionResultPromise;
+    croppedDetectionResult: DocumentDetectionUIResult;
     visible: boolean;
     configuration: DocumentScanningFlow;
     sdk: ScanbotSDK;

package/@types/ui2/document/controller/camera-screen-controller.d.ts

@@ -2,7 +2,7 @@ import React from "react";
 import { DocumentScanningFlow } from "../../configuration/document/DocumentScanningFlow";
 import type ScanbotSDK from "../../../scanbot-sdk";
 import { SBPage } from "../model/sb-page";
-import { RtuDocumentDetectionResultPromise } from "../model/document-detection-ui-result";
+import { DocumentDetectionUIResult } from "../model/document-detection-ui-result";
 import { Root } from "react-dom/client";
 export type SnappingMode = "auto" | "manual";
 type Props = {
@@ -11,7 +11,8 @@ type Props = {
     configuration: DocumentScanningFlow;
     onClose?: () => void;
     onError: (error: any) => void;
-    onImageCaptured: (image: RtuDocumentDetectionResultPromise) => void;
+    onShutterButtonClick?: () => void;
+    onImageCaptured: (image: DocumentDetectionUIResult) => void;
     onReviewButtonClick: () => void;
     sdk: ScanbotSDK;
     scanningPaused: boolean;

package/@types/ui2/document/model/document-detection-ui-result.d.ts

@@ -1,8 +1,10 @@
 import type { PageImageSource } from "../../configuration/native/PageImageSource";
-import { DocumentScannerScanResponse } from "../../../core-types";
-export type DocumentDetectionUIResult = {
+import { DocumentQualityAnalyzerResult, DocumentScannerScanResponse, Image } from "../../../core-types";
+export declare class DocumentDetectionUIResult {
     value: DocumentScannerScanResponse;
     source: PageImageSource;
-};
-export type RtuDocumentDetectionResultPromise = undefined | Promise<DocumentDetectionUIResult | null>;
-export declare function createRtuDocumentDetectionResultPromise(response: Promise<DocumentScannerScanResponse>, source: PageImageSource): RtuDocumentDetectionResultPromise;
+    analysis: DocumentQualityAnalyzerResult | null;
+    static create(value: DocumentScannerScanResponse, source: PageImageSource): DocumentDetectionUIResult;
+    updatedCroppedImage(result: Image): void;
+    setAnalysis(result: DocumentQualityAnalyzerResult): void;
+}

package/@types/ui2/document/model/sb-document.d.ts

@@ -1,11 +1,11 @@
 import { type Point } from "../../configuration/utils";
 import ScanbotSDK from "../../../scanbot-sdk";
-import { DeepPartial, DocumentQuality, DocumentScannerScanResponse, ParametricFilter, PdfConfiguration, TiffGeneratorParameters } from "../../../core-types";
+import { DeepPartial, ParametricFilter, PdfConfiguration, TiffGeneratorParameters } from "../../../core-types";
 import { SBPage } from "./sb-page";
-import { PageImageSource } from "../../configuration/native/PageImageSource";
 import { SBDocumentData } from "./utils/sb-document-data";
 import { TiffPageOptions } from "../../../service/tiff-generator";
 import { DocumentScanningFlow } from "../../configuration/document/DocumentScanningFlow";
+import { DocumentDetectionUIResult } from "./document-detection-ui-result";
 export declare class SBDocumentConfig {
     documentId: number | undefined;
     configuration: DocumentScanningFlow;
@@ -38,7 +38,7 @@ export declare class SBDocument {
     static create(config: SBDocumentConfig): Promise<SBDocument>;
     updateStorageDocument(): Promise<number>;
     delete(): Promise<void>;
-    addPage(response: DocumentScannerScanResponse, quality: DocumentQuality, source: PageImageSource, position?: number): Promise<void>;
+    addPage(response: DocumentDetectionUIResult, position?: number): Promise<void>;
     deleteFromPosition(position: number): Promise<void>;
     deletePage(page: SBPage): Promise<void>;
     deleteAllPages(): Promise<void>;

package/@types/ui2/document/views/camera-screen/bottom-bar.d.ts

@@ -19,7 +19,7 @@ declare class Props {
     onFileSelectDialogOpened: () => void;
     /** Note that onFileSelectDialogClosed may not be called in old browsers (see details below). */
     onFileSelectDialogClosed: () => void;
-    onFileUploaded: (image: Promise<DocumentScannerScanResponse | null>) => void;
+    onFileUploaded: (image: DocumentScannerScanResponse | null) => void;
     snappingModeButtonClick: () => void;
     onTorchButtonClick: () => void;
     onReviewButtonClick: () => void;

package/@types/utils/fps-limiter.d.ts

@@ -0,0 +1,6 @@
+export declare class FpsLimiter {
+    private fpsLimit?;
+    constructor(fpsLimit?: number);
+    private lastLapTime;
+    lap(): Promise<void>;
+}

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

@@ -1,6 +1,7 @@
 import { Size } from "./dto/Size";
 import { Frame } from "./dto/Frame";
 import { ImageDataWrapper } from "../model/image-data-wrapper";
+import { ImageRotation } from "../core-types";
 export declare class ImageUtils {
     static toDataUrl(buffer: ArrayBuffer): Promise<string>;
     static getObjectFitSize(container: Size, size: Size, contains?: boolean): Frame;
@@ -12,4 +13,6 @@ export declare class ImageUtils {
     static wrapperToBase64(wrapper: ImageDataWrapper): string;
     static toBase64(data: Uint8Array, stripIdentifier?: boolean): Promise<string>;
     static imageUrlToImageData(imageUrl: string): Promise<ImageData>;
+    static degreesToRotation(orientation: number): ImageRotation;
+    static degreesToRotations(orientation: number): number;
 }