@notabene/javascript-sdk 2.2.1 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/dist/notabene.cjs +1 -1
  2. package/dist/notabene.d.ts +18 -2
  3. package/dist/notabene.js +10 -10
  4. package/dist/tsdoc-metadata.json +1 -1
  5. package/docs/README.md +1 -1
  6. package/docs/_media/TransactionOptions.md +10 -10
  7. package/docs/ivms/types/README.md +1 -1
  8. package/docs/ivms/types/enumerations/PayloadVersionCode.md +3 -3
  9. package/docs/ivms/types/interfaces/PayloadMetadata.md +3 -3
  10. package/docs/ivms/types/type-aliases/Address.md +2 -2
  11. package/docs/ivms/types/type-aliases/AddressTypeCode.md +2 -2
  12. package/docs/ivms/types/type-aliases/Beneficiary.md +2 -2
  13. package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +2 -2
  14. package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +2 -2
  15. package/docs/ivms/types/type-aliases/ISOCountryCode.md +2 -2
  16. package/docs/ivms/types/type-aliases/ISODate.md +2 -2
  17. package/docs/ivms/types/type-aliases/IVMS101.md +2 -2
  18. package/docs/ivms/types/type-aliases/IntermediaryVASP.md +2 -2
  19. package/docs/ivms/types/type-aliases/LegalPerson.md +2 -2
  20. package/docs/ivms/types/type-aliases/LegalPersonName.md +2 -2
  21. package/docs/ivms/types/type-aliases/LegalPersonNameID.md +2 -2
  22. package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +2 -2
  23. package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +2 -2
  24. package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +2 -2
  25. package/docs/ivms/types/type-aliases/NationalIdentification.md +2 -2
  26. package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +2 -2
  27. package/docs/ivms/types/type-aliases/NaturalPerson.md +2 -2
  28. package/docs/ivms/types/type-aliases/NaturalPersonName.md +2 -2
  29. package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +2 -2
  30. package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +2 -2
  31. package/docs/ivms/types/type-aliases/OriginatingVASP.md +2 -2
  32. package/docs/ivms/types/type-aliases/Originator.md +2 -2
  33. package/docs/ivms/types/type-aliases/Person.md +2 -2
  34. package/docs/ivms/types/type-aliases/TransferPath.md +2 -2
  35. package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +2 -2
  36. package/docs/modules.md +1 -1
  37. package/docs/notabene/README.md +7 -1
  38. package/docs/notabene/classes/EmbeddedComponent.md +57 -31
  39. package/docs/notabene/classes/default.md +61 -25
  40. package/docs/notabene/functions/decodeFragmentToObject.md +5 -3
  41. package/docs/notabene/interfaces/NotabeneConfig.md +6 -6
  42. package/docs/notabene/type-aliases/MessageCallback.md +5 -3
  43. package/docs/types/README.md +2 -1
  44. package/docs/types/enumerations/AgentType.md +3 -3
  45. package/docs/types/enumerations/CMType.md +18 -7
  46. package/docs/types/enumerations/HMType.md +3 -3
  47. package/docs/types/enumerations/PersonType.md +4 -4
  48. package/docs/types/enumerations/ProofStatus.md +5 -5
  49. package/docs/types/enumerations/ProofTypes.md +36 -13
  50. package/docs/types/enumerations/Status.md +6 -6
  51. package/docs/types/enumerations/VASPSearchControl.md +3 -3
  52. package/docs/types/enumerations/ValidationSections.md +5 -5
  53. package/docs/types/interfaces/Agent.md +7 -7
  54. package/docs/types/interfaces/CallbackOptions.md +3 -3
  55. package/docs/types/interfaces/ComponentRequest.md +3 -3
  56. package/docs/types/interfaces/ComponentResponse.md +5 -5
  57. package/docs/types/interfaces/ConnectionRecord.md +8 -8
  58. package/docs/types/interfaces/ConnectionRequest.md +4 -4
  59. package/docs/types/interfaces/Counterparty.md +11 -11
  60. package/docs/types/interfaces/DeclarationProof.md +7 -7
  61. package/docs/types/interfaces/Deposit.md +10 -10
  62. package/docs/types/interfaces/DepositRequest.md +8 -8
  63. package/docs/types/interfaces/DepositRequestOptions.md +2 -2
  64. package/docs/types/interfaces/LegalPerson.md +14 -14
  65. package/docs/types/interfaces/MicroTransferProof.md +10 -10
  66. package/docs/types/interfaces/NaturalPerson.md +14 -14
  67. package/docs/types/interfaces/OwnershipProof.md +5 -5
  68. package/docs/types/interfaces/ScreenshotProof.md +6 -6
  69. package/docs/types/interfaces/SignatureProof.md +19 -9
  70. package/docs/types/interfaces/ThresholdOptions.md +4 -4
  71. package/docs/types/interfaces/Transaction.md +9 -9
  72. package/docs/types/interfaces/TransactionOptions.md +10 -10
  73. package/docs/types/interfaces/TransactionResponse.md +9 -9
  74. package/docs/types/interfaces/VASP.md +10 -10
  75. package/docs/types/interfaces/Wallet.md +9 -9
  76. package/docs/types/interfaces/Withdrawal.md +10 -10
  77. package/docs/types/type-aliases/BlockchainAddress.md +2 -2
  78. package/docs/types/type-aliases/CAIP10.md +2 -2
  79. package/docs/types/type-aliases/CAIP19.md +2 -2
  80. package/docs/types/type-aliases/CAIP2.md +2 -2
  81. package/docs/types/type-aliases/CAIP220.md +2 -2
  82. package/docs/types/type-aliases/Cancel.md +2 -2
  83. package/docs/types/type-aliases/Completed.md +2 -2
  84. package/docs/types/type-aliases/ComponentMessage.md +3 -3
  85. package/docs/types/type-aliases/ConnectionOptions.md +2 -2
  86. package/docs/types/type-aliases/CryptoCredential.md +2 -2
  87. package/docs/types/type-aliases/DID.md +2 -2
  88. package/docs/types/type-aliases/DTI.md +2 -2
  89. package/docs/types/type-aliases/Destination.md +2 -2
  90. package/docs/types/type-aliases/Error.md +2 -2
  91. package/docs/types/type-aliases/FieldOptions.md +3 -3
  92. package/docs/types/type-aliases/FieldTypes.md +2 -2
  93. package/docs/types/type-aliases/HostMessage.md +2 -2
  94. package/docs/types/type-aliases/ISOCurrency.md +2 -2
  95. package/docs/types/type-aliases/InvalidValue.md +2 -2
  96. package/docs/types/type-aliases/LEI.md +2 -2
  97. package/docs/types/type-aliases/LegalPersonFieldName.md +2 -2
  98. package/docs/types/type-aliases/LegalPersonFields.md +2 -2
  99. package/docs/types/type-aliases/NaturalPersonFieldName.md +2 -2
  100. package/docs/types/type-aliases/NaturalPersonFields.md +2 -2
  101. package/docs/types/type-aliases/NotabeneAsset.md +2 -2
  102. package/docs/types/type-aliases/Ready.md +21 -0
  103. package/docs/types/type-aliases/ResizeRequest.md +2 -2
  104. package/docs/types/type-aliases/Source.md +2 -2
  105. package/docs/types/type-aliases/Theme.md +2 -2
  106. package/docs/types/type-aliases/TransactionAsset.md +2 -2
  107. package/docs/types/type-aliases/TravelAddress.md +2 -2
  108. package/docs/types/type-aliases/URI.md +2 -2
  109. package/docs/types/type-aliases/UUID.md +2 -2
  110. package/docs/types/type-aliases/UpdateValue.md +2 -2
  111. package/docs/types/type-aliases/V1Asset.md +3 -3
  112. package/docs/types/type-aliases/V1Transaction.md +2 -2
  113. package/docs/types/type-aliases/VASPOptions.md +2 -2
  114. package/docs/types/type-aliases/ValidationError.md +2 -2
  115. package/package.json +4 -4
  116. package/src/notabene.ts +2 -0
  117. package/src/types.ts +19 -0
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -36,4 +36,4 @@ Format: `namespace:reference`
36
36
 
