@notabene/javascript-sdk 2.8.0-next.4 → 2.8.0-next.6

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 (134) hide show
  1. package/README.md +30 -0
  2. package/dist/cjs/notabene.cjs +1 -1
  3. package/dist/cjs/notabene.d.ts +92 -8
  4. package/dist/cjs/package.json +1 -1
  5. package/dist/esm/notabene.d.ts +92 -8
  6. package/dist/esm/notabene.js +282 -137
  7. package/dist/esm/package.json +1 -1
  8. package/dist/notabene.d.ts +92 -8
  9. package/dist/notabene.js +282 -137
  10. package/docs/README.md +30 -0
  11. package/docs/_media/TransactionOptions.md +6 -6
  12. package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
  13. package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
  14. package/docs/ivms/types/type-aliases/Address.md +1 -1
  15. package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
  16. package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
  17. package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
  18. package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
  19. package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
  20. package/docs/ivms/types/type-aliases/ISODate.md +1 -1
  21. package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
  22. package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
  23. package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
  24. package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
  25. package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
  26. package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
  27. package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
  28. package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
  29. package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
  30. package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
  31. package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
  32. package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
  33. package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
  34. package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
  35. package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
  36. package/docs/ivms/types/type-aliases/Originator.md +1 -1
  37. package/docs/ivms/types/type-aliases/Person.md +1 -1
  38. package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
  39. package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
  40. package/docs/notabene/README.md +5 -0
  41. package/docs/notabene/classes/ConnectionManager.md +165 -0
  42. package/docs/notabene/classes/EmbeddedComponent.md +17 -17
  43. package/docs/notabene/classes/default.md +7 -7
  44. package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
  45. package/docs/notabene/interfaces/ConnectionData.md +41 -0
  46. package/docs/notabene/interfaces/ConnectionMetadata.md +37 -0
  47. package/docs/notabene/interfaces/ConnectionResponse.md +61 -0
  48. package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
  49. package/docs/notabene/type-aliases/MessageCallback.md +1 -1
  50. package/docs/notabene/type-aliases/TransactionType.md +13 -0
  51. package/docs/types/README.md +1 -0
  52. package/docs/types/enumerations/AgentType.md +2 -2
  53. package/docs/types/enumerations/CMType.md +7 -7
  54. package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
  55. package/docs/types/enumerations/HMType.md +2 -2
  56. package/docs/types/enumerations/PersonType.md +3 -3
  57. package/docs/types/enumerations/ProofStatus.md +4 -4
  58. package/docs/types/enumerations/ProofTypes.md +16 -16
  59. package/docs/types/enumerations/Status.md +5 -5
  60. package/docs/types/enumerations/VASPSearchControl.md +2 -2
  61. package/docs/types/enumerations/ValidationSections.md +4 -4
  62. package/docs/types/interfaces/Agent.md +6 -6
  63. package/docs/types/interfaces/CallbackOptions.md +2 -2
  64. package/docs/types/interfaces/ComponentRequest.md +2 -2
  65. package/docs/types/interfaces/ComponentResponse.md +4 -4
  66. package/docs/types/interfaces/ConnectionRecord.md +7 -7
  67. package/docs/types/interfaces/ConnectionRequest.md +3 -3
  68. package/docs/types/interfaces/Counterparty.md +10 -10
  69. package/docs/types/interfaces/DeclarationProof.md +6 -6
  70. package/docs/types/interfaces/Deposit.md +11 -11
  71. package/docs/types/interfaces/DepositRequest.md +7 -7
  72. package/docs/types/interfaces/DepositRequestOptions.md +1 -1
  73. package/docs/types/interfaces/DepositTransaction.md +9 -9
  74. package/docs/types/interfaces/LegalPerson.md +13 -13
  75. package/docs/types/interfaces/MicroTransferProof.md +9 -9
  76. package/docs/types/interfaces/NaturalPerson.md +13 -13
  77. package/docs/types/interfaces/OwnershipProof.md +4 -4
  78. package/docs/types/interfaces/RefreshSource.md +2 -2
  79. package/docs/types/interfaces/Refreshable.md +1 -1
  80. package/docs/types/interfaces/ScreenshotProof.md +5 -5
  81. package/docs/types/interfaces/SignatureProof.md +9 -9
  82. package/docs/types/interfaces/ThresholdOptions.md +3 -3
  83. package/docs/types/interfaces/Transaction.md +8 -8
  84. package/docs/types/interfaces/TransactionOptions.md +6 -6
  85. package/docs/types/interfaces/TransactionResponse.md +9 -9
  86. package/docs/types/interfaces/VASP.md +9 -9
  87. package/docs/types/interfaces/Wallet.md +8 -8
  88. package/docs/types/interfaces/Withdrawal.md +10 -10
  89. package/docs/types/type-aliases/BlockchainAddress.md +1 -1
  90. package/docs/types/type-aliases/CAIP10.md +1 -1
  91. package/docs/types/type-aliases/CAIP19.md +1 -1
  92. package/docs/types/type-aliases/CAIP2.md +1 -1
  93. package/docs/types/type-aliases/CAIP220.md +1 -1
  94. package/docs/types/type-aliases/Cancel.md +1 -1
  95. package/docs/types/type-aliases/Completed.md +1 -1
  96. package/docs/types/type-aliases/ComponentMessage.md +1 -1
  97. package/docs/types/type-aliases/ConnectionOptions.md +1 -1
  98. package/docs/types/type-aliases/CryptoCredential.md +1 -1
  99. package/docs/types/type-aliases/DID.md +1 -1
  100. package/docs/types/type-aliases/DTI.md +1 -1
  101. package/docs/types/type-aliases/Destination.md +1 -1
  102. package/docs/types/type-aliases/Error.md +1 -1
  103. package/docs/types/type-aliases/FieldOptions.md +1 -1
  104. package/docs/types/type-aliases/FieldTypes.md +1 -1
  105. package/docs/types/type-aliases/HostMessage.md +1 -1
  106. package/docs/types/type-aliases/ISOCurrency.md +1 -1
  107. package/docs/types/type-aliases/InvalidValue.md +1 -1
  108. package/docs/types/type-aliases/LEI.md +1 -1
  109. package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
  110. package/docs/types/type-aliases/LegalPersonFields.md +3 -3
  111. package/docs/types/type-aliases/NationalIdentifierTypeFieldOptions.md +21 -0
  112. package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
  113. package/docs/types/type-aliases/NaturalPersonFields.md +3 -3
  114. package/docs/types/type-aliases/NotabeneAsset.md +1 -1
  115. package/docs/types/type-aliases/Ready.md +1 -1
  116. package/docs/types/type-aliases/ResizeRequest.md +1 -1
  117. package/docs/types/type-aliases/Source.md +1 -1
  118. package/docs/types/type-aliases/Theme.md +1 -1
  119. package/docs/types/type-aliases/TransactionAsset.md +1 -1
  120. package/docs/types/type-aliases/TravelAddress.md +1 -1
  121. package/docs/types/type-aliases/URI.md +1 -1
  122. package/docs/types/type-aliases/UUID.md +1 -1
  123. package/docs/types/type-aliases/UpdateValue.md +1 -1
  124. package/docs/types/type-aliases/V1Asset.md +1 -1
  125. package/docs/types/type-aliases/V1Transaction.md +1 -1
  126. package/docs/types/type-aliases/VASPOptions.md +1 -1
  127. package/docs/types/type-aliases/ValidationError.md +1 -1
  128. package/package.json +1 -1
  129. package/src/notabene.ts +7 -0
  130. package/src/types.ts +35 -7
  131. package/src/utils/__tests__/connections.test.ts +284 -0
  132. package/src/utils/__tests__/encryption.test.ts +79 -0
  133. package/src/utils/connections.ts +174 -0
  134. package/src/utils/encryption.ts +111 -0
