scanbot-web-sdk 6.0.0-dev.6 → 7.0.0-dev.2

package/@types/core/bridge/compiled/{PdfConfig.d.ts → PdfConfigurationTypes.d.ts}

@@ -1,80 +1,82 @@
 import { DeepPartial, PartiallyConstructible } from "../common";
 /**
-PDF attributes
+PDF attributes.
 */
 export declare class PdfAttributes extends PartiallyConstructible {
     /**
-    Author
-    @defaultValue "Created with ❤️ with Scanbot SDK";
+    Author.
+    @defaultValue "Created with Scanbot SDK";
     */
-    readonly author: string;
+    author: string;
     /**
-    Creator
+    Creator.
     @defaultValue "";
     */
-    readonly creator: string;
+    creator: string;
     /**
-    Title
+    Title.
     @defaultValue "";
     */
-    readonly title: string;
+    title: string;
     /**
-    Subject
+    Subject.
     @defaultValue "";
     */
-    readonly subject: string;
+    subject: string;
     /**
-    Keywords
+    Keywords.
     @defaultValue "";
     */
-    readonly keywords: string;
+    keywords: string;
     /** @param source {@displayType `DeepPartial<PdfAttributes>`} */
     constructor(source?: DeepPartial<PdfAttributes>);
 }
 /**
-Page size
+Page size.
 
 - `LETTER`:
-   8.5 x 11 (inches)        612 x 792 (pixels) at 72 DPI
+   8.5 x 11 (inches)        612 x 792 (pixels) at 72 DPI.
 - `LEGAL`:
-   8.5 x 14 (inches)        612 x 1008 (pixels) at 72 DPI
+   8.5 x 14 (inches)        612 x 1008 (pixels) at 72 DPI.
 - `A3`:
-   297 x 420 (mm)           841.89 x 1199.551 (pixels) at 72 DPI
+   297 x 420 (mm)           841.89 x 1199.551 (pixels) at 72 DPI.
 - `A4`:
-   210 x 297 (mm)           595.276 x 841.89 (pixels) at 72 DPI
+   210 x 297 (mm)           595.276 x 841.89 (pixels) at 72 DPI.
 - `A5`:
-   148 x 210 (mm)           419.528 x 595.276 (pixels) at 72 DPI
+   148 x 210 (mm)           419.528 x 595.276 (pixels) at 72 DPI.
 - `B4`:
-   250 x 353 (mm)           708.661 x 1000.63 (pixels) at 72 DPI
+   250 x 353 (mm)           708.661 x 1000.63 (pixels) at 72 DPI.
 - `B5`:
-   176 x 250 (mm)           498.898 x 708.661 (pixels) at 72 DPI
+   176 x 250 (mm)           498.898 x 708.661 (pixels) at 72 DPI.
 - `EXECUTIVE`:
-   7.25 x 10.5 (inches)     522 x 756 (pixels) at 72 DPI
+   7.25 x 10.5 (inches)     522 x 756 (pixels) at 72 DPI.
 - `US4x6`:
-   4 x 6 (inches)           288 x 432 (pixels) at 72 DPI
+   4 x 6 (inches)           288 x 432 (pixels) at 72 DPI.
 - `US4x8`:
-   4 x 8 (inches)           288 x 576 (pixels) at 72 DPI
+   4 x 8 (inches)           288 x 576 (pixels) at 72 DPI.
 - `US5x7`:
-   5 x 7 (inches)           360 x 504 (pixels) at 72 DPI
+   5 x 7 (inches)           360 x 504 (pixels) at 72 DPI.
 - `COMM10`:
-   4.125 x 9.5 (inches)     297 x 684 (pixels) at 72 DPI
+   4.125 x 9.5 (inches)     297 x 684 (pixels) at 72 DPI.
 - `CUSTOM`:
    physical size will be calculated from the image dimensions and the `dpi` parameter.
 */
 export type PageSize = "LETTER" | "LEGAL" | "A3" | "A4" | "A5" | "B4" | "B5" | "EXECUTIVE" | "US4x6" | "US4x8" | "US5x7" | "COMM10" | "CUSTOM";
