@regulaforensics/document-reader-webclient 5.5.1 → 5.5.5

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 (426) hide show
  1. package/.github/workflows/run-smoke-test.yml +1 -4
  2. package/.github/workflows/trivy-scan.yaml +24 -0
  3. package/dist/cjs-es5/api/default-api.js +16 -9
  4. package/dist/cjs-es5/api/process-api.js +16 -9
  5. package/dist/cjs-es5/base.js +1 -1
  6. package/dist/cjs-es5/configuration.js +1 -1
  7. package/dist/cjs-es5/ext/authenticity/authenticity.js +7 -1
  8. package/dist/cjs-es5/ext/document-reader.js +30 -7
  9. package/dist/cjs-es5/ext/images.js +23 -8
  10. package/dist/cjs-es5/ext/process-request.js +1 -1
  11. package/dist/cjs-es5/ext/process-response.js +60 -10
  12. package/dist/cjs-es5/ext/text-field.js +150 -1
  13. package/dist/cjs-es5/index.js +2 -1
  14. package/dist/cjs-es5/models/area-array.js +1 -1
  15. package/dist/cjs-es5/models/area-container.js +1 -1
  16. package/dist/cjs-es5/models/authenticity-check-list.js +1 -1
  17. package/dist/cjs-es5/models/authenticity-check-result-item.js +1 -1
  18. package/dist/cjs-es5/models/authenticity-check-result.js +1 -1
  19. package/dist/cjs-es5/models/authenticity-result-all-of.js +1 -1
  20. package/dist/cjs-es5/models/authenticity-result-type.js +72 -3
  21. package/dist/cjs-es5/models/authenticity-result.js +1 -1
  22. package/dist/cjs-es5/models/bc-pdf417-info.js +16 -0
  23. package/dist/cjs-es5/models/bc-roidetect.js +16 -0
  24. package/dist/cjs-es5/models/check-diagnose.js +37 -4
  25. package/dist/cjs-es5/models/check-result.js +1 -1
  26. package/dist/cjs-es5/models/chosen-document-type-result-all-of.js +1 -1
  27. package/dist/cjs-es5/models/chosen-document-type-result.js +1 -1
  28. package/dist/cjs-es5/models/chosen-document-type.js +1 -1
  29. package/dist/cjs-es5/models/container-list.js +1 -1
  30. package/dist/cjs-es5/models/critical.js +1 -1
  31. package/dist/cjs-es5/models/cross-source-value-comparison.js +1 -1
  32. package/dist/cjs-es5/models/data-module.js +16 -0
  33. package/dist/cjs-es5/models/details-optical.js +1 -1
  34. package/dist/cjs-es5/models/details-rfid.js +1 -1
  35. package/dist/cjs-es5/models/device-info.js +1 -1
  36. package/dist/cjs-es5/models/doc-bar-code-info-all-of.js +16 -0
  37. package/dist/cjs-es5/models/doc-bar-code-info.js +16 -0
  38. package/dist/cjs-es5/models/doc-visual-extended-field.js +1 -1
  39. package/dist/cjs-es5/models/doc-visual-extended-info.js +1 -1
  40. package/dist/cjs-es5/models/document-format.js +1 -1
  41. package/dist/cjs-es5/models/document-image-result-all-of.js +1 -1
  42. package/dist/cjs-es5/models/document-image-result.js +1 -1
  43. package/dist/cjs-es5/models/document-image.js +1 -1
  44. package/dist/cjs-es5/models/document-position-result-all-of.js +16 -0
  45. package/dist/cjs-es5/models/document-position-result.js +16 -0
  46. package/dist/cjs-es5/models/document-position.js +16 -0
  47. package/dist/cjs-es5/models/document-type-recognition-result.js +1 -1
  48. package/dist/cjs-es5/models/document-type.js +699 -5
  49. package/dist/cjs-es5/models/document-types-candidates-list.js +1 -1
  50. package/dist/cjs-es5/models/document-types-candidates-result-all-of.js +1 -1
  51. package/dist/cjs-es5/models/document-types-candidates-result.js +1 -1
  52. package/dist/cjs-es5/models/document-types-candidates.js +1 -1
  53. package/dist/cjs-es5/models/encrypted-rclresult-all-of.js +16 -0
  54. package/dist/cjs-es5/models/encrypted-rclresult.js +16 -0
  55. package/dist/cjs-es5/models/face-api-search.js +16 -0
  56. package/dist/cjs-es5/models/face-api.js +16 -0
  57. package/dist/cjs-es5/models/fdsidlist.js +1 -1
  58. package/dist/cjs-es5/models/fiber-result-all-of.js +1 -1
  59. package/dist/cjs-es5/models/fiber-result.js +1 -1
  60. package/dist/cjs-es5/models/graphic-field-type.js +14 -2
  61. package/dist/cjs-es5/models/graphic-field.js +1 -1
  62. package/dist/cjs-es5/models/graphic-fields-list.js +1 -1
  63. package/dist/cjs-es5/models/graphics-result-all-of.js +1 -1
  64. package/dist/cjs-es5/models/graphics-result.js +1 -1
  65. package/dist/cjs-es5/models/ident-result-all-of.js +1 -1
  66. package/dist/cjs-es5/models/ident-result.js +1 -1
  67. package/dist/cjs-es5/models/image-data.js +1 -1
  68. package/dist/cjs-es5/models/image-qa.js +1 -1
  69. package/dist/cjs-es5/models/image-quality-check-list.js +1 -1
  70. package/dist/cjs-es5/models/image-quality-check-type.js +10 -2
  71. package/dist/cjs-es5/models/image-quality-check.js +1 -1
  72. package/dist/cjs-es5/models/image-quality-result-all-of.js +1 -1
  73. package/dist/cjs-es5/models/image-quality-result.js +1 -1
  74. package/dist/cjs-es5/models/images-available-source.js +1 -1
  75. package/dist/cjs-es5/models/images-field-value.js +1 -1
  76. package/dist/cjs-es5/models/images-field.js +1 -1
  77. package/dist/cjs-es5/models/images-result-all-of.js +1 -1
  78. package/dist/cjs-es5/models/images-result.js +1 -1
  79. package/dist/cjs-es5/models/images.js +1 -1
  80. package/dist/cjs-es5/models/index.js +22 -1
  81. package/dist/cjs-es5/models/lcid.js +28 -28
  82. package/dist/cjs-es5/models/lexical-analysis-result-all-of.js +1 -1
  83. package/dist/cjs-es5/models/lexical-analysis-result.js +1 -1
  84. package/dist/cjs-es5/models/license-result-all-of.js +16 -0
  85. package/dist/cjs-es5/models/license-result.js +16 -0
  86. package/dist/cjs-es5/models/light.js +1 -1
  87. package/dist/cjs-es5/models/list-verified-fields.js +1 -1
  88. package/dist/cjs-es5/models/log-level.js +45 -0
  89. package/dist/cjs-es5/models/measure-system.js +1 -1
  90. package/dist/cjs-es5/models/mrzformat.js +49 -0
  91. package/dist/cjs-es5/models/ocrsecurity-text-result-all-of.js +1 -1
  92. package/dist/cjs-es5/models/ocrsecurity-text-result.js +1 -1
  93. package/dist/cjs-es5/models/one-candidate.js +1 -1
  94. package/dist/cjs-es5/models/original-symbol.js +1 -1
  95. package/dist/cjs-es5/models/parray-field.js +16 -0
  96. package/dist/cjs-es5/models/parsing-notification-codes.js +897 -0
  97. package/dist/cjs-es5/models/per-document-config.js +16 -0
  98. package/dist/cjs-es5/models/photo-ident-result-all-of.js +1 -1
  99. package/dist/cjs-es5/models/photo-ident-result.js +1 -1
  100. package/dist/cjs-es5/models/point-array.js +1 -1
  101. package/dist/cjs-es5/models/point.js +1 -1
  102. package/dist/cjs-es5/models/points-container.js +1 -1
  103. package/dist/cjs-es5/models/process-params-rfid.js +16 -0
  104. package/dist/cjs-es5/models/process-params.js +1 -1
  105. package/dist/cjs-es5/models/process-request-image.js +1 -1
  106. package/dist/cjs-es5/models/process-request.js +1 -1
  107. package/dist/cjs-es5/models/process-response.js +1 -1
  108. package/dist/cjs-es5/models/process-system-info.js +1 -1
  109. package/dist/cjs-es5/models/processing-status.js +1 -1
  110. package/dist/cjs-es5/models/raw-image-container-list.js +1 -1
  111. package/dist/cjs-es5/models/rectangle-coordinates.js +1 -1
  112. package/dist/cjs-es5/models/result-item.js +1 -1
  113. package/dist/cjs-es5/models/result.js +57 -29
  114. package/dist/cjs-es5/models/rfid-location.js +1 -1
  115. package/dist/cjs-es5/models/rfid-origin.js +1 -1
  116. package/dist/cjs-es5/models/scenario.js +57 -3
  117. package/dist/cjs-es5/models/security-feature-result-all-of.js +1 -1
  118. package/dist/cjs-es5/models/security-feature-result.js +1 -1
  119. package/dist/cjs-es5/models/security-feature-type.js +152 -3
  120. package/dist/cjs-es5/models/source-validity.js +1 -1
  121. package/dist/cjs-es5/models/source.js +17 -2
  122. package/dist/cjs-es5/models/status-result-all-of.js +1 -1
  123. package/dist/cjs-es5/models/status-result.js +1 -1
  124. package/dist/cjs-es5/models/status.js +1 -1
  125. package/dist/cjs-es5/models/string-recognition-result.js +1 -1
  126. package/dist/cjs-es5/models/symbol-candidate.js +1 -1
  127. package/dist/cjs-es5/models/symbol-recognition-result.js +1 -1
  128. package/dist/cjs-es5/models/text-available-source.js +1 -1
  129. package/dist/cjs-es5/models/text-data-result-all-of.js +1 -1
  130. package/dist/cjs-es5/models/text-data-result.js +1 -1
  131. package/dist/cjs-es5/models/text-field-type.js +651 -435
  132. package/dist/cjs-es5/models/text-field-value.js +1 -1
  133. package/dist/cjs-es5/models/text-field.js +1 -1
  134. package/dist/cjs-es5/models/text-post-processing.js +41 -0
  135. package/dist/cjs-es5/models/text-result-all-of.js +1 -1
  136. package/dist/cjs-es5/models/text-result.js +1 -1
  137. package/dist/cjs-es5/models/text.js +1 -1
  138. package/dist/cjs-es5/models/transaction-info.js +1 -1
  139. package/dist/cjs-es5/models/verification-result.js +1 -1
  140. package/dist/cjs-es5/models/verified-field-map.js +1 -1
  141. package/dist/cjs-es5/models/visibility.js +17 -2
  142. package/dist/esm-es5/api/default-api.js +16 -9
  143. package/dist/esm-es5/api/process-api.js +16 -9
  144. package/dist/esm-es5/base.js +1 -1
  145. package/dist/esm-es5/configuration.js +1 -1
  146. package/dist/esm-es5/ext/authenticity/authenticity.js +7 -1
  147. package/dist/esm-es5/ext/document-reader.js +10 -6
  148. package/dist/esm-es5/ext/images.js +4 -5
  149. package/dist/esm-es5/ext/process-request.js +1 -1
  150. package/dist/esm-es5/ext/process-response.js +41 -7
  151. package/dist/esm-es5/ext/text-field.js +150 -1
  152. package/dist/esm-es5/index.js +2 -1
  153. package/dist/esm-es5/models/area-array.js +1 -1
  154. package/dist/esm-es5/models/area-container.js +1 -1
  155. package/dist/esm-es5/models/authenticity-check-list.js +1 -1
  156. package/dist/esm-es5/models/authenticity-check-result-item.js +1 -1
  157. package/dist/esm-es5/models/authenticity-check-result.js +1 -1
  158. package/dist/esm-es5/models/authenticity-result-all-of.js +1 -1
  159. package/dist/esm-es5/models/authenticity-result-type.js +72 -3
  160. package/dist/esm-es5/models/authenticity-result.js +1 -1
  161. package/dist/esm-es5/models/bc-pdf417-info.js +14 -0
  162. package/dist/esm-es5/models/bc-roidetect.js +14 -0
  163. package/dist/esm-es5/models/check-diagnose.js +37 -4
  164. package/dist/esm-es5/models/check-result.js +1 -1
  165. package/dist/esm-es5/models/chosen-document-type-result-all-of.js +1 -1
  166. package/dist/esm-es5/models/chosen-document-type-result.js +1 -1
  167. package/dist/esm-es5/models/chosen-document-type.js +1 -1
  168. package/dist/esm-es5/models/container-list.js +1 -1
  169. package/dist/esm-es5/models/critical.js +1 -1
  170. package/dist/esm-es5/models/cross-source-value-comparison.js +1 -1
  171. package/dist/esm-es5/models/data-module.js +14 -0
  172. package/dist/esm-es5/models/details-optical.js +1 -1
  173. package/dist/esm-es5/models/details-rfid.js +1 -1
  174. package/dist/esm-es5/models/device-info.js +1 -1
  175. package/dist/esm-es5/models/doc-bar-code-info-all-of.js +14 -0
  176. package/dist/esm-es5/models/doc-bar-code-info.js +14 -0
  177. package/dist/esm-es5/models/doc-visual-extended-field.js +1 -1
  178. package/dist/esm-es5/models/doc-visual-extended-info.js +1 -1
  179. package/dist/esm-es5/models/document-format.js +1 -1
  180. package/dist/esm-es5/models/document-image-result-all-of.js +1 -1
  181. package/dist/esm-es5/models/document-image-result.js +1 -1
  182. package/dist/esm-es5/models/document-image.js +1 -1
  183. package/dist/esm-es5/models/document-position-result-all-of.js +14 -0
  184. package/dist/esm-es5/models/document-position-result.js +14 -0
  185. package/dist/esm-es5/models/document-position.js +14 -0
  186. package/dist/esm-es5/models/document-type-recognition-result.js +1 -1
  187. package/dist/esm-es5/models/document-type.js +699 -5
  188. package/dist/esm-es5/models/document-types-candidates-list.js +1 -1
  189. package/dist/esm-es5/models/document-types-candidates-result-all-of.js +1 -1
  190. package/dist/esm-es5/models/document-types-candidates-result.js +1 -1
  191. package/dist/esm-es5/models/document-types-candidates.js +1 -1
  192. package/dist/esm-es5/models/encrypted-rclresult-all-of.js +14 -0
  193. package/dist/esm-es5/models/encrypted-rclresult.js +14 -0
  194. package/dist/esm-es5/models/face-api-search.js +14 -0
  195. package/dist/esm-es5/models/face-api.js +14 -0
  196. package/dist/esm-es5/models/fdsidlist.js +1 -1
  197. package/dist/esm-es5/models/fiber-result-all-of.js +1 -1
  198. package/dist/esm-es5/models/fiber-result.js +1 -1
  199. package/dist/esm-es5/models/graphic-field-type.js +14 -2
  200. package/dist/esm-es5/models/graphic-field.js +1 -1
  201. package/dist/esm-es5/models/graphic-fields-list.js +1 -1
  202. package/dist/esm-es5/models/graphics-result-all-of.js +1 -1
  203. package/dist/esm-es5/models/graphics-result.js +1 -1
  204. package/dist/esm-es5/models/ident-result-all-of.js +1 -1
  205. package/dist/esm-es5/models/ident-result.js +1 -1
  206. package/dist/esm-es5/models/image-data.js +1 -1
  207. package/dist/esm-es5/models/image-qa.js +1 -1
  208. package/dist/esm-es5/models/image-quality-check-list.js +1 -1
  209. package/dist/esm-es5/models/image-quality-check-type.js +10 -2
  210. package/dist/esm-es5/models/image-quality-check.js +1 -1
  211. package/dist/esm-es5/models/image-quality-result-all-of.js +1 -1
  212. package/dist/esm-es5/models/image-quality-result.js +1 -1
  213. package/dist/esm-es5/models/images-available-source.js +1 -1
  214. package/dist/esm-es5/models/images-field-value.js +1 -1
  215. package/dist/esm-es5/models/images-field.js +1 -1
  216. package/dist/esm-es5/models/images-result-all-of.js +1 -1
  217. package/dist/esm-es5/models/images-result.js +1 -1
  218. package/dist/esm-es5/models/images.js +1 -1
  219. package/dist/esm-es5/models/index.js +22 -1
  220. package/dist/esm-es5/models/lcid.js +28 -28
  221. package/dist/esm-es5/models/lexical-analysis-result-all-of.js +1 -1
  222. package/dist/esm-es5/models/lexical-analysis-result.js +1 -1
  223. package/dist/esm-es5/models/license-result-all-of.js +14 -0
  224. package/dist/esm-es5/models/license-result.js +14 -0
  225. package/dist/esm-es5/models/light.js +1 -1
  226. package/dist/esm-es5/models/list-verified-fields.js +1 -1
  227. package/dist/esm-es5/models/log-level.js +42 -0
  228. package/dist/esm-es5/models/measure-system.js +1 -1
  229. package/dist/esm-es5/models/mrzformat.js +46 -0
  230. package/dist/esm-es5/models/ocrsecurity-text-result-all-of.js +1 -1
  231. package/dist/esm-es5/models/ocrsecurity-text-result.js +1 -1
  232. package/dist/esm-es5/models/one-candidate.js +1 -1
  233. package/dist/esm-es5/models/original-symbol.js +1 -1
  234. package/dist/esm-es5/models/parray-field.js +14 -0
  235. package/dist/esm-es5/models/parsing-notification-codes.js +894 -0
  236. package/dist/esm-es5/models/per-document-config.js +14 -0
  237. package/dist/esm-es5/models/photo-ident-result-all-of.js +1 -1
  238. package/dist/esm-es5/models/photo-ident-result.js +1 -1
  239. package/dist/esm-es5/models/point-array.js +1 -1
  240. package/dist/esm-es5/models/point.js +1 -1
  241. package/dist/esm-es5/models/points-container.js +1 -1
  242. package/dist/esm-es5/models/process-params-rfid.js +14 -0
  243. package/dist/esm-es5/models/process-params.js +1 -1
  244. package/dist/esm-es5/models/process-request-image.js +1 -1
  245. package/dist/esm-es5/models/process-request.js +1 -1
  246. package/dist/esm-es5/models/process-response.js +1 -1
  247. package/dist/esm-es5/models/process-system-info.js +1 -1
  248. package/dist/esm-es5/models/processing-status.js +1 -1
  249. package/dist/esm-es5/models/raw-image-container-list.js +1 -1
  250. package/dist/esm-es5/models/rectangle-coordinates.js +1 -1
  251. package/dist/esm-es5/models/result-item.js +1 -1
  252. package/dist/esm-es5/models/result.js +57 -29
  253. package/dist/esm-es5/models/rfid-location.js +1 -1
  254. package/dist/esm-es5/models/rfid-origin.js +1 -1
  255. package/dist/esm-es5/models/scenario.js +57 -3
  256. package/dist/esm-es5/models/security-feature-result-all-of.js +1 -1
  257. package/dist/esm-es5/models/security-feature-result.js +1 -1
  258. package/dist/esm-es5/models/security-feature-type.js +152 -3
  259. package/dist/esm-es5/models/source-validity.js +1 -1
  260. package/dist/esm-es5/models/source.js +17 -2
  261. package/dist/esm-es5/models/status-result-all-of.js +1 -1
  262. package/dist/esm-es5/models/status-result.js +1 -1
  263. package/dist/esm-es5/models/status.js +1 -1
  264. package/dist/esm-es5/models/string-recognition-result.js +1 -1
  265. package/dist/esm-es5/models/symbol-candidate.js +1 -1
  266. package/dist/esm-es5/models/symbol-recognition-result.js +1 -1
  267. package/dist/esm-es5/models/text-available-source.js +1 -1
  268. package/dist/esm-es5/models/text-data-result-all-of.js +1 -1
  269. package/dist/esm-es5/models/text-data-result.js +1 -1
  270. package/dist/esm-es5/models/text-field-type.js +651 -435
  271. package/dist/esm-es5/models/text-field-value.js +1 -1
  272. package/dist/esm-es5/models/text-field.js +1 -1
  273. package/dist/esm-es5/models/text-post-processing.js +38 -0
  274. package/dist/esm-es5/models/text-result-all-of.js +1 -1
  275. package/dist/esm-es5/models/text-result.js +1 -1
  276. package/dist/esm-es5/models/text.js +1 -1
  277. package/dist/esm-es5/models/transaction-info.js +1 -1
  278. package/dist/esm-es5/models/verification-result.js +1 -1
  279. package/dist/esm-es5/models/verified-field-map.js +1 -1
  280. package/dist/esm-es5/models/visibility.js +17 -2
  281. package/package.json +5 -3
  282. package/setup.sh +11 -0
  283. package/src/api/default-api.ts +16 -8
  284. package/src/api/process-api.ts +16 -8
  285. package/src/base.ts +1 -1
  286. package/src/configuration.ts +1 -1
  287. package/src/ext/authenticity/authenticity.ts +8 -1
  288. package/src/ext/document-reader.ts +18 -7
  289. package/src/ext/images.ts +3 -5
  290. package/src/ext/process-request-image.ts +1 -1
  291. package/src/ext/process-request.ts +8 -2
  292. package/src/ext/process-response.ts +56 -12
  293. package/src/ext/result-item.ts +5 -5
  294. package/src/ext/text-field.ts +168 -18
  295. package/src/index.ts +1 -0
  296. package/src/models/area-array.ts +3 -3
  297. package/src/models/area-container.ts +1 -1
  298. package/src/models/authenticity-check-list.ts +7 -1
  299. package/src/models/authenticity-check-result-item.ts +2 -2
  300. package/src/models/authenticity-check-result.ts +1 -1
  301. package/src/models/authenticity-result-all-of.ts +1 -1
  302. package/src/models/authenticity-result-type.ts +72 -3
  303. package/src/models/authenticity-result.ts +5 -1
  304. package/src/models/bc-pdf417-info.ts +61 -0
  305. package/src/models/bc-roidetect.ts +49 -0
  306. package/src/models/check-diagnose.ts +36 -3
  307. package/src/models/check-result.ts +1 -1
  308. package/src/models/chosen-document-type-result-all-of.ts +1 -1
  309. package/src/models/chosen-document-type-result.ts +5 -1
  310. package/src/models/chosen-document-type.ts +1 -1
  311. package/src/models/container-list.ts +13 -3
  312. package/src/models/critical.ts +1 -1
  313. package/src/models/cross-source-value-comparison.ts +1 -1
  314. package/src/models/data-module.ts +55 -0
  315. package/src/models/details-optical.ts +1 -1
  316. package/src/models/details-rfid.ts +1 -1
  317. package/src/models/device-info.ts +1 -1
  318. package/src/models/doc-bar-code-info-all-of.ts +38 -0
  319. package/src/models/doc-bar-code-info.ts +42 -0
  320. package/src/models/doc-visual-extended-field.ts +1 -1
  321. package/src/models/doc-visual-extended-info.ts +1 -1
  322. package/src/models/document-format.ts +1 -1
  323. package/src/models/document-image-result-all-of.ts +1 -1
  324. package/src/models/document-image-result.ts +5 -1
  325. package/src/models/document-image.ts +1 -1
  326. package/src/models/document-position-result-all-of.ts +32 -0
  327. package/src/models/document-position-result.ts +42 -0
  328. package/src/models/document-position.ts +87 -0
  329. package/src/models/document-type-recognition-result.ts +1 -1
  330. package/src/models/document-type.ts +699 -5
  331. package/src/models/document-types-candidates-list.ts +1 -1
  332. package/src/models/document-types-candidates-result-all-of.ts +1 -1
  333. package/src/models/document-types-candidates-result.ts +5 -1
  334. package/src/models/document-types-candidates.ts +1 -1
  335. package/src/models/encrypted-rclresult-all-of.ts +31 -0
  336. package/src/models/encrypted-rclresult.ts +40 -0
  337. package/src/models/face-api-search.ts +43 -0
  338. package/src/models/face-api.ts +74 -0
  339. package/src/models/fdsidlist.ts +1 -1
  340. package/src/models/fiber-result-all-of.ts +1 -1
  341. package/src/models/fiber-result.ts +1 -1
  342. package/src/models/graphic-field-type.ts +14 -2
  343. package/src/models/graphic-field.ts +1 -1
  344. package/src/models/graphic-fields-list.ts +1 -1
  345. package/src/models/graphics-result-all-of.ts +1 -1
  346. package/src/models/graphics-result.ts +5 -1
  347. package/src/models/ident-result-all-of.ts +3 -3
  348. package/src/models/ident-result.ts +1 -1
  349. package/src/models/image-data.ts +1 -1
  350. package/src/models/image-qa.ts +31 -1
  351. package/src/models/image-quality-check-list.ts +1 -1
  352. package/src/models/image-quality-check-type.ts +10 -2
  353. package/src/models/image-quality-check.ts +1 -1
  354. package/src/models/image-quality-result-all-of.ts +1 -1
  355. package/src/models/image-quality-result.ts +5 -1
  356. package/src/models/images-available-source.ts +1 -1
  357. package/src/models/images-field-value.ts +7 -1
  358. package/src/models/images-field.ts +1 -1
  359. package/src/models/images-result-all-of.ts +1 -1
  360. package/src/models/images-result.ts +5 -1
  361. package/src/models/images.ts +1 -1
  362. package/src/models/index.ts +21 -0
  363. package/src/models/lcid.ts +27 -27
  364. package/src/models/lexical-analysis-result-all-of.ts +1 -1
  365. package/src/models/lexical-analysis-result.ts +6 -2
  366. package/src/models/license-result-all-of.ts +31 -0
  367. package/src/models/license-result.ts +40 -0
  368. package/src/models/light.ts +1 -1
  369. package/src/models/list-verified-fields.ts +1 -1
  370. package/src/models/log-level.ts +46 -0
  371. package/src/models/measure-system.ts +1 -1
  372. package/src/models/mrzformat.ts +50 -0
  373. package/src/models/ocrsecurity-text-result-all-of.ts +1 -1
  374. package/src/models/ocrsecurity-text-result.ts +1 -1
  375. package/src/models/one-candidate.ts +1 -1
  376. package/src/models/original-symbol.ts +1 -1
  377. package/src/models/parray-field.ts +88 -0
  378. package/src/models/parsing-notification-codes.ts +898 -0
  379. package/src/models/per-document-config.ts +37 -0
  380. package/src/models/photo-ident-result-all-of.ts +1 -1
  381. package/src/models/photo-ident-result.ts +1 -1
  382. package/src/models/point-array.ts +1 -1
  383. package/src/models/point.ts +1 -1
  384. package/src/models/points-container.ts +1 -1
  385. package/src/models/process-params-rfid.ts +32 -0
  386. package/src/models/process-params.ts +213 -18
  387. package/src/models/process-request-image.ts +1 -1
  388. package/src/models/process-request.ts +27 -2
  389. package/src/models/process-response.ts +13 -1
  390. package/src/models/process-system-info.ts +1 -1
  391. package/src/models/processing-status.ts +1 -1
  392. package/src/models/raw-image-container-list.ts +1 -1
  393. package/src/models/rectangle-coordinates.ts +1 -1
  394. package/src/models/result-item.ts +5 -1
  395. package/src/models/result.ts +56 -28
  396. package/src/models/rfid-location.ts +1 -1
  397. package/src/models/rfid-origin.ts +1 -1
  398. package/src/models/scenario.ts +56 -2
  399. package/src/models/security-feature-result-all-of.ts +3 -3
  400. package/src/models/security-feature-result.ts +1 -1
  401. package/src/models/security-feature-type.ts +152 -3
  402. package/src/models/source-validity.ts +1 -1
  403. package/src/models/source.ts +16 -1
  404. package/src/models/status-result-all-of.ts +1 -1
  405. package/src/models/status-result.ts +5 -1
  406. package/src/models/status.ts +1 -1
  407. package/src/models/string-recognition-result.ts +1 -1
  408. package/src/models/symbol-candidate.ts +1 -1
  409. package/src/models/symbol-recognition-result.ts +1 -1
  410. package/src/models/text-available-source.ts +1 -1
  411. package/src/models/text-data-result-all-of.ts +1 -1
  412. package/src/models/text-data-result.ts +5 -1
  413. package/src/models/text-field-type.ts +651 -435
  414. package/src/models/text-field-value.ts +1 -1
  415. package/src/models/text-field.ts +1 -1
  416. package/src/models/text-post-processing.ts +42 -0
  417. package/src/models/text-result-all-of.ts +1 -1
  418. package/src/models/text-result.ts +5 -1
  419. package/src/models/text.ts +1 -1
  420. package/src/models/transaction-info.ts +1 -1
  421. package/src/models/verification-result.ts +1 -1
  422. package/src/models/verified-field-map.ts +1 -1
  423. package/src/models/visibility.ts +16 -1
  424. package/tsconfig.commonjs.json +1 -1
  425. package/tsconfig.esm.json +1 -1
  426. package/update-models.sh +1 -0
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,38 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Regula Document Reader Web API
5
+ * 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
6
+ *
7
+ * The version of the OpenAPI document: 6.8.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ *
16
+ * @export
17
+ * @enum {string}
18
+ */
19
+ export var TextPostProcessing;
20
+ (function (TextPostProcessing) {
21
+ /**
22
+ * Do not change
23
+ */
24
+ TextPostProcessing[TextPostProcessing["NO_CHANGE"] = 0] = "NO_CHANGE";
25
+ /**
26
+ * Uppercase
27
+ */
28
+ TextPostProcessing[TextPostProcessing["UPPERCASE"] = 1] = "UPPERCASE";
29
+ /**
30
+ * Lowercase
31
+ */
32
+ TextPostProcessing[TextPostProcessing["LOWERCASE"] = 2] = "LOWERCASE";
33
+ /**
34
+ * Capital
35
+ */
36
+ TextPostProcessing[TextPostProcessing["CAPITAL"] = 3] = "CAPITAL";
37
+ })(TextPostProcessing || (TextPostProcessing = {}));
38
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGV4dC1wb3N0LXByb2Nlc3NpbmcuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbW9kZWxzL3RleHQtcG9zdC1wcm9jZXNzaW5nLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLG9CQUFvQjtBQUNwQixvQkFBb0I7QUFDcEI7Ozs7Ozs7Ozs7R0FVRztBQUlIOzs7O0dBSUc7QUFDSCxNQUFNLENBQU4sSUFBWSxrQkFpQlg7QUFqQkQsV0FBWSxrQkFBa0I7SUFDMUI7O01BRUU7SUFDRixxRUFBYSxDQUFBO0lBQ2I7O01BRUU7SUFDRixxRUFBYSxDQUFBO0lBQ2I7O01BRUU7SUFDRixxRUFBYSxDQUFBO0lBQ2I7O01BRUU7SUFDRixpRUFBVyxDQUFBO0FBQ2YsQ0FBQyxFQWpCVyxrQkFBa0IsS0FBbEIsa0JBQWtCLFFBaUI3QiJ9
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,10 +18,25 @@
18
18
  */