@@ -16,7 +16,7 @@ Configuration options for Transaction components
16
16
 
17
17
  #### Defined in
18
18
 
19
- [types.ts:798](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L798)
19
+ [types.ts:826](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L826)
20
20
 
21
21
  ***
22
22
 
@@ -26,7 +26,7 @@ Configuration options for Transaction components
26
26
 
27
27
  #### Defined in
28
28
 
29
- [types.ts:799](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L799)
29
+ [types.ts:827](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L827)
30
30
 
31
31
  ***
32
32
 
@@ -36,7 +36,7 @@ Configuration options for Transaction components
36
36
 
37
37
  #### Defined in
38
38
 
39
- [types.ts:800](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L800)
39
+ [types.ts:828](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L828)
40
40
 
41
41
  ***
42
42
 
@@ -46,7 +46,7 @@ Configuration options for Transaction components
46
46
 
47
47
  #### Defined in
48
48
 
49
- [types.ts:802](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L802)
49
+ [types.ts:830](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L830)
50
50
 
51
51
  ***
52
52
 
@@ -84,7 +84,7 @@ Configuration options for Transaction components
84
84
 
85
85
  #### Defined in
86
86
 
87
- [types.ts:788](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L788)
87
+ [types.ts:816](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L816)
88
88
 
89
89
  ***