+export declare const PageSizeValues: PageSize[];
 /**
-Page direction
+Page direction.
 
 - `PORTRAIT`:
-   Portrait
+   Portrait.
 - `LANDSCAPE`:
-   Landscape
+   Landscape.
 - `AUTO`:
-   Decides based on image aspect ratio
+   Decides based on image aspect ratio.
 */
 export type PageDirection = "PORTRAIT" | "LANDSCAPE" | "AUTO";
+export declare const PageDirectionValues: PageDirection[];
 /**
-Page fit
+Page fit.
 
 - `FIT_IN`:
    Fit image into page. May leave white borders if the aspect ratio
@@ -91,8 +93,9 @@ Page fit
    will be determined by the `dpi` parameter.
 */
 export type PageFit = "FIT_IN" | "FILL_IN" | "STRETCH" | "NONE";
+export declare const PageFitValues: PageFit[];
 /**
-Resampling method
+Resampling method.
 
 - `NONE`:
    Always geometrically rescale the image to fit the page if necessary. Fast.
@@ -117,6 +120,7 @@ Resampling method
    upsampling, it is similar to nearest-neighbor.
 */
 export type ResamplingMethod = "NONE" | "NEAREST" | "LINEAR" | "CUBIC" | "LANCZOS4" | "AREA";
+export declare const ResamplingMethodValues: ResamplingMethod[];
 /**
 The parameters `pageSize`, `pageFit`, `dpi` and `resamplingMethod` interact in a complex way
 when adding bitmap images (JPEG, PNG, or raw) to the PDF.
@@ -141,31 +145,30 @@ There are three cases to consider:
       in this case the bitmap of the image is resampled to match `dpi` using the selected method
       before adding it to the PDF. This will result in a bitmap that is smaller than the
       original image and hence, the resulting PDF will be smaller in size.
-
 */