37
37
  ## Defined in
38
38
 
39
- [types.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L56)
39
+ [types.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L56)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ Chain Agnostic Payload Identifier
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:97](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L97)
15
+ [types.ts:97](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L97)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -20,4 +20,4 @@ Represents a cancel component message
20
20
 
21
21
  ## Defined in
22
22
 
23
- [types.ts:834](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L834)
23
+ [types.ts:844](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L844)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -32,4 +32,4 @@ The Response object which wraps T
32
32
 
33
33
  ## Defined in
34
34
 
35
- [types.ts:802](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L802)
35
+ [types.ts:804](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L804)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Type Alias: ComponentMessage\<T\>
8
8
 
9
- > **ComponentMessage**\<`T`\>: [`Completed`](Completed.md)\<`T`\> \| [`Cancel`](Cancel.md) \| [`Error`](Error.md) \| [`ResizeRequest`](ResizeRequest.md) \| [`InvalidValue`](InvalidValue.md)\<`T`\>
9
+ > **ComponentMessage**\<`T`\>: [`Completed`](Completed.md)\<`T`\> \| [`Cancel`](Cancel.md) \| [`Error`](Error.md) \| [`Ready`](Ready.md) \| [`ResizeRequest`](ResizeRequest.md) \| [`InvalidValue`](InvalidValue.md)\<`T`\>
10
10
 
