scanbot-web-sdk 6.0.0-dev.5 → 7.0.0-dev.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "scanbot-web-sdk",
   "title": "Web Scan SDK",
-  "version": "6.0.0-dev.5",
+  "version": "7.0.0-dev.1",
   "description": "Scanbot Web Document and Barcode Scanner SDK",
   "keywords": [
     "barcode",
@@ -70,7 +70,6 @@
     }
   ],
   "devDependencies": {},
-  "dependencies": {},
   "files": [
     "bundle/*",
     "webpack/",
@@ -81,5 +80,6 @@
     "README.md",
     "Libraries.txt",
     "LICENSE"
-  ]
+  ],
+  "dependencies": {}
 }

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

@@ -1,29 +0,0 @@
-import { DeepPartial, PartiallyConstructible } from "../common";
-import { GenericDocument } from "./GenericDocument";
-/**
-Check Recognizer Status
-
-- `SUCCESS`:
-   Recognition successful
-- `VALIDATION_FAILED`:
-   A check was recognized, but validation failed, indication a standard violation, unsupported standard, or recognition error
-- `FAIL`:
-   No check was recognized
-*/
-export type RecognitionStatus = "SUCCESS" | "VALIDATION_FAILED" | "FAIL";
-/**
-The result of check recognition
-*/
-export declare class RecognitionResult extends PartiallyConstructible {
-    /**
-    Check recognizer status
-    @defaultValue "FAIL";
-    */
-    readonly status: RecognitionStatus;
-    /**
-    Generic document containing check data. Not present, if status is FAIL.
-    */
-    readonly check: GenericDocument | null;
-    /** @param source {@displayType `DeepPartial<RecognitionResult>`} */
-    constructor(source?: DeepPartial<RecognitionResult>);
-}

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

@@ -1,18 +0,0 @@
-import { DeepPartial, PartiallyConstructible } from "../common";
-/**
-Configure the frame accumulation process
-*/
-export declare class AccumulatedResultsVerifierConfig extends PartiallyConstructible {
-    /**
-    Maximum number of accumulated frames to inspect to verify a scan result
-    @defaultValue 3;
-    */
-    maximumNumberOfAccumulatedFrames: number;
-    /**
-    Minimum number of accumulated frames that have an equal result in order for the result to be considered verified
-    @defaultValue 2;
-    */
-    minimumNumberOfRequiredFramesWithEqualRecognitionResult: number;
-    /** @param source {@displayType `DeepPartial<AccumulatedResultsVerifierConfig>`} */
-    constructor(source?: DeepPartial<AccumulatedResultsVerifierConfig>);
-}

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

@@ -1,38 +0,0 @@
-import { DeepPartial, PartiallyConstructible } from "../common";
-/**
-Enumerates generic document formats.
-
-- `DeIdCardFront`:
-   DeIdCardFront
-- `DeIdCardBack`:
-   DeIdCardBack
-- `DePassport`:
-   DePassport
-- `DeDriverLicenseFront`:
-   DeDriverLicenseFront
-- `DeDriverLicenseBack`:
-   DeDriverLicenseBack
-- `DeResidencePermitFront`:
-   DeResidencePermitFront
-- `DeResidencePermitBack`:
-   DeResidencePermitBack
-- `EuropeanHealthInsuranceCard`:
-   EuropeanHealthInsuranceCard
-- `DeHealthInsuranceCardFront`:
-   DeHealthInsuranceCardFront
-*/
-export type DocumentType = "DeIdCardFront" | "DeIdCardBack" | "DePassport" | "DeDriverLicenseFront" | "DeDriverLicenseBack" | "DeResidencePermitFront" | "DeResidencePermitBack" | "EuropeanHealthInsuranceCard" | "DeHealthInsuranceCardFront";
-/**
-Lists of generic document formats to decode
-*/
-export declare class DocumentTypes extends PartiallyConstructible {
-    /** @param source {@displayType `DeepPartial<DocumentTypes>`} */
-    constructor(source?: DeepPartial<DocumentTypes>);
-}
-export declare namespace DocumentTypes {
-    /**
-    List of all generic document formats
-    @defaultValue ["DeIdCardFront", "DeIdCardBack", "DePassport", "DeDriverLicenseFront", "DeDriverLicenseBack", "DeResidencePermitFront", "DeResidencePermitBack", "EuropeanHealthInsuranceCard", "DeHealthInsuranceCardFront"];
-    */
-    const all: DocumentType[];
-}

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

