@regulaforensics/vp-frontend-face-components 2.0.1 → 3.0.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.
Files changed (238) hide show
  1. package/README.md +362 -167
  2. package/dist/main.js +1 -1
  3. package/dist/main.js.LICENSE.txt +20 -0
  4. package/lib/index.d.ts +229 -0
  5. package/package.json +5 -83
  6. package/lib/common/BackCameraIcon.d.ts +0 -6
  7. package/lib/common/Button.d.ts +0 -7
  8. package/lib/common/CameraChangeIcon.d.ts +0 -6
  9. package/lib/common/CameraIcon.d.ts +0 -6
  10. package/lib/common/CheckIcon.d.ts +0 -6
  11. package/lib/common/CrossIcon.d.ts +0 -6
  12. package/lib/common/DocReaderCameraDisabled.d.ts +0 -5
  13. package/lib/common/DocReaderCameraPreparing.d.ts +0 -5
  14. package/lib/common/DocReaderFlip.d.ts +0 -5
  15. package/lib/common/DocReaderProcessing.d.ts +0 -5
  16. package/lib/common/DocReaderProcessingError.d.ts +0 -5
  17. package/lib/common/DocReaderProcessingFinished.d.ts +0 -6
  18. package/lib/common/DocReaderSearch.d.ts +0 -5
  19. package/lib/common/ErrorIcon.d.ts +0 -6
  20. package/lib/common/FromCameraIcon.d.ts +0 -5
  21. package/lib/common/FromGalleryIcon.d.ts +0 -5
  22. package/lib/common/FrontCameraIcon.d.ts +0 -6
  23. package/lib/common/FullscreenExitIcon.d.ts +0 -6
  24. package/lib/common/FullscreenIcon.d.ts +0 -6
  25. package/lib/common/Icon.d.ts +0 -64
  26. package/lib/common/Message.d.ts +0 -8
  27. package/lib/common/NoGlareIconLivenessDetection.d.ts +0 -5
  28. package/lib/common/NoSmilingIconLivenessDetection.d.ts +0 -5
  29. package/lib/common/PortraitOrientationOnlyIcon.d.ts +0 -6
  30. package/lib/common/RegulaLogo.d.ts +0 -6
  31. package/lib/common/RegulaLogoLivenessDetection.d.ts +0 -5
  32. package/lib/common/SnapshotIcon.d.ts +0 -6
  33. package/lib/common/Spinner.d.ts +0 -3
  34. package/lib/common/SquareIcon.d.ts +0 -6
  35. package/lib/common/StopIcon.d.ts +0 -6
  36. package/lib/common/VerifiedIcon.d.ts +0 -6
  37. package/lib/components/ButtonFaceLiveness.d.ts +0 -7
  38. package/lib/components/CameraCapture.d.ts +0 -9
  39. package/lib/components/CameraSnapshot.d.ts +0 -2
  40. package/lib/components/CameraSnapshotFileCapture.d.ts +0 -10
  41. package/lib/components/DocumentCapture.d.ts +0 -11
  42. package/lib/components/DocumentContainer.d.ts +0 -11
  43. package/lib/components/DocumentReader.d.ts +0 -2
  44. package/lib/components/DocumentReaderFileCapture.d.ts +0 -12
  45. package/lib/components/DocumentReaderLayout.d.ts +0 -22
  46. package/lib/components/DocumentReaderStartScreen.d.ts +0 -10
  47. package/lib/components/ErrorBoundary.d.ts +0 -18
  48. package/lib/components/FaceCapture.d.ts +0 -25
  49. package/lib/components/FaceDetection.d.ts +0 -2
  50. package/lib/components/FaceFullScreenOverlay.d.ts +0 -10
  51. package/lib/components/FaceHintAnimaition.d.ts +0 -16
  52. package/lib/components/FaceLayout.d.ts +0 -23
  53. package/lib/components/FaceLiveness.d.ts +0 -2
  54. package/lib/components/InfoScreen.d.ts +0 -11
  55. package/lib/components/InfoScreenFaceLiveness.d.ts +0 -12
  56. package/lib/components/InstructionVideoScreen.d.ts +0 -9
  57. package/lib/components/ProcessScreen.d.ts +0 -6
  58. package/lib/components/ProcessScreenFaceLiveness.d.ts +0 -6
  59. package/lib/components/RetryScreenFaceLiveness.d.ts +0 -7
  60. package/lib/components/SectorAnimationSvg.d.ts +0 -11
  61. package/lib/components/WebCamera.d.ts +0 -19
  62. package/lib/constants.d.ts +0 -668
  63. package/lib/contexts/DocumentAttributesContext.d.ts +0 -25
  64. package/lib/contexts/DocumentSDKContext.d.ts +0 -8
  65. package/lib/contexts/FaceAttributesContext.d.ts +0 -26
  66. package/lib/hoc/withDocumentAttributesContext.d.ts +0 -4
  67. package/lib/hoc/withDocumentSDKContext.d.ts +0 -3
  68. package/lib/hoc/withFaceAttributesContext.d.ts +0 -4
  69. package/lib/hoc/withLocalize.d.ts +0 -8
  70. package/lib/hooks/useDocumentReaderSeries.d.ts +0 -19
  71. package/lib/hooks/useDocumentReaderSingle.d.ts +0 -14
  72. package/lib/hooks/useFaceLiveness.d.ts +0 -41
  73. package/lib/hooks/useImageInputParam.d.ts +0 -7
  74. package/lib/hooks/useOrientationChange.d.ts +0 -10
  75. package/lib/hooks/useStateCallback.d.ts +0 -1
  76. package/lib/hooks/useStream.d.ts +0 -10
  77. package/lib/hooks/useUserAgent.d.ts +0 -3
  78. package/lib/hooks/useWindowBlur.d.ts +0 -2
  79. package/lib/i18n/dictionaries/_dictionaries.d.ts +0 -2275
  80. package/lib/index-document.d.ts +0 -4
  81. package/lib/index-face.d.ts +0 -1
  82. package/lib/media-resources/resourcesBase64.d.ts +0 -7
  83. package/lib/models/CameraModel.d.ts +0 -9
  84. package/lib/models/CustomError.d.ts +0 -7
  85. package/lib/models/DocReaderWebclient/ext/authenticity/authenticity.d.ts +0 -32
  86. package/lib/models/DocReaderWebclient/ext/authenticity/fiber.d.ts +0 -7
  87. package/lib/models/DocReaderWebclient/ext/authenticity/ident.d.ts +0 -8
  88. package/lib/models/DocReaderWebclient/ext/authenticity/image-ident.d.ts +0 -7
  89. package/lib/models/DocReaderWebclient/ext/authenticity/index.d.ts +0 -5
  90. package/lib/models/DocReaderWebclient/ext/authenticity/ocr-security-text.d.ts +0 -7
  91. package/lib/models/DocReaderWebclient/ext/authenticity/security-feature.d.ts +0 -8
  92. package/lib/models/DocReaderWebclient/ext/images.d.ts +0 -16
  93. package/lib/models/DocReaderWebclient/ext/index.d.ts +0 -6
  94. package/lib/models/DocReaderWebclient/ext/process-request-image.d.ts +0 -5
  95. package/lib/models/DocReaderWebclient/ext/process-request.d.ts +0 -38
  96. package/lib/models/DocReaderWebclient/ext/process-response.d.ts +0 -36
  97. package/lib/models/DocReaderWebclient/ext/text-field.d.ts +0 -40
  98. package/lib/models/DocReaderWebclient/ext/text.d.ts +0 -14
  99. package/lib/models/DocReaderWebclient/models/area-array.d.ts +0 -32
  100. package/lib/models/DocReaderWebclient/models/area-container.d.ts +0 -38
  101. package/lib/models/DocReaderWebclient/models/authenticity-check-list.d.ts +0 -31
  102. package/lib/models/DocReaderWebclient/models/authenticity-check-result-item.d.ts +0 -38
  103. package/lib/models/DocReaderWebclient/models/authenticity-check-result.d.ts +0 -43
  104. package/lib/models/DocReaderWebclient/models/authenticity-result-all-of.d.ts +0 -25
  105. package/lib/models/DocReaderWebclient/models/authenticity-result-type.d.ts +0 -33
  106. package/lib/models/DocReaderWebclient/models/authenticity-result.d.ts +0 -18
  107. package/lib/models/DocReaderWebclient/models/bc-pdf417-info.d.ts +0 -54
  108. package/lib/models/DocReaderWebclient/models/bc-roidetect.d.ts +0 -42
  109. package/lib/models/DocReaderWebclient/models/check-diagnose.d.ts +0 -98
  110. package/lib/models/DocReaderWebclient/models/check-result.d.ts +0 -30
  111. package/lib/models/DocReaderWebclient/models/chosen-document-type-result-all-of.d.ts +0 -25
  112. package/lib/models/DocReaderWebclient/models/chosen-document-type-result.d.ts +0 -19
  113. package/lib/models/DocReaderWebclient/models/chosen-document-type.d.ts +0 -74
  114. package/lib/models/DocReaderWebclient/models/container-list.d.ts +0 -45
  115. package/lib/models/DocReaderWebclient/models/critical.d.ts +0 -26
  116. package/lib/models/DocReaderWebclient/models/cross-source-value-comparison.d.ts +0 -38
  117. package/lib/models/DocReaderWebclient/models/data-module.d.ts +0 -48
  118. package/lib/models/DocReaderWebclient/models/details-optical.d.ts +0 -67
  119. package/lib/models/DocReaderWebclient/models/details-rfid.d.ts +0 -61
  120. package/lib/models/DocReaderWebclient/models/device-info.d.ts +0 -54
  121. package/lib/models/DocReaderWebclient/models/doc-bar-code-info-all-of.d.ts +0 -31
  122. package/lib/models/DocReaderWebclient/models/doc-bar-code-info.d.ts +0 -19
  123. package/lib/models/DocReaderWebclient/models/doc-visual-extended-field.d.ts +0 -70
  124. package/lib/models/DocReaderWebclient/models/doc-visual-extended-info.d.ts +0 -25
  125. package/lib/models/DocReaderWebclient/models/document-format.d.ts +0 -70
  126. package/lib/models/DocReaderWebclient/models/document-image-result-all-of.d.ts +0 -25
  127. package/lib/models/DocReaderWebclient/models/document-image-result.d.ts +0 -18
  128. package/lib/models/DocReaderWebclient/models/document-image.d.ts +0 -24
  129. package/lib/models/DocReaderWebclient/models/document-position-result-all-of.d.ts +0 -25
  130. package/lib/models/DocReaderWebclient/models/document-position-result.d.ts +0 -19
  131. package/lib/models/DocReaderWebclient/models/document-position.d.ts +0 -80
  132. package/lib/models/DocReaderWebclient/models/document-type-recognition-result.d.ts +0 -30
  133. package/lib/models/DocReaderWebclient/models/document-type.d.ts +0 -246
  134. package/lib/models/DocReaderWebclient/models/document-types-candidates-list.d.ts +0 -32
  135. package/lib/models/DocReaderWebclient/models/document-types-candidates-result-all-of.d.ts +0 -25
  136. package/lib/models/DocReaderWebclient/models/document-types-candidates-result.d.ts +0 -18
  137. package/lib/models/DocReaderWebclient/models/document-types-candidates.d.ts +0 -32
  138. package/lib/models/DocReaderWebclient/models/encrypted-rclresult-all-of.d.ts +0 -24
  139. package/lib/models/DocReaderWebclient/models/encrypted-rclresult.d.ts +0 -18
  140. package/lib/models/DocReaderWebclient/models/fdsidlist.d.ts +0 -80
  141. package/lib/models/DocReaderWebclient/models/fiber-result-all-of.d.ts +0 -74
  142. package/lib/models/DocReaderWebclient/models/fiber-result.d.ts +0 -18
  143. package/lib/models/DocReaderWebclient/models/graphic-field-type.d.ts +0 -118
  144. package/lib/models/DocReaderWebclient/models/graphic-field.d.ts +0 -63
  145. package/lib/models/DocReaderWebclient/models/graphic-fields-list.d.ts +0 -25
  146. package/lib/models/DocReaderWebclient/models/graphics-result-all-of.d.ts +0 -25
  147. package/lib/models/DocReaderWebclient/models/graphics-result.d.ts +0 -19
  148. package/lib/models/DocReaderWebclient/models/ident-result-all-of.d.ts +0 -65
  149. package/lib/models/DocReaderWebclient/models/ident-result.d.ts +0 -18
  150. package/lib/models/DocReaderWebclient/models/image-data.d.ts +0 -24
  151. package/lib/models/DocReaderWebclient/models/image-qa.d.ts +0 -54
  152. package/lib/models/DocReaderWebclient/models/image-quality-check-list.d.ts +0 -32
  153. package/lib/models/DocReaderWebclient/models/image-quality-check-type.d.ts +0 -50
  154. package/lib/models/DocReaderWebclient/models/image-quality-check.d.ts +0 -64
  155. package/lib/models/DocReaderWebclient/models/image-quality-result-all-of.d.ts +0 -25
  156. package/lib/models/DocReaderWebclient/models/image-quality-result.d.ts +0 -18
  157. package/lib/models/DocReaderWebclient/models/images-available-source.d.ts +0 -31
  158. package/lib/models/DocReaderWebclient/models/images-field-value.d.ts +0 -70
  159. package/lib/models/DocReaderWebclient/models/images-field.d.ts +0 -38
  160. package/lib/models/DocReaderWebclient/models/images-result-all-of.d.ts +0 -25
  161. package/lib/models/DocReaderWebclient/models/images-result.d.ts +0 -18
  162. package/lib/models/DocReaderWebclient/models/images.d.ts +0 -32
  163. package/lib/models/DocReaderWebclient/models/index.d.ts +0 -123
  164. package/lib/models/DocReaderWebclient/models/lcid.d.ts +0 -582
  165. package/lib/models/DocReaderWebclient/models/lexical-analysis-result-all-of.d.ts +0 -25
  166. package/lib/models/DocReaderWebclient/models/lexical-analysis-result.d.ts +0 -19
  167. package/lib/models/DocReaderWebclient/models/license-result-all-of.d.ts +0 -24
  168. package/lib/models/DocReaderWebclient/models/license-result.d.ts +0 -18
  169. package/lib/models/DocReaderWebclient/models/light.d.ts +0 -34
  170. package/lib/models/DocReaderWebclient/models/list-verified-fields.d.ts +0 -25
  171. package/lib/models/DocReaderWebclient/models/log-level.d.ts +0 -23
  172. package/lib/models/DocReaderWebclient/models/measure-system.d.ts +0 -26
  173. package/lib/models/DocReaderWebclient/models/mrzformat.d.ts +0 -24
  174. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result-all-of.d.ts +0 -81
  175. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result.d.ts +0 -18
  176. package/lib/models/DocReaderWebclient/models/one-candidate.d.ts +0 -74
  177. package/lib/models/DocReaderWebclient/models/original-symbol.d.ts +0 -37
  178. package/lib/models/DocReaderWebclient/models/parray-field.d.ts +0 -81
  179. package/lib/models/DocReaderWebclient/models/per-document-config.d.ts +0 -30
  180. package/lib/models/DocReaderWebclient/models/photo-ident-result-all-of.d.ts +0 -76
  181. package/lib/models/DocReaderWebclient/models/photo-ident-result.d.ts +0 -18
  182. package/lib/models/DocReaderWebclient/models/point-array.d.ts +0 -25
  183. package/lib/models/DocReaderWebclient/models/point.d.ts +0 -30
  184. package/lib/models/DocReaderWebclient/models/points-container.d.ts +0 -31
  185. package/lib/models/DocReaderWebclient/models/process-params.d.ts +0 -254
  186. package/lib/models/DocReaderWebclient/models/process-request-image.d.ts +0 -38
  187. package/lib/models/DocReaderWebclient/models/process-request.d.ts +0 -60
  188. package/lib/models/DocReaderWebclient/models/process-response.d.ts +0 -66
  189. package/lib/models/DocReaderWebclient/models/process-system-info.d.ts +0 -30
  190. package/lib/models/DocReaderWebclient/models/processing-status.d.ts +0 -30
  191. package/lib/models/DocReaderWebclient/models/raw-image-container-list.d.ts +0 -31
  192. package/lib/models/DocReaderWebclient/models/rectangle-coordinates.d.ts +0 -42
  193. package/lib/models/DocReaderWebclient/models/result-item.d.ts +0 -48
  194. package/lib/models/DocReaderWebclient/models/result.d.ts +0 -98
  195. package/lib/models/DocReaderWebclient/models/rfid-location.d.ts +0 -30
  196. package/lib/models/DocReaderWebclient/models/rfid-origin.d.ts +0 -42
  197. package/lib/models/DocReaderWebclient/models/scenario.d.ts +0 -36
  198. package/lib/models/DocReaderWebclient/models/security-feature-result-all-of.d.ts +0 -59
  199. package/lib/models/DocReaderWebclient/models/security-feature-result.d.ts +0 -18
  200. package/lib/models/DocReaderWebclient/models/security-feature-type.d.ts +0 -49
  201. package/lib/models/DocReaderWebclient/models/source-validity.d.ts +0 -32
  202. package/lib/models/DocReaderWebclient/models/source.d.ts +0 -23
  203. package/lib/models/DocReaderWebclient/models/status-result-all-of.d.ts +0 -25
  204. package/lib/models/DocReaderWebclient/models/status-result.d.ts +0 -18
  205. package/lib/models/DocReaderWebclient/models/status.d.ts +0 -63
  206. package/lib/models/DocReaderWebclient/models/string-recognition-result.d.ts +0 -25
  207. package/lib/models/DocReaderWebclient/models/symbol-candidate.d.ts +0 -30
  208. package/lib/models/DocReaderWebclient/models/symbol-recognition-result.d.ts +0 -32
  209. package/lib/models/DocReaderWebclient/models/text-available-source.d.ts +0 -38
  210. package/lib/models/DocReaderWebclient/models/text-data-result-all-of.d.ts +0 -25
  211. package/lib/models/DocReaderWebclient/models/text-data-result.d.ts +0 -19
  212. package/lib/models/DocReaderWebclient/models/text-field-type.d.ts +0 -2386
  213. package/lib/models/DocReaderWebclient/models/text-field-value.d.ts +0 -70
  214. package/lib/models/DocReaderWebclient/models/text-field.d.ts +0 -84
  215. package/lib/models/DocReaderWebclient/models/text-post-processing.d.ts +0 -22
  216. package/lib/models/DocReaderWebclient/models/text-result-all-of.d.ts +0 -25
  217. package/lib/models/DocReaderWebclient/models/text-result.d.ts +0 -18
  218. package/lib/models/DocReaderWebclient/models/text.d.ts +0 -51
  219. package/lib/models/DocReaderWebclient/models/transaction-info.d.ts +0 -42
  220. package/lib/models/DocReaderWebclient/models/verification-result.d.ts +0 -38
  221. package/lib/models/DocReaderWebclient/models/verified-field-map.d.ts +0 -63
  222. package/lib/models/DocReaderWebclient/models/visibility.d.ts +0 -23
  223. package/lib/models/ImageModel.d.ts +0 -7
  224. package/lib/services/DebugService.d.ts +0 -17
  225. package/lib/services/DeviceOrientationService.d.ts +0 -18
  226. package/lib/services/DocumentReaderProcessor.d.ts +0 -43
  227. package/lib/services/DocumentReaderService.d.ts +0 -37
  228. package/lib/services/EventEmitter.d.ts +0 -9
  229. package/lib/services/FaceLivenessService.d.ts +0 -70
  230. package/lib/services/FaceService.d.ts +0 -39
  231. package/lib/services/StreamRecorderService.d.ts +0 -24
  232. package/lib/types.d.ts +0 -361
  233. package/lib/utils.d.ts +0 -30
  234. package/lib/web-components/CameraSnapshot.d.ts +0 -14
  235. package/lib/web-components/DocumentReader.d.ts +0 -14
  236. package/lib/web-components/FaceDetection.d.ts +0 -11
  237. package/lib/web-components/FaceLiveness.d.ts +0 -17
  238. package/lib/web-components/FullScreenContainer.d.ts +0 -4
