@notabene/javascript-sdk 2.10.0-next.4 → 2.10.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.
- package/dist/cjs/notabene.cjs +1 -1
- package/dist/cjs/notabene.d.ts +2 -4
- package/dist/cjs/package.json +1 -1
- package/dist/esm/notabene.d.ts +2 -4
- package/dist/esm/notabene.js +12 -12
- package/dist/esm/package.json +1 -1
- package/dist/notabene.d.ts +2 -4
- package/dist/notabene.js +12 -12
- package/docs/README.md +47 -218
- package/docs/_media/TransactionOptions.md +9 -9
- package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
- package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
- package/docs/ivms/types/type-aliases/Address.md +1 -1
- package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
- package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
- package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
- package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
- package/docs/ivms/types/type-aliases/ISODate.md +1 -1
- package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
- package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
- package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
- package/docs/ivms/types/type-aliases/Originator.md +1 -1
- package/docs/ivms/types/type-aliases/Person.md +1 -1
- package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
- package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
- package/docs/notabene/README.md +1 -7
- package/docs/notabene/classes/ConnectionManager.md +5 -19
- package/docs/notabene/classes/EmbeddedComponent.md +17 -17
- package/docs/notabene/classes/default.md +7 -7
- package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
- package/docs/notabene/functions/getRefreshResult.md +3 -11
- package/docs/notabene/interfaces/ConnectionData.md +8 -8
- package/docs/notabene/interfaces/ConnectionMetadata.md +6 -6
- package/docs/notabene/interfaces/ConnectionResponse.md +12 -12
- package/docs/notabene/interfaces/ConnectionResult.md +61 -0
- package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
- package/docs/notabene/type-aliases/ConnectionStatus.md +1 -1
- package/docs/notabene/type-aliases/MessageCallback.md +1 -1
- package/docs/notabene/type-aliases/TransactionType.md +1 -1
- package/docs/types/README.md +0 -1
- package/docs/types/enumerations/AgentType.md +2 -2
- package/docs/types/enumerations/CMType.md +7 -7
- package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
- package/docs/types/enumerations/HMType.md +2 -2
- package/docs/types/enumerations/PersonType.md +3 -3
- package/docs/types/enumerations/ProofStatus.md +4 -4
- package/docs/types/enumerations/ProofTypes.md +17 -27
- package/docs/types/enumerations/Status.md +5 -5
- package/docs/types/enumerations/VASPSearchControl.md +2 -2
- package/docs/types/enumerations/ValidationSections.md +4 -4
- package/docs/types/interfaces/Agent.md +6 -6
- package/docs/types/interfaces/CallbackOptions.md +2 -2
- package/docs/types/interfaces/ComponentRequest.md +2 -2
- package/docs/types/interfaces/ComponentResponse.md +4 -4
- package/docs/types/interfaces/ConnectionRecord.md +7 -7
- package/docs/types/interfaces/ConnectionRequest.md +3 -3
- package/docs/types/interfaces/Counterparty.md +10 -10
- package/docs/types/interfaces/DeclarationProof.md +6 -6
- package/docs/types/interfaces/Deposit.md +11 -25
- package/docs/types/interfaces/DepositRequest.md +9 -9
- package/docs/types/interfaces/DepositRequestOptions.md +1 -1
- package/docs/types/interfaces/DepositTransaction.md +9 -23
- package/docs/types/interfaces/LegalPerson.md +13 -13
- package/docs/types/interfaces/MicroTransferProof.md +9 -9
- package/docs/types/interfaces/NaturalPerson.md +13 -13
- package/docs/types/interfaces/OwnershipProof.md +4 -4
- package/docs/types/interfaces/RefreshSource.md +2 -2
- package/docs/types/interfaces/Refreshable.md +1 -1
- package/docs/types/interfaces/ScreenshotProof.md +5 -5
- package/docs/types/interfaces/SignatureProof.md +10 -10
- package/docs/types/interfaces/ThresholdOptions.md +3 -3
- package/docs/types/interfaces/Transaction.md +8 -18
- package/docs/types/interfaces/TransactionOptions.md +9 -9
- package/docs/types/interfaces/TransactionResponse.md +9 -9
- package/docs/types/interfaces/VASP.md +9 -9
- package/docs/types/interfaces/Wallet.md +8 -8
- package/docs/types/interfaces/Withdrawal.md +10 -24
- package/docs/types/type-aliases/BlockchainAddress.md +1 -1
- package/docs/types/type-aliases/CAIP10.md +1 -1
- package/docs/types/type-aliases/CAIP19.md +1 -1
- package/docs/types/type-aliases/CAIP2.md +1 -1
- package/docs/types/type-aliases/CAIP220.md +1 -1
- package/docs/types/type-aliases/Cancel.md +1 -1
- package/docs/types/type-aliases/Completed.md +1 -1
- package/docs/types/type-aliases/ComponentMessage.md +1 -1
- package/docs/types/type-aliases/ConnectionOptions.md +1 -1
- package/docs/types/type-aliases/CounterpartyAssistConfig.md +2 -2
- package/docs/types/type-aliases/CryptoCredential.md +1 -1
- package/docs/types/type-aliases/DID.md +1 -1
- package/docs/types/type-aliases/DTI.md +1 -1
- package/docs/types/type-aliases/Destination.md +1 -1
- package/docs/types/type-aliases/Error.md +1 -1
- package/docs/types/type-aliases/FieldOptions.md +1 -1
- package/docs/types/type-aliases/FieldTypes.md +1 -1
- package/docs/types/type-aliases/HostMessage.md +1 -1
- package/docs/types/type-aliases/ISOCurrency.md +1 -1
- package/docs/types/type-aliases/InvalidValue.md +1 -1
- package/docs/types/type-aliases/LEI.md +1 -1
- package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
- package/docs/types/type-aliases/LegalPersonFields.md +1 -1
- package/docs/types/type-aliases/NationalIdentifierTypeFieldOptions.md +1 -1
- package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
- package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
- package/docs/types/type-aliases/NotabeneAsset.md +1 -1
- package/docs/types/type-aliases/Ready.md +1 -1
- package/docs/types/type-aliases/ResizeRequest.md +1 -1
- package/docs/types/type-aliases/Source.md +1 -1
- package/docs/types/type-aliases/Theme.md +1 -1
- package/docs/types/type-aliases/TransactionAsset.md +1 -1
- package/docs/types/type-aliases/TravelAddress.md +1 -1
- package/docs/types/type-aliases/URI.md +1 -1
- package/docs/types/type-aliases/UUID.md +1 -1
- package/docs/types/type-aliases/UpdateValue.md +1 -1
- package/docs/types/type-aliases/V1Asset.md +1 -1
- package/docs/types/type-aliases/V1Transaction.md +1 -1
- package/docs/types/type-aliases/VASPOptions.md +1 -1
- package/docs/types/type-aliases/ValidationError.md +1 -1
- package/package.json +1 -1
- package/src/types.ts +0 -2
- package/src/utils/connections.ts +0 -1
- package/docs/_media/getRefreshResult.md +0 -35
- package/docs/notabene/type-aliases/ConnectionResult.md +0 -17
- package/docs/types/interfaces/Account.md +0 -59
|
@@ -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/
|
|
16
|
+
[ivms/types.ts:71](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L71)
|
package/docs/notabene/README.md
CHANGED
|
@@ -19,11 +19,11 @@
|
|
|
19
19
|
- [ConnectionData](interfaces/ConnectionData.md)
|
|
20
20
|
- [ConnectionMetadata](interfaces/ConnectionMetadata.md)
|
|
21
21
|
- [ConnectionResponse](interfaces/ConnectionResponse.md)
|
|
22
|
+
- [ConnectionResult](interfaces/ConnectionResult.md)
|
|
22
23
|
- [NotabeneConfig](interfaces/NotabeneConfig.md)
|
|
23
24
|
|
|
24
25
|
### Type Aliases
|
|
25
26
|
|
|
26
|
-
- [ConnectionResult](type-aliases/ConnectionResult.md)
|
|
27
27
|
- [ConnectionStatus](type-aliases/ConnectionStatus.md)
|
|
28
28
|
- [MessageCallback](type-aliases/MessageCallback.md)
|
|
29
29
|
- [TransactionType](type-aliases/TransactionType.md)
|
|
@@ -35,12 +35,6 @@
|
|
|
35
35
|
|
|
36
36
|
## References
|
|
37
37
|
|
|
38
|
-
### Account
|
|
39
|
-
|
|
40
|
-
Re-exports [Account](../types/interfaces/Account.md)
|
|
41
|
-
|
|
42
|
-
***
|
|
43
|
-
|
|
44
38
|
### Agent
|
|
45
39
|
|
|
46
40
|
Re-exports [Agent](../types/interfaces/Agent.md)
|
|
@@ -26,7 +26,7 @@ Manages encrypted connections using Cloudflare Durable Objects
|
|
|
26
26
|
|
|
27
27
|
#### Defined in
|
|
28
28
|
|
|
29
|
-
[utils/connections.ts:
|
|
29
|
+
[utils/connections.ts:96](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L96)
|
|
30
30
|
|
|
31
31
|
## Methods
|
|
32
32
|
|
|
@@ -48,11 +48,9 @@ Connection ID
|
|
|
48
48
|
|
|
49
49
|
`Promise`\<`void`\>
|
|
50
50
|
|
|
51
|
-
Promise resolving when the connection is closed
|
|
52
|
-
|
|
53
51
|
#### Defined in
|
|
54
52
|
|
|
55
|
-
[utils/connections.ts:
|
|
53
|
+
[utils/connections.ts:237](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L237)
|
|
56
54
|
|
|
57
55
|
***
|
|
58
56
|
|
|
@@ -66,8 +64,6 @@ Creates a new encrypted connection
|
|
|
66
64
|
|
|
67
65
|
• **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
|
|
68
66
|
|
|
69
|
-
Type of component request
|
|
70
|
-
|
|
71
67
|
#### Parameters
|
|
72
68
|
|
|
73
69
|
##### data
|
|
@@ -80,8 +76,6 @@ The component request data to encrypt and store
|
|
|
80
76
|
|
|
81
77
|
[`ConnectionMetadata`](../interfaces/ConnectionMetadata.md)
|
|
82
78
|
|
|
83
|
-
Connection metadata including participants and transaction type
|
|
84
|
-
|
|
85
79
|
#### Returns
|
|
86
80
|
|
|
87
81
|
`Promise`\<[`ConnectionResponse`](../interfaces/ConnectionResponse.md)\<`T`\>\>
|
|
@@ -90,7 +84,7 @@ Promise resolving to connection details including ID, version, and encryption ke
|
|
|
90
84
|
|
|
91
85
|
#### Defined in
|
|
92
86
|
|
|
93
|
-
[utils/connections.ts:
|
|
87
|
+
[utils/connections.ts:106](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L106)
|
|
94
88
|
|
|
95
89
|
***
|
|
96
90
|
|
|
@@ -104,8 +98,6 @@ Retrieves and decrypts connection data
|
|
|
104
98
|
|
|
105
99
|
• **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
|
|
106
100
|
|
|
107
|
-
Type of component request
|
|
108
|
-
|
|
109
101
|
#### Parameters
|
|
110
102
|
|
|
111
103
|
##### id
|
|
@@ -128,7 +120,7 @@ Promise resolving to connection details including decrypted data
|
|
|
128
120
|
|
|
129
121
|
#### Defined in
|
|
130
122
|
|
|
131
|
-
[utils/connections.ts:
|
|
123
|
+
[utils/connections.ts:199](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L199)
|
|
132
124
|
|
|
133
125
|
***
|
|
134
126
|
|
|
@@ -142,8 +134,6 @@ Updates an existing connection with new encrypted data
|
|
|
142
134
|
|
|
143
135
|
• **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
|
|
144
136
|
|
|
145
|
-
Type of component request
|
|
146
|
-
|
|
147
137
|
#### Parameters
|
|
148
138
|
|
|
149
139
|
##### id
|
|
@@ -168,14 +158,10 @@ Current version number
|
|
|
168
158
|
|
|
169
159
|
[`ConnectionStatus`](../type-aliases/ConnectionStatus.md)
|
|
170
160
|
|
|
171
|
-
New connection status
|
|
172
|
-
|
|
173
161
|
##### key
|
|
174
162
|
|
|
175
163
|
`string`
|
|
176
164
|
|
|
177
|
-
Current encryption key
|
|
178
|
-
|
|
179
165
|
#### Returns
|
|
180
166
|
|
|
181
167
|
`Promise`\<[`ConnectionResponse`](../interfaces/ConnectionResponse.md)\<`T`\>\>
|
|
@@ -184,4 +170,4 @@ Promise resolving to updated connection details including new encryption key
|
|
|
184
170
|
|
|
185
171
|
#### Defined in
|
|
186
172
|
|
|
187
|
-
[utils/connections.ts:
|
|
173
|
+
[utils/connections.ts:151](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L151)
|
|
@@ -46,7 +46,7 @@ The initial transaction value
|
|
|
46
46
|
|
|
47
47
|
#### Defined in
|
|
48
48
|
|
|
49
|
-
[components/EmbeddedComponent.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
49
|
+
[components/EmbeddedComponent.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L34)
|
|
50
50
|
|
|
51
51
|
## Accessors
|
|
52
52
|
|
|
@@ -62,7 +62,7 @@ The initial transaction value
|
|
|
62
62
|
|
|
63
63
|
#### Defined in
|
|
64
64
|
|
|
65
|
-
[components/EmbeddedComponent.ts:72](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
65
|
+
[components/EmbeddedComponent.ts:72](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L72)
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
@@ -78,7 +78,7 @@ The initial transaction value
|
|
|
78
78
|
|
|
79
79
|
#### Defined in
|
|
80
80
|
|
|
81
|
-
[components/EmbeddedComponent.ts:68](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
81
|
+
[components/EmbeddedComponent.ts:68](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L68)
|
|
82
82
|
|
|
83
83
|
***
|
|
84
84
|
|
|
@@ -98,7 +98,7 @@ The URL of the embedded component
|
|
|
98
98
|
|
|
99
99
|
#### Defined in
|
|
100
100
|
|
|
101
|
-
[components/EmbeddedComponent.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
101
|
+
[components/EmbeddedComponent.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L56)
|
|
102
102
|
|
|
103
103
|
***
|
|
104
104
|
|
|
@@ -118,7 +118,7 @@ The current transaction value
|
|
|
118
118
|
|
|
119
119
|
#### Defined in
|
|
120
120
|
|
|
121
|
-
[components/EmbeddedComponent.ts:64](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
121
|
+
[components/EmbeddedComponent.ts:64](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L64)
|
|
122
122
|
|
|
123
123
|
## Methods
|
|
124
124
|
|
|
@@ -134,7 +134,7 @@ Closes the modal dialog
|
|
|
134
134
|
|
|
135
135
|
#### Defined in
|
|
136
136
|
|
|
137
|
-
[components/EmbeddedComponent.ts:240](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
137
|
+
[components/EmbeddedComponent.ts:240](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L240)
|
|
138
138
|
|
|
139
139
|
***
|
|
140
140
|
|
|
@@ -152,7 +152,7 @@ A promise that resolves with the transaction response
|
|
|
152
152
|
|
|
153
153
|
#### Defined in
|
|
154
154
|
|
|
155
|
-
[components/EmbeddedComponent.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
155
|
+
[components/EmbeddedComponent.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L173)
|
|
156
156
|
|
|
157
157
|
***
|
|
158
158
|
|
|
@@ -180,7 +180,7 @@ The parent element to embed the component into
|
|
|
180
180
|
|
|
181
181
|
#### Defined in
|
|
182
182
|
|
|
183
|
-
[components/EmbeddedComponent.ts:100](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
183
|
+
[components/EmbeddedComponent.ts:100](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L100)
|
|
184
184
|
|
|
185
185
|
***
|
|
186
186
|
|
|
@@ -208,7 +208,7 @@ Will throw an error if the parent element is not found
|
|
|
208
208
|
|
|
209
209
|
#### Defined in
|
|
210
210
|
|
|
211
|
-
[components/EmbeddedComponent.ts:90](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
211
|
+
[components/EmbeddedComponent.ts:90](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L90)
|
|
212
212
|
|
|
213
213
|
***
|
|
214
214
|
|
|
@@ -238,7 +238,7 @@ The callback function to remove
|
|
|
238
238
|
|
|
239
239
|
#### Defined in
|
|
240
240
|
|
|
241
|
-
[components/EmbeddedComponent.ts:154](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
241
|
+
[components/EmbeddedComponent.ts:154](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L154)
|
|
242
242
|
|
|
243
243
|
***
|
|
244
244
|
|
|
@@ -272,7 +272,7 @@ The callback function to execute when the message is received
|
|
|
272
272
|
|
|
273
273
|
#### Defined in
|
|
274
274
|
|
|
275
|
-
[components/EmbeddedComponent.ts:144](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
275
|
+
[components/EmbeddedComponent.ts:144](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L144)
|
|
276
276
|
|
|
277
277
|
***
|
|
278
278
|
|
|
@@ -288,7 +288,7 @@ Opens the component URL in the current window
|
|
|
288
288
|
|
|
289
289
|
#### Defined in
|
|
290
290
|
|
|
291
|
-
[components/EmbeddedComponent.ts:80](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
291
|
+
[components/EmbeddedComponent.ts:80](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L80)
|
|
292
292
|
|
|
293
293
|
***
|
|
294
294
|
|
|
@@ -304,7 +304,7 @@ Opens the component in a modal dialog
|
|
|
304
304
|
|
|
305
305
|
#### Defined in
|
|
306
306
|
|
|
307
|
-
[components/EmbeddedComponent.ts:202](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
307
|
+
[components/EmbeddedComponent.ts:202](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L202)
|
|
308
308
|
|
|
309
309
|
***
|
|
310
310
|
|
|
@@ -327,7 +327,7 @@ A promise that resolves with the transaction response
|
|
|
327
327
|
|
|
328
328
|
#### Defined in
|
|
329
329
|
|
|
330
|
-
[components/EmbeddedComponent.ts:255](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
330
|
+
[components/EmbeddedComponent.ts:255](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L255)
|
|
331
331
|
|
|
332
332
|
***
|
|
333
333
|
|
|
@@ -341,7 +341,7 @@ A promise that resolves with the transaction response
|
|
|
341
341
|
|
|
342
342
|
#### Defined in
|
|
343
343
|
|
|
344
|
-
[components/EmbeddedComponent.ts:126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
344
|
+
[components/EmbeddedComponent.ts:126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L126)
|
|
345
345
|
|
|
346
346
|
***
|
|
347
347
|
|
|
@@ -365,7 +365,7 @@ The message to send
|
|
|
365
365
|
|
|
366
366
|
#### Defined in
|
|
367
367
|
|
|
368
|
-
[components/EmbeddedComponent.ts:134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
368
|
+
[components/EmbeddedComponent.ts:134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L134)
|
|
369
369
|
|
|
370
370
|
***
|
|
371
371
|
|
|
@@ -393,4 +393,4 @@ The new transaction value
|
|
|
393
393
|
|
|
394
394
|
#### Defined in
|
|
395
395
|
|
|
396
|
-
[components/EmbeddedComponent.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
396
|
+
[components/EmbeddedComponent.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L162)
|
|
@@ -34,7 +34,7 @@ Configuration options for the Notabene SDK
|
|
|
34
34
|
|
|
35
35
|
#### Defined in
|
|
36
36
|
|
|
37
|
-
[notabene.ts:
|
|
37
|
+
[notabene.ts:215](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L215)
|
|
38
38
|
|
|
39
39
|
## Methods
|
|
40
40
|
|
|
@@ -86,7 +86,7 @@ component URL
|
|
|
86
86
|
|
|
87
87
|
#### Defined in
|
|
88
88
|
|
|
89
|
-
[notabene.ts:
|
|
89
|
+
[notabene.ts:233](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L233)
|
|
90
90
|
|
|
91
91
|
***
|
|
92
92
|
|
|
@@ -138,7 +138,7 @@ A new EmbeddedComponent instance
|
|
|
138
138
|
|
|
139
139
|
#### Defined in
|
|
140
140
|
|
|
141
|
-
[notabene.ts:
|
|
141
|
+
[notabene.ts:275](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L275)
|
|
142
142
|
|
|
143
143
|
***
|
|
144
144
|
|
|
@@ -178,7 +178,7 @@ A new EmbeddedComponent instance for connection
|
|
|
178
178
|
|
|
179
179
|
#### Defined in
|
|
180
180
|
|
|
181
|
-
[notabene.ts:
|
|
181
|
+
[notabene.ts:318](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L318)
|
|
182
182
|
|
|
183
183
|
***
|
|
184
184
|
|
|
@@ -216,7 +216,7 @@ A new EmbeddedComponent instance for deposit assistance
|
|
|
216
216
|
|
|
217
217
|
#### Defined in
|
|
218
218
|
|
|
219
|
-
[notabene.ts:
|
|
219
|
+
[notabene.ts:362](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L362)
|
|
220
220
|
|
|
221
221
|
***
|
|
222
222
|
|
|
@@ -254,7 +254,7 @@ A new EmbeddedComponent instance for deposit requests
|
|
|
254
254
|
|
|
255
255
|
#### Defined in
|
|
256
256
|
|
|
257
|
-
[notabene.ts:
|
|
257
|
+
[notabene.ts:340](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L340)
|
|
258
258
|
|
|
259
259
|
***
|
|
260
260
|
|
|
@@ -292,4 +292,4 @@ A new EmbeddedComponent instance for withdrawal assistance
|
|
|
292
292
|
|
|
293
293
|
#### Defined in
|
|
294
294
|
|
|
295
|
-
[notabene.ts:
|
|
295
|
+
[notabene.ts:296](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L296)
|
|
@@ -26,4 +26,4 @@ An object containing the decoded key-value pairs
|
|
|
26
26
|
|
|
27
27
|
## Defined in
|
|
28
28
|
|
|
29
|
-
[utils/urls.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
29
|
+
[utils/urls.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/urls.ts#L22)
|
|
@@ -6,30 +6,22 @@
|
|
|
6
6
|
|
|
7
7
|
# Function: getRefreshResult()
|
|
8
8
|
|
|
9
|
-
> **getRefreshResult**\<`T`\>(`refreshSource`): `Promise`\<[`ConnectionResult`](../
|
|
10
|
-
|
|
11
|
-
Retrieves and processes connection refresh data
|
|
9
|
+
> **getRefreshResult**\<`T`\>(`refreshSource`): `Promise`\<[`ConnectionResult`](../interfaces/ConnectionResult.md)\<`T`\>\>
|
|
12
10
|
|
|
13
11
|
## Type Parameters
|
|
14
12
|
|
|
15
13
|
• **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
|
|
16
14
|
|
|
17
|
-
Type of component request
|
|
18
|
-
|
|
19
15
|
## Parameters
|
|
20
16
|
|
|
21
17
|
### refreshSource
|
|
22
18
|
|
|
23
19
|
[`RefreshSource`](../../types/interfaces/RefreshSource.md)
|
|
24
20
|
|
|
25
|
-
Source information for the refresh operation
|
|
26
|
-
|
|
27
21
|
## Returns
|
|
28
22
|
|
|
29
|
-
`Promise`\<[`ConnectionResult`](../
|
|
30
|
-
|
|
31
|
-
Promise resolving to connection result with decrypted data
|
|
23
|
+
`Promise`\<[`ConnectionResult`](../interfaces/ConnectionResult.md)\<`T`\>\>
|
|
32
24
|
|
|
33
25
|
## Defined in
|
|
34
26
|
|
|
35
|
-
[utils/connections.ts:
|
|
27
|
+
[utils/connections.ts:41](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L41)
|
|
@@ -14,38 +14,38 @@
|
|
|
14
14
|
|
|
15
15
|
### authToken?
|
|
16
16
|
|
|
17
|
-
> `
|
|
17
|
+
> `optional` **authToken**: `string`
|
|
18
18
|
|
|
19
19
|
#### Defined in
|
|
20
20
|
|
|
21
|
-
[utils/connections.ts:
|
|
21
|
+
[utils/connections.ts:14](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L14)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
25
25
|
### result?
|
|
26
26
|
|
|
27
|
-
> `
|
|
27
|
+
> `optional` **result**: [`TransactionResponse`](../../types/interfaces/TransactionResponse.md)\<`T`\>
|
|
28
28
|
|
|
29
29
|
#### Defined in
|
|
30
30
|
|
|
31
|
-
[utils/connections.ts:
|
|
31
|
+
[utils/connections.ts:16](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L16)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
35
35
|
### tx
|
|
36
36
|
|
|
37
|
-
>
|
|
37
|
+
> **tx**: `T`
|
|
38
38
|
|
|
39
39
|
#### Defined in
|
|
40
40
|
|
|
41
|
-
[utils/connections.ts:
|
|
41
|
+
[utils/connections.ts:13](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L13)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
45
45
|
### txOptions?
|
|
46
46
|
|
|
47
|
-
> `
|
|
47
|
+
> `optional` **txOptions**: [`TransactionOptions`](../../types/interfaces/TransactionOptions.md)
|
|
48
48
|
|
|
49
49
|
#### Defined in
|
|
50
50
|
|
|
51
|
-
[utils/connections.ts:
|
|
51
|
+
[utils/connections.ts:15](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L15)
|
|
@@ -10,28 +10,28 @@
|
|
|
10
10
|
|
|
11
11
|
### nodeUrl?
|
|
12
12
|
|
|
13
|
-
> `
|
|
13
|
+
> `optional` **nodeUrl**: `string`
|
|
14
14
|
|
|
15
15
|
#### Defined in
|
|
16
16
|
|
|
17
|
-
[utils/connections.ts:
|
|
17
|
+
[utils/connections.ts:20](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L20)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
21
21
|
### participants
|
|
22
22
|
|
|
23
|
-
>
|
|
23
|
+
> **participants**: `string`[]
|
|
24
24
|
|
|
25
25
|
#### Defined in
|
|
26
26
|
|
|
27
|
-
[utils/connections.ts:
|
|
27
|
+
[utils/connections.ts:21](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L21)
|
|
28
28
|
|
|
29
29
|
***
|
|
30
30
|
|
|
31
31
|
### transactionType
|
|
32
32
|
|
|
33
|
-
>
|
|
33
|
+
> **transactionType**: [`TransactionType`](../type-aliases/TransactionType.md)
|
|
34
34
|
|
|
35
35
|
#### Defined in
|
|
36
36
|
|
|
37
|
-
[utils/connections.ts:
|
|
37
|
+
[utils/connections.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L22)
|
|
@@ -14,58 +14,58 @@
|
|
|
14
14
|
|
|
15
15
|
### data
|
|
16
16
|
|
|
17
|
-
>
|
|
17
|
+
> **data**: [`ConnectionData`](ConnectionData.md)\<`T`\>
|
|
18
18
|
|
|
19
19
|
#### Defined in
|
|
20
20
|
|
|
21
|
-
[utils/connections.ts:
|
|
21
|
+
[utils/connections.ts:29](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L29)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
25
25
|
### id
|
|
26
26
|
|
|
27
|
-
>
|
|
27
|
+
> **id**: `string`
|
|
28
28
|
|
|
29
29
|
#### Defined in
|
|
30
30
|
|
|
31
|
-
[utils/connections.ts:
|
|
31
|
+
[utils/connections.ts:25](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L25)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
35
35
|
### key
|
|
36
36
|
|
|
37
|
-
>
|
|
37
|
+
> **key**: `string`
|
|
38
38
|
|
|
39
39
|
#### Defined in
|
|
40
40
|
|
|
41
|
-
[utils/connections.ts:
|
|
41
|
+
[utils/connections.ts:30](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L30)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
45
45
|
### metadata
|
|
46
46
|
|
|
47
|
-
>
|
|
47
|
+
> **metadata**: [`ConnectionMetadata`](ConnectionMetadata.md)
|
|
48
48
|
|
|
49
49
|
#### Defined in
|
|
50
50
|
|
|
51
|
-
[utils/connections.ts:
|
|
51
|
+
[utils/connections.ts:28](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L28)
|
|
52
52
|
|
|
53
53
|
***
|
|
54
54
|
|
|
55
55
|
### status
|
|
56
56
|
|
|
57
|
-
>
|
|
57
|
+
> **status**: [`ConnectionStatus`](../type-aliases/ConnectionStatus.md)
|
|
58
58
|
|
|
59
59
|
#### Defined in
|
|
60
60
|
|
|
61
|
-
[utils/connections.ts:
|
|
61
|
+
[utils/connections.ts:27](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L27)
|
|
62
62
|
|
|
63
63
|
***
|
|
64
64
|
|
|
65
65
|
### version
|
|
66
66
|
|
|
67
|
-
>
|
|
67
|
+
> **version**: `number`
|
|
68
68
|
|
|
69
69
|
#### Defined in
|
|
70
70
|
|
|
71
|
-
[utils/connections.ts:
|
|
71
|
+
[utils/connections.ts:26](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L26)
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
[**@notabene/javascript-sdk**](../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@notabene/javascript-sdk](../../modules.md) / [notabene](../README.md) / ConnectionResult
|
|
6
|
+
|
|
7
|
+
# Interface: ConnectionResult\<T\>
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
• **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### id
|
|
16
|
+
|
|
17
|
+
> **id**: `string`
|
|
18
|
+
|
|
19
|
+
#### Defined in
|
|
20
|
+
|
|
21
|
+
[utils/connections.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L34)
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### metadata
|
|
26
|
+
|
|
27
|
+
> **metadata**: [`ConnectionMetadata`](ConnectionMetadata.md)
|
|
28
|
+
|
|
29
|
+
#### Defined in
|
|
30
|
+
|
|
31
|
+
[utils/connections.ts:35](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L35)
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### result?
|
|
36
|
+
|
|
37
|
+
> `optional` **result**: [`TransactionResponse`](../../types/interfaces/TransactionResponse.md)\<`T`\>
|
|
38
|
+
|
|
39
|
+
#### Defined in
|
|
40
|
+
|
|
41
|
+
[utils/connections.ts:38](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L38)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### status
|
|
46
|
+
|
|
47
|
+
> **status**: [`ConnectionStatus`](../type-aliases/ConnectionStatus.md)
|
|
48
|
+
|
|
49
|
+
#### Defined in
|
|
50
|
+
|
|
51
|
+
[utils/connections.ts:36](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L36)
|
|
52
|
+
|
|
53
|
+
***
|
|
54
|
+
|
|
55
|
+
### tx?
|
|
56
|
+
|
|
57
|
+
> `optional` **tx**: `T`
|
|
58
|
+
|
|
59
|
+
#### Defined in
|
|
60
|
+
|
|
61
|
+
[utils/connections.ts:37](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L37)
|
|
@@ -18,7 +18,7 @@ The authentication token for the Notabene API
|
|
|
18
18
|
|
|
19
19
|
#### Defined in
|
|
20
20
|
|
|
21
|
-
[notabene.ts:
|
|
21
|
+
[notabene.ts:177](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L177)
|
|
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:
|
|
33
|
+
[notabene.ts:192](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L192)
|
|
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:
|
|
45
|
+
[notabene.ts:172](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L172)
|
|
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:
|
|
57
|
+
[notabene.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L187)
|
|
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:
|
|
69
|
+
[notabene.ts:182](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L182)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
|
|
11
11
|
## Defined in
|
|
12
12
|
|
|
13
|
-
[utils/connections.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
13
|
+
[utils/connections.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L11)
|
|
@@ -30,4 +30,4 @@ The message object containing the component data and type
|
|
|
30
30
|
|
|
31
31
|
## Defined in
|
|
32
32
|
|
|
33
|
-
[utils/MessageEventManager.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
33
|
+
[utils/MessageEventManager.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/MessageEventManager.ts#L11)
|