@@ -1,150 +0,0 @@
-import { DeepPartial, PartiallyConstructible } from "../common";
-import { DocumentType } from "./MRZTypes";
-/**
-Base class for all generic document configurations.
-*/
-export type GDRConfig = DateValidationConfig | EuropeanHealthInsuranceCardConfig | MRZFallbackConfig | GDRGroupConfig;
-/** @internal */
-export declare namespace GDRConfig {
-    /** @internal */
-    function From(source: {
-        [key: string]: any;
-    }): GDRConfig;
-}
-/**
-Date validation configuration.
-This configuration does not enable the scanning of any document types by itself.
-Add to recognizer configuration to require date validation checks for specific document types.
-
-*/
-export declare class DateValidationConfig extends PartiallyConstructible {
-    readonly _type: "DateValidationConfig";
-    /**
-    Minimum year that is considered valid.
-    @defaultValue 0;
-    */
-    readonly minYear: number;
-    /**
-    Maximum year that is considered valid.
-    @defaultValue 2999;
-    */
-    readonly maxYear: number;
-    /**
-    Name, FullName, or NormalizedName of field type for which the year bounds should be applied.
-    */
-    readonly fieldTypeName: string;
-    /** @param source {@displayType `DeepPartial<DateValidationConfig>`} */
-    constructor(source?: DeepPartial<DateValidationConfig>);
-}
-/**
-Health insurance card issuing country
-
-- `AUSTRIA`:
-   Austria (Validation on the personal identification number is performed as described in "site:www.sozialversicherung.at Was ist die Versicherungsnummer?")
-- `BELGIUM`:
-   Belgium
-- `BULGARIA`:
-   Bulgaria
-- `CROATIA`:
-   Croatia
-- `CYPRUS`:
-   Cyprus
-- `CZECH_REPUBLIC`:
-   Czech Republic
-- `DENMARK`:
-   Denmark
-- `ESTONIA`:
-   Estonia
-- `FINLAND`:
-   Finland
-- `FRANCE`:
-   France
-- `GERMANY`:
-   Germany (Validation performed according to "Spezifikation für Musterkarten und Testkarten (eGK, HBA, SMC), Anhang A" and "GS1 Struktur der Kenn-Nummer (ICCSN) der elektronischen Gesundheitskarte")
-- `GREECE`:
-   Greece
-- `HUNGARY`:
-   Hungary
-- `IRELAND`:
-   Ireland
-- `ITALY`:
-   Italy
-- `LATVIA`:
-   Latvia
-- `LITHUANIA`:
-   Lithuania
-- `LUXEMBOURG`:
-   Luxembourg
-- `MALTA`:
-   Malta
-- `NETHERLANDS`:
-   Netherlands
-- `POLAND`:
-   Poland
-- `PORTUGAL`:
-   Portugal
-- `ROMANIA`:
-   Romania
-- `SLOVAKIA`:
-   Slovakia
-- `SLOVENIA`:
-   Slovenia
-- `SPAIN`:
-   Spain
-- `SWEDEN`:
-   Sweden
-- `SWITZERLAND`:
-   Switzerland
-*/
-export type EHICIssuingCountry = "AUSTRIA" | "BELGIUM" | "BULGARIA" | "CROATIA" | "CYPRUS" | "CZECH_REPUBLIC" | "DENMARK" | "ESTONIA" | "FINLAND" | "FRANCE" | "GERMANY" | "GREECE" | "HUNGARY" | "IRELAND" | "ITALY" | "LATVIA" | "LITHUANIA" | "LUXEMBOURG" | "MALTA" | "NETHERLANDS" | "POLAND" | "PORTUGAL" | "ROMANIA" | "SLOVAKIA" | "SLOVENIA" | "SPAIN" | "SWEDEN" | "SWITZERLAND";
-/**
-EHIC configuration. Add to recognizer configuration to scan EHIC.
-*/
-export declare class EuropeanHealthInsuranceCardConfig extends PartiallyConstructible {
-    readonly _type: "EuropeanHealthInsuranceCardConfig";
-    /**
-    If an expected country is selected, validation rules for the given country are used, a
-    and if the expected country cannot be inferred or the inferred country doesn't  match the given country,
-    the result of recognize() will be IncompleteValidation.
-    @defaultValue null;
-    */
-    readonly expectedCountry: EHICIssuingCountry | null;
-    /** @param source {@displayType `DeepPartial<EuropeanHealthInsuranceCardConfig>`} */
-    constructor(source?: DeepPartial<EuropeanHealthInsuranceCardConfig>);
-}
-/**
-MRZ fallback configuration.
-This configuration does not enable the scanning of any document types by itself.
-Add to recognizer configuration to enable recognizing the MRZ only, specifically for documents that are otherwise not supported.
-Note that this may enable scanning of documents that were not enabled through the accepted document types.
-
-*/
-export declare class MRZFallbackConfig extends PartiallyConstructible {
-    readonly _type: "MRZFallbackConfig";
-    /**
-    List of ISO 3166-1 alpha-3 country codes for which MRZ fallback is enabled. (e.g. "DEU" for Germany)
-    @defaultValue [];
-    */
-    readonly acceptedCountries: string[];
-    /**
-    List of MRZ document formats for which MRZ fallback is enabled.
-    @defaultValue [];
-    */
-    readonly acceptedMRZTypes: DocumentType[];
-    /** @param source {@displayType `DeepPartial<MRZFallbackConfig>`} */
-    constructor(source?: DeepPartial<MRZFallbackConfig>);
-}
-/**
-Convenience configuration for enabling the scanning of multiple generic document types with a common configuration.
-Add to recognizer configuration to enable the scanning of multiple generic documents.
-
-*/
-export declare class GDRGroupConfig extends PartiallyConstructible {
-    readonly _type: "GDRGroupConfig";
-    /**
-    List of generic document formats to scan. By default, the list is empty.
-    */
-    readonly acceptedDocumentTypes: string[];
-    /** @param source {@displayType `DeepPartial<GDRGroupConfig>`} */
-    constructor(source?: DeepPartial<GDRGroupConfig>);
-}

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