90
90
 
@@ -94,4 +94,4 @@ Configuration options for Transaction components
94
94
 
95
95
  #### Defined in
96
96
 
97
- [types.ts:801](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L801)
97
+ [types.ts:829](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L829)
@@ -18,7 +18,7 @@ Published May 2020
18
18
 
19
19
  #### Defined in
20
20
 
21
- [ivms/types.ts:365](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L365)
21
+ [ivms/types.ts:365](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L365)
22
22
 
23
23
  ***
24
24
 
@@ -30,4 +30,4 @@ Published August 2023
30
30
 
31
31
  #### Defined in
32
32
 
33
- [ivms/types.ts:367](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L367)
33
+ [ivms/types.ts:367](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L367)
@@ -19,7 +19,7 @@ The version of IVMS 101 to which the payload complies.
19
19
 
20
20
  #### Defined in
21
21
 
22
- [ivms/types.ts:358](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L358)
22
+ [ivms/types.ts:358](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L358)
23
23
 
24
24
  ***
25
25
 
@@ -31,4 +31,4 @@ The method used to map from a national system of writing to Latin script.
31
31
 
32
32
  #### Defined in
33
33
 
34
- [ivms/types.ts:356](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L356)
34
+ [ivms/types.ts:356](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L356)
@@ -111,4 +111,4 @@ Name of a built-up area, with defined boundaries, and a local government.
111
111
 
112
112
  ## Defined in
113
113
 
114
- [ivms/types.ts:119](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L119)
114
+ [ivms/types.ts:119](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L119)
@@ -13,4 +13,4 @@ Specifies the type of address
13
13
 
14
14
  ## Defined in
15
15
 
16
- [ivms/types.ts:44](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L44)
16
+ [ivms/types.ts:44](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L44)
@@ -27,4 +27,4 @@ Array of persons associated with the beneficiary
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:313](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L313)
30
+ [ivms/types.ts:313](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L313)
@@ -21,4 +21,4 @@ The beneficiary VASP information
21
21
 
22
22
  ## Defined in
23
23
 
24
- [ivms/types.ts:335](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L335)
24
+ [ivms/types.ts:335](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L335)
@@ -27,4 +27,4 @@ Place of birth (max 70 characters)
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:107](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L107)
30
+ [ivms/types.ts:107](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L107)
@@ -19,4 +19,4 @@ ISO-3166 Alpha-2 country code
19
19
 
20
20
  ## Defined in
21
21
 
22
- [ivms/types.ts:6](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L6)
22
+ [ivms/types.ts:6](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L6)
@@ -20,4 +20,4 @@ Format: YYYY-MM-DD
20
20
 
21
21
  ## Defined in
22
22
 
23
- [ivms/types.ts:14](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L14)
23
+ [ivms/types.ts:14](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L14)
@@ -38,4 +38,4 @@ IVMS101 definition
38
38
 
39
39
  ## Defined in
40
40
 
41
- [ivms/types.ts:375](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L375)
41
+ [ivms/types.ts:375](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L375)
@@ -27,4 +27,4 @@ The sequence number of this VASP in the transfer path
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:289](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L289)
30
+ [ivms/types.ts:289](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L289)
@@ -45,4 +45,4 @@ A distinct identifier used by governments to uniquely identify a legal person
45
45
 
46
46
  ## Defined in
47
47
 
48
- [ivms/types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L259)
48
+ [ivms/types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L259)
@@ -33,4 +33,4 @@ Array of phonetic name identifiers
33
33
 
34
34
  ## Defined in
35
35
 
36
- [ivms/types.ts:245](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L245)
36
+ [ivms/types.ts:245](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L245)
@@ -27,4 +27,4 @@ The nature of the name specified
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:233](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L233)
30
+ [ivms/types.ts:233](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L233)
@@ -13,4 +13,4 @@ Specifies the type of name for a legal person
13
13
 
14
14
  ## Defined in
15
15
 
16
- [ivms/types.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L34)
16
+ [ivms/types.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L34)
@@ -27,4 +27,4 @@ Type of legal person name identifier
27
27
 
28
28
  ## Defined in
29
29
 
