scanbot-web-sdk 6.0.0-dev.6 → 7.0.0-dev.1

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 (281) hide show
  1. package/@types/barcode-scanner-view.d.ts +1 -1
  2. package/@types/core/bridge/compiled/{BarcodeConfigs.d.ts → BarcodeConfigurationTypes.d.ts} +558 -173
  3. package/@types/core/bridge/compiled/BarcodeDocumentTypes.d.ts +14 -13
  4. package/@types/core/bridge/compiled/BarcodeScannerTypes.d.ts +25 -14
  5. package/@types/core/bridge/compiled/BarcodeTypes.d.ts +58 -56
  6. package/@types/core/bridge/compiled/CheckScannerTypes.d.ts +67 -0
  7. package/@types/core/bridge/compiled/CommonFieldType.d.ts +29 -28
  8. package/@types/core/bridge/compiled/CreditCardTypes.d.ts +35 -33
  9. package/@types/core/bridge/compiled/DocumentDataExtractorConfigurationTypes.d.ts +148 -0
  10. package/@types/core/bridge/compiled/DocumentDataExtractorTypes.d.ts +90 -0
  11. package/@types/core/bridge/compiled/DocumentQualityAnalyzerTypes.d.ts +28 -23
  12. package/@types/core/bridge/compiled/{DocumentDetectorTypes.d.ts → DocumentScannerTypes.d.ts} +49 -47
  13. package/@types/core/bridge/compiled/{EhicTypes.d.ts → EuropeanHealthInsuranceCardTypes.d.ts} +51 -108
  14. package/@types/core/bridge/compiled/FrameAccumulationTypes.d.ts +37 -14
  15. package/@types/core/bridge/compiled/GenericDocument.d.ts +17 -17
  16. package/@types/core/bridge/compiled/Geometry.d.ts +2 -2
  17. package/@types/core/bridge/compiled/ImageTypes.d.ts +1 -0
  18. package/@types/core/bridge/compiled/LicensePlateScannerTypes.d.ts +20 -19
  19. package/@types/core/bridge/compiled/MedicalCertificateTypes.d.ts +108 -105
  20. package/@types/core/bridge/compiled/MrzTypes.d.ts +73 -0
  21. package/@types/core/bridge/compiled/ParametricFilters.d.ts +4 -3
  22. package/@types/core/bridge/compiled/{PdfConfig.d.ts → PdfConfigurationTypes.d.ts} +48 -45
  23. package/@types/core/bridge/compiled/{GenericTextLineScannerTypes.d.ts → TextPatternScannerTypes.d.ts} +23 -22
  24. package/@types/core/bridge/compiled/TiffTypes.d.ts +48 -50
  25. package/@types/core/bridge/worker-bridge.d.ts +488 -364
  26. package/@types/core/worker/ScanbotSDK.Core.d.ts +21 -21
  27. package/@types/core-types.d.ts +10 -12
  28. package/@types/cropping-view.d.ts +8 -4
  29. package/@types/document-data-extractor-view.d.ts +22 -0
  30. package/@types/document-scanner-view.d.ts +16 -7
  31. package/@types/index.d.ts +36 -23
  32. package/@types/interfaces/i-cropping-view-handle.d.ts +2 -0
  33. package/@types/interfaces/i-document-data-extractor-scanner-handle.d.ts +3 -0
  34. package/@types/interfaces/{i-text-data-scanner-handle.d.ts → i-text-pattern-scanner-handle.d.ts} +1 -1
  35. package/@types/model/configuration/barcode-scanner-configuration.d.ts +1 -0
  36. package/@types/model/configuration/cropping-view-configuration.d.ts +1 -0
  37. package/@types/model/configuration/document-data-extractor-configuration.d.ts +9 -0
  38. package/@types/model/configuration/document-scanner-configuration.d.ts +8 -4
  39. package/@types/model/configuration/initialization-options.d.ts +1 -2
  40. package/@types/model/configuration/mrz-scanner-configuration.d.ts +4 -4
  41. package/@types/model/configuration/selection-overlay-configuration.d.ts +5 -0
  42. package/@types/model/configuration/text-pattern-scanner-configuration.d.ts +9 -0
  43. package/@types/model/configuration/view-finder-scanner-configuration.d.ts +2 -1
  44. package/@types/model/configuration/vin-scanner-configuration.d.ts +3 -3
  45. package/@types/scanbot-sdk.d.ts +269 -205
  46. package/@types/scanner-view.d.ts +2 -0
  47. package/@types/service/document-data-extractor.d.ts +13 -0
  48. package/@types/service/ocr-engine.d.ts +3 -3
  49. package/@types/service/pdf-generator.d.ts +6 -1
  50. package/@types/service/simple-mrz-recognizer.d.ts +4 -4
  51. package/@types/service/storage/indexed-db/sb-indexed-db.d.ts +60 -0
  52. package/@types/service/storage/local/sb-local-storage.d.ts +11 -0
  53. package/@types/service/storage/sb-storage.d.ts +33 -0
  54. package/@types/service/storage/utils/create-worker-vite.d.ts +1 -0
  55. package/@types/service/storage/utils/create-worker.d.ts +1 -0
  56. package/@types/service/storage/utils/sb-storage-error.d.ts +5 -0
  57. package/@types/service/storage/utils/sb-storage-utils.d.ts +10 -0
  58. package/@types/service/text-pattern-scanner.d.ts +14 -0
  59. package/@types/service/tiff-generator.d.ts +7 -4
  60. package/@types/{text-data-scanner-view.d.ts → text-pattern-scanner-view.d.ts} +9 -9
  61. package/@types/ui2/{controllers → barcode/controllers}/barcode-scanner-controller.d.ts +1 -1
  62. package/@types/ui2/{controllers → barcode/controllers}/multiple-scanning-mode-controller.d.ts +1 -1
  63. package/@types/ui2/{controllers → barcode/controllers}/single-scanning-mode-controller.d.ts +1 -1
  64. package/@types/ui2/{model → barcode/model}/counted-barcodes.d.ts +2 -2
  65. package/@types/ui2/{utils → barcode/utils}/barcode-mapper/expected-barcode-mapper.d.ts +2 -2
  66. package/@types/ui2/{utils → barcode/utils}/barcode-mapper/i-barcode-mapper.d.ts +2 -2
  67. package/@types/ui2/{utils → barcode/utils}/barcode-mapper/user-barcode-mapper.d.ts +1 -1
  68. package/@types/ui2/{utils → barcode/utils}/camera-config.d.ts +2 -2
  69. package/@types/ui2/{utils → barcode/utils}/styled-badge.d.ts +3 -1
  70. package/@types/ui2/{utils → barcode/utils}/styled-box.d.ts +1 -1
  71. package/@types/ui2/barcode/utils/styled-button.d.ts +14 -0
  72. package/@types/ui2/{utils → barcode/utils}/useScanningViewSize.d.ts +1 -1
  73. package/@types/ui2/{views → barcode/views}/action-button/action-button-container.d.ts +3 -3
  74. package/@types/ui2/{views → barcode/views}/action-button/action-button.d.ts +1 -1
  75. package/@types/ui2/{views → barcode/views}/ar/ar-badge.d.ts +2 -2
  76. package/@types/ui2/{views → barcode/views}/ar/ar-overlay-barcode-info.d.ts +2 -2
  77. package/@types/ui2/{views → barcode/views}/ar/vertical-positions.d.ts +2 -2
  78. package/@types/ui2/{views → barcode/views}/barcode-info/barcode-info.d.ts +1 -1
  79. package/@types/ui2/{views → barcode/views}/barcode-scanner.d.ts +8 -8
  80. package/@types/ui2/{views → barcode/views}/camera-permission-denied.d.ts +1 -1
  81. package/@types/ui2/{views → barcode/views}/dialog/barcode-info-dialog.d.ts +1 -1
  82. package/@types/ui2/{views → barcode/views}/dialog/barcode-mapping-error-dialog.d.ts +1 -1
  83. package/@types/ui2/{views → barcode/views}/dialog/base/confirmation-dialog.d.ts +1 -1
  84. package/@types/ui2/{views → barcode/views}/dialog/base/styled-dialog.d.ts +1 -0
  85. package/@types/ui2/{views → barcode/views}/dialog/count-edit-dialog.d.ts +1 -1
  86. package/@types/ui2/{views → barcode/views}/dialog/find-and-pick-submit-dialog.d.ts +1 -1
  87. package/@types/ui2/{views → barcode/views}/drawer/barcode-result-drawer.d.ts +1 -1
  88. package/@types/ui2/{views → barcode/views}/drawer/barcode-result-sidebar.d.ts +1 -1
  89. package/@types/ui2/{views → barcode/views}/drawer/counting-button.d.ts +1 -1
  90. package/@types/ui2/{views → barcode/views}/drawer/hooks/use-drag-listener.d.ts +1 -1
  91. package/@types/ui2/{views → barcode/views}/drawer/subviews/barcode-drawer-empty-state.d.ts +1 -1
  92. package/@types/ui2/{views → barcode/views}/drawer/subviews/barcode-list-item.d.ts +1 -1
  93. package/@types/ui2/{views → barcode/views}/drawer/subviews/barcode-list.d.ts +1 -1
  94. package/@types/ui2/{views → barcode/views}/drawer/subviews/drawer-header-content.d.ts +1 -1
  95. package/@types/ui2/{views → barcode/views}/drawer/subviews/swipe-underlay.d.ts +1 -1
  96. package/@types/ui2/{views → barcode/views}/form/dialog-button.d.ts +4 -1
  97. package/@types/ui2/{views → barcode/views}/navigation-bar.d.ts +1 -1
  98. package/@types/ui2/{views → barcode/views}/styled-text.d.ts +2 -1
  99. package/@types/ui2/configuration/DocumentQualityAnalyzerTypes.d.ts +1 -0
  100. package/@types/ui2/configuration/DocumentScannerTypes.d.ts +1 -0
  101. package/@types/ui2/configuration/Geometry.d.ts +1 -1
  102. package/@types/ui2/configuration/ParametricFilters.d.ts +1 -0
  103. package/@types/ui2/configuration/{ActionBarConfiguration.d.ts → barcode/ActionBarConfiguration.d.ts} +1 -1
  104. package/@types/ui2/configuration/{ArTrackingOverlayConfiguration.d.ts → barcode/ArTrackingOverlayConfiguration.d.ts} +1 -1
  105. package/@types/ui2/configuration/{BarcodeInfoMapping.d.ts → barcode/BarcodeInfoMapping.d.ts} +1 -1
  106. package/@types/ui2/configuration/{BarcodeRecognizerConfiguration.d.ts → barcode/BarcodeRecognizerConfiguration.d.ts} +3 -3
  107. package/@types/ui2/configuration/{BarcodeScannerConfiguration.d.ts → barcode/BarcodeScannerConfiguration.d.ts} +1 -1
  108. package/@types/ui2/configuration/barcode/BarcodeScannerTypes.d.ts +2 -0
  109. package/@types/ui2/configuration/{BarcodeScannerUIResult.d.ts → barcode/BarcodeScannerUIResult.d.ts} +1 -1
  110. package/@types/ui2/configuration/{BarcodeTextLocalization.d.ts → barcode/BarcodeTextLocalization.d.ts} +1 -1
  111. package/@types/ui2/configuration/barcode/BarcodeTypes.d.ts +1 -0
  112. package/@types/ui2/configuration/{CameraConfiguration.d.ts → barcode/CameraConfiguration.d.ts} +1 -1
  113. package/@types/ui2/configuration/{CameraPermission.d.ts → barcode/CameraPermission.d.ts} +1 -1
  114. package/@types/ui2/configuration/{Common.d.ts → barcode/Common.d.ts} +1 -1
  115. package/@types/ui2/configuration/barcode/CommonFieldType.d.ts +1 -0
  116. package/@types/ui2/configuration/{FindAndPickScanningModeUseCase.d.ts → barcode/FindAndPickScanningModeUseCase.d.ts} +1 -1
  117. package/@types/ui2/configuration/barcode/GenericDocument.d.ts +1 -0
  118. package/@types/ui2/configuration/barcode/Geometry.d.ts +1 -0
  119. package/@types/ui2/configuration/{MultipleScanningModeUseCase.d.ts → barcode/MultipleScanningModeUseCase.d.ts} +1 -1
  120. package/@types/ui2/configuration/{ScanbotAlertDialog.d.ts → barcode/ScanbotAlertDialog.d.ts} +1 -1
  121. package/@types/ui2/configuration/{SingleScanningModeUseCase.d.ts → barcode/SingleScanningModeUseCase.d.ts} +1 -1
  122. package/@types/ui2/configuration/{TopBarConfiguration.d.ts → barcode/TopBarConfiguration.d.ts} +1 -1
  123. package/@types/ui2/configuration/{UserGuidanceConfiguration.d.ts → barcode/UserGuidanceConfiguration.d.ts} +1 -1
  124. package/@types/ui2/configuration/{ViewFinderConfiguration.d.ts → barcode/ViewFinderConfiguration.d.ts} +1 -1
  125. package/@types/ui2/configuration/common/ActionBarConfiguration.d.ts +42 -0
  126. package/@types/ui2/configuration/common/CameraConfiguration.d.ts +60 -0
  127. package/@types/ui2/configuration/common/CameraPermission.d.ts +62 -0
  128. package/@types/ui2/configuration/common/Common.d.ts +467 -0
  129. package/@types/ui2/configuration/common/NavigationBarConfiguration.d.ts +11 -0
  130. package/@types/ui2/configuration/common/ScanbotAlertDialog.d.ts +74 -0
  131. package/@types/ui2/configuration/common/TopBarConfiguration.d.ts +55 -0
  132. package/@types/ui2/configuration/common/UserGuidanceConfiguration.d.ts +64 -0
  133. package/@types/ui2/configuration/common/ViewFinderConfiguration.d.ts +93 -0
  134. package/@types/ui2/configuration/document/AcknowledgementScreenConfiguration.d.ts +125 -0
  135. package/@types/ui2/configuration/document/CameraScreenConfiguration.d.ts +659 -0
  136. package/@types/ui2/configuration/document/CroppingConfiguration.d.ts +1 -0
  137. package/@types/ui2/configuration/document/CroppingResult.d.ts +1 -0
  138. package/@types/ui2/configuration/document/CroppingScreenConfiguration.d.ts +141 -0
  139. package/@types/ui2/configuration/document/CroppingTextLocalization.d.ts +1 -0
  140. package/@types/ui2/configuration/document/DocumentScannerCameraConfiguration.d.ts +60 -0
  141. package/@types/ui2/configuration/document/DocumentScannerGuidanceVisibility.d.ts +11 -0
  142. package/@types/ui2/configuration/document/DocumentScannerOutputSettings.d.ts +38 -0
  143. package/@types/ui2/configuration/document/DocumentScannerScreens.d.ts +26 -0
  144. package/@types/ui2/configuration/document/DocumentScannerTextLocalization.d.ts +608 -0
  145. package/@types/ui2/configuration/document/DocumentScannerUIResult.d.ts +5 -0
  146. package/@types/ui2/configuration/document/DocumentScannerUserGuidance.d.ts +99 -0
  147. package/@types/ui2/configuration/document/DocumentScanningFlow.d.ts +91 -0
  148. package/@types/ui2/configuration/document/IntroductionScreenConfiguration.d.ts +188 -0
  149. package/@types/ui2/configuration/document/ReorderPagesScreenConfiguration.d.ts +1 -0
  150. package/@types/ui2/configuration/document/ReviewScreenConfiguration.d.ts +372 -0
  151. package/@types/ui2/configuration/native/DocumentData.d.ts +37 -0
  152. package/@types/ui2/configuration/native/PageData.d.ts +58 -0
  153. package/@types/ui2/configuration/native/PageImageSource.d.ts +13 -0
  154. package/@types/ui2/configuration/utils.d.ts +8 -0
  155. package/@types/ui2/configuration.d.ts +46 -21
  156. package/@types/ui2/document/assets/auto-capture-disabled-icon.d.ts +4 -0
  157. package/@types/ui2/document/assets/auto-capture-icon.d.ts +4 -0
  158. package/@types/ui2/document/assets/captured-circle-icon.d.ts +5 -0
  159. package/@types/ui2/document/assets/delete-icon.d.ts +4 -0
  160. package/@types/ui2/document/assets/file-add-icon.d.ts +4 -0
  161. package/@types/ui2/document/assets/image-error-icon.d.ts +5 -0
  162. package/@types/ui2/document/assets/image-retake.d.ts +4 -0
  163. package/@types/ui2/document/assets/loading-spinner-icon.d.ts +2 -0
  164. package/@types/ui2/document/assets/shutter-button-auto-icon.d.ts +4 -0
  165. package/@types/ui2/document/assets/shutter-button-manual-icon.d.ts +5 -0
  166. package/@types/ui2/document/assets/shutter-button-spinner-icon.d.ts +4 -0
  167. package/@types/ui2/document/assets/the-hand.d.ts +10 -0
  168. package/@types/ui2/document/controller/acknowledgment-screen-controller.d.ts +16 -0
  169. package/@types/ui2/document/controller/camera-screen-controller.d.ts +20 -0
  170. package/@types/ui2/document/controller/cropping-screen-controller.d.ts +14 -0
  171. package/@types/ui2/document/controller/document-scanner-controller.d.ts +14 -0
  172. package/@types/ui2/document/controller/review-screen-controller.d.ts +18 -0
  173. package/@types/ui2/document/controller/zoom-screen-controller.d.ts +11 -0
  174. package/@types/ui2/document/model/document-detection-ui-result.d.ts +8 -0
  175. package/@types/ui2/document/model/sb-document.d.ts +62 -0
  176. package/@types/ui2/document/model/sb-page.d.ts +38 -0
  177. package/@types/ui2/document/model/utils/sb-document-data.d.ts +10 -0
  178. package/@types/ui2/document/model/utils/sb-page-data.d.ts +7 -0
  179. package/@types/ui2/document/utils/SBThemeProvider.d.ts +4 -0
  180. package/@types/ui2/document/utils/button-accessibility-styling.d.ts +40 -0
  181. package/@types/ui2/document/views/acknowledgement-screen/acknowledgement-confirmation.d.ts +19 -0
  182. package/@types/ui2/document/views/acknowledgement-screen/acknowledgement-fade.d.ts +9 -0
  183. package/@types/ui2/document/views/acknowledgement-screen/acknowledgement-image.d.ts +7 -0
  184. package/@types/ui2/document/views/acknowledgement-screen/acknowledgement-screen-bottom-bar.d.ts +12 -0
  185. package/@types/ui2/document/views/acknowledgement-screen/quality-insufficient-banner.d.ts +10 -0
  186. package/@types/ui2/document/views/camera-screen/bottom-bar.d.ts +33 -0
  187. package/@types/ui2/document/views/camera-screen/camera-permission-denied.d.ts +9 -0
  188. package/@types/ui2/document/views/camera-screen/camera-select-dropdown.d.ts +14 -0
  189. package/@types/ui2/document/views/camera-screen/introduction/assets/CheckIcon.d.ts +3 -0
  190. package/@types/ui2/document/views/camera-screen/introduction/assets/CreditCardsIcon.d.ts +3 -0
  191. package/@types/ui2/document/views/camera-screen/introduction/assets/DocumentsIcon.d.ts +3 -0
  192. package/@types/ui2/document/views/camera-screen/introduction/assets/IdCardsIcon.d.ts +3 -0
  193. package/@types/ui2/document/views/camera-screen/introduction/assets/MedicalCertsIcon.d.ts +3 -0
  194. package/@types/ui2/document/views/camera-screen/introduction/assets/Props.d.ts +3 -0
  195. package/@types/ui2/document/views/camera-screen/introduction/assets/ReceiptsIcon.d.ts +3 -0
  196. package/@types/ui2/document/views/camera-screen/introduction/introduction-image.d.ts +5 -0
  197. package/@types/ui2/document/views/camera-screen/introduction/introduction.d.ts +9 -0
  198. package/@types/ui2/document/views/camera-screen/preview-button.d.ts +11 -0
  199. package/@types/ui2/document/views/camera-screen/scanner-box.d.ts +21 -0
  200. package/@types/ui2/document/views/camera-screen/shutter-button.d.ts +10 -0
  201. package/@types/ui2/document/views/camera-screen/top-bar.d.ts +11 -0
  202. package/@types/ui2/document/views/camera-screen/top-user-guidance.d.ts +8 -0
  203. package/@types/ui2/document/views/camera-screen/use-document-scanner-view.d.ts +31 -0
  204. package/@types/ui2/document/views/camera-screen/user-guidance-text.d.ts +10 -0
  205. package/@types/ui2/document/views/common/alert-dialog.d.ts +11 -0
  206. package/@types/ui2/document/views/common/bar-button.d.ts +17 -0
  207. package/@types/ui2/document/views/common/common-top-bar.d.ts +12 -0
  208. package/@types/ui2/document/views/common/loading-spinner.d.ts +4 -0
  209. package/@types/ui2/document/views/common/styled-menu-item.d.ts +12 -0
  210. package/@types/ui2/document/views/common/styled-menu.d.ts +17 -0
  211. package/@types/ui2/document/views/review-screen/bottom-bar.d.ts +15 -0
  212. package/@types/ui2/document/views/review-screen/carousel-page.d.ts +13 -0
  213. package/@types/ui2/document/views/review-screen/carousel.d.ts +14 -0
  214. package/@types/ui2/document/views/review-screen/page-counter-and-zoom-button.d.ts +10 -0
  215. package/@types/ui2/document/views/review-screen/scroller-navigation-button.d.ts +11 -0
  216. package/@types/ui2/document/views/review-screen/top-bar.d.ts +11 -0
  217. package/@types/ui2/scanbot-sdk-ui.d.ts +4 -0
  218. package/@types/ui2/scanbot-ui-library.d.ts +7 -4
  219. package/@types/ui2/utils/text-styling.d.ts +8 -0
  220. package/@types/ui2/utils/use-time-since-first-render-has-passed.d.ts +1 -0
  221. package/@types/utils/constants.d.ts +0 -2
  222. package/@types/utils/dto/Frame.d.ts +2 -0
  223. package/@types/utils/image-utils.d.ts +1 -1
  224. package/@types/utils/parse-color.d.ts +9 -0
  225. package/@types/utils/react/useIsMounted.d.ts +2 -0
  226. package/@types/utils/react/usePromise.d.ts +4 -3
  227. package/@types/utils/supported-image-mime-types.d.ts +2 -0
  228. package/@types/utils/view-utils.d.ts +1 -1
  229. package/@types/view/barcode-polygon/animated-barcode-selection-overlay.d.ts +8 -2
  230. package/@types/view/polygon/document-polygon.d.ts +1 -0
  231. package/@types/worker/worker-bridge.d.ts +498 -374
  232. package/Libraries.txt +1510 -36
  233. package/bundle/ScanbotSDK.min.js +4 -4
  234. package/bundle/ScanbotSDK.ui2.min.js +18 -18
  235. package/bundle/ScanbotSDK.ui2.min.js.LICENSE.txt +10 -0
  236. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  237. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  238. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  239. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm +0 -0
  240. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  241. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js +1 -1
  242. package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js +1 -1
  243. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js +1 -1
  244. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  245. package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm +0 -0
  246. package/bundle/bin/complete/ScanbotSDK.Asm.wasm +0 -0
  247. package/bundle/bin/complete/ScanbotSDK.Core-simd-threads.js +1 -1
  248. package/bundle/bin/complete/ScanbotSDK.Core-simd.js +1 -1
  249. package/bundle/bin/complete/ScanbotSDK.Core.js +1 -1
  250. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  251. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  252. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  253. package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm +0 -0
  254. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  255. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js +1 -1
  256. package/bundle/bin/document-scanner/ScanbotSDK.Core.js +1 -1
  257. package/package.json +3 -3
  258. package/@types/core/bridge/compiled/CheckRecognizerTypes.d.ts +0 -29
  259. package/@types/core/bridge/compiled/FrameUtilities.d.ts +0 -18
  260. package/@types/core/bridge/compiled/GDRTypes.d.ts +0 -38
  261. package/@types/core/bridge/compiled/GenericDocumentRecognizerConfigs.d.ts +0 -150
  262. package/@types/core/bridge/compiled/GenericDocumentRecognizerTypes.d.ts +0 -83
  263. package/@types/core/bridge/compiled/GenericDocumentTypes.d.ts +0 -15
  264. package/@types/core/bridge/compiled/MRZTypes.d.ts +0 -52
  265. package/@types/generic-document-recognizer-view.d.ts +0 -22
  266. package/@types/interfaces/i-generic-document-recognizer-scanner-handle.d.ts +0 -3
  267. package/@types/model/configuration/generic-document-recognizer-configuration.d.ts +0 -9
  268. package/@types/model/configuration/text-data-scanner-configuration.d.ts +0 -9
  269. package/@types/service/generic-document-recognizer.d.ts +0 -13
  270. package/@types/service/text-data-recognizer.d.ts +0 -14
  271. package/@types/ui2/configuration/BarcodeScannerTypes.d.ts +0 -1
  272. package/@types/ui2/configuration/BarcodeTypes.d.ts +0 -1
  273. package/@types/ui2/configuration/CommonFieldType.d.ts +0 -1
  274. package/@types/ui2/configuration/GenericDocument.d.ts +0 -1
  275. package/@types/ui2/utils/styled-button.d.ts +0 -7
  276. /package/@types/core/bridge/compiled/{OcrElements.d.ts → OcrTypes.d.ts} +0 -0
  277. /package/@types/ui2/{utils → barcode/utils}/find-and-pick.ts/expected-barcode-counter.d.ts +0 -0
  278. /package/@types/ui2/{utils → barcode/utils}/styled-input.d.ts +0 -0
  279. /package/@types/ui2/{views → barcode/views}/drawer/subviews/barcode-drawer-header.d.ts +0 -0
  280. /package/@types/ui2/configuration/{BarcodeItemMapper.d.ts → barcode/BarcodeItemMapper.d.ts} +0 -0
  281. /package/@types/ui2/configuration/{BarcodeUseCase.d.ts → barcode/BarcodeUseCase.d.ts} +0 -0
