@notabene/javascript-sdk 2.10.0-next.4 → 2.11.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 (136) hide show
  1. package/dist/cjs/notabene.cjs +1 -1
  2. package/dist/cjs/notabene.d.ts +60 -1
  3. package/dist/cjs/package.json +1 -1
  4. package/dist/esm/notabene.d.ts +60 -1
  5. package/dist/esm/notabene.js +14 -14
  6. package/dist/esm/package.json +1 -1
  7. package/dist/notabene.d.ts +60 -1
  8. package/dist/notabene.js +14 -14
  9. package/docs/README.md +9 -4
  10. package/docs/_media/TransactionOptions.md +17 -7
  11. package/docs/_media/getRefreshResult.md +1 -1
  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/classes/ConnectionManager.md +5 -5
  41. package/docs/notabene/classes/EmbeddedComponent.md +17 -17
  42. package/docs/notabene/classes/default.md +7 -7
  43. package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
  44. package/docs/notabene/functions/getRefreshResult.md +1 -1
  45. package/docs/notabene/interfaces/ConnectionData.md +4 -4
  46. package/docs/notabene/interfaces/ConnectionMetadata.md +3 -3
  47. package/docs/notabene/interfaces/ConnectionResponse.md +6 -6
  48. package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
  49. package/docs/notabene/type-aliases/ConnectionResult.md +1 -1
  50. package/docs/notabene/type-aliases/ConnectionStatus.md +1 -1
  51. package/docs/notabene/type-aliases/MessageCallback.md +1 -1
  52. package/docs/notabene/type-aliases/TransactionType.md +1 -1
  53. package/docs/types/README.md +2 -0
  54. package/docs/types/enumerations/AgentType.md +2 -2
  55. package/docs/types/enumerations/CMType.md +27 -7
  56. package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
  57. package/docs/types/enumerations/HMType.md +2 -2
  58. package/docs/types/enumerations/PersonType.md +3 -3
  59. package/docs/types/enumerations/ProofStatus.md +4 -4
  60. package/docs/types/enumerations/ProofTypes.md +30 -18
  61. package/docs/types/enumerations/Status.md +5 -5
  62. package/docs/types/enumerations/VASPSearchControl.md +2 -2
  63. package/docs/types/enumerations/ValidationSections.md +4 -4
  64. package/docs/types/interfaces/Account.md +5 -5
  65. package/docs/types/interfaces/Agent.md +6 -6
  66. package/docs/types/interfaces/CallbackOptions.md +2 -2
  67. package/docs/types/interfaces/ComponentRequest.md +2 -2
  68. package/docs/types/interfaces/ComponentResponse.md +4 -4
  69. package/docs/types/interfaces/ConnectionRecord.md +7 -7
  70. package/docs/types/interfaces/ConnectionRequest.md +3 -3
  71. package/docs/types/interfaces/Counterparty.md +10 -10
  72. package/docs/types/interfaces/DeclarationProof.md +6 -6
  73. package/docs/types/interfaces/Deposit.md +12 -12
  74. package/docs/types/interfaces/DepositRequest.md +7 -7
  75. package/docs/types/interfaces/DepositRequestOptions.md +1 -1
  76. package/docs/types/interfaces/DepositTransaction.md +10 -10
  77. package/docs/types/interfaces/LegalPerson.md +13 -13
  78. package/docs/types/interfaces/MicroTransferProof.md +9 -9
  79. package/docs/types/interfaces/NaturalPerson.md +13 -13
  80. package/docs/types/interfaces/OwnershipProof.md +4 -4
  81. package/docs/types/interfaces/RefreshSource.md +2 -2
  82. package/docs/types/interfaces/Refreshable.md +1 -1
  83. package/docs/types/interfaces/ScreenshotProof.md +5 -5
  84. package/docs/types/interfaces/SignatureProof.md +14 -12
  85. package/docs/types/interfaces/ThresholdOptions.md +3 -3
  86. package/docs/types/interfaces/Transaction.md +9 -9
  87. package/docs/types/interfaces/TransactionOptions.md +17 -7
  88. package/docs/types/interfaces/TransactionResponse.md +9 -9
  89. package/docs/types/interfaces/VASP.md +19 -9
  90. package/docs/types/interfaces/Wallet.md +8 -8
  91. package/docs/types/interfaces/Withdrawal.md +11 -11
  92. package/docs/types/type-aliases/BlockchainAddress.md +1 -1
  93. package/docs/types/type-aliases/CAIP10.md +1 -1
  94. package/docs/types/type-aliases/CAIP19.md +1 -1
  95. package/docs/types/type-aliases/CAIP2.md +1 -1
  96. package/docs/types/type-aliases/CAIP220.md +1 -1
  97. package/docs/types/type-aliases/Cancel.md +1 -1
  98. package/docs/types/type-aliases/Completed.md +1 -1
  99. package/docs/types/type-aliases/ComponentMessage.md +5 -2
  100. package/docs/types/type-aliases/ConnectionOptions.md +1 -1
  101. package/docs/types/type-aliases/CounterpartyAssistConfig.md +1 -1
  102. package/docs/types/type-aliases/CryptoCredential.md +1 -1
  103. package/docs/types/type-aliases/DID.md +1 -1
  104. package/docs/types/type-aliases/DTI.md +1 -1
  105. package/docs/types/type-aliases/Destination.md +1 -1
  106. package/docs/types/type-aliases/Error.md +1 -1
  107. package/docs/types/type-aliases/FieldOptions.md +2 -2
  108. package/docs/types/type-aliases/FieldTypes.md +1 -1
  109. package/docs/types/type-aliases/HostMessage.md +1 -1
  110. package/docs/types/type-aliases/ISOCurrency.md +1 -1
  111. package/docs/types/type-aliases/Info.md +37 -0
  112. package/docs/types/type-aliases/InvalidValue.md +1 -1
  113. package/docs/types/type-aliases/LEI.md +1 -1
  114. package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
  115. package/docs/types/type-aliases/LegalPersonFields.md +1 -1
  116. package/docs/types/type-aliases/NationalIdentifierTypeFieldOptions.md +1 -1
  117. package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
  118. package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
  119. package/docs/types/type-aliases/NotabeneAsset.md +1 -1
  120. package/docs/types/type-aliases/Ready.md +1 -1
  121. package/docs/types/type-aliases/ResizeRequest.md +1 -1
  122. package/docs/types/type-aliases/Source.md +1 -1
  123. package/docs/types/type-aliases/Theme.md +1 -1
  124. package/docs/types/type-aliases/TransactionAsset.md +1 -1
  125. package/docs/types/type-aliases/TravelAddress.md +1 -1
  126. package/docs/types/type-aliases/URI.md +1 -1
  127. package/docs/types/type-aliases/UUID.md +1 -1
  128. package/docs/types/type-aliases/UpdateValue.md +1 -1
  129. package/docs/types/type-aliases/V1Asset.md +1 -1
  130. package/docs/types/type-aliases/V1Transaction.md +1 -1
  131. package/docs/types/type-aliases/VASPOptions.md +1 -1
  132. package/docs/types/type-aliases/ValidationError.md +1 -1
  133. package/docs/types/type-aliases/Warning.md +37 -0
  134. package/package.json +1 -1
  135. package/src/notabene.ts +4 -0
  136. package/src/types.ts +65 -3
