@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/notabene/interfaces/ConnectionResult.md DELETED
@@ -1,61 +0,0 @@
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)