@notabene/javascript-sdk 2.10.0-next.1 → 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 (137) hide show
  1. package/README.md +9 -4
  2. package/dist/cjs/notabene.cjs +1 -1
  3. package/dist/cjs/notabene.d.ts +4 -2
  4. package/dist/cjs/package.json +1 -1
  5. package/dist/esm/notabene.d.ts +4 -2
  6. package/dist/esm/notabene.js +12 -12
  7. package/dist/esm/package.json +1 -1
  8. package/dist/notabene.d.ts +4 -2
  9. package/dist/notabene.js +12 -12
  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 +1 -1
  135. package/src/types.ts +2 -0
  136. package/src/utils/connections.ts +1 -0
  137. package/docs/notabene/interfaces/ConnectionResult.md +0 -61
package/docs/ivms/types/type-aliases/OriginatingVASP.md CHANGED
@@ -21,4 +21,4 @@ The originating VASP information
21
21
 
22
22
  ## Defined in
23
23
 
24
- [ivms/types.ts:325](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L325)
24
+ [ivms/types.ts:325](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/ivms/types.ts#L325)
package/docs/ivms/types/type-aliases/Originator.md CHANGED
@@ -27,4 +27,4 @@ Array of persons associated with the originator
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L301)
30
+ [ivms/types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/ivms/types.ts#L301)
package/docs/ivms/types/type-aliases/Person.md CHANGED
@@ -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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L277)
30
+ [ivms/types.ts:277](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/ivms/types.ts#L277)
package/docs/ivms/types/type-aliases/TransferPath.md CHANGED
@@ -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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L345)
24
+ [ivms/types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/ivms/types.ts#L345)
package/docs/ivms/types/type-aliases/TransliterationMethodCode.md CHANGED
@@ -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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L71)
16
+ [ivms/types.ts:71](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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)
23
22
  - [NotabeneConfig](interfaces/NotabeneConfig.md)
24
23
 
25
24
  ### Type Aliases
26
25
 
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,6 +35,12 @@
35
35
 
36
36
  ## References
37
37
 
38
+ ### Account
39
+
40
+ Re-exports [Account](../types/interfaces/Account.md)
41
+
42
+ ***
43
+
38
44
  ### Agent
39
45
 
40
46
  Re-exports [Agent](../types/interfaces/Agent.md)
package/docs/notabene/classes/ConnectionManager.md CHANGED
@@ -26,7 +26,7 @@ Manages encrypted connections using Cloudflare Durable Objects
26
26
 
27
27
  #### Defined in
28
28
 
29
- [utils/connections.ts:96](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L96)
29
+ [utils/connections.ts:115](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L115)
30
30
 
31
31
  ## Methods
32
32
 
@@ -48,9 +48,11 @@ Connection ID
48
48
 
49
49
  `Promise`\<`void`\>
50
50
 
51
+ Promise resolving when the connection is closed
52
+
51
53
  #### Defined in
52
54
 
53
- [utils/connections.ts:237](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L237)
55
+ [utils/connections.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L262)
54
56
 
55
57
  ***
56
58
 
@@ -64,6 +66,8 @@ Creates a new encrypted connection
64
66
 
65
67
  • **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
66
68
 
69
+ Type of component request
70
+
67
71
  #### Parameters
68
72
 
69
73
  ##### data
@@ -76,6 +80,8 @@ The component request data to encrypt and store
76
80
 
77
81
  [`ConnectionMetadata`](../interfaces/ConnectionMetadata.md)
78
82
 
83
+ Connection metadata including participants and transaction type
84
+
79
85
  #### Returns
80
86
 
81
87
  `Promise`\<[`ConnectionResponse`](../interfaces/ConnectionResponse.md)\<`T`\>\>
@@ -84,7 +90,7 @@ Promise resolving to connection details including ID, version, and encryption ke
84
90
 
85
91
  #### Defined in
86
92
 
87
- [utils/connections.ts:106](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L106)
93
+ [utils/connections.ts:126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L126)
88
94
 
89
95
  ***
90
96
 
@@ -98,6 +104,8 @@ Retrieves and decrypts connection data
98
104
 
99
105
  • **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
100
106
 
107
+ Type of component request
108
+
101
109
  #### Parameters
102
110
 
103
111
  ##### id
@@ -120,7 +128,7 @@ Promise resolving to connection details including decrypted data
120
128
 