19
19
  export var Visibility;
20
20
  (function (Visibility) {
21
+ /**
22
+ * Invisible
23
+ */
21
24
  Visibility[Visibility["INVISIBLE"] = 0] = "INVISIBLE";
25
+ /**
26
+ * Visible
27
+ */
22
28
  Visibility[Visibility["VISIBLE"] = 1] = "VISIBLE";
29
+ /**
30
+ * Colored
31
+ */
23
32
  Visibility[Visibility["COLORED"] = 2] = "COLORED";
33
+ /**
34
+ * Grayscale
35
+ */
24
36
  Visibility[Visibility["GRAYSCALE"] = 4] = "GRAYSCALE";
37
+ /**
38
+ * Visible vs IR match
39
+ */
25
40
  Visibility[Visibility["WHITE_IR_MATCHING"] = 8] = "WHITE_IR_MATCHING";
26
41
  })(Visibility || (Visibility = {}));
27
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmlzaWJpbGl0eS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9tb2RlbHMvdmlzaWJpbGl0eS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxvQkFBb0I7QUFDcEIsb0JBQW9CO0FBQ3BCOzs7Ozs7Ozs7O0dBVUc7QUFJSDs7OztHQUlHO0FBQ0gsTUFBTSxDQUFOLElBQVksVUFNWDtBQU5ELFdBQVksVUFBVTtJQUNsQixxREFBYSxDQUFBO0lBQ2IsaURBQVcsQ0FBQTtJQUNYLGlEQUFXLENBQUE7SUFDWCxxREFBYSxDQUFBO0lBQ2IscUVBQXFCLENBQUE7QUFDekIsQ0FBQyxFQU5XLFVBQVUsS0FBVixVQUFVLFFBTXJCIn0=
42
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmlzaWJpbGl0eS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9tb2RlbHMvdmlzaWJpbGl0eS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxvQkFBb0I7QUFDcEIsb0JBQW9CO0FBQ3BCOzs7Ozs7Ozs7O0dBVUc7QUFJSDs7OztHQUlHO0FBQ0gsTUFBTSxDQUFOLElBQVksVUFxQlg7QUFyQkQsV0FBWSxVQUFVO0lBQ2xCOztNQUVFO0lBQ0YscURBQWEsQ0FBQTtJQUNiOztNQUVFO0lBQ0YsaURBQVcsQ0FBQTtJQUNYOztNQUVFO0lBQ0YsaURBQVcsQ0FBQTtJQUNYOztNQUVFO0lBQ0YscURBQWEsQ0FBQTtJQUNiOztNQUVFO0lBQ0YscUVBQXFCLENBQUE7QUFDekIsQ0FBQyxFQXJCVyxVQUFVLEtBQVYsVUFBVSxRQXFCckIifQ==
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@regulaforensics/document-reader-webclient",
3
- "version": "5.5.1",
3
+ "version": "5.5.5",
4
4
  "description": "Regula Document Reader js client for the browser and node.js based on axios",