-export declare class PdfConfig extends PartiallyConstructible {
+export declare class PdfConfiguration extends PartiallyConstructible {
     /**
-    Attributes
+    Attributes.
     @defaultValue new PdfAttributes({});
     */
-    readonly attributes: PdfAttributes;
+    attributes: PdfAttributes;
     /**
     Physical size of the page. If CUSTOM, the page size will be set as the image size at given dpi.
     @defaultValue "A4";
     */
-    readonly pageSize: PageSize;
+    pageSize: PageSize;
     /**
-    Page direction
+    Page direction.
     @defaultValue "PORTRAIT";
     */
-    readonly pageDirection: PageDirection;
+    pageDirection: PageDirection;
     /**
     How to fit the image into the page. Only used if `pageSize` is not `CUSTOM`.
     The image can either be stretched to fill the page,
     in one of three ways, or centered on the page without stretching.
     @defaultValue "FIT_IN";
     */
-    readonly pageFit: PageFit;
+    pageFit: PageFit;
     /**
     The `dpi` parameter has two different meanings depending on the value of `pageSize` and
     `pageFit`. If pageSize is CUSTOM or pageFit is NONE, then `dpi` is the conversion ratio used
@@ -176,7 +179,7 @@ export declare class PdfConfig extends PartiallyConstructible {
     calculated image DPI is used instead.
     @defaultValue 72;
     */
-    readonly dpi: number;
+    dpi: number;
     /**
     JPEG quality for images.
     Applies if an image is added as a cv::Mat and therefore needs to be encoded.
@@ -186,12 +189,12 @@ export declare class PdfConfig extends PartiallyConstructible {
     original.
     @defaultValue 80;
     */
-    readonly jpegQuality: number;
+    jpegQuality: number;
     /**
-    Resampling method
+    Resampling method.
     @defaultValue "NONE";
     */
-    readonly resamplingMethod: ResamplingMethod;
-    /** @param source {@displayType `DeepPartial<PdfConfig>`} */
-    constructor(source?: DeepPartial<PdfConfig>);
+    resamplingMethod: ResamplingMethod;
+    /** @param source {@displayType `DeepPartial<PdfConfiguration>`} */
+    constructor(source?: DeepPartial<PdfConfiguration>);
 }

package/@types/core/bridge/compiled/{GenericTextLineScannerTypes.d.ts → TextPatternScannerTypes.d.ts}

@@ -1,7 +1,7 @@
 import { DeepPartial, PartiallyConstructible } from "../common";
 import { Rectangle } from "../common";
 /**
-Structure containing recognized word text and bounds
+Structure containing recognized word text and bounds.
 */
 export declare class WordBox extends PartiallyConstructible {
     /**
@@ -13,7 +13,7 @@ export declare class WordBox extends PartiallyConstructible {
     */
     readonly boundingRect: Rectangle;
     /**
-    Confidence of the recognition
+    Confidence of the recognition.
     @defaultValue 0.0;
     */
     readonly recognitionConfidence: number;
@@ -21,7 +21,7 @@ export declare class WordBox extends PartiallyConstructible {
     constructor(source?: DeepPartial<WordBox>);
 }
 /**
-Structure containing recognized symbol text and bounds
+Structure containing recognized symbol text and bounds.
 */
 export declare class SymbolBox extends PartiallyConstructible {
     /**
@@ -40,9 +40,9 @@ export declare class SymbolBox extends PartiallyConstructible {
     constructor(source?: DeepPartial<SymbolBox>);
 }
 /**
-The result of the text line recognition
+The result of the text line recognition.
 */
-export declare class ScannerResult extends PartiallyConstructible {
+export declare class TextPatternScannerResult extends PartiallyConstructible {
     /**
     Raw recognized string
     */
@@ -56,29 +56,22 @@ export declare class ScannerResult extends PartiallyConstructible {
     */
     readonly symbolBoxes: SymbolBox[];
     /**
-    Confidence of the recognition
+    Confidence of the recognition.
     @defaultValue 0.0;
     */
     readonly confidence: number;
     /**
-    Whether the validation was successful
+    Whether the validation was successful.
     @defaultValue false;
     */
     readonly validationSuccessful: boolean;
-    /** @param source {@displayType `DeepPartial<ScannerResult>`} */
-    constructor(source?: DeepPartial<ScannerResult>);
+    /** @param source {@displayType `DeepPartial<TextPatternScannerResult>`} */
+    constructor(source?: DeepPartial<TextPatternScannerResult>);
 }
 /**
-Preset for the validation
-
-- `VEHICLE_IDENTIFICATION_NUMBER`:
-   Validation rules for vehicle identification numbers
+Base class for content validators.
 */
-export type ValidatorPreset = "VEHICLE_IDENTIFICATION_NUMBER";
-/**
-Base class for content validators
-*/
-export type ContentValidator = DefaultContentValidator | PresetContentValidator | PatternContentValidator;
+export type ContentValidator = DefaultContentValidator | PatternContentValidator;
 /** @internal */
 export declare namespace ContentValidator {
     /** @internal */
@@ -100,19 +93,7 @@ export declare class DefaultContentValidator extends PartiallyConstructible {
     constructor(source?: DeepPartial<DefaultContentValidator>);
 }
 /**
-Preset content validator
-*/
-export declare class PresetContentValidator extends PartiallyConstructible {
-    readonly _type: "PresetContentValidator";
-    /**
-    Validator preset
-    */
-    preset: ValidatorPreset;
-    /** @param source {@displayType `DeepPartial<PresetContentValidator>`} */
-    constructor(source?: DeepPartial<PresetContentValidator>);
-}
-/**
-Pattern content validator
+Pattern content validator.
 */
 export declare class PatternContentValidator extends PartiallyConstructible {
     readonly _type: "PatternContentValidator";
@@ -129,7 +110,7 @@ export declare class PatternContentValidator extends PartiallyConstructible {
     */
     pattern: string;
     /**
-    Whether the pattern should match the whole string or just a substring
+    Whether the pattern should match the whole string or just a substring.
     @defaultValue false;
     */
     matchSubstring: boolean;
@@ -137,29 +118,29 @@ export declare class PatternContentValidator extends PartiallyConstructible {
     constructor(source?: DeepPartial<PatternContentValidator>);
 }
 /**
-Configuration for the generic text line scanner
+Configuration for the text pattern scanner.
 */
-export declare class ScannerConfiguration extends PartiallyConstructible {
+export declare class TextPatternScannerConfiguration extends PartiallyConstructible {
     /**
     Maximum image side (height or width) for OCR process. 0 - do not rescale.
     @defaultValue 0;
     */
     ocrResolutionLimit: number;
     /**
-    Maximum number of accumulated frames to inspect before actual result is returned
+    Maximum number of accumulated frames to inspect before actual result is returned.
     @defaultValue 3;
     */
     maximumNumberOfAccumulatedFrames: number;
     /**
-    Minimum number of accumulated frames that have equal result
+    Minimum number of accumulated frames that have equal result.
     @defaultValue 2;
     */
     minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
     /**
-    Content validator
+    Content validator.
     @defaultValue new DefaultContentValidator({});
     */
     validator: ContentValidator;
-    /** @param source {@displayType `DeepPartial<ScannerConfiguration>`} */
-    constructor(source?: DeepPartial<ScannerConfiguration>);
+    /** @param source {@displayType `DeepPartial<TextPatternScannerConfiguration>`} */
+    constructor(source?: DeepPartial<TextPatternScannerConfiguration>);
 }

package/@types/core/bridge/compiled/TiffTypes.d.ts

@@ -1,58 +1,55 @@
 import { DeepPartial, PartiallyConstructible } from "../common";
 import { ParametricFilter } from "./ParametricFilters";
 /**
-TIFF compression type
+TIFF compression type.
 
 - `NONE`:
-   dump mode
+   dump mode.
 - `CCITTRLE`:
-   CCITT modified Huffman RLE
-- `CCITTFAX3`:
-   CCITT Group 3 fax encoding
+   CCITT modified Huffman RLE.
 - `CCITT_T4`:
-   CCITT T.4 (TIFF 6 name)
-- `CCITTFAX4`:
-   CCITT Group 4 fax encoding
+   CCITT T.4 (CCITTFAX3, CCITT Group 3 fax encoding, TIFF 6 name).
 - `CCITT_T6`:
-   CCITT T.6 (TIFF 6 name)
+   CCITT T.6 (CCITTFAX4, CCITT Group 4 fax encoding, TIFF 6 name).
 - `LZW`:
-   Lempel-Ziv & Welch
+   Lempel-Ziv and Welch.
 - `OJPEG`:
-   !6.0 JPEG
+   !6.0 JPEG.
 - `JPEG`:
-   %JPEG DCT compression
+   %JPEG DCT compression.
 - `T85`:
-   !TIFF/FX T.85 JBIG compression
+   !TIFF/FX T.85 JBIG compression.
 - `T43`:
-   !TIFF/FX T.43 colour by layered JBIG compression
+   !TIFF/FX T.43 colour by layered JBIG compression.
 - `NEXT`:
-   NeXT 2-bit RLE
+   NeXT 2-bit RLE.
 - `CCITTRLEW`:
-   #1 w/ word alignment
+   #1 w/ word alignment.
 - `PACKBITS`:
-   Macintosh RLE
+   Macintosh RLE.
 - `THUNDERSCAN`:
-   ThunderScan RLE
+   ThunderScan RLE.
 - `IT8CTPAD`:
-   IT8 CT w/padding
+   IT8 CT w/padding.
 - `IT8LW`:
-   IT8 Linework RLE
+   IT8 Linework RLE.
 - `IT8MP`:
-   IT8 Monochrome picture
+   IT8 Monochrome picture.
 - `IT8BL`:
-   IT8 Binary line art
+   IT8 Binary line art.
 - `PIXARFILM`:
-   Pixar companded 10bit LZW
+   Pixar companded 10bit LZW.
 - `PIXARLOG`:
-   Pixar companded 11bit ZIP
+   Pixar companded 11bit ZIP.
 - `DEFLATE`:
-   Deflate compression
+   Deflate compression.
 - `ADOBE_DEFLATE`:
-   Deflate compression, as recognized by Adobe
+   Deflate compression, as recognized by Adobe.
 */
-export type CompressionMode = "NONE" | "CCITTRLE" | "CCITTFAX3" | "CCITT_T4" | "CCITTFAX4" | "CCITT_T6" | "LZW" | "OJPEG" | "JPEG" | "T85" | "T43" | "NEXT" | "CCITTRLEW" | "PACKBITS" | "THUNDERSCAN" | "IT8CTPAD" | "IT8LW" | "IT8MP" | "IT8BL" | "PIXARFILM" | "PIXARLOG" | "DEFLATE" | "ADOBE_DEFLATE";
+export type CompressionMode = "NONE" | "CCITTRLE" | "CCITT_T4" | "CCITT_T6" | "LZW" | "OJPEG" | "JPEG" | "T85" | "T43" | "NEXT" | "CCITTRLEW" | "PACKBITS" | "THUNDERSCAN" | "IT8CTPAD" | "IT8LW" | "IT8MP" | "IT8BL" | "PIXARFILM" | "PIXARLOG" | "DEFLATE" | "ADOBE_DEFLATE";
+export declare const CompressionModeValues: CompressionMode[];
 /**
-Binarization behavior to apply when adding pages to a TIFF
+Binarization behavior to apply when adding pages to a TIFF.
 
 - `DISABLED`:
    Do not binarize the image. Image will be stored as a grayscale or color TIFF.
@@ -63,8 +60,9 @@ Binarization behavior to apply when adding pages to a TIFF
    otherwise same behavior as DISABLED. This is the default.
 */
 export type Binarization = "DISABLED" | "ENABLED" | "ENABLED_IF_BINARIZATION_FILTER_SET";
+export declare const BinarizationValues: Binarization[];
 /**
-User-defined TIFF field value
+User-defined TIFF field value.
 */
 export type UserFieldValue = UserFieldDoubleValue | UserFieldStringValue | UserFieldIntValue;
 /** @internal */
@@ -75,66 +73,66 @@ export declare namespace UserFieldValue {
     }): UserFieldValue;
 }
 /**
-Double value (TIFF_DOUBLE)
+Double value (TIFF_DOUBLE).
 */
 export declare class UserFieldDoubleValue extends PartiallyConstructible {
     readonly _type: "UserFieldDoubleValue";
     /**
     Value
     */
-    readonly value: number;
+    value: number;
     /** @param source {@displayType `DeepPartial<UserFieldDoubleValue>`} */
     constructor(source?: DeepPartial<UserFieldDoubleValue>);
 }
 /**
-ASCII string value (TIFF_ASCII)
+ASCII string value (TIFF_ASCII).
 */
 export declare class UserFieldStringValue extends PartiallyConstructible {
     readonly _type: "UserFieldStringValue";
     /**
     Value
     */
-    readonly value: string;
+    value: string;
     /** @param source {@displayType `DeepPartial<UserFieldStringValue>`} */
     constructor(source?: DeepPartial<UserFieldStringValue>);
 }
 /**
-32-bit int value (TIFF_LONG)
+32-bit int value (TIFF_LONG).
 */
 export declare class UserFieldIntValue extends PartiallyConstructible {
     readonly _type: "UserFieldIntValue";
     /**
     Value
     */
-    readonly value: number;
+    value: number;
     /** @param source {@displayType `DeepPartial<UserFieldIntValue>`} */
     constructor(source?: DeepPartial<UserFieldIntValue>);
 }
 /**
-User-defined TIFF field
+User-defined TIFF field.
 */
 export declare class UserField extends PartiallyConstructible {
     /**
     Numeric tag
     */
-    readonly tag: number;
+    tag: number;
     /**
     Field name
     */
-    readonly name: string;
+    name: string;
     /**
     Value
     */
-    readonly value: UserFieldValue;
+    value: UserFieldValue;
     /** @param source {@displayType `DeepPartial<UserField>`} */
     constructor(source?: DeepPartial<UserField>);
 }
 /**
-TIFF writer parameters
+TIFF writer parameters.
 */
-export declare class TIFFWriterParameters extends PartiallyConstructible {
+export declare class TiffWriterParameters extends PartiallyConstructible {
     /**
-    Compression
+    Compression.
     @defaultValue "LZW";
     */
     compression: CompressionMode;
@@ -149,12 +147,12 @@ export declare class TIFFWriterParameters extends PartiallyConstructible {
     */
     zipCompressionLevel: number;
     /**
-    DPI value
+    DPI value.
     @defaultValue 72;
     */
     dpi: number;
     /**
-    User-defined fields
+    User-defined fields.
     @defaultValue [];
     */
     userFields: UserField[];
@@ -167,18 +165,18 @@ export declare class TIFFWriterParameters extends PartiallyConstructible {
     @defaultValue null;
     */
     binarizationFilter: ParametricFilter | null;
-    /** @param source {@displayType `DeepPartial<TIFFWriterParameters>`} */
-    constructor(source?: DeepPartial<TIFFWriterParameters>);
+    /** @param source {@displayType `DeepPartial<TiffWriterParameters>`} */
+    constructor(source?: DeepPartial<TiffWriterParameters>);
 }
-export declare namespace TIFFWriterParameters {
+export declare namespace TiffWriterParameters {
     /**
-    Default compression
+    Default compression.
     @defaultValue "LZW";
     */
     const defaultCompression: CompressionMode;
     /**
-    Compression mode typically producing the smallest file sizes for binary (1-bit) document images
-    @defaultValue "CCITTFAX4";
+    Compression mode typically producing the smallest file sizes for binary (1-bit) document images.
+    @defaultValue "CCITT_T6";
     */
     const binaryDocumentOptimizedCompression: CompressionMode;
 }

package/@types/core/bridge/compiled/VinScannerTypes.d.ts

@@ -0,0 +1,79 @@
+import { DeepPartial, PartiallyConstructible } from "../common";
+import { Point } from "../common";
+import { TextPatternScannerResult } from "./TextPatternScannerTypes";
+/**
+Status of the barcode extraction.
+
+- `SUCCESS`:
+   Barcode containing a VIN was successfully extracted.
+- `BARCODE_WITHOUT_VIN`:
+   Barcode was found but it does not contain a VIN.
+- `NO_BARCODE_FOUND`:
+   No barcode was found in the image.
+- `BARCODE_EXTRACTION_DISABLED`:
+   Barcode extraction is disabled in the configuration.
+*/
+export type VinBarcodeExtractionStatus = "SUCCESS" | "BARCODE_WITHOUT_VIN" | "NO_BARCODE_FOUND" | "BARCODE_EXTRACTION_DISABLED";
+export declare const VinBarcodeExtractionStatusValues: VinBarcodeExtractionStatus[];
+/**
+Result of the barcode scanner.
+*/
+export declare class VinBarcodeResult extends PartiallyConstructible {
+    /**
+    Text result of the barcode scanner
+    */
+    readonly extractedVIN: string;
+    /**
+    Rectangle of the barcode in the image
+    */
+    readonly rectangle: Point[];
+    /**
+    Status of the barcode extraction
+    */
+    readonly status: VinBarcodeExtractionStatus;
+    /** @param source {@displayType `DeepPartial<VinBarcodeResult>`} */
+    constructor(source?: DeepPartial<VinBarcodeResult>);
+}
+/**
+Result of the VIN scanner.
+*/
+export declare class VinScannerResult extends PartiallyConstructible {
+    /**
+    Text result of the VIN scanner
+    */
+    readonly textResult: TextPatternScannerResult;
+    /**
+    Barcode result of the VIN scanner
+    */
+    readonly barcodeResult: VinBarcodeResult;
+    /** @param source {@displayType `DeepPartial<VinScannerResult>`} */
+    constructor(source?: DeepPartial<VinScannerResult>);
+}
+/**
+Configuration for the VIN scanner.
+*/
+export declare class VinScannerConfiguration extends PartiallyConstructible {
+    /**
+    If true, the VIN scanner will also extract VINs from barcodes.
+    Requires a license that allows barcode scanning in addition to VIN scanning.
+    @defaultValue false;
+    */
+    extractVINFromBarcode: boolean;
+    /**
+    Maximum image side (height or width) for OCR process. 0 - do not rescale.
+    @defaultValue 0;
+    */
+    ocrResolutionLimit: number;
+    /**
+    Maximum number of accumulated frames to inspect before actual result is returned.
+    @defaultValue 3;
+    */
+    maximumNumberOfAccumulatedFrames: number;
+    /**
+    Minimum number of accumulated frames that have equal result.
+    @defaultValue 2;
+    */
+    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
+    /** @param source {@displayType `DeepPartial<VinScannerConfiguration>`} */
+    constructor(source?: DeepPartial<VinScannerConfiguration>);
+}