@@ -1,83 +0,0 @@
-import { DeepPartial, PartiallyConstructible } from "../common";
-import { GDRConfig } from "./GenericDocumentRecognizerConfigs";
-import { GenericDocument } from "./GenericDocument";
-import { Point } from "../common";
-import { ResultAccumulationConfig } from "./FrameAccumulationTypes";
-/**
-The status of the recognition process
-
-- `SUCCESS`:
-   The document was recognized successfully
-- `ERROR_NOTHING_FOUND`:
-   No document was detected
-- `ERROR_BAD_CROP`:
-   A document was detected, but it was at an angle/distance that was too large
-- `ERROR_UNKNOWN_DOCUMENT`:
-   A document was detected, but it was not recognized as a supported document
-- `ERROR_UNACCEPTABLE_DOCUMENT`:
-   A document was detected as a supported document, but it was not part of the accepted documents
-- `INCOMPLETE_VALIDATION`:
-   All fields were recognized, but some of them failed validation
-*/
-export type RecognitionStatus = "SUCCESS" | "ERROR_NOTHING_FOUND" | "ERROR_BAD_CROP" | "ERROR_UNKNOWN_DOCUMENT" | "ERROR_UNACCEPTABLE_DOCUMENT" | "INCOMPLETE_VALIDATION";
-/**
-Contains the result of running the generic document recognizer
-*/
-export declare class RecognitionResult extends PartiallyConstructible {
-    /**
-    The status of the recognition process
-    */
-    readonly status: RecognitionStatus;
-    /**
-    The recognized document
-    */
-    readonly document: GenericDocument | null;
-    /**
-    Coordinates of the detected document in the input image (clockwise from top-left)
-    */
-    readonly quad: Point[] | null;
-    /** @param source {@displayType `DeepPartial<RecognitionResult>`} */
-    constructor(source?: DeepPartial<RecognitionResult>);
-}
-/**
-The recognition mode
-
-- `LIVE`:
-   The recognizer will attempt to accumulate results over multiple frames.
-- `SINGLE_SHOT`:
-   The recognizer will only use the current frame and will spend additional time to ensure the best possible result.
-*/
-export type RecognitionMode = "LIVE" | "SINGLE_SHOT";
-/**
-Parameters for the recognition process
-*/
-export declare class RecognitionParameters extends PartiallyConstructible {
-    /**
-    The recognition mode
-    @defaultValue "LIVE";
-    */
-    mode: RecognitionMode;
-    /** @param source {@displayType `DeepPartial<RecognitionParameters>`} */
-    constructor(source?: DeepPartial<RecognitionParameters>);
-}
-/**
-Configuration for the generic document recognizer
-*/
-export declare class GenericDocumentRecognizerParameters extends PartiallyConstructible {
-    /**
-    Configuration for how to accumulate results
-    @defaultValue new ResultAccumulationConfig({});
-    */
-    resultAccumulationConfig: ResultAccumulationConfig;
-    /**
-    Normalized names of the fields to exclude from the result
-    @defaultValue [];
-    */
-    fieldExcludeList: string[];
-    /**
-    Options for generic document decoding
-    */
-    configurations: GDRConfig[];
-    /** @param source {@displayType `DeepPartial<GenericDocumentRecognizerParameters>`} */
-    constructor(source?: DeepPartial<GenericDocumentRecognizerParameters>);
-}

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

