scanbot-web-sdk 8.1.0-beta.1 → 8.1.0-beta.2

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 (66) hide show
  1. package/@types/core/bridge/worker-bridge.d.ts +28 -0
  2. package/@types/core/compiled/BarcodeScannerTypes.d.ts +13 -5
  3. package/@types/core/compiled/DocumentsModel.d.ts +443 -1
  4. package/@types/core/compiled/ParametricFilters.d.ts +36 -1
  5. package/@types/core/compiled/utils.d.ts +1 -1
  6. package/@types/core-types.d.ts +1 -1
  7. package/@types/model/configuration/document-scanner-view-configuration.d.ts +4 -0
  8. package/@types/model/configuration/scanner-configuration.d.ts +3 -0
  9. package/@types/scanbot-sdk.d.ts +14 -0
  10. package/@types/ui2/common.d.ts +1 -1
  11. package/@types/ui2/configuration/BarcodeTypes.d.ts +1 -1
  12. package/@types/ui2/configuration/barcode/BarcodeScannerScreenConfiguration.d.ts +2 -2
  13. package/@types/ui2/configuration/barcode/BarcodeUseCase.d.ts +3 -3
  14. package/@types/ui2/configuration/barcode/FindAndPickScanningModeUseCase.d.ts +4 -4
  15. package/@types/ui2/configuration/barcode/MultipleScanningModeUseCase.d.ts +2 -2
  16. package/@types/ui2/configuration/barcode/SingleScanningModeUseCase.d.ts +2 -2
  17. package/@types/ui2/configuration/check/CheckScannerScreenConfiguration.d.ts +4 -4
  18. package/@types/ui2/configuration/common/ActionBarConfiguration.d.ts +1 -1
  19. package/@types/ui2/configuration/common/CameraConfiguration.d.ts +6 -0
  20. package/@types/ui2/configuration/common/CameraPermission.d.ts +3 -3
  21. package/@types/ui2/configuration/common/Common.d.ts +19 -0
  22. package/@types/ui2/configuration/common/ScanCompletionOverlay.d.ts +1 -1
  23. package/@types/ui2/configuration/common/ScanbotAlertDialog.d.ts +2 -2
  24. package/@types/ui2/configuration/common/SelectCameraMenu.d.ts +3 -3
  25. package/@types/ui2/configuration/common/TopBarConfiguration.d.ts +3 -3
  26. package/@types/ui2/configuration/common/UserGuidanceConfiguration.d.ts +3 -3
  27. package/@types/ui2/configuration/common/ViewFinderConfiguration.d.ts +1 -1
  28. package/@types/ui2/configuration/credit_card/CreditCardScannerScreenConfiguration.d.ts +4 -4
  29. package/@types/ui2/configuration/document/CameraScreenConfiguration.d.ts +5 -5
  30. package/@types/ui2/configuration/document/DocumentScannerCameraConfiguration.d.ts +6 -0
  31. package/@types/ui2/configuration/document/DocumentScannerScreens.d.ts +3 -3
  32. package/@types/ui2/configuration/document/DocumentScannerUserGuidance.d.ts +1 -1
  33. package/@types/ui2/configuration/document/DocumentScanningFlow.d.ts +3 -3
  34. package/@types/ui2/configuration/document_data/DocumentDataExtractorScreenConfiguration.d.ts +4 -4
  35. package/@types/ui2/configuration/mrz/MRZScannerScreenConfiguration.d.ts +3 -3
  36. package/@types/ui2/configuration/native/DocumentData.d.ts +1 -1
  37. package/@types/ui2/configuration/native/PageData.d.ts +1 -1
  38. package/@types/ui2/configuration/text_pattern/TextPatternScannerScreenConfiguration.d.ts +2 -2
  39. package/@types/ui2/configuration/vin/VINScannerScreenConfiguration.d.ts +2 -2
  40. package/@types/utils/assets/camera-localization.d.ts +1 -1
  41. package/@types/view/scanbot-camera-view.d.ts +2 -0
  42. package/@types/worker/worker-bridge.d.ts +28 -0
  43. package/bundle/ScanbotSDK.min.js +3 -3
  44. package/bundle/ScanbotSDK.ui2.min.js +10 -10
  45. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  46. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  47. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  48. package/bundle/bin/barcode-scanner/ScanbotSDK.Asm.wasm +0 -0
  49. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  50. package/bundle/bin/barcode-scanner/ScanbotSDK.Core-simd.js +1 -1
  51. package/bundle/bin/barcode-scanner/ScanbotSDK.Core.js +1 -1
  52. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.js +1 -1
  53. package/bundle/bin/complete/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  54. package/bundle/bin/complete/ScanbotSDK.Asm-simd.wasm +0 -0
  55. package/bundle/bin/complete/ScanbotSDK.Asm.wasm +0 -0
  56. package/bundle/bin/complete/ScanbotSDK.Core-simd-threads.js +1 -1
  57. package/bundle/bin/complete/ScanbotSDK.Core-simd.js +1 -1
  58. package/bundle/bin/complete/ScanbotSDK.Core.js +1 -1
  59. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.js +1 -1
  60. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd-threads.wasm +0 -0
  61. package/bundle/bin/document-scanner/ScanbotSDK.Asm-simd.wasm +0 -0
  62. package/bundle/bin/document-scanner/ScanbotSDK.Asm.wasm +0 -0
  63. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd-threads.js +1 -1
  64. package/bundle/bin/document-scanner/ScanbotSDK.Core-simd.js +1 -1
  65. package/bundle/bin/document-scanner/ScanbotSDK.Core.js +1 -1
  66. package/package.json +1 -1
