@notabene/javascript-sdk 2.9.3 → 2.10.0-next.4

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 (138) hide show
  1. package/README.md +22 -29
  2. package/dist/cjs/notabene.cjs +1 -1
  3. package/dist/cjs/notabene.d.ts +78 -26
  4. package/dist/cjs/package.json +2 -1
  5. package/dist/esm/notabene.d.ts +78 -26
  6. package/dist/esm/notabene.js +19 -13
  7. package/dist/esm/package.json +2 -1
  8. package/dist/notabene.d.ts +78 -26
  9. package/dist/notabene.js +19 -13
  10. package/docs/README.md +218 -47
  11. package/docs/_media/TransactionOptions.md +9 -9
  12. package/docs/_media/getRefreshResult.md +35 -0
  13. package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
  14. package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
  15. package/docs/ivms/types/type-aliases/Address.md +1 -1
  16. package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
  17. package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
  18. package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
  19. package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
  20. package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
  21. package/docs/ivms/types/type-aliases/ISODate.md +1 -1
  22. package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
  23. package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
  24. package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
  25. package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
  26. package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
  27. package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
  28. package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
  29. package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
  30. package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
  31. package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
  32. package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
  33. package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
  34. package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
  35. package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
  36. package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
  37. package/docs/ivms/types/type-aliases/Originator.md +1 -1
  38. package/docs/ivms/types/type-aliases/Person.md +1 -1
  39. package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
  40. package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
  41. package/docs/notabene/README.md +7 -1
  42. package/docs/notabene/classes/ConnectionManager.md +19 -5
  43. package/docs/notabene/classes/EmbeddedComponent.md +17 -17
  44. package/docs/notabene/classes/default.md +7 -7
  45. package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
  46. package/docs/notabene/functions/getRefreshResult.md +11 -3
  47. package/docs/notabene/interfaces/ConnectionData.md +8 -8
  48. package/docs/notabene/interfaces/ConnectionMetadata.md +6 -6
  49. package/docs/notabene/interfaces/ConnectionResponse.md +12 -12
  50. package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
  51. package/docs/notabene/type-aliases/ConnectionResult.md +17 -0
  52. package/docs/notabene/type-aliases/ConnectionStatus.md +1 -1
  53. package/docs/notabene/type-aliases/MessageCallback.md +1 -1
  54. package/docs/notabene/type-aliases/TransactionType.md +1 -1
  55. package/docs/types/README.md +1 -0
  56. package/docs/types/enumerations/AgentType.md +2 -2
  57. package/docs/types/enumerations/CMType.md +7 -7
  58. package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
  59. package/docs/types/enumerations/HMType.md +2 -2
  60. package/docs/types/enumerations/PersonType.md +3 -3
  61. package/docs/types/enumerations/ProofStatus.md +4 -4
  62. package/docs/types/enumerations/ProofTypes.md +27 -17
  63. package/docs/types/enumerations/Status.md +5 -5
  64. package/docs/types/enumerations/VASPSearchControl.md +2 -2
  65. package/docs/types/enumerations/ValidationSections.md +4 -4
  66. package/docs/types/interfaces/Account.md +59 -0
  67. package/docs/types/interfaces/Agent.md +6 -6
  68. package/docs/types/interfaces/CallbackOptions.md +2 -2
  69. package/docs/types/interfaces/ComponentRequest.md +2 -2
  70. package/docs/types/interfaces/ComponentResponse.md +4 -4
  71. package/docs/types/interfaces/ConnectionRecord.md +7 -7
  72. package/docs/types/interfaces/ConnectionRequest.md +3 -3
  73. package/docs/types/interfaces/Counterparty.md +10 -10
  74. package/docs/types/interfaces/DeclarationProof.md +6 -6
  75. package/docs/types/interfaces/Deposit.md +25 -11
  76. package/docs/types/interfaces/DepositRequest.md +9 -9
  77. package/docs/types/interfaces/DepositRequestOptions.md +1 -1
  78. package/docs/types/interfaces/DepositTransaction.md +23 -9
  79. package/docs/types/interfaces/LegalPerson.md +13 -13
  80. package/docs/types/interfaces/MicroTransferProof.md +9 -9
  81. package/docs/types/interfaces/NaturalPerson.md +13 -13
  82. package/docs/types/interfaces/OwnershipProof.md +4 -4
  83. package/docs/types/interfaces/RefreshSource.md +2 -2
  84. package/docs/types/interfaces/Refreshable.md +1 -1
  85. package/docs/types/interfaces/ScreenshotProof.md +5 -5
  86. package/docs/types/interfaces/SignatureProof.md +10 -10
  87. package/docs/types/interfaces/ThresholdOptions.md +3 -3
  88. package/docs/types/interfaces/Transaction.md +18 -8
  89. package/docs/types/interfaces/TransactionOptions.md +9 -9
  90. package/docs/types/interfaces/TransactionResponse.md +9 -9
  91. package/docs/types/interfaces/VASP.md +9 -9
  92. package/docs/types/interfaces/Wallet.md +8 -8
  93. package/docs/types/interfaces/Withdrawal.md +24 -10
  94. package/docs/types/type-aliases/BlockchainAddress.md +1 -1
  95. package/docs/types/type-aliases/CAIP10.md +1 -1
  96. package/docs/types/type-aliases/CAIP19.md +1 -1
  97. package/docs/types/type-aliases/CAIP2.md +1 -1
  98. package/docs/types/type-aliases/CAIP220.md +1 -1
  99. package/docs/types/type-aliases/Cancel.md +1 -1
  100. package/docs/types/type-aliases/Completed.md +1 -1
  101. package/docs/types/type-aliases/ComponentMessage.md +1 -1
  102. package/docs/types/type-aliases/ConnectionOptions.md +1 -1
  103. package/docs/types/type-aliases/CounterpartyAssistConfig.md +2 -2
  104. package/docs/types/type-aliases/CryptoCredential.md +1 -1
  105. package/docs/types/type-aliases/DID.md +1 -1
  106. package/docs/types/type-aliases/DTI.md +1 -1
  107. package/docs/types/type-aliases/Destination.md +1 -1
  108. package/docs/types/type-aliases/Error.md +1 -1
  109. package/docs/types/type-aliases/FieldOptions.md +1 -1
  110. package/docs/types/type-aliases/FieldTypes.md +1 -1
  111. package/docs/types/type-aliases/HostMessage.md +1 -1
  112. package/docs/types/type-aliases/ISOCurrency.md +1 -1
  113. package/docs/types/type-aliases/InvalidValue.md +1 -1
  114. package/docs/types/type-aliases/LEI.md +1 -1
  115. package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
  116. package/docs/types/type-aliases/LegalPersonFields.md +1 -1
  117. package/docs/types/type-aliases/NationalIdentifierTypeFieldOptions.md +1 -1
  118. package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
  119. package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
  120. package/docs/types/type-aliases/NotabeneAsset.md +1 -1
  121. package/docs/types/type-aliases/Ready.md +1 -1
  122. package/docs/types/type-aliases/ResizeRequest.md +1 -1
  123. package/docs/types/type-aliases/Source.md +1 -1
  124. package/docs/types/type-aliases/Theme.md +1 -1
  125. package/docs/types/type-aliases/TransactionAsset.md +1 -1
  126. package/docs/types/type-aliases/TravelAddress.md +1 -1
  127. package/docs/types/type-aliases/URI.md +1 -1
  128. package/docs/types/type-aliases/UUID.md +1 -1
  129. package/docs/types/type-aliases/UpdateValue.md +1 -1
  130. package/docs/types/type-aliases/V1Asset.md +1 -1
  131. package/docs/types/type-aliases/V1Transaction.md +1 -1
  132. package/docs/types/type-aliases/VASPOptions.md +1 -1
  133. package/docs/types/type-aliases/ValidationError.md +1 -1
  134. package/package.json +2 -1
  135. package/src/types.ts +36 -2
  136. package/src/utils/connections.ts +47 -21
  137. package/src/utils/encryption.ts +13 -6
  138. package/docs/notabene/interfaces/ConnectionResult.md +0 -61