11
11
  Union type representing all possible messages that can be sent from a component
12
12
 
@@ -36,4 +36,4 @@ through these message types:
36
36
 
37
37
  ## Defined in
38
38
 
39
- [types.ts:872](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L872)
39
+ [types.ts:882](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L882)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ An object representing options for a Connection Request
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:574](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L574)
15
+ [types.ts:574](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L574)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ A crypto credential
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:191](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L191)
15
+ [types.ts:191](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L191)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ A Decentralized Identifier
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:219](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L219)
15
+ [types.ts:219](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L219)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -35,4 +35,4 @@ Format: `DTI[NNNNN]` where N is a digit
35
35
 
36
36
  ## Defined in
37
37
 
38
- [types.ts:117](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L117)
38
+ [types.ts:117](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L117)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ The destination of a transaction either a blockchain address, a CAIP-19 address,
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:197](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L197)
15
+ [types.ts:197](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L197)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -42,4 +42,4 @@ Identifier code of the error message
42
42
 
43
43
  ## Defined in
44
44
 
45
- [types.ts:823](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L823)
45
+ [types.ts:833](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L833)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,10 +6,10 @@
6
6
 
7
7
  # Type Alias: FieldOptions
8
8
 
9
- > **FieldOptions**: `boolean` \| `object`
9
+ > **FieldOptions**: `boolean` \| \{ `optional`: `boolean`; `transmit`: `boolean`; \}
10
10
 
11
11
  Field properties
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:686](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L686)
15
+ [types.ts:686](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L686)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -22,4 +22,4 @@ Field type configuration
22
22
 
23
23
  ## Defined in
24
24
 
25
- [types.ts:698](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L698)
25
+ [types.ts:698](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L698)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -34,4 +34,4 @@ without requiring full reinitialization.
34
34
 
35
35
  ## Defined in
36
36
 
37
- [types.ts:934](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L934)
37
+ [types.ts:945](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L945)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:231](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L231)
15
+ [types.ts:231](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L231)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -42,4 +42,4 @@ Array of validation errors
42
42
 
43
43
  ## Defined in
44
44
 
45
- [types.ts:845](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L845)
45
+ [types.ts:855](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L855)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ A LEI Legal Entity Identifier
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:225](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L225)
15
+ [types.ts:225](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L225)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [types.ts:429](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L429)
13
+ [types.ts:429](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L429)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ Field properties by field name
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:443](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L443)
15
+ [types.ts:443](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L443)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ Field names for NaturalPerson
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:382](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L382)
15
+ [types.ts:382](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L382)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ Field properties by field name for Natural persons
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:397](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L397)
15
+ [types.ts:397](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L397)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -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:139](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L139)
36
+ [types.ts:139](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L139)
@@ -0,0 +1,21 @@
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
+
3
+ ***
4
+
5
+ [@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Ready
6
+
7
+ # Type Alias: Ready
8
+
9
+ > **Ready**: `object`
10
+
11
+ Represents a ready component message
12
+
13
+ ## Type declaration
14
+
15
+ ### type
16
+
17
+ > **type**: [`READY`](../enumerations/CMType.md#ready)
18
+
19
+ ## Defined in
20
+
21
+ [types.ts:813](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L813)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -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:811](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L811)
27
+ [types.ts:821](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L821)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ The source of a transaction
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:207](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L207)
15
+ [types.ts:207](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L207)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -30,4 +30,4 @@ The theme of the Notabene SDK
30
30
 