@@ -79,6 +79,13 @@ export declare class WorkerBridge {
79
79
  paperWhiteningBias?: number;
80
80
  } & {
81
81
  readonly _type: "ColorDocumentFilter";
82
+ }) | ({
83
+ contrastEnhancement?: number;
84
+ colorEnhancement?: number;
85
+ paperSaturation?: number;
86
+ paperLightness?: number;
87
+ } & {
88
+ readonly _type: "ColorDocumentShadowRemovalFilter";
82
89
  }) | ({
83
90
  brightness?: number;
84
91
  } & {
@@ -147,6 +154,13 @@ export declare class WorkerBridge {
147
154
  paperWhiteningBias?: number;
148
155
  } & {
149
156
  readonly _type: "ColorDocumentFilter";
157
+ }) | ({
158
+ contrastEnhancement?: number;
159
+ colorEnhancement?: number;
160
+ paperSaturation?: number;
161
+ paperLightness?: number;
162
+ } & {
163
+ readonly _type: "ColorDocumentShadowRemovalFilter";
150
164
  }) | ({
151
165
  brightness?: number;
152
166
  } & {
@@ -230,6 +244,13 @@ export declare class WorkerBridge {
230
244
  paperWhiteningBias?: number;
231
245
  } & {
232
246
  readonly _type: "ColorDocumentFilter";
247
+ }) | ({
248
+ contrastEnhancement?: number;
249
+ colorEnhancement?: number;
250
+ paperSaturation?: number;
251
+ paperLightness?: number;
252
+ } & {
253
+ readonly _type: "ColorDocumentShadowRemovalFilter";
233
254
  }) | ({
234
255
  brightness?: number;
235
256
  } & {
@@ -298,6 +319,13 @@ export declare class WorkerBridge {
298
319
  paperWhiteningBias?: number;
299
320
  } & {
300
321
  readonly _type: "ColorDocumentFilter";
322
+ }) | ({
323
+ contrastEnhancement?: number;
324
+ colorEnhancement?: number;
325
+ paperSaturation?: number;
326
+ paperLightness?: number;
327
+ } & {
328
+ readonly _type: "ColorDocumentShadowRemovalFilter";
301
329
  }) | ({
302
330
  brightness?: number;
303
331
  } & {
@@ -221,11 +221,6 @@ export declare class BarcodeScannerConfiguration {
221
221
  */
222
222
  returnBarcodeImage: boolean;
223
223
  /**
224
- The engine mode for barcode scanning.
225
- @defaultValue "NEXT_GEN_LOW_POWER";
226
- */
227
- engineMode: BarcodeScannerEngineMode;
228
- /**
229
224
  Configuration to accumulate barcodes across multiple frames in live mode.
230
225
  @defaultValue new BarcodeAccumulationConfiguration({});
231
226
  */
@@ -237,6 +232,19 @@ export declare class BarcodeScannerConfiguration {
237
232
  */
238
233
  optimizedForOverlays: boolean;
239
234
  /**
235
+ In single-shot mode, if the combined area of detected barcodes exceeds this fraction of the input image, the scanner returns the result immediately.
236
+ Further scanning is skipped, even if more barcodes may be present.
237
+ This can be used to accelerate scanning when barcode sizes are known in advance.
238
+ To disable this behaviour, the value must be set to 1.0.
239
+ @defaultValue 0.8;
240
+ */
241
+ directAcceptanceAreaFraction: number;
242
+ /**
243
+ The engine mode for barcode scanning.
244
+ @defaultValue "NEXT_GEN_LOW_POWER";
245
+ */
246
+ engineMode: BarcodeScannerEngineMode;
247
+ /**
240
248
  Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
241
249
 
242
250
  On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results.
@@ -1505,4 +1505,446 @@ export declare class MoIdentityCardFront {
1505
1505
  }
1506
1506
  export declare namespace MoIdentityCardFront {
1507
1507
  }
1508
- export type DocumentsModelRootType = typeof Metadata.DOCUMENT_TYPE | typeof MRZ.DOCUMENT_TYPE | typeof ParsedDeAddress.DOCUMENT_TYPE | typeof DeIdCardFront.DOCUMENT_TYPE | typeof DeIdCardBack.DOCUMENT_TYPE | typeof DePassport.DOCUMENT_TYPE | typeof EuropeanDriverLicenseFront.DOCUMENT_TYPE | typeof EuropeanDriverLicenseBack.DOCUMENT_TYPE | typeof DeResidencePermitFront.DOCUMENT_TYPE | typeof DeResidencePermitBack.DOCUMENT_TYPE | typeof EuropeanHealthInsuranceCard.DOCUMENT_TYPE | typeof DeHealthInsuranceCardFront.DOCUMENT_TYPE | typeof BrIdCardFront.DOCUMENT_TYPE | typeof BrIdCardBack.DOCUMENT_TYPE | typeof BrIdCardFrontPhotoOnly.DOCUMENT_TYPE | typeof CnEntryAndExitPermitBack.DOCUMENT_TYPE | typeof CnEntryAndExitPermitFront.DOCUMENT_TYPE | typeof CnPermanentResidentCardFront.DOCUMENT_TYPE | typeof HkIdentityCardFront.DOCUMENT_TYPE | typeof TwEntryAndExitPermit.DOCUMENT_TYPE | typeof MoIdentityCardBack.DOCUMENT_TYPE | typeof MoIdentityCardFront.DOCUMENT_TYPE;
1508
+ /** RoIdCardTD3 */
1509
+ export declare class RoIdCardTD3 {
1510
+ private _document;
1511
+ get document(): GenericDocument;
1512
+ static readonly DOCUMENT_TYPE = "RoIdCardTD3";
1513
+ static readonly ADDRESS_FIELD_NAME = "Address";
1514
+ static readonly ADDRESS_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Address";
1515
+ static readonly BIRTHPLACE_FIELD_NAME = "Birthplace";
1516
+ static readonly BIRTHPLACE_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Birthplace";
1517
+ static readonly EXPIRY_DATE_FIELD_NAME = "ExpiryDate";
1518
+ static readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED = "RoIdCardTD3.ExpiryDate";
1519
+ static readonly GENDER_FIELD_NAME = "Gender";
1520
+ static readonly GENDER_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Gender";
1521
+ static readonly GIVEN_NAMES_FIELD_NAME = "GivenNames";
1522
+ static readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED = "RoIdCardTD3.GivenNames";
1523
+ static readonly ID_FIELD_NAME = "ID";
1524
+ static readonly ID_FIELD_NAME_NORMALIZED = "RoIdCardTD3.ID";
1525
+ static readonly ISSUING_AUTHORITY_FIELD_NAME = "IssuingAuthority";
1526
+ static readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED = "RoIdCardTD3.IssuingAuthority";
1527
+ static readonly NATIONALITY_FIELD_NAME = "Nationality";
1528
+ static readonly NATIONALITY_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Nationality";
1529
+ static readonly PERSONAL_NUMBER_FIELD_NAME = "PersonalNumber";
1530
+ static readonly PERSONAL_NUMBER_FIELD_NAME_NORMALIZED = "RoIdCardTD3.PersonalNumber";
1531
+ static readonly PHOTO_FIELD_NAME = "Photo";
1532
+ static readonly PHOTO_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Photo";
1533
+ static readonly RAW_MRZ_FIELD_NAME = "RawMRZ";
1534
+ static readonly RAW_MRZ_FIELD_NAME_NORMALIZED = "RoIdCardTD3.RawMRZ";
1535
+ static readonly SURNAME_FIELD_NAME = "Surname";
1536
+ static readonly SURNAME_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Surname";
1537
+ static readonly VALID_FROM_DATE_FIELD_NAME = "ValidFromDate";
1538
+ static readonly VALID_FROM_DATE_FIELD_NAME_NORMALIZED = "RoIdCardTD3.ValidFromDate";
1539
+ constructor(document: GenericDocument);
1540
+ requiredDocumentType(): string;
1541
+ /** Address */
1542
+ get address(): Field;
1543
+ /** Birthplace */
1544
+ get birthplace(): Field;
1545
+ /** Expiry date */
1546
+ get expiryDate(): Field;
1547
+ /** Gender */
1548
+ get gender(): Field;
1549
+ /** Given Names */
1550
+ get givenNames(): Field;
1551
+ /** Series and number of the ID card */
1552
+ get id(): Field;
1553
+ /** Issuing authority */
1554
+ get issuingAuthority(): Field;
1555
+ /** Nationality */
1556
+ get nationality(): Field;
1557
+ /** Personal Number (CNP) */
1558
+ get personalNumber(): Field;
1559
+ /** Photo image */
1560
+ get photo(): Field;
1561
+ /** Raw MRZ text value */
1562
+ get rawMRZ(): Field;
1563
+ /** Surname */
1564
+ get surname(): Field;
1565
+ /** Valid from date */
1566
+ get validFromDate(): Field;
1567
+ /** The child document of type "MRZ". */
1568
+ get mrz(): MRZ;
1569
+ /** The child document of type "Metadata". */
1570
+ get metadata(): Metadata;
1571
+ }
1572
+ export declare namespace RoIdCardTD3 {
1573
+ }
1574
+ /** ItIdCardFront */
1575
+ export declare class ItIdCardFront {
1576
+ private _document;
1577
+ get document(): GenericDocument;
1578
+ static readonly DOCUMENT_TYPE = "ItIdCardFront";
1579
+ static readonly BIRTH_DATE_FIELD_NAME = "BirthDate";
1580
+ static readonly BIRTH_DATE_FIELD_NAME_NORMALIZED = "ItIdCardFront.BirthDate";
1581
+ static readonly BIRTHPLACE_FIELD_NAME = "Birthplace";
1582
+ static readonly BIRTHPLACE_FIELD_NAME_NORMALIZED = "ItIdCardFront.Birthplace";
1583
+ static readonly CARD_ACCESS_NUMBER_FIELD_NAME = "CardAccessNumber";
1584
+ static readonly CARD_ACCESS_NUMBER_FIELD_NAME_NORMALIZED = "ItIdCardFront.CardAccessNumber";
1585
+ static readonly EXPIRY_DATE_FIELD_NAME = "ExpiryDate";
1586
+ static readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED = "ItIdCardFront.ExpiryDate";
1587
+ static readonly GENDER_FIELD_NAME = "Gender";
1588
+ static readonly GENDER_FIELD_NAME_NORMALIZED = "ItIdCardFront.Gender";
1589
+ static readonly GIVEN_NAMES_FIELD_NAME = "GivenNames";
1590
+ static readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED = "ItIdCardFront.GivenNames";
1591
+ static readonly HEIGHT_FIELD_NAME = "Height";
1592
+ static readonly HEIGHT_FIELD_NAME_NORMALIZED = "ItIdCardFront.Height";
1593
+ static readonly ID_FIELD_NAME = "ID";
1594
+ static readonly ID_FIELD_NAME_NORMALIZED = "ItIdCardFront.ID";
1595
+ static readonly ISSUE_DATE_FIELD_NAME = "IssueDate";
1596
+ static readonly ISSUE_DATE_FIELD_NAME_NORMALIZED = "ItIdCardFront.IssueDate";
1597
+ static readonly NATIONALITY_FIELD_NAME = "Nationality";
1598
+ static readonly NATIONALITY_FIELD_NAME_NORMALIZED = "ItIdCardFront.Nationality";
1599
+ static readonly PHOTO_FIELD_NAME = "Photo";
1600
+ static readonly PHOTO_FIELD_NAME_NORMALIZED = "ItIdCardFront.Photo";
1601
+ static readonly PLACE_OF_ISSUE_FIELD_NAME = "PlaceOfIssue";
1602
+ static readonly PLACE_OF_ISSUE_FIELD_NAME_NORMALIZED = "ItIdCardFront.PlaceOfIssue";
1603
+ static readonly SIGNATURE_FIELD_NAME = "Signature";
1604
+ static readonly SIGNATURE_FIELD_NAME_NORMALIZED = "ItIdCardFront.Signature";
1605
+ static readonly SURNAME_FIELD_NAME = "Surname";
1606
+ static readonly SURNAME_FIELD_NAME_NORMALIZED = "ItIdCardFront.Surname";
1607
+ constructor(document: GenericDocument);
1608
+ requiredDocumentType(): string;
1609
+ /** Date of Birth */
1610
+ get birthDate(): Field;
1611
+ /** Birthplace */
1612
+ get birthplace(): Field;
1613
+ /** Card Access Number */
1614
+ get cardAccessNumber(): Field;
1615
+ /** Expiry date */
1616
+ get expiryDate(): Field;
1617
+ /** Gender */
1618
+ get gender(): Field;
1619
+ /** Given Names */
1620
+ get givenNames(): Field;
1621
+ /** Height */
1622
+ get height(): Field;
1623
+ /** Identity Document Number */
1624
+ get id(): Field;
1625
+ /** Date of Issue */
1626
+ get issueDate(): Field;
1627
+ /** Nationality */
1628
+ get nationality(): Field;
1629
+ /** Photo image */
1630
+ get photo(): Field;
1631
+ /** Municipality of Issue */
1632
+ get placeOfIssue(): Field;
1633
+ /** Signature image */
1634
+ get signature(): Field;
1635
+ /** Surname */
1636
+ get surname(): Field;
1637
+ /** The child document of type "Metadata". */
1638
+ get metadata(): Metadata;
1639
+ }
1640
+ export declare namespace ItIdCardFront {
1641
+ }
1642
+ /** ItIdCardBack */
1643
+ export declare class ItIdCardBack {
1644
+ private _document;
1645
+ get document(): GenericDocument;
1646
+ static readonly DOCUMENT_TYPE = "ItIdCardBack";
1647
+ static readonly ADDRESS_FIELD_NAME = "Address";
1648
+ static readonly ADDRESS_FIELD_NAME_NORMALIZED = "ItIdCardBack.Address";
1649
+ static readonly BARCODE_FIELD_NAME = "Barcode";
1650
+ static readonly BARCODE_FIELD_NAME_NORMALIZED = "ItIdCardBack.Barcode";
1651
+ static readonly FISCAL_CODE_FIELD_NAME = "FiscalCode";
1652
+ static readonly FISCAL_CODE_FIELD_NAME_NORMALIZED = "ItIdCardBack.FiscalCode";
1653
+ static readonly ISSUING_AUTHORITY_FIELD_NAME = "IssuingAuthority";
1654
+ static readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED = "ItIdCardBack.IssuingAuthority";
1655
+ static readonly PARENTS_FIELD_NAME = "Parents";
1656
+ static readonly PARENTS_FIELD_NAME_NORMALIZED = "ItIdCardBack.Parents";
1657
+ static readonly RAW_MRZ_FIELD_NAME = "RawMRZ";
1658
+ static readonly RAW_MRZ_FIELD_NAME_NORMALIZED = "ItIdCardBack.RawMRZ";
1659
+ static readonly REMARKS_FIELD_NAME = "Remarks";
1660
+ static readonly REMARKS_FIELD_NAME_NORMALIZED = "ItIdCardBack.Remarks";
1661
+ static readonly VALIDATION_PHOTO_FIELD_NAME = "ValidationPhoto";
1662
+ static readonly VALIDATION_PHOTO_FIELD_NAME_NORMALIZED = "ItIdCardBack.ValidationPhoto";
1663
+ constructor(document: GenericDocument);
1664
+ requiredDocumentType(): string;
1665
+ /** Address */
1666
+ get address(): Field;
1667
+ /** Barcode data */
1668
+ get barcode(): Field;
1669
+ /** Fiscal Code */
1670
+ get fiscalCode(): Field;
1671
+ /** Issuing authority */
1672
+ get issuingAuthority(): Field | undefined;
1673
+ /** Parents information */
1674
+ get parents(): Field;
1675
+ /** Raw MRZ text value */
1676
+ get rawMRZ(): Field;
1677
+ /** Remarks */
1678
+ get remarks(): Field;
1679
+ /** Validation Photo */
1680
+ get validationPhoto(): Field;
1681
+ /** The child document of type "MRZ". */
1682
+ get mrz(): MRZ;
1683
+ /** The child document of type "Metadata". */
1684
+ get metadata(): Metadata;
1685
+ }
1686
+ export declare namespace ItIdCardBack {
1687
+ }
1688
+ /** PoIdCardFront */
1689
+ export declare class PoIdCardFront {
1690
+ private _document;
1691
+ get document(): GenericDocument;
1692
+ static readonly DOCUMENT_TYPE = "PoIdCardFront";
1693
+ static readonly BIRTH_DATE_FIELD_NAME = "BirthDate";
1694
+ static readonly BIRTH_DATE_FIELD_NAME_NORMALIZED = "PoIdCardFront.BirthDate";
1695
+ static readonly CARD_ACCESS_NUMBER_FIELD_NAME = "CardAccessNumber";
1696
+ static readonly CARD_ACCESS_NUMBER_FIELD_NAME_NORMALIZED = "PoIdCardFront.CardAccessNumber";
1697
+ static readonly EXPIRY_DATE_FIELD_NAME = "ExpiryDate";
1698
+ static readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED = "PoIdCardFront.ExpiryDate";
1699
+ static readonly GENDER_FIELD_NAME = "Gender";
1700
+ static readonly GENDER_FIELD_NAME_NORMALIZED = "PoIdCardFront.Gender";
1701
+ static readonly GIVEN_NAMES_FIELD_NAME = "GivenNames";
1702
+ static readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED = "PoIdCardFront.GivenNames";
1703
+ static readonly ID_FIELD_NAME = "ID";
1704
+ static readonly ID_FIELD_NAME_NORMALIZED = "PoIdCardFront.ID";
1705
+ static readonly NATIONALITY_FIELD_NAME = "Nationality";
1706
+ static readonly NATIONALITY_FIELD_NAME_NORMALIZED = "PoIdCardFront.Nationality";
1707
+ static readonly PHOTO_FIELD_NAME = "Photo";
1708
+ static readonly PHOTO_FIELD_NAME_NORMALIZED = "PoIdCardFront.Photo";
1709
+ static readonly SIGNATURE_FIELD_NAME = "Signature";
1710
+ static readonly SIGNATURE_FIELD_NAME_NORMALIZED = "PoIdCardFront.Signature";
1711
+ static readonly SURNAME_FIELD_NAME = "Surname";
1712
+ static readonly SURNAME_FIELD_NAME_NORMALIZED = "PoIdCardFront.Surname";
1713
+ constructor(document: GenericDocument);
1714
+ requiredDocumentType(): string;
1715
+ /** Date of Birth */
1716
+ get birthDate(): Field;
1717
+ /** Card Access Number */
1718
+ get cardAccessNumber(): Field | undefined;
1719
+ /** Expiry date */
1720
+ get expiryDate(): Field;
1721
+ /** Gender */
1722
+ get gender(): Field;
1723
+ /** Given Names */
1724
+ get givenNames(): Field;
1725
+ /** Identity Document Number */
1726
+ get id(): Field;
1727
+ /** Nationality */
1728
+ get nationality(): Field;
1729
+ /** Photo image */
1730
+ get photo(): Field;
1731
+ /** Signature image */
1732
+ get signature(): Field | undefined;
1733
+ /** Surname */
1734
+ get surname(): Field;
1735
+ /** The child document of type "Metadata". */
1736
+ get metadata(): Metadata;
1737
+ }
1738
+ export declare namespace PoIdCardFront {
1739
+ }
1740
+ /** RoIdCardBack */
1741
+ export declare class RoIdCardBack {
1742
+ private _document;
1743
+ get document(): GenericDocument;
1744
+ static readonly DOCUMENT_TYPE = "RoIdCardBack";
1745
+ static readonly ISSUE_DATE_FIELD_NAME = "IssueDate";
1746
+ static readonly ISSUE_DATE_FIELD_NAME_NORMALIZED = "RoIdCardBack.IssueDate";
1747
+ static readonly ISSUING_AUTHORITY_FIELD_NAME = "IssuingAuthority";
1748
+ static readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED = "RoIdCardBack.IssuingAuthority";
1749
+ static readonly RAW_MRZ_FIELD_NAME = "RawMRZ";
1750
+ static readonly RAW_MRZ_FIELD_NAME_NORMALIZED = "RoIdCardBack.RawMRZ";
1751
+ constructor(document: GenericDocument);
1752
+ requiredDocumentType(): string;
1753
+ /** Date of Issue */
1754
+ get issueDate(): Field;
1755
+ /** Issuing authority */
1756
+ get issuingAuthority(): Field;
1757
+ /** Raw MRZ text value */
1758
+ get rawMRZ(): Field;
1759
+ /** The child document of type "MRZ". */
1760
+ get mrz(): MRZ;
1761
+ /** The child document of type "Metadata". */
1762
+ get metadata(): Metadata;
1763
+ }
1764
+ export declare namespace RoIdCardBack {
1765
+ }
1766
+ /** RoIdCardFront */
1767
+ export declare class RoIdCardFront {
1768
+ private _document;
1769
+ get document(): GenericDocument;
1770
+ static readonly DOCUMENT_TYPE = "RoIdCardFront";
1771
+ static readonly BIRTH_DATE_FIELD_NAME = "BirthDate";
1772
+ static readonly BIRTH_DATE_FIELD_NAME_NORMALIZED = "RoIdCardFront.BirthDate";
1773
+ static readonly CARD_ACCESS_NUMBER_FIELD_NAME = "CardAccessNumber";
1774
+ static readonly CARD_ACCESS_NUMBER_FIELD_NAME_NORMALIZED = "RoIdCardFront.CardAccessNumber";
1775
+ static readonly EXPIRY_DATE_FIELD_NAME = "ExpiryDate";
1776
+ static readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED = "RoIdCardFront.ExpiryDate";
1777
+ static readonly GENDER_FIELD_NAME = "Gender";
1778
+ static readonly GENDER_FIELD_NAME_NORMALIZED = "RoIdCardFront.Gender";
1779
+ static readonly GIVEN_NAMES_FIELD_NAME = "GivenNames";
1780
+ static readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED = "RoIdCardFront.GivenNames";
1781
+ static readonly ID_FIELD_NAME = "ID";
1782
+ static readonly ID_FIELD_NAME_NORMALIZED = "RoIdCardFront.ID";
1783
+ static readonly NATIONALITY_FIELD_NAME = "Nationality";
1784
+ static readonly NATIONALITY_FIELD_NAME_NORMALIZED = "RoIdCardFront.Nationality";
1785
+ static readonly PERSONAL_NUMBER_FIELD_NAME = "PersonalNumber";
1786
+ static readonly PERSONAL_NUMBER_FIELD_NAME_NORMALIZED = "RoIdCardFront.PersonalNumber";
1787
+ static readonly SIGNATURE_FIELD_NAME = "Signature";
1788
+ static readonly SIGNATURE_FIELD_NAME_NORMALIZED = "RoIdCardFront.Signature";
1789
+ static readonly SURNAME_FIELD_NAME = "Surname";
1790
+ static readonly SURNAME_FIELD_NAME_NORMALIZED = "RoIdCardFront.Surname";
1791
+ constructor(document: GenericDocument);
1792
+ requiredDocumentType(): string;
1793
+ /** Date of Birth */
1794
+ get birthDate(): Field;
1795
+ /** Card Access Number */
1796
+ get cardAccessNumber(): Field;
1797
+ /** Expiry date */
1798
+ get expiryDate(): Field;
1799
+ /** Gender */
1800
+ get gender(): Field;
1801
+ /** Given Names */
1802
+ get givenNames(): Field;
1803
+ /** Identity Document Number */
1804
+ get id(): Field;
1805
+ /** Nationality */
1806
+ get nationality(): Field;
1807
+ /** Personal Number (CNP) */
1808
+ get personalNumber(): Field;
1809
+ /** Signature image */
1810
+ get signature(): Field;
1811
+ /** Surname */
1812
+ get surname(): Field;
1813
+ /** The child document of type "Metadata". */
1814
+ get metadata(): Metadata;
1815
+ }
1816
+ export declare namespace RoIdCardFront {
1817
+ }
1818
+ /** PoIdCardBack */
1819
+ export declare class PoIdCardBack {
1820
+ private _document;
1821
+ get document(): GenericDocument;
1822
+ static readonly DOCUMENT_TYPE = "PoIdCardBack";
1823
+ static readonly BARCODE_FIELD_NAME = "Barcode";
1824
+ static readonly BARCODE_FIELD_NAME_NORMALIZED = "PoIdCardBack.Barcode";
1825
+ static readonly BIRTHPLACE_FIELD_NAME = "Birthplace";
1826
+ static readonly BIRTHPLACE_FIELD_NAME_NORMALIZED = "PoIdCardBack.Birthplace";
1827
+ static readonly ID_FIELD_NAME = "ID";
1828
+ static readonly ID_FIELD_NAME_NORMALIZED = "PoIdCardBack.ID";
1829
+ static readonly ISSUE_DATE_FIELD_NAME = "IssueDate";
1830
+ static readonly ISSUE_DATE_FIELD_NAME_NORMALIZED = "PoIdCardBack.IssueDate";
1831
+ static readonly ISSUING_AUTHORITY_FIELD_NAME = "IssuingAuthority";
1832
+ static readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED = "PoIdCardBack.IssuingAuthority";
1833
+ static readonly PARENTS_GIVEN_NAMES_FIELD_NAME = "ParentsGivenNames";
1834
+ static readonly PARENTS_GIVEN_NAMES_FIELD_NAME_NORMALIZED = "PoIdCardBack.ParentsGivenNames";
1835
+ static readonly PERSONAL_NUMBER_FIELD_NAME = "PersonalNumber";
1836
+ static readonly PERSONAL_NUMBER_FIELD_NAME_NORMALIZED = "PoIdCardBack.PersonalNumber";
1837
+ static readonly RAW_MRZ_FIELD_NAME = "RawMRZ";
1838
+ static readonly RAW_MRZ_FIELD_NAME_NORMALIZED = "PoIdCardBack.RawMRZ";
1839
+ static readonly SURNAME_FIELD_NAME = "Surname";
1840
+ static readonly SURNAME_FIELD_NAME_NORMALIZED = "PoIdCardBack.Surname";
1841
+ constructor(document: GenericDocument);
1842
+ requiredDocumentType(): string;
1843
+ /** Barcode data */
1844
+ get barcode(): Field;
1845
+ /** Birthplace */
1846
+ get birthplace(): Field;
1847
+ /** Identity Document Number */
1848
+ get id(): Field;
1849
+ /** Date of Issue */
1850
+ get issueDate(): Field;
1851
+ /** Issuing authority */
1852
+ get issuingAuthority(): Field;
1853
+ /** Parents Given Names */
1854
+ get parentsGivenNames(): Field;
1855
+ /** Personal Number */
1856
+ get personalNumber(): Field;
1857
+ /** Raw MRZ text value */
1858
+ get rawMRZ(): Field;
1859
+ /** Surname */
1860
+ get surname(): Field;
1861
+ /** The child document of type "MRZ". */
1862
+ get mrz(): MRZ;
1863
+ /** The child document of type "Metadata". */
1864
+ get metadata(): Metadata;
1865
+ }
1866
+ export declare namespace PoIdCardBack {
1867
+ }
1868
+ /** TrIdCardBack */
1869
+ export declare class TrIdCardBack {
1870
+ private _document;
1871
+ get document(): GenericDocument;
1872
+ static readonly DOCUMENT_TYPE = "TrIdCardBack";
1873
+ static readonly BARCODE_FIELD_NAME = "Barcode";
1874
+ static readonly BARCODE_FIELD_NAME_NORMALIZED = "TrIdCardBack.Barcode";
1875
+ static readonly FATHERS_NAME_FIELD_NAME = "FathersName";
1876
+ static readonly FATHERS_NAME_FIELD_NAME_NORMALIZED = "TrIdCardBack.FathersName";
1877
+ static readonly ISSUING_AUTHORITY_FIELD_NAME = "IssuingAuthority";
1878
+ static readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED = "TrIdCardBack.IssuingAuthority";
1879
+ static readonly MOTHERS_NAME_FIELD_NAME = "MothersName";
1880
+ static readonly MOTHERS_NAME_FIELD_NAME_NORMALIZED = "TrIdCardBack.MothersName";
1881
+ static readonly RAW_MRZ_FIELD_NAME = "RawMRZ";
1882
+ static readonly RAW_MRZ_FIELD_NAME_NORMALIZED = "TrIdCardBack.RawMRZ";
1883
+ constructor(document: GenericDocument);
1884
+ requiredDocumentType(): string;
1885
+ /** Barcode data */
1886
+ get barcode(): Field;
1887
+ /** Father's Name */
1888
+ get fathersName(): Field;
1889
+ /** Issuing authority */
1890
+ get issuingAuthority(): Field;
1891
+ /** Mother's Name */
1892
+ get mothersName(): Field;
1893
+ /** Raw MRZ text value */
1894
+ get rawMRZ(): Field;
1895
+ /** The child document of type "MRZ". */
1896
+ get mrz(): MRZ;
1897
+ /** The child document of type "Metadata". */
1898
+ get metadata(): Metadata;
1899
+ }
1900
+ export declare namespace TrIdCardBack {
1901
+ }
1902
+ /** TrIdCardFront */
1903
+ export declare class TrIdCardFront {
1904
+ private _document;
1905
+ get document(): GenericDocument;
1906
+ static readonly DOCUMENT_TYPE = "TrIdCardFront";
1907
+ static readonly BIRTH_DATE_FIELD_NAME = "BirthDate";
1908
+ static readonly BIRTH_DATE_FIELD_NAME_NORMALIZED = "TrIdCardFront.BirthDate";
1909
+ static readonly EXPIRY_DATE_FIELD_NAME = "ExpiryDate";
1910
+ static readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED = "TrIdCardFront.ExpiryDate";
1911
+ static readonly GENDER_FIELD_NAME = "Gender";
1912
+ static readonly GENDER_FIELD_NAME_NORMALIZED = "TrIdCardFront.Gender";
1913
+ static readonly GIVEN_NAMES_FIELD_NAME = "GivenNames";
1914
+ static readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED = "TrIdCardFront.GivenNames";
1915
+ static readonly ID_FIELD_NAME = "ID";
1916
+ static readonly ID_FIELD_NAME_NORMALIZED = "TrIdCardFront.ID";
1917
+ static readonly NATIONALITY_FIELD_NAME = "Nationality";
1918
+ static readonly NATIONALITY_FIELD_NAME_NORMALIZED = "TrIdCardFront.Nationality";
1919
+ static readonly PERSONAL_NUMBER_FIELD_NAME = "PersonalNumber";
1920
+ static readonly PERSONAL_NUMBER_FIELD_NAME_NORMALIZED = "TrIdCardFront.PersonalNumber";
1921
+ static readonly SIGNATURE_FIELD_NAME = "Signature";
1922
+ static readonly SIGNATURE_FIELD_NAME_NORMALIZED = "TrIdCardFront.Signature";
1923
+ static readonly SURNAME_FIELD_NAME = "Surname";
1924
+ static readonly SURNAME_FIELD_NAME_NORMALIZED = "TrIdCardFront.Surname";
1925
+ constructor(document: GenericDocument);
1926
+ requiredDocumentType(): string;
1927
+ /** Date of Birth */
1928
+ get birthDate(): Field;
1929
+ /** Expiry date */
1930
+ get expiryDate(): Field;
1931
+ /** Gender */
1932
+ get gender(): Field;
1933
+ /** Given Names */
1934
+ get givenNames(): Field;
1935
+ /** Identity Document Number */
1936
+ get id(): Field;
1937
+ /** Nationality */
1938
+ get nationality(): Field;
1939
+ /** Personal Number */
1940
+ get personalNumber(): Field;
1941
+ /** Signature image */
1942
+ get signature(): Field;
1943
+ /** Surname */
1944
+ get surname(): Field;
1945
+ /** The child document of type "Metadata". */
1946
+ get metadata(): Metadata;
1947
+ }
1948
+ export declare namespace TrIdCardFront {
1949
+ }
1950
+ export type DocumentsModelRootType = typeof Metadata.DOCUMENT_TYPE | typeof MRZ.DOCUMENT_TYPE | typeof ParsedDeAddress.DOCUMENT_TYPE | typeof DeIdCardFront.DOCUMENT_TYPE | typeof DeIdCardBack.DOCUMENT_TYPE | typeof DePassport.DOCUMENT_TYPE | typeof EuropeanDriverLicenseFront.DOCUMENT_TYPE | typeof EuropeanDriverLicenseBack.DOCUMENT_TYPE | typeof DeResidencePermitFront.DOCUMENT_TYPE | typeof DeResidencePermitBack.DOCUMENT_TYPE | typeof EuropeanHealthInsuranceCard.DOCUMENT_TYPE | typeof DeHealthInsuranceCardFront.DOCUMENT_TYPE | typeof BrIdCardFront.DOCUMENT_TYPE | typeof BrIdCardBack.DOCUMENT_TYPE | typeof BrIdCardFrontPhotoOnly.DOCUMENT_TYPE | typeof CnEntryAndExitPermitBack.DOCUMENT_TYPE | typeof CnEntryAndExitPermitFront.DOCUMENT_TYPE | typeof CnPermanentResidentCardFront.DOCUMENT_TYPE | typeof HkIdentityCardFront.DOCUMENT_TYPE | typeof TwEntryAndExitPermit.DOCUMENT_TYPE | typeof MoIdentityCardBack.DOCUMENT_TYPE | typeof MoIdentityCardFront.DOCUMENT_TYPE | typeof RoIdCardTD3.DOCUMENT_TYPE | typeof ItIdCardFront.DOCUMENT_TYPE | typeof ItIdCardBack.DOCUMENT_TYPE | typeof PoIdCardFront.DOCUMENT_TYPE | typeof RoIdCardBack.DOCUMENT_TYPE | typeof RoIdCardFront.DOCUMENT_TYPE | typeof PoIdCardBack.DOCUMENT_TYPE | typeof TrIdCardBack.DOCUMENT_TYPE | typeof TrIdCardFront.DOCUMENT_TYPE;
@@ -68,7 +68,7 @@ export declare const BinarizationFilterPresetValues: ReadonlyArray<BinarizationF
68
68
  /**
69
69
  Base class for all parametric filters.
70
70
  */
71
- export type ParametricFilter = LegacyFilter | ScanbotBinarizationFilter | CustomBinarizationFilter | ColorDocumentFilter | BrightnessFilter | ContrastFilter | GrayscaleFilter | WhiteBlackPointFilter;
71
+ export type ParametricFilter = LegacyFilter | ScanbotBinarizationFilter | CustomBinarizationFilter | ColorDocumentFilter | ColorDocumentShadowRemovalFilter | BrightnessFilter | ContrastFilter | GrayscaleFilter | WhiteBlackPointFilter;
72
72
  /** @internal */
73
73
  export declare namespace ParametricFilter {
74
74
  /** @internal */
@@ -165,6 +165,41 @@ export declare class ColorDocumentFilter {
165
165
  constructor(source?: DeepPartial<ColorDocumentFilter>);
166
166
  }
167
167
  /**
168
+ Color document shadow removal filter. The filter is similar to ColorDocumentFilter tries to remove shadows from the image without damaging colorful elements. As a result of shadow removal, paper is usually whitened.
169
+ */
170
+ export declare class ColorDocumentShadowRemovalFilter {
171
+ readonly _type: "ColorDocumentShadowRemovalFilter";
172
+ /**
173
+ Strength of contrast enhancement. Typical values are between 0 and 1, although higher values are possible.
174
+ @defaultValue 0.5;
175
+ */
176
+ contrastEnhancement: number;
177
+ /**
178
+ Strength of color saturation enhancement. Typical values are between 0 and 1, although higher values are possible.
179
+ @defaultValue 0.5;
180
+ */
181
+ colorEnhancement: number;
182
+ /**
183
+ The shadow removal filter balances between whitening paper and enhancing the contrast and colors of the printed parts of a document.
184
+ This parameter controls the saturation (colorfulness) threshold for distinguishing paper from print. Values must be between 0 and 1.
185
+ Lower values will cause the filter to prefer whitening to enhancing.
186
+ Higher values will cause the filter to prefer enhancing to whitening.
187
+ @defaultValue 0.5;
188
+ */
189
+ paperSaturation: number;
190
+ /**
191
+ The shadow removal filter balances between whitening paper and enhancing the contrast and colors of the printed parts of a document.
192
+ This parameter controls the lightness threshold for distinguishing paper from print.
193
+ Values must be between 0 and 1.
194
+ Lower values will cause the filter to prefer whitening to enhancing.
195
+ Higher values will cause the filter to prefer enhancing to whitening.
196
+ @defaultValue 0.5;
197
+ */
198
+ paperLightness: number;
199
+ /** @param source {@displayType `DeepPartial<ColorDocumentShadowRemovalFilter>`} */
200
+ constructor(source?: DeepPartial<ColorDocumentShadowRemovalFilter>);
201
+ }
202
+ /**
168
203
  Brightness adjustment filter.
169
204
  */
170
205
  export declare class BrightnessFilter {
@@ -43,7 +43,7 @@ export type WrappedImage = {
43
43
  format: string;
44
44
  step: number;
45
45
  };
46
- export declare class ObjectMap<T extends string> {
46
+ export declare class WasmObjectMap<T extends string> {
47
47
  private _map;
48
48
  private _nextId;
49
49
  private _unique;
@@ -60,5 +60,5 @@ export * from './core/bridge/utils';
60
60
  export * from './core/bridge/worker-bridge';
61
61
  export * from './core/compiled/bridge/image';
62
62
  export * from './core/compiled/utils';
63
- export { type RawImage, type DeepPartial, type Point, type Rectangle, type ObjectId, type ObjectMap, type WrappedImage, type IsUnion, type IsPolymorphicKey, type NonPartiallyConstructibleTrait, consumeResult } from './core/compiled/utils';
63
+ export { type RawImage, type DeepPartial, type Point, type Rectangle, type ObjectId, type WasmObjectMap, type WrappedImage, type IsUnion, type IsPolymorphicKey, type NonPartiallyConstructibleTrait, consumeResult } from './core/compiled/utils';
64
64
  export type * from './core/worker/ScanbotSDK.Core';
@@ -77,6 +77,10 @@ export declare class DocumentScannerViewConfiguration extends ScannerConfigurati
77
77
  * Default is 1000ms.
78
78
  */
79
79
  autoCaptureDelay?: number;
80
+ /**
81
+ * Determines whether the captured image should be automatically cropped to the detected document's outline.
82
+ */
83
+ autoCrop?: boolean;
80
84
  /**
81
85
  * Attempts to take a single exposure using the video capture device,
82
86
  * resulting in a high resolution image and potentially greatly improved detection quality.
@@ -23,6 +23,9 @@ export declare class ScannerConfiguration extends BaseConfiguration {
23
23
  preferredCamera?: string;
24
24
  spinnerColor?: string;
25
25
  backgroundColor?: string;
26
+ /** In FILL_IN – Fits the camera frame into the view, cropping the frame if necessary */
27
+ /** In FIT_IN – Fits the entire preview (camera) frame into the view. If aspect ratio does not fit, will contain black edges */
28
+ previewMode?: 'FIT_IN' | 'FILL_IN';
26
29
  constructor(resolution: {
27
30
  width: number;
28
31
  height: number;
@@ -142,6 +142,13 @@ export default class ScanbotSDK {
142
142
  paperWhiteningBias?: number;
143
143
  } & {
144
144
  readonly _type: "ColorDocumentFilter";
145
+ }) | ({
146
+ contrastEnhancement?: number;
147
+ colorEnhancement?: number;
148
+ paperSaturation?: number;
149
+ paperLightness?: number;
150
+ } & {
151
+ readonly _type: "ColorDocumentShadowRemovalFilter";
145
152
  }) | ({
146
153
  brightness?: number;
147
154
  } & {
@@ -210,6 +217,13 @@ export default class ScanbotSDK {
210
217
  paperWhiteningBias?: number;
211
218
  } & {
212
219
  readonly _type: "ColorDocumentFilter";
220
+ }) | ({
221
+ contrastEnhancement?: number;
222
+ colorEnhancement?: number;
223
+ paperSaturation?: number;
224
+ paperLightness?: number;
225
+ } & {
226
+ readonly _type: "ColorDocumentShadowRemovalFilter";
213
227
  }) | ({
214
228
  brightness?: number;
215
229
  } & {
@@ -1,3 +1,3 @@
1
1
  export type { Point, RawImage, Rectangle } from "../core-types";
2
- export type { ObjectId, ObjectMap, consumeResult } from "../core-types";
2
+ export type { ObjectId, WasmObjectMap, consumeResult } from "../core-types";
3
3
  export type wrapImage = void;
@@ -1 +1 @@
1
- export type { BarcodeFormat, Gs1Handling, Gs1HandlingValues, BarcodeFormatValues, CharacterEncoding, CharacterEncodingValues, RangeEncoding, StructuredAppendInfo, UpcEanExtensionBehavior, UpcEanExtensionBehaviorValues, } from "../../core-types";
1
+ export type { BarcodeFormat, Gs1Handling, Gs1HandlingValues, BarcodeFormatValues, CharacterEncoding, CharacterEncodingValues, RangeEncoding, StructuredAppendInfo, UpcEanExtensionBehavior, UpcEanExtensionBehaviorValues, OneDConfirmationMode, OneDConfirmationModeValues, } from "../../core-types";