@notabene/javascript-sdk 2.8.0 → 2.9.0-next.1

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 (126) hide show
  1. package/dist/cjs/notabene.cjs +1 -1
  2. package/dist/cjs/notabene.d.ts +3 -1
  3. package/dist/cjs/package.json +1 -1
  4. package/dist/esm/notabene.d.ts +3 -1
  5. package/dist/esm/notabene.js +7 -7
  6. package/dist/esm/package.json +1 -1
  7. package/dist/notabene.d.ts +3 -1
  8. package/dist/notabene.js +7 -7
  9. package/docs/README.md +4 -4
  10. package/docs/_media/TransactionOptions.md +6 -6
  11. package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
  12. package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
  13. package/docs/ivms/types/type-aliases/Address.md +1 -1
  14. package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
  15. package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
  16. package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
  17. package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
  18. package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
  19. package/docs/ivms/types/type-aliases/ISODate.md +1 -1
  20. package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
  21. package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
  22. package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
  23. package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
  24. package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
  25. package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
  26. package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
  27. package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
  28. package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
  29. package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
  30. package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
  31. package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
  32. package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
  33. package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
  34. package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
  35. package/docs/ivms/types/type-aliases/Originator.md +1 -1
  36. package/docs/ivms/types/type-aliases/Person.md +1 -1
  37. package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
  38. package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
  39. package/docs/notabene/classes/ConnectionManager.md +5 -5
  40. package/docs/notabene/classes/EmbeddedComponent.md +17 -17
  41. package/docs/notabene/classes/default.md +7 -7
  42. package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
  43. package/docs/notabene/interfaces/ConnectionData.md +3 -3
  44. package/docs/notabene/interfaces/ConnectionMetadata.md +3 -3
  45. package/docs/notabene/interfaces/ConnectionResponse.md +5 -5
  46. package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
  47. package/docs/notabene/type-aliases/MessageCallback.md +1 -1
  48. package/docs/notabene/type-aliases/TransactionType.md +1 -1
  49. package/docs/types/enumerations/AgentType.md +2 -2
  50. package/docs/types/enumerations/CMType.md +7 -7
  51. package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
  52. package/docs/types/enumerations/HMType.md +2 -2
  53. package/docs/types/enumerations/PersonType.md +3 -3
  54. package/docs/types/enumerations/ProofStatus.md +4 -4
  55. package/docs/types/enumerations/ProofTypes.md +27 -16
  56. package/docs/types/enumerations/Status.md +5 -5
  57. package/docs/types/enumerations/VASPSearchControl.md +2 -2
  58. package/docs/types/enumerations/ValidationSections.md +4 -4
  59. package/docs/types/interfaces/Agent.md +6 -6
  60. package/docs/types/interfaces/CallbackOptions.md +2 -2
  61. package/docs/types/interfaces/ComponentRequest.md +2 -2
  62. package/docs/types/interfaces/ComponentResponse.md +4 -4
  63. package/docs/types/interfaces/ConnectionRecord.md +7 -7
  64. package/docs/types/interfaces/ConnectionRequest.md +3 -3
  65. package/docs/types/interfaces/Counterparty.md +10 -10
  66. package/docs/types/interfaces/DeclarationProof.md +6 -6
  67. package/docs/types/interfaces/Deposit.md +11 -11
  68. package/docs/types/interfaces/DepositRequest.md +7 -7
  69. package/docs/types/interfaces/DepositRequestOptions.md +1 -1
  70. package/docs/types/interfaces/DepositTransaction.md +9 -9
  71. package/docs/types/interfaces/LegalPerson.md +13 -13
  72. package/docs/types/interfaces/MicroTransferProof.md +9 -9
  73. package/docs/types/interfaces/NaturalPerson.md +13 -13
  74. package/docs/types/interfaces/OwnershipProof.md +4 -4
  75. package/docs/types/interfaces/RefreshSource.md +2 -2
  76. package/docs/types/interfaces/Refreshable.md +1 -1
  77. package/docs/types/interfaces/ScreenshotProof.md +5 -5
  78. package/docs/types/interfaces/SignatureProof.md +10 -10
  79. package/docs/types/interfaces/ThresholdOptions.md +3 -3
  80. package/docs/types/interfaces/Transaction.md +8 -8
  81. package/docs/types/interfaces/TransactionOptions.md +6 -6
  82. package/docs/types/interfaces/TransactionResponse.md +9 -9
  83. package/docs/types/interfaces/VASP.md +9 -9
  84. package/docs/types/interfaces/Wallet.md +8 -8
  85. package/docs/types/interfaces/Withdrawal.md +10 -10
  86. package/docs/types/type-aliases/BlockchainAddress.md +1 -1
  87. package/docs/types/type-aliases/CAIP10.md +1 -1
  88. package/docs/types/type-aliases/CAIP19.md +1 -1
  89. package/docs/types/type-aliases/CAIP2.md +1 -1
  90. package/docs/types/type-aliases/CAIP220.md +1 -1
  91. package/docs/types/type-aliases/Cancel.md +1 -1
  92. package/docs/types/type-aliases/Completed.md +1 -1
  93. package/docs/types/type-aliases/ComponentMessage.md +1 -1
  94. package/docs/types/type-aliases/ConnectionOptions.md +1 -1
  95. package/docs/types/type-aliases/CryptoCredential.md +1 -1
  96. package/docs/types/type-aliases/DID.md +1 -1
  97. package/docs/types/type-aliases/DTI.md +1 -1
  98. package/docs/types/type-aliases/Destination.md +1 -1
  99. package/docs/types/type-aliases/Error.md +1 -1
  100. package/docs/types/type-aliases/FieldOptions.md +1 -1
  101. package/docs/types/type-aliases/FieldTypes.md +1 -1
  102. package/docs/types/type-aliases/HostMessage.md +1 -1
  103. package/docs/types/type-aliases/ISOCurrency.md +1 -1
  104. package/docs/types/type-aliases/InvalidValue.md +1 -1
  105. package/docs/types/type-aliases/LEI.md +1 -1
  106. package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
  107. package/docs/types/type-aliases/LegalPersonFields.md +1 -1
  108. package/docs/types/type-aliases/NationalIdentifierTypeFieldOptions.md +1 -1
  109. package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
  110. package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
  111. package/docs/types/type-aliases/NotabeneAsset.md +1 -1
  112. package/docs/types/type-aliases/Ready.md +1 -1
  113. package/docs/types/type-aliases/ResizeRequest.md +1 -1
  114. package/docs/types/type-aliases/Source.md +1 -1
  115. package/docs/types/type-aliases/Theme.md +1 -1
  116. package/docs/types/type-aliases/TransactionAsset.md +1 -1
  117. package/docs/types/type-aliases/TravelAddress.md +1 -1
  118. package/docs/types/type-aliases/URI.md +1 -1
  119. package/docs/types/type-aliases/UUID.md +1 -1
  120. package/docs/types/type-aliases/UpdateValue.md +1 -1
  121. package/docs/types/type-aliases/V1Asset.md +1 -1
  122. package/docs/types/type-aliases/V1Transaction.md +1 -1
  123. package/docs/types/type-aliases/VASPOptions.md +1 -1
  124. package/docs/types/type-aliases/ValidationError.md +1 -1
  125. package/package.json +1 -1
  126. package/src/types.ts +4 -1