30
- [ivms/types.ts:221](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L221)
30
+ [ivms/types.ts:221](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L221)
@@ -33,4 +33,4 @@ Secondary identifier, maximum 100 characters in local format
33
33
 
34
34
  ## Defined in
35
35
 
36
- [ivms/types.ts:159](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L159)
36
+ [ivms/types.ts:159](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L159)
@@ -39,4 +39,4 @@ Registration authority (format: RA followed by 6 digits)
39
39
 
40
40
  ## Defined in
41
41
 
42
- [ivms/types.ts:91](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L91)
42
+ [ivms/types.ts:91](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L91)
@@ -13,4 +13,4 @@ Specifies the type of national identifier
13
13
 
14
14
  ## Defined in
15
15
 
16
- [ivms/types.ts:54](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L54)
16
+ [ivms/types.ts:54](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L54)
@@ -51,4 +51,4 @@ A distinct identifier used by governments to uniquely identify a natural person
51
51
 
52
52
  ## Defined in
53
53
 
54
- [ivms/types.ts:201](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L201)
54
+ [ivms/types.ts:201](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L201)
@@ -33,4 +33,4 @@ Array of phonetic name identifiers
33
33
 
34
34
  ## Defined in
35
35
 
36
- [ivms/types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L187)
36
+ [ivms/types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L187)
@@ -33,4 +33,4 @@ Secondary identifier, maximum 100 characters
33
33
 
34
34
  ## Defined in
35
35
 
36
- [ivms/types.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L173)
36
+ [ivms/types.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L173)
@@ -13,4 +13,4 @@ Specifies the type of name for a natural person
13
13
 
14
14
  ## Defined in
15
15
 
16
- [ivms/types.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L22)
16
+ [ivms/types.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L22)
@@ -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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L325)
24
+ [ivms/types.ts:325](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L325)
@@ -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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L301)
30
+ [ivms/types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L301)
@@ -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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L277)
30
+ [ivms/types.ts:277](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L277)
@@ -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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L345)
24
+ [ivms/types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L345)
@@ -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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/ivms/types.ts#L71)
16
+ [ivms/types.ts:71](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L71)
@@ -10,16 +10,21 @@
10
10
 
11
11
  ### Classes
12
12
 
13
+ - [ConnectionManager](classes/ConnectionManager.md)
13
14
  - [default](classes/default.md)
14
15
  - [EmbeddedComponent](classes/EmbeddedComponent.md)
15
16
 
16
17
  ### Interfaces
17
18
 
19
+ - [ConnectionData](interfaces/ConnectionData.md)
20
+ - [ConnectionMetadata](interfaces/ConnectionMetadata.md)
21
+ - [ConnectionResponse](interfaces/ConnectionResponse.md)
18
22
  - [NotabeneConfig](interfaces/NotabeneConfig.md)
19
23
 
20
24
  ### Type Aliases
21
25
 
22
26
  - [MessageCallback](type-aliases/MessageCallback.md)
27
+ - [TransactionType](type-aliases/TransactionType.md)
23
28
 
24
29
  ### Functions
25
30
 
