@microblink/blinkid-react-native 7.2.0 → 7.5.0
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/android/.gradle/8.9/checksums/checksums.lock +0 -0
- package/android/.gradle/8.9/checksums/md5-checksums.bin +0 -0
- package/android/.gradle/8.9/checksums/sha1-checksums.bin +0 -0
- package/android/.gradle/8.9/fileHashes/fileHashes.lock +0 -0
- package/android/.gradle/buildOutputCleanup/buildOutputCleanup.lock +0 -0
- package/android/.gradle/buildOutputCleanup/cache.properties +1 -1
- package/android/build.gradle +1 -1
- package/android/src/main/java/com/microblink/blinkid/reactnative/BlinkIdDeserializationUtilities.kt +2 -1
- package/android/src/main/java/com/microblink/blinkid/reactnative/BlinkIdSerializationUtilities.kt +21 -3
- package/android/src/main/java/com/microblink/blinkid/reactnative/BlinkidReactNativeModule.kt +14 -2
- package/ios/BlinkIdDeserializationUtilities.swift +3 -0
- package/ios/BlinkIdSerializationUtilities.swift +151 -53
- package/ios/BlinkidReactNativeModule.swift +22 -3
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/BlinkID +0 -0
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Headers/BlinkID-Swift.h +24563 -16979
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Info.plist +0 -0
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios.abi.json +14027 -608
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios.private.swiftinterface +462 -14
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios.swiftdoc +0 -0
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios.swiftinterface +462 -14
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/PrivateHeaders/SwiftCxxBridge.hpp +1 -0
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/_CodeSignature/CodeResources +17 -17
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64/BlinkID.framework/conan.xcconfig +3 -3
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/BlinkID +0 -0
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Headers/BlinkID-Swift.h +49697 -34548
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Info.plist +0 -0
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios-simulator.abi.json +14027 -608
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface +462 -14
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios-simulator.swiftdoc +0 -0
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/arm64-apple-ios-simulator.swiftinterface +462 -14
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/x86_64-apple-ios-simulator.abi.json +14027 -608
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface +462 -14
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/x86_64-apple-ios-simulator.swiftdoc +0 -0
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/Modules/BlinkID.swiftmodule/x86_64-apple-ios-simulator.swiftinterface +462 -14
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/PrivateHeaders/SwiftCxxBridge.hpp +1 -0
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/_CodeSignature/CodeResources +27 -27
- package/ios/Frameworks/BlinkID.xcframework/ios-arm64_x86_64-simulator/BlinkID.framework/conan.xcconfig +3 -3
- package/ios/Frameworks/BlinkIDUX.xcframework/Info.plist +5 -5
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/Assets.car +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/Info.plist +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/hr.lproj/Localizable.strings +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Info.plist +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios.abi.json +708 -193
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios.package.swiftinterface +28 -41
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios.private.swiftinterface +28 -41
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios.swiftdoc +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios.swiftinterface +28 -41
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/Assets.car +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/Info.plist +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/_CodeSignature/CodeDirectory +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/_CodeSignature/CodeRequirements-1 +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/_CodeSignature/CodeResources +6 -6
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/BlinkIDUX_BlinkIDUX.bundle/hr.lproj/Localizable.strings +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Info.plist +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios-simulator.abi.json +708 -193
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios-simulator.package.swiftinterface +28 -41
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface +28 -41
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios-simulator.swiftdoc +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/arm64-apple-ios-simulator.swiftinterface +28 -41
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/x86_64-apple-ios-simulator.abi.json +708 -193
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/x86_64-apple-ios-simulator.package.swiftinterface +28 -41
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface +28 -41
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/x86_64-apple-ios-simulator.swiftdoc +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/Modules/BlinkIDUX.swiftmodule/x86_64-apple-ios-simulator.swiftinterface +28 -41
- package/ios/Frameworks/BlinkIDUX.xcframework/ios-arm64_x86_64-simulator/BlinkIDUX.framework/_CodeSignature/CodeResources +1 -1
- package/lib/module/NativeBlinkidReactNative.js +4 -4
- package/lib/module/NativeBlinkidReactNative.js.map +1 -1
- package/lib/module/blinkIdResult.js +34 -1
- package/lib/module/blinkIdResult.js.map +1 -1
- package/lib/module/blinkIdSettings.js +272 -259
- package/lib/module/blinkIdSettings.js.map +1 -1
- package/lib/module/blinkIdUtilities.js +2 -2
- package/lib/module/index.js +19 -19
- package/lib/module/index.js.map +1 -1
- package/lib/module/types.js +30 -9
- package/lib/module/types.js.map +1 -1
- package/lib/typescript/src/NativeBlinkidReactNative.d.ts +1 -1
- package/lib/typescript/src/NativeBlinkidReactNative.d.ts.map +1 -1
- package/lib/typescript/src/blinkIdResult.d.ts +16 -1
- package/lib/typescript/src/blinkIdResult.d.ts.map +1 -1
- package/lib/typescript/src/blinkIdSettings.d.ts +193 -181
- package/lib/typescript/src/blinkIdSettings.d.ts.map +1 -1
- package/lib/typescript/src/index.d.ts +6 -6
- package/lib/typescript/src/index.d.ts.map +1 -1
- package/lib/typescript/src/types.d.ts +20 -1
- package/lib/typescript/src/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/NativeBlinkidReactNative.ts +25 -15
- package/src/blinkIdResult.ts +74 -74
- package/src/blinkIdSettings.ts +264 -250
- package/src/blinkIdUtilities.ts +4 -4
- package/src/index.tsx +56 -34
- package/src/types.ts +647 -688
- package/ios/Frameworks/BlinkIDUX.xcframework/_CodeSignature/CodeDirectory +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/_CodeSignature/CodeRequirements +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/_CodeSignature/CodeRequirements-1 +0 -0
- package/ios/Frameworks/BlinkIDUX.xcframework/_CodeSignature/CodeResources +0 -1575
- package/ios/Frameworks/BlinkIDUX.xcframework/_CodeSignature/CodeSignature +0 -0
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DetectionLevel, AnonymizationMode, ScanningMode, DocumentRules, DocumentAnonymizationSettings, RecognitionModeFilter } from
|
|
1
|
+
import { DetectionLevel, AnonymizationMode, ScanningMode, DocumentRules, DocumentAnonymizationSettings, RecognitionModeFilter } from "./types";
|
|
2
2
|
/**
|
|
3
3
|
* Settings for the initialization of the BlinkID SDK.
|
|
4
4
|
*
|
|
@@ -45,11 +45,23 @@ export declare class BlinkIdSdkSettings {
|
|
|
45
45
|
*
|
|
46
46
|
*/
|
|
47
47
|
resourceRequestTimeout?: number;
|
|
48
|
+
/**
|
|
49
|
+
* Set a custom HTTPS URL to be used as a proxy for Ping and license checks.
|
|
50
|
+
* The proxy URL will be applied only if the license has the appropriate rights.
|
|
51
|
+
*
|
|
52
|
+
* The URL must use the HTTPS protocol. Example: https://your-proxy.com/
|
|
53
|
+
*
|
|
54
|
+
* If this value is defined, SDK initialization will not be successful in the following cases:
|
|
55
|
+
* - if the URL does not use HTTPS or if the URL is invalid
|
|
56
|
+
* - if the license does not allow proxy usage
|
|
57
|
+
*
|
|
58
|
+
*/
|
|
59
|
+
microblinkProxyURL?: string;
|
|
48
60
|
/**
|
|
49
61
|
*
|
|
50
62
|
* Settings for the initialization of the BlinkID SDK.
|
|
51
63
|
*/
|
|
52
|
-
constructor(licenseKey: string, licensee?: string, downloadResources?: boolean, resourceDownloadUrl?: string, resourceLocalFolder?: string, bundleURL?: string, resourceRequestTimeout?: number);
|
|
64
|
+
constructor(licenseKey: string, licensee?: string, downloadResources?: boolean, resourceDownloadUrl?: string, resourceLocalFolder?: string, bundleURL?: string, resourceRequestTimeout?: number, microblinkProxyURL?: string);
|
|
53
65
|
}
|
|
54
66
|
/**
|
|
55
67
|
* Represents the configuration settings for a scanning session.
|
|
@@ -124,230 +136,230 @@ export declare class BlinkIdScanningSettings {
|
|
|
124
136
|
* - If blurDetectionLevel != `off` - even if blur is detected, the image will be processed and blur will be reported in the `ProcessResult`.
|
|
125
137
|
*
|
|
126
138
|
* Default: `true`
|
|
127
|
-
|
|
139
|
+
*/
|
|
128
140
|
skipImagesWithBlur: boolean;
|
|
129
141
|
/**
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
142
|
+
* The level of glare detection in the document image.
|
|
143
|
+
*
|
|
144
|
+
* Defines the severity of glare detected in the document image, as defined in [DetectionLevel].
|
|
145
|
+
* Values range from `off` (detection NotAvailable) to higher levels of glare detection.
|
|
146
|
+
* `low` – less sensitive to glare; if something is detected as glare, it is almost certainly actual glare,
|
|
147
|
+
* but some amount of glare may not be detected at all.
|
|
148
|
+
* `high` – highly sensitive to glare; it may detect as glare even something that only resembles glare.
|
|
149
|
+
*
|
|
150
|
+
* Default: {@link DetectionLevel.Mid}
|
|
151
|
+
*/
|
|
140
152
|
glareDetectionLevel: DetectionLevel;
|
|
141
153
|
/**
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
154
|
+
* Indicates whether images with glare in the document image should be skipped.
|
|
155
|
+
*
|
|
156
|
+
* A value of `true` means images with detected glare will be excluded from further processing to prevent glared images from being used
|
|
157
|
+
* - If glareDetectionLevel = `off` - glared images will be processed
|
|
158
|
+
* - If glare is detected `ProcessingStatus` will be `ImagePreprocessingFailed` and glare will be reported in the `ProcessResult`
|
|
159
|
+
* A value of `false` means images with detected glare will not be excluded from further processing
|
|
160
|
+
* - If glareDetectionLevel != `off` - even if glare is detected, the image will be processed and glare will be reported in the `ProcessResult`
|
|
161
|
+
*
|
|
162
|
+
* Default: `true`
|
|
163
|
+
*/
|
|
152
164
|
skipImagesWithGlare: boolean;
|
|
153
165
|
/**
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
166
|
+
* The level of allowed detected tilt of the document in the image.
|
|
167
|
+
*
|
|
168
|
+
* Defines the severity of allowed detected tilt of the document in the image, as defined in [DetectionLevel].
|
|
169
|
+
* Values range from `off` (detection NotAvailable) to higher levels of allowed tilt.
|
|
170
|
+
* `low` – less sensitive to tilt.
|
|
171
|
+
* `high` – highly sensitive to tilt.
|
|
172
|
+
*
|
|
173
|
+
* Default: {@link DetectionLevel.off}
|
|
162
174
|
*/
|
|
163
175
|
tiltDetectionLevel: DetectionLevel;
|
|
164
176
|
/**
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
177
|
+
* Indicates whether images with inadequate lighting conditions should be rejected.
|
|
178
|
+
*
|
|
179
|
+
* Inadequate lighting conditions are represented as either `TooBright` or `TooDark` document images,
|
|
180
|
+
* as defined in the `ImageAnalysisLightingStatus` enum.
|
|
181
|
+
* A value of `true` means images with inadequate lighting conditions will be excluded from further processing to prevent images with
|
|
182
|
+
* inadequate lighting from being used
|
|
183
|
+
* - If inadequate light conditions are detected `ProcessingStatus` will be `ImagePreprocessingFailed` and lighting status will be
|
|
184
|
+
* reported in the `ProcessResult`.
|
|
185
|
+
*
|
|
186
|
+
* Default: `true`
|
|
175
187
|
*/
|
|
176
188
|
skipImagesWithInadequateLightingConditions: boolean;
|
|
177
189
|
/**
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
190
|
+
* Indicates whether images occluded by hand should be rejected.
|
|
191
|
+
*
|
|
192
|
+
* A value of `true` means images occluded by hand will be excluded from further processing to prevent occluded images from being used
|
|
193
|
+
* - If hand occlusion is detected `ProcessingStatus` will be `ImagePreprocessingFailed` and hand occlusion status will be reported
|
|
194
|
+
* in the `ProcessResult`
|
|
195
|
+
* This setting is applicable only if `scanCroppedDocumentImage` = false.
|
|
196
|
+
*
|
|
197
|
+
* Default: `true`
|
|
198
|
+
*/
|
|
187
199
|
skipImagesOccludedByHand: boolean;
|
|
188
200
|
/**
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
201
|
+
* Indicates whether the aggregation of data from multiple images is enabled.
|
|
202
|
+
*
|
|
203
|
+
* Disabling this setting will yield higher-quality captured images, but it may slow down the scanning process due to the additional
|
|
204
|
+
* effort required to find the optimal image.
|
|
205
|
+
* Enabling this setting will simplify the extraction process, but the extracted data will be aggregated from multiple images instead
|
|
206
|
+
* of being sourced from a single image.
|
|
207
|
+
* This only applies to images from Video input image source - for images from Photo source, setting will be ignored.
|
|
208
|
+
*
|
|
209
|
+
* Default: `true`
|
|
210
|
+
*/
|
|
199
211
|
combineResultsFromMultipleInputImages: boolean;
|
|
200
212
|
/**
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
213
|
+
* Enables barcode recognition to proceed even if the initial VIZ extraction fails.
|
|
214
|
+
*
|
|
215
|
+
* If the barcode recognition is successful, recognition will still end in a valid state.
|
|
216
|
+
* This setting is applicable only to images from Photo source.
|
|
217
|
+
* For multi-side scanning, it is permitted only for the back side.
|
|
218
|
+
*
|
|
219
|
+
* Default: `false`
|
|
208
220
|
*/
|
|
209
221
|
enableBarcodeScanOnly: boolean;
|
|
210
222
|
/**
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
223
|
+
* Defines custom rules for specific document class.
|
|
224
|
+
*
|
|
225
|
+
* When defining [DocumentRules], [DocumentFilter] is optionally set to specify the document to which the rule applies, and a `fields` with
|
|
226
|
+
* the appropriate `alphabetType` should be specified as mandatory for that document.
|
|
227
|
+
* If a `fields` is set to a field that is optional for that document or does not exist on it, all fields on the document become optional.
|
|
228
|
+
* If a `fields` is set to a field with an incorrect alphabetType, all fields on the document become optional.
|
|
229
|
+
* If a `fields` is set to a field that doesn’t exist in the internal rules, that rule is ignored.
|
|
230
|
+
* When adding multiple `fields`, any field that does not match our rules is ignored. Only fields that comply with our rules are set as mandatory.
|
|
231
|
+
* If the documentFilter fields `country`, `region`, or `type` are set to `null`, all supported values for those fields will be considered.
|
|
232
|
+
* For example, if `country = null`, the rule will apply to all supported countries in BlinkID.
|
|
233
|
+
*
|
|
234
|
+
* By default, document fields are validated using internal rules that define mandatory fields for the scanned document class. This setting allows
|
|
235
|
+
* users to narrow down our internal rules on mandatory fields. All undefined fields will become optional. It is not possible to mark fields as
|
|
236
|
+
* mandatory if they cannot theoretically appear on the document.
|
|
237
|
+
* The more detailed document filter will have priority over the other.
|
|
238
|
+
*
|
|
239
|
+
* See {@link DocumentRules} for more detailed information.
|
|
240
|
+
*/
|
|
229
241
|
customDocumentRules?: DocumentRules[];
|
|
230
242
|
/**
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
243
|
+
* The mode of anonymization applied to the document.
|
|
244
|
+
*
|
|
245
|
+
* Redact specific fields based on requirements or laws regarding a specific document.
|
|
246
|
+
* Data can be redacted from the image, the result or both.
|
|
247
|
+
*
|
|
248
|
+
* Default: {@link AnonymizationMode.fullResult}
|
|
249
|
+
*/
|
|
238
250
|
anonymizationMode: AnonymizationMode;
|
|
239
251
|
/**
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
252
|
+
* Redact fields for specific document class.
|
|
253
|
+
*
|
|
254
|
+
* Fields specified by requirements or laws for a specific document will be redacted regardless of this setting.
|
|
255
|
+
* Based on anonymizationMode setting, data will be redacted from the image, the result or both.
|
|
256
|
+
*
|
|
257
|
+
* See {@link DocumentAnonymizationSettings} for more information.
|
|
258
|
+
*/
|
|
247
259
|
customDocumentAnonymizationSettings?: DocumentAnonymizationSettings[];
|
|
248
260
|
/**
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
261
|
+
* Indicates whether input images should be returned.
|
|
262
|
+
*
|
|
263
|
+
* Save the input images at the moment of the data extraction or timeout.
|
|
264
|
+
* This significantly increases memory consumption. The scanning performance is not affected.
|
|
265
|
+
*
|
|
266
|
+
* Default: `false`
|
|
267
|
+
*/
|
|
256
268
|
returnInputImages: boolean;
|
|
257
269
|
/**
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
270
|
+
* Process only cropped document images.
|
|
271
|
+
* Requires the input image to consist solely of the cropped document image with perspective correction applied.
|
|
272
|
+
* This only applies to images from Photo input image source - for images from Video input image source, setting will be ignored.
|
|
273
|
+
*
|
|
274
|
+
* Default: `false`
|
|
275
|
+
*/
|
|
264
276
|
scanCroppedDocumentImage: boolean;
|
|
265
277
|
/**
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
278
|
+
* The filter for recognition modes.
|
|
279
|
+
*
|
|
280
|
+
* Specifies which recognition modes are enabled during the scanning process, with a default value of true to enable all modes.
|
|
281
|
+
* [RecognitionModeFilter] is used to enable/disable recognition of specific document groups.
|
|
282
|
+
*
|
|
283
|
+
* This setting is experimental and it will be removed in upcoming releases.
|
|
284
|
+
*
|
|
285
|
+
* By default all modes are enabled (set to `true`).
|
|
286
|
+
*/
|
|
275
287
|
recognitionModeFilter: RecognitionModeFilter;
|
|
276
288
|
/**
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
289
|
+
* Indicates whether character validation is enabled.
|
|
290
|
+
*
|
|
291
|
+
* Allow only results containing expected characters for a given field.
|
|
292
|
+
* Each field is validated against a set of rules.
|
|
293
|
+
* All fields have to be successfully validated in order to successfully scan a document.
|
|
294
|
+
* Setting is used to improve scanning accuracy.
|
|
295
|
+
* If set to `true`, when an invalid character is detected `ProcessingStatus.InvalidCharactersFound` is returned.
|
|
296
|
+
*
|
|
297
|
+
* Default: `true`
|
|
298
|
+
*/
|
|
287
299
|
enableCharacterValidation: boolean;
|
|
288
300
|
/**
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
301
|
+
* Defines the minimum required margin (in percentage) between the edge of the input image and the document.
|
|
302
|
+
*
|
|
303
|
+
* The setting is applicable only when using images from Video source.
|
|
304
|
+
* The setting is not applicable if `scanCroppedDocumentImage = true` (it will be ignored).
|
|
305
|
+
* This setting is implemented to comply with regulations in certain countries that mandate documents
|
|
306
|
+
* to be stored with adequate margins in the image.
|
|
307
|
+
*
|
|
308
|
+
* Default: `0.02` (also recommended value)
|
|
309
|
+
*/
|
|
298
310
|
inputImageMargin: number;
|
|
299
311
|
/**
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
312
|
+
* Indicates whether backside of unsupported document should be scanned also.
|
|
313
|
+
*
|
|
314
|
+
* By default, back side of the document will not be scanned if only the front side is supported for a specific
|
|
315
|
+
* document.
|
|
316
|
+
*
|
|
317
|
+
* Default: `false`
|
|
318
|
+
*/
|
|
307
319
|
scanUnsupportedBack: boolean;
|
|
308
320
|
/**
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
321
|
+
* Indicates whether scanning can continue to the next side despite an uncertain front-side scan.
|
|
322
|
+
*
|
|
323
|
+
* This only applies to images from Photo input image source - for images from Video source, setting will be
|
|
324
|
+
* ignored.
|
|
325
|
+
*
|
|
326
|
+
* Default: `false`
|
|
327
|
+
*/
|
|
316
328
|
allowUncertainFrontSideScan: boolean;
|
|
317
329
|
/**
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
330
|
+
* The maximum allowed mismatches per field during data matching.
|
|
331
|
+
*
|
|
332
|
+
* Configures the maximum number of characters per field that can be inconsistent during data matching.
|
|
333
|
+
* By defualt, no mismatches are allowed.
|
|
334
|
+
*
|
|
335
|
+
* Default: `0`
|
|
336
|
+
*/
|
|
325
337
|
maxAllowedMismatchesPerField: number;
|
|
326
338
|
/**
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
339
|
+
* Indicates whether only the passport data page should be scanned.
|
|
340
|
+
*
|
|
341
|
+
* Scan only the data page ( page containing MRZ ) of the passport.
|
|
342
|
+
* If set to `false`, it will be required to scan the second page of certain passports.
|
|
343
|
+
*
|
|
344
|
+
* Default: `true`
|
|
345
|
+
*/
|
|
334
346
|
scanPassportDataPageOnly: boolean;
|
|
335
347
|
/**
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
348
|
+
* Configures the image processing settings during the scanning process.
|
|
349
|
+
*
|
|
350
|
+
* Allows customization of cropped image handling, such as dotsPerInch, extensions, and
|
|
351
|
+
* whether images should be returned for the document, face or signature regions.
|
|
352
|
+
*
|
|
353
|
+
* See {@link CroppedImageSettings} for more information.
|
|
354
|
+
*/
|
|
343
355
|
croppedImageSettings: CroppedImageSettings;
|
|
344
356
|
/**
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
357
|
+
* Represents the configurable settings for scanning a document.
|
|
358
|
+
*
|
|
359
|
+
* This class defines various parameters and policies related to the scanning
|
|
360
|
+
* process, including image quality handling, data extraction and anonymization,
|
|
361
|
+
* along with options for frame processing and image extraction.
|
|
362
|
+
*/
|
|
351
363
|
constructor();
|
|
352
364
|
}
|
|
353
365
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blinkIdSettings.d.ts","sourceRoot":"","sources":["../../../src/blinkIdSettings.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"blinkIdSettings.d.ts","sourceRoot":"","sources":["../../../src/blinkIdSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,aAAa,EACb,6BAA6B,EAC7B,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;gBAED,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,OAAO,EAC3B,mBAAmB,CAAC,EAAE,MAAM,EAC5B,mBAAmB,CAAC,EAAE,MAAM,EAC5B,SAAS,CAAC,EAAE,MAAM,EAClB,sBAAsB,CAAC,EAAE,MAAM,EAC/B,kBAAkB,CAAC,EAAE,MAAM;CAW9B;AAED;;;;;;GAMG;AACH,qBAAa,sBAAsB;IACjC;;;;;;;OAOG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;;OAIG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;;;;;OAOG;;CAMJ;AAED;;;;;;;MAOM;AACN,qBAAa,uBAAuB;IAClC;;;;;;;;;;;;UAYM;IACN,kBAAkB,EAAE,cAAc,CAAC;IAEnC;;;;;;;;;;OAUG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;;;;;;;;OAUG;IACH,mBAAmB,EAAE,cAAc,CAAC;IAEpC;;;;;;;;;;OAUG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;;;;;;OASG;IACH,kBAAkB,EAAE,cAAc,CAAC;IAEnC;;;;;;;;;;;OAWG;IACH,0CAA0C,EAAE,OAAO,CAAC;IAEpD;;;;;;;;;OASG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC;;;;;;;;;;OAUG;IACH,qCAAqC,EAAE,OAAO,CAAC;IAE/C;;;;;;;;OAQG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,EAAE,aAAa,EAAE,CAAC;IAEtC;;;;;;;OAOG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IAErC;;;;;;;OAOG;IACH,mCAAmC,CAAC,EAAE,6BAA6B,EAAE,CAAC;IACtE;;;;;;;OAOG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;;;;;OAMG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC;;;;;;;;;OASG;IACH,qBAAqB,EAAE,qBAAqB,CAAC;IAE7C;;;;;;;;;;OAUG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;;;OASG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;;;;;OAOG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;;;;OAOG;IACH,2BAA2B,EAAE,OAAO,CAAC;IAErC;;;;;;;OAOG;IACH,4BAA4B,EAAE,MAAM,CAAC;IAErC;;;;;;;OAOG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC;;;;;;;OAOG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;OAMG;;CAuBJ;AAED;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B;;;;;OAKG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;;;OAKG;IACH,oBAAoB,EAAE,OAAO,CAAC;;CAM/B;AAED;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;OAIG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;OAGG;;CAQJ"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import { BlinkIdScanningResult } from
|
|
2
|
-
import type { BlinkIdSdkSettings, BlinkIdSessionSettings, BlinkIdUiSettings } from
|
|
3
|
-
import type { ClassFilter } from
|
|
4
|
-
export { BlinkIdScanningSettings, BlinkIdSdkSettings, BlinkIdSessionSettings, BlinkIdUiSettings, CroppedImageSettings, } from
|
|
5
|
-
export { BlinkIdScanningResult } from
|
|
6
|
-
export * from
|
|
1
|
+
import { BlinkIdScanningResult } from "./blinkIdResult";
|
|
2
|
+
import type { BlinkIdSdkSettings, BlinkIdSessionSettings, BlinkIdUiSettings } from "./blinkIdSettings";
|
|
3
|
+
import type { ClassFilter } from "./types";
|
|
4
|
+
export { BlinkIdScanningSettings, BlinkIdSdkSettings, BlinkIdSessionSettings, BlinkIdUiSettings, CroppedImageSettings, } from "./blinkIdSettings";
|
|
5
|
+
export { BlinkIdScanningResult } from "./blinkIdResult";
|
|
6
|
+
export * from "./types";
|
|
7
7
|
/**
|
|
8
8
|
* The `performScan` method launches the BlinkID scanning process with the default UX properties.
|
|
9
9
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EACV,kBAAkB,EAClB,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAG3C,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EAClB,sBAAsB,EACtB,iBAAiB,EACjB,oBAAoB,GACrB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGxD,cAAc,SAAS,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,WAAW,CAC/B,kBAAkB,EAAE,kBAAkB,EACtC,sBAAsB,EAAE,sBAAsB,EAC9C,iBAAiB,CAAC,EAAE,iBAAiB,EACrC,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO,CAAC,qBAAqB,CAAC,CAQhC;AACD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,oBAAoB,CACxC,kBAAkB,EAAE,kBAAkB,EACtC,sBAAsB,EAAE,sBAAsB,EAC9C,UAAU,EAAE,MAAM,EAClB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,qBAAqB,CAAC,CAQhC"}
|
|
@@ -624,7 +624,7 @@ export declare class DriverLicenseDetailedInfo<T> {
|
|
|
624
624
|
*
|
|
625
625
|
* See {@link VehicleClassInfo} for more information.
|
|
626
626
|
*/
|
|
627
|
-
vehicleClassesInfo?: VehicleClassInfo<T
|
|
627
|
+
vehicleClassesInfo?: VehicleClassInfo<T>[];
|
|
628
628
|
constructor(nativeDriverLicenseDetailedInfo: any);
|
|
629
629
|
}
|
|
630
630
|
/**
|
|
@@ -985,6 +985,21 @@ export declare class VizResult {
|
|
|
985
985
|
*
|
|
986
986
|
*/
|
|
987
987
|
vehicleOwner?: StringResult;
|
|
988
|
+
/**
|
|
989
|
+
* The country code of the document owner.
|
|
990
|
+
*
|
|
991
|
+
*/
|
|
992
|
+
countryCode?: StringResult;
|
|
993
|
+
/**
|
|
994
|
+
* The certificate number of the document owner.
|
|
995
|
+
*
|
|
996
|
+
*/
|
|
997
|
+
certificateNumber?: StringResult;
|
|
998
|
+
/**
|
|
999
|
+
* The national insurance number of the document owner.
|
|
1000
|
+
*
|
|
1001
|
+
*/
|
|
1002
|
+
nationalInsuranceNumber?: StringResult;
|
|
988
1003
|
/**
|
|
989
1004
|
*
|
|
990
1005
|
* @param nativeVizResult
|
|
@@ -1275,6 +1290,10 @@ export declare class BarcodeResult {
|
|
|
1275
1290
|
* Currently this is only filled for AAMVACompliant documents.
|
|
1276
1291
|
*/
|
|
1277
1292
|
extendedElements?: BarcodeExtendedElements;
|
|
1293
|
+
/**
|
|
1294
|
+
* Indicates whether the barcode was successfully parsed.
|
|
1295
|
+
*/
|
|
1296
|
+
parsed?: boolean;
|
|
1278
1297
|
/**
|
|
1279
1298
|
*
|
|
1280
1299
|
* @param nativeBarcodeResult
|