@@ -4,29 +4,30 @@ import { DeepPartial, PartiallyConstructible } from "../common";
4
4
  Type of barcode document format used.
5
5
 
6
6
  - `AAMVA`:
7
- American Association of Motor Vehicle Administrators barcode document
7
+ American Association of Motor Vehicle Administrators barcode document.
8
8
  - `BOARDING_PASS`:
9
- Boarding pass barcode document
9
+ Boarding pass barcode document.
10
10
  - `DE_MEDICAL_PLAN`:
11
- German medication plan barcode document
11
+ German medication plan barcode document.
12
12
  - `MEDICAL_CERTIFICATE`:
13
- German medical certificate barcode document
13
+ German medical certificate barcode document.
14
14
  - `ID_CARD_PDF_417`:
15
- ID card barcode document
15
+ ID card barcode document.
16
16
  - `SEPA`:
17
- SEPA barcode (aka GiroCode) document
17
+ SEPA barcode (aka GiroCode) document.
18
18
  - `SWISS_QR`:
19
- Swiss QR barcode document
19
+ Swiss QR barcode document.
20
20
  - `VCARD`:
21
- VCard barcode document
21
+ VCard barcode document.
22
22
  - `GS1`:
23
- GS1 barcode document
23
+ GS1 barcode document.
24
24
  - `HIBC`:
25
- Health industry barcode document
25
+ Health industry barcode document.
26
26
  */
27
27
  export type BarcodeDocumentFormat = "AAMVA" | "BOARDING_PASS" | "DE_MEDICAL_PLAN" | "MEDICAL_CERTIFICATE" | "ID_CARD_PDF_417" | "SEPA" | "SWISS_QR" | "VCARD" | "GS1" | "HIBC";
28
+ export declare const BarcodeDocumentFormatValues: BarcodeDocumentFormat[];
28
29
  /**
29
- Barcode document formats
30
+ Barcode document formats.
30
31
  */
31
32
  export declare class BarcodeDocumentFormats extends PartiallyConstructible {
32
33
  /** @param source {@displayType `DeepPartial<BarcodeDocumentFormats>`} */
@@ -34,12 +35,12 @@ export declare class BarcodeDocumentFormats extends PartiallyConstructible {
34
35
  }
35
36
  export declare namespace BarcodeDocumentFormats {
36
37
  /**
37
- All barcode document formats
38
+ All barcode document formats.
38
39
  @defaultValue ["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
39
40
  */
40
41
  const all: BarcodeDocumentFormat[];
41
42
  /**
42
- Barcode types that are used to encode documents
43
+ Barcode types that are used to encode documents.
43
44
  @defaultValue {
44
45
  "AAMVA": ["PDF_417"],
45
46
  "ID_CARD_PDF_417": ["PDF_417"],
@@ -1,5 +1,5 @@
1
1
  import { BarcodeDocumentFormat } from "./BarcodeDocumentTypes";
2
- import { BarcodeFormatConfigurationBase } from "./BarcodeConfigs";
2
+ import { BarcodeFormatConfigurationBase } from "./BarcodeConfigurationTypes";
3
3
  import { BarcodeFormat } from "./BarcodeTypes";
4
4
  import { DeepPartial, PartiallyConstructible } from "../common";
5
5
  import { GenericDocument } from "./GenericDocument";
@@ -14,7 +14,7 @@ export declare class BarcodeItem extends PartiallyConstructible {
14
14
  */
15
15
  readonly text: string;
16
16
  /**
17
- Barcode format
17
+ Barcode format.
18
18
  @defaultValue "NONE";
19
19
  */
20
20
  readonly format: BarcodeFormat;
@@ -23,6 +23,10 @@ export declare class BarcodeItem extends PartiallyConstructible {
23
23
  */
24
24
  readonly quad: Point[];
25
25
  /**
26
+ The four corners of the barcode in the input image, in clockwise order starting from the top left, normalized to the range [0, 1].
27
+ */
28
+ readonly quadNormalized: Point[];
29
+ /**
26
30
  True if this is a 1D barcode that is printed upside-down, that is, the barcode was scanned right-to-left.
27
31
  @defaultValue false;
28
32
  */
@@ -59,17 +63,23 @@ export declare class BarcodeItem extends PartiallyConstructible {
59
63
  */
60
64
  readonly dataBarStackSize: number;
61
65
  /**
66
+ The size score is a floating point value between 0 and 1 that represents the relative size of the barcode in the input image.
67
+ Barcodes taking up a small portion of the input image will have a score close to 0, while barcodes that take a large portion will have a score close to 1.
68
+ @defaultValue 0.0;
69
+ */
70
+ readonly sizeScore: number;
71
+ /**
62
72
  The parsed known document format (if parsed successfully).
63
73
  */
64
- readonly parsedDocument: GenericDocument | null;
74
+ readonly extractedDocument: GenericDocument | null;
65
75
  /** @param source {@displayType `DeepPartial<BarcodeItem>`} */
66
76
  constructor(source?: DeepPartial<BarcodeItem>);
67
77
  }
68
78
  /**
69
- The engine mode for barcode scanning
79
+ The engine mode for barcode scanning.
70
80
 
71
81
  - `LEGACY`:
72
- Legacy mode. Very fast, significantly less accurate. Doesn't support all barcode types
82
+ Legacy mode. Very fast, significantly less accurate. Doesn't support all barcode types.
73
83
  - `NEXT_GEN_LOW_POWER`:
74
84
  A faster version of the main engine mode, for use with low-power devices.
75
85
  - `NEXT_GEN`:
@@ -80,40 +90,41 @@ The engine mode for barcode scanning
80
90
  Similar to NEXT_GEN, but optimized for AR.
81
91
  */
82
92
  export type BarcodeScannerEngineMode = "LEGACY" | "NEXT_GEN_LOW_POWER" | "NEXT_GEN" | "NEXT_GEN_LOW_POWER_AR" | "NEXT_GEN_AR";
93
+ export declare const BarcodeScannerEngineModeValues: BarcodeScannerEngineMode[];
83
94
  /**
84
- Configuration for the barcode scanner
95
+ Configuration for the barcode scanner.
85
96
  */
86
97
  export declare class BarcodeScannerConfiguration extends PartiallyConstructible {
87
98
  /**
88
- Options for barcode decoding
99
+ Options for barcode decoding.
89
100
  @defaultValue [new BarcodeFormatCommonConfiguration({})];
90
101
  */
91
102
  barcodeFormatConfigurations: BarcodeFormatConfigurationBase[];
92
103
  /**
93
- List of accepted barcode document formats.
94
- Barcodes that decode to one of the accepted document formats will have parsedDocument field in BarcodeItem populated with the parsed document.
104
+ List of document formats to be extracted.
105
+ Barcodes that decode to one of the extracted document formats will have extractedDocument field in BarcodeItem populated with the parsed document.
95
106
  By default all supported barcode document formats are accepted.
96
107
  If empty, no barcodes will be parsed into documents.
97
108
  @defaultValue ["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
98
109
  */
99
- acceptedDocumentFormats: BarcodeDocumentFormat[];
110
+ extractedDocumentFormats: BarcodeDocumentFormat[];
100
111
  /**
101
112
  If true and acceptedDocumentFormats is not empty, then barcodes that don't decode to one of the accepted document formats will be ignored.
102
113
  @defaultValue false;
103
114
  */
104
115
  onlyAcceptDocuments: boolean;
105
116
  /**
106
- If true, the barcode image will be returned in the BarcodeItem
117
+ If true, the barcode image will be returned in the BarcodeItem.
107
118
  @defaultValue true;
108
119
  */
109
120
  returnBarcodeImage: boolean;
110
121
  /**
111
- The engine mode for barcode scanning
122
+ The engine mode for barcode scanning.
112
123
  @defaultValue "NEXT_GEN_LOW_POWER";
113
124
  */
114
125
  engineMode: BarcodeScannerEngineMode;
115
126
  /**
116
- If true, the barcode recognition will be performed in live mode
127
+ If true, the barcode scanning will be performed in live mode.
117
128
  @defaultValue true;
118
129
  */
119
130
  live: boolean;
@@ -121,7 +132,7 @@ export declare class BarcodeScannerConfiguration extends PartiallyConstructible
121
132
  constructor(source?: DeepPartial<BarcodeScannerConfiguration>);
122
133
  }
123
134
  /**
124
- The result of barcode scanning
135
+ The result of barcode scanning.
125
136
  */
126
137
  export declare class BarcodeScannerResult extends PartiallyConstructible {
127
138
  /**
@@ -3,81 +3,82 @@ import { DeepPartial, PartiallyConstructible } from "../common";
3
3
  Enumerates barcode formats.
4
4
 
5
5
  - `NONE`:
6
- Used as a return value if no valid barcode has been detected
6
+ Used as a return value if no valid barcode has been detected.
7
7
  - `AZTEC`:
8
- Aztec (2D)
8
+ Aztec (2D).
9
9
  - `CODABAR`:
10
- CODABAR (1D)
10
+ CODABAR (1D).
11
11
  - `CODE_39`:
12
- Code 39 (1D)
12
+ Code 39 (1D).
13
13
  - `CODE_93`:
14
- Code 93 (1D)
14
+ Code 93 (1D).
15
15
  - `CODE_128`:
16
- Code 128 (1D)
16
+ Code 128 (1D).
17
17
  - `DATA_MATRIX`:
18
- Data Matrix (2D)
18
+ Data Matrix (2D).
19
19
  - `EAN_8`:
20
- EAN-8 (1D)
20
+ EAN-8 (1D).
21
21
  - `EAN_13`:
22
- EAN-13 (1D)
22
+ EAN-13 (1D).
23
23
  - `ITF`:
24
- ITF (Interleaved Two of Five) (1D)
25
- - `MAXICODE`:
26
- MaxiCode (2D)
24
+ ITF (Interleaved Two of Five) (1D).
25
+ - `MAXI_CODE`:
26
+ MaxiCode (2D).
27
27
  - `PDF_417`:
28
- PDF417 (2D)
28
+ PDF417 (2D).
29
29
  - `QR_CODE`:
30
- QR Code (2D)
30
+ QR Code (2D).
31
31
  - `DATABAR`:
32
- GS1 DataBar-14 (formerly RSS-14) (1D)
32
+ GS1 DataBar-14 (formerly RSS-14) (1D).
33
33
  - `DATABAR_EXPANDED`:
34
- GS1 DataBar Expanded (formerly RSS Expanded) (1D)
34
+ GS1 DataBar Expanded (formerly RSS Expanded) (1D).
35
35
  - `UPC_A`:
36
- UPC-A (1D)
36
+ UPC-A (1D).
37
37
  - `UPC_E`:
38
- UPC-E (1D)
38
+ UPC-E (1D).
39
39
  - `MSI_PLESSEY`:
40
- MSI PLESSEY
40
+ MSI PLESSEY.
41
41
  - `IATA_2_OF_5`:
42
- IATA 2 of 5 (1D)
42
+ IATA 2 of 5 (1D).
43
43
  - `INDUSTRIAL_2_OF_5`:
44
- INDUSTRIAL 2 of 5 (1D)
44
+ INDUSTRIAL 2 of 5 (1D).
45
45
  - `CODE_25`:
46
- CODE 25 (1D)
46
+ CODE 25 (1D).
47
47
  - `MICRO_QR_CODE`:
48
- Micro QR Code (2D)
48
+ Micro QR Code (2D).
49
49
  - `USPS_INTELLIGENT_MAIL`:
50
- USPS Intelligent Mail, a.k.a. USPS OneCode, USPS-STD-11
50
+ USPS Intelligent Mail, a.k.a. USPS OneCode, USPS-STD-11.
51
51
  - `ROYAL_MAIL`:
52
- Royal Mail Four-State Customer Code, a.k.a. RM4SCC, CBC, BPO 4 State Code
52
+ Royal Mail Four-State Customer Code, a.k.a. RM4SCC, CBC, BPO 4 State Code.
53
53
  - `JAPAN_POST`:
54
- Japan Post Four-State Barcode
54
+ Japan Post Four-State Barcode.
55
55
  - `ROYAL_TNT_POST`:
56
- Royal TNT Post Four-State Barcode, a.k.a. KIX, Klant IndeX
56
+ Royal TNT Post Four-State Barcode, a.k.a. KIX, Klant IndeX.
57
57
  - `AUSTRALIA_POST`:
58
- Australia Post Four-State Customer Code
58
+ Australia Post Four-State Customer Code.
59
59
  - `DATABAR_LIMITED`:
60
- GS1 DataBar Limited
60
+ GS1 DataBar Limited.
61
61
  - `MICRO_PDF_417`:
62
- Micro PDF417 (2D)
62
+ Micro PDF417 (2D).
63
63
  - `GS1_COMPOSITE`:
64
64
  GS1 COMPOSITE (combined linear and 2D).
65
65
  - `RMQR_CODE`:
66
- Rectangular Micro QR Code (2D)
66
+ Rectangular Micro QR Code (2D).
67
67
  - `CODE_11`:
68
- Code 11 (1D)
68
+ Code 11 (1D).
69
69
  - `CODE_32`:
70
- Code 32 (Italian Pharmacode) (1D)
70
+ Code 32 (Italian Pharmacode) (1D).
71
71
  - `PHARMA_CODE`:
72
- Pharmacode, a.k.a. One-Track Pharmacode, Pharmaceutical Binary Code (1D)
72
+ Pharmacode, a.k.a. One-Track Pharmacode, Pharmaceutical Binary Code (1D).
73
73
  - `PHARMA_CODE_TWO_TRACK`:
74
- Two-Track Pharmacode, a.k.a. Pharmaceutical Binary Code
74
+ Two-Track Pharmacode, a.k.a. Pharmaceutical Binary Code.
75
75
  - `PZN`:
76
- Pharmazentralnummer, a.k.a. PZN, PZN8, German Pharmaceutical Central Number (1D)
76
+ Pharmazentralnummer, a.k.a. PZN, PZN8, German Pharmaceutical Central Number (1D).
77
77
  */
78
- export type BarcodeFormat = "NONE" | "AZTEC" | "CODABAR" | "CODE_39" | "CODE_93" | "CODE_128" | "DATA_MATRIX" | "EAN_8" | "EAN_13" | "ITF" | "MAXICODE" | "PDF_417" | "QR_CODE" | "DATABAR" | "DATABAR_EXPANDED" | "UPC_A" | "UPC_E" | "MSI_PLESSEY" | "IATA_2_OF_5" | "INDUSTRIAL_2_OF_5" | "CODE_25" | "MICRO_QR_CODE" | "USPS_INTELLIGENT_MAIL" | "ROYAL_MAIL" | "JAPAN_POST" | "ROYAL_TNT_POST" | "AUSTRALIA_POST" | "DATABAR_LIMITED" | "MICRO_PDF_417" | "GS1_COMPOSITE" | "RMQR_CODE" | "CODE_11" | "CODE_32" | "PHARMA_CODE" | "PHARMA_CODE_TWO_TRACK" | "PZN";
78
+ export type BarcodeFormat = "NONE" | "AZTEC" | "CODABAR" | "CODE_39" | "CODE_93" | "CODE_128" | "DATA_MATRIX" | "EAN_8" | "EAN_13" | "ITF" | "MAXI_CODE" | "PDF_417" | "QR_CODE" | "DATABAR" | "DATABAR_EXPANDED" | "UPC_A" | "UPC_E" | "MSI_PLESSEY" | "IATA_2_OF_5" | "INDUSTRIAL_2_OF_5" | "CODE_25" | "MICRO_QR_CODE" | "USPS_INTELLIGENT_MAIL" | "ROYAL_MAIL" | "JAPAN_POST" | "ROYAL_TNT_POST" | "AUSTRALIA_POST" | "DATABAR_LIMITED" | "MICRO_PDF_417" | "GS1_COMPOSITE" | "RMQR_CODE" | "CODE_11" | "CODE_32" | "PHARMA_CODE" | "PHARMA_CODE_TWO_TRACK" | "PZN";
79
+ export declare const BarcodeFormatValues: BarcodeFormat[];
79
80
  /**
80
- Lists of barcode formats to decode
81
+ Lists of barcode formats to decode.
81
82
  */
82
83
  export declare class BarcodeFormats extends PartiallyConstructible {
83
84
  /** @param source {@displayType `DeepPartial<BarcodeFormats>`} */
@@ -85,33 +86,33 @@ export declare class BarcodeFormats extends PartiallyConstructible {
85
86
  }
86
87
  export declare namespace BarcodeFormats {
87
88
  /**
88
- List of 1D barcode formats
89
+ List of 1D barcode formats.
89
90
  @defaultValue ["CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_8", "EAN_13", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "MSI_PLESSEY", "PHARMA_CODE", "PZN", "UPC_A", "UPC_E"];
90
91
  */
91
92
  const oned: BarcodeFormat[];
92
93
  /**
93
- List of 2D barcode formats
94
- @defaultValue ["AZTEC", "DATA_MATRIX", "MAXICODE", "MICRO_QR_CODE", "MICRO_PDF_417", "PDF_417", "QR_CODE", "RMQR_CODE"];
94
+ List of 2D barcode formats.
95
+ @defaultValue ["AZTEC", "DATA_MATRIX", "MAXI_CODE", "MICRO_QR_CODE", "MICRO_PDF_417", "PDF_417", "QR_CODE", "RMQR_CODE"];
95
96
  */
96
97
  const twod: BarcodeFormat[];
97
98
  /**
98
- List of postal barcode formats
99
+ List of postal barcode formats.
99
100
  @defaultValue ["AUSTRALIA_POST", "JAPAN_POST", "ROYAL_MAIL", "ROYAL_TNT_POST", "USPS_INTELLIGENT_MAIL"];
100
101
  */
101
102
  const postal: BarcodeFormat[];
102
103
  /**
103
- List of pharmaceutical barcode formats
104
+ List of pharmaceutical barcode formats.
104
105
  @defaultValue ["CODE_32", "PHARMA_CODE", "PHARMA_CODE_TWO_TRACK", "PZN"];
105
106
  */
106
107
  const pharma: BarcodeFormat[];
107
108
  /**
108
- List of common barcode formats
109
+ List of common barcode formats.
109
110
  @defaultValue ["AZTEC", "CODABAR", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "ITF", "MICRO_QR_CODE", "PDF_417", "QR_CODE", "UPC_A", "UPC_E"];
110
111
  */
111
112
  const common: BarcodeFormat[];
112
113
  /**
113
- List of all barcode formats
114
- @defaultValue ["AUSTRALIA_POST", "AZTEC", "CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "GS1_COMPOSITE", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "JAPAN_POST", "MAXICODE", "MICRO_PDF_417", "MICRO_QR_CODE", "MSI_PLESSEY", "PDF_417", "PHARMA_CODE", "PHARMA_CODE_TWO_TRACK", "PZN", "QR_CODE", "RMQR_CODE", "ROYAL_MAIL", "ROYAL_TNT_POST", "UPC_A", "UPC_E", "USPS_INTELLIGENT_MAIL"];
114
+ List of all barcode formats.
115
+ @defaultValue ["AUSTRALIA_POST", "AZTEC", "CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "GS1_COMPOSITE", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "JAPAN_POST", "MAXI_CODE", "MICRO_PDF_417", "MICRO_QR_CODE", "MSI_PLESSEY", "PDF_417", "PHARMA_CODE", "PHARMA_CODE_TWO_TRACK", "PZN", "QR_CODE", "RMQR_CODE", "ROYAL_MAIL", "ROYAL_TNT_POST", "UPC_A", "UPC_E", "USPS_INTELLIGENT_MAIL"];
115
116
  */
116
117
  const all: BarcodeFormat[];
117
118
  }
@@ -139,7 +140,6 @@ visualize a GS1 message containing the \x1D character, you may see a number of d
139
140
  results, depending on how the system handles unprintable characters. You may see a question
140
141
  mark, a box, an escape sequence, a space or nothing at all.
141
142
 
142
-
143
143
  - `PARSE`:
144
144
  This is the default. GS1 messages are converted to the machine-readable format per
145
145
  the GS1 spec (the special FNC1 character is converted to ASCII \x1D).
@@ -157,23 +157,25 @@ mark, a box, an escape sequence, a space or nothing at all.
157
157
  - `DECODE_FULL`:
158
158
  Combines the validations of VALIDATE_FULL and the human-readable output format of DECODE_STRUCTURE.
159
159
  */
160
- export type GS1Handling = "PARSE" | "VALIDATE_STRUCTURE" | "DECODE_STRUCTURE" | "VALIDATE_FULL" | "DECODE_FULL";
160
+ export type Gs1Handling = "PARSE" | "VALIDATE_STRUCTURE" | "DECODE_STRUCTURE" | "VALIDATE_FULL" | "DECODE_FULL";
161
+ export declare const Gs1HandlingValues: Gs1Handling[];
161
162
  /**
162
163
  Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
163
164
 
164
- - `Require2`:
165
+ - `REQUIRE_2`:
165
166
  Only barcodes with a 2-digit extension are accepted.
166
- - `Require5`:
167
+ - `REQUIRE_5`:
167
168
  Only barcodes with a 5-digit extension are accepted.
168
- - `RequireAny`:
169
+ - `REQUIRE_ANY`:
169
170
  Only barcodes with either a 2-digit or a 5-digit extension are accepted.
170
- - `Ignore`:
171
+ - `IGNORE`:
171
172
  Always ignore the extension.
172
- - `Allow2`:
173
+ - `ALLOW_2`:
173
174
  Return detected 2-digit extension if present, but do not require it. Ignore the 5-digit extension.
174
- - `Allow5`:
175
+ - `ALLOW_5`:
175
176
  Return detected 5-digit extension if present, but do not require it. Ignore the 2-digit extension.
176
- - `AllowAny`:
177
+ - `ALLOW_ANY`:
177
178
  Return any detected extension if present, but do not require it.
178
179
  */
179
- export type UpcEanExtensionBehavior = "Require2" | "Require5" | "RequireAny" | "Ignore" | "Allow2" | "Allow5" | "AllowAny";
180
+ export type UpcEanExtensionBehavior = "REQUIRE_2" | "REQUIRE_5" | "REQUIRE_ANY" | "IGNORE" | "ALLOW_2" | "ALLOW_5" | "ALLOW_ANY";
181
+ export declare const UpcEanExtensionBehaviorValues: UpcEanExtensionBehavior[];
@@ -0,0 +1,67 @@
1
+ import { DeepPartial, PartiallyConstructible } from "../common";
2
+ import { DocumentDetectionResult } from "./DocumentScannerTypes";
3
+ import { GenericDocument } from "./GenericDocument";
4
+ import { RawImage } from "../common";
5
+ /**
6
+ Check document detection and extraction mode.
7
+
8
+ - `DISABLED`:
9
+ Document detection is not performed. Successful check scans will only contain the machine-readable check data without a full crop of the check.
10
+ - `DETECT_DOCUMENT`:
11
+ Document scanner will be used to locate the complete check in the input image. The documentDetectionResult field in the result will contain the result of document detection.
12
+ - `DETECT_AND_CROP_DOCUMENT`:
13
+ Document scanner will be used to locate the complete check in the input image. The documentDetectionResult result field will contain the result of document detection. The croppedImage result field will contain a crop of the entire check.
14
+ */
15
+ export type CheckDocumentDetectionMode = "DISABLED" | "DETECT_DOCUMENT" | "DETECT_AND_CROP_DOCUMENT";
16
+ export declare const CheckDocumentDetectionModeValues: CheckDocumentDetectionMode[];
17
+ /**
18
+ Check Scanning Status.
19
+
20
+ - `SUCCESS`:
21
+ Scanning successful.
22
+ - `VALIDATION_FAILED`:
23
+ A check was recognized, but validation failed, indication a standard violation, unsupported standard, or scanner error.
24
+ - `FAIL`:
25
+ No check was recognized.
26
+ */
27
+ export type CheckRecognitionStatus = "SUCCESS" | "VALIDATION_FAILED" | "FAIL";
28
+ export declare const CheckRecognitionStatusValues: CheckRecognitionStatus[];
29
+ /**
30
+ The result of check scanning.
31
+ */
32
+ export declare class CheckScanningResult extends PartiallyConstructible {
33
+ /**
34
+ Check recognition status.
35
+ @defaultValue "FAIL";
36
+ */
37
+ readonly status: CheckRecognitionStatus;
38
+ /**
39
+ Generic document containing check data. Not present, if status is FAIL.
40
+ */
41
+ readonly check: GenericDocument | null;
42
+ /**
43
+ The result of document detection. Will be set only if detectDocument in the configuration is set to true. Check scanning may still succeed even if the whole document is not visible in the input image and the complete document could not be located.
44
+ */
45
+ readonly documentDetectionResult: DocumentDetectionResult | null;
46
+ /**
47
+ Crop of the check if documentDetectionMode is set to DETECT_AND_CROP_DOCUMENT. Will be non-empty, only if check recognition succeeded.
48
+ */
49
+ readonly croppedImage: RawImage | null;
50
+ /** @param source {@displayType `DeepPartial<CheckScanningResult>`} */
51
+ constructor(source?: DeepPartial<CheckScanningResult>);
52
+ }
53
+ /**
54
+ Configuration of the check scanner.
55
+ */
56
+ export declare class CheckScannerConfiguration extends PartiallyConstructible {
57
+ /**
58
+ Document detection to be performed in addition to scanning the machine-readable data in the check.
59
+
60
+ By default only the machine-readable data is extracted during check scanning. Optionally, the coordinates and a crop of the entire check document can be returned, in addition to the check data.
61
+ A check scan result may still be successful even if the whole document is not visible in the input image and the complete document could not be located.
62
+ @defaultValue "DISABLED";
63
+ */
64
+ readonly documentDetectionMode: CheckDocumentDetectionMode;
65
+ /** @param source {@displayType `DeepPartial<CheckScannerConfiguration>`} */
66
+ constructor(source?: DeepPartial<CheckScannerConfiguration>);
67
+ }
@@ -1,59 +1,60 @@
1
1
  /**
2
- Common field types
2
+ Common field types.
3
3
 
4
4
  - `ID`:
5
- Document ID
5
+ Document ID.
6
6
  - `SURNAME`:
7
- Person surname field
7
+ Person surname field.
8
8
  - `MAIDEN_NAME`:
9
- Person maiden name field
9
+ Person maiden name field.
10
10
  - `GIVEN_NAMES`:
11
- Person given names field
11
+ Person given names field.
12
12
  - `BIRTH_DATE`:
13
- Person birth date field
13
+ Person birth date field.
14
14
  - `NATIONALITY`:
15
- Person nationality field
15
+ Person nationality field.
16
16
  - `BIRTHPLACE`:
17
- Person birthplace field
17
+ Person birthplace field.
18
18
  - `EXPIRY_DATE`:
19
- Document expiry date field
19
+ Document expiry date field.
20
20
  - `EYE_COLOR`:
21
- Person height field
21
+ Person height field.
22
22
  - `HEIGHT`:
23
- Person height field
23
+ Person height field.
24
24
  - `ISSUE_DATE`:
25
- Document issue date field
25
+ Document issue date field.
26
26
  - `ISSUING_AUTHORITY`:
27
- Document issuing authority field
27
+ Document issuing authority field.
28
28
  - `ADDRESS`:
29
- Address field
29
+ Address field.
30
30
  - `PSEUDONYM`:
31
- Pseudonym field
31
+ Pseudonym field.
32
32
  - `MRZ`:
33
- MRZ field
33
+ MRZ field.
34
34
  - `COUNTRY_CODE`:
35
- Country code (ISO-3166 Alpha-3) field
35
+ Country code (ISO-3166 Alpha-3) field.
36
36
  - `GENDER`:
37
- Gender field
37
+ Gender field.
38
38
  - `SIGNATURE`:
39
- Signature field
39
+ Signature field.
40
40
  - `PHOTO`:
41
- Photo field
41
+ Photo field.
42
42
  - `VALID_FROM_DATE`:
43
- Date of start of validity field
43
+ Date of start of validity field.
44
44
  - `ROUTING_NUMBER`:
45
- Check routing number
45
+ Check routing number.
46
46
  - `ACCOUNT_NUMBER`:
47
- Check account number
47
+ Check account number.
48
48
  - `PLACE_OF_ISSUE`:
49
- Place of issue for the identity card
49
+ Place of issue for the identity card.
50
50
  - `TITLE_TYPE`:
51
- Type of the title field in the identity document
51
+ Type of the title field in the identity document.
52
52
  - `REMARKS`:
53
- Remarks field in the identity document
53
+ Remarks field in the identity document.
54
54
  - `NAME`:
55
- Full name field
55
+ Full name field.
56
56
  - `CARD_ACCESS_NUMBER`:
57
- Card access number field
57
+ Card access number field.
58
58
  */
59
59
  export type CommonFieldType = "ID" | "SURNAME" | "MAIDEN_NAME" | "GIVEN_NAMES" | "BIRTH_DATE" | "NATIONALITY" | "BIRTHPLACE" | "EXPIRY_DATE" | "EYE_COLOR" | "HEIGHT" | "ISSUE_DATE" | "ISSUING_AUTHORITY" | "ADDRESS" | "PSEUDONYM" | "MRZ" | "COUNTRY_CODE" | "GENDER" | "SIGNATURE" | "PHOTO" | "VALID_FROM_DATE" | "ROUTING_NUMBER" | "ACCOUNT_NUMBER" | "PLACE_OF_ISSUE" | "TITLE_TYPE" | "REMARKS" | "NAME" | "CARD_ACCESS_NUMBER";
60
+ export declare const CommonFieldTypeValues: CommonFieldType[];
@@ -1,31 +1,32 @@
1
1
  import { DeepPartial, PartiallyConstructible } from "../common";
2
- import { DocumentDetectionStatus } from "./DocumentDetectorTypes";
2
+ import { DocumentDetectionStatus } from "./DocumentScannerTypes";
3
3
  import { GenericDocument } from "./GenericDocument";
4
4
  import { Point } from "../common";
5
- import { ResultAccumulationConfig } from "./FrameAccumulationTypes";
5
+ import { ResultAccumulationConfiguration } from "./FrameAccumulationTypes";
6
6
  /**
7
- The status of the recognition process
7
+ The status of the scanning process.
8
8
 
9
9
  - `SUCCESS`:
10
- The credit card was recognized successfully
10
+ The credit card was scanned successfully.
11
11
  - `ERROR_NOTHING_FOUND`:
12
- No credit card was detected
12
+ No credit card was detected.
13
13
  - `INCOMPLETE`:
14
- Not all required fields were found or confirmed
14
+ Not all required fields were found or confirmed.
15
15
  */
16
- export type CreditCardRecognitionStatus = "SUCCESS" | "ERROR_NOTHING_FOUND" | "INCOMPLETE";
16
+ export type CreditCardScanningStatus = "SUCCESS" | "ERROR_NOTHING_FOUND" | "INCOMPLETE";
17
+ export declare const CreditCardScanningStatusValues: CreditCardScanningStatus[];
17
18
  /**
18
- Contains the result of running the credit card recognizer
19
+ Contains the result of running the credit card scanner.
19
20
  */
20
- export declare class CreditCardRecognitionResult extends PartiallyConstructible {
21
+ export declare class CreditCardScanningResult extends PartiallyConstructible {
21
22
  /**
22
23
  The status of the credit card detection step
23
24
  */
24
25
  readonly detectionStatus: DocumentDetectionStatus;
25
26
  /**
26
- The status of the credit card recognition step
27
+ The status of the credit card scanning step
27
28
  */
28
- readonly recognitionStatus: CreditCardRecognitionStatus;
29
+ readonly scanningStatus: CreditCardScanningStatus;
29
30
  /**
30
31
  Generic document containing credit card data. Not present, if status is FAIL.
31
32
  */
@@ -33,50 +34,51 @@ export declare class CreditCardRecognitionResult extends PartiallyConstructible
33
34
  /**
34
35
  Coordinates of the detected credit card in the input image (clockwise from top-left)
35
36
  */
36
- readonly quad: Point[] | null;
37
- /** @param source {@displayType `DeepPartial<CreditCardRecognitionResult>`} */
38
- constructor(source?: DeepPartial<CreditCardRecognitionResult>);
37
+ readonly quad: Point[];
38
+ /** @param source {@displayType `DeepPartial<CreditCardScanningResult>`} */
39
+ constructor(source?: DeepPartial<CreditCardScanningResult>);
39
40
  }
40
41
  /**
41
- The recognition mode
42
+ The scanning mode.
42
43
 
43
44
  - `LIVE`:
44
- The recognizer will merge all information from multiple frames to provide the best possible result.
45
+ The scanner will merge all information from multiple frames to provide the best possible result.
45
46
  Use this mode when the input is a video or camera stream.
46
47
  - `SINGLE_SHOT`:
47
- The recognizer will only use the current frame and will spend additional time to ensure the best possible result. Use this mode when scanning single images, e.g. imported from the gallery.
48
+ The scanner will only use the current frame and will spend additional time to ensure the best possible result. Use this mode when scanning single images, e.g. imported from the gallery.
48
49
  */
49
- export type CreditCardRecognitionMode = "LIVE" | "SINGLE_SHOT";
50
+ export type CreditCardScanningMode = "LIVE" | "SINGLE_SHOT";
51
+ export declare const CreditCardScanningModeValues: CreditCardScanningMode[];
50
52
  /**
51
- Configuration for the credit card recognizer
53
+ Configuration for the credit card scanner.
52
54
  */
53
- export declare class CreditCardRecognizerConfiguration extends PartiallyConstructible {
55
+ export declare class CreditCardScannerConfiguration extends PartiallyConstructible {
54
56
  /**
55
57
  If true, the document detector will be used to find where the credit card is in the input image.
56
- If false, the recognizer will assume that the credit card has been pre-cropped and takes the entirety of the input image.
58
+ If false, the scanner will assume that the credit card has been pre-cropped and takes the entirety of the input image.
57
59
  @defaultValue true;
58
60
  */
59
- readonly useDocumentDetector: boolean;
61
+ useDocumentDetector: boolean;
60
62
  /**
61
- The recognition mode
63
+ The scanning mode.
62
64
  @defaultValue "LIVE";
63
65
  */
64
- readonly recognitionMode: CreditCardRecognitionMode;
66
+ scanningMode: CreditCardScanningMode;
65
67
  /**
66
- Whether the expiry date is required for a successful recognition
68
+ Whether the expiry date is required for a successful scanning.
67
69
  @defaultValue true;
68
70
  */
69
- readonly requireExpiryDate: boolean;
71
+ requireExpiryDate: boolean;
70
72
  /**
71
- Whether the cardholder name is required for a successful recognition
73
+ Whether the cardholder name is required for a successful scanning.
72
74
  @defaultValue true;
73
75
  */
74
- readonly requireCardholderName: boolean;
76
+ requireCardholderName: boolean;
75
77
  /**
76
- Configuration for how to accumulate results
77
- @defaultValue new ResultAccumulationConfig({});
78
+ Configuration for how to accumulate results.
79
+ @defaultValue new ResultAccumulationConfiguration({});
78
80
  */
79
- resultAccumulationConfig: ResultAccumulationConfig;
80
- /** @param source {@displayType `DeepPartial<CreditCardRecognizerConfiguration>`} */
81
- constructor(source?: DeepPartial<CreditCardRecognizerConfiguration>);
81
+ resultAccumulationConfig: ResultAccumulationConfiguration;
82
+ /** @param source {@displayType `DeepPartial<CreditCardScannerConfiguration>`} */
83
+ constructor(source?: DeepPartial<CreditCardScannerConfiguration>);
82
84
  }