@@ -0,0 +1,165 @@
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
+
3
+ ***
4
+
5
+ [@notabene/javascript-sdk](../../modules.md) / [notabene](../README.md) / ConnectionManager
6
+
7
+ # Class: ConnectionManager
8
+
9
+ Manages encrypted connections using Cloudflare Durable Objects
10
+
11
+ ## Constructors
12
+
13
+ ### new ConnectionManager()
14
+
15
+ > **new ConnectionManager**(`endpoint`): [`ConnectionManager`](ConnectionManager.md)
16
+
17
+ #### Parameters
18
+
19
+ ##### endpoint
20
+
21
+ `string`
22
+
23
+ #### Returns
24
+
25
+ [`ConnectionManager`](ConnectionManager.md)
26
+
27
+ #### Defined in
28
+
29
+ [utils/connections.ts:30](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/utils/connections.ts#L30)
30
+
31
+ ## Methods
32
+
33
+ ### close()
34
+
35
+ > **close**(`id`): `Promise`\<`void`\>
36
+
37
+ Closes a connection
38
+
39
+ #### Parameters
40
+
41
+ ##### id
42
+
43
+ `string`
44
+
45
+ Connection ID
46
+
47
+ #### Returns
48
+
49
+ `Promise`\<`void`\>
50
+
51
+ #### Defined in
52
+
53
+ [utils/connections.ts:165](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/utils/connections.ts#L165)
54
+
55
+ ***
56
+
57
+ ### create()
58
+
59
+ > **create**\<`T`\>(`data`, `metadata`): `Promise`\<[`ConnectionResponse`](../interfaces/ConnectionResponse.md)\<`T`\>\>
60
+
61
+ Creates a new encrypted connection
62
+
63
+ #### Type Parameters
64
+
65
+ • **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
66
+
67
+ #### Parameters
68
+
69
+ ##### data
70
+
71
+ [`ConnectionData`](../interfaces/ConnectionData.md)\<`T`\>
72
+
73
+ The component request data to encrypt and store
74
+
75
+ ##### metadata
76
+
77
+ [`ConnectionMetadata`](../interfaces/ConnectionMetadata.md)
78
+
79
+ #### Returns
80
+
81
+ `Promise`\<[`ConnectionResponse`](../interfaces/ConnectionResponse.md)\<`T`\>\>
82
+
83
+ Promise resolving to connection details including ID, version, and encryption key
84
+
85
+ #### Defined in
86
+
87
+ [utils/connections.ts:40](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/utils/connections.ts#L40)
88
+
89
+ ***
90
+
91
+ ### get()
92
+
93
+ > **get**\<`T`\>(`id`, `key`): `Promise`\<[`ConnectionResponse`](../interfaces/ConnectionResponse.md)\<`T`\>\>
94
+
95
+ Retrieves and decrypts connection data
96
+
97
+ #### Type Parameters
98
+
99
+ • **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
100
+
101
+ #### Parameters
102
+
103
+ ##### id
104
+
105
+ `string`
106
+
107
+ Connection ID
108
+
109
+ ##### key
110
+
111
+ `string`
112
+
113
+ Encryption key from previous create/update operation
114
+
115
+ #### Returns
116
+
117
+ `Promise`\<[`ConnectionResponse`](../interfaces/ConnectionResponse.md)\<`T`\>\>
118
+
119
+ Promise resolving to connection details including decrypted data
120
+
121
+ #### Defined in
122
+
123
+ [utils/connections.ts:128](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/utils/connections.ts#L128)
124
+
125
+ ***
126
+
127
+ ### update()
128
+
129
+ > **update**\<`T`\>(`id`, `data`, `version`): `Promise`\<[`ConnectionResponse`](../interfaces/ConnectionResponse.md)\<`T`\>\>
130
+
131
+ Updates an existing connection with new encrypted data
132
+
133
+ #### Type Parameters
134
+
135
+ • **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
136
+
137
+ #### Parameters
138
+
139
+ ##### id
140
+
141
+ `string`
142
+
143
+ Connection ID
144
+
145
+ ##### data
146
+
147
+ [`ConnectionData`](../interfaces/ConnectionData.md)\<`T`\>
148
+
149
+ New data to encrypt and store
150
+
151
+ ##### version
152
+
153
+ `number`
154
+
155
+ Current version number
156
+
157
+ #### Returns
158
+
159
+ `Promise`\<[`ConnectionResponse`](../interfaces/ConnectionResponse.md)\<`T`\>\>
160
+
161
+ Promise resolving to updated connection details including new encryption key
162
+
163
+ #### Defined in
164
+
165
+ [utils/connections.ts:84](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/utils/connections.ts#L84)
@@ -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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L34)
49
+ [components/EmbeddedComponent.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L72)
65
+ [components/EmbeddedComponent.ts:72](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L68)
81
+ [components/EmbeddedComponent.ts:68](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L56)
101
+ [components/EmbeddedComponent.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L64)
121
+ [components/EmbeddedComponent.ts:64](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L240)
137
+ [components/EmbeddedComponent.ts:240](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L173)
155
+ [components/EmbeddedComponent.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L100)
183
+ [components/EmbeddedComponent.ts:100](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L90)
211
+ [components/EmbeddedComponent.ts:90](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L154)
241
+ [components/EmbeddedComponent.ts:154](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L144)
275
+ [components/EmbeddedComponent.ts:144](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L80)
291
+ [components/EmbeddedComponent.ts:80](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L202)
307
+ [components/EmbeddedComponent.ts:202](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L255)
330
+ [components/EmbeddedComponent.ts:255](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L126)
344
+ [components/EmbeddedComponent.ts:126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L134)
368
+ [components/EmbeddedComponent.ts:134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/components/EmbeddedComponent.ts#L162)
396
+ [components/EmbeddedComponent.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/components/EmbeddedComponent.ts#L162)