@notabene/javascript-sdk 2.2.1 → 2.2.2

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 (113) hide show
  1. package/dist/notabene.cjs +1 -1
  2. package/dist/notabene.d.ts +11 -1
  3. package/dist/notabene.js +8 -8
  4. package/docs/_media/TransactionOptions.md +6 -6
  5. package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
  6. package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
  7. package/docs/ivms/types/type-aliases/Address.md +1 -1
  8. package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
  9. package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
  10. package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
  11. package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
  12. package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
  13. package/docs/ivms/types/type-aliases/ISODate.md +1 -1
  14. package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
  15. package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
  16. package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
  17. package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
  18. package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
  19. package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
  20. package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
  21. package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
  22. package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
  23. package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
  24. package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
  25. package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
  26. package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
  27. package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
  28. package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
  29. package/docs/ivms/types/type-aliases/Originator.md +1 -1
  30. package/docs/ivms/types/type-aliases/Person.md +1 -1
  31. package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
  32. package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
  33. package/docs/notabene/README.md +6 -0
  34. package/docs/notabene/classes/EmbeddedComponent.md +17 -17
  35. package/docs/notabene/classes/default.md +6 -6
  36. package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
  37. package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
  38. package/docs/notabene/type-aliases/MessageCallback.md +1 -1
  39. package/docs/types/README.md +1 -0
  40. package/docs/types/enumerations/AgentType.md +2 -2
  41. package/docs/types/enumerations/CMType.md +17 -6
  42. package/docs/types/enumerations/HMType.md +2 -2
  43. package/docs/types/enumerations/PersonType.md +3 -3
  44. package/docs/types/enumerations/ProofStatus.md +4 -4
  45. package/docs/types/enumerations/ProofTypes.md +12 -12
  46. package/docs/types/enumerations/Status.md +5 -5
  47. package/docs/types/enumerations/VASPSearchControl.md +2 -2
  48. package/docs/types/enumerations/ValidationSections.md +4 -4
  49. package/docs/types/interfaces/Agent.md +6 -6
  50. package/docs/types/interfaces/CallbackOptions.md +2 -2
  51. package/docs/types/interfaces/ComponentRequest.md +2 -2
  52. package/docs/types/interfaces/ComponentResponse.md +4 -4
  53. package/docs/types/interfaces/ConnectionRecord.md +7 -7
  54. package/docs/types/interfaces/ConnectionRequest.md +3 -3
  55. package/docs/types/interfaces/Counterparty.md +10 -10
  56. package/docs/types/interfaces/DeclarationProof.md +6 -6
  57. package/docs/types/interfaces/Deposit.md +9 -9
  58. package/docs/types/interfaces/DepositRequest.md +7 -7
  59. package/docs/types/interfaces/DepositRequestOptions.md +1 -1
  60. package/docs/types/interfaces/LegalPerson.md +13 -13
  61. package/docs/types/interfaces/MicroTransferProof.md +9 -9
  62. package/docs/types/interfaces/NaturalPerson.md +13 -13
  63. package/docs/types/interfaces/OwnershipProof.md +4 -4
  64. package/docs/types/interfaces/ScreenshotProof.md +5 -5
  65. package/docs/types/interfaces/SignatureProof.md +7 -7
  66. package/docs/types/interfaces/ThresholdOptions.md +3 -3
  67. package/docs/types/interfaces/Transaction.md +8 -8
  68. package/docs/types/interfaces/TransactionOptions.md +6 -6
  69. package/docs/types/interfaces/TransactionResponse.md +8 -8
  70. package/docs/types/interfaces/VASP.md +9 -9
  71. package/docs/types/interfaces/Wallet.md +8 -8
  72. package/docs/types/interfaces/Withdrawal.md +9 -9
  73. package/docs/types/type-aliases/BlockchainAddress.md +1 -1
  74. package/docs/types/type-aliases/CAIP10.md +1 -1
  75. package/docs/types/type-aliases/CAIP19.md +1 -1
  76. package/docs/types/type-aliases/CAIP2.md +1 -1
  77. package/docs/types/type-aliases/CAIP220.md +1 -1
  78. package/docs/types/type-aliases/Cancel.md +1 -1
  79. package/docs/types/type-aliases/Completed.md +1 -1
  80. package/docs/types/type-aliases/ComponentMessage.md +2 -2
  81. package/docs/types/type-aliases/ConnectionOptions.md +1 -1
  82. package/docs/types/type-aliases/CryptoCredential.md +1 -1
  83. package/docs/types/type-aliases/DID.md +1 -1
  84. package/docs/types/type-aliases/DTI.md +1 -1
  85. package/docs/types/type-aliases/Destination.md +1 -1
  86. package/docs/types/type-aliases/Error.md +1 -1
  87. package/docs/types/type-aliases/FieldOptions.md +1 -1
  88. package/docs/types/type-aliases/FieldTypes.md +1 -1
  89. package/docs/types/type-aliases/HostMessage.md +1 -1
  90. package/docs/types/type-aliases/ISOCurrency.md +1 -1
  91. package/docs/types/type-aliases/InvalidValue.md +1 -1
  92. package/docs/types/type-aliases/LEI.md +1 -1
  93. package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
  94. package/docs/types/type-aliases/LegalPersonFields.md +1 -1
  95. package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
  96. package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
  97. package/docs/types/type-aliases/NotabeneAsset.md +1 -1
  98. package/docs/types/type-aliases/Ready.md +21 -0
  99. package/docs/types/type-aliases/ResizeRequest.md +1 -1
  100. package/docs/types/type-aliases/Source.md +1 -1
  101. package/docs/types/type-aliases/Theme.md +1 -1
  102. package/docs/types/type-aliases/TransactionAsset.md +1 -1
  103. package/docs/types/type-aliases/TravelAddress.md +1 -1
  104. package/docs/types/type-aliases/URI.md +1 -1
  105. package/docs/types/type-aliases/UUID.md +1 -1
  106. package/docs/types/type-aliases/UpdateValue.md +1 -1
  107. package/docs/types/type-aliases/V1Asset.md +1 -1
  108. package/docs/types/type-aliases/V1Transaction.md +1 -1
  109. package/docs/types/type-aliases/VASPOptions.md +1 -1
  110. package/docs/types/type-aliases/ValidationError.md +1 -1
  111. package/package.json +1 -1
  112. package/src/notabene.ts +2 -0
  113. package/src/types.ts +11 -0
@@ -12,4 +12,4 @@ 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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L686)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L698)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L945)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L231)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L855)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L225)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L429)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L443)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L382)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L397)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L139)
@@ -0,0 +1,21 @@
1
+ [**@notabene/javascript-sdk**](../../README.md) • **Docs**
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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L813)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L821)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L207)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L237)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L145)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L186)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L213)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L39)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L923)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L605)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L611)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/src/types.ts#L720)
@@ -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/37b9a143f8fa9e46954aa19cbff9c441035afdce/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.2.2",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/notabene.js",
16
16
  "types": "dist/notabene.d.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