@@ -1,668 +0,0 @@
1
- export declare enum FaceMessage {
2
- Empty = 0,
3
- FitFaceIntoOval = 1,
4
- LookStraight = 2,
5
- MoveCloser = 3,
6
- MoveAway = 4,
7
- HoldStill = 5,
8
- ShowOnlyOneFace = 6,
9
- TurnHead = 7
10
- }
11
- export declare enum FaceProcessingStage {
12
- Far = 0,
13
- Near = 1
14
- }
15
- export declare enum FaceStatus {
16
- Finished = 0,
17
- InProcess = 1,
18
- Timeout = 2,
19
- Failed = 3,
20
- Stop_Session = 4
21
- }
22
- export declare enum ImageOutputType {
23
- UINT = "UINT",
24
- BASE64 = "BASE64",
25
- UINT_AND_BASE64 = "UINT_AND_BASE64"
26
- }
27
- export declare enum FaceEventActions {
28
- ELEMENT_VISIBLE = "ELEMENT_VISIBLE",
29
- PRESS_START_BUTTON = "PRESS_START_BUTTON",
30
- PRESS_RETRY_BUTTON = "PRESS_RETRY_BUTTON",
31
- CLOSE = "CLOSE",
32
- PROCESS_FINISHED = "PROCESS_FINISHED",
33
- SERVICE_INITIALIZED = "SERVICE_INITIALIZED"
34
- }
35
- export declare enum DocumentEventActions {
36
- ELEMENT_VISIBLE = "ELEMENT_VISIBLE",
37
- PRESS_CAMERA_BUTTON = "PRESS_CAMERA_BUTTON",
38
- PRESS_FILE_BUTTON = "PRESS_FILE_BUTTON",
39
- PRESS_RETRY_BUTTON = "PRESS_RETRY_BUTTON",
40
- PRESS_SKIP_BUTTON = "PRESS_SKIP_BUTTON",
41
- CLOSE = "CLOSE",
42
- CAMERA_PROCESS_CLOSED = "CAMERA_PROCESS_CLOSED",
43
- CAMERA_PROCESS_STARTED = "CAMERA_PROCESS_STARTED",
44
- FILE_PROCESS_STARTED = "FILE_PROCESS_STARTED",
45
- PROCESS_FINISHED = "PROCESS_FINISHED",
46
- SERVICE_INITIALIZED = "SERVICE_INITIALIZED"
47
- }
48
- export declare enum DocumentCaptureStatus {
49
- FINDING = "DocumentCaptureStatus.FINDING",
50
- PROCESSING = "DocumentCaptureStatus.PROCESSING",
51
- SUCCESS = "DocumentCaptureStatus.SUCCESS",
52
- FAILED = "DocumentCaptureStatus.FAILED",
53
- RESOLUTION = "DocumentCaptureStatus.RESOLUTION",
54
- GLARE = "DocumentCaptureStatus.GLARE",
55
- FOCUS = "DocumentCaptureStatus.FOCUS",
56
- HOLD = "DocumentCaptureStatus.HOLD",
57
- START_DETECTION = "DocumentCaptureStatus.START_DETECTION",
58
- START_NEXT_PAGE = "DocumentCaptureStatus.START_NEXT_PAGE",
59
- SNAPSHOT = "DocumentCaptureStatus.SNAPSHOT",
60
- TIMEOUT = "DocumentCaptureStatus.TIMEOUT"
61
- }
62
- export declare enum ImageQualityCheckType {
63
- IMAGE_GLARES = 0,
64
- IMAGE_FOCUS = 1,
65
- IMAGE_RESOLUTION = 2,
66
- IMAGE_COLORNESS = 3,
67
- PERSPECTIVE = 4,
68
- BOUNDS = 5,
69
- SCREEN_CAPTURE = 6,
70
- PORTRAIT = 7,
71
- HANDWRITTEN = 8
72
- }
73
- export declare enum ResponseCode {
74
- EMPTY = -1,
75
- ERROR = 0,
76
- OK = 1
77
- }
78
- export declare enum CheckResult {
79
- ERROR = 0,
80
- OK = 1,
81
- WAS_NOT_DONE = 2
82
- }
83
- export declare enum StreamStatus {
84
- PREPARING = "StreamStatus.PREPARING",
85
- REQUESTING = "StreamStatus.REQUESTING",
86
- READY = "StreamStatus.READY",
87
- PLAY = "StreamStatus.PLAY",
88
- UNKNOWN_ERROR = "StreamStatus.UNKNOWN_ERROR",
89
- PERMISSION_DENIED = "StreamStatus.PERMISSION_DENIED",
90
- NO_CAMERA = "StreamStatus.NO_CAMERA",
91
- INCORRECT_CAMERA_ID = "StreamStatus.INCORRECT_CAMERA_ID"
92
- }
93
- export declare enum FaceAbortSessionStatus {
94
- CHANGE_CAMERA = "FaceAbortSessionStatus.CHANGE_CAMERA",
95
- DEVICE_ROTATE = "FaceAbortSessionStatus.DEVICE_ROTATE",
96
- SESSION_TIMEOUT = "FaceAbortSessionStatus.TIMEOUT",
97
- CLOSE_BUTTON = "FaceAbortSessionStatus.CLOSE_BUTTON",
98
- UNKNOWN = "FaceAbortSessionStatus.UNKNOWN"
99
- }
100
- export declare enum FaceCompletionStatus {
101
- RESTART = "FaceCompletionStatus.RESTART",
102
- ABORT_PROCESSING = "FaceCompletionStatus.ABORT_PROCESSING",
103
- INSTRUCTION = "FaceCompletionStatus.INSTRUCTION",
104
- SUCCESS = "FaceCompletionStatus.SUCCESS",
105
- FAILED = "FaceCompletionStatus.FAILED",
106
- CAPTURING = "FaceCompletionStatus.CAPTURING",
107
- PROCESSING_REQUEST = "FaceCompletionStatus.PROCESSING_REQUEST",
108
- WASM_DEFAULT_ERROR = "FaceCompletionStatus.WASM_DEFAULT_ERROR",
109
- NOT_SUPPORTED_ERROR = "FaceCompletionStatus.NOT_SUPPORTED_ERROR",
110
- WASM_LICENSE_ERROR = "FaceCompletionStatus.WASM_LICENSE_ERROR",
111
- UNKNOWN_ERROR = "FaceCompletionStatus.UNKNOWN_ERROR",
112
- NO_CAMERA_ERROR = "FaceCompletionStatus.NO_CAMERA_ERROR",
113
- PERMISSION_DENIED_ERROR = "FaceCompletionStatus.PERMISSION_DENIED_ERROR",
114
- INCORRECT_CAMERA_ID_ERROR = "FaceCompletionStatus.INCORRECT_CAMERA_ID_ERROR"
115
- }
116
- export declare enum DocumentCompletionStatus {
117
- CHOOSE_INPUT_SOURCE = "DocumentCompletionStatus.CHOOSE_INPUT_SOURCE",
118
- CAMERA_PROCESSING = "DocumentCompletionStatus.CAMERA_PROCESSING",
119
- FILE_PROCESSING = "DocumentCompletionStatus.FILE_PROCESSING",
120
- API_PROCESSING = "DocumentCompletionStatus.API_PROCESSING",
121
- SUCCESS = "DocumentCompletionStatus.SUCCESS",
122
- FAILED = "DocumentCompletionStatus.FAILED",
123
- FILE_SIZE_ERROR = "DocumentCompletionStatus.FILE_SIZE_ERROR",
124
- WASM_DEFAULT_ERROR = "DocumentCompletionStatus.WASM_DEFAULT_ERROR",
125
- NOT_SUPPORTED_ERROR = "DocumentCompletionStatus.NOT_SUPPORTED_ERROR",
126
- WASM_LICENSE_ERROR = "DocumentCompletionStatus.WASM_LICENSE_ERROR",
127
- INCORRECT_FILE_ERROR = "DocumentCompletionStatus.INCORRECT_FILE_ERROR",
128
- UNKNOWN_ERROR = "DocumentCompletionStatus.UNKNOWN_ERROR",
129
- TIMEOUT = "DocumentCompletionStatus.TIMEOUT"
130
- }
131
- export declare enum CameraFacingMode {
132
- user = "user",
133
- environment = "environment"
134
- }
135
- export declare enum ProcessingStatus {
136
- NOT_FINISHED = 0,
137
- FINISHED = 1,
138
- TIMEOUT = 2
139
- }
140
- export declare enum ObjectFit {
141
- contain = "contain",
142
- cover = "cover"
143
- }
144
- export declare enum InternalScenarios {
145
- MrzAndLocate = "MrzAndLocate",
146
- MrzOrLocate = "MrzOrLocate",
147
- Mrz = "Mrz",
148
- Locate = "Locate"
149
- }
150
- export declare enum ErrorTypes {
151
- WASM_ERROR = "WASM_ERROR",
152
- WASM_LICENSE = "WASM_LICENSE",
153
- FILE_SIZE = "FILE_SIZE",
154
- INCORRECT_FILE = "INCORRECT_FILE",
155
- UNKNOWN_ERROR = "UNKNOWN_ERROR",
156
- NOT_SUPPORTED = "NOT_SUPPORTED",
157
- CAMERA_UNKNOWN_ERROR = "CAMERA_UNKNOWN_ERROR",
158
- CAMERA_PERMISSION_DENIED = "CAMERA_PERMISSION_DENIED",
159
- NO_CAMERA = "NO_CAMERA",
160
- INCORRECT_CAMERA_ID = "INCORRECT_CAMERA_ID",
161
- CONNECTION_ERROR = "CONNECTION_ERROR",
162
- LANDSCAPE_MODE_RESTRICTED = "LANDSCAPE_MODE_RESTRICTED",
163
- NOT_PREPARED = "NOT_PREPARED",
164
- NOT_INITIALIZED = "NOT_INITIALIZED",
165
- IN_PROCESS = "IN_PROCESS",
166
- ALREADY_PREPARED = "ALREADY_PREPARED",
167
- ALREADY_INITIALIZED = "ALREADY_INITIALIZED"
168
- }
169
- export declare enum Method {
170
- prepare = 12000,
171
- initialize = 12100,
172
- process = 12101,
173
- processImage = 12104,
174
- startNewPage = 12106,
175
- startNewDocument = 12105
176
- }
177
- export declare enum MediaElementReadyState {
178
- HAVE_NOTHING = 0,
179
- HAVE_METADATA = 1,
180
- HAVE_CURRENT_DATA = 2,
181
- HAVE_FUTURE_DATA = 3,
182
- HAVE_ENOUGH_DATA = 4
183
- }
184
- export declare enum Target {
185
- stdout = "stdout",
186
- stderr = "stderr",
187
- custom = "custom",
188
- gl = "gl",
189
- init = "worker-init"
190
- }
191
- export declare enum logLevels {
192
- OFF = 0,
193
- LOG = 1,
194
- INFO = 2,
195
- WARN = 3,
196
- ERROR = 4
197
- }
198
- export declare enum DirectionType {
199
- Rtl = "rtl",
200
- Ltr = "ltr"
201
- }
202
- export declare const FACE_LIVENESS_EVENT = "face-liveness";
203
- export declare const FACE_CAPTURE_EVENT = "face-capture";
204
- export declare const DOCUMENT_READER_EVENT = "document-reader";
205
- export declare const CAMERA_SNAPSHOT_EVENT = "camera-snapshot";
206
- export declare const PERCENT_FRAME_OFFSET = 10;
207
- export declare const FLIP_TIMEOUT = 3000;
208
- export declare const FRAME_STROKE_WIDTH_LIVENESS_DETECTION = 3;
209
- export declare const RESULT_TIMEOUT_MS = 2000;
210
- export declare const NEW_INDEX = 1;
211
- export declare const MAX_FILES_SIZE = 25000000;
212
- export declare const RESIZE_VALUE = 1920;
213
- export declare const MAX_BROWSER_SUPPORTED_RESOLUTION = 536870912;
214
- export declare const PERMISSION_DENIED_ERROR_NAME = "NotAllowedError";
215
- export declare const FACE_BACKEND_URL = "https://faceapi.regulaforensics.com";
216
- export declare const DEFAULT_COMPONENT_LANGUAGE = "en";
217
- export declare const RTL_LANGUAGES: string[];
218
- export declare const DEFAULT_CAMERA_ID = 0;
219
- export declare const OVAL_TRANSITION_TIME = 200;
220
- export declare const CAMERAS_COUNT = 1;
221
- export declare const FIREFOX_SWITCH_CAMERA_DELAY = 500;
222
- export declare const CameraResolution: {
223
- VGA: {
224
- width: number;
225
- height: number;
226
- };
227
- HD: {
228
- width: number;
229
- height: number;
230
- };
231
- FULL_HD: {
232
- width: number;
233
- height: number;
234
- };
235
- SQUARE: {
236
- width: number;
237
- height: number;
238
- };
239
- };
240
- export declare const BackCameraKeywords: string[];
241
- export declare const FaceErrorCodes: {
242
- 199: {
243
- name: string;
244
- type: number;
245
- };
246
- 201: {
247
- name: string;
248
- type: number;
249
- };
250
- 202: {
251
- name: string;
252
- type: number;
253
- };
254
- 203: {
255
- name: string;
256
- type: number;
257
- };
258
- 224: {
259
- name: string;
260
- type: number;
261
- };
262
- 227: {
263
- name: string;
264
- type: number;
265
- };
266
- 228: {
267
- name: string;
268
- type: number;
269
- };
270
- 229: {
271
- name: string;
272
- type: number;
273
- };
274
- 230: {
275
- name: string;
276
- type: number;
277
- };
278
- 231: {
279
- name: string;
280
- type: number;
281
- };
282
- 232: {
283
- name: string;
284
- type: number;
285
- };
286
- 233: {
287
- name: string;
288
- type: number;
289
- };
290
- 234: {
291
- name: string;
292
- type: number;
293
- };
294
- 235: {
295
- name: string;
296
- type: number;
297
- };
298
- 236: {
299
- name: string;
300
- type: number;
301
- };
302
- 237: {
303
- name: string;
304
- type: number;
305
- };
306
- 238: {
307
- name: string;
308
- type: number;
309
- };
310
- 239: {
311
- name: string;
312
- type: number;
313
- };
314
- 240: {
315
- name: string;
316
- type: number;
317
- };
318
- 242: {
319
- name: string;
320
- type: number;
321
- };
322
- 243: {
323
- name: string;
324
- type: number;
325
- };
326
- 244: {
327
- name: string;
328
- type: number;
329
- };
330
- 245: {
331
- name: string;
332
- type: number;
333
- };
334
- 246: {
335
- name: string;
336
- type: number;
337
- };
338
- 247: {
339
- name: string;
340
- type: number;
341
- };
342
- 248: {
343
- name: string;
344
- type: number;
345
- };
346
- 249: {
347
- name: string;
348
- type: number;
349
- };
350
- };
351
- export declare const FACER_NO_LICENSE = 200;
352
- export declare const WebComponentErrorByStreamStatus: {
353
- "StreamStatus.UNKNOWN_ERROR": ErrorTypes;
354
- "StreamStatus.PERMISSION_DENIED": ErrorTypes;
355
- "StreamStatus.NO_CAMERA": ErrorTypes;
356
- "StreamStatus.INCORRECT_CAMERA_ID": ErrorTypes;
357
- };
358
- export declare const DocumentReaderStatusByError: {
359
- FILE_SIZE: DocumentCompletionStatus;
360
- WASM_ERROR: DocumentCompletionStatus;
361
- NOT_SUPPORTED: DocumentCompletionStatus;
362
- WASM_LICENSE: DocumentCompletionStatus;
363
- INCORRECT_FILE: DocumentCompletionStatus;
364
- };
365
- export declare const DocumentReaderFinishStatusByCaptureStatus: {
366
- "DocumentCaptureStatus.SUCCESS": DocumentCompletionStatus;
367
- "DocumentCaptureStatus.TIMEOUT": DocumentCompletionStatus;
368
- "DocumentCaptureStatus.FAILED": DocumentCompletionStatus;
369
- };
370
- export declare const FaceLivenessStatusByError: {
371
- WASM_ERROR: FaceCompletionStatus;
372
- NOT_SUPPORTED: FaceCompletionStatus;
373
- WASM_LICENSE: FaceCompletionStatus;
374
- };
375
- export declare const DocumentSupportedBrowsers: {
376
- iOS: {
377
- Chrome: number;
378
- Firefox: number;
379
- Opera: number;
380
- Safari: number;
381
- Edge: number;
382
- Chromium: number;
383
- IE: number;
384
- 'Internet Explorer': number;
385
- 'Mobile Safari': number;
386
- 'Samsung Browser': number;
387
- };
388
- Android: {
389
- Chrome: number;
390
- Firefox: number;
391
- Opera: number;
392
- Safari: number;
393
- Edge: number;
394
- Chromium: number;
395
- IE: number;
396
- 'Internet Explorer': number;
397
- 'Mobile Safari': number;
398
- 'Samsung Browser': number;
399
- };
400
- desktop: {
401
- Chrome: number;
402
- Firefox: number;
403
- Opera: number;
404
- Safari: number;
405
- Edge: number;
406
- Chromium: number;
407
- IE: number;
408
- 'Internet Explorer': number;
409
- 'Mobile Safari': number;
410
- 'Samsung Browser': number;
411
- };
412
- };
413
- export declare const FaceSupportedBrowsers: {
414
- iOS: {
415
- Chrome: number;
416
- Firefox: number;
417
- Opera: number;
418
- Safari: number;
419
- Edge: number;
420
- Chromium: number;
421
- IE: number;
422
- 'Internet Explorer': number;
423
- 'Mobile Safari': number;
424
- 'Samsung Browser': number;
425
- };
426
- Android: {
427
- Chrome: number;
428
- Firefox: number;
429
- Opera: number;
430
- Safari: number;
431
- Edge: number;
432
- Chromium: number;
433
- IE: number;
434
- 'Internet Explorer': number;
435
- 'Mobile Safari': number;
436
- 'Samsung Browser': number;
437
- };
438
- desktop: {
439
- Chrome: number;
440
- Firefox: number;
441
- Opera: number;
442
- Safari: number;
443
- Edge: number;
444
- Chromium: number;
445
- IE: number;
446
- 'Internet Explorer': number;
447
- 'Mobile Safari': number;
448
- 'Samsung Browser': number;
449
- };
450
- };
451
- export declare const DocumentScenarioFrameParams: {
452
- scenario: ({
453
- caption: string;
454
- desc: string;
455
- frameKWHDoublePageSpreadLandscape: string;
456
- frameKWHDoublePageSpreadPortrait: string;
457
- frameKWHLandscape: string;
458
- frameKWHPortrait: string;
459
- frameOrientation: number;
460
- multiPageOff: number;
461
- name: string;
462
- seriesProcessMode: number;
463
- barcodeExt?: undefined;
464
- faceExt?: undefined;
465
- manualCrop?: undefined;
466
- UVTorch?: undefined;
467
- } | {
468
- barcodeExt: number;
469
- caption: string;
470
- desc: string;
471
- frameKWHDoublePageSpreadLandscape: number;
472
- frameKWHDoublePageSpreadPortrait: number;
473
- frameKWHLandscape: number;
474
- frameKWHPortrait: number;
475
- frameOrientation: number;
476
- multiPageOff: number;
477
- name: string;
478
- seriesProcessMode: number;
479
- faceExt?: undefined;
480
- manualCrop?: undefined;
481
- UVTorch?: undefined;
482
- } | {
483
- caption: string;
484
- desc: string;
485
- faceExt: number;
486
- frameKWHDoublePageSpreadLandscape: string;
487
- frameKWHDoublePageSpreadPortrait: string;
488
- frameKWHLandscape: string;
489
- frameKWHPortrait: string;
490
- frameOrientation: number;
491
- manualCrop: number;
492
- name: string;
493
- seriesProcessMode: number;
494
- multiPageOff?: undefined;
495
- barcodeExt?: undefined;
496
- UVTorch?: undefined;
497
- } | {
498
- barcodeExt: number;
499
- caption: string;
500
- desc: string;
501
- frameKWHDoublePageSpreadLandscape: string;
502
- frameKWHDoublePageSpreadPortrait: string;
503
- frameKWHLandscape: string;
504
- frameKWHPortrait: string;
505
- frameOrientation: number;
506
- multiPageOff: number;
507
- name: string;
508
- seriesProcessMode: number;
509
- faceExt?: undefined;
510
- manualCrop?: undefined;
511
- UVTorch?: undefined;
512
- } | {
513
- caption: string;
514
- desc: string;
515
- faceExt: number;
516
- frameKWHDoublePageSpreadLandscape: string;
517
- frameKWHDoublePageSpreadPortrait: string;
518
- frameKWHLandscape: string;
519
- frameKWHPortrait: string;
520
- frameOrientation: number;
521
- manualCrop: number;
522
- multiPageOff: number;
523
- name: string;
524
- seriesProcessMode: number;
525
- barcodeExt?: undefined;
526
- UVTorch?: undefined;
527
- } | {
528
- barcodeExt: number;
529
- caption: string;
530
- desc: string;
531
- faceExt: number;
532
- frameKWHDoublePageSpreadLandscape: string;
533
- frameKWHDoublePageSpreadPortrait: string;
534
- frameKWHLandscape: string;
535
- frameKWHPortrait: string;
536
- frameOrientation: number;
537
- manualCrop: number;
538
- multiPageOff: number;
539
- name: string;
540
- seriesProcessMode: number;
541
- UVTorch?: undefined;
542
- } | {
543
- caption: string;
544
- desc: string;
545
- frameKWHDoublePageSpreadLandscape: string;
546
- frameKWHDoublePageSpreadPortrait: string;
547
- frameKWHLandscape: string;
548
- frameKWHPortrait: string;
549
- frameOrientation: number;
550
- manualCrop: number;
551
- name: string;
552
- seriesProcessMode: number;
553
- multiPageOff?: undefined;
554
- barcodeExt?: undefined;
555
- faceExt?: undefined;
556
- UVTorch?: undefined;
557
- } | {
558
- barcodeExt: number;
559
- caption: string;
560
- desc: string;
561
- faceExt: number;
562
- frameKWHDoublePageSpreadLandscape: string;
563
- frameKWHDoublePageSpreadPortrait: string;
564
- frameKWHLandscape: string;
565
- frameKWHPortrait: string;
566
- frameOrientation: number;
567
- manualCrop: number;
568
- name: string;
569
- seriesProcessMode: number;
570
- multiPageOff?: undefined;
571
- UVTorch?: undefined;
572
- } | {
573
- caption: string;
574
- desc: string;
575
- frameKWHDoublePageSpreadLandscape: string;
576
- frameKWHDoublePageSpreadPortrait: string;
577
- frameKWHLandscape: string;
578
- frameKWHPortrait: string;
579
- frameOrientation: number;
580
- manualCrop: number;
581
- multiPageOff: number;
582
- name: string;
583
- seriesProcessMode: number;
584
- barcodeExt?: undefined;
585
- faceExt?: undefined;
586
- UVTorch?: undefined;
587
- } | {
588
- caption: string;
589
- desc: string;
590
- frameKWHDoublePageSpreadLandscape: number;
591
- frameKWHDoublePageSpreadPortrait: number;
592
- frameKWHLandscape: number;
593
- frameKWHPortrait: number;
594
- frameOrientation: number;
595
- multiPageOff: number;
596
- name: string;
597
- seriesProcessMode: number;
598
- barcodeExt?: undefined;
599
- faceExt?: undefined;
600
- manualCrop?: undefined;
601
- UVTorch?: undefined;
602
- } | {
603
- UVTorch: number;
604
- caption: string;
605
- desc: string;
606
- frameKWHDoublePageSpreadLandscape: number;
607
- frameKWHDoublePageSpreadPortrait: number;
608
- frameKWHLandscape: number;
609
- frameKWHPortrait: number;
610
- frameOrientation: number;
611
- name: string;
612
- multiPageOff?: undefined;
613
- seriesProcessMode?: undefined;
614
- barcodeExt?: undefined;
615
- faceExt?: undefined;
616
- manualCrop?: undefined;
617
- })[];
618
- };
619
- export declare const CIRCLE_ROTATE_SHIFT = 22.5;
620
- export declare const MIRROR_ANIMATION_TARGETS: number[];
621
- export declare const ANIMATION_TIMEOUT = 1000;
622
- export declare const ANIMATION_MESSAGE: FaceMessage[];
623
- export declare const STATIC_ANIMATION_MESSAGE: FaceMessage[];
624
- export declare const DocumentReaderRecognizerDefaultRequest: {
625
- processParam: {
626
- scenario: InternalScenarios;
627
- returnUncroppedImage: boolean;
628
- multipageProcessing: boolean;
629
- timeoutFromFirstDetect: number;
630
- timeoutFromFirstDocType: number;
631
- imageQa: {
632
- expectedPass: string[];
633
- dpiThreshold: number;
634
- glaresCheck: boolean;
635
- glaresCheckParams: {
636
- imgMarginPart: number;
637
- maxGlaringPart: number;
638
- };
639
- };
640
- };
641
- };
642
- export declare const DocumentReaderImageDefaultRequest: {
643
- processParam: {
644
- scenario: InternalScenarios;
645
- returnUncroppedImage: boolean;
646
- };
647
- };
648
- export declare const SDKDocumentReaderRecognizerDefaultRequest: {
649
- processParam: {
650
- scenario: InternalScenarios;
651
- returnUncroppedImage: boolean;
652
- timeoutFromFirstDetect: number;
653
- timeoutFromFirstDocType: number;
654
- };
655
- };
656
- export declare const SDKDocumentReaderImageDefaultRequest: {
657
- processParam: {
658
- scenario: InternalScenarios;
659
- returnUncroppedImage: boolean;
660
- };
661
- };
662
- export declare const AcceptedFiles: string[];
663
- export declare enum VideoFinishStatus {
664
- aborted = "liveness_aborted",
665
- timeout = "liveness_timeout",
666
- default = "liveness_default",
667
- inactive = "liveness_inactive"
668
- }
@@ -1,25 +0,0 @@
1
- /// <reference types="react" />
2
- import { CameraSnapshotResponseType, DocumentDictionaries, DocumentReaderResponseType, Locales } from '../types';
3
- import { DocumentEventActions, InternalScenarios, ErrorTypes } from '../constants';
4
- declare type DocumentCallbackArgTypes = DocumentReaderResponseType | CameraSnapshotResponseType;
5
- export declare type DocumentAttributesContextType = {
6
- onAction: ({ manual, action }: {
7
- manual: boolean;
8
- action: DocumentEventActions;
9
- }) => void;
10
- onResponse: (response: DocumentCallbackArgTypes) => void;
11
- onFail: (reason: ErrorTypes) => void;
12
- locale?: Locales;
13
- internalScenario?: InternalScenarios;
14
- multipageProcessing?: boolean;
15
- startScreen?: boolean;
16
- multiple?: boolean;
17
- license?: string;
18
- copyright?: boolean;
19
- cameraId?: string;
20
- changeCamera?: boolean;
21
- translations?: DocumentDictionaries;
22
- };
23
- export declare const DocumentAttributesContext: import("react").Context<DocumentAttributesContextType>;
24
- export declare const useDocumentContext: () => DocumentAttributesContextType;
25
- export {};
@@ -1,8 +0,0 @@
1
- /// <reference types="react" />
2
- import DocumentReaderService from '../services/DocumentReaderService';
3
- declare type DocumentSDKContextType = {
4
- service: DocumentReaderService | null;
5
- };
6
- export declare const DocumentSDKContext: import("react").Context<DocumentSDKContextType>;
7
- export declare const useDocumentSDKContext: () => DocumentSDKContextType;
8
- export {};