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