31
31
  ## Defined in
32
32
 
33
- [types.ts:237](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L237)
33
+ [types.ts:237](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L237)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -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:145](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L145)
15
+ [types.ts:145](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L145)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -34,4 +34,4 @@ VASPs and blockchain networks while maintaining privacy.
34
34
 
35
35
  ## Defined in
36
36
 
37
- [types.ts:186](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L186)
37
+ [types.ts:186](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L186)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,4 +12,4 @@ A Uniform Resource Identifier
12
12
 
13
13
  ## Defined in
14
14
 
15
- [types.ts:213](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L213)
15
+ [types.ts:213](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L213)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -24,4 +24,4 @@ Format: 8-4-4-4-12 hexadecimal digits
24
24
 
25
25
  ## Defined in
26
26
 
27
- [types.ts:39](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L39)
27
+ [types.ts:39](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L39)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -51,4 +51,4 @@ and its configuration without requiring a full reload/reinitialize.
51
51
 
52
52
  ## Defined in
53
53
 
54
- [types.ts:912](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L912)
54
+ [types.ts:923](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L923)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Type Alias: V1Asset
8
8
 
9
- > **V1Asset**: [`NotabeneAsset`](NotabeneAsset.md) \| `object`
9
+ > **V1Asset**: [`NotabeneAsset`](NotabeneAsset.md) \| \{ `caip19`: [`CAIP19`](CAIP19.md); \}
10
10
 
11
11
  Represents a legacy V1 API asset format supporting both Notabene and CAIP-19 identifiers
12
12
 
@@ -33,4 +33,4 @@ Used for backwards compatibility with V1 API transaction payloads:
33
33
 
34
34
  ## Defined in
35
35
 
36
- [types.ts:605](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L605)
36
+ [types.ts:605](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L605)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -46,4 +46,4 @@ Transaction payload suitable for calling Notabene v1 tx/create
46
46
 
47
47
  ## Defined in
48
48
 
49
- [types.ts:611](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L611)
49
+ [types.ts:611](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L611)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -26,4 +26,4 @@ Options for which VASPs to be searchable
26
26
 
27
27
  ## Defined in
28
28
 
29
- [types.ts:720](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L720)
29
+ [types.ts:720](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L720)
@@ -1,4 +1,4 @@
1
- [**@notabene/javascript-sdk**](../../README.md) • **Docs**
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -22,4 +22,4 @@ Validation error
22
22
 
23
23
  ## Defined in
24
24
 