5
5
  "author": "Regula Forensics, Inc.",
6
6
  "keywords": [
@@ -31,10 +31,12 @@
31
31
  "build": "npm run clean && npm run format && npm run build-cjs && npm run build-esm && echo '{\"type\": \"commonjs\"}' > ./dist/cjs-es5/package.json"
32
32
  },
33
33
  "dependencies": {
34
- "axios": "^0.21.1",
35
- "base64-arraybuffer": "^0.2.0"
34
+ "axios": "^0.21.4",
35
+ "base64-arraybuffer": "^0.2.0",
36
+ "pako": "^2.0.3"
36
37
  },
37
38
  "devDependencies": {
39
+ "@types/pako": "^1.0.1",
38
40
  "@typescript-eslint/eslint-plugin": "^3.5.0",
39
41
  "@typescript-eslint/parser": "^3.5.0",
40
42
  "eslint": "^7.4.0",
package/setup.sh ADDED
@@ -0,0 +1,11 @@
1
+ npm install
2
+
3
+ npm run build
4
+
5
+ cd ./example || exit
6
+
7
+ npm install
8
+
9
+ export API_BASE_PATH="https://testapi.regulaforensics.com"
10
+
11
+ node index.js
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,10 +29,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
29
29
  /**
30
30
  *
31
31
  * @summary Server health check
32
+ * @param {string} [xRequestID]
32
33
  * @param {*} [options] Override http request option.
33
34
  * @throws {RequiredError}
34
35
  */
35
- ping: async (options: any = {}): Promise<RequestArgs> => {
36
+ ping: async (xRequestID?: string, options: any = {}): Promise<RequestArgs> => {
36
37
  const localVarPath = `/api/ping`;
37
38
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
38
39
  const localVarUrlObj = new URL(localVarPath, 'https://example.com');
@@ -45,6 +46,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
45
46
  const localVarHeaderParameter = {} as any;
46
47
  const localVarQueryParameter = {} as any;
47
48
 
49
+ if (xRequestID !== undefined && xRequestID !== null) {
50
+ localVarHeaderParameter['X-RequestID'] = String(xRequestID);
51
+ }
52
+
48
53
 
49
54
 
50
55
  const queryParameters = new URLSearchParams(localVarUrlObj.search);
@@ -75,11 +80,12 @@ export const DefaultApiFp = function(configuration?: Configuration) {
75
80
  /**
76
81
  *
77
82
  * @summary Server health check
83
+ * @param {string} [xRequestID]
78
84
  * @param {*} [options] Override http request option.
79
85
  * @throws {RequiredError}
80
86
  */
81
- async ping(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfo>> {
82
- const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).ping(options);
87
+ async ping(xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfo>> {
88
+ const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).ping(xRequestID, options);
83
89
  return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
84
90
  const axiosRequestArgs = {...localVarAxiosArgs.options, url: (configuration?.basePath || basePath) + localVarAxiosArgs.url};
85
91
  return axios.request(axiosRequestArgs);
@@ -97,11 +103,12 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
97
103
  /**
98
104
  *
99
105
  * @summary Server health check
106
+ * @param {string} [xRequestID]
100
107
  * @param {*} [options] Override http request option.
101
108
  * @throws {RequiredError}
102
109
  */
103
- ping(options?: any): AxiosPromise<DeviceInfo> {
104
- return DefaultApiFp(configuration).ping(options).then((request) => request(axios, basePath));
110
+ ping(xRequestID?: string, options?: any): AxiosPromise<DeviceInfo> {
111
+ return DefaultApiFp(configuration).ping(xRequestID, options).then((request) => request(axios, basePath));
105
112
  },
106
113
  };
107
114
  };
@@ -116,11 +123,12 @@ export class DefaultApi extends BaseAPI {
116
123
  /**
117
124
  *
118
125
  * @summary Server health check
126
+ * @param {string} [xRequestID]
119
127
  * @param {*} [options] Override http request option.
120
128
  * @throws {RequiredError}
121
129
  * @memberof DefaultApi
122
130
  */
123
- public ping(options?: any) {
124
- return DefaultApiFp(this.configuration).ping(options).then((request) => request(this.axios, this.basePath));
131
+ public ping(xRequestID?: string, options?: any) {
132
+ return DefaultApiFp(this.configuration).ping(xRequestID, options).then((request) => request(this.axios, this.basePath));
125
133
  }
126
134
  }
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,10 +32,11 @@ export const ProcessApiAxiosParamCreator = function (configuration?: Configurati
32
32
  *
33
33
  * @summary Process list of documents images and return extracted data
34
34
  * @param {ProcessRequest} processRequest
35
+ * @param {string} [xRequestID]
35
36
  * @param {*} [options] Override http request option.
36
37
  * @throws {RequiredError}
37
38
  */
38
- apiProcess: async (processRequest: ProcessRequest, options: any = {}): Promise<RequestArgs> => {
39
+ apiProcess: async (processRequest: ProcessRequest, xRequestID?: string, options: any = {}): Promise<RequestArgs> => {
39
40
  // verify required parameter 'processRequest' is not null or undefined
40
41
  if (processRequest === null || processRequest === undefined) {
41
42
  throw new RequiredError('processRequest','Required parameter processRequest was null or undefined when calling apiProcess.');
@@ -52,6 +53,10 @@ export const ProcessApiAxiosParamCreator = function (configuration?: Configurati
52
53
  const localVarHeaderParameter = {} as any;
53
54
  const localVarQueryParameter = {} as any;
54
55
 
56
+ if (xRequestID !== undefined && xRequestID !== null) {
57
+ localVarHeaderParameter['X-RequestID'] = String(xRequestID);
58
+ }
59
+
55
60
 
56
61
 
57
62
  localVarHeaderParameter['Content-Type'] = 'application/json';
@@ -92,11 +97,12 @@ export const ProcessApiFp = function(configuration?: Configuration) {
92
97
  *
93
98
  * @summary Process list of documents images and return extracted data
94
99
  * @param {ProcessRequest} processRequest
100
+ * @param {string} [xRequestID]
95
101
  * @param {*} [options] Override http request option.
96
102
  * @throws {RequiredError}
97
103
  */
98
- async apiProcess(processRequest: ProcessRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProcessResponse>> {
99
- const localVarAxiosArgs = await ProcessApiAxiosParamCreator(configuration).apiProcess(processRequest, options);
104
+ async apiProcess(processRequest: ProcessRequest, xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProcessResponse>> {
105
+ const localVarAxiosArgs = await ProcessApiAxiosParamCreator(configuration).apiProcess(processRequest, xRequestID, options);
100
106
  return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
101
107
  const axiosRequestArgs = {...localVarAxiosArgs.options, url: (configuration?.basePath || basePath) + localVarAxiosArgs.url};
102
108
  return axios.request(axiosRequestArgs);
@@ -115,11 +121,12 @@ export const ProcessApiFactory = function (configuration?: Configuration, basePa
115
121
  *
116
122
  * @summary Process list of documents images and return extracted data
117
123
  * @param {ProcessRequest} processRequest
124
+ * @param {string} [xRequestID]
118
125
  * @param {*} [options] Override http request option.
119
126
  * @throws {RequiredError}
120
127
  */
121
- apiProcess(processRequest: ProcessRequest, options?: any): AxiosPromise<ProcessResponse> {
122
- return ProcessApiFp(configuration).apiProcess(processRequest, options).then((request) => request(axios, basePath));
128
+ apiProcess(processRequest: ProcessRequest, xRequestID?: string, options?: any): AxiosPromise<ProcessResponse> {
129
+ return ProcessApiFp(configuration).apiProcess(processRequest, xRequestID, options).then((request) => request(axios, basePath));
123
130
  },
124
131
  };
125
132
  };
@@ -135,11 +142,12 @@ export class ProcessApi extends BaseAPI {
135
142
  *
136
143
  * @summary Process list of documents images and return extracted data
137
144
  * @param {ProcessRequest} processRequest
145
+ * @param {string} [xRequestID]
138
146
  * @param {*} [options] Override http request option.
139
147
  * @throws {RequiredError}
140
148
  * @memberof ProcessApi
141
149
  */
142
- public apiProcess(processRequest: ProcessRequest, options?: any) {
143
- return ProcessApiFp(this.configuration).apiProcess(processRequest, options).then((request) => request(this.axios, this.basePath));
150
+ public apiProcess(processRequest: ProcessRequest, xRequestID?: string, options?: any) {
151
+ return ProcessApiFp(this.configuration).apiProcess(processRequest, xRequestID, options).then((request) => request(this.axios, this.basePath));
144
152
  }
145
153
  }
package/src/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -48,7 +48,6 @@ export class Authenticity implements BaseAuthenticityCheckList {
48
48
  return this.imageIdentOrUndefined(AuthenticityResultType.IPI);
49
49
  }
50
50
 
51
-
52
51
  public embedImageChecks(): SecurityFeatureChecks | undefined {
53
52
  return this.securityFeatureOrUndefined(AuthenticityResultType.PHOTO_EMBED_TYPE);
54
53
  }
@@ -77,6 +76,14 @@ export class Authenticity implements BaseAuthenticityCheckList {
77
76
  return this.identOrUndefined(AuthenticityResultType.LETTER_SCREEN);
78
77
  }
79
78
 
79
+ public hologramDetectionChecks(): IdentChecks | undefined {
80
+ return this.identOrUndefined(AuthenticityResultType.HOLOGRAM_DETECTION);
81
+ }
82
+
83
+ public mrzChecks(): SecurityFeatureChecks | undefined {
84
+ return this.securityFeatureOrUndefined(AuthenticityResultType.EXTENDED_MRZ_CHECK);
85
+ }
86
+
80
87
  public resultByType(authenticityType: number): AuthenticityCheckResult | undefined {
81
88
  for (const result of this.List) {
82
89
  if (result.Type == authenticityType) {
@@ -1,6 +1,13 @@
1
1
  import {DefaultApi} from "../api/default-api.js";
2
2
  import {ProcessApi} from "../api/process-api.js";
3
- import {Light, ProcessRequest as ProcessRequestBase, Scenario, Result} from "../models/index.js";
3
+ import {
4
+ Light,
5
+ ProcessRequest as ProcessRequestBase,
6
+ Scenario,
7
+ Result,
8
+
9
+ DeviceInfo
10
+ } from "../models/index.js";
4
11
  import {Response} from "./process-response.js";
5
12
  import {Configuration} from "../configuration.js";
6
13
  import globalAxios, {AxiosInstance} from "axios";
@@ -8,9 +15,7 @@ import {BASE_PATH} from "../base.js";
8
15
  import {ProcessRequestImage as ProcessRequestImageBase} from "../models/index.js";
9
16
  import {Base64String, instanceOfProcessRequest, ProcessRequest} from "./process-request.js";
10
17
  import {ProcessRequestImage} from "./process-request-image.js";
11
-
12
- // @ts-ignore
13
- import converter from "base64-arraybuffer";
18
+ import * as converter from "base64-arraybuffer";
14
19
 
15
20
 
16
21
  export class DocumentReaderApi {
@@ -25,14 +30,19 @@ export class DocumentReaderApi {
25
30
  this.processApi = new ProcessApi(configuration, basePath, axios)
26
31
  }
27
32
 
33
+ ping(xRequestID?: string): Promise<DeviceInfo> {
34
+ return this.defaultApi.ping(xRequestID)
35
+ .then((axiosResult) => axiosResult.data);
36
+ }
37
+
28
38
  /**
29
39
  *
30
40
  * @summary Process list of documents images and return extracted data
31
- * @param {ProcessRequest} [processRequest] Request options such as image, results types and etc.
41
+ * @param {ProcessRequest} [request] Request options such as image, results types and etc.
32
42
  * @param {*} [options] Override http request option.
33
43
  * @throws {RequiredError} If some request params are missed
34
44
  * */
35
- process(request: ProcessRequest | ProcessRequestBase, options?: any): Promise<Response> {
45
+ process(request: ProcessRequest | ProcessRequestBase, xRequestID?: string, options?: any): Promise<Response> {
36
46
  let baseRequest;
37
47
 
38
48
  if (instanceOfProcessRequest(request)) {
@@ -53,9 +63,10 @@ export class DocumentReaderApi {
53
63
  baseRequest = requestToBaseRequest(request)
54
64
  } else {
55
65
  baseRequest = request
66
+ console.log();
56
67
  }
57
68
 
58
- return this.processApi.apiProcess(baseRequest, options)
69
+ return this.processApi.apiProcess(baseRequest, xRequestID, options)
59
70
  .then((axiosResult) => new Response(axiosResult.data));
60
71
  }
61
72
 
package/src/ext/images.ts CHANGED
@@ -4,9 +4,7 @@ import {
4
4
  ImagesField as BaseImagesField,
5
5
  ImagesAvailableSource, ImagesFieldValue, Source
6
6
  } from "../models/index.js";
7
-
8
- // @ts-ignore
9
- import converter from "base64-arraybuffer";
7
+ import * as converter from "base64-arraybuffer";
10
8
 
11
9
  export class Images implements BaseImages {
12
10
 
@@ -39,7 +37,7 @@ export class ImagesField implements BaseImagesField {
39
37
  valueList: Array<ImagesFieldValue>;
40
38
 
41
39
  constructor(origin: BaseImagesField) {
42
- this.fieldType = origin.fieldType
40
+ this.fieldName = origin.fieldName
43
41
  this.fieldType = origin.fieldType
44
42
  this.valueList = origin.valueList
45
43
  }
@@ -58,7 +56,7 @@ export class ImagesField implements BaseImagesField {
58
56
  return undefined
59
57
  }
60
58
 
61
- if (original) {
59
+ if (original && fieldValue.originalValue) {
62
60
  return base64ToBuffer(fieldValue.originalValue)
63
61
  }
64
62
  return base64ToBuffer(fieldValue.value)
@@ -3,4 +3,4 @@ import {Base64String} from "./process-request.js";
3
3
 
4
4
  export interface ProcessRequestImage extends Omit<ProcessRequestImageBase, 'ImageData'> {
5
5
  ImageData: ArrayBuffer | Base64String
6
- }
6
+ }
@@ -1,4 +1,4 @@
1
- import {ProcessParams, ProcessSystemInfo} from "../models/index.js";
1
+ import {ContainerList, ProcessParams, ProcessSystemInfo} from "../models/index.js";
2
2
  import {ProcessRequestImage} from "./process-request-image.js";
3
3
 
4
4
  export type Base64String = string;
@@ -10,7 +10,7 @@ export interface ProcessRequest {
10
10
  * @type {ProcessParams}
11
11
  * @memberof ProcessRequest
12
12
  */
13
- processParam?: ProcessParams;
13
+ processParam: ProcessParams;
14
14
 
15
15
  /**
16
16
  *
@@ -19,6 +19,12 @@ export interface ProcessRequest {
19
19
  */
20
20
  images: Array<ProcessRequestImage | ArrayBuffer | Base64String>;
21
21
 
22
+ /**
23
+ * @type {ContainerList}
24
+ * @memberOf ProcessRequest
25
+ */
26
+ ContainerList: ContainerList
27
+
22
28
  /**
23
29
  *
24
30
  * @type {ProcessParams}