@@ -20,7 +20,7 @@ A VASP agent acting on behalf of the counterparty
20
20
 
21
21
  #### Defined in
22
22
 
23
- [types.ts:303](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L303)
23
+ [types.ts:303](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L303)
24
24
 
25
25
  ***
26
26
 
@@ -34,7 +34,7 @@ A VASP agent acting on behalf of the counterparty
34
34
 
35
35
  #### Defined in
36
36
 
37
- [types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L260)
37
+ [types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L260)
38
38
 
39
39
  ***
40
40
 
@@ -44,7 +44,7 @@ A VASP agent acting on behalf of the counterparty
44
44
 
45
45
  #### Defined in
46
46
 
47
- [types.ts:300](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L300)
47
+ [types.ts:300](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L300)
48
48
 
49
49
  ***
50
50
 
@@ -58,7 +58,7 @@ A VASP agent acting on behalf of the counterparty
58
58
 
59
59
  #### Defined in
60
60
 
61
- [types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L301)
61
+ [types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L301)
62
62
 
63
63
  ***
64
64
 
@@ -72,7 +72,7 @@ A VASP agent acting on behalf of the counterparty
72
72
 
73
73
  #### Defined in
74
74
 
75
- [types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L264)
75
+ [types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L264)
76
76
 
77
77
  ***
