scanbot-web-sdk 4.0.0-beta.1 → 4.0.0-rc.2

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

@@ -14,4 +14,13 @@ export declare class BaseConfiguration {
     static mapValues(source: any, destination: {
         [key: string]: any;
     }, ignore?: string[]): void;
+    static mapValuesDeep(source: any, destination: {
+        [key: string]: any;
+    }): void;
+    /** Instantiate a new configuration object of type T and merge any of its values with the values provided
+     *  in the partialConfigurationObject.
+     */
+    protected static _fromJson<T extends BaseConfiguration>(t: {
+        new (): T;
+    }, partialConfigurationObject: any): T;
 }

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

@@ -1,13 +1,36 @@
 import { TextDataScannerResult } from "../generic-text-line-recognizer/text-data-scanner-result";
 import { ScannerConfiguration } from "./scanner-configuration";
+import { TextStyleConfiguration } from "./text-style-configuration";
+import { WindowStyleConfiguration } from "./window-style-configuration";
 import { ViewFinderConfiguration } from "./view-finder-configuration";
+declare class TextDataScannerWindowStyle implements WindowStyleConfiguration {
+    aspectRatio: number;
+    widthProportion: number;
+    borderColor: string;
+    left: string;
+    top: string;
+    transform: string;
+}
+declare class TextDataScannerTextStyle implements TextStyleConfiguration {
+    color: string;
+    size: string;
+    weight: number;
+}
+export declare class TextDataScannerViewFinderStyle implements ViewFinderConfiguration {
+    window: TextDataScannerWindowStyle;
+    text: TextDataScannerTextStyle;
+    backgroundColor: string;
+    hint: string;
+}
 export declare type ValidatorPreset = "VehicleIdentificationNumber";
+export declare type TextDetectionCallback = (e: TextDataScannerResult) => void;
 export declare class TextDataScannerConfiguration extends ScannerConfiguration {
     constructor();
     ocrResolutionLimit?: number;
     supportedLanguages?: string[];
     validatorPreset?: ValidatorPreset;
     style?: ViewFinderConfiguration;
-    onTextDetected?: (e: TextDataScannerResult) => void;
+    onTextDetected?: TextDetectionCallback;
     static fromJson(json: any): TextDataScannerConfiguration;
 }
+export {};

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

@@ -0,0 +1,10 @@
+import { ScannerConfiguration } from "./scanner-configuration";
+import { ViewFinderConfiguration } from "./view-finder-configuration";
+import { TextDetectionCallback } from "./text-data-scanner-configuration";
+export declare class VINScannerConfiguration extends ScannerConfiguration {
+    constructor();
+    ocrResolutionLimit?: number;
+    style?: ViewFinderConfiguration;
+    onTextDetected?: TextDetectionCallback;
+    static fromJson(json: any): VINScannerConfiguration;
+}

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

@@ -21,6 +21,7 @@ import SimpleMrzRecognizer from "./service/simple-mrz-recognizer";
 import OcrEngine from "./service/ocr-engine";
 import { ContourDetectionResult } from "./model/document/contour-detection-result";
 import { TextDataScannerConfiguration } from "./model/configuration/text-data-scanner-configuration";
+import { VINScannerConfiguration } from "./model/configuration/vin-scanner-configuration";
 import { ITextDataScannerHandle } from "./interfaces/i-text-data-scanner-handle";
 import DocumentQualityAnalyzerConfiguration from "./model/configuration/document-quality-analyzer-configuration";
 import DocumentQualityAnalyzer from "./service/document-quality-analyzer";
@@ -38,6 +39,7 @@ export default class ScanbotSDK {
     createBarcodeScanner(configuration: BarcodeScannerConfiguration): Promise<IBarcodeScannerHandle>;
     openCroppingView(configuration: CroppingViewConfiguration): Promise<ICroppingViewHandle>;
     createTextDataScanner(configuration: TextDataScannerConfiguration): Promise<ITextDataScannerHandle>;
+    createVINScanner(configuration: VINScannerConfiguration): Promise<ITextDataScannerHandle>;
     /**
      * Image Operations
      */
@@ -67,4 +69,5 @@ export default class ScanbotSDK {
     throwIfMissing(property: any, message: string): void;
     release(object: any, source?: string): Promise<void>;
     private licenseCheck;
+    private createGenericTextLineScanner;
 }

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

@@ -1,10 +1,14 @@
 /// <reference types="react" />
 import { ScanbotCameraProps, ScanbotCameraState, ScannerView } from "./scanner-view";
-import { TextDataScannerConfiguration } from "./model/configuration/text-data-scanner-configuration";
+import { TextDetectionCallback } from "./model/configuration/text-data-scanner-configuration";
 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";
 export declare class TextDataScannerProps extends ScanbotCameraProps {
     textDataScanner: TextDataScanner;
+    onTextDetected: TextDetectionCallback;
+    style: ViewFinderConfiguration;
 }
 export declare class TextDataScannerState extends ScanbotCameraState {
     isFinderVisible?: boolean;
@@ -14,14 +18,13 @@ export default class TextDataScannerView extends ScannerView<TextDataScannerProp
     finder?: ViewFinder;
     shouldComputeSize: boolean;
     private paused;
-    private _configuration?;
     constructor(props: TextDataScannerProps);
-    get configuration(): TextDataScannerConfiguration;
+    get configuration(): ScannerConfiguration;
     get enabled(): boolean;
     /**
      * Public API functions
      */
-    static create(configuration: TextDataScannerConfiguration, textDataScanner: TextDataScanner): Promise<TextDataScannerView>;
+    static create(configuration: ScannerConfiguration, style: ViewFinderConfiguration, onTextDetected: TextDetectionCallback, textDataScanner: TextDataScanner): Promise<TextDataScannerView>;
     isDetectionPaused(): boolean;
     resumeDetection(): Promise<void>;
     pauseDetection(): void;

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

@@ -15,6 +15,6 @@ export default class BarcodePolygonLabel extends React.Component<BarcodePolygonL
     style(style: BarcodePolygonLabelStyle): void;
     update(model: BarcodeOverlay): void;
     label: HTMLDivElement;
-    formatText(code: Barcode, format: SelectionOverlayTextFormat): string;
+    formatText(code: Barcode, format: SelectionOverlayTextFormat): string | undefined;
     render(): React.ReactNode;
 }