scanbot-web-sdk 7.0.0-dev.2 → 7.0.0-dev.5
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/barcode-scanner-view.d.ts +6 -6
- package/@types/core-types.d.ts +28 -28
- package/@types/cropping-view.d.ts +2 -2
- package/@types/document-data-extractor-view.d.ts +3 -3
- package/@types/document-scanner-view.d.ts +6 -6
- package/@types/index.d.ts +7 -33
- package/@types/model/barcode/barcode-result.d.ts +3 -7
- package/@types/model/barcode/barcode.d.ts +4 -4
- package/@types/model/configuration/{barcode-scanner-configuration.d.ts → barcode-scanner-view-configuration.d.ts} +5 -5
- package/@types/model/configuration/document-data-extractor-view-configuration.d.ts +9 -0
- package/@types/model/configuration/{document-scanner-configuration.d.ts → document-scanner-view-configuration.d.ts} +8 -7
- package/@types/model/configuration/{mrz-scanner-configuration.d.ts → mrz-scanner-view-configuration.d.ts} +6 -6
- package/@types/model/configuration/selection-overlay-configuration.d.ts +2 -2
- package/@types/model/configuration/text-pattern-scanner-view-configuration.d.ts +9 -0
- package/@types/model/configuration/vin-scanner-view-configuration.d.ts +9 -0
- package/@types/mrz-scanner-view.d.ts +3 -3
- package/@types/scanbot-sdk.d.ts +77 -77
- package/@types/service/document-data-extractor.d.ts +2 -2
- package/@types/service/document-quality-analyzer.d.ts +2 -2
- package/@types/service/ocr-engine.d.ts +3 -3
- package/@types/service/simple-mrz-recognizer.d.ts +3 -3
- package/@types/service/text-pattern-scanner.d.ts +3 -3
- package/@types/service/tiff-generator.d.ts +2 -2
- package/@types/service/vin-scanner.d.ts +3 -3
- package/@types/ui2/barcode/controllers/barcode-scanner-controller.d.ts +2 -2
- package/@types/ui2/barcode/controllers/multiple-scanning-mode-controller.d.ts +2 -2
- package/@types/ui2/barcode/controllers/single-scanning-mode-controller.d.ts +2 -2
- package/@types/ui2/barcode/utils/camera-config.d.ts +1 -1
- package/@types/ui2/barcode/utils/styled-button.d.ts +1 -1
- package/@types/ui2/barcode/views/action-button/action-button-container.d.ts +2 -2
- package/@types/ui2/barcode/views/action-button/action-button.d.ts +1 -1
- package/@types/ui2/barcode/views/barcode-scanner.d.ts +3 -3
- package/@types/ui2/barcode/views/camera-permission-denied.d.ts +1 -1
- package/@types/ui2/barcode/views/drawer/subviews/drawer-header-content.d.ts +1 -1
- package/@types/ui2/barcode/views/form/dialog-button.d.ts +0 -1
- package/@types/ui2/barcode/views/navigation-bar.d.ts +1 -1
- package/@types/ui2/configuration/BarcodeItemMapper.d.ts +6 -0
- package/@types/ui2/configuration/BarcodeScannerTypes.d.ts +2 -0
- package/@types/ui2/configuration/BarcodeTypes.d.ts +1 -0
- package/@types/ui2/configuration/CommonFieldType.d.ts +1 -0
- package/@types/ui2/configuration/GenericDocument.d.ts +1 -0
- package/@types/ui2/configuration/Geometry.d.ts +1 -1
- package/@types/ui2/configuration/barcode/ArTrackingOverlayConfiguration.d.ts +3 -24
- package/@types/ui2/configuration/barcode/BarcodeInfoMapping.d.ts +3 -3
- package/@types/ui2/configuration/barcode/BarcodeRecognizerConfiguration.d.ts +6 -13
- package/@types/ui2/configuration/barcode/BarcodeScannerConfiguration.d.ts +13 -13
- package/@types/ui2/configuration/barcode/BarcodeScannerUIResult.d.ts +8 -8
- package/@types/ui2/configuration/barcode/BarcodeUseCase.d.ts +3 -3
- package/@types/ui2/configuration/barcode/FindAndPickScanningModeUseCase.d.ts +8 -6
- package/@types/ui2/configuration/barcode/MultipleScanningModeUseCase.d.ts +11 -6
- package/@types/ui2/configuration/barcode/SingleScanningModeUseCase.d.ts +4 -4
- package/@types/ui2/configuration.d.ts +12 -20
- package/@types/ui2/document/model/sb-document.d.ts +3 -3
- package/@types/ui2/document/views/camera-screen/use-document-scanner-view.d.ts +1 -1
- package/@types/ui2/document/views/camera-screen/user-guidance-text.d.ts +1 -1
- package/@types/ui2/scanbot-sdk-ui.d.ts +2 -2
- package/@types/utils/barcode-utils.d.ts +2 -2
- package/@types/view/action-bar/bottom-action-bar.d.ts +2 -2
- package/@types/view/barcode-calculation/barcode-calculation-popup-list.d.ts +2 -2
- package/@types/view/barcode-calculation/barcode-calculation-popup.d.ts +4 -4
- package/@types/view/barcode-polygon/animated-barcode-selection-overlay.d.ts +5 -5
- package/@types/view/barcode-polygon/barcode-overlay.d.ts +3 -3
- package/@types/view/barcode-polygon/barcode-polygon-label.d.ts +2 -2
- package/@types/view/document-outline.d.ts +1 -1
- package/@types/view/polygon/animated-document-polygon.d.ts +1 -1
- package/@types/view/polygon/animated-path.d.ts +1 -1
- package/@types/worker/worker-bridge.d.ts +98 -98
- package/bundle/ScanbotSDK.min.js +4 -4
- package/bundle/ScanbotSDK.ui2.min.js +16 -16
- 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
- package/@types/model/configuration/document-data-extractor-configuration.d.ts +0 -9
- package/@types/model/configuration/text-pattern-scanner-configuration.d.ts +0 -9
- package/@types/model/configuration/vin-scanner-configuration.d.ts +0 -9
- package/@types/ui2/configuration/barcode/ActionBarConfiguration.d.ts +0 -42
- package/@types/ui2/configuration/barcode/BarcodeItemMapper.d.ts +0 -6
- package/@types/ui2/configuration/barcode/BarcodeScannerTypes.d.ts +0 -2
- package/@types/ui2/configuration/barcode/BarcodeTypes.d.ts +0 -1
- package/@types/ui2/configuration/barcode/CameraConfiguration.d.ts +0 -60
- package/@types/ui2/configuration/barcode/CameraPermission.d.ts +0 -54
- package/@types/ui2/configuration/barcode/Common.d.ts +0 -359
- package/@types/ui2/configuration/barcode/CommonFieldType.d.ts +0 -1
- package/@types/ui2/configuration/barcode/GenericDocument.d.ts +0 -1
- package/@types/ui2/configuration/barcode/Geometry.d.ts +0 -1
- package/@types/ui2/configuration/barcode/ScanbotAlertDialog.d.ts +0 -49
- package/@types/ui2/configuration/barcode/TopBarConfiguration.d.ts +0 -55
- package/@types/ui2/configuration/barcode/UserGuidanceConfiguration.d.ts +0 -30
- package/@types/ui2/configuration/barcode/ViewFinderConfiguration.d.ts +0 -93
|
@@ -7,9 +7,9 @@ import BarcodeCalculationPopup from "./view/barcode-calculation/barcode-calculat
|
|
|
7
7
|
import AnimatedBarcodeSelectionOverlay from "./view/barcode-polygon/animated-barcode-selection-overlay";
|
|
8
8
|
import BottomActionBar from "./view/action-bar/bottom-action-bar";
|
|
9
9
|
import ScannedImageWithOverlay from "./view/barcode-calculation/scanned-image-with-overlay";
|
|
10
|
-
import {
|
|
10
|
+
import { BarcodeScannerViewConfiguration } from "./model/configuration/barcode-scanner-view-configuration";
|
|
11
11
|
import { Size } from "./utils/dto/Size";
|
|
12
|
-
import {
|
|
12
|
+
import { BarcodeItem } from "./core-types";
|
|
13
13
|
import type { ObjectId } from "./core-types";
|
|
14
14
|
export declare class BarcodeScannerProps extends ScanbotCameraProps {
|
|
15
15
|
viewFinderPadding?: ViewFinderPadding;
|
|
@@ -36,15 +36,15 @@ export default class BarcodeScannerView extends ScannerView<BarcodeScannerProps,
|
|
|
36
36
|
scannedImage: ScannedImageWithOverlay | undefined;
|
|
37
37
|
bottomActionBar: BottomActionBar | undefined;
|
|
38
38
|
barcodeScannerHandle: ObjectId<"BarcodeScanner"> | null;
|
|
39
|
-
readonly barcodes:
|
|
39
|
+
readonly barcodes: BarcodeItem[];
|
|
40
40
|
private detectionRunning;
|
|
41
41
|
constructor(props: BarcodeScannerProps);
|
|
42
|
-
get configuration():
|
|
42
|
+
get configuration(): BarcodeScannerViewConfiguration;
|
|
43
43
|
get enabled(): boolean;
|
|
44
44
|
/**
|
|
45
45
|
* Public API functions
|
|
46
46
|
*/
|
|
47
|
-
static create(configuration:
|
|
47
|
+
static create(configuration: BarcodeScannerViewConfiguration): Promise<BarcodeScannerView>;
|
|
48
48
|
isDetectionPaused(): boolean;
|
|
49
49
|
resumeDetection(): Promise<void>;
|
|
50
50
|
pauseDetection(): void;
|
|
@@ -72,5 +72,5 @@ export default class BarcodeScannerView extends ScannerView<BarcodeScannerProps,
|
|
|
72
72
|
getCapabilities(): MediaTrackCapabilities | undefined;
|
|
73
73
|
render(): React.JSX.Element;
|
|
74
74
|
resetCountImage(): void;
|
|
75
|
-
countLabelText(barcodes:
|
|
75
|
+
countLabelText(barcodes: BarcodeItem[]): string;
|
|
76
76
|
}
|
package/@types/core-types.d.ts
CHANGED
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
export *
|
|
2
|
-
export *
|
|
3
|
-
export *
|
|
4
|
-
export *
|
|
5
|
-
export *
|
|
6
|
-
export *
|
|
7
|
-
export *
|
|
8
|
-
export *
|
|
9
|
-
export *
|
|
10
|
-
export *
|
|
11
|
-
export *
|
|
12
|
-
export *
|
|
13
|
-
export *
|
|
14
|
-
export *
|
|
15
|
-
export *
|
|
16
|
-
export *
|
|
17
|
-
export *
|
|
18
|
-
export *
|
|
19
|
-
export *
|
|
20
|
-
export *
|
|
21
|
-
export *
|
|
22
|
-
export *
|
|
23
|
-
export *
|
|
24
|
-
export *
|
|
1
|
+
export * from './core/bridge/compiled/BarcodeConfigurationTypes';
|
|
2
|
+
export * from './core/bridge/compiled/BarcodeScannerTypes';
|
|
3
|
+
export * from './core/bridge/compiled/BarcodeTypes';
|
|
4
|
+
export * from "./core/bridge/compiled/BarcodeDocumentTypes";
|
|
5
|
+
export * from './core/bridge/compiled/CheckScannerTypes';
|
|
6
|
+
export * from './core/bridge/compiled/CommonFieldType';
|
|
7
|
+
export * from './core/bridge/compiled/DocumentScannerTypes';
|
|
8
|
+
export * from './core/bridge/compiled/DocumentQualityAnalyzerTypes';
|
|
9
|
+
export * from './core/bridge/compiled/EuropeanHealthInsuranceCardTypes';
|
|
10
|
+
export * from './core/bridge/compiled/GenericDocument';
|
|
11
|
+
export * from './core/bridge/compiled/DocumentDataExtractorConfigurationTypes';
|
|
12
|
+
export * from './core/bridge/compiled/DocumentDataExtractorTypes';
|
|
13
|
+
export * from './core/bridge/compiled/TextPatternScannerTypes';
|
|
14
|
+
export * from './core/bridge/compiled/Geometry';
|
|
15
|
+
export * from './core/bridge/compiled/LicensePlateScannerTypes';
|
|
16
|
+
export * from './core/bridge/compiled/MedicalCertificateTypes';
|
|
17
|
+
export * from './core/bridge/compiled/MrzTypes';
|
|
18
|
+
export * from './core/bridge/compiled/OcrTypes';
|
|
19
|
+
export * from './core/bridge/compiled/ParametricFilters';
|
|
20
|
+
export * from './core/bridge/compiled/PdfConfigurationTypes';
|
|
21
|
+
export * from './core/bridge/compiled/TiffTypes';
|
|
22
|
+
export * from './core/bridge/compiled/FrameAccumulationTypes';
|
|
23
|
+
export * from './core/bridge/compiled/ImageTypes';
|
|
24
|
+
export * from './core/bridge/compiled/VinScannerTypes';
|
|
25
25
|
export type { ObjectId, Image, CroppedDetectionResult } from './core/worker/ScanbotSDK.Core';
|
|
26
|
-
export *
|
|
27
|
-
export *
|
|
28
|
-
export *
|
|
29
|
-
export *
|
|
26
|
+
export * from './core/bridge/compiled/DocumentsModel';
|
|
27
|
+
export * from './core/bridge/compiled/BarcodeDocumentModel';
|
|
28
|
+
export * from './core/bridge/compiled/CheckDocumentModel';
|
|
29
|
+
export * from './core/bridge/compiled/CreditCardDocumentModel';
|
|
30
30
|
export { PartiallyConstructible, type RawImage, type DeepPartial, type Point, type Rectangle } from './core/bridge/common';
|
|
@@ -10,7 +10,7 @@ import { MagneticLine } from "./utils/dto/MagneticLine";
|
|
|
10
10
|
import { Polygon } from "./utils/dto/Polygon";
|
|
11
11
|
import MagnifierView, { MagnifierOptions } from "./view/cropping/magnifier-view";
|
|
12
12
|
import { ICroppingViewHandle } from "./interfaces/i-cropping-view-handle";
|
|
13
|
-
import {
|
|
13
|
+
import { DocumentDetectionResult } from "./core-types";
|
|
14
14
|
export interface CroppingViewProps {
|
|
15
15
|
configuration: CroppingViewConfiguration;
|
|
16
16
|
container?: HTMLElement;
|
|
@@ -23,7 +23,7 @@ export interface CroppingViewProps {
|
|
|
23
23
|
}
|
|
24
24
|
export interface CroppingViewState {
|
|
25
25
|
image: string;
|
|
26
|
-
documentDetectionResult:
|
|
26
|
+
documentDetectionResult: DocumentDetectionResult;
|
|
27
27
|
polygon: Polygon;
|
|
28
28
|
calculatedSize: Size;
|
|
29
29
|
animation: {
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import React from "react";
|
|
2
2
|
import { ScanbotCameraProps, ScanbotCameraState, ScannerView } from "./scanner-view";
|
|
3
3
|
import { IDocumentDataExtractorScannerHandle } from "./interfaces/i-document-data-extractor-scanner-handle";
|
|
4
|
-
import {
|
|
4
|
+
import { DocumentDataExtractorViewConfiguration } from "./model/configuration/document-data-extractor-view-configuration";
|
|
5
5
|
import type ScanbotSDK from "./scanbot-sdk";
|
|
6
6
|
declare class DocumentDataExtractorProps extends ScanbotCameraProps {
|
|
7
|
-
configuration:
|
|
7
|
+
configuration: DocumentDataExtractorViewConfiguration;
|
|
8
8
|
sdk: ScanbotSDK;
|
|
9
9
|
}
|
|
10
10
|
export default class DocumentDataExtractorView extends ScannerView<DocumentDataExtractorProps, ScanbotCameraState> implements IDocumentDataExtractorScannerHandle {
|
|
@@ -13,7 +13,7 @@ export default class DocumentDataExtractorView extends ScannerView<DocumentDataE
|
|
|
13
13
|
private enabled;
|
|
14
14
|
private finder?;
|
|
15
15
|
constructor(props: DocumentDataExtractorProps);
|
|
16
|
-
static create(sdk: ScanbotSDK, configuration:
|
|
16
|
+
static create(sdk: ScanbotSDK, configuration: DocumentDataExtractorViewConfiguration): Promise<IDocumentDataExtractorScannerHandle>;
|
|
17
17
|
componentDidMount(): void;
|
|
18
18
|
componentWillUnmount(): Promise<void>;
|
|
19
19
|
private detect;
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import React from "react";
|
|
2
2
|
import type ScanbotSDK from './scanbot-sdk';
|
|
3
|
-
import {
|
|
3
|
+
import { DocumentScannerViewConfiguration, HintTextConfiguration } from "./model/configuration/document-scanner-view-configuration";
|
|
4
4
|
import { ScanbotCameraProps, ScanbotCameraState, ScannerView } from "./scanner-view";
|
|
5
5
|
import { ShutterButton, ShutterButtonAction } from "./view/shutter-button";
|
|
6
6
|
import { DocumentOutline } from "./view/document-outline";
|
|
7
7
|
import { PolygonMovementPredicate } from "./utils/predicate/polygon-movement-predicate";
|
|
8
8
|
import { Polygon } from "./utils/dto/Polygon";
|
|
9
9
|
import { IDocumentScannerHandle } from "./interfaces/i-document-scanner-handle";
|
|
10
|
-
import { CroppedDetectionResult,
|
|
10
|
+
import { CroppedDetectionResult, DocumentDetectionResult, ObjectId } from "./core-types";
|
|
11
11
|
import { ViewFinderPadding } from "./view/view-finder";
|
|
12
12
|
export declare class DocumentScannerState extends ScanbotCameraState {
|
|
13
13
|
action: ShutterButtonAction;
|
|
@@ -30,13 +30,13 @@ export default class DocumentScannerView extends ScannerView<DocumentScannerProp
|
|
|
30
30
|
constructor(props: DocumentScannerProps);
|
|
31
31
|
get defaultAction(): ShutterButtonAction;
|
|
32
32
|
get enabled(): boolean;
|
|
33
|
-
get configuration():
|
|
33
|
+
get configuration(): DocumentScannerViewConfiguration;
|
|
34
34
|
componentDidUpdate(prevProps: DocumentScannerProps): void;
|
|
35
35
|
get autoCaptureSensitivity(): number;
|
|
36
36
|
/**
|
|
37
37
|
* Public API functions
|
|
38
38
|
*/
|
|
39
|
-
static create(configuration:
|
|
39
|
+
static create(configuration: DocumentScannerViewConfiguration, sdk: ScanbotSDK): Promise<DocumentScannerView>;
|
|
40
40
|
detectAndCrop(): Promise<CroppedDetectionResult | null>;
|
|
41
41
|
enableAutoCapture(): void;
|
|
42
42
|
disableAutoCapture(): void;
|
|
@@ -49,8 +49,8 @@ export default class DocumentScannerView extends ScannerView<DocumentScannerProp
|
|
|
49
49
|
componentDidMount(): Promise<void>;
|
|
50
50
|
componentWillUnmount(): Promise<void>;
|
|
51
51
|
detect(): Promise<void>;
|
|
52
|
-
getStatusString(detectionResult:
|
|
53
|
-
detectInWebWorker(): Promise<
|
|
52
|
+
getStatusString(detectionResult: DocumentDetectionResult): import("./core-types").DocumentDetectionStatus;
|
|
53
|
+
detectInWebWorker(): Promise<DocumentDetectionResult & {
|
|
54
54
|
originalImage: ImageData;
|
|
55
55
|
}>;
|
|
56
56
|
preventAutoCapture?: boolean;
|
package/@types/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { SBStoreImageType } from "./service/storage/indexed-db/sb-indexed-db";
|
|
2
2
|
|
|
3
3
|
export { IDocumentScannerHandle } from "./interfaces/i-document-scanner-handle";
|
|
4
|
-
export {
|
|
4
|
+
export { DocumentScannerViewConfiguration, StyleConfiguration, TextConfiguration, CaptureButtonStyleConfiguration, OutlineStyleConfiguration, HintTextConfiguration, OutlineLabelStyleConfiguration, CaptureAnimationStyleConfiguration, OutlinePolygonStyleConfiguration } from "./model/configuration/document-scanner-view-configuration";
|
|
5
5
|
|
|
6
6
|
export { ViewFinderScannerConfiguration } from "./model/configuration/view-finder-scanner-configuration";
|
|
7
7
|
|
|
@@ -10,20 +10,20 @@ export { CroppingViewConfiguration, CroppingViewStyle, CroppingViewMagneticLineS
|
|
|
10
10
|
export { CroppingResult } from "./model/response/cropping-result";
|
|
11
11
|
|
|
12
12
|
export { IBarcodeScannerHandle } from "./interfaces/i-barcode-scanner-handle";
|
|
13
|
-
export {
|
|
13
|
+
export { BarcodeScannerViewConfiguration } from "./model/configuration/barcode-scanner-view-configuration";
|
|
14
14
|
export { BarcodeCountConfiguration, BarcodeCountStyleConfiguration } from "./model/configuration/barcode-count-configuration";
|
|
15
15
|
export { BarcodeScannerResultWithSize } from "./model/barcode/barcode-result";
|
|
16
16
|
|
|
17
17
|
export { IMrzScannerHandle } from "./interfaces/i-mrz-scanner-handle";
|
|
18
|
-
export {
|
|
18
|
+
export { MrzScannerViewConfiguration, MrzScannerAccumulatedFrameVerificationConfiguration } from "./model/configuration/mrz-scanner-view-configuration";
|
|
19
19
|
export * as SimpleMrzRecognizer from "./service/simple-mrz-recognizer";
|
|
20
20
|
|
|
21
|
-
export {
|
|
21
|
+
export { TextPatternScannerViewConfiguration, TextDetectionCallback } from "./model/configuration/text-pattern-scanner-view-configuration";
|
|
22
22
|
export { ITextPatternScannerHandle } from "./interfaces/i-text-pattern-scanner-handle";
|
|
23
23
|
|
|
24
|
-
export {
|
|
24
|
+
export { VinScannerViewConfiguration, VinDetectionCallback } from "./model/configuration/vin-scanner-view-configuration";
|
|
25
25
|
|
|
26
|
-
export {
|
|
26
|
+
export { DocumentDataExtractorViewConfiguration } from "./model/configuration/document-data-extractor-view-configuration";
|
|
27
27
|
export { DocumentDataExtractor } from "./service/document-data-extractor";
|
|
28
28
|
|
|
29
29
|
export { PdfGenerator, PdfPageOptions } from "./service/pdf-generator";
|
|
@@ -67,33 +67,7 @@ export { SBPageData } from "./ui2/document/model/utils/sb-page-data";
|
|
|
67
67
|
|
|
68
68
|
export { default as ScanbotSDKUI2 } from "./ui2/scanbot-sdk-ui";
|
|
69
69
|
export * as UIConfig from "./ui2/configuration";
|
|
70
|
-
export
|
|
71
|
-
BarcodeConfigurationTypes,
|
|
72
|
-
BarcodeDocumentTypes,
|
|
73
|
-
BarcodeScannerTypes,
|
|
74
|
-
BarcodeTypes,
|
|
75
|
-
CheckScannerTypes,
|
|
76
|
-
CommonFieldType,
|
|
77
|
-
DocumentDataExtractorTypes,
|
|
78
|
-
DocumentDataExtractorConfigurationTypes,
|
|
79
|
-
DocumentScannerTypes,
|
|
80
|
-
DocumentQualityAnalyzerTypes,
|
|
81
|
-
EuropeanHealthInsuranceCardTypes,
|
|
82
|
-
GenericDocument,
|
|
83
|
-
TextPatternScannerTypes,
|
|
84
|
-
Geometry,
|
|
85
|
-
ImageTypes,
|
|
86
|
-
LicensePlateScannerTypes,
|
|
87
|
-
MedicalCertificateTypes,
|
|
88
|
-
MrzTypes,
|
|
89
|
-
OcrTypes,
|
|
90
|
-
ParametricFilters,
|
|
91
|
-
PdfConfigurationTypes,
|
|
92
|
-
TiffTypes,
|
|
93
|
-
FrameAccumulationTypes,
|
|
94
|
-
ObjectId, Image, CroppedDetectionResult,
|
|
95
|
-
PartiallyConstructible, RawImage, DeepPartial, Point, Rectangle
|
|
96
|
-
} from "./core-types";
|
|
70
|
+
export * from "./core-types";
|
|
97
71
|
|
|
98
72
|
// We also need to export the Config-namespace as a whole, because it is directly used in
|
|
99
73
|
// ScanbotSDK.ts and without it, the API docs would be incomplete.
|
|
@@ -1,17 +1,13 @@
|
|
|
1
1
|
import { Size } from "../../utils/dto/Size";
|
|
2
|
-
import
|
|
2
|
+
import { BarcodeItem } from "../../core-types";
|
|
3
3
|
export declare class BarcodeScannerResultWithSize {
|
|
4
|
-
|
|
5
|
-
barcodes: BarcodeScannerTypes.BarcodeItem[];
|
|
6
|
-
originalImage?: ImageData;
|
|
7
|
-
};
|
|
8
|
-
barcodes: BarcodeScannerTypes.BarcodeItem[];
|
|
4
|
+
barcodes: BarcodeItem[];
|
|
9
5
|
originalImageSize: Size | null;
|
|
10
6
|
/**
|
|
11
7
|
* @internal
|
|
12
8
|
*/
|
|
13
9
|
constructor(coreResult: {
|
|
14
|
-
barcodes:
|
|
10
|
+
barcodes: BarcodeItem[];
|
|
15
11
|
originalImage?: ImageData;
|
|
16
12
|
});
|
|
17
13
|
isEmpty(): boolean;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export declare function barcodesEqual(barcodeItem1:
|
|
3
|
-
export declare function barcodeId(barcode:
|
|
4
|
-
export declare function barcodeItemFromText(text: string):
|
|
1
|
+
import { BarcodeItem } from "../../core-types";
|
|
2
|
+
export declare function barcodesEqual(barcodeItem1: BarcodeItem, barcodeItem2: BarcodeItem): boolean;
|
|
3
|
+
export declare function barcodeId(barcode: BarcodeItem): string;
|
|
4
|
+
export declare function barcodeItemFromText(text: string): BarcodeItem;
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
import { SelectionOverlayConfiguration } from "./selection-overlay-configuration";
|
|
2
2
|
import { BarcodeCountConfiguration } from "./barcode-count-configuration";
|
|
3
3
|
import { ViewFinderScannerConfiguration } from "./view-finder-scanner-configuration";
|
|
4
|
-
import {
|
|
4
|
+
import { BarcodeScannerConfiguration, type DeepPartial } from "../../core-types";
|
|
5
5
|
import type { BarcodeScannerResultWithSize } from "../barcode/barcode-result";
|
|
6
|
-
export declare class
|
|
6
|
+
export declare class BarcodeScannerViewConfiguration extends ViewFinderScannerConfiguration {
|
|
7
7
|
constructor();
|
|
8
8
|
/**
|
|
9
9
|
* Capture delay in milliseconds after detecting barcodes. Defaults to 1000
|
|
10
10
|
*/
|
|
11
11
|
captureDelay?: number;
|
|
12
12
|
overlay?: SelectionOverlayConfiguration;
|
|
13
|
-
/** {@displayType `Omit<DeepPartial<
|
|
14
|
-
detectionParameters?: Omit<DeepPartial<
|
|
13
|
+
/** {@displayType `Omit<DeepPartial<BarcodeScannerConfiguration>, "live">`} {@link BarcodeScannerConfiguration}*/
|
|
14
|
+
detectionParameters?: Omit<DeepPartial<BarcodeScannerConfiguration>, "live">;
|
|
15
15
|
/**
|
|
16
16
|
* Special property to enable barcode count mode.
|
|
17
17
|
* This is a type of a ready-to-use user interface scanning and counting found barcodes.
|
|
@@ -39,5 +39,5 @@ export declare class BarcodeScannerConfiguration extends ViewFinderScannerConfig
|
|
|
39
39
|
* A lower value will result in faster processing times but may reduce recognition quality.
|
|
40
40
|
*/
|
|
41
41
|
desiredRecognitionResolution?: number;
|
|
42
|
-
static fromJson(json: any):
|
|
42
|
+
static fromJson(json: any): BarcodeScannerViewConfiguration;
|
|
43
43
|
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { DeepPartial, DocumentDataExtractionResult, DocumentDataExtractorConfiguration } from "../../core-types";
|
|
2
|
+
import { ViewFinderScannerConfiguration } from "./view-finder-scanner-configuration";
|
|
3
|
+
export declare class DocumentDataExtractorViewConfiguration extends ViewFinderScannerConfiguration {
|
|
4
|
+
constructor();
|
|
5
|
+
detectorParameters?: DeepPartial<DocumentDataExtractorConfiguration>;
|
|
6
|
+
/** Callback is called for every analyzed frame. */
|
|
7
|
+
onDocumentDetected?: (result: DocumentDataExtractionResult) => void;
|
|
8
|
+
static fromJson(json: DeepPartial<DocumentDataExtractorViewConfiguration>): DocumentDataExtractorViewConfiguration;
|
|
9
|
+
}
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
import { ScannerConfiguration } from "./scanner-configuration";
|
|
2
|
-
import {
|
|
3
|
-
import { ViewFinderConfiguration } from "../../ui2/configuration
|
|
2
|
+
import { CroppedDetectionResult, DocumentDetectionStatus, DocumentScannerParameters } from "../../core-types";
|
|
3
|
+
import type { ViewFinderConfiguration } from "../../ui2/configuration";
|
|
4
|
+
import type { DeepPartial } from "../../ui2/common";
|
|
4
5
|
export declare class TextConfiguration {
|
|
5
6
|
constructor(hint?: HintTextConfiguration);
|
|
6
7
|
hint?: HintTextConfiguration;
|
|
7
8
|
}
|
|
8
9
|
export type HintTextConfiguration = {
|
|
9
|
-
[key in
|
|
10
|
+
[key in DocumentDetectionStatus]: string;
|
|
10
11
|
};
|
|
11
12
|
export declare class StyleConfiguration {
|
|
12
13
|
constructor();
|
|
@@ -47,10 +48,10 @@ export declare class OutlineLabelStyleConfiguration {
|
|
|
47
48
|
export declare class CaptureButtonStyleConfiguration {
|
|
48
49
|
color?: string;
|
|
49
50
|
}
|
|
50
|
-
export declare class
|
|
51
|
+
export declare class DocumentScannerViewConfiguration extends ScannerConfiguration {
|
|
51
52
|
constructor();
|
|
52
|
-
/** {@displayType `DeepPartial<
|
|
53
|
-
detectionParameters?: DeepPartial<
|
|
53
|
+
/** {@displayType `DeepPartial<DocumentScannerParameters>`} {@link DocumentScannerParameters}*/
|
|
54
|
+
detectionParameters?: DeepPartial<DocumentScannerParameters>;
|
|
54
55
|
/**
|
|
55
56
|
* If auto-capture is enabled and when a document is detected, it will be automatically
|
|
56
57
|
* captured when conditions are good and the auto-snapping time-out elapses.
|
|
@@ -98,5 +99,5 @@ export declare class DocumentScannerConfiguration extends ScannerConfiguration {
|
|
|
98
99
|
* stopped only when detection is stopped or camera widget is disposed.
|
|
99
100
|
*/
|
|
100
101
|
onDocumentDetected?: (result: CroppedDetectionResult) => void;
|
|
101
|
-
static fromJson(json: any):
|
|
102
|
+
static fromJson(json: any): DocumentScannerViewConfiguration;
|
|
102
103
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DeepPartial,
|
|
1
|
+
import { DeepPartial, MrzScannerConfiguration, MrzScannerResult } from "../../core-types";
|
|
2
2
|
import { ViewFinderScannerConfiguration } from "./view-finder-scanner-configuration";
|
|
3
3
|
export interface MrzScannerAccumulatedFrameVerificationConfiguration {
|
|
4
4
|
/** Maximum number of accumulated frames to inspect to verify a scan result */
|
|
@@ -7,11 +7,11 @@ export interface MrzScannerAccumulatedFrameVerificationConfiguration {
|
|
|
7
7
|
* in order for the result to be considered verified */
|
|
8
8
|
minimumNumberOfRequiredFramesWithEqualRecognitionResult?: number;
|
|
9
9
|
}
|
|
10
|
-
export declare class
|
|
10
|
+
export declare class MrzScannerViewConfiguration extends ViewFinderScannerConfiguration {
|
|
11
11
|
constructor();
|
|
12
|
-
/** {@displayType `DeepPartial<
|
|
13
|
-
recognizerConfiguration?: DeepPartial<
|
|
14
|
-
onMrzDetected?: (e:
|
|
12
|
+
/** {@displayType `DeepPartial<MrzScannerConfiguration>`} {@link MrzScannerConfiguration}*/
|
|
13
|
+
recognizerConfiguration?: DeepPartial<MrzScannerConfiguration>;
|
|
14
|
+
onMrzDetected?: (e: MrzScannerResult) => void;
|
|
15
15
|
_onDetectionFailed?: (e: ImageData) => void;
|
|
16
|
-
static fromJson(json: any):
|
|
16
|
+
static fromJson(json: any): MrzScannerViewConfiguration;
|
|
17
17
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { BarcodeItem } from "../../core-types";
|
|
2
2
|
export type SelectionOverlayTextFormat = "Text" | "TextAndFormat" | "None";
|
|
3
3
|
export declare class BarcodePolygonStyle {
|
|
4
4
|
fillColor?: string;
|
|
@@ -49,5 +49,5 @@ export declare class SelectionOverlayConfiguration {
|
|
|
49
49
|
*/
|
|
50
50
|
countingRepeatDelay?: number;
|
|
51
51
|
style?: SelectionOverlayStyleConfiguration;
|
|
52
|
-
onBarcodeFound?: (code:
|
|
52
|
+
onBarcodeFound?: (code: BarcodeItem, polygon: IBarcodePolygonHandle, label: IBarcodePolygonLabelHandle) => void;
|
|
53
53
|
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { ViewFinderScannerConfiguration } from "./view-finder-scanner-configuration";
|
|
2
|
+
import { DeepPartial, TextPatternScannerResult, TextPatternScannerConfiguration } from "../../core-types";
|
|
3
|
+
export type TextDetectionCallback = (e: TextPatternScannerResult) => void;
|
|
4
|
+
export declare class TextPatternScannerViewConfiguration extends ViewFinderScannerConfiguration {
|
|
5
|
+
constructor();
|
|
6
|
+
ocrConfiguration?: DeepPartial<TextPatternScannerConfiguration>;
|
|
7
|
+
onTextDetected?: TextDetectionCallback;
|
|
8
|
+
static fromJson(json: any): TextPatternScannerViewConfiguration;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { ViewFinderScannerConfiguration } from "./view-finder-scanner-configuration";
|
|
2
|
+
import { DeepPartial, VinScannerConfiguration, VinScannerResult } from "../../core-types";
|
|
3
|
+
export type VinDetectionCallback = (e: VinScannerResult) => void;
|
|
4
|
+
export declare class VinScannerViewConfiguration extends ViewFinderScannerConfiguration {
|
|
5
|
+
constructor();
|
|
6
|
+
detectionConfiguration?: DeepPartial<VinScannerConfiguration>;
|
|
7
|
+
onVinDetected?: VinDetectionCallback;
|
|
8
|
+
static fromJson(json: any): VinScannerViewConfiguration;
|
|
9
|
+
}
|
|
@@ -3,7 +3,7 @@ import { ScanbotCameraProps, ScanbotCameraState, ScannerView } from "./scanner-v
|
|
|
3
3
|
import { IMrzScannerHandle } from "./interfaces/i-mrz-scanner-handle";
|
|
4
4
|
import ViewFinder from "./view/view-finder";
|
|
5
5
|
import SimpleMrzRecognizer from "./service/simple-mrz-recognizer";
|
|
6
|
-
import {
|
|
6
|
+
import { MrzScannerViewConfiguration } from "./model/configuration/mrz-scanner-view-configuration";
|
|
7
7
|
export declare class MrzScannerProps extends ScanbotCameraProps {
|
|
8
8
|
mrzRecognizer: SimpleMrzRecognizer;
|
|
9
9
|
}
|
|
@@ -17,12 +17,12 @@ export default class MrzScannerView extends ScannerView<MrzScannerProps, MrzScan
|
|
|
17
17
|
private paused;
|
|
18
18
|
private _configuration?;
|
|
19
19
|
constructor(props: MrzScannerProps);
|
|
20
|
-
get configuration():
|
|
20
|
+
get configuration(): MrzScannerViewConfiguration;
|
|
21
21
|
get enabled(): boolean;
|
|
22
22
|
/**
|
|
23
23
|
* Public API functions
|
|
24
24
|
*/
|
|
25
|
-
static create(configuration:
|
|
25
|
+
static create(configuration: MrzScannerViewConfiguration, mrzRecognizer: SimpleMrzRecognizer): Promise<MrzScannerView>;
|
|
26
26
|
isDetectionPaused(): boolean;
|
|
27
27
|
resumeDetection(): Promise<void>;
|
|
28
28
|
pauseDetection(): void;
|