@@ -1,15 +0,0 @@
-import { DeepPartial, PartiallyConstructible } from "../common";
-/**
-Lists of generic document types to decode
-*/
-export declare class DocumentTypes extends PartiallyConstructible {
-    /** @param source {@displayType `DeepPartial<DocumentTypes>`} */
-    constructor(source?: DeepPartial<DocumentTypes>);
-}
-export declare namespace DocumentTypes {
-    /**
-    List of all generic document types
-    @defaultValue ["DeIdCardFront", "DeIdCardBack", "DePassport", "DeDriverLicenseFront", "DeDriverLicenseBack", "DeResidencePermitFront", "DeResidencePermitBack", "EuropeanHealthInsuranceCard", "DeHealthInsuranceCardFront"];
-    */
-    const all: string[];
-}

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

@@ -1,52 +0,0 @@
-import { AccumulatedResultsVerifierConfig } from "./FrameUtilities";
-import { DeepPartial, PartiallyConstructible } from "../common";
-import { GenericDocument } from "./GenericDocument";
-/**
-Type of document containing the MRZ
-
-- `UNKNOWN`:
-   Undefined
-- `CREW_MEMBER_CERTIFICATE`:
-   Crew member certificate
-- `ID_CARD`:
-   ID card
-- `PASSPORT`:
-   Passport
-- `VISA`:
-   Visa card
-- `CH_DRIVING_LICENSE`:
-   Swiss driver license
-*/
-export type DocumentType = "UNKNOWN" | "CREW_MEMBER_CERTIFICATE" | "ID_CARD" | "PASSPORT" | "VISA" | "CH_DRIVING_LICENSE";
-/**
-Container for result of MRZ recognition attempt
-*/
-export declare class RecognitionResult extends PartiallyConstructible {
-    /**
-    Recognition successful
-    @defaultValue false;
-    */
-    readonly recognitionSuccessful: boolean;
-    /**
-    Raw string value of MRZ
-    */
-    readonly rawMRZ: string;
-    /**
-    Generic document containing MRZ data
-    */
-    readonly document: GenericDocument | null;
-    /** @param source {@displayType `DeepPartial<RecognitionResult>`} */
-    constructor(source?: DeepPartial<RecognitionResult>);
-}
-/**
-Configuration for MRZ recognizer
-*/
-export declare class RecognizerConfiguration extends PartiallyConstructible {
-    /**
-    Configure the frame accumulation process
-    @defaultValue new AccumulatedResultsVerifierConfig({});
-    */
-    accumulatedResultsVerifierConfig: AccumulatedResultsVerifierConfig;
-    /** @param source {@displayType `DeepPartial<RecognizerConfiguration>`} */
-    constructor(source?: DeepPartial<RecognizerConfiguration>);
-}

package/@types/generic-document-recognizer-view.d.ts

@@ -1,22 +0,0 @@
-import React from "react";
-import { ScanbotCameraProps, ScanbotCameraState, ScannerView } from "./scanner-view";
-import { IGenericDocumentRecognizerScannerHandle } from "./interfaces/i-generic-document-recognizer-scanner-handle";
-import { GenericDocumentRecognizerConfiguration } from "./model/configuration/generic-document-recognizer-configuration";
-import type ScanbotSDK from "./scanbot-sdk";
-declare class GenericDocumentRecognizerProps extends ScanbotCameraProps {
-    configuration: GenericDocumentRecognizerConfiguration;
-    sdk: ScanbotSDK;
-}
-export default class GenericDocumentRecognizerView extends ScannerView<GenericDocumentRecognizerProps, ScanbotCameraState> implements IGenericDocumentRecognizerScannerHandle {
-    private configuration;
-    private genericDocumentRecognizer;
-    private enabled;
-    private finder?;
-    constructor(props: GenericDocumentRecognizerProps);
-    static create(sdk: ScanbotSDK, configuration: GenericDocumentRecognizerConfiguration): Promise<IGenericDocumentRecognizerScannerHandle>;
-    componentDidMount(): void;
-    componentWillUnmount(): Promise<void>;
-    private detect;
-    render(): React.JSX.Element;
-}
-export {};