@@ -12,4 +12,4 @@ Field properties
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:742](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L742)
15
+ [types.ts:742](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L742)
@@ -22,4 +22,4 @@ Field type configuration
22
22
 
23
23
  ## Defined in
24
24
 
25
- [types.ts:755](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L755)
25
+ [types.ts:755](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L755)
@@ -34,4 +34,4 @@ without requiring full reinitialization.
34
34
 
35
35
  ## Defined in
36
36
 
37
- [types.ts:1014](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L1014)
37
+ [types.ts:1014](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L1014)
@@ -12,4 +12,4 @@
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:232](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L232)
15
+ [types.ts:232](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L232)
@@ -42,4 +42,4 @@ Array of validation errors
42
42
 
43
43
  ## Defined in
44
44
 
45
- [types.ts:924](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L924)
45
+ [types.ts:924](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L924)
@@ -12,4 +12,4 @@ A LEI Legal Entity Identifier
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:226](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L226)
15
+ [types.ts:226](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L226)
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [types.ts:449](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L449)
13
+ [types.ts:449](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L449)
@@ -12,4 +12,4 @@ Field properties for legal person fields
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:463](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L463)
15
+ [types.ts:463](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L463)
@@ -18,4 +18,4 @@ Field properties for national identifier type selection
18
18
 
19
19
  ## Defined in
20
20
 
21
- [types.ts:399](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L399)
21
+ [types.ts:399](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L399)
@@ -12,4 +12,4 @@ Field names for NaturalPerson
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:384](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L384)
15
+ [types.ts:384](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L384)
@@ -12,4 +12,4 @@ Field properties for natural person fields
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:407](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L407)
15
+ [types.ts:407](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L407)
@@ -33,4 +33,4 @@ system that may be used alongside CAIP-19 and DTI identifiers.
33
33
 
34
34
  ## Defined in
35
35
 