25
- [types.ts:677](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/e726d89bf77c8ab57b82ac5a02356ef19031620e/src/types.ts#L677)
25
+ [types.ts:677](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/3486f61e2b02a464f16f90ee758186b0548e4e66/src/types.ts#L677)
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.2.1",
13
+ "version": "2.3.0",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/notabene.js",
16
16
  "types": "dist/notabene.d.ts",
@@ -64,12 +64,12 @@
64
64
  "prettier-plugin-organize-imports": "^4.1.0",
65
65
  "rimraf": "^6.0.1",
66
66
  "semantic-release": "^24.2.0",
67
- "typedoc": "^0.26.11",
67
+ "typedoc": "^0.27.5",
68
68
  "typedoc-plugin-markdown": "^4.2.10",
69
- "typescript": "^5.6.3",
69
+ "typescript": "^5.7.2",
70
70
  "typescript-eslint": "^8.12.2",
71
71
  "vite": "^5.4.10",
72
- "vitest": "^2.1.3"
72
+ "vitest": "^2.1.8"
73
73
  },
74
74
  "lint-staged": {
75
75
  "*.ts": [
package/src/notabene.ts CHANGED
@@ -33,6 +33,7 @@ import type {
33
33
  NaturalPerson,
34
34
  NotabeneAsset,
35
35
  OwnershipProof,
36
+ Ready,
36
37
  ResizeRequest,
37
38
  ScreenshotProof,
38
39
  SignatureProof,
@@ -111,6 +112,7 @@ export type {
111
112
  NaturalPerson,
112
113
  NotabeneAsset,
113
114
  OwnershipProof,
115
+ Ready,
114
116
  ResizeRequest,
115
117
  ScreenshotProof,
116
118
  SignatureProof,
package/src/types.ts CHANGED
@@ -779,6 +779,7 @@ export interface TransactionOptions {
779
779
  * - COMPLETE: Indicates a completed operation with response data
780
780
  * - RESIZE: Request to adjust component size/dimensions
781
781
  * - RESULT: Operation result notification
782
+ * - READY: Component is initialized and ready
782
783
  * - INVALID: Validation failed with errors
783
784
  * - ERROR: Operation encountered an error
784
785
  * - CANCEL: Operation was cancelled
@@ -788,6 +789,7 @@ export enum CMType {
788
789
  COMPLETE = 'complete',
789
790
  RESIZE = 'resize',
790
791
  RESULT = 'result',
792
+ READY = 'ready',
791
793
  INVALID = 'invalid',
792
794
  ERROR = 'error',
793
795
  CANCEL = 'cancel',
@@ -804,6 +806,14 @@ export type Completed<T> = {
804
806
  response: TransactionResponse<T>;
805
807
  };
806
808
 
809
+ /**
810
+ * Represents a ready component message
811
+ * @public
812
+ */
813
+ export type Ready = {
814
+ type: CMType.READY;
815
+ };
816
+
807
817
  /**
808
818
  * Represents a resize request component message. This is handled by the library.
809
819
  * @internal
@@ -873,6 +883,7 @@ export type ComponentMessage<T> =
873
883
  | Completed<T>
874
884
  | Cancel
875
885
  | Error
886
+ | Ready
876
887
  | ResizeRequest
877
888
  | InvalidValue<T>;
878
889
 
@@ -971,6 +982,9 @@ export enum ProofStatus {
971
982
  * - SIWE: Sign-In with Ethereum message signature (EIP-4361)
972
983
  * - EIP712: Ethereum typed data signature following EIP-712 standard
973
984
  * - BIP137: Bitcoin message signature following BIP-137
985
+ * - BIP322: Bitcoin message signature following BIP-322
986
+ * - TIP191: Tron message signing
987
+ * - ED25519: Ed25519 signature (used in Solana)
974
988
  * - XPUB: Extended public key signature for HD wallets
975
989
  * - MicroTransfer: Proof via small blockchain transaction
976
990
  * - Screenshot: Image proof of ownership/access
@@ -989,7 +1003,9 @@ export enum ProofTypes {
989
1003
  EIP712 = 'eip-712',
990
1004
  EIP1271 = 'eip-1271',
991
1005
  BIP137 = 'bip-137',
1006
+ BIP322 = 'bip-322',
992
1007
  BIP137_XPUB = 'xpub',
1008
+ TIP191 = 'tip-191',
993
1009
  ED25519 = 'ed25519',
994
1010
  MicroTransfer = 'microtransfer',
995
1011
  Screenshot = 'screenshot',
@@ -1047,14 +1063,17 @@ export interface SignatureProof extends OwnershipProof {
1047
1063
  | ProofTypes.EIP712
1048
1064
  | ProofTypes.EIP1271
1049
1065
  | ProofTypes.BIP137
1066
+ | ProofTypes.BIP322
1050
1067
  | ProofTypes.BIP137_XPUB
1051
1068
  | ProofTypes.ED25519
1069
+ | ProofTypes.TIP191
1052
1070
  | ProofTypes.SIWX
1053
1071
  | ProofTypes.SIWE;
1054
1072
 
1055
1073
  proof: string;
1056
1074
  attestation: string;
1057
1075
  wallet_provider: string;
1076
+ xpub?: string;
1058
1077
  }
1059
1078
 
1060
1079
  /**