@notabene/javascript-sdk 2.2.1 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/dist/notabene.cjs +1 -1
  2. package/dist/notabene.d.ts +18 -2
  3. package/dist/notabene.js +10 -10
  4. package/dist/tsdoc-metadata.json +1 -1
  5. package/docs/README.md +1 -1
  6. package/docs/_media/TransactionOptions.md +10 -10
  7. package/docs/ivms/types/README.md +1 -1
  8. package/docs/ivms/types/enumerations/PayloadVersionCode.md +3 -3
  9. package/docs/ivms/types/interfaces/PayloadMetadata.md +3 -3
  10. package/docs/ivms/types/type-aliases/Address.md +2 -2
  11. package/docs/ivms/types/type-aliases/AddressTypeCode.md +2 -2
  12. package/docs/ivms/types/type-aliases/Beneficiary.md +2 -2
  13. package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +2 -2
  14. package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +2 -2
  15. package/docs/ivms/types/type-aliases/ISOCountryCode.md +2 -2
  16. package/docs/ivms/types/type-aliases/ISODate.md +2 -2
  17. package/docs/ivms/types/type-aliases/IVMS101.md +2 -2
  18. package/docs/ivms/types/type-aliases/IntermediaryVASP.md +2 -2
  19. package/docs/ivms/types/type-aliases/LegalPerson.md +2 -2
  20. package/docs/ivms/types/type-aliases/LegalPersonName.md +2 -2
  21. package/docs/ivms/types/type-aliases/LegalPersonNameID.md +2 -2
  22. package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +2 -2
  23. package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +2 -2
  24. package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +2 -2
  25. package/docs/ivms/types/type-aliases/NationalIdentification.md +2 -2
  26. package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +2 -2
  27. package/docs/ivms/types/type-aliases/NaturalPerson.md +2 -2
  28. package/docs/ivms/types/type-aliases/NaturalPersonName.md +2 -2
  29. package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +2 -2
  30. package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +2 -2
  31. package/docs/ivms/types/type-aliases/OriginatingVASP.md +2 -2
  32. package/docs/ivms/types/type-aliases/Originator.md +2 -2
  33. package/docs/ivms/types/type-aliases/Person.md +2 -2
  34. package/docs/ivms/types/type-aliases/TransferPath.md +2 -2
  35. package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +2 -2
  36. package/docs/modules.md +1 -1
  37. package/docs/notabene/README.md +7 -1
  38. package/docs/notabene/classes/EmbeddedComponent.md +57 -31
  39. package/docs/notabene/classes/default.md +61 -25
  40. package/docs/notabene/functions/decodeFragmentToObject.md +5 -3
  41. package/docs/notabene/interfaces/NotabeneConfig.md +6 -6
  42. package/docs/notabene/type-aliases/MessageCallback.md +5 -3
  43. package/docs/types/README.md +2 -1
  44. package/docs/types/enumerations/AgentType.md +3 -3
  45. package/docs/types/enumerations/CMType.md +18 -7
  46. package/docs/types/enumerations/HMType.md +3 -3
  47. package/docs/types/enumerations/PersonType.md +4 -4
  48. package/docs/types/enumerations/ProofStatus.md +5 -5
  49. package/docs/types/enumerations/ProofTypes.md +36 -13
  50. package/docs/types/enumerations/Status.md +6 -6
  51. package/docs/types/enumerations/VASPSearchControl.md +3 -3
  52. package/docs/types/enumerations/ValidationSections.md +5 -5
  53. package/docs/types/interfaces/Agent.md +7 -7
  54. package/docs/types/interfaces/CallbackOptions.md +3 -3
  55. package/docs/types/interfaces/ComponentRequest.md +3 -3
  56. package/docs/types/interfaces/ComponentResponse.md +5 -5
  57. package/docs/types/interfaces/ConnectionRecord.md +8 -8
  58. package/docs/types/interfaces/ConnectionRequest.md +4 -4
  59. package/docs/types/interfaces/Counterparty.md +11 -11
  60. package/docs/types/interfaces/DeclarationProof.md +7 -7
  61. package/docs/types/interfaces/Deposit.md +10 -10
  62. package/docs/types/interfaces/DepositRequest.md +8 -8
  63. package/docs/types/interfaces/DepositRequestOptions.md +2 -2
  64. package/docs/types/interfaces/LegalPerson.md +14 -14
  65. package/docs/types/interfaces/MicroTransferProof.md +10 -10
  66. package/docs/types/interfaces/NaturalPerson.md +14 -14
  67. package/docs/types/interfaces/OwnershipProof.md +5 -5
  68. package/docs/types/interfaces/ScreenshotProof.md +6 -6
  69. package/docs/types/interfaces/SignatureProof.md +19 -9
  70. package/docs/types/interfaces/ThresholdOptions.md +4 -4
  71. package/docs/types/interfaces/Transaction.md +9 -9
  72. package/docs/types/interfaces/TransactionOptions.md +10 -10
  73. package/docs/types/interfaces/TransactionResponse.md +9 -9
  74. package/docs/types/interfaces/VASP.md +10 -10
  75. package/docs/types/interfaces/Wallet.md +9 -9
  76. package/docs/types/interfaces/Withdrawal.md +10 -10
  77. package/docs/types/type-aliases/BlockchainAddress.md +2 -2
  78. package/docs/types/type-aliases/CAIP10.md +2 -2
  79. package/docs/types/type-aliases/CAIP19.md +2 -2
  80. package/docs/types/type-aliases/CAIP2.md +2 -2
  81. package/docs/types/type-aliases/CAIP220.md +2 -2
  82. package/docs/types/type-aliases/Cancel.md +2 -2
  83. package/docs/types/type-aliases/Completed.md +2 -2
  84. package/docs/types/type-aliases/ComponentMessage.md +3 -3
  85. package/docs/types/type-aliases/ConnectionOptions.md +2 -2
  86. package/docs/types/type-aliases/CryptoCredential.md +2 -2
  87. package/docs/types/type-aliases/DID.md +2 -2
  88. package/docs/types/type-aliases/DTI.md +2 -2
  89. package/docs/types/type-aliases/Destination.md +2 -2
  90. package/docs/types/type-aliases/Error.md +2 -2
  91. package/docs/types/type-aliases/FieldOptions.md +3 -3
  92. package/docs/types/type-aliases/FieldTypes.md +2 -2
  93. package/docs/types/type-aliases/HostMessage.md +2 -2
  94. package/docs/types/type-aliases/ISOCurrency.md +2 -2
  95. package/docs/types/type-aliases/InvalidValue.md +2 -2
  96. package/docs/types/type-aliases/LEI.md +2 -2
  97. package/docs/types/type-aliases/LegalPersonFieldName.md +2 -2
  98. package/docs/types/type-aliases/LegalPersonFields.md +2 -2
  99. package/docs/types/type-aliases/NaturalPersonFieldName.md +2 -2
  100. package/docs/types/type-aliases/NaturalPersonFields.md +2 -2
  101. package/docs/types/type-aliases/NotabeneAsset.md +2 -2
  102. package/docs/types/type-aliases/Ready.md +21 -0
  103. package/docs/types/type-aliases/ResizeRequest.md +2 -2
  104. package/docs/types/type-aliases/Source.md +2 -2
  105. package/docs/types/type-aliases/Theme.md +2 -2
  106. package/docs/types/type-aliases/TransactionAsset.md +2 -2
  107. package/docs/types/type-aliases/TravelAddress.md +2 -2
  108. package/docs/types/type-aliases/URI.md +2 -2
  109. package/docs/types/type-aliases/UUID.md +2 -2
  110. package/docs/types/type-aliases/UpdateValue.md +2 -2
  111. package/docs/types/type-aliases/V1Asset.md +3 -3
  112. package/docs/types/type-aliases/V1Transaction.md +2 -2
  113. package/docs/types/type-aliases/VASPOptions.md +2 -2
  114. package/docs/types/type-aliases/ValidationError.md +2 -2
  115. package/package.json +4 -4
  116. package/src/notabene.ts +2 -0
  117. package/src/types.ts +19 -0