36
- [types.ts:140](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L140)
36
+ [types.ts:140](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L140)
@@ -18,4 +18,4 @@ Represents a ready component message
18
18
 
19
19
  ## Defined in
20
20
 
21
- [types.ts:871](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L871)
21
+ [types.ts:871](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L871)
@@ -24,4 +24,4 @@ Represents a resize request component message. This is handled by the library.
24
24
 
25
25
  ## Defined in
26
26
 
27
- [types.ts:879](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L879)
27
+ [types.ts:879](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L879)
@@ -12,4 +12,4 @@ The source of a transaction
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:208](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L208)
15
+ [types.ts:208](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L208)
@@ -34,4 +34,4 @@ The theme of the Notabene SDK
34
34
 
35
35
  ## Defined in
36
36
 
37
- [types.ts:238](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L238)
37
+ [types.ts:238](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L238)
@@ -12,4 +12,4 @@ The asset of a transaction either a Notabene asset, a CAIP-19 asset, or a DTI.
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:146](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L146)
15
+ [types.ts:146](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L146)
@@ -34,4 +34,4 @@ VASPs and blockchain networks while maintaining privacy.
34
34
 
35
35
  ## Defined in
36
36
 
37
- [types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L187)
37
+ [types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L187)
@@ -12,4 +12,4 @@ A Uniform Resource Identifier
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:214](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L214)
15
+ [types.ts:214](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L214)
@@ -24,4 +24,4 @@ Format: 8-4-4-4-12 hexadecimal digits
24
24
 
25
25
  ## Defined in
26
26
 
27
- [types.ts:40](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L40)
27
+ [types.ts:40](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L40)
@@ -51,4 +51,4 @@ and its configuration without requiring a full reload/reinitialize.
51
51
 
52
52
  ## Defined in
53
53
 
54
- [types.ts:992](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L992)
54
+ [types.ts:992](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L992)
@@ -33,4 +33,4 @@ Used for backwards compatibility with V1 API transaction payloads:
33
33
 
34
34
  ## Defined in
35
35
 
36
- [types.ts:657](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L657)
36
+ [types.ts:657](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L657)
@@ -54,4 +54,4 @@ Transaction payload suitable for calling Notabene v1 tx/create
54
54
 
55
55
  ## Defined in
56
56
 
57
- [types.ts:663](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L663)
57
+ [types.ts:663](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L663)
@@ -26,4 +26,4 @@ Options for which VASPs to be searchable
26
26
 
27
27
  ## Defined in
28
28
 
29
- [types.ts:777](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L777)
29
+ [types.ts:777](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L777)
@@ -22,4 +22,4 @@ Validation error
22
22
 
23
23
  ## Defined in
24
24
 
25
- [types.ts:733](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L733)
25
+ [types.ts:733](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/69cd8d08514af027712db73539fbd0247649c123/src/types.ts#L733)
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "author": "Notabene <developers@notabene.id>",
11
11
  "license": "MIT",
12
12
  "packageManager": "yarn@4.5.1",
13
- "version": "2.8.0",
13
+ "version": "2.9.0-next.1",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
package/src/types.ts CHANGED
@@ -1055,6 +1055,7 @@ export enum ProofStatus {
1055
1055
  * - TIP191: Tron message signing
1056
1056
  * - ED25519: Ed25519 signature (used in Solana)
1057
1057
  * - XRP_ED25519: Ed25519 signature (used in XRP)
1058
+ * - XLM_ED25519: Ed25519 signature (used in Stellar)
1058
1059
  * - XPUB: Extended public key signature for HD wallets
1059
1060
  * - MicroTransfer: Proof via small blockchain transaction
1060
1061
  * - Screenshot: Image proof of ownership/access
@@ -1079,6 +1080,7 @@ export enum ProofTypes {
1079
1080
  TIP191 = 'tip-191',
1080
1081
  ED25519 = 'ed25519',
1081
1082
  XRP_ED25519 = 'xrp-ed25519',
1083
+ XLM_ED25519 = 'xlm-ed25519',
1082
1084
  CIP8 = 'cip-8',
1083
1085
  MicroTransfer = 'microtransfer',
1084
1086
  Screenshot = 'screenshot',
@@ -1143,7 +1145,8 @@ export interface SignatureProof extends OwnershipProof {
1143
1145
  | ProofTypes.SIWX
1144
1146
  | ProofTypes.SIWE
1145
1147
  | ProofTypes.CIP8
1146
- | ProofTypes.XRP_ED25519;
1148
+ | ProofTypes.XRP_ED25519
1149
+ | ProofTypes.XLM_ED25519;
1147
1150
 
1148
1151
  proof: string;
1149
1152
  attestation: string;