78
78
 
@@ -86,7 +86,7 @@ A VASP agent acting on behalf of the counterparty
86
86
 
87
87
  #### Defined in
88
88
 
89
- [types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L261)
89
+ [types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L261)
90
90
 
91
91
  ***
92
92
 
@@ -100,7 +100,7 @@ A VASP agent acting on behalf of the counterparty
100
100
 
101
101
  #### Defined in
102
102
 
103
- [types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L263)
103
+ [types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L263)
104
104
 
105
105
  ***
106
106
 
@@ -114,7 +114,7 @@ A VASP agent acting on behalf of the counterparty
114
114
 
115
115
  #### Defined in
116
116
 
117
- [types.ts:265](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L265)
117
+ [types.ts:265](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L265)
118
118
 
119
119
  ***
120
120
 
@@ -124,4 +124,4 @@ A VASP agent acting on behalf of the counterparty
124
124
 
125
125
  #### Defined in
126
126
 
127
- [types.ts:302](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L302)
127
+ [types.ts:302](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L302)
@@ -24,7 +24,7 @@ A wallet agent acting on behalf of the counterparty
24
24
 
25
25
  #### Defined in
26
26
 
27
- [types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L260)
27
+ [types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L260)
28
28
 
29
29
  ***
30
30
 
@@ -38,7 +38,7 @@ A wallet agent acting on behalf of the counterparty
38
38
 
39
39
  #### Defined in
40
40
 
41
- [types.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L262)
41
+ [types.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L262)
42
42
 
43
43
  ***
44
44
 
@@ -52,7 +52,7 @@ A wallet agent acting on behalf of the counterparty
52
52
 
53
53
  #### Defined in
54
54
 
55
- [types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L264)
55
+ [types.ts:264](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L264)
56
56
 
57
57
  ***
58
58
 
@@ -62,7 +62,7 @@ A wallet agent acting on behalf of the counterparty
62
62
 
63
63
  #### Defined in
64
64
 
65
- [types.ts:311](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L311)
65
+ [types.ts:311](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L311)
66
66
 
67
67
  ***
68
68
 
@@ -76,7 +76,7 @@ A wallet agent acting on behalf of the counterparty
76
76
 
77
77
  #### Defined in
78
78
 
79
- [types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L261)
79
+ [types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L261)
80
80
 
81
81
  ***
82
82
 
@@ -90,7 +90,7 @@ A wallet agent acting on behalf of the counterparty
90
90
 
91
91
  #### Defined in
92
92
 
93
- [types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L263)
93
+ [types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L263)
94
94
 
95
95
  ***
96
96
 
@@ -104,7 +104,7 @@ A wallet agent acting on behalf of the counterparty
104
104
 
105
105
  #### Defined in
106
106
 
107
- [types.ts:265](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L265)
107
+ [types.ts:265](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L265)
108
108
 
109
109
  ***
110
110
 
