@regulaforensics/vp-frontend-face-components 2.0.0 → 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 (237) hide show
  1. package/README.md +372 -165
  2. package/dist/main.js +1 -1
  3. package/dist/main.js.LICENSE.txt +30 -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 -686
  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 -25
  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 -20
  71. package/lib/hooks/useDocumentReaderSingle.d.ts +0 -15
  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/DocumentReaderProcessor.d.ts +0 -50
  226. package/lib/services/DocumentReaderService.d.ts +0 -57
  227. package/lib/services/EventEmitter.d.ts +0 -9
  228. package/lib/services/FaceLivenessService.d.ts +0 -62
  229. package/lib/services/FaceService.d.ts +0 -39
  230. package/lib/services/StreamRecorderService.d.ts +0 -24
  231. package/lib/types.d.ts +0 -361
  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 -11
  236. package/lib/web-components/FaceLiveness.d.ts +0 -17
  237. package/lib/web-components/FullScreenContainer.d.ts +0 -4
@@ -1,4 +0,0 @@
1
- import '@webcomponents/webcomponentsjs/webcomponents-bundle.js';
2
- export declare function defineComponents(): Promise<void>;
3
- export { default as DocumentReaderService } from './services/DocumentReaderService';
4
- export { default as DocumentReaderProcessor } from './services/DocumentReaderProcessor';
@@ -1 +0,0 @@
1
- import '@webcomponents/webcomponentsjs/webcomponents-bundle.js';
@@ -1,7 +0,0 @@
1
- export declare const videoInstructionBase64: string;
2
- export declare const videoInstructionCaptureBase64: string;
3
- export declare const spriteHint1: string;
4
- export declare const spriteHint2: string;
5
- export declare const spriteHint3: string;
6
- export declare const spriteHint4: string;
7
- export declare const spriteHint5: string;
@@ -1,9 +0,0 @@
1
- import { FacingModeType } from '../types';
2
- declare class CameraModel {
3
- readonly deviceId: string;
4
- readonly facing?: FacingModeType;
5
- readonly groupId: string;
6
- readonly label: string;
7
- constructor(mdi: MediaDeviceInfo, facing?: FacingModeType);
8
- }
9
- export default CameraModel;
@@ -1,7 +0,0 @@
1
- import { ErrorTypes } from '../constants';
2
- declare class CustomError {
3
- type: ErrorTypes;
4
- details?: any;
5
- constructor(type: ErrorTypes, details?: any);
6
- }
7
- export default CustomError;
@@ -1,32 +0,0 @@
1
- import { AuthenticityCheckList as BaseAuthenticityCheckList, AuthenticityCheckResult } from '../../models';
2
- import { FiberChecks } from './fiber';
3
- import { IdentChecks } from './ident';
4
- import { ImageIdentChecks } from './image-ident';
5
- import { OCRSecurityTextChecks } from './ocr-security-text';
6
- import { SecurityFeatureChecks } from './security-feature';
7
- export declare class Authenticity implements BaseAuthenticityCheckList {
8
- List: Array<AuthenticityCheckResult>;
9
- page_idx: number;
10
- constructor(origin: BaseAuthenticityCheckList, page_idx: number);
11
- uvLuminescenceChecks(): SecurityFeatureChecks | undefined;
12
- irB900Checks(): SecurityFeatureChecks | undefined;
13
- imagePatternChecks(): IdentChecks | undefined;
14
- axialProtectionChecks(): SecurityFeatureChecks | undefined;
15
- uvFiberChecks(): FiberChecks | undefined;
16
- irVisibilityChecks(): IdentChecks | undefined;
17
- ocrSecurityTextChecks(): OCRSecurityTextChecks | undefined;
18
- ipiChecks(): ImageIdentChecks | undefined;
19
- embedImageChecks(): SecurityFeatureChecks | undefined;
20
- hologramsChecks(): SecurityFeatureChecks | undefined;
21
- imageAreaChecks(): SecurityFeatureChecks | undefined;
22
- portraitComparisonChecks(): IdentChecks | undefined;
23
- barcodeFormatCheckChecks(): SecurityFeatureChecks | undefined;
24
- kinegramChecks(): IdentChecks | undefined;
25
- letterScreenChecks(): IdentChecks | undefined;
26
- resultByType(authenticityType: number): AuthenticityCheckResult | undefined;
27
- private fiberOrUndefined;
28
- private identOrUndefined;
29
- private imageIdentOrUndefined;
30
- private ocrSecurityTextOrUndefined;
31
- private securityFeatureOrUndefined;
32
- }
@@ -1,7 +0,0 @@
1
- import { AuthenticityCheckResult, AuthenticityResultType, CheckResult, FiberResult } from '../../models';
2
- export declare class FiberChecks implements AuthenticityCheckResult {
3
- List: Array<FiberResult>;
4
- Result: CheckResult;
5
- Type: AuthenticityResultType;
6
- constructor(origin: AuthenticityCheckResult);
7
- }
@@ -1,8 +0,0 @@
1
- import { AuthenticityCheckResult, AuthenticityResultType, CheckResult, IdentResult, SecurityFeatureType } from '../../models';
2
- export declare class IdentChecks implements AuthenticityCheckResult {
3
- List: Array<IdentResult>;
4
- Result: CheckResult;
5
- Type: AuthenticityResultType;
6
- constructor(origin: AuthenticityCheckResult);
7
- checksByElement(elementType: SecurityFeatureType): Array<IdentResult>;
8
- }
@@ -1,7 +0,0 @@
1
- import { AuthenticityCheckResult, AuthenticityResultType, CheckResult, PhotoIdentResult } from '../../models';
2
- export declare class ImageIdentChecks implements AuthenticityCheckResult {
3
- List: Array<PhotoIdentResult>;
4
- Result: CheckResult;
5
- Type: AuthenticityResultType;
6
- constructor(origin: AuthenticityCheckResult);
7
- }
@@ -1,5 +0,0 @@
1
- export * from './authenticity';
2
- export * from './fiber';
3
- export * from './ident';
4
- export * from './ocr-security-text';
5
- export * from './security-feature';
@@ -1,7 +0,0 @@
1
- import { AuthenticityCheckResult, AuthenticityResultType, CheckResult, OCRSecurityTextResult } from '../../models';
2
- export declare class OCRSecurityTextChecks implements AuthenticityCheckResult {
3
- List: Array<OCRSecurityTextResult>;
4
- Result: CheckResult;
5
- Type: AuthenticityResultType;
6
- constructor(origin: AuthenticityCheckResult);
7
- }
@@ -1,8 +0,0 @@
1
- import { AuthenticityCheckResult, AuthenticityResultType, CheckResult, SecurityFeatureResult, SecurityFeatureType } from '../../models';
2
- export declare class SecurityFeatureChecks implements AuthenticityCheckResult {
3
- List: Array<SecurityFeatureResult>;
4
- Result: CheckResult;
5
- Type: AuthenticityResultType;
6
- constructor(origin: AuthenticityCheckResult);
7
- checksByElement(elementType: SecurityFeatureType): Array<SecurityFeatureResult>;
8
- }
@@ -1,16 +0,0 @@
1
- import { GraphicFieldType, Images as BaseImages, ImagesField as BaseImagesField, ImagesAvailableSource, ImagesFieldValue, Source } from '../models';
2
- export declare class Images implements BaseImages {
3
- availableSourceList: Array<ImagesAvailableSource>;
4
- fieldList: Array<ImagesField>;
5
- constructor(origin: BaseImages);
6
- getField(type: GraphicFieldType): ImagesField | undefined;
7
- getFields(type: GraphicFieldType): Array<ImagesField> | undefined;
8
- }
9
- export declare class ImagesField implements BaseImagesField {
10
- fieldName: string;
11
- fieldType: GraphicFieldType;
12
- valueList: Array<ImagesFieldValue>;
13
- constructor(origin: BaseImagesField);
14
- getValue(source?: Source, original?: boolean): ArrayBuffer | undefined;
15
- private getValueBySource;
16
- }
@@ -1,6 +0,0 @@
1
- export * from './process-request';
2
- export * from './process-request-image';
3
- export * from './process-response';
4
- export * from './text';
5
- export * from './images';
6
- export * from './text-field';
@@ -1,5 +0,0 @@
1
- import { ProcessRequestImage as ProcessRequestImageBase } from '../models';
2
- import { Base64String } from './process-request';
3
- export interface ProcessRequestImage extends Omit<ProcessRequestImageBase, 'ImageData'> {
4
- ImageData: ArrayBuffer | Base64String;
5
- }
@@ -1,38 +0,0 @@
1
- import { ContainerList, ProcessParams, ProcessSystemInfo } from '../models';
2
- import { ProcessRequestImage } from './process-request-image';
3
- export declare type Base64String = string;
4
- export interface ProcessRequest {
5
- /**
6
- *
7
- * @type {ProcessParams}
8
- * @memberof ProcessRequest
9
- */
10
- processParam: ProcessParams;
11
- /**
12
- *
13
- * @type {Array<ProcessRequestImage>}
14
- * @memberof ProcessRequest
15
- */
16
- images: Array<ProcessRequestImage | ArrayBuffer | Base64String>;
17
- /**
18
- * @type {ContainerList}
19
- * @memberOf ProcessRequest
20
- */
21
- ContainerList: ContainerList;
22
- /**
23
- *
24
- * @type {ProcessParams}
25
- * @memberof ProcessRequest
26
- */
27
- systemInfo?: ProcessSystemInfo;
28
- /**
29
- * Free-form object to be included in response. Must be object, not list or simple value.
30
- * Do not affect document processing. Use it freely to pass your app params. Stored in process logs.
31
- * @type {{ [key: string]: object; }}
32
- * @memberof ProcessRequest
33
- */
34
- passBackObject?: {
35
- [key: string]: any;
36
- };
37
- }
38
- export declare const instanceOfProcessRequest: (data: any) => data is ProcessRequest;
@@ -1,36 +0,0 @@
1
- import { AuthenticityResult, ContainerList, ImageQualityCheckList, ImagesResult, ProcessingStatus, ProcessResponse, Result, ResultItem, RfidLocation, Status, StatusResult, TextResult, ChosenDocumentTypeResult, DocBarCodeInfo, TransactionInfo } from '../models';
2
- import { Text } from './text';
3
- import { Images } from './images';
4
- import { Authenticity } from './authenticity';
5
- export declare class Response {
6
- status?: Status;
7
- text?: Text;
8
- images?: Images;
9
- lowLvlResponse: LowLvlResponse;
10
- rawResponse: ProcessResponse;
11
- constructor(original: ProcessResponse);
12
- authenticity(page_idx?: number): Authenticity | undefined;
13
- authenticityPerPage(): Array<Authenticity>;
14
- imageQualityChecks(page_idx?: number): ImageQualityCheckList | undefined;
15
- imageQualityChecksPerPage(): Array<ImageQualityCheckList> | undefined;
16
- }
17
- export declare class LowLvlResponse implements ProcessResponse {
18
- ContainerList: ContainerList;
19
- ProcessingFinished: ProcessingStatus;
20
- TransactionInfo: TransactionInfo;
21
- ChipPage?: RfidLocation;
22
- log?: string;
23
- passBackObject?: {
24
- [key: string]: any;
25
- };
26
- morePagesAvailable?: number;
27
- constructor(original: ProcessResponse);
28
- statusResult(): StatusResult | undefined;
29
- textResult(): TextResult | undefined;
30
- imagesResult(): ImagesResult | undefined;
31
- barcodeResult(): DocBarCodeInfo | undefined;
32
- documentTypeResults(): Array<ChosenDocumentTypeResult> | undefined;
33
- resultByType(type: Result): ResultItem | undefined;
34
- resultByTypeAndPage(type: Result, page_idx?: number): ResultItem | undefined;
35
- resultsByType(type: Result): Array<ResultItem | AuthenticityResult | ImageQualityCheckList>;
36
- }
@@ -1,40 +0,0 @@
1
- import { CheckResult, CrossSourceValueComparison, Source, SourceValidity, TextField as BaseTextField, TextFieldType, TextFieldValue } from '../models';
2
- export declare class TextField implements BaseTextField {
3
- fieldType: TextFieldType;
4
- fieldName: string;
5
- lcid?: number;
6
- status: CheckResult;
7
- validityStatus: CheckResult;
8
- comparisonStatus: CheckResult;
9
- value: string;
10
- valueList: Array<TextFieldValue>;
11
- validityList: Array<SourceValidity>;
12
- comparisonList: Array<CrossSourceValueComparison>;
13
- constructor(origin: BaseTextField);
14
- /**
15
- * This method returns value of the text field. Value encoded in UTF8.
16
- * Fields value obtained in the following order:
17
- * - if MRZ value is present, it will be taken
18
- * - if no MRZ, but RFID value is present, it will be taken
19
- * - if no MRZ, no RFID, but Barcode value is present, it will be taken
20
- * - if no MRZ, no RFID, no Barcode, but Visual OCR value is present, it will be taken
21
- *
22
- * @param source See {@code Source}
23
- * @param original Each value formatted according to input params and server settings.
24
- * To get original representation, set this flag to true. Date example:
25
- * - original visual value - "3 January 2009"
26
- * - formatted value - "03.01.2009"
27
- */
28
- getValue(source?: Source, original?: boolean): string | undefined;
29
- /**
30
- * Returns validity check of all values for given source.
31
- * @param source See {@code Source}
32
- */
33
- sourceValidity(source: Source): CheckResult;
34
- /**
35
- * Returns value matching result for different sources.
36
- */
37
- crossSourceComparison(one: Source, other: Source): CheckResult;
38
- getLCIDName(): string | undefined;
39
- private getValueBySource;
40
- }
@@ -1,14 +0,0 @@
1
- import { TextAvailableSource as AvailableSource, CheckResult, Text as BaseText, TextFieldType } from '../models';
2
- import { TextField } from './text-field';
3
- export declare class Text implements BaseText {
4
- status: CheckResult;
5
- validityStatus: CheckResult;
6
- comparisonStatus: CheckResult;
7
- availableSourceList: Array<AvailableSource>;
8
- fieldList: Array<TextField>;
9
- constructor(origin: BaseText);
10
- getField(type: TextFieldType, lcid?: number): TextField | undefined;
11
- getFieldByName(name: string, lcid?: number): TextField | undefined;
12
- getFieldValue(type: TextFieldType, lcid?: number): string | undefined;
13
- getFieldValueByName(name: string, lcid?: number): string | undefined;
14
- }
@@ -1,32 +0,0 @@
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 { PointArray } from './point-array';
13
- import { RectangleCoordinates } from './rectangle-coordinates';
14
- /**
15
- *
16
- * @export
17
- * @interface AreaArray
18
- */
19
- export interface AreaArray {
20
- /**
21
- *
22
- * @type {Array<RectangleCoordinates>}
23
- * @memberof AreaArray
24
- */
25
- List?: Array<RectangleCoordinates>;
26
- /**
27
- *
28
- * @type {Array<PointArray>}
29
- * @memberof AreaArray
30
- */
31
- Points?: Array<PointArray>;
32
- }
@@ -1,38 +0,0 @@
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 { PointsContainer } from './points-container';
13
- import { RectangleCoordinates } from './rectangle-coordinates';
14
- /**
15
- * Checked fragment coordinates
16
- * @export
17
- * @interface AreaContainer
18
- */
19
- export interface AreaContainer {
20
- /**
21
- *
22
- * @type {number}
23
- * @memberof AreaContainer
24
- */
25
- Count?: number;
26
- /**
27
- *
28
- * @type {Array<RectangleCoordinates>}
29
- * @memberof AreaContainer
30
- */
31
- List?: Array<RectangleCoordinates>;
32
- /**
33
- *
34
- * @type {Array<PointsContainer>}
35
- * @memberof AreaContainer
36
- */
37
- Points?: Array<PointsContainer>;
38
- }
@@ -1,31 +0,0 @@
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 { AuthenticityCheckResult } from './authenticity-check-result';
13
- /**
14
- *
15
- * @export
16
- * @interface AuthenticityCheckList
17
- */
18
- export interface AuthenticityCheckList {
19
- /**
20
- * Count of items in List
21
- * @type {number}
22
- * @memberof AuthenticityCheckList
23
- */
24
- Count?: number;
25
- /**
26
- * Authenticity Check
27
- * @type {Array<AuthenticityCheckResult>}
28
- * @memberof AuthenticityCheckList
29
- */
30
- List: Array<AuthenticityCheckResult>;
31
- }
@@ -1,38 +0,0 @@
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 { CheckDiagnose } from './check-diagnose';
13
- import { CheckResult } from './check-result';
14
- /**
15
- * Common fields for all authenticity result objects
16
- * @export
17
- * @interface AuthenticityCheckResultItem
18
- */
19
- export interface AuthenticityCheckResultItem {
20
- /**
21
- * Same as authenticity result type, but used for safe parsing of not-described values. See authenticity result type
22
- * @type {number}
23
- * @memberof AuthenticityCheckResultItem
24
- */
25
- Type: number;
26
- /**
27
- *
28
- * @type {CheckResult}
29
- * @memberof AuthenticityCheckResultItem
30
- */
31
- ElementResult?: CheckResult;
32
- /**
33
- *
34
- * @type {CheckDiagnose}
35
- * @memberof AuthenticityCheckResultItem
36
- */
37
- ElementDiagnose?: CheckDiagnose;
38
- }
@@ -1,43 +0,0 @@
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 { AuthenticityResultType } from './authenticity-result-type';
13
- import { CheckResult } from './check-result';
14
- import { FiberResult } from './fiber-result';
15
- import { IdentResult } from './ident-result';
16
- import { OCRSecurityTextResult } from './ocrsecurity-text-result';
17
- import { PhotoIdentResult } from './photo-ident-result';
18
- import { SecurityFeatureResult } from './security-feature-result';
19
- /**
20
- *
21
- * @export
22
- * @interface AuthenticityCheckResult
23
- */
24
- export interface AuthenticityCheckResult {
25
- /**
26
- *
27
- * @type {AuthenticityResultType}
28
- * @memberof AuthenticityCheckResult
29
- */
30
- Type: AuthenticityResultType;
31
- /**
32
- *
33
- * @type {CheckResult}
34
- * @memberof AuthenticityCheckResult
35
- */
36
- Result: CheckResult;
37
- /**
38
- *
39
- * @type {Array<SecurityFeatureResult | IdentResult | FiberResult | OCRSecurityTextResult | PhotoIdentResult>}
40
- * @memberof AuthenticityCheckResult
41
- */
42
- List: Array<SecurityFeatureResult | IdentResult | FiberResult | OCRSecurityTextResult | PhotoIdentResult>;
43
- }
@@ -1,25 +0,0 @@
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 { AuthenticityCheckList } from './authenticity-check-list';
13
- /**
14
- *
15
- * @export
16
- * @interface AuthenticityResultAllOf
17
- */
18
- export interface AuthenticityResultAllOf {
19
- /**
20
- *
21
- * @type {AuthenticityCheckList}
22
- * @memberof AuthenticityResultAllOf
23
- */
24
- AuthenticityCheckList: AuthenticityCheckList;
25
- }
@@ -1,33 +0,0 @@
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
- * Enumeration describes available authenticity checks
14
- * @export
15
- * @enum {string}
16
- */
17
- export declare enum AuthenticityResultType {
18
- UV_LUMINESCENCE = 1,
19
- IR_B900 = 2,
20
- IMAGE_PATTERN = 4,
21
- AXIAL_PROTECTION = 8,
22
- UV_FIBERS = 16,
23
- IR_VISIBILITY = 32,
24
- OCR_SECURITY_TEXT = 64,
25
- IPI = 128,
26
- PHOTO_EMBED_TYPE = 512,
27
- HOLOGRAMS = 4096,
28
- PHOTO_AREA = 8192,
29
- PORTRAIT_COMPARISON = 32768,
30
- BARCODE_FORMAT_CHECK = 65536,
31
- KINEGRAM = 131072,
32
- LETTER_SCREEN = 262144
33
- }
@@ -1,18 +0,0 @@
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 { AuthenticityResultAllOf } from './authenticity-result-all-of';
13
- import { ResultItem } from './result-item';
14
- /**
15
- * @type AuthenticityResult
16
- * @export
17
- */
18
- export declare type AuthenticityResult = AuthenticityResultAllOf & ResultItem;
@@ -1,54 +0,0 @@
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 BcPDF417INFO
16
- */
17
- export interface BcPDF417INFO {
18
- /**
19
- *
20
- * @type {number}
21
- * @memberof BcPDF417INFO
22
- */
23
- Angle?: number;
24
- /**
25
- *
26
- * @type {number}
27
- * @memberof BcPDF417INFO
28
- */
29
- bcColumn?: number;
30
- /**
31
- *
32
- * @type {number}
33
- * @memberof BcPDF417INFO
34
- */
35
- bcErrorLevel?: number;
36
- /**
37
- *
38
- * @type {number}
39
- * @memberof BcPDF417INFO
40
- */
41
- bcRow?: number;
42
- /**
43
- *
44
- * @type {number}
45
- * @memberof BcPDF417INFO
46
- */
47
- minX?: number;
48
- /**
49
- *
50
- * @type {number}
51
- * @memberof BcPDF417INFO
52
- */
53
- minY?: number;
54
- }
@@ -1,42 +0,0 @@
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 BcROIDETECT
16
- */
17
- export interface BcROIDETECT {
18
- /**
19
- *
20
- * @type {number}
21
- * @memberof BcROIDETECT
22
- */
23
- bottom?: number;
24
- /**
25
- *
26
- * @type {number}
27
- * @memberof BcROIDETECT
28
- */
29
- left?: number;
30
- /**
31
- *
32
- * @type {number}
33
- * @memberof BcROIDETECT
34
- */
35
- right?: number;
36
- /**
37
- *
38
- * @type {number}
39
- * @memberof BcROIDETECT
40
- */
41
- top?: number;
42
- }