@regulaforensics/vp-frontend-face-components 1.4.0 → 2.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 (211) hide show
  1. package/README.md +47 -22
  2. package/dist/main.js +1 -1
  3. package/dist/main.js.LICENSE.txt +19 -20
  4. package/lib/common/Icon.d.ts +58 -1
  5. package/lib/common/Message.d.ts +3 -2
  6. package/lib/common/NoGlareIconLivenessDetection.d.ts +5 -0
  7. package/lib/common/NoSmilingIconLivenessDetection.d.ts +5 -0
  8. package/lib/common/PortraitOrientationOnlyIcon.d.ts +6 -0
  9. package/lib/common/RegulaLogoLivenessDetection.d.ts +5 -0
  10. package/lib/components/ButtonFaceLiveness.d.ts +7 -0
  11. package/lib/components/CameraCapture.d.ts +9 -0
  12. package/lib/components/CameraSnapshot.d.ts +2 -0
  13. package/lib/components/CameraSnapshotFileCapture.d.ts +10 -0
  14. package/lib/components/DocumentCapture.d.ts +11 -0
  15. package/lib/components/DocumentContainer.d.ts +11 -0
  16. package/lib/components/DocumentReader.d.ts +2 -0
  17. package/lib/components/DocumentReaderFileCapture.d.ts +12 -0
  18. package/lib/components/DocumentReaderLayout.d.ts +22 -0
  19. package/lib/components/DocumentReaderStartScreen.d.ts +10 -0
  20. package/lib/components/ErrorBoundary.d.ts +6 -5
  21. package/lib/components/FaceCapture.d.ts +17 -9
  22. package/lib/components/FaceFullScreenOverlay.d.ts +2 -3
  23. package/lib/components/FaceHintAnimaition.d.ts +16 -0
  24. package/lib/components/FaceLayout.d.ts +14 -10
  25. package/lib/components/InfoScreen.d.ts +2 -1
  26. package/lib/components/InfoScreenFaceLiveness.d.ts +12 -0
  27. package/lib/components/InstructionVideoScreen.d.ts +9 -0
  28. package/lib/components/ProcessScreenFaceLiveness.d.ts +6 -0
  29. package/lib/components/RetryScreenFaceLiveness.d.ts +7 -0
  30. package/lib/components/SectorAnimationSvg.d.ts +11 -0
  31. package/lib/components/WebCamera.d.ts +6 -7
  32. package/lib/constants.d.ts +489 -169
  33. package/lib/contexts/DocumentAttributesContext.d.ts +25 -0
  34. package/lib/contexts/DocumentSDKContext.d.ts +8 -0
  35. package/lib/contexts/FaceAttributesContext.d.ts +11 -10
  36. package/lib/hoc/withDocumentAttributesContext.d.ts +4 -0
  37. package/lib/hoc/withDocumentSDKContext.d.ts +3 -0
  38. package/lib/hoc/withLocalize.d.ts +5 -4
  39. package/lib/hooks/useDocumentReaderSeries.d.ts +20 -0
  40. package/lib/hooks/useDocumentReaderSingle.d.ts +15 -0
  41. package/lib/hooks/useFaceLiveness.d.ts +34 -26
  42. package/lib/hooks/useImageInputParam.d.ts +7 -0
  43. package/lib/hooks/useStateCallback.d.ts +1 -0
  44. package/lib/hooks/useStream.d.ts +3 -9
  45. package/lib/i18n/dictionaries/_dictionaries.d.ts +2212 -1988
  46. package/lib/index-document.d.ts +4 -0
  47. package/lib/media-resources/resourcesBase64.d.ts +7 -0
  48. package/lib/models/CameraModel.d.ts +2 -2
  49. package/lib/models/CustomError.d.ts +7 -0
  50. package/lib/models/DocReaderWebclient/ext/authenticity/authenticity.d.ts +32 -0
  51. package/lib/models/DocReaderWebclient/ext/authenticity/fiber.d.ts +7 -0
  52. package/lib/models/DocReaderWebclient/ext/authenticity/ident.d.ts +8 -0
  53. package/lib/models/DocReaderWebclient/ext/authenticity/image-ident.d.ts +7 -0
  54. package/lib/models/DocReaderWebclient/ext/authenticity/index.d.ts +5 -0
  55. package/lib/models/DocReaderWebclient/ext/authenticity/ocr-security-text.d.ts +7 -0
  56. package/lib/models/DocReaderWebclient/ext/authenticity/security-feature.d.ts +8 -0
  57. package/lib/models/DocReaderWebclient/ext/images.d.ts +16 -0
  58. package/lib/models/DocReaderWebclient/ext/index.d.ts +6 -0
  59. package/lib/models/DocReaderWebclient/ext/process-request-image.d.ts +5 -0
  60. package/lib/models/DocReaderWebclient/ext/process-request.d.ts +38 -0
  61. package/lib/models/DocReaderWebclient/ext/process-response.d.ts +36 -0
  62. package/lib/models/DocReaderWebclient/ext/text-field.d.ts +40 -0
  63. package/lib/models/DocReaderWebclient/ext/text.d.ts +14 -0
  64. package/lib/models/DocReaderWebclient/models/area-array.d.ts +32 -0
  65. package/lib/models/DocReaderWebclient/models/area-container.d.ts +38 -0
  66. package/lib/models/DocReaderWebclient/models/authenticity-check-list.d.ts +31 -0
  67. package/lib/models/DocReaderWebclient/models/authenticity-check-result-item.d.ts +38 -0
  68. package/lib/models/DocReaderWebclient/models/authenticity-check-result.d.ts +43 -0
  69. package/lib/models/DocReaderWebclient/models/authenticity-result-all-of.d.ts +25 -0
  70. package/lib/models/DocReaderWebclient/models/authenticity-result-type.d.ts +33 -0
  71. package/lib/models/DocReaderWebclient/models/authenticity-result.d.ts +18 -0
  72. package/lib/models/DocReaderWebclient/models/bc-pdf417-info.d.ts +54 -0
  73. package/lib/models/DocReaderWebclient/models/bc-roidetect.d.ts +42 -0
  74. package/lib/models/DocReaderWebclient/models/check-diagnose.d.ts +98 -0
  75. package/lib/models/DocReaderWebclient/models/check-result.d.ts +30 -0
  76. package/lib/models/DocReaderWebclient/models/chosen-document-type-result-all-of.d.ts +25 -0
  77. package/lib/models/DocReaderWebclient/models/chosen-document-type-result.d.ts +19 -0
  78. package/lib/models/DocReaderWebclient/models/chosen-document-type.d.ts +74 -0
  79. package/lib/models/DocReaderWebclient/models/container-list.d.ts +45 -0
  80. package/lib/models/DocReaderWebclient/models/critical.d.ts +26 -0
  81. package/lib/models/DocReaderWebclient/models/cross-source-value-comparison.d.ts +38 -0
  82. package/lib/models/DocReaderWebclient/models/data-module.d.ts +48 -0
  83. package/lib/models/DocReaderWebclient/models/details-optical.d.ts +67 -0
  84. package/lib/models/DocReaderWebclient/models/details-rfid.d.ts +61 -0
  85. package/lib/models/DocReaderWebclient/models/device-info.d.ts +54 -0
  86. package/lib/models/DocReaderWebclient/models/doc-bar-code-info-all-of.d.ts +31 -0
  87. package/lib/models/DocReaderWebclient/models/doc-bar-code-info.d.ts +19 -0
  88. package/lib/models/DocReaderWebclient/models/doc-visual-extended-field.d.ts +70 -0
  89. package/lib/models/DocReaderWebclient/models/doc-visual-extended-info.d.ts +25 -0
  90. package/lib/models/DocReaderWebclient/models/document-format.d.ts +70 -0
  91. package/lib/models/DocReaderWebclient/models/document-image-result-all-of.d.ts +25 -0
  92. package/lib/models/DocReaderWebclient/models/document-image-result.d.ts +18 -0
  93. package/lib/models/DocReaderWebclient/models/document-image.d.ts +24 -0
  94. package/lib/models/DocReaderWebclient/models/document-position-result-all-of.d.ts +25 -0
  95. package/lib/models/DocReaderWebclient/models/document-position-result.d.ts +19 -0
  96. package/lib/models/DocReaderWebclient/models/document-position.d.ts +80 -0
  97. package/lib/models/DocReaderWebclient/models/document-type-recognition-result.d.ts +30 -0
  98. package/lib/models/DocReaderWebclient/models/document-type.d.ts +246 -0
  99. package/lib/models/DocReaderWebclient/models/document-types-candidates-list.d.ts +32 -0
  100. package/lib/models/DocReaderWebclient/models/document-types-candidates-result-all-of.d.ts +25 -0
  101. package/lib/models/DocReaderWebclient/models/document-types-candidates-result.d.ts +18 -0
  102. package/lib/models/DocReaderWebclient/models/document-types-candidates.d.ts +32 -0
  103. package/lib/models/DocReaderWebclient/models/encrypted-rclresult-all-of.d.ts +24 -0
  104. package/lib/models/DocReaderWebclient/models/encrypted-rclresult.d.ts +18 -0
  105. package/lib/models/DocReaderWebclient/models/fdsidlist.d.ts +80 -0
  106. package/lib/models/DocReaderWebclient/models/fiber-result-all-of.d.ts +74 -0
  107. package/lib/models/DocReaderWebclient/models/fiber-result.d.ts +18 -0
  108. package/lib/models/DocReaderWebclient/models/graphic-field-type.d.ts +118 -0
  109. package/lib/models/DocReaderWebclient/models/graphic-field.d.ts +63 -0
  110. package/lib/models/DocReaderWebclient/models/graphic-fields-list.d.ts +25 -0
  111. package/lib/models/DocReaderWebclient/models/graphics-result-all-of.d.ts +25 -0
  112. package/lib/models/DocReaderWebclient/models/graphics-result.d.ts +19 -0
  113. package/lib/models/DocReaderWebclient/models/ident-result-all-of.d.ts +65 -0
  114. package/lib/models/DocReaderWebclient/models/ident-result.d.ts +18 -0
  115. package/lib/models/DocReaderWebclient/models/image-data.d.ts +24 -0
  116. package/lib/models/DocReaderWebclient/models/image-qa.d.ts +54 -0
  117. package/lib/models/DocReaderWebclient/models/image-quality-check-list.d.ts +32 -0
  118. package/lib/models/DocReaderWebclient/models/image-quality-check-type.d.ts +50 -0
  119. package/lib/models/DocReaderWebclient/models/image-quality-check.d.ts +64 -0
  120. package/lib/models/DocReaderWebclient/models/image-quality-result-all-of.d.ts +25 -0
  121. package/lib/models/DocReaderWebclient/models/image-quality-result.d.ts +18 -0
  122. package/lib/models/DocReaderWebclient/models/images-available-source.d.ts +31 -0
  123. package/lib/models/DocReaderWebclient/models/images-field-value.d.ts +70 -0
  124. package/lib/models/DocReaderWebclient/models/images-field.d.ts +38 -0
  125. package/lib/models/DocReaderWebclient/models/images-result-all-of.d.ts +25 -0
  126. package/lib/models/DocReaderWebclient/models/images-result.d.ts +18 -0
  127. package/lib/models/DocReaderWebclient/models/images.d.ts +32 -0
  128. package/lib/models/DocReaderWebclient/models/index.d.ts +123 -0
  129. package/lib/models/DocReaderWebclient/models/lcid.d.ts +582 -0
  130. package/lib/models/DocReaderWebclient/models/lexical-analysis-result-all-of.d.ts +25 -0
  131. package/lib/models/DocReaderWebclient/models/lexical-analysis-result.d.ts +19 -0
  132. package/lib/models/DocReaderWebclient/models/license-result-all-of.d.ts +24 -0
  133. package/lib/models/DocReaderWebclient/models/license-result.d.ts +18 -0
  134. package/lib/models/DocReaderWebclient/models/light.d.ts +34 -0
  135. package/lib/models/DocReaderWebclient/models/list-verified-fields.d.ts +25 -0
  136. package/lib/models/DocReaderWebclient/models/log-level.d.ts +23 -0
  137. package/lib/models/DocReaderWebclient/models/measure-system.d.ts +26 -0
  138. package/lib/models/DocReaderWebclient/models/mrzformat.d.ts +24 -0
  139. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result-all-of.d.ts +81 -0
  140. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result.d.ts +18 -0
  141. package/lib/models/DocReaderWebclient/models/one-candidate.d.ts +74 -0
  142. package/lib/models/DocReaderWebclient/models/original-symbol.d.ts +37 -0
  143. package/lib/models/DocReaderWebclient/models/parray-field.d.ts +81 -0
  144. package/lib/models/DocReaderWebclient/models/per-document-config.d.ts +30 -0
  145. package/lib/models/DocReaderWebclient/models/photo-ident-result-all-of.d.ts +76 -0
  146. package/lib/models/DocReaderWebclient/models/photo-ident-result.d.ts +18 -0
  147. package/lib/models/DocReaderWebclient/models/point-array.d.ts +25 -0
  148. package/lib/models/DocReaderWebclient/models/point.d.ts +30 -0
  149. package/lib/models/DocReaderWebclient/models/points-container.d.ts +31 -0
  150. package/lib/models/DocReaderWebclient/models/process-params.d.ts +254 -0
  151. package/lib/models/DocReaderWebclient/models/process-request-image.d.ts +38 -0
  152. package/lib/models/DocReaderWebclient/models/process-request.d.ts +60 -0
  153. package/lib/models/DocReaderWebclient/models/process-response.d.ts +66 -0
  154. package/lib/models/DocReaderWebclient/models/process-system-info.d.ts +30 -0
  155. package/lib/models/DocReaderWebclient/models/processing-status.d.ts +30 -0
  156. package/lib/models/DocReaderWebclient/models/raw-image-container-list.d.ts +31 -0
  157. package/lib/models/DocReaderWebclient/models/rectangle-coordinates.d.ts +42 -0
  158. package/lib/models/DocReaderWebclient/models/result-item.d.ts +48 -0
  159. package/lib/models/DocReaderWebclient/models/result.d.ts +98 -0
  160. package/lib/models/DocReaderWebclient/models/rfid-location.d.ts +30 -0
  161. package/lib/models/DocReaderWebclient/models/rfid-origin.d.ts +42 -0
  162. package/lib/models/DocReaderWebclient/models/scenario.d.ts +36 -0
  163. package/lib/models/DocReaderWebclient/models/security-feature-result-all-of.d.ts +59 -0
  164. package/lib/models/DocReaderWebclient/models/security-feature-result.d.ts +18 -0
  165. package/lib/models/DocReaderWebclient/models/security-feature-type.d.ts +49 -0
  166. package/lib/models/DocReaderWebclient/models/source-validity.d.ts +32 -0
  167. package/lib/models/DocReaderWebclient/models/source.d.ts +23 -0
  168. package/lib/models/DocReaderWebclient/models/status-result-all-of.d.ts +25 -0
  169. package/lib/models/DocReaderWebclient/models/status-result.d.ts +18 -0
  170. package/lib/models/DocReaderWebclient/models/status.d.ts +63 -0
  171. package/lib/models/DocReaderWebclient/models/string-recognition-result.d.ts +25 -0
  172. package/lib/models/DocReaderWebclient/models/symbol-candidate.d.ts +30 -0
  173. package/lib/models/DocReaderWebclient/models/symbol-recognition-result.d.ts +32 -0
  174. package/lib/models/DocReaderWebclient/models/text-available-source.d.ts +38 -0
  175. package/lib/models/DocReaderWebclient/models/text-data-result-all-of.d.ts +25 -0
  176. package/lib/models/DocReaderWebclient/models/text-data-result.d.ts +19 -0
  177. package/lib/models/DocReaderWebclient/models/text-field-type.d.ts +2386 -0
  178. package/lib/models/DocReaderWebclient/models/text-field-value.d.ts +70 -0
  179. package/lib/models/DocReaderWebclient/models/text-field.d.ts +84 -0
  180. package/lib/models/DocReaderWebclient/models/text-post-processing.d.ts +22 -0
  181. package/lib/models/DocReaderWebclient/models/text-result-all-of.d.ts +25 -0
  182. package/lib/models/DocReaderWebclient/models/text-result.d.ts +18 -0
  183. package/lib/models/DocReaderWebclient/models/text.d.ts +51 -0
  184. package/lib/models/DocReaderWebclient/models/transaction-info.d.ts +42 -0
  185. package/lib/models/DocReaderWebclient/models/verification-result.d.ts +38 -0
  186. package/lib/models/DocReaderWebclient/models/verified-field-map.d.ts +63 -0
  187. package/lib/models/DocReaderWebclient/models/visibility.d.ts +23 -0
  188. package/lib/services/DebugService.d.ts +4 -0
  189. package/lib/services/DocumentReaderProcessor.d.ts +50 -0
  190. package/lib/services/DocumentReaderService.d.ts +48 -30
  191. package/lib/services/FaceLivenessService.d.ts +35 -19
  192. package/lib/services/FaceService.d.ts +34 -6
  193. package/lib/services/StreamRecorderService.d.ts +24 -0
  194. package/lib/types.d.ts +261 -119
  195. package/lib/utils.d.ts +17 -52
  196. package/lib/web-components/CameraSnapshot.d.ts +14 -0
  197. package/lib/web-components/DocumentReader.d.ts +14 -0
  198. package/lib/web-components/FaceDetection.d.ts +3 -3
  199. package/lib/web-components/FaceLiveness.d.ts +7 -4
  200. package/lib/web-components/FullScreenContainer.d.ts +1 -1
  201. package/package.json +59 -62
  202. package/lib/common/InstructionIconFaceDetection.d.ts +0 -5
  203. package/lib/common/InstructionIconFaceLiveness.d.ts +0 -5
  204. package/lib/common/NoGlareIcon.d.ts +0 -5
  205. package/lib/common/NoSmilingIcon.d.ts +0 -5
  206. package/lib/components/InstructionScreen.d.ts +0 -9
  207. package/lib/components/RetryScreen.d.ts +0 -7
  208. package/lib/hooks/useDebounce.d.ts +0 -2
  209. package/lib/hooks/useInterval.d.ts +0 -3
  210. package/lib/services/WasmFeatureDetectService.d.ts +0 -4
  211. package/lib/web-components.d.ts +0 -47
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { VerifiedFieldMap } from './verified-field-map';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ListVerifiedFields
17
+ */
18
+ export interface ListVerifiedFields {
19
+ /**
20
+ *
21
+ * @type {Array<VerifiedFieldMap>}
22
+ * @memberof ListVerifiedFields
23
+ */
24
+ pFieldMaps?: Array<VerifiedFieldMap>;
25
+ }
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum LogLevel {
18
+ FATAL_ERROR = "FatalError",
19
+ ERROR = "Error",
20
+ WARNING = "Warning",
21
+ INFO = "Info",
22
+ DEBUG = "Debug"
23
+ }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum MeasureSystem {
18
+ /**
19
+ * Metric system of measurement, where things are measured in meters and grams
20
+ */
21
+ METRIC = 0,
22
+ /**
23
+ * Imperial System of Measurement, where things are measured in feet, inches and pounds
24
+ */
25
+ IMPERIAL = 1
26
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum MRZFormat {
18
+ IDL = "1x30",
19
+ ID1 = "3x30",
20
+ ID2 = "2x36",
21
+ ID3 = "2x44",
22
+ CAN = "1x6",
23
+ ID1_2_30 = "2x30"
24
+ }
@@ -0,0 +1,81 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Critical } from './critical';
13
+ import { Light } from './light';
14
+ import { RectangleCoordinates } from './rectangle-coordinates';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface OCRSecurityTextResultAllOf
19
+ */
20
+ export interface OCRSecurityTextResultAllOf {
21
+ /**
22
+ *
23
+ * @type {Critical}
24
+ * @memberof OCRSecurityTextResultAllOf
25
+ */
26
+ CriticalFlag?: Critical;
27
+ /**
28
+ *
29
+ * @type {Light}
30
+ * @memberof OCRSecurityTextResultAllOf
31
+ */
32
+ LightType?: Light;
33
+ /**
34
+ *
35
+ * @type {RectangleCoordinates}
36
+ * @memberof OCRSecurityTextResultAllOf
37
+ */
38
+ FieldRect?: RectangleCoordinates;
39
+ /**
40
+ *
41
+ * @type {number}
42
+ * @memberof OCRSecurityTextResultAllOf
43
+ */
44
+ EtalonResultType?: number;
45
+ /**
46
+ *
47
+ * @type {number}
48
+ * @memberof OCRSecurityTextResultAllOf
49
+ */
50
+ EtalonFieldType?: number;
51
+ /**
52
+ *
53
+ * @type {number}
54
+ * @memberof OCRSecurityTextResultAllOf
55
+ */
56
+ EtalonLightType?: number;
57
+ /**
58
+ *
59
+ * @type {string}
60
+ * @memberof OCRSecurityTextResultAllOf
61
+ */
62
+ SecurityTextResultOCR?: string;
63
+ /**
64
+ *
65
+ * @type {string}
66
+ * @memberof OCRSecurityTextResultAllOf
67
+ */
68
+ EtalonResultOCR?: string;
69
+ /**
70
+ *
71
+ * @type {number}
72
+ * @memberof OCRSecurityTextResultAllOf
73
+ */
74
+ Reserved1?: number;
75
+ /**
76
+ *
77
+ * @type {number}
78
+ * @memberof OCRSecurityTextResultAllOf
79
+ */
80
+ Reserved2?: number;
81
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AuthenticityCheckResultItem } from './authenticity-check-result-item';
13
+ import { OCRSecurityTextResultAllOf } from './ocrsecurity-text-result-all-of';
14
+ /**
15
+ * @type OCRSecurityTextResult
16
+ * @export
17
+ */
18
+ export declare type OCRSecurityTextResult = AuthenticityCheckResultItem & OCRSecurityTextResultAllOf;
@@ -0,0 +1,74 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { FDSIDList } from './fdsidlist';
13
+ import { RfidLocation } from './rfid-location';
14
+ /**
15
+ * Contains information about one document type candidate
16
+ * @export
17
+ * @interface OneCandidate
18
+ */
19
+ export interface OneCandidate {
20
+ /**
21
+ * Document name
22
+ * @type {string}
23
+ * @memberof OneCandidate
24
+ */
25
+ DocumentName?: string;
26
+ /**
27
+ * Unique document type template identifier (Regula\'s internal numeric code)
28
+ * @type {number}
29
+ * @memberof OneCandidate
30
+ */
31
+ ID?: number;
32
+ /**
33
+ * A measure of the likelihood of correct recognition in the analysis of this type of document
34
+ * @type {number}
35
+ * @memberof OneCandidate
36
+ */
37
+ P?: number;
38
+ /**
39
+ *
40
+ * @type {RfidLocation}
41
+ * @memberof OneCandidate
42
+ */
43
+ RFID_Presence?: RfidLocation;
44
+ /**
45
+ *
46
+ * @type {FDSIDList}
47
+ * @memberof OneCandidate
48
+ */
49
+ FDSIDList?: FDSIDList;
50
+ /**
51
+ * Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document
52
+ * @type {number}
53
+ * @memberof OneCandidate
54
+ */
55
+ NecessaryLights?: number;
56
+ /**
57
+ * Set of authentication options provided for this type of document (combination of Authenticity enum)
58
+ * @type {number}
59
+ * @memberof OneCandidate
60
+ */
61
+ CheckAuthenticity?: number;
62
+ /**
63
+ * The required exposure value of the camera when receiving images of a document of this type for a UV lighting scheme
64
+ * @type {number}
65
+ * @memberof OneCandidate
66
+ */
67
+ UVExp?: number;
68
+ /**
69
+ * Combination of lighting scheme identifiers (combination of Light enum) needed to perform all authenticity checks specified in CheckAuthenticity
70
+ * @type {number}
71
+ * @memberof OneCandidate
72
+ */
73
+ AuthenticityNecessaryLights?: number;
74
+ }
@@ -0,0 +1,37 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { RectangleCoordinates } from './rectangle-coordinates';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface OriginalSymbol
17
+ */
18
+ export interface OriginalSymbol {
19
+ /**
20
+ * Unicode symbol code
21
+ * @type {number}
22
+ * @memberof OriginalSymbol
23
+ */
24
+ code?: number;
25
+ /**
26
+ * Probability of correctness reading of a single character
27
+ * @type {number}
28
+ * @memberof OriginalSymbol
29
+ */
30
+ probability?: number;
31
+ /**
32
+ *
33
+ * @type {RectangleCoordinates}
34
+ * @memberof OriginalSymbol
35
+ */
36
+ rect?: RectangleCoordinates;
37
+ }
@@ -0,0 +1,81 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { BcPDF417INFO } from './bc-pdf417-info';
13
+ import { BcROIDETECT } from './bc-roidetect';
14
+ import { DataModule } from './data-module';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface PArrayField
19
+ */
20
+ export interface PArrayField {
21
+ /**
22
+ *
23
+ * @type {number}
24
+ * @memberof PArrayField
25
+ */
26
+ bcAngle_DETECT?: number;
27
+ /**
28
+ *
29
+ * @type {number}
30
+ * @memberof PArrayField
31
+ */
32
+ bcCodeResult?: number;
33
+ /**
34
+ *
35
+ * @type {number}
36
+ * @memberof PArrayField
37
+ */
38
+ bcCountModule?: number;
39
+ /**
40
+ *
41
+ * @type {Array<DataModule>}
42
+ * @memberof PArrayField
43
+ */
44
+ bcDataModule?: Array<DataModule>;
45
+ /**
46
+ *
47
+ * @type {BcPDF417INFO}
48
+ * @memberof PArrayField
49
+ */
50
+ bcPDF417INFO?: BcPDF417INFO;
51
+ /**
52
+ *
53
+ * @type {BcROIDETECT}
54
+ * @memberof PArrayField
55
+ */
56
+ bcROI_DETECT?: BcROIDETECT;
57
+ /**
58
+ *
59
+ * @type {number}
60
+ * @memberof PArrayField
61
+ */
62
+ bcTextDecoderTypes?: number;
63
+ /**
64
+ *
65
+ * @type {number}
66
+ * @memberof PArrayField
67
+ */
68
+ bcTextFieldType?: number;
69
+ /**
70
+ *
71
+ * @type {number}
72
+ * @memberof PArrayField
73
+ */
74
+ bcType_DECODE?: number;
75
+ /**
76
+ *
77
+ * @type {number}
78
+ * @memberof PArrayField
79
+ */
80
+ bcType_DETECT?: number;
81
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface PerDocumentConfig
16
+ */
17
+ export interface PerDocumentConfig {
18
+ /**
19
+ * Specific template IDs, for which apply current custom configuration
20
+ * @type {Array<number>}
21
+ * @memberof PerDocumentConfig
22
+ */
23
+ docID?: Array<number>;
24
+ /**
25
+ * Contains items from AuthenticityResultType as sum via OR operation
26
+ * @type {number}
27
+ * @memberof PerDocumentConfig
28
+ */
29
+ excludeAuthChecks?: number;
30
+ }
@@ -0,0 +1,76 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ImageData } from './image-data';
13
+ import { Light } from './light';
14
+ import { RawImageContainerList } from './raw-image-container-list';
15
+ import { RectangleCoordinates } from './rectangle-coordinates';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface PhotoIdentResultAllOf
20
+ */
21
+ export interface PhotoIdentResultAllOf {
22
+ /**
23
+ *
24
+ * @type {Light}
25
+ * @memberof PhotoIdentResultAllOf
26
+ */
27
+ LightIndex?: Light;
28
+ /**
29
+ *
30
+ * @type {RectangleCoordinates}
31
+ * @memberof PhotoIdentResultAllOf
32
+ */
33
+ Area?: RectangleCoordinates;
34
+ /**
35
+ *
36
+ * @type {ImageData}
37
+ * @memberof PhotoIdentResultAllOf
38
+ */
39
+ SourceImage?: ImageData;
40
+ /**
41
+ *
42
+ * @type {RawImageContainerList}
43
+ * @memberof PhotoIdentResultAllOf
44
+ */
45
+ ResultImages?: RawImageContainerList;
46
+ /**
47
+ *
48
+ * @type {number}
49
+ * @memberof PhotoIdentResultAllOf
50
+ */
51
+ FieldTypesCount?: number;
52
+ /**
53
+ *
54
+ * @type {Array<number>}
55
+ * @memberof PhotoIdentResultAllOf
56
+ */
57
+ FieldTypesList?: Array<number>;
58
+ /**
59
+ *
60
+ * @type {number}
61
+ * @memberof PhotoIdentResultAllOf
62
+ */
63
+ Step?: number;
64
+ /**
65
+ *
66
+ * @type {number}
67
+ * @memberof PhotoIdentResultAllOf
68
+ */
69
+ Angle?: number;
70
+ /**
71
+ *
72
+ * @type {number}
73
+ * @memberof PhotoIdentResultAllOf
74
+ */
75
+ Reserved3?: number;
76
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AuthenticityCheckResultItem } from './authenticity-check-result-item';
13
+ import { PhotoIdentResultAllOf } from './photo-ident-result-all-of';
14
+ /**
15
+ * @type PhotoIdentResult
16
+ * @export
17
+ */
18
+ export declare type PhotoIdentResult = AuthenticityCheckResultItem & PhotoIdentResultAllOf;
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Point } from './point';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface PointArray
17
+ */
18
+ export interface PointArray {
19
+ /**
20
+ *
21
+ * @type {Array<Point>}
22
+ * @memberof PointArray
23
+ */
24
+ PointsList?: Array<Point>;
25
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface Point
16
+ */
17
+ export interface Point {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof Point
22
+ */
23
+ x?: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof Point
28
+ */
29
+ y?: number;
30
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Regula Document Reader Web API
3
+ * Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
4
+ *
5
+ * The version of the OpenAPI document: 6.5.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Point } from './point';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface PointsContainer
17
+ */
18
+ export interface PointsContainer {
19
+ /**
20
+ *
21
+ * @type {number}
22
+ * @memberof PointsContainer
23
+ */
24
+ PointCount?: number;
25
+ /**
26
+ *
27
+ * @type {Array<Point>}
28
+ * @memberof PointsContainer
29
+ */
30
+ PointsList?: Array<Point>;
31
+ }