@@ -114,4 +114,4 @@ A wallet agent acting on behalf of the counterparty
114
114
 
115
115
  #### Defined in
116
116
 
117
- [types.ts:312](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L312)
117
+ [types.ts:312](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L312)
@@ -14,6 +14,20 @@ An object representing a withdrawal transaction
14
14
 
15
15
  ## Properties
16
16
 
17
+ ### account?
18
+
19
+ > `optional` **account**: [`Account`](Account.md)
20
+
21
+ #### Inherited from
22
+
23
+ [`Transaction`](Transaction.md).[`account`](Transaction.md#account)
24
+
25
+ #### Defined in
26
+
27
+ [types.ts:572](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L572)
28
+
29
+ ***
30
+
17
31
  ### agent
18
32
 
19
33
  > **agent**: [`Agent`](Agent.md)
@@ -24,7 +38,7 @@ An object representing a withdrawal transaction
24
38
 
25
39
  #### Defined in
26
40
 
27
- [types.ts:551](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L551)
41
+ [types.ts:563](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L563)
28
42
 
29
43
  ***
30
44
 
@@ -38,7 +52,7 @@ An object representing a withdrawal transaction
38
52
 
39
53
  #### Defined in
40
54
 
41
- [types.ts:554](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L554)
55
+ [types.ts:566](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L566)
42
56
 
43
57
  ***
44
58
 
@@ -52,7 +66,7 @@ An object representing a withdrawal transaction
52
66
 
53
67
  #### Defined in
54
68
 
55
- [types.ts:553](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L553)
69
+ [types.ts:565](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L565)
56
70
 
57
71
  ***
58
72
 
@@ -74,7 +88,7 @@ An object representing a withdrawal transaction
74
88
 
75
89
  #### Defined in
76
90
 
77
- [types.ts:556](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L556)
91
+ [types.ts:568](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L568)
78
92
 
79
93
  ***
80
94
 
@@ -88,7 +102,7 @@ An object representing a withdrawal transaction
88
102
 
89
103
  #### Defined in
90
104
 
91
- [types.ts:552](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L552)
105
+ [types.ts:564](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L564)
92
106
 
93
107
  ***
94
108
 
@@ -102,7 +116,7 @@ An object representing a withdrawal transaction
102
116
 
103
117
  #### Defined in
104
118
 
105
- [types.ts:524](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L524)
119
+ [types.ts:536](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L536)
106
120
 
107
121
  ***
108
122
 
@@ -116,7 +130,7 @@ An object representing a withdrawal transaction
116
130
 
117
131
  #### Defined in
118
132
 
119
- [types.ts:489](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L489)
133
+ [types.ts:501](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L501)
120
134
 
121
135
  ***
122
136
 
@@ -130,7 +144,7 @@ An object representing a withdrawal transaction
130
144
 
131
145
  #### Defined in
132
146
 
133
- [types.ts:555](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L555)
147
+ [types.ts:567](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L567)
134
148
 
135
149
  ***
136
150
 
@@ -144,7 +158,7 @@ An object representing a withdrawal transaction
144
158
 
145
159
  #### Defined in
146
160
 
147
- [types.ts:568](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L568)
161
+ [types.ts:581](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L581)
148
162
 
149
163
  ***
150
164
 
@@ -158,4 +172,4 @@ An object representing a withdrawal transaction
158
172
 
159
173
  #### Defined in
160
174
 
161
- [types.ts:523](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L523)
175
+ [types.ts:535](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L535)
@@ -33,4 +33,4 @@ The address format and validation rules depend on the underlying blockchain.
33
33
 
34
34
  ## Defined in
35
35
 
36
- [types.ts:167](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L167)
36
+ [types.ts:167](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L167)
@@ -36,4 +36,4 @@ Format: `{caip2}:{address}`
36
36
 
37
37
  ## Defined in
38
38
 
39
- [types.ts:74](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L74)
39
+ [types.ts:74](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L74)
@@ -37,4 +37,4 @@ Format: `{caip2}/{asset_namespace}:{asset_reference}`
37
37
 
38
38
  ## Defined in
39
39
 
40
- [types.ts:92](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L92)
40
+ [types.ts:92](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L92)
@@ -36,4 +36,4 @@ Format: `namespace:reference`
36
36
 
37
37
  ## Defined in
38
38
 
39
- [types.ts:57](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L57)
39
+ [types.ts:57](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L57)
@@ -12,4 +12,4 @@ Chain Agnostic Payload Identifier
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:98](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L98)
15
+ [types.ts:98](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L98)
@@ -20,4 +20,4 @@ Represents a cancel component message
20
20
 
21
21
  ## Defined in
22
22
 
23
- [types.ts:932](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L932)
23
+ [types.ts:941](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L941)
@@ -32,4 +32,4 @@ The Response object which wraps T
32
32
 
33
33
  ## Defined in
34
34
 
35
- [types.ts:881](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L881)
35
+ [types.ts:890](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L890)
@@ -36,4 +36,4 @@ through these message types:
36
36
 
37
37
  ## Defined in
38
38
 
39
- [types.ts:970](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L970)
39
+ [types.ts:979](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L979)
@@ -12,4 +12,4 @@ An object representing options for a Connection Request
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:626](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L626)
15
+ [types.ts:639](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L639)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Type Alias: CounterpartyAssistConfig
8
8
 
9
- > **CounterpartyAssistConfig**: \{ `enabled`: `boolean`; \} \| `{ [key in PersonType]: { enabled?: boolean } }`
9
+ > **CounterpartyAssistConfig**: `boolean` \| \{ `counterpartyTypes`: [`PersonType`](../enumerations/PersonType.md)[]; \}
10
10
 
11
11
  Counterparty Assist Configuration options for recipient selection
12
12
 
@@ -16,4 +16,4 @@ Controls for each person type, whether to show the share feature or not.
16
16
 
17
17
  ## Defined in
18
18
 
19
- [types.ts:791](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L791)
19
+ [types.ts:804](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L804)
@@ -12,4 +12,4 @@ A crypto credential
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:192](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L192)
15
+ [types.ts:192](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L192)
@@ -12,4 +12,4 @@ A Decentralized Identifier
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:220](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L220)
15
+ [types.ts:220](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L220)
@@ -35,4 +35,4 @@ Format: `DTI[NNNNN]` where N is a digit
35
35
 
36
36
  ## Defined in
37
37
 
38
- [types.ts:118](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L118)
38
+ [types.ts:118](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L118)
@@ -12,4 +12,4 @@ The destination of a transaction either a blockchain address, a CAIP-19 address,
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:198](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L198)
15
+ [types.ts:198](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L198)
@@ -42,4 +42,4 @@ Identifier code of the error message
42
42
 
43
43
  ## Defined in
44
44
 
45
- [types.ts:921](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L921)
45
+ [types.ts:930](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L930)
@@ -12,4 +12,4 @@ Field properties
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:742](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L742)
15
+ [types.ts:755](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L755)
@@ -22,4 +22,4 @@ Field type configuration
22
22
 
23
23
  ## Defined in
24
24
 
25
- [types.ts:755](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L755)
25
+ [types.ts:768](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L768)
@@ -34,4 +34,4 @@ without requiring full reinitialization.
34
34
 
35
35
  ## Defined in
36
36
 
37
- [types.ts:1033](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1033)
37
+ [types.ts:1042](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L1042)
@@ -12,4 +12,4 @@
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:232](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L232)
15
+ [types.ts:232](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L232)
@@ -42,4 +42,4 @@ Array of validation errors
42
42
 
43
43
  ## Defined in
44
44
 
45
- [types.ts:943](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L943)
45
+ [types.ts:952](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L952)
@@ -12,4 +12,4 @@ A LEI Legal Entity Identifier
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:226](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L226)
15
+ [types.ts:226](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L226)
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [types.ts:449](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L449)
13
+ [types.ts:461](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L461)
@@ -12,4 +12,4 @@ Field properties for legal person fields
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:463](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L463)
15
+ [types.ts:475](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L475)
@@ -18,4 +18,4 @@ Field properties for national identifier type selection
18
18
 
19
19
  ## Defined in
20
20
 