package/docs/ivms/types/type-aliases/Person.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -27,4 +27,4 @@ Natural person information
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:277](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/ivms/types.ts#L277)
30
+ [ivms/types.ts:277](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/ivms/types.ts#L277)
package/docs/ivms/types/type-aliases/TransferPath.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -21,4 +21,4 @@ Array of intermediary VASPs involved in the transfer
21
21
 
22
22
  ## Defined in
23
23
 
24
- [ivms/types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/ivms/types.ts#L345)
24
+ [ivms/types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/ivms/types.ts#L345)
package/docs/ivms/types/type-aliases/TransliterationMethodCode.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -13,4 +13,4 @@ Specifies the method used to transliterate text
13
13
 
14
14
  ## Defined in
15
15
 
16
- [ivms/types.ts:71](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/ivms/types.ts#L71)
16
+ [ivms/types.ts:71](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/ivms/types.ts#L71)
package/docs/modules.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](README.md)
2
2
 
3
3
  ***
4
4
 
package/docs/notabene/README.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -249,6 +249,12 @@ Re-exports [ProofTypes](../types/enumerations/ProofTypes.md)
249
249
 
250
250
  ***
251
251
 
252
+ ### Ready
253
+
254
+ Re-exports [Ready](../types/type-aliases/Ready.md)
255
+
256
+ ***
257
+
252
258
  ### ResizeRequest
253
259
 
254
260
  Re-exports [ResizeRequest](../types/type-aliases/ResizeRequest.md)
package/docs/notabene/classes/EmbeddedComponent.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -24,15 +24,21 @@ Creates an instance of EmbeddedComponent.
24
24
 
25
25
  #### Parameters
26
26
 
27
- • **url**: `string`
27
+ ##### url
28
+
29
+ `string`
28
30
 
29
31
  The URL of the embedded component
30
32
 
31
- • **value**: `Partial`\<`V`\>
33
+ ##### value
34
+
35
+ `Partial`\<`V`\>
32
36
 
33
37
  The initial transaction value
34
38
 
35
- • **options?**: `O`
39
+ ##### options?
40
+
41
+ `O`
36
42
 
37
43
  #### Returns
38
44
 
@@ -40,7 +46,7 @@ The initial transaction value
40
46
 
41
47
  #### Defined in
42
48
 
43
- [components/EmbeddedComponent.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L34)
49
+ [components/EmbeddedComponent.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L34)
44
50
 
45
51
  ## Accessors
46
52
 
@@ -56,7 +62,7 @@ The initial transaction value
56
62
 
57
63
  #### Defined in
58
64
 
59
- [components/EmbeddedComponent.ts:72](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L72)
65
+ [components/EmbeddedComponent.ts:72](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L72)
60
66
 
61
67
  ***
62
68
 
@@ -72,7 +78,7 @@ The initial transaction value
72
78
 
73
79
  #### Defined in
74
80
 
75
- [components/EmbeddedComponent.ts:68](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L68)
81
+ [components/EmbeddedComponent.ts:68](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L68)
76
82
 
77
83
  ***
78
84
 
@@ -92,7 +98,7 @@ The URL of the embedded component
92
98
 
93
99
  #### Defined in
94
100
 
95
- [components/EmbeddedComponent.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L56)
101
+ [components/EmbeddedComponent.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L56)
96
102
 
97
103
  ***
98
104
 
@@ -112,7 +118,7 @@ The current transaction value
112
118
 
113
119
  #### Defined in
114
120
 
115
- [components/EmbeddedComponent.ts:64](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L64)
121
+ [components/EmbeddedComponent.ts:64](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L64)
116
122
 
117
123
  ## Methods
118
124
 
@@ -128,7 +134,7 @@ Closes the modal dialog
128
134
 
129
135
  #### Defined in
130
136
 
131
- [components/EmbeddedComponent.ts:240](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L240)
137
+ [components/EmbeddedComponent.ts:240](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L240)
132
138
 
133
139
  ***
134
140
 
@@ -146,7 +152,7 @@ A promise that resolves with the transaction response
146
152
 
147
153
  #### Defined in
148
154
 
149
- [components/EmbeddedComponent.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L173)
155
+ [components/EmbeddedComponent.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L173)
150
156
 
151
157
  ***
152
158
 
@@ -158,11 +164,15 @@ Embeds the component into a parent element
158
164
 
159
165
  #### Parameters
160
166
 
161
- • **parent**: `Element`
167
+ ##### parent
168
+
169
+ `Element`
162
170
 
163
171
  The parent element to embed the component into
164
172
 
165
- • **modal**: `boolean` = `false`
173
+ ##### modal
174
+
175
+ `boolean` = `false`
166
176
 
167
177
  #### Returns
168
178
 
@@ -170,7 +180,7 @@ The parent element to embed the component into
170
180
 
171
181
  #### Defined in
172
182
 
173
- [components/EmbeddedComponent.ts:100](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L100)
183
+ [components/EmbeddedComponent.ts:100](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L100)
174
184
 
175
185
  ***
176
186
 
@@ -182,7 +192,9 @@ Mounts the component to a parent element
182
192
 
183
193
  #### Parameters
184
194
 
185
- • **parentId**: `string`
195
+ ##### parentId
196
+
197
+ `string`
186
198
 
187
199
  The ID of the parent element
188
200
 
@@ -196,7 +208,7 @@ Will throw an error if the parent element is not found
196
208
 
197
209
  #### Defined in
198
210
 
199
- [components/EmbeddedComponent.ts:90](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L90)
211
+ [components/EmbeddedComponent.ts:90](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L90)
200
212
 
201
213
  ***
202
214
 
@@ -208,11 +220,15 @@ Removes an event listener for a specific message type
208
220
 
209
221
  #### Parameters
210
222
 
211
- • **messageType**: `string`
223
+ ##### messageType
224
+
225
+ `string`
212
226
 
213
227
  The type of message to stop listening for
214
228
 
215
- • **callback**: [`MessageCallback`](../type-aliases/MessageCallback.md)\<`V`\>
229
+ ##### callback
230
+
231
+ [`MessageCallback`](../type-aliases/MessageCallback.md)\<`V`\>
216
232
 
217
233
  The callback function to remove
218
234
 
@@ -222,7 +238,7 @@ The callback function to remove
222
238
 
223
239
  #### Defined in
224
240
 
225
- [components/EmbeddedComponent.ts:154](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L154)
241
+ [components/EmbeddedComponent.ts:154](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L154)
226
242
 
227
243
  ***
228
244
 
@@ -234,11 +250,15 @@ Adds an event listener for a specific message type
234
250
 
235
251
  #### Parameters
236
252
 
237
- • **messageType**: `string`
253
+ ##### messageType
254
+
255
+ `string`
238
256
 
239
257
  The type of message to listen for
240
258
 
241
- • **callback**: [`MessageCallback`](../type-aliases/MessageCallback.md)\<`V`\>
259
+ ##### callback
260
+
261
+ [`MessageCallback`](../type-aliases/MessageCallback.md)\<`V`\>
242
262
 
243
263
  The callback function to execute when the message is received
244
264
 
@@ -252,7 +272,7 @@ The callback function to execute when the message is received
252
272
 
253
273
  #### Defined in
254
274
 
255
- [components/EmbeddedComponent.ts:144](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L144)
275
+ [components/EmbeddedComponent.ts:144](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L144)
256
276
 
257
277
  ***
258
278
 
@@ -268,7 +288,7 @@ Opens the component URL in the current window
268
288
 
269
289
  #### Defined in
270
290
 
271
- [components/EmbeddedComponent.ts:80](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L80)
291
+ [components/EmbeddedComponent.ts:80](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L80)
272
292
 
273
293
  ***
274
294
 
@@ -284,7 +304,7 @@ Opens the component in a modal dialog
284
304
 
285
305
  #### Defined in
286
306
 
287
- [components/EmbeddedComponent.ts:202](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L202)
307
+ [components/EmbeddedComponent.ts:202](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L202)
288
308
 
289
309
  ***
290
310
 
@@ -307,7 +327,7 @@ A promise that resolves with the transaction response
307
327
 
308
328
  #### Defined in
309
329
 
310
- [components/EmbeddedComponent.ts:255](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L255)
330
+ [components/EmbeddedComponent.ts:255](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L255)
311
331
 
312
332
  ***
313
333
 
@@ -321,7 +341,7 @@ A promise that resolves with the transaction response
321
341
 
322
342
  #### Defined in
323
343
 
324
- [components/EmbeddedComponent.ts:126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L126)
344
+ [components/EmbeddedComponent.ts:126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L126)
325
345
 
326
346
  ***
327
347
 
@@ -333,7 +353,9 @@ Sends a message to the embedded component
333
353
 
334
354
  #### Parameters
335
355
 
336
- • **message**: [`HostMessage`](../../types/type-aliases/HostMessage.md)\<`V`, `O`\>
356
+ ##### message
357
+
358
+ [`HostMessage`](../../types/type-aliases/HostMessage.md)\<`V`, `O`\>
337
359
 
338
360
  The message to send
339
361
 
@@ -343,7 +365,7 @@ The message to send
343
365
 
344
366
  #### Defined in
345
367
 
346
- [components/EmbeddedComponent.ts:134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L134)
368
+ [components/EmbeddedComponent.ts:134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L134)
347
369
 
348
370
  ***
349
371
 
@@ -355,11 +377,15 @@ Updates the transaction value and sends an update message to the component
355
377
 
356
378
  #### Parameters
357
379
 
358
- • **value**: `Partial`\<`V`\>
380
+ ##### value
381
+
382
+ `Partial`\<`V`\>
359
383
 
360
384
  The new transaction value
361
385
 
362
- • **options?**: `O`
386
+ ##### options?
387
+
388
+ `O`
363
389
 
364
390
  #### Returns
365
391
 
@@ -367,4 +393,4 @@ The new transaction value
367
393
 
368
394
  #### Defined in
369
395
 
370
- [components/EmbeddedComponent.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/components/EmbeddedComponent.ts#L162)
396
+ [components/EmbeddedComponent.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/components/EmbeddedComponent.ts#L162)
package/docs/notabene/classes/default.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -22,7 +22,9 @@ Creates a new instance of the Notabene SDK
22
22
 
23
23
  #### Parameters
24
24
 
25
- • **config**: [`NotabeneConfig`](../interfaces/NotabeneConfig.md)
25
+ ##### config
26
+
27
+ [`NotabeneConfig`](../interfaces/NotabeneConfig.md)
26
28
 
27
29
  Configuration options for the Notabene SDK
28
30
 
@@ -32,7 +34,7 @@ Configuration options for the Notabene SDK
32
34
 
33
35
  #### Defined in
34
36
 
35
- [notabene.ts:185](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L185)
37
+ [notabene.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L187)
36
38
 
37
39
  ## Methods
38
40
 
@@ -52,19 +54,27 @@ Generates a URL for a Notabene component
52
54
 
53
55
  #### Parameters
54
56
 
55
- • **path**: `string`
57
+ ##### path
58
+
59
+ `string`
56
60
 
57
61
  The path of the component
58
62
 
59
- • **value**: `V`
63
+ ##### value
64
+
65
+ `V`
60
66
 
61
67
  Transaction data
62
68
 
63
- • **configuration?**: `O`
69
+ ##### configuration?
70
+
71
+ `O`
64
72
 
65
73
  Optional transaction configuration
66
74
 
67
- • **callbacks?**: [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
75
+ ##### callbacks?
76
+
77
+ [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
68
78
 
69
79
  Optional callback configuration
70
80
 
@@ -76,7 +86,7 @@ component URL
76
86
 
77
87
  #### Defined in
78
88
 
79
- [notabene.ts:203](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L203)
89
+ [notabene.ts:205](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L205)
80
90
 
81
91
  ***
82
92
 
@@ -96,19 +106,27 @@ Creates a new embedded component
96
106
 
97
107
  #### Parameters
98
108
 
99
- • **path**: `string`
109
+ ##### path
110
+
111
+ `string`
100
112
 
101
113
  The path of the component
102
114
 
103
- • **value**: `Partial`\<`V`\>
115
+ ##### value
116
+
117
+ `Partial`\<`V`\>
104
118
 
105
119
  Transaction data
106
120
 
107
- • **options?**: `O`
121
+ ##### options?
122
+
123
+ `O`
108
124
 
109
125
  Optional transaction options
110
126
 
111
- • **callbacks?**: [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
127
+ ##### callbacks?
128
+
129
+ [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
112
130
 
113
131
  Optional callback configuration
114
132
 
@@ -120,7 +138,7 @@ A new EmbeddedComponent instance
120
138
 
121
139
  #### Defined in
122
140
 
123
- [notabene.ts:245](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L245)
141
+ [notabene.ts:247](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L247)
124
142
 
125
143
  ***
126
144
 
@@ -134,15 +152,21 @@ Creates a connect component
134
152
 
135
153
  #### Parameters
136
154
 
137
- • **value**: [`ConnectionRequest`](../../types/interfaces/ConnectionRequest.md)
155
+ ##### value
156
+
157
+ [`ConnectionRequest`](../../types/interfaces/ConnectionRequest.md)
138
158
 
139
159
  Connection request data
140
160
 
141
- • **options?**: [`ConnectionOptions`](../../types/type-aliases/ConnectionOptions.md)
161
+ ##### options?
162
+
163
+ [`ConnectionOptions`](../../types/type-aliases/ConnectionOptions.md)
142
164
 
143
165
  Optional transaction options
144
166
 
145
- • **callbacks?**: [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
167
+ ##### callbacks?
168
+
169
+ [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
146
170
 
147
171
  Optional callback configuration
148
172
 
@@ -154,7 +178,7 @@ A new EmbeddedComponent instance for connection
154
178
 
155
179
  #### Defined in
156
180
 
157
- [notabene.ts:288](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L288)
181
+ [notabene.ts:290](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L290)
158
182
 
159
183
  ***
160
184
 
@@ -166,15 +190,21 @@ Creates a deposit request component
166
190
 
167
191
  #### Parameters
168
192
 
169
- • **value**: [`DepositRequest`](../../types/interfaces/DepositRequest.md)
193
+ ##### value
194
+
195
+ [`DepositRequest`](../../types/interfaces/DepositRequest.md)
170
196
 
171
197
  Deposit request data
172
198
 
173
- • **options?**: [`DepositRequestOptions`](../../types/interfaces/DepositRequestOptions.md)
199
+ ##### options?
200
+
201
+ [`DepositRequestOptions`](../../types/interfaces/DepositRequestOptions.md)
174
202
 
175
203
  Optional transaction options
176
204
 
177
- • **callbacks?**: [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
205
+ ##### callbacks?
206
+
207
+ [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
178
208
 
179
209
  Optional callback configuration
180
210
 
@@ -186,7 +216,7 @@ A new EmbeddedComponent instance for deposit requests
186
216
 
187
217
  #### Defined in
188
218
 
189
- [notabene.ts:310](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L310)
219
+ [notabene.ts:312](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L312)
190
220
 
191
221
  ***
192
222
 
@@ -198,15 +228,21 @@ Creates a withdrawal assist component
198
228
 
199
229
  #### Parameters
200
230
 
201
- • **value**: `Partial`\<[`Withdrawal`](../../types/interfaces/Withdrawal.md)\>
231
+ ##### value
232
+
233
+ `Partial`\<[`Withdrawal`](../../types/interfaces/Withdrawal.md)\>
202
234
 
203
235
  Withdrawal transaction data
204
236
 
205
- • **options?**: [`TransactionOptions`](../../types/interfaces/TransactionOptions.md)
237
+ ##### options?
238
+
239
+ [`TransactionOptions`](../../types/interfaces/TransactionOptions.md)
206
240
 
207
241
  Optional transaction options
208
242
 
209
- • **callbacks?**: [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
243
+ ##### callbacks?
244
+
245
+ [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
210
246
 
211
247
  Optional callback configuration
212
248
 
@@ -218,4 +254,4 @@ A new EmbeddedComponent instance for withdrawal assistance
218
254
 
219
255
  #### Defined in
220
256
 
221
- [notabene.ts:266](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L266)
257
+ [notabene.ts:268](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L268)
package/docs/notabene/functions/decodeFragmentToObject.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,7 +12,9 @@ Decodes a URL fragment into an object
12
12
 
13
13
  ## Parameters
14
14
 
15
- • **fragment**: `string`
15
+ ### fragment
16
+
17
+ `string`
16
18
 
17
19
  The URL fragment to decode
18
20
 
@@ -24,4 +26,4 @@ An object containing the decoded key-value pairs
24
26
 
25
27
  ## Defined in
26
28
 
27
- [utils/urls.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/utils/urls.ts#L22)
29
+ [utils/urls.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/utils/urls.ts#L22)
package/docs/notabene/interfaces/NotabeneConfig.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -18,7 +18,7 @@ The authentication token for the Notabene API
18
18
 
19
19
  #### Defined in
20
20
 
21
- [notabene.ts:147](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L147)
21
+ [notabene.ts:149](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L149)
22
22
 
23
23
  ***
24
24
 
@@ -30,7 +30,7 @@ The locale to use for the UX components
30
30
 
31
31
  #### Defined in
32
32
 
33
- [notabene.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L162)
33
+ [notabene.ts:164](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L164)
34
34
 
35
35
  ***
36
36
 
@@ -42,7 +42,7 @@ The URL of the Notabene API node
42
42
 
43
43
  #### Defined in
44
44
 
45
- [notabene.ts:142](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L142)
45
+ [notabene.ts:144](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L144)
46
46
 
47
47
  ***
48
48
 
@@ -54,7 +54,7 @@ Custom theme configuration for the UX components
54
54
 
55
55
  #### Defined in
56
56
 
57
- [notabene.ts:157](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L157)
57
+ [notabene.ts:159](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L159)
58
58
 
59
59
  ***
60
60
 
@@ -66,4 +66,4 @@ The URL of the Notabene UX components
66
66
 
67
67
  #### Defined in
68
68
 
69
- [notabene.ts:152](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/notabene.ts#L152)
69
+ [notabene.ts:154](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/notabene.ts#L154)
package/docs/notabene/type-aliases/MessageCallback.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -18,7 +18,9 @@ The type of data contained in the component message
18
18
 
19
19
  ## Parameters
20
20
 
21
- • **message**: [`ComponentMessage`](../../types/type-aliases/ComponentMessage.md)\<`T`\>
21
+ ### message
22
+
23
+ [`ComponentMessage`](../../types/type-aliases/ComponentMessage.md)\<`T`\>
22
24
 
23
25
  The message object containing the component data and type
24
26
 
@@ -28,4 +30,4 @@ The message object containing the component data and type
28
30
 
29
31
  ## Defined in
30
32
 
31
- [utils/MessageEventManager.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/utils/MessageEventManager.ts#L11)
33
+ [utils/MessageEventManager.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/utils/MessageEventManager.ts#L11)
package/docs/types/README.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -74,6 +74,7 @@
74
74
  - [NaturalPersonFieldName](type-aliases/NaturalPersonFieldName.md)
75
75
  - [NaturalPersonFields](type-aliases/NaturalPersonFields.md)
76
76
  - [NotabeneAsset](type-aliases/NotabeneAsset.md)
77
+ - [Ready](type-aliases/Ready.md)
77
78
  - [ResizeRequest](type-aliases/ResizeRequest.md)
78
79
  - [Source](type-aliases/Source.md)
79
80
  - [Theme](type-aliases/Theme.md)
package/docs/types/enumerations/AgentType.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -16,7 +16,7 @@ The type of Agent. Either a wallet or a VASP
16
16
 
17
17
  #### Defined in
18
18
 
19
- [types.ts:249](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L249)
19
+ [types.ts:249](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L249)
20
20
 
21
21
  ***
22
22
 
@@ -26,4 +26,4 @@ The type of Agent. Either a wallet or a VASP
26
26
 
27
27
  #### Defined in
28
28
 
29
- [types.ts:250](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L250)
29
+ [types.ts:250](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L250)