121
129
  #### Defined in
122
130
 
123
- [utils/connections.ts:199](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L199)
131
+ [utils/connections.ts:223](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L223)
124
132
 
125
133
  ***
126
134
 
@@ -134,6 +142,8 @@ Updates an existing connection with new encrypted data
134
142
 
135
143
  • **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
136
144
 
145
+ Type of component request
146
+
137
147
  #### Parameters
138
148
 
139
149
  ##### id
@@ -158,10 +168,14 @@ Current version number
158
168
 
159
169
  [`ConnectionStatus`](../type-aliases/ConnectionStatus.md)
160
170
 
171
+ New connection status
172
+
161
173
  ##### key
162
174
 
163
175
  `string`
164
176
 
177
+ Current encryption key
178
+
165
179
  #### Returns
166
180
 
167
181
  `Promise`\<[`ConnectionResponse`](../interfaces/ConnectionResponse.md)\<`T`\>\>
@@ -170,4 +184,4 @@ Promise resolving to updated connection details including new encryption key
170
184
 
171
185
  #### Defined in
172
186
 
173
- [utils/connections.ts:151](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L151)
187
+ [utils/connections.ts:174](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L174)
package/docs/notabene/classes/EmbeddedComponent.md CHANGED
@@ -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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L34)
49
+ [components/EmbeddedComponent.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L72)
65
+ [components/EmbeddedComponent.ts:72](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L68)
81
+ [components/EmbeddedComponent.ts:68](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L56)
101
+ [components/EmbeddedComponent.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L64)
121
+ [components/EmbeddedComponent.ts:64](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L240)
137
+ [components/EmbeddedComponent.ts:240](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L173)
155
+ [components/EmbeddedComponent.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L100)
183
+ [components/EmbeddedComponent.ts:100](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L90)
211
+ [components/EmbeddedComponent.ts:90](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L154)
241
+ [components/EmbeddedComponent.ts:154](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L144)
275
+ [components/EmbeddedComponent.ts:144](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L80)
291
+ [components/EmbeddedComponent.ts:80](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L202)
307
+ [components/EmbeddedComponent.ts:202](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L255)
330
+ [components/EmbeddedComponent.ts:255](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L126)
344
+ [components/EmbeddedComponent.ts:126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L134)
368
+ [components/EmbeddedComponent.ts:134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/components/EmbeddedComponent.ts#L162)
396
+ [components/EmbeddedComponent.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/components/EmbeddedComponent.ts#L162)
package/docs/notabene/classes/default.md CHANGED
@@ -34,7 +34,7 @@ Configuration options for the Notabene SDK
34
34
 
35
35
  #### Defined in
36
36
 
37
- [notabene.ts:215](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L215)
37
+ [notabene.ts:217](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L217)
38
38
 
39
39
  ## Methods
40
40
 
@@ -86,7 +86,7 @@ component URL
86
86
 
87
87
  #### Defined in
88
88
 
89
- [notabene.ts:233](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L233)
89
+ [notabene.ts:235](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L235)
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:275](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L275)
141
+ [notabene.ts:277](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L277)
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:318](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L318)
181
+ [notabene.ts:320](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L320)
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:362](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L362)
219
+ [notabene.ts:364](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L364)
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:340](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L340)
257
+ [notabene.ts:342](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L342)
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:296](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L296)
295
+ [notabene.ts:298](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L298)
package/docs/notabene/functions/decodeFragmentToObject.md CHANGED
@@ -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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/urls.ts#L22)
29
+ [utils/urls.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/urls.ts#L22)
package/docs/notabene/functions/getRefreshResult.md CHANGED
@@ -6,22 +6,30 @@
6
6
 
7
7
  # Function: getRefreshResult()
8
8
 
9
- > **getRefreshResult**\<`T`\>(`refreshSource`): `Promise`\<[`ConnectionResult`](../interfaces/ConnectionResult.md)\<`T`\>\>
9
+ > **getRefreshResult**\<`T`\>(`refreshSource`): `Promise`\<[`ConnectionResult`](../type-aliases/ConnectionResult.md)\<`T`\>\>
10
+
11
+ Retrieves and processes connection refresh data
10
12
 
11
13
  ## Type Parameters
12
14
 
13
15
  • **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
14
16
 
17
+ Type of component request
18
+
15
19
  ## Parameters
16
20
 
17
21
  ### refreshSource
18
22
 
19
23
  [`RefreshSource`](../../types/interfaces/RefreshSource.md)
20
24
 
25
+ Source information for the refresh operation
26
+
21
27
  ## Returns
22
28
 
23
- `Promise`\<[`ConnectionResult`](../interfaces/ConnectionResult.md)\<`T`\>\>
29
+ `Promise`\<[`ConnectionResult`](../type-aliases/ConnectionResult.md)\<`T`\>\>
30
+
31
+ Promise resolving to connection result with decrypted data
24
32
 
25
33
  ## Defined in
26
34
 
27
- [utils/connections.ts:41](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L41)
35
+ [utils/connections.ts:60](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L60)
package/docs/notabene/interfaces/ConnectionData.md CHANGED
@@ -14,38 +14,38 @@
14
14
 
15
15
  ### authToken?
16
16
 
17
- > `optional` **authToken**: `string`
17
+ > `readonly` `optional` **authToken**: `string`
18
18
 
19
19
  #### Defined in
20
20
 
21
- [utils/connections.ts:14](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L14)
21
+ [utils/connections.ts:15](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L15)
22
22
 
23
23
  ***
24
24
 
25
25
  ### result?
26
26
 
27
- > `optional` **result**: [`TransactionResponse`](../../types/interfaces/TransactionResponse.md)\<`T`\>
27
+ > `readonly` `optional` **result**: [`TransactionResponse`](../../types/interfaces/TransactionResponse.md)\<`T`\>
28
28
 
29
29
  #### Defined in
30
30
 
31
- [utils/connections.ts:16](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L16)
31
+ [utils/connections.ts:17](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L17)
32
32
 
33
33
  ***
34
34
 
35
35
  ### tx
36
36
 
37
- > **tx**: `T`
37
+ > `readonly` **tx**: `T`
38
38
 
39
39
  #### Defined in
40
40
 
41
- [utils/connections.ts:13](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L13)
41
+ [utils/connections.ts:14](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L14)
42
42
 
43
43
  ***
44
44
 
45
45
  ### txOptions?
46
46
 
47
- > `optional` **txOptions**: [`TransactionOptions`](../../types/interfaces/TransactionOptions.md)
47
+ > `readonly` `optional` **txOptions**: [`TransactionOptions`](../../types/interfaces/TransactionOptions.md)
48
48
 
49
49
  #### Defined in
50
50
 
51
- [utils/connections.ts:15](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L15)
51
+ [utils/connections.ts:16](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L16)
package/docs/notabene/interfaces/ConnectionMetadata.md CHANGED
@@ -10,28 +10,28 @@
10
10
 
11
11
  ### nodeUrl?
12
12
 
13
- > `optional` **nodeUrl**: `string`
13
+ > `readonly` `optional` **nodeUrl**: `string`
14
14
 
15
15
  #### Defined in
16
16
 
17
- [utils/connections.ts:20](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L20)
17
+ [utils/connections.ts:21](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L21)
18
18
 
19
19
  ***
20
20
 
21
21
  ### participants
22
22
 
23
- > **participants**: `string`[]
23
+ > `readonly` **participants**: readonly `string`[]
24
24
 
25
25
  #### Defined in
26
26
 
27
- [utils/connections.ts:21](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L21)
27
+ [utils/connections.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L22)
28
28
 
29
29
  ***
30
30
 
31
31
  ### transactionType
32
32
 
33
- > **transactionType**: [`TransactionType`](../type-aliases/TransactionType.md)
33
+ > `readonly` **transactionType**: [`TransactionType`](../type-aliases/TransactionType.md)
34
34
 
35
35
  #### Defined in
36
36
 
37
- [utils/connections.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L22)
37
+ [utils/connections.ts:23](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L23)
package/docs/notabene/interfaces/ConnectionResponse.md CHANGED
@@ -14,58 +14,58 @@
14
14
 
15
15
  ### data
16
16
 
17
- > **data**: [`ConnectionData`](ConnectionData.md)\<`T`\>
17
+ > `readonly` **data**: [`ConnectionData`](ConnectionData.md)\<`T`\>
18
18
 
19
19
  #### Defined in
20
20
 
21
- [utils/connections.ts:29](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L29)
21
+ [utils/connections.ts:31](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L31)
22
22
 
23
23
  ***
24
24
 
25
25
  ### id
26
26
 
27
- > **id**: `string`
27
+ > `readonly` **id**: `string`
28
28
 
29
29
  #### Defined in
30
30
 
31
- [utils/connections.ts:25](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L25)
31
+ [utils/connections.ts:27](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L27)
32
32
 
33
33
  ***
34
34
 
35
35
  ### key
36
36
 
37
- > **key**: `string`
37
+ > `readonly` **key**: `string`
38
38
 
39
39
  #### Defined in
40
40
 
41
- [utils/connections.ts:30](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L30)
41
+ [utils/connections.ts:32](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L32)
42
42
 
43
43
  ***
44
44
 
45
45
  ### metadata
46
46
 
47
- > **metadata**: [`ConnectionMetadata`](ConnectionMetadata.md)
47
+ > `readonly` **metadata**: [`ConnectionMetadata`](ConnectionMetadata.md)
48
48
 
49
49
  #### Defined in
50
50
 
51
- [utils/connections.ts:28](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L28)
51
+ [utils/connections.ts:30](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L30)
52
52
 
53
53
  ***
54
54
 
55
55
  ### status
56
56
 
57
- > **status**: [`ConnectionStatus`](../type-aliases/ConnectionStatus.md)
57
+ > `readonly` **status**: [`ConnectionStatus`](../type-aliases/ConnectionStatus.md)
58
58
 
59
59
  #### Defined in
60
60
 
61
- [utils/connections.ts:27](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L27)
61
+ [utils/connections.ts:29](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L29)
62
62
 
63
63
  ***
64
64
 
65
65
  ### version
66
66
 
67
- > **version**: `number`
67
+ > `readonly` **version**: `number`
68
68
 
69
69
  #### Defined in
70
70
 
71
- [utils/connections.ts:26](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L26)
71
+ [utils/connections.ts:28](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L28)
package/docs/notabene/interfaces/NotabeneConfig.md CHANGED
@@ -18,7 +18,7 @@ The authentication token for the Notabene API
18
18
 
19
19
  #### Defined in
20
20
 
21
- [notabene.ts:177](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L177)
21
+ [notabene.ts:179](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L179)
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:192](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L192)
33
+ [notabene.ts:194](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L194)
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:172](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L172)
45
+ [notabene.ts:174](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L174)
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:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L187)
57
+ [notabene.ts:189](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L189)
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:182](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/notabene.ts#L182)
69
+ [notabene.ts:184](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/notabene.ts#L184)
package/docs/notabene/type-aliases/ConnectionResult.md ADDED
@@ -0,0 +1,17 @@
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
+
3
+ ***
4
+
5
+ [@notabene/javascript-sdk](../../modules.md) / [notabene](../README.md) / ConnectionResult
6
+
7
+ # Type Alias: ConnectionResult\<T\>
8
+
9
+ > **ConnectionResult**\<`T`\>: \{ `id`: [`UUID`](../../types/type-aliases/UUID.md); `metadata`: [`ConnectionMetadata`](../interfaces/ConnectionMetadata.md); `status`: `"closed"`; \} \| \{ `id`: [`UUID`](../../types/type-aliases/UUID.md); `metadata`: [`ConnectionMetadata`](../interfaces/ConnectionMetadata.md); `result`: [`TransactionResponse`](../../types/interfaces/TransactionResponse.md)\<`T`\>; `status`: `"completed"`; \} \| \{ `id`: [`UUID`](../../types/type-aliases/UUID.md); `metadata`: [`ConnectionMetadata`](../interfaces/ConnectionMetadata.md); `status`: `"active"`; `tx`: `T`; \}
10
+
11
+ ## Type Parameters
12
+
13
+ • **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
14
+
15
+ ## Defined in
16
+
17
+ [utils/connections.ts:35](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L35)
package/docs/notabene/type-aliases/ConnectionStatus.md CHANGED
@@ -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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L11)
13
+ [utils/connections.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L11)
package/docs/notabene/type-aliases/MessageCallback.md CHANGED
@@ -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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/MessageEventManager.ts#L11)
33
+ [utils/MessageEventManager.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/MessageEventManager.ts#L11)
package/docs/notabene/type-aliases/TransactionType.md CHANGED
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [utils/connections.ts:10](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L10)
13
+ [utils/connections.ts:10](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/b3b58dde23d9780aa680a2d943b97074d4e49921/src/utils/connections.ts#L10)