capacitor-plugin-scanbot-sdk - npm Package Compare versions

Comparing version 4.3.0 to 5.1.0-beta.1

dist/esm/arguments.d.ts

@@ -1,4 +0,10 @@
-import type { BarcodeDocumentFormat, BarcodeFormat, CheckStandard, Gs1HandlingMode, MSIPlesseyChecksumAlgorithm } from './types';
-interface InternalBarcodeDetectionCommonParameters {
+import type { CustomBinarizationFilter, ScanbotBinarizationFilter } from './ParametricFilters';
+import type { DocumentsModelRootType } from './documents/DocumentsModel';
+import type { BarcodeDocumentFormat, BarcodeFormat, CodeDensity, EngineMode, Gs1HandlingMode, MSIPlesseyChecksumAlgorithm, PageDirection, PageSize } from './types';
+export interface DetectBarcodesOnImageArguments {
     /**
+     * The input image file URI
+     */
+    imageFileUri: string;
+    /**
      * Accepted barcode formats
@@ -13,2 +19,6 @@ */
     /**
+     * Barcode scanner engine mode. Default is NEXT_GEN
+     */
+    engineMode?: EngineMode;
+    /**
      * Optional minimum required text length of the detected barcode.
@@ -47,16 +57,12 @@ * The default is 0 (setting is turned off).
     msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm;
-}
-export interface DetectBarcodesOnImageArguments extends InternalBarcodeDetectionCommonParameters {
     /**
-     * The input image file URI
-     */
-    imageFileUri: string;
-}
-export interface DetectBarcodesOnImagesArguments extends InternalBarcodeDetectionCommonParameters {
+     * If `true`, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If `false` - mode is disabled. The default is `false`. Android only.
+     * */
+    lowPowerMode?: boolean;
     /**
-     * The input image files URIs
+     * The expected density of QR codes in an image.
      */
-    imageFileUris: string[];
+    codeDensity?: CodeDensity;
 }
-interface PdfExtractorArguments {
+export interface PdfExtractorArguments {
     /**
@@ -85,23 +91,36 @@ * The location of the PDF file
 }
-export interface PerformOCRArguments {
-    imageFileUris: string[];
-    languages: string[];
+export interface DocumentQualityAnalyzerArguments {
+    imageFileUri: string;
+    imageSizeLimit?: number;
+    minimumNumberOfSymbols?: number;
+}
+export interface RecognizeMedicalCertificateArguments {
+    imageFileUri: string;
     options?: {
-        outputFormat?: OCROutputFormat;
-        engineMode?: OCREngineMode;
+        patientInfoRecognitionEnabled?: boolean;
+        barcodeRecognitionEnabled?: boolean;
+        detectDocumentEnabled?: boolean;
+        returnCroppedDocumentUri?: boolean;
     };
 }
-export interface PDFMetadata {
-    author?: string;
-    creator?: string;
-    title?: string;
-    subject?: string;
-    keywords?: string;
+export interface RecognizeGenericDocumentArguments {
+    imageFileUri: string;
+    acceptedDocumentFormats?: DocumentsModelRootType[];
+    sharpnessAcceptanceFactor?: number;
 }
+export interface PerformOCRArguments {
+    imageFileUris: string[];
+    ocrConfiguration?: OCRConfiguration;
+}
 export interface CreatePDFArguments {
     imageFileUris: string[];
     options?: {
-        pageSize?: PDFPageSize;
-        pageOrientation?: PDFPageOrientation;
+        pageSize?: PageSize;
+        pageDirection?: PageDirection;
         metadata?: PDFMetadata;
+        pageFitMode?: PDFPageFitMode;
+        dpi?: number;
+        jpegQuality?: number;
+        resample?: boolean;
+        ocrConfiguration?: OCRConfiguration;
     };
@@ -112,27 +131,71 @@ }
     options?: {
-        oneBitEncoded?: boolean;
+        binarizationFilter?: CustomBinarizationFilter | ScanbotBinarizationFilter;
         dpi?: number;
         compression?: TIFFCompression;
+        userDefinedFields?: TIFFUserDefinedField[];
     };
 }
-export type OCROutputFormat = 'PLAIN_TEXT' | 'PDF_FILE' | 'RESULT_JSON' | 'FULL_OCR_RESULT';
-export type OCREngineMode = 'SCANBOT_OCR' | 'TESSERACT';
-export type PDFPageSize = 'A3' | 'A4' | 'A5' | 'B4' | 'B5' | 'COMM10' | 'CUSTOM' | 'EXECUTIVE' | 'LEGAL' | 'LETTER' | 'US4x6' | 'US4x8' | 'US5x7';
-export type PDFPageOrientation = 'PORTRAIT' | 'LANDSCAPE' | 'AUTO';
-export type TIFFCompression = 'NONE' | 'CCITTRLE' | 'CCITTFAX3' | 'CCITT_T4' | 'CCITTFAX4' | 'CCITT_T6' | 'LZW' | 'CCITTRLEW' | 'PACKBITS' | 'DEFLATE' | 'ADOBE_DEFLATE';
-export interface ExtractImagesFromPdfArguments extends PdfExtractorArguments {
+export type OCRConfiguration = OCRScanbotEngineConfiguration | OCRTesseractConfiguration;
+/** Slow but powerful OCR engine. Supports non-Latin languages. */
+export type OCRTesseractConfiguration = {
+    engineMode: 'TESSERACT';
+    languages: string[];
+};
+/** Fast and accurate OCR engine. Supports only Latin languages. */
+export type OCRScanbotEngineConfiguration = {
+    engineMode: 'SCANBOT_OCR';
+};
+export interface PDFMetadata {
+    author?: string;
+    creator?: string;
+    title?: string;
+    subject?: string;
+    keywords?: string;
 }
-export interface ExtractPagesFromPdfArguments extends PdfExtractorArguments {
+export type PDFPageFitMode = 
+/** Fit image into page, preserves aspect ratio. */
+'FIT_IN'
+/** Fill page with image, preserves aspect ratio. */
+ | 'FILL_IN'
+/** Stretch image to fill page, does NOT preserve aspect ratio. */
+ | 'STRETCH'
+/** No resizing, centers the image. */
+ | 'NONE';
+/** TIFF Compression algorithms. */
+export type TIFFCompression = 
+/** Supported with binarized images. Supported with colored images. */
+'NONE'
+/** Supported with binarized images. Is not supported with colored images. */
+ | 'CCITTRLE'
+/** Supported with binarized images. Is not supported with colored images. */
+ | 'CCITT_T4'
+/** Supported with binarized images. Is not supported with colored images. */
+ | 'CCITT_T6'
+/** Supported with binarized images. Supported with colored images. */
+ | 'LZW'
+/** Supported with binarized images. Is not supported with colored images. */
+ | 'CCITTRLEW'
+/** Supported with binarized images. Supported with colored images. */
+ | 'PACKBITS'
+/** Supported with binarized images. Supported with colored images. */
+ | 'DEFLATE'
+/** Supported with binarized images. Supported with colored images. */
+ | 'ADOBE_DEFLATE';
+/** Class used to describe user-defined TIFF field. */
+export interface TIFFUserDefinedField {
+    /** Value of the field. */
+    fieldValue: string | number;
+    /** Field name. */
+    fieldName: string;
+    /** Field numeric tag. */
+    fieldTag: number;
+    /** Field type. */
+    fieldType: TIFFUserDefinedFieldType;
 }
-export interface RecognizeCheckOnImageArgs {
-    /**
-     * The input image file URI.
-     */
-    imageFileUri: string;
-    /**
-     * An optional array of check types that act as a detection filter.
-     * By default all supported check formats will be detected.
-     */
-    acceptedCheckStandards?: CheckStandard[];
-}
-export {};
+export type TIFFUserDefinedFieldType = 
+/** A numeric field type. */
+'NUMERIC'
+/** A string based field type. */
+ | 'STRING';
+export type ExtractImagesFromPdfArguments = PdfExtractorArguments;
+export type ExtractPagesFromPdfArguments = PdfExtractorArguments;

dist/esm/index.d.ts

@@ -1,12 +0,28 @@
-import type { CreatePDFArguments, DetectBarcodesOnImageArguments, DetectBarcodesOnImagesArguments, ExtractImagesFromPdfArguments, ExtractPagesFromPdfArguments, PerformOCRArguments, WriteTIFFArguments } from './arguments';
+import type { ParametricFilter } from './ParametricFilters';
+import type { CreatePDFArguments, DetectBarcodesOnImageArguments, DocumentQualityAnalyzerArguments, ExtractImagesFromPdfArguments, ExtractPagesFromPdfArguments, PerformOCRArguments, RecognizeGenericDocumentArguments, RecognizeMedicalCertificateArguments, WriteTIFFArguments } from './arguments';
 import type { BarcodeScannerConfiguration, BatchBarcodeScannerConfiguration, CheckRecognizerConfiguration, CroppingConfiguration, DocumentScannerConfiguration, FinderDocumentScannerConfiguration, GenericDocumentRecognizerConfiguration, HealthInsuranceCardScannerConfiguration, LicensePlateScannerConfiguration, MedicalCertificateRecognizerConfiguration, MrzScannerConfiguration, ScanbotSdkConfiguration, TextDataScannerConfiguration, VinScannerConfiguration } from './configurations';
-import type { ResultWrapper } from './definitions';
-import type { GenericDocumentRecognizerResult } from './gdr/gdr-base-wrappers';
-import type { ApplyImageFilterResult, BarcodeScannerResult, BatchBarcodeScannerResult, CreatePDFResult, CroppingResult, DetectBarcodesOnImageResult, DetectBarcodesOnImagesResult, DetectDocumentResult, DocumentQualityAnalyzerResult, DocumentScannerResult, ExtractImagesFromPdfResult, ExtractPagesFromPdfResult, GetFilteredDocumentPreviewUriResult, GetImageDataResult, GetLicenseInfoResult, GetOCRConfigsResult, HealthInsuranceCardScannerResult, InitializeSDKResult, LicensePlateScannerResult, MedicalCertificateScannerResult as MedicalCertificateRecognizerResult, MrzScannerResult, PerformOCRResult, RecognizeMRZResult, RefreshImageUrisResult, RemovePageResult, RotateImageResult, TextDataScannerResult, VinScannerResult, WriteTIFFResult } from './results';
-import type { ApplyImageFilterOnPageResult, CheckRecognizerResult, CheckStandard, CreatePageResult, DetectDocumentOnPageResult, ImageFilterType, Page, RecognizeCheckResult, RotatePageResult, SetDocumentImageResult } from './types';
+import type { ResultWrapper } from './customTypes';
+import type { CheckDocumentModelRootType } from './documents/CheckDocumentModel';
+import type { ApplyImageFiltersResult, BarcodeScannerResult, BatchBarcodeScannerResult, CheckRecognizerResult, CreatePDFResult, CroppingResult, DetectBarcodesOnImageResult, DetectDocumentResult, DocumentQualityAnalyzerResult, DocumentScannerResult, ExtractImagesFromPdfResult, ExtractPagesFromPdfResult, GenericDocumentRecognizerResult, GetImageDataResult, GetLicenseInfoResult, GetOCRConfigsResult, HealthInsuranceCardScannerResult, InitializeSDKResult, LicensePlateScannerResult, MedicalCertificateScannerResult, MrzScannerResult, PerformOCRResult, RecognizeEHICResult, RecognizeGenericDocumentResult, RecognizeMedicalCertificateResult, RecognizeMRZResult, RefreshImageUrisResult, RotateImageResult, TextDataScannerResult, VinScannerResult, WriteTIFFResult } from './results';
+import type { ApplyImageFiltersOnPageResult, CreatePageResult, DetectDocumentOnPageResult, Page, RotatePageResult, SetDocumentImageResult } from './types';
 export interface ScanbotSDKCapacitorPlugin {
+    /**
+     * Opens the Ready-To-Use UI Document Scanner screen with the desired configuration.
+     */
     startDocumentScanner(configuration: DocumentScannerConfiguration): Promise<ResultWrapper<DocumentScannerResult>>;
+    /**
+     * Forces the Ready-To-Use UI Document Scanner screen to close while it is running.
+     */
     closeDocumentScanner(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI Finder Document Scanner screen with the desired configuration.
+     */
     startFinderDocumentScanner(configuration: FinderDocumentScannerConfiguration): Promise<ResultWrapper<DocumentScannerResult>>;
+    /**
+     * Forces the Ready-To-Use UI Finder Document Scanner screen to close while it is running.
+     */
     closeFinderDocumentScanner(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI Cropping screen with the desired configuration.
+     */
     startCroppingScreen(args: {
@@ -16,39 +32,129 @@ page: Page;
     }): Promise<ResultWrapper<CroppingResult>>;
+    /**
+     * Forces the Ready-To-Use UI Cropping screen to close while it is running.
+     */
     closeCroppingScreen(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI MRZ Scanner screen with the desired configuration.
+     */
     startMrzScanner(configuration: MrzScannerConfiguration): Promise<ResultWrapper<MrzScannerResult>>;
+    /**
+     * Forces the Ready-To-Use UI MRZ Scanner screen to close while it is running.
+     */
     closeMrzScanner(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI Barcode Scanner screen with the desired configuration.
+     *
+     * @deprecated Use ***startBarcodeScanner*** from ***'capacitor-plugin-scanbot-sdk/ui_v2'*** instead.
+     */
     startBarcodeScanner(configuration: BarcodeScannerConfiguration): Promise<ResultWrapper<BarcodeScannerResult>>;
+    /**
+     * Forces the Ready-To-Use UI Barcode Scanner screen to close while it is running.
+     *
+     * @deprecated
+     */
     closeBarcodeScanner(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI Batch Barcode Scanner screen with the desired configuration.
+     *
+     * @deprecated Use ***startBarcodeScanner*** from ***'capacitor-plugin-scanbot-sdk/ui_v2'*** instead.
+     */
     startBatchBarcodeScanner(configuration: BatchBarcodeScannerConfiguration): Promise<ResultWrapper<BatchBarcodeScannerResult>>;
+    /**
+     * Forces the Ready-To-Use UI Batch Barcode Scanner screen to close while it is running.
+     *
+     * @deprecated
+     */
     closeBatchBarcodeScanner(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI European Health Insurance Card Scanner screen with the desired configuration.
+     */
     startEHICScanner(configuration: HealthInsuranceCardScannerConfiguration): Promise<ResultWrapper<HealthInsuranceCardScannerResult>>;
+    /**
+     * Forces the Ready-To-Use UI European Health Insurance Card Scanner screen to close while it is running.
+     */
     closeEHICScanner(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI Text Data Scanner screen with the desired configuration.
+     */
     startTextDataScanner(configuration: TextDataScannerConfiguration): Promise<ResultWrapper<TextDataScannerResult>>;
+    /**
+     * Forces the Ready-To-Use UI Text Data Scanner screen to close while it is running.
+     */
     closeTextDataScanner(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI License Plate Scanner screen with the desired configuration.
+     */
     startLicensePlateScanner(configuration: LicensePlateScannerConfiguration): Promise<ResultWrapper<LicensePlateScannerResult>>;
+    /**
+     * Forces the Ready-To-Use UI License Plate Scanner screen to close while it is running.
+     */
     closeLicensePlateScanner(): Promise<void>;
-    startMedicalCertificateRecognizer(configuration: MedicalCertificateRecognizerConfiguration): Promise<ResultWrapper<MedicalCertificateRecognizerResult>>;
+    /**
+     * Opens the Ready-To-Use UI Medical Certificate Recognizer screen with the desired configuration.
+     */
+    startMedicalCertificateRecognizer(configuration: MedicalCertificateRecognizerConfiguration): Promise<ResultWrapper<MedicalCertificateScannerResult>>;
+    /**
+     * Forces the Ready-To-Use UI Medical Certificate Recognizer screen to close while it is running.
+     */
     closeMedicalCertificateRecognizer(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI Generic Document Recognizer screen with the desired configuration.
+     */
     startGenericDocumentRecognizer(configuration: GenericDocumentRecognizerConfiguration): Promise<ResultWrapper<GenericDocumentRecognizerResult>>;
+    /**
+     * Forces the Ready-To-Use UI Generic Document Recognizer screen to close while it is running.
+     */
     closeGenericDocumentRecognizer(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI Check Recognizer screen with the desired configuration.
+     */
     startCheckRecognizer(configuration: CheckRecognizerConfiguration): Promise<ResultWrapper<CheckRecognizerResult>>;
+    /**
+     * Forces the Ready-To-Use UI Check Recognizer screen to close while it is running.
+     */
     closeCheckRecognizer(): Promise<void>;
+    /**
+     * Opens the Ready-To-Use UI VIN Scanner screen with the desired configuration.
+     */
     startVinScanner(configuration: VinScannerConfiguration): Promise<ResultWrapper<VinScannerResult>>;
+    /**
+     * Forces the Ready-To-Use UI VIN Scanner screen to close while it is running.
+     */
     closeVinScanner(): Promise<void>;
-    /** SDK Operations **/
-    initializeSDK(options: ScanbotSdkConfiguration): Promise<ResultWrapper<InitializeSDKResult>>;
+    /**
+     * Initializes the Scanbot SDK with the preferred configuration.
+     */
+    initializeSDK(config: ScanbotSdkConfiguration): Promise<ResultWrapper<InitializeSDKResult>>;
+    /**
+     * Provides complete information about the current license status.
+     */
     getLicenseInfo(): Promise<ResultWrapper<GetLicenseInfoResult>>;
+    /**
+     * Detects barcodes on the image represented by the file URI. The image file URI is part of the input arguments.
+     */
     detectBarcodesOnImage(args: DetectBarcodesOnImageArguments): Promise<ResultWrapper<DetectBarcodesOnImageResult>>;
-    detectBarcodesOnImages(args: DetectBarcodesOnImagesArguments): Promise<ResultWrapper<DetectBarcodesOnImagesResult>>;
-    applyImageFilter(args: {
+    /**
+     * Applies the given filters to the given image, and returns its URI.
+     */
+    applyImageFilters(args: {
         imageFileUri: string;
-        filter: ImageFilterType;
-    }): Promise<ResultWrapper<ApplyImageFilterResult>>;
-    applyImageFilterOnPage(args: {
+        filters: ParametricFilter[];
+    }): Promise<ResultWrapper<ApplyImageFiltersResult>>;
+    /**
+     * Applies the given filters to the given page.
+     */
+    applyImageFiltersOnPage(args: {
         page: Page;
-        filter: ImageFilterType;
-    }): Promise<ResultWrapper<ApplyImageFilterOnPageResult>>;
+        filters: ParametricFilter[];
+    }): Promise<ResultWrapper<ApplyImageFiltersOnPageResult>>;
+    /**
+     * Returns the BASE64 Image Data for the given image.
+     */
     getImageData(args: {
         imageFileUri: string;
     }): Promise<ResultWrapper<GetImageDataResult>>;
+    /**
+     * Rotates the given image by the specified degrees.
+     */
     rotateImage(args: {
@@ -58,8 +164,17 @@ imageFileUri: string;
     }): Promise<ResultWrapper<RotateImageResult>>;
+    /**
+     * Creates a page with the image located at the given URI.
+     */
     createPage(args: {
         imageUri: string;
     }): Promise<ResultWrapper<CreatePageResult>>;
+    /**
+     * Removes the given page from the storage.
+     */
     removePage(args: {
         page: Page;
-    }): Promise<ResultWrapper<RemovePageResult>>;
+    }): Promise<ResultWrapper<void>>;
+    /**
+     * Rotates the given page for the number of 90 degree clockwise rotations. Negative values will rotate counterclockwise.
+     */
     rotatePage(args: {
@@ -69,2 +184,5 @@ page: Page;
     }): Promise<ResultWrapper<RotatePageResult>>;
+    /**
+     * Applies the given image to the desired page.
+     */
     setDocumentImage(args: {
@@ -74,43 +192,99 @@ page: Page;
     }): Promise<ResultWrapper<SetDocumentImageResult>>;
+    /**
+     * Detects document on the given image and returns the result.
+     */
     detectDocument(args: {
         imageFileUri: string;
     }): Promise<ResultWrapper<DetectDocumentResult>>;
+    /**
+     * Detects document on the given page and returns the result.
+     */
     detectDocumentOnPage(args: {
         page: Page;
     }): Promise<ResultWrapper<DetectDocumentOnPageResult>>;
-    documentQualityAnalyzer(args: {
-        imageFileUri: string;
-        imageSizeLimit?: number;
-    }): Promise<ResultWrapper<DocumentQualityAnalyzerResult>>;
+    /**
+     * Detects the quality of the document on a still image.
+     */
+    documentQualityAnalyzer(args: DocumentQualityAnalyzerArguments): Promise<ResultWrapper<DocumentQualityAnalyzerResult>>;
+    /**
+     * Extracts images from a PDF represented by the file URL. The PDF file URL is part of the input arguments.
+     */
     extractImagesFromPdf(args: ExtractImagesFromPdfArguments): Promise<ResultWrapper<ExtractImagesFromPdfResult>>;
+    /**
+     * Extracts images from a PDF represented by the file URL, creates pages from them and returns the created pages.
+     * The PDF file URL is part of the input arguments.
+     */
     extractPagesFromPdf(args: ExtractPagesFromPdfArguments): Promise<ResultWrapper<ExtractPagesFromPdfResult>>;
+    /**
+     * Recognizes a Check on the given image.
+     * Set desired check standards or leave it empty/undefined to recognize all supported checks.
+     */
     recognizeCheck(args: {
         imageFileUri: string;
-        acceptedCheckStandards?: CheckStandard[];
-    }): Promise<ResultWrapper<RecognizeCheckResult>>;
+        acceptedCheckStandards?: CheckDocumentModelRootType[];
+    }): Promise<ResultWrapper<CheckRecognizerResult>>;
+    /**
+     * Recognizes an MRZ on the given image.
+     */
     recognizeMrz(args: {
         imageFileUri: string;
     }): Promise<ResultWrapper<RecognizeMRZResult>>;
+    /**
+     * Recognizes a Medical Certificate on the given image.
+     * Modify the result with extra options that are part of the input arguments.
+     */
+    recognizeMedicalCertificate(args: RecognizeMedicalCertificateArguments): Promise<ResultWrapper<RecognizeMedicalCertificateResult>>;
+    /**
+     * Recognizes a European Health Insurance Card (EHIC) on the given image.
+     */
+    recognizeEHIC(args: {
+        imageFileUri: string;
+    }): Promise<ResultWrapper<RecognizeEHICResult>>;
+    /**
+     * Recognizes a generic document on the given image.
+     * Set the expected generic document formats or leave it empty/undefined to recognize all supported generic document formats.
+     */
+    recognizeGenericDocument(args: RecognizeGenericDocumentArguments): Promise<ResultWrapper<RecognizeGenericDocumentResult>>;
+    /**
+     * Recreates the given pages to refresh the Image URIs.
+     */
     refreshImageUris(args: {
         pages: Page[];
     }): Promise<ResultWrapper<RefreshImageUrisResult>>;
+    /**
+     * Returns the available OCR configs.
+     */
     getOCRConfigs(): Promise<ResultWrapper<GetOCRConfigsResult>>;
+    /**
+     * Removes all files generated by this plugin.
+     */
     cleanup(): Promise<ResultWrapper<void>>;
-    getFilteredDocumentPreviewUri(args: {
-        page: Page;
-        filter: ImageFilterType;
-    }): Promise<ResultWrapper<GetFilteredDocumentPreviewUriResult>>;
+    /**
+     * Performs OCR on given images. Set preferred ***ocrConfiguration*** engine, or leave it undefined to use the default one which is ***OCRScanbotEngineConfiguration***.
+     * If ***OCRTesseractConfiguration*** is used, the expected ***languages*** need to be set.
+     */
     performOCR(args: PerformOCRArguments): Promise<ResultWrapper<PerformOCRResult>>;
+    /**
+     * Creates a PDF using the given list of image file URIs.
+     * Please check the extra options that are part of the input arguments to modify the created PDF file per your needs.
+     */
     createPDF(args: CreatePDFArguments): Promise<ResultWrapper<CreatePDFResult>>;
+    /**
+     * Creates a TIFF using the given list of image file URIs.
+     * Please check the extra options that are part of the input arguments to modify the created TIFF file per your needs.
+     */
     writeTIFF(args: WriteTIFFArguments): Promise<ResultWrapper<WriteTIFFResult>>;
 }
 declare const ScanbotSDK: ScanbotSDKCapacitorPlugin;
-export * from './definitions';
-export * from './types';
+export { ScanbotSDK };
 export * from './arguments';
 export * from './configurations';
+export * from './customTypes';
+export * from './ParametricFilters';
 export * from './results';
-export * from './gdr/gdr-base-wrappers';
-export * from './gdr/generic_document_types';
-export * from './gdr/generic_document_wrappers';
-export { ScanbotSDK };
+export * from './types';
+export * from './documents/BarcodeDocumentModel';
+export * from './documents/CheckDocumentModel';
+export * from './documents/CommonFieldType';
+export * from './documents/DocumentsModel';
+export * from './documents/GenericDocument';

dist/esm/index.js

 import { registerPlugin } from '@capacitor/core';
-const scanbot = registerPlugin('ScanbotSDKCapacitor', {});
-const ScanbotSDK = scanbot;
-export * from './definitions';
-export * from './types';
+const _registeredPlugin = registerPlugin('ScanbotSDKCapacitor', {});
+const ScanbotSDK = _registeredPlugin;
+/** @internal */
+const _ScanbotSDKUiV2 = _registeredPlugin;
+export { ScanbotSDK };
+/** @internal */
+export { _ScanbotSDKUiV2 };
 export * from './arguments';
 export * from './configurations';
+export * from './customTypes';
+export * from './ParametricFilters';
 export * from './results';
-export * from './gdr/gdr-base-wrappers';
-export * from './gdr/generic_document_types';
-export * from './gdr/generic_document_wrappers';
-export { ScanbotSDK };
+export * from './types';
+export * from './documents/BarcodeDocumentModel';
+export * from './documents/CheckDocumentModel';
+export * from './documents/CommonFieldType';
+export * from './documents/DocumentsModel';
+export * from './documents/GenericDocument';
 //# sourceMappingURL=index.js.map

dist/esm/results.d.ts

@@ -1,4 +0,4 @@
-import type { MRZDocument } from './gdr/generic_document_wrappers';
-import type { BarcodeResultField, CheckRecognizerResult, DetectBarcodesOnImagesField, DetectionStatus, DocumentQuality, HealthInsuranceCardField, LicenseStatus, MRZDocumentType, MedicalCertificateCheckboxesInfo, MedicalCertificateDatesInfo, MedicalCertificateFormType, MedicalCertificatePatientDataInfo, Page, PolygonPoint, TextDataRecognitionResult } from './types';
-export interface ApplyImageFilterResult {
+import type { GenericDocument } from './documents/GenericDocument';
+import type { BarcodeResultField, CheckStatus, DetectionStatus, DocumentQuality, HealthInsuranceCardDetectionStatus, HealthInsuranceCardField, LicenseStatus, MRZDocumentTypes, MedicalCertificateCheckboxesInfo, MedicalCertificateDatesInfo, MedicalCertificateFormType, MedicalCertificatePatientDataInfo, OCRPage, Page, PolygonPoint, RecognitionStatus, TextDataRecognitionResult } from './types';
+export interface ApplyImageFiltersResult {
     /** The URI of the filtered image */
@@ -11,6 +11,11 @@ imageFileUri: string;
 }
-export interface BatchBarcodeScannerResult extends BarcodeScannerResult {
+export type BatchBarcodeScannerResult = BarcodeScannerResult;
+export interface CheckRecognizerResult {
+    /** Check Document represented as Generic Document */
+    check: GenericDocument;
+    /** The status of the operation */
+    checkStatus: CheckStatus;
+    /** The URI of the snapped Check Image */
+    imageFileUri?: string;
 }
-export interface CheckRecognizerScreenResult extends CheckRecognizerResult {
-}
 export interface CreatePDFResult {
@@ -22,3 +27,3 @@ /** The URI of the generated PDF file */
     /** The cropped page */
-    page?: Page;
+    page: Page;
 }
@@ -29,11 +34,7 @@ export interface DetectBarcodesOnImageResult {
 }
-export interface DetectBarcodesOnImagesResult {
-    /** An array for which each element has a imageUri and the list of detected barcodes */
-    results: DetectBarcodesOnImagesField[];
-}
 export interface DetectDocumentResult {
     /** The URI of the document image file, if something is detected */
-    documentImageFileUri?: string;
+    documentImageFileUri: string;
     /** The array of detected polygon points, if something is detected */
-    polygon?: PolygonPoint[];
+    polygon: PolygonPoint[];
     /** The status of the detection */
@@ -53,2 +54,4 @@ detectionResult: DetectionStatus;
     fields: HealthInsuranceCardField[];
+    /** Health Insurance Card detection status. */
+    detectionStatus: HealthInsuranceCardDetectionStatus;
 }
@@ -63,8 +66,7 @@ export interface ExtractImagesFromPdfResult {
 }
-export interface FinderDocumentScannerResult extends DocumentScannerResult {
+export type FinderDocumentScannerResult = DocumentScannerResult;
+export interface GenericDocumentRecognizerResult {
+    /** List of recognized Generic Documents */
+    documents: GenericDocument[];
 }
-export interface GetFilteredDocumentPreviewUriResult {
-    /** The URI of the filtered document preview image */
-    filteredDocumentPreviewUri: string;
-}
 export interface GetImageDataResult {
@@ -94,7 +96,7 @@ /** The Base 64 encoded representation of the image data */
     /** The License Plate detected by the scanner */
-    licensePlate?: string;
+    licensePlate: string;
     /** Confidence in result accuracy. The value ranges from 0 to 100, higher is better. */
-    confidence?: number;
+    confidence: number;
     /** The Country Code on the License Plate as detected by the scanner */
-    countryCode?: string;
+    countryCode: string;
 }
@@ -113,12 +115,19 @@ export interface MedicalCertificateScannerResult {
 }
-export interface MrzScannerResult extends RecognizeMRZResult {
-}
+export type MrzScannerResult = RecognizeMRZResult;
 export interface PerformOCRResult {
     /** The OCR result as plain text */
-    plainText?: string;
-    /** The URI of the PDF file */
-    pdfFileUri?: string;
-    /** The OCR result as JSON data */
-    jsonData?: any;
+    plainText: string;
+    /** The array of recognized OCR pages */
+    pages: OCRPage[];
 }
+export type RecognizeEHICResult = HealthInsuranceCardScannerResult;
+export interface RecognizeGenericDocumentResult {
+    /** Recognition status */
+    recognitionStatus: RecognitionStatus;
+    /** Cropped document image if it was detected */
+    imageFileUri?: string;
+    /** Contains a document which might be wrapped into one of {@link DocumentsModelRootType} */
+    document?: GenericDocument;
+}
+export type RecognizeMedicalCertificateResult = MedicalCertificateScannerResult;
 export interface RecognizeMRZResult {
@@ -128,3 +137,3 @@ /** True if the recognition was successful, false otherwise */
     /** The recognized document type */
-    documentType: MRZDocumentType;
+    documentType: MRZDocumentTypes;
     /** Total number of check digits as required by the travel document type */
@@ -136,4 +145,4 @@ checkDigitsCount: number;
     rawString: string;
-    /** MRZ Document */
-    mrz: MRZDocument;
+    /** MRZ Document represented as Generic Document */
+    mrz?: GenericDocument;
 }
@@ -144,6 +153,2 @@ export interface RefreshImageUrisResult {
 }
-export interface RemovePageResult {
-    /** Operation Result */
-    operationResult: string;
-}
 export interface RotateImageResult {
@@ -155,11 +160,11 @@ /** The URI of the rotated image */
     /** The Text Data Scanner recognition result */
-    result?: TextDataRecognitionResult;
+    result: TextDataRecognitionResult;
 }
 export interface VinScannerResult {
     /** The scanned Vehicle Identification Number */
-    rawText?: string;
+    rawText: string;
     /** The scanned result confidence value. */
-    confidenceValue?: number;
+    confidenceValue: number;
     /** Boolean that represents a successful validation */
-    validationSuccessful?: boolean;
+    validationSuccessful: boolean;
 }
@@ -166,0 +171,0 @@ export interface WriteTIFFResult {

dist/esm/types.d.ts

@@ -1,2 +0,3 @@
-import type { AUSCheckDocument, FRACheckDocument, INDCheckDocument, ISRCheckDocument, KWTCheckDocument, UnknownCheckDocument, USACheckDocument } from './gdr/generic_document_wrappers';
+import type { ParametricFilter } from './ParametricFilters';
+import type { GenericDocument } from './documents/GenericDocument';
 /** The Barcode Scanner Result Field */
@@ -14,843 +15,5 @@ export interface BarcodeResultField {
     parsedSuccessful: boolean;
-    /** The formatted barcode document (if it was parsed succesfully) */
-    formattedResult?: AAMVADocumentFormat | BoardingPassDocumentFormat | GS1DocumentFormat | IDCardPDF417DocumentFormat | MedicalCertificateDocumentFormat | MedicalPlanDocumentFormat | SEPADocumentFormat | SwissQRCodeDocumentFormat | VCardDocumentFormat;
+    /** The parsed known document format (if parsed successfully). */
+    formattedResult?: GenericDocument;
 }
-/** Base Document Format */
-export interface BaseDocumentFormat {
-    /** True if the document was parsed successfully */
-    parsedSuccessful: boolean;
-    /** The parsed barcode document type */
-    documentFormat: BarcodeDocumentFormat;
-}
-/** AAMVA Document Format */
-export interface AAMVADocumentFormat extends BaseDocumentFormat {
-    /** Header Raw String */
-    headerRawString: string;
-    /** File Type */
-    fileType: string;
-    /** Issuer Identification Number */
-    issuerIdentificationNumber: string;
-    /** AAMVA Version Number */
-    aamvaVersionNumber: string;
-    /** Jurisdiction Version Number */
-    jurisdictionVersionNumber: string;
-    /** Number of entries */
-    numberOfEntries: number;
-    /** Sub-files */
-    subfiles: AAMVADocumentSubfile[];
-}
-/** AAMVA Document Sub-File */
-export interface AAMVADocumentSubfile {
-    /** Sub-file type */
-    subFileType: string;
-    /** Sub-file raw header */
-    subFileRawHeader: string;
-    /** Sub-file fields */
-    fields: AAMVADocumentSubfileField[];
-}
-/** AAMVA Document Sub-File Field */
-export interface AAMVADocumentSubfileField {
-    /** AAMVA Document sub-file Record Field Type */
-    type: AAMVARecordFieldType;
-    /** AAMVA Document sub-file Field Type String */
-    typeString: string;
-    /** AAMVA Document sub-file Field value */
-    value: string;
-    /** AAMVA Document sub-file Field raw value */
-    rawValue: string;
-}
-/** AAMVA Record Field Type */
-export type AAMVARecordFieldType = 
-/** Audit information. */
-'AUDIT_INFORMATION'
-/** Card revision date. */
- | 'CARD_REVISION_DATE'
-/** Compliance type. */
- | 'COMPLIANCE_TYPE'
-/** Country of territory of issuance. */
- | 'COUNTRY_TERRITORY_OF_ISSUANCE'
-/** Court restriction code. */
- | 'COURT_RESTRICTION_CODE'
-/** Date of birth. */
- | 'DATE_OF_BIRTH'
-/** Document discriminator. */
- | 'DOCUMENT_DISCRIMINATOR'
-/** Eyes color. */
- | 'EYES_COLOR'
-/** Family name. */
- | 'FAMILY_NAME'
-/** Family name truncation. */
- | 'FAMILY_NAME_TRUNCATION'
-/** Federal commercial vehicle codes. */
- | 'FEDERAL_COMMERCIAL_VEHICLE_CODES'
-/** First name. */
- | 'FIRST_NAME'
-/** First name truncation. */
- | 'FIRST_NAMES_TRUNCATION'
-/** Full name. */
- | 'FULL_NAME'
-/** Hair color. */
- | 'HAIR_COLOR'
-/** HazMat endorsement expiry date. */
- | 'HAZ_MAT_ENDORSEMENT_EXPIRY_DATE'
-/** Height in CM. */
- | 'HEIGHT_IN_CM'
-/** Height in feet/inches. */
- | 'HEIGHT_IN_FEET_INCHES'
-/** Inventory control number. */
- | 'INVENTORY_CONTROL_NUMBER'
-/** Issue timestamp. */
- | 'ISSUE_TIMESTAMP'
-/** Jurisdiction-specific. */
- | 'JURISDICTION_SPECIFIC'
-/** Jurisdiction-specific restriction code description. */
- | 'JURISDICTION_SPECIFIC_RESTRICTION_CODE_DESCRIPTION'
-/** Jurisdiction-specific vehicle classification description. */
- | 'JURISDICTION_SPECIFIC_VEHICLE_CLASSIFICATION_DESCRIPTION'
-/** Last name. */
- | 'LAST_NAME'
-/** License classification code. */
- | 'LICENSE_CLASSIFICATION_CODE'
-/** License endorsements code. */
- | 'LICENSE_ENDORSEMENT_CODE'
-/** License expiration date. */
- | 'LICENSE_EXPIRATION_DATE'
-/** License or ID document issue date. */
- | 'LICENSE_OR_ID_DOCUMENT_ISSUE_DATE'
-/** License or ID number. */
- | 'LICENSE_OR_ID_NUMBER'
-/** License restriction code. */
- | 'LICENSE_RESTRICTION_CODE'
-/** Limited duration document indicator. */
- | 'LIMITED_DURATION_DOCUMENT_INDICATOR'
-/** Mailing city. */
- | 'MAILING_CITY'
-/** Mailing jurisdiction code. */
- | 'MAILING_JURISDICTION_CODE'
-/** Mailing postal code. */
- | 'MAILING_POSTAL_CODE'
-/** Mailing street address line 1. */
- | 'MAILING_STREET_ADDRESS_1'
-/** Mailing street address line 2. */
- | 'MAILING_STREET_ADDRESS_2'
-/** Medical indicator codes. */
- | 'MEDICAL_INDICATOR_CODES'
-/** MIddle name or initial. */
- | 'MIDDLE_NAME_OR_INITIAL'
-/** Middle names truncation. */
- | 'MIDDLE_NAMES_TRUNCATION'
-/** Name prefix. */
- | 'NAME_PREFIX'
-/** Name suffix. */
- | 'NAME_SUFFIX'
-/** Non-resident indicator. */
- | 'NON_RESIDENT_INDICATOR'
-/** Number of duplicates. */
- | 'NUMBER_OF_DUPLICATES'
-/** Organ donor. */
- | 'ORGAN_DONOR'
-/** Organ donor indicator. */
- | 'ORGAN_DONOR_INDICATOR'
-/** Permit classification code. */
- | 'PERMIT_CLASSIFICATION_CODE'
-/** Permit endorsement code. */
- | 'PERMIT_ENDORSEMENT_CODE'
-/** Permit expiration date. */
- | 'PERMIT_EXPIRATION_DATE'
-/** Permit identifier. */
- | 'PERMIT_IDENTIFIER'
-/** Permit issue date. */
- | 'PERMIT_ISSUE_DATE'
-/** Permit restriction code. */
- | 'PERMIT_RESTRICTION_CODE'
-/** Weight range. */
- | 'PHYSICAL_DESCRIPTION_WEIGHT_RANGE'
-/** Place of birth. */
- | 'PLACE_OF_BIRTH'
-/** Prefix. */
- | 'PREFIX'
-/** Race or ethnicity. */
- | 'RACE_ETHNICITY'
-/** Residence city. */
- | 'RESIDENCE_CITY'
-/** Residence jurisdiction code. */
- | 'RESIDENCE_JURISDICTION_CODE'
-/** Residence postal code. */
- | 'RESIDENCE_POSTAL_CODE'
-/** Residence street address line 1. */
- | 'RESIDENCE_STREET_ADDRESS_1'
-/** Residence street address line 2. */
- | 'RESIDENCE_STREET_ADDRESS_2'
-/** Sex. */
- | 'SEX'
-/** Social security number. */
- | 'SOCIAL_SECURITY_NUMBER'
-/** Standard endorsement code. */
- | 'STANDARD_ENDORSEMENT_CODE'
-/** Standard restriction code. */
- | 'STANDARD_RESTRICTION_CODE'
-/** Standard vehicle classification. */
- | 'STANDARD_VEHICLE_CLASSIFICATION'
-/** Suffix. */
- | 'SUFFIX'
-/** Under 18 until. */
- | 'UNDER_18_UNTIL'
-/** Under 19 until. */
- | 'UNDER_19_UNTIL'
-/** Under 21 until. */
- | 'UNDER_21_UNTIL'
-/** Unique customer identifier. */
- | 'UNIQUE_CUSTOMER_IDENTIFIER'
-/** Veteran indicator. */
- | 'VETERAN_INDICATOR'
-/** Virginia-specific class. */
- | 'VIRGINIA_SPECIFIC_CLASS'
-/** Virginia-specific endorsements. */
- | 'VIRGINIA_SPECIFIC_ENDORSEMENTS'
-/** Virginia-specific restrictions. */
- | 'VIRGINIA_SPECIFIC_RESTRICTIONS'
-/** Weight in KG. */
- | 'WEIGHT_IN_KG'
-/** Weight in LBS. */
- | 'WEIGHT_IN_LBS'
-/** Unknown. */
- | 'UNKNOWN';
-/** Boarding Pass Document Format */
-export interface BoardingPassDocumentFormat extends BaseDocumentFormat {
-    /** Number of legs */
-    numberOfLegs: number;
-    /** True if electronic ticket, false otherwise */
-    electronicTicket: boolean;
-    /** Security Data */
-    securityData: string;
-    /** Legs */
-    legs?: BoardingPassLeg[];
-}
-/** Boarding Pass Leg */
-export interface BoardingPassLeg {
-    /** Boarding Pass Leg Fields */
-    fields: BoardingPassLegField[];
-}
-/** Boarding Pass Leg Field */
-export interface BoardingPassLegField {
-    /** Boarding Pass Document Field Type */
-    type: BoardingPassDocumentFieldType;
-    /** Boarding Pass Document Field Value */
-    value: string;
-}
-/** Boarding Pass Document Field Type */
-export type BoardingPassDocumentFieldType = 
-/** Airline designator of boarding pass issuer. */
-'AIRLINE_DESIGNATOR_OF_BOARDING_PASS_ISSUER'
-/** Airline numeric code. */
- | 'AIRLINE_NUMERIC_CODE'
-/** Baggage tag license plate numbers. */
- | 'BAGGAGE_TAG_LICENSE_PLATE_NUMBERS'
-/** Check-in sequence number. */
- | 'CHECK_IN_SEQUENCE_NUMBER'
-/** Compartment code. */
- | 'COMPARTMENT_CODE'
-/** Date of boarding pass issuance in Julian format. */
- | 'DATE_OF_BOARDING_PASS_ISSUANCE_JULIAN'
-/** Date of flight in Julian format. */
- | 'DATE_OF_FLIGHT_JULIAN'
-/** Departure airport code. */
- | 'DEPARTURE_AIRPORT_CODE'
-/** Destination airport code. */
- | 'DESTINATION_AIRPORT_CODE'
-/** Document form serial number. */
- | 'DOCUMENT_FORM_SERIAL_NUMBER'
-/** Document type. */
- | 'DOCUMENT_TYPE'
-/** Fast track. */
- | 'FAST_TRACK'
-/** First non-consecutive baggage tag license plate number. */
- | 'FIRST_NON_CONSECUTIVE_BAGGAGE_TAG_LICENSE_PLATE_NUMBER'
-/** Flight number. */
- | 'FLIGHT_NUMBER'
-/** For individual airline use. */
- | 'FOR_INDIVIDUAL_AIRLINE_USE'
-/** Free baggage allowance. */
- | 'FREE_BAGGAGE_ALLOWANCE'
-/** Frequent flyer airline designator. */
- | 'FREQUENT_FLYER_AIRLINE_DESIGNATOR'
-/** Frequent flyer number. */
- | 'FREQUENT_FLYER_NUMBER'
-/** IDAD indicator. */
- | 'IDAD_INDICATOR'
-/** International document verification. */
- | 'INTERNATIONAL_DOCUMENTATION_VERIFICATION'
-/** Marketing carrier designator. */
- | 'MARKETING_CARRIER_DESIGNATOR'
-/** Operating carrier designator. */
- | 'OPERATING_CARRIER_DESIGNATOR'
-/** Operating carrier PNR code. */
- | 'OPERATING_CARRIER_PNR_CODE'
-/** Passenger description. */
- | 'PASSENGER_DESCRIPTION'
-/** Passenger status. */
- | 'PASSENGER_STATUS'
-/** Seat number. */
- | 'SEAT_NUMBER'
-/** Second non-consecutive baggage tag license plate number. */
- | 'SECOND_NON_CONSECUTIVE_BAGGAGE_TAG_LICENSE_PLATE_NUMBER'
-/** Selectee indicator. */
- | 'SELECTEE_INDICATOR'
-/** Source of boarding pass issuance. */
- | 'SOURCE_OF_BOARDING_PASS_ISSUANCE'
-/** Source of check-in. */
- | 'SOURCE_OF_CHECK_IN'
-/** Version number. */
- | 'VERSION_NUMBER'
-/** Unknown */
- | 'UNKNOWN';
-/** GS1 Document Format */
-export interface GS1DocumentFormat extends BaseDocumentFormat {
-    /** GS1 Document fields */
-    fields: GS1DocumentField[];
-}
-/** GS1 Document Field */
-export interface GS1DocumentField {
-    /** Field raw value */
-    rawValue: string;
-    /** Application Identifier */
-    applicationIdentifier: string;
-    /** Data Title */
-    dataTitle: string;
-    /** Field description */
-    fieldDescription: string;
-    /** True if it is standard, false otherwise */
-    standard: boolean;
-    /** Validation Status */
-    validationStatus: GS1SystemElementValidationStatus;
-}
-/** GS1 Element Validation Status */
-export type GS1SystemElementValidationStatus = 
-/** The GS1 Field is valid */
-'VALID'
-/** The GS1 Field is not valid */
- | 'INVALID';
-/** ID Card PDF417 Document Format */
-export interface IDCardPDF417DocumentFormat extends BaseDocumentFormat {
-    /** ID Card PDF417 Document Fields */
-    fields: IDCardPDF417DocumentField[];
-}
-/** ID Card PDF417 Document Field */
-export interface IDCardPDF417DocumentField {
-    /** Field Type */
-    type?: IDCardPDF417DocumentFieldType;
-    /** Field Value */
-    value: string;
-}
-/** ID Card PDF417 Document Field Type */
-export type IDCardPDF417DocumentFieldType = 
-/** First Name */
-'FIRST_NAME'
-/** Last Name */
- | 'LAST_NAME'
-/** Document Code */
- | 'DOCUMENT_CODE'
-/** Birth Date */
- | 'BIRTH_DATE'
-/** Date Issued */
- | 'DATE_ISSUED'
-/** Date Expired */
- | 'DATE_EXPIRED'
-/** Optional 1 */
- | 'OPTIONAL_1'
-/** Unknown */
- | 'UNKNOWN';
-/** Medical Certificate Document Format */
-export interface MedicalCertificateDocumentFormat extends BaseDocumentFormat {
-    /** Medical Certificate Document Fields */
-    fields: MedicalCertificateDocumentField[];
-}
-/** Medical Certificate Document Field */
-export interface MedicalCertificateDocumentField {
-    /** Medical Certificate Document Field Type */
-    type?: MedicalCertificateDocumentFieldType;
-    /** Medical Certificate Document Field Value */
-    value: string;
-}
-/** Medical Certificate Document Field Type */
-export type MedicalCertificateDocumentFieldType = 
-/** Requires Care */
-'REQUIRES_CARE'
-/** Accident */
- | 'ACCIDENT'
-/** Initial Certificate */
- | 'INITIAL_CERTIFICATE'
-/** Renewed Certificate */
- | 'RENEWED_CERTIFICATE'
-/** Work Accident */
- | 'WORK_ACCIDENT'
-/** Assigned To Accident Insurance Doctor */
- | 'ASSIGNED_TO_ACCIDENT_INSURANCE_DOCTOR'
-/** Incapable Of Work Since */
- | 'INCAPABLE_OF_WORK_SINCE'
-/** Incapable Of Work Until */
- | 'INCAPABLE_OF_WORK_UNTIL'
-/** Diagnosed On */
- | 'DIAGNOSED_ON'
-/** Document Date */
- | 'DOCUMENT_DATE'
-/** Birth Date */
- | 'BIRTH_DATE'
-/** First Name */
- | 'FIRST_NAME'
-/** Last Name */
- | 'LAST_NAME'
-/** Diagnose */
- | 'DIAGNOSE'
-/** Health Insurance Number */
- | 'HEALTH_INSURANCE_NUMBER'
-/** Insured Person Number */
- | 'INSURED_PERSON_NUMBER'
-/** Status */
- | 'STATUS'
-/** Place Of Operation Number */
- | 'PLACE_OF_OPERATION_NUMBER'
-/** Doctor Number */
- | 'DOCTOR_NUMBER'
-/** Unknown */
- | 'UNKNOWN';
-/** Medical Plan Document Format */
-export interface MedicalPlanDocumentFormat extends BaseDocumentFormat {
-    /** Identifier */
-    GUID: string;
-    /** Current page (index) */
-    currentPage: number;
-    /** Total number of pages */
-    totalNumberOfPages: number;
-    /** Document version number */
-    documentVersionNumber: string;
-    /** Patch version number */
-    patchVersionNumber: string;
-    /** Language country code */
-    languageCountryCode: string;
-    /** Patient Information */
-    patient: MedicalPlanPatientInformation;
-    /** Doctor Information */
-    doctor: MedicalPlanDoctorInformation;
-    /** Subheadings */
-    subheadings: MedicalPlanStandardSubheading[];
-}
-/** Medical Plan Patient Information */
-export interface MedicalPlanPatientInformation {
-    /** Medical Plan Patient Fields */
-    fields: MedicalPlanPatientField[];
-}
-/** Medical Plan Patient Field */
-export interface MedicalPlanPatientField {
-    /** Medical Plan Patient Field Type */
-    type: MedicalPlanPatientFieldType;
-    /** Medical Plan Patient Field Value */
-    value: string;
-}
-/** Medical Plan Patient Field Type */
-export type MedicalPlanPatientFieldType = 
-/** First Name */
-'FIRST_NAME'
-/** Last Name */
- | 'LAST_NAME'
-/** Title */
- | 'TITLE'
-/** Pre Name */
- | 'PRE_NAME'
-/** Suffix */
- | 'SUFFIX'
-/** Patient Id */
- | 'PATIENT_ID'
-/** Birth Date */
- | 'BIRTH_DATE'
-/** Gender */
- | 'GENDER'
-/** Weight */
- | 'WEIGHT'
-/** Height */
- | 'HEIGHT'
-/** Creatinine Value */
- | 'CREATININE_VALUE'
-/** Allergies And Intolerances */
- | 'ALLERGIES_AND_INTOLERANCES'
-/** Breast Feeding */
- | 'BREAST_FEEDING'
-/** Pregnant */
- | 'PREGNANT'
-/** Patient Free Text */
- | 'PATIENT_FREE_TEXT'
-/** Unknown */
- | 'UNKNOWN';
-/** Medical Plan Doctor Information */
-export interface MedicalPlanDoctorInformation {
-    /** Medical Plan Doctor Information Fields */
-    fields: MedicalPlanDoctorField[];
-}
-/** Medical Plan Doctor Field */
-export interface MedicalPlanDoctorField {
-    /** Medical Plan Doctor Field Type */
-    type: MedicalPlanDoctorFieldType;
-    /** Medical Plan Doctor Field Value */
-    value: string;
-}
-/** Medical Plan Doctor Field Type */
-export type MedicalPlanDoctorFieldType = 
-/** Issuer name */
-'ISSUER_NAME'
-/** Doctor number */
- | 'DOCTOR_NUMBER'
-/** Pharmacy ID */
- | 'PHARMACY_ID'
-/** Hospital ID */
- | 'HOSPITAL_ID'
-/** Street */
- | 'STREET'
-/** Postal Code */
- | 'POSTAL_CODE'
-/** Place */
- | 'PLACE'
-/** Telephone Number */
- | 'TELEPHONE_NUMBER'
-/** Email */
- | 'EMAIL'
-/** Issuing date and time */
- | 'ISSUING_DATE_AND_TIME'
-/** Unknown */
- | 'UNKNOWN';
-/** Medical Plan Standard Subheading */
-export interface MedicalPlanStandardSubheading {
-    /** Subheading Fields */
-    fields: MedicalPlanStandardSubheadingField[];
-    /** General Notes */
-    generalNotes: string[];
-    /** Medicines */
-    medicines: MedicalPlanMedicine[];
-    /** Prescriptions */
-    prescriptions: MedicalPlanPrescription[];
-}
-/** Medical Plan Standard Subheading Field */
-export interface MedicalPlanStandardSubheadingField {
-    /** Medical Plan Standard Subheading Field Type */
-    type: MedicalPlanStandardSubheadingFieldType;
-    /** Medical Plan Standard Subheading Field Value */
-    value: string;
-}
-/** Medical Plan Standard Subheading Field Type */
-export type MedicalPlanStandardSubheadingFieldType = 
-/** Key words */
-'KEY_WORDS'
-/** Subheading free text */
- | 'SUBHEADING_FREE_TEXT';
-/** Medical Plan Medicine */
-export interface MedicalPlanMedicine {
-    /** Medical Plan Medicine Fields */
-    fields: MedicalPlanMedicineField[];
-    /** Medical Plan Medicine Substances */
-    substances: MedicalPlanMedicineSubstance[];
-}
-/** Medical Plan Medicine Field */
-export interface MedicalPlanMedicineField {
-    /** Medical Plan Medicine Field Type */
-    type: MedicalPlanMedicineFieldType;
-    /** Medical Plan Medicine Field Value */
-    value: string;
-}
-/** Medical Plan Medicine Field Type */
-export type MedicalPlanMedicineFieldType = 
-/** Pharmaceutical number */
-'PHARMACEUTICAL_NUMBER'
-/** Drug name */
- | 'DRUG_NAME'
-/** Dosage form */
- | 'DOSAGE_FORM'
-/** Dosage form free text */
- | 'DOSAGE_FORM_FREE_TEXT'
-/** Morning */
- | 'MORNING'
-/** Midday */
- | 'MIDDAY'
-/** Evening */
- | 'EVENING'
-/** Night */
- | 'NIGHT'
-/** Dosage free text */
- | 'DOSAGE_FREE_TEXT'
-/** Dosing unit */
- | 'DOSING_UNIT'
-/** Dosing unit free text */
- | 'DOSING_UNIT_FREE_TEXT'
-/** Relevant info */
- | 'RELEVANT_INFO'
-/** Reason for treatment */
- | 'REASON_FOR_TREATMENT'
-/** General notes */
- | 'GENERAL_NOTES'
-/** Unknown */
- | 'UNKNOWN';
-/** Medical Plan Medicine Substance */
-export interface MedicalPlanMedicineSubstance {
-    /** Medical Plan Medicine Substance Fields */
-    fields: MedicalPlanMedicineSubstanceField[];
-}
-/** Medical Plan Medicine Substance Field */
-export interface MedicalPlanMedicineSubstanceField {
-    /** Medical Plan Medicine Substance Field Type */
-    type: MedicalPlanMedicineSubstanceFieldType;
-    /** Medical Plan Medicine Substance Field Value */
-    value: string;
-}
-/** Medical Plan Medicine Substance Field Type */
-export type MedicalPlanMedicineSubstanceFieldType = 
-/** Active substance */
-'ACTIVE_SUBSTANCE'
-/** Potency */
- | 'POTENCY'
-/** Unknown */
- | 'UNKNOWN';
-/** Medical Plan Prescription */
-export interface MedicalPlanPrescription {
-    /** Medical Plan Prescription Fields */
-    fields: MedicalPlanPrescriptionField[];
-}
-/** Medical Plan Prescription Field */
-export interface MedicalPlanPrescriptionField {
-    /** Medical Plan Prescription Field Type */
-    type?: MedicalPlanPrescriptionFieldType;
-    /** Medical Plan Prescription Field Value */
-    value: string;
-}
-/** Medical Plan Prescription Field Type */
-export type MedicalPlanPrescriptionFieldType = 
-/** General informationm */
-'GENERAL_INFORMATION'
-/** Prescription free text */
- | 'PRESCRIPTION_FREE_TEXT'
-/** Unknown */
- | 'UNKNOWN';
-/** SEPA Document Format */
-export interface SEPADocumentFormat extends BaseDocumentFormat {
-    /** SEPA Document Format Fields */
-    fields: SEPADocumentFormatField[];
-}
-/** SEPA Document Format Field */
-export interface SEPADocumentFormatField {
-    /** SEPA Document Field Type */
-    type: SEPADocumentFieldType;
-    /** SEPA Document Field Value */
-    value: string;
-}
-/** SEPA Document Field Type */
-export type SEPADocumentFieldType = 
-/** Service tag */
-'SERVICE_TAG'
-/** Version */
- | 'VERSION'
-/** Character set */
- | 'CHARACTER_SET'
-/** Identification */
- | 'IDENTIFICATION'
-/** Receiver IBAN */
- | 'RECEIVER_IBAN'
-/** Receiver BIC */
- | 'RECEIVER_BIC'
-/** Receiver name */
- | 'RECEIVER_NAME'
-/** Receiver amount */
- | 'AMOUNT'
-/** Purpose */
- | 'PURPOSE'
-/** Remittance */
- | 'REMITTANCE'
-/** Information */
- | 'INFORMATION'
-/** Unknown */
- | 'UNKNOWN';
-/** Swiss QR Code Document Format */
-export interface SwissQRCodeDocumentFormat extends BaseDocumentFormat {
-    /** Swiss QR Code Document Fields */
-    fields: SwissQRCodeDocumentField[];
-    /** Swiss QR Code Version */
-    version: SwissQRCodeVersion;
-}
-/** Swiss QR Code Document Field */
-export interface SwissQRCodeDocumentField {
-    /** Swiss QR Code Document Field Type */
-    type: SwissQRCodeDocumentFieldType;
-    /** Swiss QR Code Document Field Value */
-    value: string;
-    /** Swiss QR Code Document Field Human-readable String */
-    typeHumanReadableString: string;
-}
-/** Swiss QR Code Document Field Type */
-export type SwissQRCodeDocumentFieldType = 
-/** Additional Billing Information */
-'ADDITIONAL_BILLING_INFORMATION'
-/** Additional Info Trailer */
- | 'ADDITIONAL_INFO_TRAILER'
-/** Additional Info Unstructured */
- | 'ADDITIONAL_INFO_UNSTRUCTURED'
-/** Alternative Procedure Parameter */
- | 'ALTERNATIVE_PROCEDURE_PARAMETER'
-/** Amount */
- | 'AMOUNT'
-/** Currency */
- | 'CURRENCY'
-/** Debtor Address Type */
- | 'DEBTOR_ADDRESS_TYPE'
-/** Debtor Country */
- | 'DEBTOR_COUNTRY'
-/** Debtor Name */
- | 'DEBTOR_NAME'
-/** Debtor Place */
- | 'DEBTOR_PLACE'
-/** Debtor Postal Code */
- | 'DEBTOR_POSTAL_CODE'
-/** Debtor Street Or Address Line 1 */
- | 'DEBTOR_STREET_OR_ADDRESS_LINE_1'
-/** Debtor Street Or Address Line 2 */
- | 'DEBTOR_STREET_OR_ADDRESS_LINE_2'
-/** Due Date */
- | 'DUE_DATE'
-/** Encoding */
- | 'ENCODING'
-/** Final Payee Address Type */
- | 'FINAL_PAYEE_ADDRESS_TYPE'
-/** Final Payee Building Or Address Line 2 */
- | 'FINAL_PAYEE_BUILDING_OR_ADDRESS_LINE_2'
-/** Final Payee Country */
- | 'FINAL_PAYEE_COUNTRY'
-/** Final Payee Name */
- | 'FINAL_PAYEE_NAME'
-/** Final Payee Place */
- | 'FINAL_PAYEE_PLACE'
-/** Final Payee Postal Code */
- | 'FINAL_PAYEE_POSTAL_CODE'
-/** Final Payee Street Or Address Line 1 */
- | 'FINAL_PAYEE_STREET_OR_ADDRESS_LINE_1'
-/** Iban */
- | 'IBAN'
-/** Payee Address Type */
- | 'PAYEE_ADDRESS_TYPE'
-/** Payee Building Or Address Line 2 */
- | 'PAYEE_BUILDING_OR_ADDRESS_LINE_2'
-/** Payee Country */
- | 'PAYEE_COUNTRY'
-/** Payee Name */
- | 'PAYEE_NAME'
-/** Payee Place */
- | 'PAYEE_PLACE'
-/** Payee Postal Code */
- | 'PAYEE_POSTAL_CODE'
-/** Payee Street Or Address Line 1 */
- | 'PAYEE_STREET_OR_ADDRESS_LINE_1'
-/** Payment Reference */
- | 'PAYMENT_REFERENCE'
-/** Payment Reference Type */
- | 'PAYMENT_REFERENCE_TYPE'
-/** Unknown */
- | 'UNKNOWN';
-/** Swiss QR Code Version */
-export type SwissQRCodeVersion = 
-/** Version 1.0 */
-'V1_0'
-/** Version 2.0 */
- | 'V2_0'
-/** Version 2.1 */
- | 'V2_1'
-/** Unknown */
- | 'UNKNOWN';
-/** vCard Document Format */
-export interface VCardDocumentFormat extends BaseDocumentFormat {
-    /** vCard Document Format Fields */
-    fields: VCardDocumentFormatField[];
-}
-/** vCard Document Field */
-export interface VCardDocumentFormatField {
-    /** vCard Document Field Type */
-    type: VCardDocumentFormatFieldType;
-    /** vCard Document Field Type Modifiers */
-    typeModifiers: string[];
-    /** vCard Document Field Raw Text */
-    rawText?: string;
-    /** vCard Document Field Values */
-    values: string[];
-}
-/** vCard Document Field Type */
-export type VCardDocumentFormatFieldType = 
-/** Anniversary */
-'ANNIVERSARY'
-/** Birthday */
- | 'BIRTHDAY'
-/** Busy Time Url */
- | 'BUSY_TIME_URL'
-/** Calendar Uri */
- | 'CALENDAR_URI'
-/** Calendar Uri For Requests */
- | 'CALENDAR_URI_FOR_REQUESTS'
-/** Categories */
- | 'CATEGORIES'
-/** Client Pid Map */
- | 'CLIENT_PID_MAP'
-/** Custom */
- | 'CUSTOM'
-/** Delivery Address */
- | 'DELIVERY_ADDRESS'
-/** Email */
- | 'EMAIL'
-/** First Name */
- | 'FIRST_NAME'
-/** Gender */
- | 'GENDER'
-/** Geo Location */
- | 'GEO_LOCATION'
-/** Impp */
- | 'IMPP'
-/** Kind */
- | 'KIND'
-/** Languages */
- | 'LANGUAGES'
-/** Logo */
- | 'LOGO'
-/** Member */
- | 'MEMBER'
-/** Name */
- | 'NAME'
-/** Nickname */
- | 'NICKNAME'
-/** Note */
- | 'NOTE'
-/** Organisation */
- | 'ORGANISATION'
-/** Photo */
- | 'PHOTO'
-/** Product ID */
- | 'PRODUCT_ID'
-/** Public Key */
- | 'PUBLIC_KEY'
-/** Related */
- | 'RELATED'
-/** Revision */
- | 'REVISION'
-/** Role */
- | 'ROLE'
-/** Sound */
- | 'SOUND'
-/** Source */
- | 'SOURCE'
-/** Telephone Number */
- | 'TELEPHONE_NUMBER'
-/** Time Zone */
- | 'TIME_ZONE'
-/** Title */
- | 'TITLE'
-/** UID */
- | 'UID'
-/** URL */
- | 'URL'
-/** Version */
- | 'VERSION'
-/** Xml */
- | 'XML'
-/** Unknown */
- | 'UNKNOWN';
 /** Configuration that helps to override default hint values. */
@@ -882,14 +45,7 @@ export interface CheckUserGuidanceStrings {
 /** A check format commonly used in Israel */
- | 'ISR';
-/** The Check Recognizer Result Field */
-export interface CheckRecognizerResult {
-    /** Check Document */
-    check: USACheckDocument | FRACheckDocument | KWTCheckDocument | AUSCheckDocument | INDCheckDocument | ISRCheckDocument | UnknownCheckDocument;
-    /** The status of the operation */
-    checkStatus: CheckStatus;
-    /** The URI of the snapped Check Image */
-    imageFileUri?: string;
-    /** The type of the recognized check */
-    checkType: CheckStandard;
-}
+ | 'ISR'
+/** A check format commonly used in the United Arab Emirates. */
+ | 'UAE'
+/** A check format commonly used in Canada. */
+ | 'CAN';
 /** Check Status */
@@ -899,78 +55,4 @@ export type CheckStatus =
 'SUCCESS'
-/** The check recognition failed */
- | 'FAIL';
-/** SDK Page */
-export interface Page {
-    /** A string identifying the page in the internal page file storage */
-    pageId: string;
-    /** The page's cropping polygon as calculated by a document detection operation or as set by the cropping UI. Modifying the polygon will change the polygon as shown in the cropping UI but will not automatically re-crop the original image */
-    polygon: PolygonPoint[];
-    /** The document detection result status for the operation that produced the page */
-    detectionResult: DetectionStatus;
-    /** The image source */
-    pageImageSource: PageImageSource;
-    /** The Image Filter that was applied on the page image */
-    filter: ImageFilterType;
-    /** The value that was set for `documentImageSizeLimit`, which limits the maximum size of the document image. */
-    documentImageSizeLimit?: Size;
-    /** File URI of the original image */
-    originalImageFileUri: string;
-    /** File URI of the cropped document image (if document detection was successful) */
-    documentImageFileUri?: string;
-    /** File URI of a screen-sized preview of the original image */
-    originalPreviewImageFileUri: string;
-    /** File URI of a screen-sized preview of the document image (if document detection was successful) */
-    documentPreviewImageFileUri?: string;
-}
-/** The page image source */
-export type PageImageSource = 
-/** Used by default. If the source is not defined. */
-'UNDEFINED'
-/** If the source image was captured manually. For example, when the user pressed a Snap button */
- | 'MANUAL_SNAP'
-/** If the source image was captured automatically. For example, by auto snapping functions */
- | 'AUTO_SNAP'
-/** If the source image was taken from the camera frame */
- | 'CAMERA_FRAME'
-/** If the source image was imported from an external source */
- | 'IMPORT';
-/** The SDK license status */
-export type LicenseStatus = 
-/** License is valid and accepted. */
-'Okay'
-/** No license set yet. The SDK is in trial mode. */
- | 'Trial'
-/** No license set yet. The SDKs trial mode is over. */
- | 'Expired'
-/** No license active. The set license does not cover the current operating system. */
- | 'WrongOS'
-/** No license active. The set license was unreadable or has an invalid format. */
- | 'Corrupted'
-/** No license active. The set licenses does not cover the current apps bundle identifier. */
- | 'AppIDMismatch'
-/** No license set yet. The SDKs trial mode is over. */
- | 'NotSet';
-/** Polygon Point */
-export interface PolygonPoint {
-    /** Polygon point X */
-    x: number;
-    /** Polygon point Y */
-    y: number;
-}
-/** Detection Status */
-export type DetectionStatus = 
-/** An acceptable polygon was detected. */
-'OK'
-/** A polygon was detected, but its size is too small. */
- | 'OK_BUT_TOO_SMALL'
-/** A polygon was detected, but it has too much perspective distortion. */
- | 'OK_BUT_BAD_ANGLES'
-/** A polygon was detected, but its aspect ratio should be landscape/portrait but is portrait/landscape. */
- | 'OK_BUT_BAD_ASPECT_RATIO'
-/** No polygon detected at all. */
- | 'ERROR_NOTHING_DETECTED'
-/** No polygon detected, image too dark. */
- | 'ERROR_TOO_DARK'
-/** No polygon detected, image too noisy (background). */
- | 'ERROR_TOO_NOISY';
+/** Check was recognized, but validation failed, indication a standard violation, non supported standard, or recognition error */
+ | 'VALIDATION_FAILED';
 /** Barcode document format */
@@ -1024,6 +106,6 @@ export type BarcodeDocumentFormat =
  | 'MICRO_QR_CODE'
-/** RSS_14 barcode type */
- | 'RSS_14'
-/** RSS_EXPANDED barcode type */
- | 'RSS_EXPANDED'
+/** DATABAR barcode type */
+ | 'DATABAR'
+/** DATABAR_EXPANDED barcode type */
+ | 'DATABAR_EXPANDED'
 /** UPC_A barcode type */
@@ -1052,3 +134,5 @@ | 'UPC_A'
 /** GS1 DataBar Composite */
- | 'GS1_COMPOSITE';
+ | 'GS1_COMPOSITE'
+/** Micro pdf 417 */
+ | 'MICRO_PDF_417';
 /** A filter for extended EAN and UPC barcodes. */
@@ -1296,2 +380,16 @@ export type BarcodesExtensionFilter =
  | 'TYPE_AND_CODE';
+/** The document quality status that comes from DocumentQualityAnalyzer */
+export type DocumentQuality = 
+/** Cant recognize any document. */
+'NO_DOCUMENT'
+/** Very poor document quality. */
+ | 'VERY_POOR'
+/** Poor document quality. */
+ | 'POOR'
+/** Reasonable document quality. */
+ | 'REASONABLE'
+/** Good document quality. */
+ | 'GOOD'
+/** Excellent document quality. */
+ | 'EXCELLENT';
 /** The image filter types. */
@@ -1335,95 +433,208 @@ export type ImageFilterType =
  | 'QUALITY';
-/** Result of applyImageFilterOnPage */
-export interface ApplyImageFilterOnPageResult extends Page {
+/** The page size of the pdf document. */
+export type PageSize = 
+/** Letter page size. */
+'LETTER'
+/** Legal page size. */
+ | 'LEGAL'
+/** A3 page size. */
+ | 'A3'
+/** A4 page size. */
+ | 'A4'
+/** A5 page size. */
+ | 'A5'
+/** B4 page size. */
+ | 'B4'
+/** B5 page size. */
+ | 'B5'
+/** Executive page size. */
+ | 'EXECUTIVE'
+/** US4x6 page size. */
+ | 'US4x6'
+/** US4x8 page size. */
+ | 'US4x8'
+/** US5x7 page size. */
+ | 'US5x7'
+/** COMM10 page size. */
+ | 'COMM10'
+/** Custom page size. From the Image. */
+ | 'CUSTOM';
+/** The page orientation of the pdf document. */
+export type PageDirection = 
+/** Portrait page orientation. */
+'PORTRAIT'
+/** Landscape page orientation. */
+ | 'LANDSCAPE'
+/** Taken from the original image */
+ | 'AUTO';
+/** The page orientation of the pdf document. */
+export type OcrEngine = 
+/** Slow but powerful OCR engine. Supports non-Latin languages. */
+'TESSERACT'
+/** Fast and accurate OCR engine. Supports only Latin languages. */
+ | 'SCANBOT_OCR';
+/** SDK Page */
+export interface Page {
+    /** A string identifying the page in the internal page file storage */
+    pageId: string;
+    /** The page's cropping polygon as calculated by a document detection operation or as set by the cropping UI. Modifying the polygon will change the polygon as shown in the cropping UI but will not automatically re-crop the original image */
+    polygon: PolygonPoint[];
+    /** The document detection result status for the operation that produced the page */
+    detectionResult: DetectionStatus;
+    /** The image source */
+    pageImageSource: PageImageSource;
+    /** The Image Filter that was applied on the page image. @deprecated Use **parametricFilters** instead. */
+    filter: ImageFilterType;
+    /** The Image Filters that are applied on the page image */
+    parametricFilters?: ParametricFilter[];
+    /** The value that was set for `documentImageSizeLimit`, which limits the maximum size of the document image. */
+    documentImageSizeLimit?: Size;
+    /** File URI of the original image */
+    originalImageFileUri: string;
+    /** File URI of the cropped document image (if document detection was successful) */
+    documentImageFileUri?: string;
+    /** File URI of a screen-sized preview of the original image */
+    originalPreviewImageFileUri: string;
+    /** File URI of a screen-sized preview of the document image (if document detection was successful) */
+    documentPreviewImageFileUri?: string;
 }
+/** The page image source */
+export type PageImageSource = 
+/** Used by default. If the source is not defined. */
+'UNDEFINED'
+/** If the source image was captured manually. For example, when the user pressed a Snap button */
+ | 'MANUAL_SNAP'
+/** If the source image was captured automatically. For example, by auto snapping functions */
+ | 'AUTO_SNAP'
+/** If the source image was taken from the camera frame */
+ | 'CAMERA_FRAME'
+/** If the source image was imported from an external source */
+ | 'IMPORT';
+/** The SDK license status */
+export type LicenseStatus = 
+/** License is valid and accepted. */
+'Okay'
+/** No license set yet. The SDK is in trial mode. */
+ | 'Trial'
+/** No license set yet. The SDKs trial mode is over. */
+ | 'Expired'
+/** No license active. The set license does not cover the current operating system. */
+ | 'WrongOS'
+/** No license active. The set license was unreadable or has an invalid format. */
+ | 'Corrupted'
+/** No license active. The set licenses does not cover the current apps bundle identifier. */
+ | 'AppIDMismatch'
+/** No license set yet. The SDKs trial mode is over. */
+ | 'NotSet';
+/** Polygon Point */
+export interface PolygonPoint {
+    /** Polygon point X */
+    x: number;
+    /** Polygon point Y */
+    y: number;
+}
+/** Detection Status */
+export type DetectionStatus = 
+/** An acceptable polygon was detected. */
+'OK'
+/** A polygon was detected, but its size is too small. */
+ | 'OK_BUT_TOO_SMALL'
+/** A polygon was detected, but it has too much perspective distortion. */
+ | 'OK_BUT_BAD_ANGLES'
+/** A polygon was detected, but its aspect ratio should be landscape/portrait but is portrait/landscape. */
+ | 'OK_BUT_BAD_ASPECT_RATIO'
+/** A polygon was detected, but its center is too far away from the image center. */
+ | 'OK_OFF_CENTER'
+/** A barcode was detected. Android only. */
+ | 'OK_BARCODE'
+/** No polygon detected at all. */
+ | 'ERROR_NOTHING_DETECTED'
+/** No polygon detected, image too dark. */
+ | 'ERROR_TOO_DARK'
+/** No polygon detected, image too noisy (background). */
+ | 'ERROR_TOO_NOISY';
+/** Result of applyImageFiltersOnPage */
+export type ApplyImageFiltersOnPageResult = Page;
 /** Result of createPage */
-export interface CreatePageResult extends Page {
-}
+export type CreatePageResult = Page;
 /** Result of detectDocumentOnPage */
-export interface DetectDocumentOnPageResult extends Page {
-}
-/** Result of recognizeCheck */
-export interface RecognizeCheckResult extends CheckRecognizerResult {
-}
+export type DetectDocumentOnPageResult = Page;
 /** Result of rotatePage */
-export interface RotatePageResult extends Page {
-}
+export type RotatePageResult = Page;
 /** Result of setDocumentImage */
-export interface SetDocumentImageResult extends Page {
-}
-/** Cropping screen accessibility configuration */
+export type SetDocumentImageResult = Page;
+/** Cropping screen accessibility configuration. */
 export interface CroppingAccessibilityConfiguration {
-    /** Text, that is used as an accessibility label for the cancel button */
+    /** Text used as an accessibility label for the cancel button. */
     cancelButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the cancel button */
+    /** Text used as an accessibility hint for the cancel button. */
     cancelButtonAccessibilityHint: string;
-    /** Text, that is used as an accessibility label for the done button */
+    /** Text used as an accessibility label for the done button. */
     doneButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the done button. */
+    /** Text used as an accessibility hint for the done button. */
     doneButtonAccessibilityHint: string;
-    /** Text, that is used as an accessibility label for the detect button */
+    /** Text used as an accessibility label for the detect button. */
     detectButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the detect button */
+    /** Text used as an accessibility hint for the detect button. */
     detectButtonAccessibilityHint: string;
-    /** Text, that is used as an accessibility label for the reset button */
+    /** Text used as an accessibility label for the reset button. */
     resetButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the reset button */
+    /** Text used as an accessibility hint for the reset button. */
     resetButtonAccessibilityHint: string;
-    /** Text, that is used as an accessibility hint for the rotate button */
+    /** Text used as an accessibility label for the rotate button. */
     rotateButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the rotate button */
+    /** Text used as an accessibility hint for the rotate button. */
     rotateButtonAccessibilityHint: string;
 }
-/** Detect Barcodes On Images Result Field */
-export interface DetectBarcodesOnImagesField {
-    /** The URI of the image file the barcodes have been detected on */
-    imageFileUri: string;
-    /** The array of detected barcodes */
-    barcodeResults: BarcodeResultField[];
-}
-/** Enum that represents the analyzed text legibility on the images */
-export type DocumentQuality = 
-/** If no document is found */
-'NO_DOCUMENT'
-/** Document quality is very poor */
- | 'VERY_POOR'
-/** Document quality is poor */
- | 'POOR'
-/** Document quality is reasonably good */
- | 'REASONABLE'
-/** Document quality is good */
- | 'GOOD'
-/** Document quality is excellent */
- | 'EXCELLENT';
 /** Document scanner accessibility configuration */
 export interface DocumentScannerAccessibilityConfiguration {
-    /** Text, that is used as an accessibility label for the flash button. */
+    /** Text used as an accessibility label for the flash button. */
     flashButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the flash button. */
+    /** Text used as an accessibility hint for the flash button. */
     flashButtonAccessibilityHint: string;
-    /** Text, that is used as an accessibility label for the multi-page button. */
+    /** Text used as an accessibility label for the multi-page button. */
     multiPageButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the multi-page button. */
+    /** Text used as an accessibility hint for the multi-page button. */
     multiPageButtonAccessibilityHint: string;
-    /** Text, that is used as an accessibility label for the auto-snapping button. */
+    /** Text used as an accessibility label for the auto-snapping button. */
     autoSnappingButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the auto-snapping button. */
+    /** Text used as an accessibility hint for the auto-snapping button. */
     autoSnappingButtonAccessibilityHint: string;
-    /** Text, that is used as an accessibility label for the cancel button. */
+    /** Text used as an accessibility label for the cancel button. */
     cancelButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the cancel button. */
+    /** Text used as an accessibility hint for the cancel button. */
     cancelButtonAccessibilityHint: string;
-    /** Text, that is used as an accessibility label for the page-amount button. */
+    /** Text used as an accessibility label for the page count button. */
     pageCounterButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the page-amount button. */
+    /** Text used as an accessibility hint for the page count button. */
     pageCounterAccessibilityHint: string;
-    /** Text, that is used as an accessibility label for the shutter button. */
+    /** Text used as an accessibility label for the shutter button. */
     shutterButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the shutter button. */
+    /** Text used as an accessibility hint for the shutter button. */
     shutterButtonAccessibilityHint: string;
 }
+/** Health Insurance Card Field Type */
+export type HealthInsuranceCardFieldType = 
+/** SURNAME */
+'SURNAME'
+/** GIVEN_NAME */
+ | 'GIVEN_NAME'
+/** DATE_OF_BIRTH */
+ | 'DATE_OF_BIRTH'
+/** PERSONAL_IDENTIFICATION_NUMBER */
+ | 'PERSONAL_IDENTIFICATION_NUMBER'
+/** INSTITUTION_NUMBER */
+ | 'INSTITUTION_NUMBER'
+/** INSTITUTION_NAME */
+ | 'INSTITUTION_NAME'
+/** CARD_NUMBER */
+ | 'CARD_NUMBER'
+/** CARD_EXPIRATION_DATE */
+ | 'CARD_EXPIRATION_DATE'
+/** COUNTRY */
+ | 'COUNTRY';
 /** The Health Insurance Card field */
 export interface HealthInsuranceCardField {
     /** Health Insurance Card Field Type */
-    type: string;
+    type: HealthInsuranceCardFieldType;
     /** Health Insurance Card Field Recognized Text */
@@ -1434,53 +645,65 @@ value: string;
 }
+/** The Health Insurance Card detection status. */
+export type HealthInsuranceCardDetectionStatus = 
+/** Detection successful. The fields array is filled with all of the extracted data. All validatable fields have passed validation. */
+'SUCCESS'
+/** No document found or the document doesn't look like the back of an Health Insurance Card. */
+ | 'FAILED_DETECTION'
+/** A potential Health Insurance Card was found but one or more fields failed validation. */
+ | 'INCOMPLETE_VALIDATION';
 /** Finder Document scanner accessibility configuration */
 export interface FinderDocumentScannerAccessibilityConfiguration {
-    /** Text, that is used as an accessibility label for the flash button. */
+    /** Text used as an accessibility label for the flash button. */
     flashButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the flash button. */
+    /** Text used as an accessibility hint for the flash button. */
     flashButtonAccessibilityHint: string;
-    /** Text, that is used as an accessibility label for the cancel button. */
+    /** Text used as an accessibility label for the cancel button. */
     cancelButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the cancel button. */
+    /** Text used as an accessibility hint for the cancel button. */
     cancelButtonAccessibilityHint: string;
-    /** Text, that is used as an accessibility label for the shutter button. */
+    /** Text used as an accessibility label for the shutter button. */
     shutterButtonAccessibilityLabel: string;
-    /** Text, that is used as an accessibility hint for the shutter button. */
+    /** Text used as an accessibility hint for the shutter button. */
     shutterButtonAccessibilityHint: string;
 }
-/** Field display configuration object */
+/** Field display configuration object. */
 export interface FieldsDisplayConfiguration {
-    /** Complete list of available normalized field names is available in the documentation */
+    /** Please refer to the documentation for a list of all available normalized field names. */
     normalizedFieldName: string;
-    /** The display text of the field in the list */
+    /** Display text of the field in the list. */
     defaultDisplayText: string;
-    /** The default display state of a field in the RTU UI, could be hidden by default or visible by default. */
+    /** Default display state of a field in the RTU UI. Can be hidden by default or visible by default. */
     defaultDisplayState: FieldDisplayState;
 }
-/** Field display configuration object */
+/** The field display configuration object. */
 export interface DocumentsDisplayConfiguration {
-    /** Complete list of available normalized document names is available in the documentation */
+    /** Please refer to the documentation for a list of all available normalized field names. */
     normalizedDocumentName: string;
-    /** The display text of the document in the list */
+    /** Display text of the document in the list. */
     defaultDisplayText: string;
 }
-/** Field display state in the RTU UI */
+/** Field display state in the RTU UI. */
 export type FieldDisplayState = 
-/** Field will not be shown in the RTU UI */
+/** Field will be hidden in the RTU UI. */
 'HIDDEN'
-/** Field will be shown in the RTU UI if its text value isn't an empty string */
+/** Field will be shown in the RTU UI if its text value isn't an empty string. */
  | 'VISIBLE_IF_NOT_EMPTY'
-/** Field will be shown in the RTU UI */
+/** Field will always be shown in the RTU UI. */
  | 'ALWAYS_VISIBLE';
-/** Supported document types */
+/** Supported document types. */
 export type GenericDocumentType = 
-/** German ID card, front side */
+/** German ID card, front side. */
 'DE_ID_CARD_FRONT'
-/** German ID card, back side */
+/** German ID card, back side. */
  | 'DE_ID_CARD_BACK'
-/** German travel passport (Reisepass) */
+/** German travel passport (Reisepass). */
  | 'DE_PASSPORT'
-/** German driver license (Führerschein), front side */
+/** German driver's license (Führerschein), front side. */
  | 'DE_DRIVER_LICENSE_FRONT'
-/** German driver license (Führerschein), back side */
- | 'DE_DRIVER_LICENSE_BACK';
+/** German driver's license (Führerschein), back side. */
+ | 'DE_DRIVER_LICENSE_BACK'
+/** German residence permit (Aufenthaltstitel), front side. */
+ | 'DE_RESIDENCE_PERMIT_FRONT'
+/** German residence permit (Aufenthaltstitel), back side. */
+ | 'DE_RESIDENCE_PERMIT_BACK';
 /** Detector mode, classic (OCR based) or ML (machine learning based) approach. */
@@ -1629,4 +852,47 @@ export type LicensePlateScanStrategy =
 }
+/** The bounding box of the receiver in absolute image coordinate system */
+export interface OCRBoundingBox {
+    /** x */
+    x: number;
+    /** y */
+    y: number;
+    /** width */
+    width: number;
+    /** height */
+    height: number;
+}
+/** Represents the results of an optical character recognition (OCR) operation */
+export interface OCRResultBlock {
+    /** The recognized text within the receivers bounding box */
+    text: string;
+    /** Ranges from 0.0 (not confident) to 100.0 (very confident). */
+    confidence: number;
+    /** The bounding box of the receiver in absolute image coordinate system */
+    boundingBox: OCRBoundingBox;
+}
+/** Represents the results of an optical character recognition (OCR) operation */
+export interface OCRPage {
+    /** The recognized text of the page */
+    text: string;
+    /** The paragraph blocks of the page */
+    paragraphs: OCRResultBlock[];
+    /** The line blocks of the page */
+    lines: OCRResultBlock[];
+    /** The word blocks of the page */
+    words: OCRResultBlock[];
+}
+/** Enumerated result status of the recognition */
+export type RecognitionStatus = 
+/** Document was found, cropped, all the fields found and their data was recognized */
+'SUCCESS'
+/** Document was found and can be processed further */
+ | 'SUCCESS_FOUND'
+/** Nothing was found */
+ | 'ERROR_NOTHING_FOUND'
+/** Document cannot be cropped in a good way (e.g. not fully visible to viewport, partially covered etc) */
+ | 'ERROR_BAD_CROP'
+/** Image too blurry */
+ | 'ERROR_TOO_BLURRY';
 /** MRZ Document Type */
-export type MRZDocumentType = 
+export type MRZDocumentTypes = 
 /** The document is a passport. */
@@ -1633,0 +899,0 @@ 'PASSPORT'

package.json

 {
   "name": "capacitor-plugin-scanbot-sdk",
-  "version": "4.3.0",
+  "version": "5.1.0-beta.1",
   "description": "Scanbot Document and Barcode Scanner SDK for Capacitor",
@@ -10,2 +10,3 @@ "main": "dist/plugin.cjs.js",
   "files": [
+    "ui_v2/",
     "android/src/main/",
@@ -17,2 +18,10 @@ "android/build.gradle",
   ],
+  "scripts": {
+    "eslint": "eslint . --ext ts --fix",
+    "prettier": "prettier \"**/*.ts\" --write",
+    "docgen": "rimraf ./api-docs && rimraf ./dist-api-docs && cp -r ./dist/ ./dist-api-docs/ && typedoc",
+    "build": "npm run clean && tsc && rollup -c rollup.config.js && npm run docgen",
+    "clean": "rimraf ./dist && rimraf ./api-docs && rimraf ./dist-api-docs",
+    "prepack": "npm run build"
+  },
   "author": "Scanbot SDK",
@@ -74,31 +83,14 @@ "license": "Commercial",
   ],
-  "scripts": {
-    "verify": "npm run verify:ios && npm run verify:android",
-    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..",
-    "verify:android": "cd android && ./gradlew clean build test && cd ..",
-    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
-    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
-    "eslint": "eslint . --ext ts",
-    "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
-    "swiftlint": "node-swiftlint",
-    "docgen": "docgen --api ScanbotSDKCapacitorPlugin --output-readme README.md --output-json dist/docs.json",
-    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js",
-    "clean": "rimraf ./dist",
-    "watch": "tsc --watch",
-    "prepublishOnly": "npm run build"
-  },
   "devDependencies": {
     "@capacitor/android": "^6.0.0",
     "@capacitor/core": "^6.0.0",
-    "@capacitor/docgen": "^0.0.18",
     "@capacitor/ios": "^6.0.0",
-    "@ionic/eslint-config": "^0.3.0",
+    "@ionic/eslint-config": "^0.4.0",
     "@ionic/prettier-config": "^1.0.1",
-    "@ionic/swiftlint-config": "^1.1.2",
-    "eslint": "^7.11.0",
+    "eslint": "^8.57.0",
     "prettier": "~2.3.0",
-    "prettier-plugin-java": "~1.0.2",
     "rimraf": "^3.0.2",
     "rollup": "^2.32.0",
-    "swiftlint": "^1.0.1",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-rename-defaults": "^0.7.0",
     "typescript": "5.1.3"
@@ -110,7 +102,8 @@ },
   "prettier": "@ionic/prettier-config",
-  "swiftlint": "@ionic/swiftlint-config",
   "eslintConfig": {
     "extends": "@ionic/eslint-config/recommended",
     "rules": {
-      "@typescript-eslint/no-empty-interface": "off"
+      "@typescript-eslint/no-namespace": 0,
+      "@typescript-eslint/no-unused-vars": 0,
+      "@typescript-eslint/prefer-as-const": 0
     }
@@ -126,2 +119,2 @@ },
   }
-}
+}

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4147184

increased by292%

Dev dependency count

12

decreased by-14.29%

Number of package files

123

increased by161.7%

Lines of code

37783

increased by154.11%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

46

decreased by-98.47%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes