@regulaforensics/vp-frontend-document-components 2.0.0 → 2.1.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 (151) hide show
  1. package/README.md +67 -18
  2. package/dist/main.js +1 -1
  3. package/esm/main.js +1 -1
  4. package/lib/components/DocumentCapture.d.ts +1 -1
  5. package/lib/components/DocumentReaderFileCapture.d.ts +3 -3
  6. package/lib/constants.d.ts +40 -1
  7. package/lib/hooks/useDocumentReaderSeries.d.ts +1 -1
  8. package/lib/hooks/useDocumentReaderSingle.d.ts +3 -3
  9. package/lib/models/DocReaderWebclient/ext/authenticity/authenticity.d.ts +32 -0
  10. package/lib/models/DocReaderWebclient/ext/authenticity/fiber.d.ts +7 -0
  11. package/lib/models/DocReaderWebclient/ext/authenticity/ident.d.ts +8 -0
  12. package/lib/models/DocReaderWebclient/ext/authenticity/image-ident.d.ts +7 -0
  13. package/lib/models/DocReaderWebclient/ext/authenticity/index.d.ts +5 -0
  14. package/lib/models/DocReaderWebclient/ext/authenticity/ocr-security-text.d.ts +7 -0
  15. package/lib/models/DocReaderWebclient/ext/authenticity/security-feature.d.ts +8 -0
  16. package/lib/models/DocReaderWebclient/ext/images.d.ts +16 -0
  17. package/lib/models/DocReaderWebclient/ext/index.d.ts +6 -0
  18. package/lib/models/DocReaderWebclient/ext/process-request-image.d.ts +5 -0
  19. package/lib/models/DocReaderWebclient/ext/process-request.d.ts +38 -0
  20. package/lib/models/DocReaderWebclient/ext/process-response.d.ts +36 -0
  21. package/lib/models/DocReaderWebclient/ext/text-field.d.ts +40 -0
  22. package/lib/models/DocReaderWebclient/ext/text.d.ts +14 -0
  23. package/lib/models/DocReaderWebclient/models/area-array.d.ts +32 -0
  24. package/lib/models/DocReaderWebclient/models/area-container.d.ts +38 -0
  25. package/lib/models/DocReaderWebclient/models/authenticity-check-list.d.ts +31 -0
  26. package/lib/models/DocReaderWebclient/models/authenticity-check-result-item.d.ts +38 -0
  27. package/lib/models/DocReaderWebclient/models/authenticity-check-result.d.ts +43 -0
  28. package/lib/models/DocReaderWebclient/models/authenticity-result-all-of.d.ts +25 -0
  29. package/lib/models/DocReaderWebclient/models/authenticity-result-type.d.ts +33 -0
  30. package/lib/models/DocReaderWebclient/models/authenticity-result.d.ts +18 -0
  31. package/lib/models/DocReaderWebclient/models/bc-pdf417-info.d.ts +54 -0
  32. package/lib/models/DocReaderWebclient/models/bc-roidetect.d.ts +42 -0
  33. package/lib/models/DocReaderWebclient/models/check-diagnose.d.ts +98 -0
  34. package/lib/models/DocReaderWebclient/models/check-result.d.ts +30 -0
  35. package/lib/models/DocReaderWebclient/models/chosen-document-type-result-all-of.d.ts +25 -0
  36. package/lib/models/DocReaderWebclient/models/chosen-document-type-result.d.ts +19 -0
  37. package/lib/models/DocReaderWebclient/models/chosen-document-type.d.ts +74 -0
  38. package/lib/models/DocReaderWebclient/models/container-list.d.ts +45 -0
  39. package/lib/models/DocReaderWebclient/models/critical.d.ts +26 -0
  40. package/lib/models/DocReaderWebclient/models/cross-source-value-comparison.d.ts +38 -0
  41. package/lib/models/DocReaderWebclient/models/data-module.d.ts +48 -0
  42. package/lib/models/DocReaderWebclient/models/details-optical.d.ts +67 -0
  43. package/lib/models/DocReaderWebclient/models/details-rfid.d.ts +61 -0
  44. package/lib/models/DocReaderWebclient/models/device-info.d.ts +54 -0
  45. package/lib/models/DocReaderWebclient/models/doc-bar-code-info-all-of.d.ts +31 -0
  46. package/lib/models/DocReaderWebclient/models/doc-bar-code-info.d.ts +19 -0
  47. package/lib/models/DocReaderWebclient/models/doc-visual-extended-field.d.ts +70 -0
  48. package/lib/models/DocReaderWebclient/models/doc-visual-extended-info.d.ts +25 -0
  49. package/lib/models/DocReaderWebclient/models/document-format.d.ts +70 -0
  50. package/lib/models/DocReaderWebclient/models/document-image-result-all-of.d.ts +25 -0
  51. package/lib/models/DocReaderWebclient/models/document-image-result.d.ts +18 -0
  52. package/lib/models/DocReaderWebclient/models/document-image.d.ts +24 -0
  53. package/lib/models/DocReaderWebclient/models/document-position-result-all-of.d.ts +25 -0
  54. package/lib/models/DocReaderWebclient/models/document-position-result.d.ts +19 -0
  55. package/lib/models/DocReaderWebclient/models/document-position.d.ts +80 -0
  56. package/lib/models/DocReaderWebclient/models/document-type-recognition-result.d.ts +30 -0
  57. package/lib/models/DocReaderWebclient/models/document-type.d.ts +246 -0
  58. package/lib/models/DocReaderWebclient/models/document-types-candidates-list.d.ts +32 -0
  59. package/lib/models/DocReaderWebclient/models/document-types-candidates-result-all-of.d.ts +25 -0
  60. package/lib/models/DocReaderWebclient/models/document-types-candidates-result.d.ts +18 -0
  61. package/lib/models/DocReaderWebclient/models/document-types-candidates.d.ts +32 -0
  62. package/lib/models/DocReaderWebclient/models/encrypted-rclresult-all-of.d.ts +24 -0
  63. package/lib/models/DocReaderWebclient/models/encrypted-rclresult.d.ts +18 -0
  64. package/lib/models/DocReaderWebclient/models/fdsidlist.d.ts +80 -0
  65. package/lib/models/DocReaderWebclient/models/fiber-result-all-of.d.ts +74 -0
  66. package/lib/models/DocReaderWebclient/models/fiber-result.d.ts +18 -0
  67. package/lib/models/DocReaderWebclient/models/graphic-field-type.d.ts +118 -0
  68. package/lib/models/DocReaderWebclient/models/graphic-field.d.ts +63 -0
  69. package/lib/models/DocReaderWebclient/models/graphic-fields-list.d.ts +25 -0
  70. package/lib/models/DocReaderWebclient/models/graphics-result-all-of.d.ts +25 -0
  71. package/lib/models/DocReaderWebclient/models/graphics-result.d.ts +19 -0
  72. package/lib/models/DocReaderWebclient/models/ident-result-all-of.d.ts +65 -0
  73. package/lib/models/DocReaderWebclient/models/ident-result.d.ts +18 -0
  74. package/lib/models/DocReaderWebclient/models/image-data.d.ts +24 -0
  75. package/lib/models/DocReaderWebclient/models/image-qa.d.ts +54 -0
  76. package/lib/models/DocReaderWebclient/models/image-quality-check-list.d.ts +32 -0
  77. package/lib/models/DocReaderWebclient/models/image-quality-check-type.d.ts +50 -0
  78. package/lib/models/DocReaderWebclient/models/image-quality-check.d.ts +64 -0
  79. package/lib/models/DocReaderWebclient/models/image-quality-result-all-of.d.ts +25 -0
  80. package/lib/models/DocReaderWebclient/models/image-quality-result.d.ts +18 -0
  81. package/lib/models/DocReaderWebclient/models/images-available-source.d.ts +31 -0
  82. package/lib/models/DocReaderWebclient/models/images-field-value.d.ts +70 -0
  83. package/lib/models/DocReaderWebclient/models/images-field.d.ts +38 -0
  84. package/lib/models/DocReaderWebclient/models/images-result-all-of.d.ts +25 -0
  85. package/lib/models/DocReaderWebclient/models/images-result.d.ts +18 -0
  86. package/lib/models/DocReaderWebclient/models/images.d.ts +32 -0
  87. package/lib/models/DocReaderWebclient/models/index.d.ts +123 -0
  88. package/lib/models/DocReaderWebclient/models/lcid.d.ts +582 -0
  89. package/lib/models/DocReaderWebclient/models/lexical-analysis-result-all-of.d.ts +25 -0
  90. package/lib/models/DocReaderWebclient/models/lexical-analysis-result.d.ts +19 -0
  91. package/lib/models/DocReaderWebclient/models/license-result-all-of.d.ts +24 -0
  92. package/lib/models/DocReaderWebclient/models/license-result.d.ts +18 -0
  93. package/lib/models/DocReaderWebclient/models/light.d.ts +34 -0
  94. package/lib/models/DocReaderWebclient/models/list-verified-fields.d.ts +25 -0
  95. package/lib/models/DocReaderWebclient/models/log-level.d.ts +23 -0
  96. package/lib/models/DocReaderWebclient/models/measure-system.d.ts +26 -0
  97. package/lib/models/DocReaderWebclient/models/mrzformat.d.ts +24 -0
  98. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result-all-of.d.ts +81 -0
  99. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result.d.ts +18 -0
  100. package/lib/models/DocReaderWebclient/models/one-candidate.d.ts +74 -0
  101. package/lib/models/DocReaderWebclient/models/original-symbol.d.ts +37 -0
  102. package/lib/models/DocReaderWebclient/models/parray-field.d.ts +81 -0
  103. package/lib/models/DocReaderWebclient/models/per-document-config.d.ts +30 -0
  104. package/lib/models/DocReaderWebclient/models/photo-ident-result-all-of.d.ts +76 -0
  105. package/lib/models/DocReaderWebclient/models/photo-ident-result.d.ts +18 -0
  106. package/lib/models/DocReaderWebclient/models/point-array.d.ts +25 -0
  107. package/lib/models/DocReaderWebclient/models/point.d.ts +30 -0
  108. package/lib/models/DocReaderWebclient/models/points-container.d.ts +31 -0
  109. package/lib/models/DocReaderWebclient/models/process-params.d.ts +254 -0
  110. package/lib/models/DocReaderWebclient/models/process-request-image.d.ts +38 -0
  111. package/lib/models/DocReaderWebclient/models/process-request.d.ts +60 -0
  112. package/lib/models/DocReaderWebclient/models/process-response.d.ts +66 -0
  113. package/lib/models/DocReaderWebclient/models/process-system-info.d.ts +30 -0
  114. package/lib/models/DocReaderWebclient/models/processing-status.d.ts +30 -0
  115. package/lib/models/DocReaderWebclient/models/raw-image-container-list.d.ts +31 -0
  116. package/lib/models/DocReaderWebclient/models/rectangle-coordinates.d.ts +42 -0
  117. package/lib/models/DocReaderWebclient/models/result-item.d.ts +48 -0
  118. package/lib/models/DocReaderWebclient/models/result.d.ts +98 -0
  119. package/lib/models/DocReaderWebclient/models/rfid-location.d.ts +30 -0
  120. package/lib/models/DocReaderWebclient/models/rfid-origin.d.ts +42 -0
  121. package/lib/models/DocReaderWebclient/models/scenario.d.ts +36 -0
  122. package/lib/models/DocReaderWebclient/models/security-feature-result-all-of.d.ts +59 -0
  123. package/lib/models/DocReaderWebclient/models/security-feature-result.d.ts +18 -0
  124. package/lib/models/DocReaderWebclient/models/security-feature-type.d.ts +49 -0
  125. package/lib/models/DocReaderWebclient/models/source-validity.d.ts +32 -0
  126. package/lib/models/DocReaderWebclient/models/source.d.ts +23 -0
  127. package/lib/models/DocReaderWebclient/models/status-result-all-of.d.ts +25 -0
  128. package/lib/models/DocReaderWebclient/models/status-result.d.ts +18 -0
  129. package/lib/models/DocReaderWebclient/models/status.d.ts +63 -0
  130. package/lib/models/DocReaderWebclient/models/string-recognition-result.d.ts +25 -0
  131. package/lib/models/DocReaderWebclient/models/symbol-candidate.d.ts +30 -0
  132. package/lib/models/DocReaderWebclient/models/symbol-recognition-result.d.ts +32 -0
  133. package/lib/models/DocReaderWebclient/models/text-available-source.d.ts +38 -0
  134. package/lib/models/DocReaderWebclient/models/text-data-result-all-of.d.ts +25 -0
  135. package/lib/models/DocReaderWebclient/models/text-data-result.d.ts +19 -0
  136. package/lib/models/DocReaderWebclient/models/text-field-type.d.ts +2386 -0
  137. package/lib/models/DocReaderWebclient/models/text-field-value.d.ts +70 -0
  138. package/lib/models/DocReaderWebclient/models/text-field.d.ts +84 -0
  139. package/lib/models/DocReaderWebclient/models/text-post-processing.d.ts +22 -0
  140. package/lib/models/DocReaderWebclient/models/text-result-all-of.d.ts +25 -0
  141. package/lib/models/DocReaderWebclient/models/text-result.d.ts +18 -0
  142. package/lib/models/DocReaderWebclient/models/text.d.ts +51 -0
  143. package/lib/models/DocReaderWebclient/models/transaction-info.d.ts +42 -0
  144. package/lib/models/DocReaderWebclient/models/verification-result.d.ts +38 -0
  145. package/lib/models/DocReaderWebclient/models/verified-field-map.d.ts +63 -0
  146. package/lib/models/DocReaderWebclient/models/visibility.d.ts +23 -0
  147. package/lib/services/DocumentReaderProcessor.d.ts +7 -15
  148. package/lib/services/DocumentReaderService.d.ts +10 -4
  149. package/lib/types.d.ts +12 -9
  150. package/lib/utils.d.ts +4 -1
  151. package/package.json +1 -3
@@ -0,0 +1,70 @@
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 { OriginalSymbol } from './original-symbol';
13
+ import { RectangleCoordinates } from './rectangle-coordinates';
14
+ import { RfidOrigin } from './rfid-origin';
15
+ import { Source } from './source';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface TextFieldValue
20
+ */
21
+ export interface TextFieldValue {
22
+ /**
23
+ *
24
+ * @type {Source}
25
+ * @memberof TextFieldValue
26
+ */
27
+ source: Source;
28
+ /**
29
+ * Parsed/processed value. Date format converted for output, delimiters removed
30
+ * @type {string}
31
+ * @memberof TextFieldValue
32
+ */
33
+ value: string;
34
+ /**
35
+ * Original value as seen in the document
36
+ * @type {string}
37
+ * @memberof TextFieldValue
38
+ */
39
+ originalValue?: string;
40
+ /**
41
+ *
42
+ * @type {Array<OriginalSymbol>}
43
+ * @memberof TextFieldValue
44
+ */
45
+ originalSymbols?: Array<OriginalSymbol>;
46
+ /**
47
+ * Page index of the image from input list
48
+ * @type {number}
49
+ * @memberof TextFieldValue
50
+ */
51
+ pageIndex: number;
52
+ /**
53
+ * Min recognition probability. Combined minimum probability from single characters probabilities
54
+ * @type {number}
55
+ * @memberof TextFieldValue
56
+ */
57
+ probability?: number;
58
+ /**
59
+ *
60
+ * @type {RectangleCoordinates}
61
+ * @memberof TextFieldValue
62
+ */
63
+ fieldRect?: RectangleCoordinates;
64
+ /**
65
+ *
66
+ * @type {RfidOrigin}
67
+ * @memberof TextFieldValue
68
+ */
69
+ rfidOrigin?: RfidOrigin;
70
+ }
@@ -0,0 +1,84 @@
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 { CheckResult } from './check-result';
13
+ import { CrossSourceValueComparison } from './cross-source-value-comparison';
14
+ import { LCID } from './lcid';
15
+ import { SourceValidity } from './source-validity';
16
+ import { TextFieldType } from './text-field-type';
17
+ import { TextFieldValue } from './text-field-value';
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface TextField
22
+ */
23
+ export interface TextField {
24
+ /**
25
+ *
26
+ * @type {TextFieldType}
27
+ * @memberof TextField
28
+ */
29
+ fieldType: TextFieldType;
30
+ /**
31
+ * Field name. Only use to search values for fields with fieldType=50(other). In general, use fieldType for lookup.
32
+ * @type {string}
33
+ * @memberof TextField
34
+ */
35
+ fieldName: string;
36
+ /**
37
+ *
38
+ * @type {LCID}
39
+ * @memberof TextField
40
+ */
41
+ lcid?: LCID;
42
+ /**
43
+ *
44
+ * @type {CheckResult}
45
+ * @memberof TextField
46
+ */
47
+ status: CheckResult;
48
+ /**
49
+ *
50
+ * @type {CheckResult}
51
+ * @memberof TextField
52
+ */
53
+ validityStatus: CheckResult;
54
+ /**
55
+ *
56
+ * @type {CheckResult}
57
+ * @memberof TextField
58
+ */
59
+ comparisonStatus: CheckResult;
60
+ /**
61
+ * The most confidence value, selected from valueList
62
+ * @type {string}
63
+ * @memberof TextField
64
+ */
65
+ value: string;
66
+ /**
67
+ *
68
+ * @type {Array<TextFieldValue>}
69
+ * @memberof TextField
70
+ */
71
+ valueList: Array<TextFieldValue>;
72
+ /**
73
+ * Validity of all field values for given source. If there are two values on different pages for one field-source pair, then validity also will include logical match checking. If such values do not match, validity will return error.
74
+ * @type {Array<SourceValidity>}
75
+ * @memberof TextField
76
+ */
77
+ validityList: Array<SourceValidity>;
78
+ /**
79
+ *
80
+ * @type {Array<CrossSourceValueComparison>}
81
+ * @memberof TextField
82
+ */
83
+ comparisonList: Array<CrossSourceValueComparison>;
84
+ }
@@ -0,0 +1,22 @@
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 TextPostProcessing {
18
+ NO_CHANGE = 0,
19
+ UPPERCASE = 1,
20
+ LOWERCASE = 2,
21
+ CAPITAL = 3
22
+ }
@@ -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 { Text } from './text';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface TextResultAllOf
17
+ */
18
+ export interface TextResultAllOf {
19
+ /**
20
+ *
21
+ * @type {Text}
22
+ * @memberof TextResultAllOf
23
+ */
24
+ Text: Text;
25
+ }
@@ -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 { ResultItem } from './result-item';
13
+ import { TextResultAllOf } from './text-result-all-of';
14
+ /**
15
+ * @type TextResult
16
+ * @export
17
+ */
18
+ export declare type TextResult = ResultItem & TextResultAllOf;
@@ -0,0 +1,51 @@
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 { CheckResult } from './check-result';
13
+ import { TextAvailableSource } from './text-available-source';
14
+ import { TextField } from './text-field';
15
+ /**
16
+ * Contains all document text fields data with validity and cross-source compare checks
17
+ * @export
18
+ * @interface Text
19
+ */
20
+ export interface Text {
21
+ /**
22
+ *
23
+ * @type {CheckResult}
24
+ * @memberof Text
25
+ */
26
+ status: CheckResult;
27
+ /**
28
+ *
29
+ * @type {CheckResult}
30
+ * @memberof Text
31
+ */
32
+ validityStatus: CheckResult;
33
+ /**
34
+ *
35
+ * @type {CheckResult}
36
+ * @memberof Text
37
+ */
38
+ comparisonStatus: CheckResult;
39
+ /**
40
+ *
41
+ * @type {Array<TextField>}
42
+ * @memberof Text
43
+ */
44
+ fieldList: Array<TextField>;
45
+ /**
46
+ *
47
+ * @type {Array<TextAvailableSource>}
48
+ * @memberof Text
49
+ */
50
+ availableSourceList: Array<TextAvailableSource>;
51
+ }
@@ -0,0 +1,42 @@
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 TransactionInfo
16
+ */
17
+ export interface TransactionInfo {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof TransactionInfo
22
+ */
23
+ ComputerName?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof TransactionInfo
28
+ */
29
+ DateTime?: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof TransactionInfo
34
+ */
35
+ TransactionID?: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof TransactionInfo
40
+ */
41
+ UserName?: string;
42
+ }
@@ -0,0 +1,38 @@
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 VerificationResult {
18
+ /**
19
+ * Comparison result unknown
20
+ */
21
+ DISABLED = 0,
22
+ /**
23
+ * Verification passed
24
+ */
25
+ VERIFIED = 1,
26
+ /**
27
+ * Verification failed
28
+ */
29
+ NOT_VERIFIED = 2,
30
+ /**
31
+ * Positive comparison result
32
+ */
33
+ COMPARE_MATCH = 3,
34
+ /**
35
+ * Negative comparison result
36
+ */
37
+ COMPARE_NOT_MATCH = 4
38
+ }
@@ -0,0 +1,63 @@
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 { LCID } from './lcid';
13
+ import { TextFieldType } from './text-field-type';
14
+ import { VerificationResult } from './verification-result';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface VerifiedFieldMap
19
+ */
20
+ export interface VerifiedFieldMap {
21
+ /**
22
+ *
23
+ * @type {TextFieldType}
24
+ * @memberof VerifiedFieldMap
25
+ */
26
+ wFieldType?: TextFieldType;
27
+ /**
28
+ *
29
+ * @type {LCID}
30
+ * @memberof VerifiedFieldMap
31
+ */
32
+ wLCID?: LCID;
33
+ /**
34
+ * Field data extracted from mrz(machine readable zone)
35
+ * @type {string}
36
+ * @memberof VerifiedFieldMap
37
+ */
38
+ Field_MRZ?: string;
39
+ /**
40
+ * Field data extracted from visual zone
41
+ * @type {string}
42
+ * @memberof VerifiedFieldMap
43
+ */
44
+ Field_Visual?: string;
45
+ /**
46
+ * Field data extracted from barcode
47
+ * @type {string}
48
+ * @memberof VerifiedFieldMap
49
+ */
50
+ Field_Barcode?: string;
51
+ /**
52
+ * Field data extracted from rfid chip
53
+ * @type {string}
54
+ * @memberof VerifiedFieldMap
55
+ */
56
+ Field_RFID?: string;
57
+ /**
58
+ * results comparison matrix. Elements of the matrix with indices 0, 1, 2, 3 take one of the values Disabled(0), Verified(1) or Not_Verified(2), elements with indices 4, 5, 6, 7, 8 are one of the values Disabled(0), Compare_Match(3) or Compare_Not_Match(4). Elements of the Matrix matrix have the following semantic meaning: - element with index 0 –– the result of verification of data from the MRZ; - 1 –– the result of verification of data from the RFID microcircuit; - 2 –– the result of verification of data from text areas of the document; - 3 –– the result of verification data from barcodes; - 4 - the result of comparing MRZ data and RFID microcircuits; - 5 - the result of comparing MRZ data and text areas of document filling; - 6 - the result of comparing MRZ data and bar codes; - 7 - the result of comparing the data of text areas of the document and the RFID chip; - 8 - the result of comparing the data of the text areas of the document and barcodes; - 9 - the result of comparing the data of the RFID chip and barcodes.
59
+ * @type {Array<VerificationResult>}
60
+ * @memberof VerifiedFieldMap
61
+ */
62
+ Matrix?: Array<VerificationResult>;
63
+ }
@@ -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
+ * Enumeration contains visibility status of the security element
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum Visibility {
18
+ INVISIBLE = 0,
19
+ VISIBLE = 1,
20
+ COLORED = 2,
21
+ GRAYSCALE = 4,
22
+ WHITE_IR_MATCHING = 8
23
+ }
@@ -1,34 +1,27 @@
1
- import { CurrentPage, FacingModeType, SDKImageProcessingRequest, SDKRecognizerProcessingRequest, WidthAndHeight } from '../types';
2
- import { Response } from '@regulaforensics/document-reader-webclient';
1
+ import { CurrentPage, ProcessingRequest, ImageProcessingRequest, StreamParams } from '../types';
2
+ import { Response } from '../models/DocReaderWebclient/ext';
3
3
  declare type ServiceListener = ((data: Response) => void) | null;