package/@types/interfaces/i-generic-document-recognizer-scanner-handle.d.ts

@@ -1,3 +0,0 @@
-import { IScannerCommon } from "./i-scanner-common-handle";
-export interface IGenericDocumentRecognizerScannerHandle extends IScannerCommon {
-}

package/@types/model/configuration/generic-document-recognizer-configuration.d.ts

@@ -1,9 +0,0 @@
-import type { DeepPartial, GenericDocumentRecognizerTypes } from "../../core-types";
-import { ViewFinderScannerConfiguration } from "./view-finder-scanner-configuration";
-export declare class GenericDocumentRecognizerConfiguration extends ViewFinderScannerConfiguration {
-    constructor();
-    detectorParameters?: DeepPartial<GenericDocumentRecognizerTypes.GenericDocumentRecognizerParameters>;
-    /** Callback is called for every analyzed frame. */
-    onDocumentDetected?: (result: GenericDocumentRecognizerTypes.RecognitionResult) => void;
-    static fromJson(json: DeepPartial<GenericDocumentRecognizerConfiguration>): GenericDocumentRecognizerConfiguration;
-}

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

@@ -1,9 +0,0 @@
-import { ViewFinderScannerConfiguration } from "./view-finder-scanner-configuration";
-import { GenericTextLineScannerTypes, DeepPartial } from "../../core-types";
-export type TextDetectionCallback = (e: GenericTextLineScannerTypes.ScannerResult) => void;
-export declare class TextDataScannerConfiguration extends ViewFinderScannerConfiguration {
-    constructor();
-    ocrConfiguration?: DeepPartial<GenericTextLineScannerTypes.ScannerConfiguration>;
-    onTextDetected?: TextDetectionCallback;
-    static fromJson(json: any): TextDataScannerConfiguration;
-}

package/@types/service/generic-document-recognizer.d.ts

@@ -1,13 +0,0 @@
-import ScanbotSDK from '../scanbot-sdk';
-import { ObjectId, Image, GenericDocumentRecognizerTypes, DeepPartial } from "../core-types";
-import { ConsumeType } from "../consume-type";
-export default class GenericDocumentRecognizer {
-    private _sdk;
-    private _recognizer;
-    /** @internal */
-    constructor(_sdk: ScanbotSDK, _recognizer: ObjectId<"GenericDocumentRecognizer">);
-    recognize<ImageType extends Image>(image: ImageType, parameters: DeepPartial<GenericDocumentRecognizerTypes.RecognitionParameters>, consumeImage?: ConsumeType): Promise<GenericDocumentRecognizerTypes.RecognitionResult & {
-        originalImage: ImageType;
-    }>;
-    release(): Promise<void>;
-}

package/@types/service/text-data-recognizer.d.ts

@@ -1,14 +0,0 @@
-import ScanbotSDK from '../scanbot-sdk';
-import { ObjectId, Image, GenericTextLineScannerTypes } from '../core-types';
-import { ConsumeType } from "../consume-type";
-export default class TextDataScanner {
-    private _sdk;
-    private _textDataScannerToken;
-    constructor(_sdk: ScanbotSDK, _textDataScannerToken: Promise<ObjectId<"GenericTextLineScanner">>);
-    recognize<ImageType extends Image>(image: ImageType, consumeImage?: ConsumeType): Promise<GenericTextLineScannerTypes.ScannerResult & {
-        originalImage: ImageType;
-    }>;
-    cleanRecognitionQueue(): Promise<void>;
-    recognizeURL(imageURL: string): Promise<GenericTextLineScannerTypes.ScannerResult>;
-    release(): Promise<void>;
-}

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

@@ -1 +0,0 @@
-export { BarcodeItem, type BarcodeScannerEngineMode } from "../../core/bridge/compiled/BarcodeScannerTypes";

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

@@ -1 +0,0 @@
-export type { BarcodeFormat, GS1Handling, } from "../../core/bridge/compiled/BarcodeTypes";

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

@@ -1 +0,0 @@
-export * from "../../core/bridge/compiled/CommonFieldType";

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

@@ -1 +0,0 @@
-export * from "../../core/bridge/compiled/GenericDocument";

package/@types/ui2/utils/styled-button.d.ts

@@ -1,7 +0,0 @@
-import React from "react";
-import { ButtonConfiguration } from "../configuration";
-export interface ButtonProps extends ButtonConfiguration {
-    onClick: () => void;
-    icon?: React.ReactNode;
-}
-export declare function StyledButton(props: ButtonProps): React.JSX.Element;