@@ -0,0 +1,37 @@
1
+ [**@notabene/javascript-sdk**](../../README.md)
2
+
3
+ ***
4
+
5
+ [@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Warning
6
+
7
+ # Type Alias: Warning
8
+
9
+ > **Warning**: `object`
10
+
11
+ Represents a warning component message
12
+
13
+ ## Type declaration
14
+
15
+ ### description?
16
+
17
+ > `optional` **description**: `string`
18
+
19
+ ### message
20
+
21
+ > **message**: `string`
22
+
23
+ ### type
24
+
25
+ > **type**: [`WARNING`](../enumerations/CMType.md#warning)
26
+
27
+ ## Param
28
+
29
+ Warning message
30
+
31
+ ## Param
32
+
33
+ Description of the warning message
34
+
35
+ ## Defined in
36
+
37
+ [types.ts:967](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L967)
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.10.0-next.4",
13
+ "version": "2.11.0",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
package/src/notabene.ts CHANGED
@@ -45,6 +45,8 @@ import type {
45
45
  ResizeRequest,
46
46
  ScreenshotProof,
47
47
  SignatureProof,
48
+ SIWXInput,
49
+ SolanaMetadata,
48
50
  Theme,
49
51
  ThresholdOptions,
50
52
  Transaction,
@@ -146,6 +148,8 @@ export type {
146
148
  ResizeRequest,
147
149
  ScreenshotProof,
148
150
  SignatureProof,
151
+ SIWXInput,
152
+ SolanaMetadata,
149
153
  Theme,
150
154
  ThresholdOptions,
151
155
  Transaction,
package/src/types.ts CHANGED
@@ -1109,6 +1109,8 @@ export enum ProofStatus {
1109
1109
  * - SelfDeclaration: User self-declares ownership without cryptographic proof
1110
1110
  * - EIP191: Ethereum personal signature following EIP-191 standard
1111
1111
  * - SIWE: Sign-In with Ethereum message signature (EIP-4361)
1112
+ * - SIWX: Sign-In with X message signature
1113
+ * - SOL_SIWX: Sign-In with Solana message signature (SIWE for Solana)
1112
1114
  * - EIP712: Ethereum typed data signature following EIP-712 standard
1113
1115
  * - BIP137: Bitcoin message signature following BIP-137
1114
1116
  * - BIP322: Bitcoin message signature following BIP-322
@@ -1131,6 +1133,7 @@ export enum ProofTypes {
1131
1133
  SelfDeclaration = 'self-declaration',
1132
1134
  SIWE = 'siwe',
1133
1135
  SIWX = 'siwx',
1136
+ SOL_SIWX = 'sol-siwx',
1134
1137
  EIP191 = 'eip-191',
1135
1138
  EIP712 = 'eip-712',
1136
1139
  EIP1271 = 'eip-1271',
@@ -1176,6 +1179,62 @@ export interface OwnershipProof {
1176
1179
  address: CAIP10;
1177
1180
  }
1178
1181
 
1182
+ /**
1183
+ * Input for SIWX message signing
1184
+ * Every SIWX message must include the following fields:
1185
+ * - domain
1186
+ * - address
1187
+ * - statement
1188
+ * - uri
1189
+ * - version
1190
+ * - chainId
1191
+ *
1192
+ * Optional fields:
1193
+ * - nonce
1194
+ * - issuedAt
1195
+ * - expirationTime
1196
+ * - notBefore
1197
+ * - requestId
1198
+ * - resources
1199
+ *
1200
+ * @public
1201
+ */
1202
+ export interface SIWXInput {
1203
+ domain: string;
1204
+ address: string;
1205
+ statement?: string;
1206
+ uri?: string;
1207
+ version?: string;
1208
+ chainId?: string;
1209
+ nonce?: string;
1210
+ issuedAt?: string;
1211
+ expirationTime?: string;
1212
+ notBefore?: string;
1213
+ requestId?: string;
1214
+ resources?: readonly string[];
1215
+ }
1216
+
1217
+ /**
1218
+ * Metadata for Solana SIWX ownership proofs
1219
+ * @remarks
1220
+ * - Includes the account public key and address
1221
+ * - Includes the signed message
1222
+ * - Includes the signature
1223
+ * - Includes the message
1224
+ *
1225
+ * @see {@link SignatureProof} For signature-based proofs
1226
+ * @public
1227
+ */
1228
+ export interface SolanaMetadata {
1229
+ account: {
1230
+ address: string;
1231
+ publicKey: Uint8Array;
1232
+ };
1233
+ signedMessage: Uint8Array;
1234
+ signature: Uint8Array;
1235
+ message: SIWXInput;
1236
+ }
1237
+
1179
1238
  /**
1180
1239
  * Interface for signature-based ownership proofs that use cryptographic message signing
1181
1240
  *
@@ -1204,6 +1263,7 @@ export interface SignatureProof extends OwnershipProof {
1204
1263
  | ProofTypes.ED25519
1205
1264
  | ProofTypes.TIP191
1206
1265
  | ProofTypes.SIWX
1266
+ | ProofTypes.SOL_SIWX
1207
1267
  | ProofTypes.SIWE
1208
1268
  | ProofTypes.CIP8
1209
1269
  | ProofTypes.XRP_ED25519
@@ -1214,9 +1274,11 @@ export interface SignatureProof extends OwnershipProof {
1214
1274
  attestation: string;
1215
1275
  wallet_provider: string;
1216
1276
  xpub?: string;
1217
- chainSpecificData?: {
1218
- cardanoCoseKey?: string; // Cardano COSE key https://cips.cardano.org/cip/CIP-0030
1219
- };
1277
+ chainSpecificData?:
1278
+ | {
1279
+ cardanoCoseKey?: string; // Cardano COSE key https://cips.cardano.org/cip/CIP-0030
1280
+ }
1281
+ | SolanaMetadata;
1220
1282
  }
1221
1283
 
1222
1284
  /**