scanbot-web-sdk 6.0.0-dev.1 → 6.0.0-dev.2

package/ui.d.ts

@@ -0,0 +1,3 @@
+import ScanbotSDK from './@types/scanbot-sdk'
+
+export default ScanbotSDK;

package/ui.js

@@ -0,0 +1,2 @@
+
+var ScanbotSDK = module.exports = require("./bundle/ScanbotSDK.ui2.min.js").ScanbotSDK;

package/webpack/fileLoader.js

@@ -2,9 +2,7 @@ require('!!file-loader?name=ScanbotSDK.Core.js!../bundle/bin/complete/ScanbotSDK
 require('!!file-loader?name=ScanbotSDK.Core-simd.js!../bundle/bin/complete/ScanbotSDK.Core-simd.js');
 require('!!file-loader?name=ScanbotSDK.Core-simd-threads.js!../bundle/bin/complete/ScanbotSDK.Core-simd-threads.js');
 
-// Workaround for webpack issue https://github.com/webpack/webpack/issues/8412
-// which prevents .wasm files from being used with file-loader
-export const path = require('!!file-loader?esModule=false&name=ScanbotSDK.Asm.wasm!../bundle/bin/complete/ScanbotSDK.Asm.wasm-webpack-file-loader');
-require('!!file-loader?esModule=false&name=ScanbotSDK.Asm-simd.wasm!../bundle/bin/complete/ScanbotSDK.Asm-simd.wasm-webpack-file-loader');
-require('!!file-loader?esModule=false&name=ScanbotSDK.Asm-simd-threads.wasm!../bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm-webpack-file-loader');
+export const path = require('!!file-loader?esModule=false&name=ScanbotSDK.Asm.wasm!../bundle/bin/complete/ScanbotSDK.Asm.wasm');
+require('!!file-loader?esModule=false&name=ScanbotSDK.Asm-simd.wasm!../bundle/bin/complete/ScanbotSDK.Asm-simd.wasm');
+require('!!file-loader?esModule=false&name=ScanbotSDK.Asm-simd-threads.wasm!../bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm');
 require('!!file-loader?esModule=false&name=ScanbotSDK.Asm-simd-threads.js!../bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js');

package/@types/core/compiled/ParametricFilters.d.ts

@@ -1,181 +0,0 @@
-/// Auto-generated. Modification will be overwritten.
-
-/** Output mode of binarization filter.*/
-export type OutputMode =
-    /** BINARY - Black and white image, suitable for 1-bit compression.*/
-    "BINARY" |
-
-    /** ANTIALIASED - When the source image is a document photo, this mode
-    will produce nice, smooth, antialiased text in grayscale, which is typically more readable
-    than the text in BINARY mode. Antialiasing requires extra processing,
-    which makes this mode slower than BINARY mode.
-    */
-    "ANTIALIASED";
-
-
-/** Preset of parameters for custom binarization filter.*/
-export type BinarizationFilterPreset =
-    /** Usually performs well if there is no shadow.*/
-    "PRESET_1" |
-
-    /** Usually performs well even if there are shadows.*/
-    "PRESET_2" |
-
-    /** Usually performs well even if there are shadows.*/
-    "PRESET_3" |
-
-    /** Usually performs well even if there are shadows.*/
-    "PRESET_4";
-
-
-
-/** Automatic binarization filter. This filter is a good starting point for most use cases.*/
-export class ScanbotBinarizationFilter {
-    
-    /** Output mode of the filter. BINARY will return a black and white image, GRAYSCALE will return an antialiased grayscale image.*/
-    outputMode: OutputMode;
-    
-
-    /** @internal */
-    toWireType(): any;
-}
-/** Automatic binarization filter. This filter is a good starting point for most use cases.*/
-export class CustomBinarizationFilter {
-    
-    /** Preset of binarization filter parameters that are found to perform well on different types of documents.*/
-    preset: BinarizationFilterPreset;
-    
-    /** Output mode of the filter. BINARY will return a black and white image, GRAYSCALE will return an antialiased grayscale image.*/
-    outputMode: OutputMode;
-    
-    /** Value controlling the amount of noise removal. Value between 0 and 1.
-    Too little noise removal may result in a very noisy image, worsening readability.
-    Too much noise removal may result in the degradation of text, again, worsening readability.
-    */
-    denoise: number;
-    
-    /** Filter radius. The bigger the radius, the slower the filter and generally the less noise in the result.
-    The radius is used for both shadows removal and the calculation of local statistics in the main body of the filter.
-    Higher radius usually allows to cope better with regions of light text on dark background.
-    All the values larger than 512 are clamped to 512.
-    */
-    radius: number;
-    
-
-    /** @internal */
-    toWireType(): any;
-}
-/** Color document filter. This filter is a good starting point for most use cases.*/
-export class ColorDocumentFilter {
-    
-    /** Strength of contrast enhancement. Typical values are between 1 and 2.*/
-    valueStrength: number;
-    
-    /** Strength of color saturation enhancement. Typical values are between 1 and 2.*/
-    saturationStrength: number;
-    
-    /** Saturation level separating colors from paper.*/
-    saturationOffset: number;
-    
-
-    /** @internal */
-    toWireType(): any;
-}
-/** Brightness adjustment filter.*/
-export class BrightnessFilter {
-    
-    /** Brightness adjustment value in the range from -1 to 1. Negative values will make the image darker, positive values will make it brighter.*/
-    brightness: number;
-    
-
-    /** @internal */
-    toWireType(): any;
-}
-/** Contrast adjustment filter.*/
-export class ContrastFilter {
-    
-    /** Contrast adjustment value in the range from -1 to 254 (inclusively). Negative values will decrease the contrast, positive values will increase it.*/
-    contrast: number;
-    
-
-    /** @internal */
-    toWireType(): any;
-}
-/** Converts color images to grayscale, optionally applying autocontrast.*/
-export class GrayscaleFilter {
-    
-    /** Enable or disable autocontrast.
-    */
-    autocontrast: boolean;
-    
-    /** Ignore this fraction of pixels at the edge of the image when calculating statistics.
-    
-    Pixels at the edge of the image typically have poor statistics. Ignoring them
-    and using only the inner pixels when calculating certain statistics can
-    substantially improve the quality of the result.
-    
-    The value must be less than 0.5 but usually good values are between 0 and 0.15.
-    */
-    borderWidthFraction: number;
-    
-    /** Clip this fraction of the darkest pixels in operations such as autocontrast.
-    
-    Increasing the range of middle gray levels at the expense of the brightest and darkest levels
-    may improve the overall contrast and quality of the result.
-    
-    Sum of blackOutliersFraction and whiteOutliersFraction must be less than 1 but usually
-    good values for the parameters do not exceed 0.05;
-    */
-    blackOutliersFraction: number;
-    
-    /** Clip this fraction of the brightest pixels in operations such as autocontrast.
-    
-    Increasing the range of middle gray levels at the expense of the brightest and darkest levels
-    may improve the overall contrast and quality of the result.
-    
-    Sum of blackOutliersFraction and whiteOutliersFraction must be less than 1 but usually
-    good values for the parameters do not exceed 0.05;
-    */
-    whiteOutliersFraction: number;
-    
-
-    /** @internal */
-    toWireType(): any;
-}
-/** Deprecated image filters.*/
-export class LegacyFilter {
-    
-    /** Id of filter to be applied.*/
-    filterType: number;
-    
-
-    /** @internal */
-    toWireType(): any;
-}
-/** Maps image value channel so that all the pixels darker than the black point are set to 0,
-all the pixels brighter than the white point are set to 255, and the pixels in between
-are linearly scaled.
-*/
-export class WhiteBlackPointFilter {
-    
-    /** Fraction of the value channel range that is set to 0. The value should be in the range from 0 to 1.*/
-    blackPoint: number;
-    
-    /** Fraction of the value channel range that is not set to 255. The value should be in the range from 0 to 1.*/
-    whitePoint: number;
-    
-
-    /** @internal */
-    toWireType(): any;
-}
-
-export type ParametricFilter =
-    ScanbotBinarizationFilter |
-    CustomBinarizationFilter |
-    ColorDocumentFilter |
-    BrightnessFilter |
-    ContrastFilter |
-    GrayscaleFilter |
-    LegacyFilter |
-    WhiteBlackPointFilter;
-    

package/@types/core/utils.d.ts

@@ -1 +0,0 @@
-export function areThreadsAvailable(): boolean;

package/@types/core/worker-bridge.d.ts

@@ -1,20 +0,0 @@
-
-export class WorkerBridgeInitOptions {
-    allowSimd?: boolean;
-    allowThreads?: boolean;
-    requestSuffix?: string;
-}
-
-export class WorkerBridge {
-    constructor(basePath: string, options: WorkerBridgeInitOptions);
-
-    post(command: string, args: any[], copyArgs: boolean): Promise<any>;
-
-    // Create a copy and pass it to the worker
-    postByCopyingArgs(command: string, args: any[]): Promise<any>;
-
-    // Directly transfer the args to the worker
-    postByTransferringArgs(command: string, args: any[]): Promise<any>;
-
-    destroy(): void;
-}

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

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

package/@types/model/barcode/engine-mode.d.ts

@@ -1 +0,0 @@
-export type EngineMode = "NEXT_GEN" | "LEGACY";

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

@@ -1,13 +0,0 @@
-export default class DocumentQualityAnalyzerConfiguration {
-    /**
-     * Patch size should be approx. 512-768. It governs the trade-off between speed and memory usage.
-     * Smaller patch sizes use less memory but take longer. Defaults to 512.
-     */
-    patchSize: number;
-    /**
-     * Images with a side length larger than maxImageSize will be downscaled before analysing.
-     * This is useful to reduce memory usage and processing time for large images.
-     * Set to -1 to disable downscaling.
-     */
-    maxImageSize: number;
-}

package/@types/model/document/contour-detection-result.d.ts

@@ -1,11 +0,0 @@
-import { MagneticLine } from "../../utils/dto/MagneticLine";
-import { Polygon } from "../../utils/dto/Polygon";
-import { DetectionStatus } from "./detection-status";
-export declare class ContourDetectionResult {
-    horizontalLines?: MagneticLine[];
-    verticalLines?: MagneticLine[];
-    polygon?: Polygon;
-    detectionStatus?: DetectionStatus;
-    success?: boolean;
-    constructor(contourDetectionResult?: ContourDetectionResult);
-}

package/@types/model/document/detection-status.d.ts

@@ -1,11 +0,0 @@
-export declare enum DetectionStatus {
-    NotAcquired = "NotAcquired",
-    OK = "OK",
-    OK_SmallSize = "OK_SmallSize",
-    OK_BadAngles = "OK_BadAngles",
-    OK_BadAspectRatio = "OK_BadAspectRatio",
-    OK_OffCenter = "OK_OffCenter",
-    Error_NothingDetected = "Error_NothingDetected",
-    Error_Brightness = "Error_Brightness",
-    Error_Noise = "Error_Noise"
-}

package/@types/model/document/document-detection-result.d.ts

@@ -1,8 +0,0 @@
-import { VideoSize } from "../../utils/dto/VideoSize";
-import { ContourDetectionResult } from "./contour-detection-result";
-export declare class DocumentDetectionResult extends ContourDetectionResult {
-    cropped?: Uint8Array;
-    original: Uint8Array;
-    videoSize: VideoSize;
-    constructor(contourDetectionResult?: ContourDetectionResult);
-}

package/@types/model/filter-types.d.ts

@@ -1,6 +0,0 @@
-export type BinarizationFilter = 'binarized' | 'otsuBinarization' | 'pureBinarized' | 'lowLightBinarization' | 'lowLightBinarization2' | 'deepBinarization';
-export type ColorFilter = 'color' | 'gray' | 'colorDocument' | 'blackAndWhite' | 'edgeHighlight';
-/**
- * @deprecated Use the new ImageProcessor API instead (see {@link ScanbotSDK.createImageProcessor}).
- */
-export type ImageFilter = BinarizationFilter | ColorFilter;

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

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

package/@types/model/mrz/mrz-result.d.ts

@@ -1,41 +0,0 @@
-export type MRZFieldValidationStatus = 'Success' | 'Failure' | 'NotValidated';
-export declare class MrzField {
-    name?: string;
-    value?: string;
-    confidence?: number;
-    validated?: MRZFieldValidationStatus;
-    constructor(name?: string, value?: string, confidence?: number, validated?: MRZFieldValidationStatus);
-}
-export declare class MrzCheckDigits {
-    general?: MrzField;
-    documentNumber?: MrzField;
-    birthDate?: MrzField;
-    expiryDate?: MrzField;
-    personalNumber?: MrzField;
-}
-export declare class MrzResult {
-    documentNumber?: MrzField;
-    issuingAuthority?: MrzField;
-    departmentOfIssuance?: MrzField;
-    givenNames?: MrzField;
-    surname?: MrzField;
-    nationality?: MrzField;
-    birthDate?: MrzField;
-    gender?: MrzField;
-    expiryDate?: MrzField;
-    personalNumber?: MrzField;
-    travelDocType?: MrzField;
-    travelDocTypeVariant?: MrzField;
-    optional1?: MrzField;
-    optional2?: MrzField;
-    discreetIssuingStateOrOrganization?: MrzField;
-    kindOfDocumentField?: MrzField;
-    documentType?: MrzField;
-    format?: MrzField;
-    pinCode?: MrzField;
-    languageCode?: MrzField;
-    versionNumber?: MrzField;
-    checkDigits?: MrzCheckDigits;
-    verificationSuccessful?: boolean;
-    static fromWorker(inputs: any): MrzResult;
-}

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

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

package/@types/service/image-processor.d.ts

@@ -1,35 +0,0 @@
-import ScanbotSDK from "../scanbot-sdk";
-import { ParametricFilter } from "../core/compiled/ParametricFilters";
-import { Polygon } from "../utils/dto/Polygon";
-export type Rotation = "ROTATION_NONE" | "ROTATION_90_CLOCKWISE" | "ROTATION_180" | "ROTATION_90_COUNTERCLOCKWISE";
-export declare class ImageProcessor {
-    private _sdk;
-    private _token;
-    /** @internal */
-    constructor(_sdk: ScanbotSDK, _token: string);
-    copy(): Promise<ImageProcessor>;
-    /**
-     * Applies the given filter to the image.
-     * See {@link ParametricFilters} for available filters.
-     * @example
-     * imageProcessor.applyFilter(new sdk.imageFilters.ScanbotBinarizationFilter());
-     * */
-    applyFilter(filter: ParametricFilter): Promise<void>;
-    /**
-     * Crops the image to the given polygon.
-     *    The polygon is defined by an array of four points, each point being an object with `x` and `y` coordinates.
-     *    Each coordinate is a floating point number between 0 and 1, representing the percentage of the image width and height, respectively.
-     *    @example
-     *    // Crop an image to the center 80% of the image:
-     *    imageProcessor.crop([{x: 0.1, y: 0.1}, {x: 0.9, y: 0.1}, {x: 0.9, y: 0.9}, {x: 0.1, y: 0.9}])
-     */
-    crop(polygon: Polygon): Promise<void>;
-    /** Resizes image, keeping aspect ratio, so that the biggest side of the image is equal to `destinationSize`. */
-    resize(destinationSize: number): Promise<void>;
-    rotate(rotation: Rotation): Promise<void>;
-    /** Returns the processed image as a JPEG encoded ArrayBuffer. */
-    processedImage(): Promise<ArrayBuffer>;
-    release(): Promise<void>;
-    /** @internal */
-    get __token(): string;
-}

package/@types/ui2/configuration/BarcodeResult.d.ts

@@ -1,14 +0,0 @@
-import { BarcodeItem } from "./BarcodeItem";
-import { DeepPartial, PartiallyConstructible } from "./utils";
-/**
- Results of the barcode scan.
- */
-export declare class BarcodeScannerResult extends PartiallyConstructible {
-    /**
-     Recognized barcode items.
-     @defaultValue [];
-     */
-    items: BarcodeItem[];
-    /** @param source {@displayType `DeepPartial<BarcodeScannerResult>`} */
-    constructor(source?: DeepPartial<BarcodeScannerResult>);
-}

package/@types/utils/networking.d.ts

@@ -1,7 +0,0 @@
-import { BarcodeResult } from "../model/barcode/barcode-result";
-import { ImageDataWrapper } from "../model/image-data-wrapper";
-export default class Networking {
-    static postBlob(url: string, blob: Blob): Promise<any>;
-    static postImage(url: string, imageData: ImageDataWrapper): Promise<any>;
-    static recognizeBarcodes(url: string, imageData: ImageDataWrapper): Promise<BarcodeResult>;
-}