scanbot-web-sdk 8.0.0-beta.3 → 8.0.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/@types/core/bridge/worker-bridge.d.ts +136 -78
- package/@types/core/compiled/BarcodeConfigurationTypes.d.ts +31 -31
- package/@types/core/compiled/BarcodeDocumentModel.d.ts +89 -57
- package/@types/core/compiled/BarcodeDocumentTypes.d.ts +3 -3
- package/@types/core/compiled/BarcodeScannerTypes.d.ts +17 -9
- package/@types/core/compiled/BarcodeTypes.d.ts +4 -4
- package/@types/core/compiled/CheckScannerTypes.d.ts +6 -3
- package/@types/core/compiled/CreditCardTypes.d.ts +3 -3
- package/@types/core/compiled/DocumentClassifierTypes.d.ts +65 -0
- package/@types/core/compiled/DocumentDataExtractorConfigurationTypes.d.ts +8 -8
- package/@types/core/compiled/DocumentDataExtractorTypes.d.ts +14 -13
- package/@types/core/compiled/DocumentQualityAnalyzerTypes.d.ts +13 -4
- package/@types/core/compiled/DocumentScannerTypes.d.ts +8 -7
- package/@types/core/compiled/FrameAccumulationTypes.d.ts +3 -3
- package/@types/core/compiled/GenericDocument.d.ts +7 -7
- package/@types/core/compiled/Geometry.d.ts +4 -4
- package/@types/core/compiled/LicensingTypes.d.ts +6 -4
- package/@types/core/compiled/MedicalCertificateTypes.d.ts +7 -7
- package/@types/core/compiled/MrzTypes.d.ts +4 -4
- package/@types/core/compiled/OcrTypes.d.ts +6 -6
- package/@types/core/compiled/ParametricFilters.d.ts +23 -8
- package/@types/core/compiled/PdfConfigurationTypes.d.ts +9 -3
- package/@types/core/compiled/TextPatternScannerTypes.d.ts +7 -7
- package/@types/core/compiled/TiffTypes.d.ts +6 -19
- package/@types/core/compiled/VinScannerTypes.d.ts +4 -4
- package/@types/core/compiled/WorkerApiEntrypoint.d.ts +2 -0
- package/@types/core/compiled/bridge/BridgeApiEntrypoint.d.ts +9 -0
- package/@types/core/compiled/bridge/DocumentClassifier.d.ts +33 -0
- package/@types/core/compiled/bridge/DocumentQualityAnalyzer.d.ts +2 -2
- package/@types/core/compiled/bridge/DocumentScanner.d.ts +2 -2
- package/@types/core/compiled/bridge/image.d.ts +2 -2
- package/@types/core/compiled/utils.d.ts +11 -4
- package/@types/core/compiled/worker/WorkerDocumentClassifier.d.ts +19 -0
- package/@types/core/compiled/worker/WorkerDocumentQualityAnalyzer.d.ts +1 -1
- package/@types/core/compiled/worker/WorkerDocumentScanner.d.ts +1 -1
- package/@types/core/worker/ScanbotSDK.Core.d.ts +6 -4
- package/@types/core-types.d.ts +4 -1
- package/@types/document-scanner-view.d.ts +2 -5
- package/@types/index.d.ts +0 -3
- package/@types/scanbot-sdk.d.ts +70 -41
- package/@types/service/tiff-generator.d.ts +2 -2
- package/@types/ui2/common.d.ts +0 -7
- package/@types/ui2/configuration/utils.d.ts +1 -6
- package/@types/worker/worker-bridge.d.ts +136 -78
- package/Libraries.txt +1205 -6
- package/bundle/ScanbotSDK.min.js +4 -4
- package/bundle/ScanbotSDK.ui2.min.js +6 -6
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
- package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm +0 -0
- package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
- package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js +1 -1
- package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm +0 -0
- package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm +0 -0
- package/bundle/bin/complete/ScanbotSDK.Asm.wasm +0 -0
- package/bundle/bin/complete/ScanbotSDK.Core-simd-threads.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Core-simd.js +1 -1
- package/bundle/bin/complete/ScanbotSDK.Core.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
- package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
- package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm +0 -0
- package/bundle/bin/document-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js +1 -1
- package/bundle/bin/document-scanner/ScanbotSDK.Core.js +1 -1
- package/package.json +1 -1
|
@@ -23,12 +23,13 @@ export declare const VCardSourceDocumentType = "Source";
|
|
|
23
23
|
export declare const VCardKindDocumentType = "Kind";
|
|
24
24
|
export declare const VCardXMLDocumentType = "XML";
|
|
25
25
|
export declare const VCardNameDocumentType = "Name";
|
|
26
|
-
export declare const
|
|
26
|
+
export declare const VCardFormattedNameDocumentType = "FormattedName";
|
|
27
27
|
export declare const VCardNicknameDocumentType = "Nickname";
|
|
28
28
|
export declare const VCardBirthdayDocumentType = "Birthday";
|
|
29
29
|
export declare const VCardAnniversaryDocumentType = "Anniversary";
|
|
30
30
|
export declare const VCardGenderDocumentType = "Gender";
|
|
31
31
|
export declare const VCardDeliveryAddressDocumentType = "DeliveryAddress";
|
|
32
|
+
export declare const VCardLabelDocumentType = "Label";
|
|
32
33
|
export declare const VCardPhotoDocumentType = "Photo";
|
|
33
34
|
export declare const VCardTelephoneNumberDocumentType = "TelephoneNumber";
|
|
34
35
|
export declare const VCardEmailDocumentType = "Email";
|
|
@@ -39,6 +40,7 @@ export declare const VCardGeoLocationDocumentType = "GeoLocation";
|
|
|
39
40
|
export declare const VCardTitleDocumentType = "Title";
|
|
40
41
|
export declare const VCardRoleDocumentType = "Role";
|
|
41
42
|
export declare const VCardLogoDocumentType = "Logo";
|
|
43
|
+
export declare const VCardAgentDocumentType = "Agent";
|
|
42
44
|
export declare const VCardOrganisationDocumentType = "Organisation";
|
|
43
45
|
export declare const VCardMemberDocumentType = "Member";
|
|
44
46
|
export declare const VCardRelatedDocumentType = "Related";
|
|
@@ -54,6 +56,8 @@ export declare const VCardPublicKeyDocumentType = "PublicKey";
|
|
|
54
56
|
export declare const VCardBusyTimeURLDocumentType = "BusyTimeURL";
|
|
55
57
|
export declare const VCardCalendarURIForRequestsDocumentType = "CalendarURIForRequests";
|
|
56
58
|
export declare const VCardCalendarURIDocumentType = "CalendarURI";
|
|
59
|
+
export declare const VCardSortStringDocumentType = "SortString";
|
|
60
|
+
export declare const VCardClassificationDocumentType = "Classification";
|
|
57
61
|
export declare const VCardCustomDocumentType = "Custom";
|
|
58
62
|
export declare const AAMVADocumentType = "AAMVA";
|
|
59
63
|
export declare const AAMVATitleDataDocumentType = "TitleData";
|
|
@@ -553,76 +557,84 @@ export declare class VCard {
|
|
|
553
557
|
requiredDocumentType(): string;
|
|
554
558
|
/** The child document of type "Version". */
|
|
555
559
|
get version(): VCard.Version;
|
|
556
|
-
/**
|
|
557
|
-
get
|
|
560
|
+
/** An array of all children of type "Source". */
|
|
561
|
+
get sources(): VCard.Source[];
|
|
558
562
|
/** The child document of type "Kind". */
|
|
559
563
|
get kind(): VCard.Kind | undefined;
|
|
560
|
-
/**
|
|
561
|
-
get
|
|
564
|
+
/** An array of all children of type "XML". */
|
|
565
|
+
get xmls(): VCard.XML[];
|
|
562
566
|
/** The child document of type "Name". */
|
|
563
567
|
get name(): VCard.Name | undefined;
|
|
564
|
-
/** The child document of type "
|
|
565
|
-
get
|
|
566
|
-
/**
|
|
567
|
-
get
|
|
568
|
+
/** The child document of type "FormattedName". */
|
|
569
|
+
get formattedName(): VCard.FormattedName | undefined;
|
|
570
|
+
/** An array of all children of type "Nickname". */
|
|
571
|
+
get nicknames(): VCard.Nickname[];
|
|
568
572
|
/** The child document of type "Birthday". */
|
|
569
573
|
get birthday(): VCard.Birthday | undefined;
|
|
570
574
|
/** The child document of type "Anniversary". */
|
|
571
575
|
get anniversary(): VCard.Anniversary | undefined;
|
|
572
576
|
/** The child document of type "Gender". */
|
|
573
577
|
get gender(): VCard.Gender | undefined;
|
|
574
|
-
/**
|
|
575
|
-
get
|
|
576
|
-
/**
|
|
577
|
-
get
|
|
578
|
-
/**
|
|
579
|
-
get
|
|
580
|
-
/**
|
|
581
|
-
get
|
|
582
|
-
/**
|
|
583
|
-
get
|
|
584
|
-
/**
|
|
585
|
-
get
|
|
586
|
-
/**
|
|
587
|
-
get
|
|
588
|
-
/**
|
|
589
|
-
get
|
|
590
|
-
/**
|
|
591
|
-
get
|
|
592
|
-
/**
|
|
593
|
-
get
|
|
594
|
-
/**
|
|
595
|
-
get
|
|
596
|
-
/**
|
|
597
|
-
get
|
|
598
|
-
/**
|
|
599
|
-
get
|
|
600
|
-
/**
|
|
601
|
-
get
|
|
602
|
-
/**
|
|
603
|
-
get
|
|
604
|
-
/**
|
|
605
|
-
get
|
|
578
|
+
/** An array of all children of type "DeliveryAddress". */
|
|
579
|
+
get deliveryAddresses(): VCard.DeliveryAddress[];
|
|
580
|
+
/** An array of all children of type "Label". */
|
|
581
|
+
get labels(): VCard.Label[];
|
|
582
|
+
/** An array of all children of type "Photo". */
|
|
583
|
+
get photos(): VCard.Photo[];
|
|
584
|
+
/** An array of all children of type "TelephoneNumber". */
|
|
585
|
+
get telephoneNumbers(): VCard.TelephoneNumber[];
|
|
586
|
+
/** An array of all children of type "Email". */
|
|
587
|
+
get emails(): VCard.Email[];
|
|
588
|
+
/** An array of all children of type "IMPP". */
|
|
589
|
+
get impps(): VCard.IMPP[];
|
|
590
|
+
/** An array of all children of type "Languages". */
|
|
591
|
+
get languageses(): VCard.Languages[];
|
|
592
|
+
/** An array of all children of type "TimeZone". */
|
|
593
|
+
get timeZones(): VCard.TimeZone[];
|
|
594
|
+
/** An array of all children of type "GeoLocation". */
|
|
595
|
+
get geoLocations(): VCard.GeoLocation[];
|
|
596
|
+
/** An array of all children of type "Title". */
|
|
597
|
+
get titles(): VCard.Title[];
|
|
598
|
+
/** An array of all children of type "Role". */
|
|
599
|
+
get roles(): VCard.Role[];
|
|
600
|
+
/** An array of all children of type "Logo". */
|
|
601
|
+
get logos(): VCard.Logo[];
|
|
602
|
+
/** An array of all children of type "Agent". */
|
|
603
|
+
get agents(): VCard.Agent[];
|
|
604
|
+
/** An array of all children of type "Organisation". */
|
|
605
|
+
get organisations(): VCard.Organisation[];
|
|
606
|
+
/** An array of all children of type "Member". */
|
|
607
|
+
get members(): VCard.Member[];
|
|
608
|
+
/** An array of all children of type "Related". */
|
|
609
|
+
get relateds(): VCard.Related[];
|
|
610
|
+
/** An array of all children of type "Categories". */
|
|
611
|
+
get categorieses(): VCard.Categories[];
|
|
612
|
+
/** An array of all children of type "Note". */
|
|
613
|
+
get notes(): VCard.Note[];
|
|
606
614
|
/** The child document of type "ProductId". */
|
|
607
615
|
get productId(): VCard.ProductId | undefined;
|
|
608
616
|
/** The child document of type "Revision". */
|
|
609
617
|
get revision(): VCard.Revision | undefined;
|
|
610
|
-
/**
|
|
611
|
-
get
|
|
618
|
+
/** An array of all children of type "Sound". */
|
|
619
|
+
get sounds(): VCard.Sound[];
|
|
612
620
|
/** The child document of type "UID". */
|
|
613
621
|
get uid(): VCard.UID | undefined;
|
|
614
|
-
/**
|
|
615
|
-
get
|
|
616
|
-
/**
|
|
617
|
-
get
|
|
618
|
-
/**
|
|
619
|
-
get
|
|
620
|
-
/**
|
|
621
|
-
get
|
|
622
|
-
/**
|
|
623
|
-
get
|
|
624
|
-
/**
|
|
625
|
-
get
|
|
622
|
+
/** An array of all children of type "ClientPIDMap". */
|
|
623
|
+
get clientPIDMaps(): VCard.ClientPIDMap[];
|
|
624
|
+
/** An array of all children of type "URL". */
|
|
625
|
+
get urls(): VCard.URL[];
|
|
626
|
+
/** An array of all children of type "PublicKey". */
|
|
627
|
+
get publicKeys(): VCard.PublicKey[];
|
|
628
|
+
/** An array of all children of type "BusyTimeURL". */
|
|
629
|
+
get busyTimeURLS(): VCard.BusyTimeURL[];
|
|
630
|
+
/** An array of all children of type "CalendarURIForRequests". */
|
|
631
|
+
get calendarURIForRequestss(): VCard.CalendarURIForRequests[];
|
|
632
|
+
/** An array of all children of type "CalendarURI". */
|
|
633
|
+
get calendarURwe(): VCard.CalendarURI[];
|
|
634
|
+
/** The child document of type "SortString". */
|
|
635
|
+
get sortString(): VCard.SortString | undefined;
|
|
636
|
+
/** The child document of type "Classification". */
|
|
637
|
+
get classification(): VCard.Classification | undefined;
|
|
626
638
|
/** An array of all children of type "Custom". */
|
|
627
639
|
get customs(): VCard.Custom[];
|
|
628
640
|
}
|
|
@@ -665,8 +677,8 @@ export declare namespace VCard {
|
|
|
665
677
|
constructor(document: GenericDocument);
|
|
666
678
|
requiredDocumentType(): string;
|
|
667
679
|
}
|
|
668
|
-
/**
|
|
669
|
-
class
|
|
680
|
+
/** Formatted Name */
|
|
681
|
+
class FormattedName extends Entry {
|
|
670
682
|
constructor(document: GenericDocument);
|
|
671
683
|
requiredDocumentType(): string;
|
|
672
684
|
}
|
|
@@ -695,6 +707,11 @@ export declare namespace VCard {
|
|
|
695
707
|
constructor(document: GenericDocument);
|
|
696
708
|
requiredDocumentType(): string;
|
|
697
709
|
}
|
|
710
|
+
/** Label */
|
|
711
|
+
class Label extends Entry {
|
|
712
|
+
constructor(document: GenericDocument);
|
|
713
|
+
requiredDocumentType(): string;
|
|
714
|
+
}
|
|
698
715
|
/** Photo */
|
|
699
716
|
class Photo extends Entry {
|
|
700
717
|
constructor(document: GenericDocument);
|
|
@@ -745,6 +762,11 @@ export declare namespace VCard {
|
|
|
745
762
|
constructor(document: GenericDocument);
|
|
746
763
|
requiredDocumentType(): string;
|
|
747
764
|
}
|
|
765
|
+
/** Agent */
|
|
766
|
+
class Agent extends Entry {
|
|
767
|
+
constructor(document: GenericDocument);
|
|
768
|
+
requiredDocumentType(): string;
|
|
769
|
+
}
|
|
748
770
|
/** Organisation */
|
|
749
771
|
class Organisation extends Entry {
|
|
750
772
|
constructor(document: GenericDocument);
|
|
@@ -820,6 +842,16 @@ export declare namespace VCard {
|
|
|
820
842
|
constructor(document: GenericDocument);
|
|
821
843
|
requiredDocumentType(): string;
|
|
822
844
|
}
|
|
845
|
+
/** Sort String */
|
|
846
|
+
class SortString extends Entry {
|
|
847
|
+
constructor(document: GenericDocument);
|
|
848
|
+
requiredDocumentType(): string;
|
|
849
|
+
}
|
|
850
|
+
/** Classification */
|
|
851
|
+
class Classification extends Entry {
|
|
852
|
+
constructor(document: GenericDocument);
|
|
853
|
+
requiredDocumentType(): string;
|
|
854
|
+
}
|
|
823
855
|
/** Custom */
|
|
824
856
|
class Custom extends Entry {
|
|
825
857
|
constructor(document: GenericDocument);
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BarcodeFormat } from "./BarcodeTypes";
|
|
2
|
-
import { DeepPartial
|
|
2
|
+
import { DeepPartial } from "./utils";
|
|
3
3
|
import { GenericDocument } from "./GenericDocument";
|
|
4
4
|
/**
|
|
5
5
|
Type of barcode document format used.
|
|
@@ -30,7 +30,7 @@ export declare const BarcodeDocumentFormatValues: BarcodeDocumentFormat[];
|
|
|
30
30
|
/**
|
|
31
31
|
Barcode document formats.
|
|
32
32
|
*/
|
|
33
|
-
export declare class BarcodeDocumentFormats
|
|
33
|
+
export declare class BarcodeDocumentFormats {
|
|
34
34
|
/** @param source {@displayType `DeepPartial<BarcodeDocumentFormats>`} */
|
|
35
35
|
constructor(source?: DeepPartial<BarcodeDocumentFormats>);
|
|
36
36
|
}
|
|
@@ -62,7 +62,7 @@ export declare namespace BarcodeDocumentFormats {
|
|
|
62
62
|
/**
|
|
63
63
|
The result of barcode document parsing.
|
|
64
64
|
*/
|
|
65
|
-
export declare class BarcodeDocumentParserResult
|
|
65
|
+
export declare class BarcodeDocumentParserResult {
|
|
66
66
|
/**
|
|
67
67
|
True if any document was parsed
|
|
68
68
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { BarcodeDocumentFormat } from "./BarcodeDocumentTypes";
|
|
2
2
|
import { BarcodeFormatConfigurationBase } from "./BarcodeConfigurationTypes";
|
|
3
3
|
import { BarcodeFormat } from "./BarcodeTypes";
|
|
4
|
-
import { DeepPartial
|
|
4
|
+
import { DeepPartial } from "./utils";
|
|
5
5
|
import { GenericDocument } from "./GenericDocument";
|
|
6
6
|
import { Image } from "./bridge/image";
|
|
7
7
|
import { Point } from "./utils";
|
|
@@ -11,7 +11,7 @@ import { StructuredAppendInfo } from "./BarcodeTypes";
|
|
|
11
11
|
/**
|
|
12
12
|
A single barcode found in the input image. Barcodes with the same content but different locations in the image are considered separate barcodes.
|
|
13
13
|
*/
|
|
14
|
-
export declare class BarcodeItem
|
|
14
|
+
export declare class BarcodeItem {
|
|
15
15
|
/**
|
|
16
16
|
Text contained in the barcode. Binary data is returned in the rawBytes field only.
|
|
17
17
|
*/
|
|
@@ -48,6 +48,14 @@ export declare class BarcodeItem extends PartiallyConstructible {
|
|
|
48
48
|
*/
|
|
49
49
|
readonly quadNormalized: Point[];
|
|
50
50
|
/**
|
|
51
|
+
As quad, but extended to appropriate height for oned barcodes.
|
|
52
|
+
*/
|
|
53
|
+
readonly extendedQuad: Point[];
|
|
54
|
+
/**
|
|
55
|
+
As quadNormalized, but extended to appropriate height for oned barcodes.
|
|
56
|
+
*/
|
|
57
|
+
readonly extendedQuadNormalized: Point[];
|
|
58
|
+
/**
|
|
51
59
|
True if this is a 1D barcode that is printed upside-down, that is, the barcode was scanned right-to-left.
|
|
52
60
|
@defaultValue false;
|
|
53
61
|
*/
|
|
@@ -127,18 +135,18 @@ export declare const BarcodeAccumulationMethodValues: BarcodeAccumulationMethod[
|
|
|
127
135
|
/**
|
|
128
136
|
Configuration for how to accumulate results.
|
|
129
137
|
*/
|
|
130
|
-
export declare class BarcodeAccumulationConfiguration
|
|
138
|
+
export declare class BarcodeAccumulationConfiguration {
|
|
131
139
|
/**
|
|
132
140
|
In case that ean/upc both with and without extensions are allowed,
|
|
133
141
|
we require confirmations to consider a standalone EAN or UPC (i.e. without extension) as valid.
|
|
134
|
-
@defaultValue
|
|
142
|
+
@defaultValue 1;
|
|
135
143
|
*/
|
|
136
144
|
minConfirmationsStandaloneEAN: number;
|
|
137
145
|
/**
|
|
138
|
-
|
|
139
|
-
@defaultValue
|
|
146
|
+
The time in milliseconds to accumulate barcodes across multiple frames.
|
|
147
|
+
@defaultValue 500;
|
|
140
148
|
*/
|
|
141
|
-
|
|
149
|
+
accumulationTime: number;
|
|
142
150
|
/**
|
|
143
151
|
If true, the results from previous frames that are not connected to results on the current frame will be removed.
|
|
144
152
|
This is should be enabled when large camera movements are expected.
|
|
@@ -157,7 +165,7 @@ export declare class BarcodeAccumulationConfiguration extends PartiallyConstruct
|
|
|
157
165
|
/**
|
|
158
166
|
Configuration for the barcode scanner.
|
|
159
167
|
*/
|
|
160
|
-
export declare class BarcodeScannerConfiguration
|
|
168
|
+
export declare class BarcodeScannerConfiguration {
|
|
161
169
|
/**
|
|
162
170
|
Options for barcode decoding.
|
|
163
171
|
@defaultValue [new BarcodeFormatCommonConfiguration({})];
|
|
@@ -212,7 +220,7 @@ export declare class BarcodeScannerConfiguration extends PartiallyConstructible
|
|
|
212
220
|
/**
|
|
213
221
|
The result of barcode scanning.
|
|
214
222
|
*/
|
|
215
|
-
export declare class BarcodeScannerResult
|
|
223
|
+
export declare class BarcodeScannerResult {
|
|
216
224
|
/**
|
|
217
225
|
List of found barcodes
|
|
218
226
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DeepPartial
|
|
1
|
+
import { DeepPartial } from "./utils";
|
|
2
2
|
/**
|
|
3
3
|
Enumerates character encodings.
|
|
4
4
|
|
|
@@ -76,7 +76,7 @@ export declare const CharacterEncodingValues: CharacterEncoding[];
|
|
|
76
76
|
/**
|
|
77
77
|
A character encoding for a given range of bytes.
|
|
78
78
|
*/
|
|
79
|
-
export declare class RangeEncoding
|
|
79
|
+
export declare class RangeEncoding {
|
|
80
80
|
/**
|
|
81
81
|
Start index of the range.
|
|
82
82
|
*/
|
|
@@ -95,7 +95,7 @@ export declare class RangeEncoding extends PartiallyConstructible {
|
|
|
95
95
|
/**
|
|
96
96
|
The structured append mode can be used to split a message across multiple barcodes.
|
|
97
97
|
*/
|
|
98
|
-
export declare class StructuredAppendInfo
|
|
98
|
+
export declare class StructuredAppendInfo {
|
|
99
99
|
/**
|
|
100
100
|
The number of barcodes in the structured append set.
|
|
101
101
|
*/
|
|
@@ -194,7 +194,7 @@ export declare const BarcodeFormatValues: BarcodeFormat[];
|
|
|
194
194
|
/**
|
|
195
195
|
Lists of barcode formats to decode.
|
|
196
196
|
*/
|
|
197
|
-
export declare class BarcodeFormats
|
|
197
|
+
export declare class BarcodeFormats {
|
|
198
198
|
/** @param source {@displayType `DeepPartial<BarcodeFormats>`} */
|
|
199
199
|
constructor(source?: DeepPartial<BarcodeFormats>);
|
|
200
200
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DeepPartial
|
|
1
|
+
import { DeepPartial } from "./utils";
|
|
2
2
|
import { DocumentDetectionResult } from "./DocumentScannerTypes";
|
|
3
3
|
import { GenericDocument } from "./GenericDocument";
|
|
4
4
|
import { Image } from "./bridge/image";
|
|
@@ -30,7 +30,7 @@ export declare const CheckMagneticInkStripScanningStatusValues: CheckMagneticInk
|
|
|
30
30
|
/**
|
|
31
31
|
The result of check scanning.
|
|
32
32
|
*/
|
|
33
|
-
export declare class CheckScanningResult
|
|
33
|
+
export declare class CheckScanningResult {
|
|
34
34
|
/**
|
|
35
35
|
Magnetic ink strip scanning status.
|
|
36
36
|
@defaultValue "ERROR_NOTHING_FOUND";
|
|
@@ -46,6 +46,7 @@ export declare class CheckScanningResult extends PartiallyConstructible {
|
|
|
46
46
|
readonly documentDetectionResult: DocumentDetectionResult | null;
|
|
47
47
|
/**
|
|
48
48
|
Crop of the check if documentDetectionMode is set to DETECT_AND_CROP_DOCUMENT. Will be non-empty, only if check recognition succeeded.
|
|
49
|
+
@defaultValue null;
|
|
49
50
|
*/
|
|
50
51
|
readonly croppedImage: Image | null;
|
|
51
52
|
/** @param source {@displayType `DeepPartial<CheckScanningResult>`} */
|
|
@@ -54,12 +55,14 @@ export declare class CheckScanningResult extends PartiallyConstructible {
|
|
|
54
55
|
/**
|
|
55
56
|
Configuration of the check scanner.
|
|
56
57
|
*/
|
|
57
|
-
export declare class CheckScannerConfiguration
|
|
58
|
+
export declare class CheckScannerConfiguration {
|
|
58
59
|
/**
|
|
59
60
|
Document detection to be performed in addition to scanning the machine-readable data in the check.
|
|
60
61
|
|
|
61
62
|
By default only the machine-readable data is extracted during check scanning. Optionally, the coordinates and a crop of the entire check document can be returned, in addition to the check data.
|
|
62
63
|
A check scan result may still be successful even if the whole document is not visible in the input image and the complete document could not be located.
|
|
64
|
+
|
|
65
|
+
If cropping is enabled, check recognition will be performed on the cropped image of the check, which may improve recognition results.
|
|
63
66
|
@defaultValue "DISABLED";
|
|
64
67
|
*/
|
|
65
68
|
documentDetectionMode: CheckDocumentDetectionMode;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DeepPartial
|
|
1
|
+
import { DeepPartial } from "./utils";
|
|
2
2
|
import { DocumentDetectionStatus } from "./DocumentScannerTypes";
|
|
3
3
|
import { GenericDocument } from "./GenericDocument";
|
|
4
4
|
import { Point } from "./utils";
|
|
@@ -19,7 +19,7 @@ export declare const CreditCardScanningStatusValues: CreditCardScanningStatus[];
|
|
|
19
19
|
/**
|
|
20
20
|
Contains the result of running the credit card scanner.
|
|
21
21
|
*/
|
|
22
|
-
export declare class CreditCardScanningResult
|
|
22
|
+
export declare class CreditCardScanningResult {
|
|
23
23
|
/**
|
|
24
24
|
The status of the credit card detection step
|
|
25
25
|
*/
|
|
@@ -46,7 +46,7 @@ export declare class CreditCardScanningResult extends PartiallyConstructible {
|
|
|
46
46
|
/**
|
|
47
47
|
Configuration for the credit card scanner.
|
|
48
48
|
*/
|
|
49
|
-
export declare class CreditCardScannerConfiguration
|
|
49
|
+
export declare class CreditCardScannerConfiguration {
|
|
50
50
|
/**
|
|
51
51
|
If true, the document detector will be used to find where the credit card is in the input image.
|
|
52
52
|
If false, the scanner will assume that the credit card has been pre-cropped and takes the entirety of the input image.
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { DeepPartial } from "./utils";
|
|
2
|
+
import { DocumentScanningResult } from "./DocumentScannerTypes";
|
|
3
|
+
/**
|
|
4
|
+
Configuration for the document classifier.
|
|
5
|
+
*/
|
|
6
|
+
export declare class DocumentClassifierConfiguration {
|
|
7
|
+
/**
|
|
8
|
+
If true, image will be scanned for a valid document first.
|
|
9
|
+
@defaultValue true;
|
|
10
|
+
*/
|
|
11
|
+
readonly crop: boolean;
|
|
12
|
+
/** @param source {@displayType `DeepPartial<DocumentClassifierConfiguration>`} */
|
|
13
|
+
constructor(source?: DeepPartial<DocumentClassifierConfiguration>);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
The status of the classification result.
|
|
17
|
+
|
|
18
|
+
- `SUCCESS`:
|
|
19
|
+
The document was classified successfully.
|
|
20
|
+
- `FAILURE_SCANNING`:
|
|
21
|
+
No document was detected.
|
|
22
|
+
*/
|
|
23
|
+
export type DocumentClassifierStatus = "SUCCESS" | "FAILURE_SCANNING";
|
|
24
|
+
export declare const DocumentClassifierStatusValues: DocumentClassifierStatus[];
|
|
25
|
+
/**
|
|
26
|
+
The type of the document.
|
|
27
|
+
|
|
28
|
+
- `UNKNOWN`:
|
|
29
|
+
The document type is unknown.
|
|
30
|
+
- `BILL_OF_LADING`:
|
|
31
|
+
Bill of lading.
|
|
32
|
+
- `PAY_SHEET`:
|
|
33
|
+
Pay sheet.
|
|
34
|
+
- `SCALE_TICKET`:
|
|
35
|
+
Scale ticket.
|
|
36
|
+
- `TOLL_RECEIPT`:
|
|
37
|
+
Toll receipt.
|
|
38
|
+
- `WASH_RECEIPT`:
|
|
39
|
+
Wash receipt.
|
|
40
|
+
*/
|
|
41
|
+
export type DocumentType = "UNKNOWN" | "BILL_OF_LADING" | "PAY_SHEET" | "SCALE_TICKET" | "TOLL_RECEIPT" | "WASH_RECEIPT";
|
|
42
|
+
export declare const DocumentTypeValues: DocumentType[];
|
|
43
|
+
/**
|
|
44
|
+
Contains the result of running the document classifier.
|
|
45
|
+
*/
|
|
46
|
+
export declare class DocumentClassifierResult {
|
|
47
|
+
/**
|
|
48
|
+
The classification result.
|
|
49
|
+
*/
|
|
50
|
+
readonly documentType: DocumentType;
|
|
51
|
+
/**
|
|
52
|
+
The confidence of the classification result.
|
|
53
|
+
*/
|
|
54
|
+
readonly confidence: number;
|
|
55
|
+
/**
|
|
56
|
+
The status of the classification result.
|
|
57
|
+
*/
|
|
58
|
+
readonly status: DocumentClassifierStatus;
|
|
59
|
+
/**
|
|
60
|
+
The result of the document scanning.
|
|
61
|
+
*/
|
|
62
|
+
readonly documentScanningResult: DocumentScanningResult;
|
|
63
|
+
/** @param source {@displayType `DeepPartial<DocumentClassifierResult>`} */
|
|
64
|
+
constructor(source?: DeepPartial<DocumentClassifierResult>);
|
|
65
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DeepPartial
|
|
1
|
+
import { DeepPartial } from "./utils";
|
|
2
2
|
import { MrzDocumentType } from "./MrzTypes";
|
|
3
3
|
/**
|
|
4
4
|
Base class for all generic document configuration elements.
|
|
@@ -16,7 +16,7 @@ Date validation configuration.
|
|
|
16
16
|
This configuration element does not enable the scanning of any document types by itself.
|
|
17
17
|
Add to recognizer configuration to require date validation checks for specific document types.
|
|
18
18
|
*/
|
|
19
|
-
export declare class DateValidationConfiguration
|
|
19
|
+
export declare class DateValidationConfiguration {
|
|
20
20
|
readonly _type: "DateValidationConfiguration";
|
|
21
21
|
/**
|
|
22
22
|
Minimum year that is considered valid.
|
|
@@ -40,7 +40,7 @@ German Address Field validation configuration.
|
|
|
40
40
|
This configuration does not enable the scanning of any document types by itself.
|
|
41
41
|
Add to recognizer configuration to require German Address validation checks for specific document types.
|
|
42
42
|
*/
|
|
43
|
-
export declare class DeAddressParserConfiguration
|
|
43
|
+
export declare class DeAddressParserConfiguration {
|
|
44
44
|
readonly _type: "DeAddressParserConfiguration";
|
|
45
45
|
/**
|
|
46
46
|
List of generic document formats for which German Address validation has to be applied.
|
|
@@ -120,7 +120,7 @@ export declare const EuropeanHealthInsuranceCardIssuingCountryValues: EuropeanHe
|
|
|
120
120
|
/**
|
|
121
121
|
European Health Insurance Card (EHIC) configuration element. Add to extractor configuration to scan EHICs.
|
|
122
122
|
*/
|
|
123
|
-
export declare class EuropeanHealthInsuranceCardConfiguration
|
|
123
|
+
export declare class EuropeanHealthInsuranceCardConfiguration {
|
|
124
124
|
readonly _type: "EuropeanHealthInsuranceCardConfiguration";
|
|
125
125
|
/**
|
|
126
126
|
If an expected country is selected, validation rules for the given country are used,
|
|
@@ -138,7 +138,7 @@ This configuration element does not enable the scanning of any document types by
|
|
|
138
138
|
Add to extractor configuration to enable recognizing the MRZ only, specifically for documents that are otherwise not supported.
|
|
139
139
|
Note that this may enable scanning of documents that were not enabled through the accepted document types.
|
|
140
140
|
*/
|
|
141
|
-
export declare class MrzFallbackConfiguration
|
|
141
|
+
export declare class MrzFallbackConfiguration {
|
|
142
142
|
readonly _type: "MRZFallbackConfiguration";
|
|
143
143
|
/**
|
|
144
144
|
List of ISO 3166-1 alpha-3 country codes for which the MRZ fallback is enabled. (e.g. "DEU" for Germany).
|
|
@@ -158,7 +158,7 @@ Auto-focus configuration.
|
|
|
158
158
|
The recognizer will ignore frames that are not focused. This option is enabled by default.
|
|
159
159
|
This configuration has no effect in SINGLE_SHOT mode.
|
|
160
160
|
*/
|
|
161
|
-
export declare class AutoFocusConfiguration
|
|
161
|
+
export declare class AutoFocusConfiguration {
|
|
162
162
|
readonly _type: "AutoFocusConfiguration";
|
|
163
163
|
/**
|
|
164
164
|
Sensitivity threshold for detecting that autofocus is in progress.
|
|
@@ -177,7 +177,7 @@ Glare detection configuration.
|
|
|
177
177
|
The recognizer will detect whether fields are obstructed by glare. This feature is enabled by default.
|
|
178
178
|
This configuration has no effect in SINGLE_SHOT mode.
|
|
179
179
|
*/
|
|
180
|
-
export declare class GlareDetectionConfiguration
|
|
180
|
+
export declare class GlareDetectionConfiguration {
|
|
181
181
|
readonly _type: "GlareDetectionConfiguration";
|
|
182
182
|
/**
|
|
183
183
|
Glare detection threshold.
|
|
@@ -194,7 +194,7 @@ export declare class GlareDetectionConfiguration extends PartiallyConstructible
|
|
|
194
194
|
Convenience configuration element for enabling the scanning of multiple document types with a common configuration.
|
|
195
195
|
Add to extractor configuration to enable the scanning of multiple document types.
|
|
196
196
|
*/
|
|
197
|
-
export declare class DocumentDataExtractorCommonConfiguration
|
|
197
|
+
export declare class DocumentDataExtractorCommonConfiguration {
|
|
198
198
|
readonly _type: "DocumentDataExtractorCommonConfiguration";
|
|
199
199
|
/**
|
|
200
200
|
List of document types to scan. By default, the list is empty.
|