4
4
  declare type ResponseListener = (currentPage: CurrentPage) => void;
5
5
  declare type StreamSettings = Partial<StreamParams>;
6
- declare type StreamParams = {
7
- cameraMode: FacingModeType;
8
- preferredCameraId: string;
9
- resolution: WidthAndHeight;
10
- };
11
6
  declare class DocumentReaderProcessor {
12
7
  private _videoElement;
13
8
  private _stream;
14
9
  private _documentReaderService;
15
10
  private _canvas;
16
11
  private _streamParam;
17
- private _frameSizes;
18
- private _recognizerProcessParam;
19
- private _imageProcessParam;
20
12
  private _videoEventListener;
21
13
  private _recognizerListener;
22
14
  private _isPrepared;
23
15
  private _isInitialized;
24
16
  private _isProcessing;
17
+ private _pageIdx;
25
18
  constructor(videoElement?: HTMLVideoElement);
26
19
  get streamParam(): StreamParams;
27
20
  set streamParam(params: Partial<StreamSettings>);
28
- get recognizerProcessParam(): SDKRecognizerProcessingRequest;
29
- set recognizerProcessParam(params: SDKRecognizerProcessingRequest);
30
- get imageProcessParam(): SDKImageProcessingRequest;
31
- set imageProcessParam(params: SDKImageProcessingRequest);
21
+ get recognizerProcessParam(): ProcessingRequest;
22
+ set recognizerProcessParam(params: ProcessingRequest);
23
+ get imageProcessParam(): ImageProcessingRequest;
24
+ set imageProcessParam(params: ImageProcessingRequest);
32
25
  get recognizeListener(): ServiceListener;
33
26
  set recognizeListener(listener: ServiceListener);
34
27
  set videoElement(videoElement: HTMLVideoElement | null);
@@ -36,7 +29,6 @@ declare class DocumentReaderProcessor {
36
29
  get isPrepared(): boolean;
37
30
  get isInitialized(): boolean;
38
31
  get isProcessing(): boolean;
39
- private get processRequest();
40
32
  private startStream;
41
33
  private detect;
42
34
  private startNewPage;
@@ -1,6 +1,6 @@
1
1
  import { DocumentCommandCode } from '../constants';
2
- import { DocumentReaderRequest } from '../types';
3
- import { Response } from '@regulaforensics/document-reader-webclient';
2
+ import { ProcessingRequest, ImageProcessingRequest } from '../types';
3
+ import { Response } from '../models/DocReaderWebclient/ext';
4
4
  declare type PrepareData = {
5
5
  isInitialized: boolean;
6
6
  isPrepared: boolean;
@@ -13,7 +13,13 @@ declare class DocumentReaderService {
13
13
  private _worker;
14
14
  private _prepareListener;
15
15
  private _currentPromise;
16
+ private _recognizerProcessParam;
17
+ private _imageProcessParam;
16
18
  constructor();
19
+ get recognizerProcessParam(): ProcessingRequest;
20
+ set recognizerProcessParam(params: ProcessingRequest);
21
+ get imageProcessParam(): ImageProcessingRequest;
22
+ set imageProcessParam(params: ImageProcessingRequest);
17
23
  get isInitialized(): boolean;
18
24
  private set isInitialized(value);
19
25
  get isPrepared(): boolean;
@@ -34,8 +40,8 @@ declare class DocumentReaderService {
34
40
  initialize(initData?: {
35
41
  license: string | undefined;
36
42
  }): Promise<void>;
37
- processImage(base64ImagesArray: Array<string>, params: DocumentReaderRequest): Promise<Response>;
38
- process(imageDataArray: Array<ImageData>, request: DocumentReaderRequest, commandCode: DocumentCommandCode): Promise<Response>;
43
+ processImage(base64ImagesArray: Array<string>, params: ProcessingRequest): Promise<Response>;
44
+ process(imageDataArray: Array<ImageData>, commandCode: DocumentCommandCode): Promise<Response>;
39
45
  startNewPage(): Promise<void>;
40
46
  startNewDocument(): Promise<void>;
41
47
  shutdown(): void;
package/lib/types.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { Response } from '@regulaforensics/document-reader-webclient';
1
+ import { Response } from './models/DocReaderWebclient/ext';
2
2
  import { DocumentEventActions, FaceEventActions, InternalScenarios, ObjectFit, ResponseCode, StreamStatus, ErrorTypes, CameraFacingMode } from './constants';
3
3
  import CameraModel from './models/CameraModel';
4
4
  export declare type XY = {
@@ -240,6 +240,7 @@ export declare type DocumentReaderProcessParam = {
240
240
  timeoutFromFirstDetect?: number;
241
241
  timeoutFromFirstDocType?: number;
242
242
  resultTypeOutput?: Array<string>;
243
+ customParams?: Record<string, any>;
243
244
  imageQa?: {
244
245
  expectedPass?: Array<string>;
245
246
  dpiThreshold?: number;
@@ -250,15 +251,12 @@ export declare type DocumentReaderProcessParam = {
250
251
  };
251
252
  };
252
253
  };
253
- export declare type DocumentReaderRequest = {
254
- processParam: Record<string, any>;
254
+ export declare type ProcessingRequest = {
255
+ processParam: DocumentReaderProcessParam;
255
256
  imagesList?: Array<DocumentReaderImage>;
256
257
  imageInputParam?: ImageInputParamType;
257
258
  };
258
- export declare type SDKRecognizerProcessingRequest = {
259
- processParam: DocumentReaderProcessParam;
260
- };
261
- export declare type SDKImageProcessingRequest = {
259
+ export declare type ImageProcessingRequest = {
262
260
  processParam: Pick<DocumentReaderProcessParam, 'returnPackageForReprocess' | 'returnUncroppedImage' | 'scenario'>;
263
261
  };
264
262
  export declare type DevicesType = {
@@ -273,6 +271,11 @@ export interface StreamDataType {
273
271
  camera: CameraTypes;
274
272
  twoFacingModesAvailable: boolean;
275
273
  }
274
+ export declare type StreamParams = {
275
+ cameraMode: FacingModeType;
276
+ preferredCameraId: string;
277
+ resolution: WidthAndHeight;
278
+ };
276
279
  export declare type CameraTypes = {
277
280
  selectedCamera: CameraModel;
278
281
  frontCameras: Array<CameraModel>;
@@ -302,10 +305,9 @@ interface IDocumentBaseComponent extends IBaseComponent {
302
305
  multiple?: boolean;
303
306
  'object-fit'?: keyof typeof ObjectFit;
304
307
  }
305
- export interface IFaceLiveness extends Omit<IBaseComponent, 'headers'> {
308
+ export interface IFaceLiveness extends IBaseComponent {
306
309
  url?: string;
307
310
  debug?: boolean;
308
- headers?: string | Record<string, string>;
309
311
  }
310
312
  export interface IDocumentReader extends IDocumentBaseComponent {
311
313
  'internal-scenario'?: keyof typeof InternalScenarios;
@@ -316,6 +318,7 @@ export interface IFaceDetection extends IBaseComponent {
316
318
  debug?: boolean;
317
319
  }
318
320
  export declare type ICameraSnapshot = IDocumentBaseComponent;
321
+ export { DocumentReaderService, DocumentReaderProcessor, defineComponents } from './index-document';
319
322
  export { default as DocumentReaderCaptureWebComponent } from './web-components/CameraSnapshot';
320
323
  export { default as DocumentReaderWebComponent } from './web-components/DocumentReader';
321
324
  export { default as FaceDetectionWebComponent } from './web-components/FaceDetection';
package/lib/utils.d.ts CHANGED
@@ -1,6 +1,7 @@
1
- import { ImageOutputType, ObjectFit } from './constants';
1
+ import { DocumentCaptureStatus, ImageOutputType, ObjectFit } from './constants';
2
2
  import CameraModel from './models/CameraModel';
3
3
  import { CameraTypes, CaptureFrameType, DevicesType, FaceDebugOutput, FacingModeType, FrameObject, StreamDataType, VideoParamsType, WidthAndHeight } from './types';
4
+ import { Response } from './models/DocReaderWebclient/ext';
4
5
  export declare function uint8ArrayToBase64(arr: Uint8ClampedArray, videoFrame: {
5
6
  width: number;
6
7
  height: number;
@@ -25,3 +26,5 @@ export declare function getVideo(resolution: WidthAndHeight, cameraTypes: Camera
25
26
  export declare function getImageFromVideo(videoElement: HTMLVideoElement, outputType: ImageOutputType): CaptureFrameType;
26
27
  export declare function getNextCamera(camerasInfo: CameraTypes): string;
27
28
  export declare function drawFaceDebugOutput(canvas: HTMLCanvasElement, videoElementParams: VideoParamsType, debugOutput: FaceDebugOutput): void;
29
+ export declare function mergeDeep<T, S, R>(target: T, source: S): R | T;
30
+ export declare function getStatus(response: Response, pageIdx: number, multipageProcessing?: boolean): DocumentCaptureStatus.FINDING | DocumentCaptureStatus.SUCCESS | DocumentCaptureStatus.RESOLUTION | DocumentCaptureStatus.GLARE | DocumentCaptureStatus.FOCUS | DocumentCaptureStatus.HOLD | DocumentCaptureStatus.START_NEXT_PAGE | DocumentCaptureStatus.TIMEOUT;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@regulaforensics/vp-frontend-document-components",
3
- "version": "2.0.0",
3
+ "version": "2.1.0",
4
4
  "description": "Regula framework agnostic web components to work with webcamera",
5
5
  "types": "lib/types.d.ts",
6
6
  "main": "dist/main.js",
@@ -35,7 +35,6 @@
35
35
  "*.{js,ts,tsx}": "eslint --fix"
36
36
  },
37
37
  "dependencies": {
38
- "@regulaforensics/document-reader-webclient": "^6.3.2",
39
38
  "@regulaforensics/facesdk-webclient": "^3.1.2",
40
39
  "@webcomponents/webcomponentsjs": "^2.6.0",
41
40
  "localize-react": "^1.7.1",
@@ -63,7 +62,6 @@
63
62
  "@storybook/builder-webpack5": "^6.5.13",
64
63
  "@storybook/manager-webpack5": "^6.5.13",
65
64
  "@storybook/react": "^6.5.13",
66
- "@types/pako": "^1.0.3",
67
65
  "@types/react": "^18.0.21",
68
66
  "@types/react-dom": "^18.0.6",
69
67
  "@types/uuid": "^8.3.4",