scanbot-web-sdk 3.1.0-alpha.1 → 4.0.0-alpha.2

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

@@ -38,7 +38,7 @@ export default class DocumentScannerView extends ScannerView<DocumentScannerProp
      * Internal functions
      */
     componentDidMount(): Promise<void>;
-    componentWillUnmount(): void;
+    componentWillUnmount(): Promise<void>;
     detect(): Promise<void>;
     getStatusString(detectionResult: any): string;
     detectInWebWorker(): Promise<any>;

package/@types/model/barcode/barcode-format.d.ts

@@ -1 +1 @@
-export declare type BarcodeFormat = "AZTEC" | "CODABAR" | "CODE_39" | "CODE_93" | "CODE_128" | "DATA_MATRIX" | "EAN_8" | "EAN_13" | "ITF" | "MAXICODE" | "PDF_417" | "QR_CODE" | "RSS_14" | "RSS_EXPANDED" | "UPC_A" | "UPC_E" | "UPC_EAN_EXTENSION" | "MSI_PLESSEY" | "IATA_2_OF_5" | "INDUSTRIAL_2_OF_5" | "CODE_25" | "MICRO_QR_CODE";
+export declare type BarcodeFormat = "AZTEC" | "CODABAR" | "CODE_39" | "CODE_93" | "CODE_128" | "DATA_MATRIX" | "EAN_8" | "EAN_13" | "ITF" | "MAXICODE" | "PDF_417" | "QR_CODE" | "RSS_14" | "RSS_EXPANDED" | "UPC_A" | "UPC_E" | "UPC_EAN_EXTENSION" | "MSI_PLESSEY" | "IATA_2_OF_5" | "INDUSTRIAL_2_OF_5" | "CODE_25" | "MICRO_QR_CODE" | "USPS_INTELLIGENT_MAIL" | "ROYAL_MAIL" | "JAPAN_POST" | "ROYAL_TNT_POST" | "AUSTRALIA_POST" | "DATABAR_LIMITED";

package/@types/model/configuration/barcode-count-configuration.d.ts

@@ -1,5 +1,5 @@
 export declare class BarcodeCountStyleConfiguration {
-    topLabelTop: number;
+    topLabelTop?: number;
     sheetHeight?: string;
     sheetTopMargin?: string;
 }

package/@types/model/configuration/document-quality-analyzer-configuration.d.ts

@@ -0,0 +1,7 @@
+export default class DocumentQualityAnalyzerConfiguration {
+    /**
+     * Patch size should be approx. 512-768. It governs the trade-off between speed and memory usage.
+     * Smaller patch sizes use less memory but take longer. Defaults to 512.
+     */
+    patchSize: number;
+}

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

@@ -1,10 +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 type ValidatorPreset = "VehicleIdentificationNumber";
 export declare class TextDataScannerConfiguration extends ScannerConfiguration {
     constructor();
     ocrResolutionLimit?: number;
     supportedLanguages?: string[];
+    validatorPreset?: ValidatorPreset;
     style?: ViewFinderConfiguration;
     onTextDetected?: (e: TextDataScannerResult) => void;
     static fromJson(json: any): TextDataScannerConfiguration;

package/@types/model/response/document-quality-analyzer-result.d.ts

@@ -0,0 +1,8 @@
+export declare type DocumentQuality = "NO_DOCUMENT" | "VERY_POOR" | "POOR" | "REASONABLE" | "GOOD" | "EXCELLENT";
+export default interface DocumentQualityAnalyzerResult {
+    /**
+    * Result of document quality analysis.
+    * It is used to determine if the document is good enough to be used for OCR processing.
+    */
+    quality: DocumentQuality;
+}

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

@@ -19,10 +19,11 @@ import { MrzScannerConfiguration } from "./model/configuration/mrz-scanner-confi
 import { IMrzScannerHandle } from "./interfaces/i-mrz-scanner-handle";
 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";
+import DocumentQualityAnalyzerConfiguration from "./model/configuration/document-quality-analyzer-configuration";
+import DocumentQualityAnalyzer from "./service/document-quality-analyzer";
 export default class ScanbotSDK {
     bridge: WorkerBridge;
     initialized: boolean;
@@ -44,11 +45,12 @@ export default class ScanbotSDK {
     applyFilter(imageBuffer: ArrayBuffer, filterType: ImageFilter): Promise<ArrayBuffer>;
     rotateImageCcw(imageBuffer: ArrayBuffer, rotations: number): Promise<ArrayBuffer>;
     cropAndRotateImageCcw(imageBuffer: ArrayBuffer, polygon: Polygon, rotations: number): Promise<any>;
+    analyzeDocumentQuality(imageBuffer: ArrayBuffer, polygon: Polygon, rotations: number): Promise<any>;
     detectDocument(imageBuffer: ArrayBuffer, acceptedAngleScore?: number, acceptedSizeScore?: number): Promise<ContourDetectionResult>;
     detectBarcodes(base64: string, engineMode?: EngineMode, barcodeFormats?: BarcodeFormat[], returnBarcodeImage?: boolean): Promise<BarcodeResult>;
     createSimpleMRZRecognizer(): Promise<SimpleMrzRecognizer>;
     createOcrEngine(languages: Array<string>): Promise<OcrEngine>;
-    createBlurDetector(): Promise<BlurDetector>;
+    createDocumentQualityAnalyzer(config?: DocumentQualityAnalyzerConfiguration): Promise<DocumentQualityAnalyzer>;
     /**
      * Misc. Features
      */
@@ -63,5 +65,6 @@ export default class ScanbotSDK {
      */
     throwIfMissingBuffer(buffer: any): void;
     throwIfMissing(property: any, message: string): void;
+    release(object: any, source?: string): Promise<void>;
     private licenseCheck;
 }

package/@types/service/document-quality-analyzer.d.ts

@@ -0,0 +1,9 @@
+import ScanbotSDK from '../scanbot-sdk';
+import DocumentQualityAnalyzerResult from '../model/response/document-quality-analyzer-result';
+export default class DocumentQualityAnalyzer {
+    _token: string;
+    _sdk: ScanbotSDK;
+    constructor(sdk: ScanbotSDK, token: string);
+    analyze(imageData: ArrayBuffer): Promise<DocumentQualityAnalyzerResult>;
+    release(): Promise<void>;
+}

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

@@ -1,21 +1,19 @@
 import ScanbotSDK from '../scanbot-sdk';
-/**
- * Paper size calculation:
- * - if a standard paper size is given, that paper size is used
- * - otherwise if both paperWidthInches and paperHeightInches is set, those values are used
- * - otherwise the paper size is calculated to fit the input image exactly at the given DPI. If no
- *      DPI value is given, a default DPI of 72 is used.
- *
- * DPI calculation:
- * - if a DPI is given, then that value is used. If the value is not given or
- *      that value is too small for the entire image to fit on the page, then
- *      the smallest possible DPI value is chosen so that the entire image fits on the page.
- */
+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";
 export interface PdfGenerationOptions {
-    dpi?: number;
-    standardPaperSize?: 'A4' | 'Letter' | 'Legal';
-    paperWidthInches?: number;
-    paperHeightInches?: number;
+    standardPaperSize?: PageSize;
     landscape?: boolean;
 }
 export default class PdfGenerator {