scanbot-web-sdk 2.8.2 → 2.9.0-alpha3

package/@types/index.d.ts

@@ -16,6 +16,10 @@ import { IMrzScannerHandle } from "./interfaces/i-mrz-scanner-handle";
 import { MrzScannerConfiguration } from "./model/configuration/mrz-scanner-configuration";
 import { MrzResult, MrzCheckDigits, MrzField } from "./model/mrz/mrz-result";
 
+import { TextDataScannerResult } from './model/generic-text-line-recognizer/text-data-scanner-result';
+import { TextDataScannerConfiguration } from "./model/configuration/text-data-scanner-configuration";
+import { ITextDataScannerHandle } from "./interfaces/i-text-data-scanner-handle";
+
 import PdfGenerator, { PdfGenerationOptions } from "./service/pdf-generator";
 import TiffGenerator, { TiffGenerationOptions } from "./service/tiff-generator";
 
@@ -42,6 +46,10 @@ export {
     MrzCheckDigits,
     MrzField,
 
+    ITextDataScannerHandle,
+    TextDataScannerConfiguration,
+    TextDataScannerResult,
+
     ICroppingViewHandle,
     CroppingViewConfiguration,
     CroppingResult,

package/@types/interfaces/i-text-data-scanner-handle.d.ts

@@ -0,0 +1,6 @@
+export interface ITextDataScannerHandle {
+    resumeDetection(): void;
+    pauseDetection(): void;
+    isDetectionPaused(): boolean;
+    dispose(): void;
+}

package/@types/model/configuration/text-data-scanner-configuration.d.ts

@@ -0,0 +1,12 @@
+import { TextDataScannerResult } from "../generic-text-line-recognizer/text-data-scanner-result";
+import { ScannerConfiguration } from "./scanner-configuration";
+import { ViewFinderConfiguration } from "./view-finder-configuration";
+export declare class TextDataScannerConfiguration extends ScannerConfiguration {
+    constructor();
+    ocrResolutionLimit?: number;
+    supportedLanguages?: string[];
+    style?: ViewFinderConfiguration;
+    onTextDetected?: (e: TextDataScannerResult) => void;
+    _onDetectionFailed?: (e: ImageData) => void;
+    static fromJson(json: any): TextDataScannerConfiguration;
+}

package/@types/model/generic-text-line-recognizer/text-data-scanner-result.d.ts

@@ -0,0 +1,6 @@
+export declare class TextDataScannerResult {
+    text?: string;
+    confidence?: number;
+    validated?: boolean;
+    static fromWorker(output: any): TextDataScannerResult;
+}

package/@types/scanbot-sdk.d.ts

@@ -21,6 +21,8 @@ import SimpleMrzRecognizer from "./service/simple-mrz-recognizer";
 import OcrEngine from "./service/ocr-engine";
 import BlurDetector from "./service/blur-detector";
 import { ContourDetectionResult } from "./model/document/contour-detection-result";
+import { TextDataScannerConfiguration } from "./model/configuration/text-data-scanner-configuration";
+import { ITextDataScannerHandle } from "./interfaces/i-text-data-scanner-handle";
 export default class ScanbotSDK {
     bridge: WorkerBridge;
     initialized: boolean;
@@ -34,6 +36,7 @@ export default class ScanbotSDK {
     createMrzScanner(configuration: MrzScannerConfiguration): Promise<IMrzScannerHandle>;
     createBarcodeScanner(configuration: BarcodeScannerConfiguration): Promise<IBarcodeScannerHandle>;
     openCroppingView(configuration: CroppingViewConfiguration): Promise<ICroppingViewHandle>;
+    createTextDataScanner(configuration: TextDataScannerConfiguration): Promise<ITextDataScannerHandle>;
     /**
      * Image Operations
      */

package/@types/service/text-data-recognizer.d.ts

@@ -0,0 +1,11 @@
+import { TextDataScannerResult } from '../model/generic-text-line-recognizer/text-data-scanner-result';
+import ScanbotSDK from '../scanbot-sdk';
+export default class TextDataScanner {
+    _textDataScannerToken: string;
+    _sdk: ScanbotSDK;
+    constructor(sdk: ScanbotSDK, textDataScannerToken: string);
+    recognize(imageData: ImageData): Promise<TextDataScannerResult>;
+    cleanRecognitionQueue(): Promise<void>;
+    recognizeURL(imageURL: string): Promise<TextDataScannerResult>;
+    release(): Promise<void>;
+}

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

@@ -0,0 +1,39 @@
+/// <reference types="react" />
+import { ScanbotCameraProps, ScanbotCameraState, ScannerView } from "./scanner-view";
+import { TextDataScannerConfiguration } from "./model/configuration/text-data-scanner-configuration";
+import { ViewFinder } from "./view/view-finder";
+import TextDataScanner from "./service/text-data-recognizer";
+export declare class TextDataScannerProps extends ScanbotCameraProps {
+    textDataScanner: TextDataScanner;
+}
+export declare class TextDataScannerState extends ScanbotCameraState {
+    isFinderVisible?: boolean;
+}
+export default class TextDataScannerView extends ScannerView<TextDataScannerProps, TextDataScannerState> {
+    static FRAME_RESOLUTION: number;
+    finder?: ViewFinder;
+    shouldComputeSize: boolean;
+    private paused;
+    constructor(props: TextDataScannerProps);
+    get configuration(): TextDataScannerConfiguration;
+    get enabled(): boolean;
+    /**
+     * Public API functions
+     */
+    static create(configuration: TextDataScannerConfiguration, textDataScanner: TextDataScanner): Promise<TextDataScannerView>;
+    isDetectionPaused(): boolean;
+    resumeDetection(): Promise<void>;
+    pauseDetection(): void;
+    /**
+     * React Overrides
+     */
+    componentDidMount(): Promise<void>;
+    componentWillUnmount(): void;
+    updateDimensions(): Promise<void>;
+    resume(): Promise<void>;
+    pause(): void;
+    computeSize(): boolean;
+    detect(): Promise<void>;
+    saveExtractedImageData(): void;
+    render(): JSX.Element;
+}