21
- [types.ts:399](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L399)
21
+ [types.ts:411](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L411)
@@ -12,4 +12,4 @@ Field names for NaturalPerson
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:384](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L384)
15
+ [types.ts:396](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L396)
@@ -12,4 +12,4 @@ Field properties for natural person fields
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:407](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L407)
15
+ [types.ts:419](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L419)
@@ -33,4 +33,4 @@ system that may be used alongside CAIP-19 and DTI identifiers.
33
33
 
34
34
  ## Defined in
35
35
 
36
- [types.ts:140](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L140)
36
+ [types.ts:140](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L140)
@@ -18,4 +18,4 @@ Represents a ready component message
18
18
 
19
19
  ## Defined in
20
20
 
21
- [types.ts:890](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L890)
21
+ [types.ts:899](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L899)
@@ -24,4 +24,4 @@ Represents a resize request component message. This is handled by the library.
24
24
 
25
25
  ## Defined in
26
26
 
27
- [types.ts:898](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L898)
27
+ [types.ts:907](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L907)
@@ -12,4 +12,4 @@ The source of a transaction
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:208](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L208)
15
+ [types.ts:208](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L208)
@@ -34,4 +34,4 @@ The theme of the Notabene SDK
34
34
 
35
35
  ## Defined in
36
36
 
37
- [types.ts:238](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L238)
37
+ [types.ts:238](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L238)
@@ -12,4 +12,4 @@ The asset of a transaction either a Notabene asset, a CAIP-19 asset, or a DTI.
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:146](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L146)
15
+ [types.ts:146](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L146)
@@ -34,4 +34,4 @@ VASPs and blockchain networks while maintaining privacy.
34
34
 
35
35
  ## Defined in
36
36
 
37
- [types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L187)
37
+ [types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L187)
@@ -12,4 +12,4 @@ A Uniform Resource Identifier
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:214](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L214)
15
+ [types.ts:214](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L214)
@@ -24,4 +24,4 @@ Format: 8-4-4-4-12 hexadecimal digits
24
24
 
25
25
  ## Defined in
26
26
 
27
- [types.ts:40](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L40)
27
+ [types.ts:40](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L40)
@@ -51,4 +51,4 @@ and its configuration without requiring a full reload/reinitialize.
51
51
 
52
52
  ## Defined in
53
53
 
54
- [types.ts:1011](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L1011)
54
+ [types.ts:1020](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L1020)
@@ -33,4 +33,4 @@ Used for backwards compatibility with V1 API transaction payloads:
33
33
 
34
34
  ## Defined in
35
35
 
36
- [types.ts:657](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L657)
36
+ [types.ts:670](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L670)
@@ -54,4 +54,4 @@ Transaction payload suitable for calling Notabene v1 tx/create
54
54
 
55
55
  ## Defined in
56
56
 
57
- [types.ts:663](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L663)
57
+ [types.ts:676](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L676)
@@ -26,4 +26,4 @@ Options for which VASPs to be searchable
26
26
 
27
27
  ## Defined in
28
28
 
29
- [types.ts:777](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L777)
29
+ [types.ts:790](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L790)
@@ -22,4 +22,4 @@ Validation error
22
22
 
23
23
  ## Defined in
24
24
 
25
- [types.ts:733](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L733)
25
+ [types.ts:746](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/types.ts#L746)
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "author": "Notabene <developers@notabene.id>",
11
11
  "license": "MIT",
12
12
  "packageManager": "yarn@4.5.1",
13
- "version": "2.9.3",
13
+ "version": "2.10.0-next.4",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
@@ -53,6 +53,7 @@
53
53
  "build:dev": "yarn build && yarn dev",
54
54
  "build:clean": "rimraf dist ts-out coverage temp",
55
55
  "build": "vite build && yarn typecheck && api-extractor run --local && node scripts/copy-types.mjs && yarn docs",
56
+ "build:no-docs": "vite build && yarn typecheck && api-extractor run --local && node scripts/copy-types.mjs",
56
57
  "lint": "eslint . --max-warnings 0",
57
58
  "lint:fix": "yarn lint --fix --cache --no-warn-ignored",
58
59
  "format": "prettier --write --cache .",