@notabene/javascript-sdk 2.5.1 → 2.5.3
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.
- package/README.md +65 -2
- package/dist/notabene.d.ts +10 -1
- package/docs/README.md +65 -2
- package/docs/_media/TransactionOptions.md +6 -6
- package/docs/ivms/types/enumerations/PayloadVersionCode.md +2 -2
- package/docs/ivms/types/interfaces/PayloadMetadata.md +2 -2
- package/docs/ivms/types/type-aliases/Address.md +1 -1
- package/docs/ivms/types/type-aliases/AddressTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/Beneficiary.md +1 -1
- package/docs/ivms/types/type-aliases/BeneficiaryVASP.md +1 -1
- package/docs/ivms/types/type-aliases/DateAndPlaceOfBirth.md +1 -1
- package/docs/ivms/types/type-aliases/ISOCountryCode.md +1 -1
- package/docs/ivms/types/type-aliases/ISODate.md +1 -1
- package/docs/ivms/types/type-aliases/IVMS101.md +1 -1
- package/docs/ivms/types/type-aliases/IntermediaryVASP.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPerson.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonName.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/LegalPersonNameTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/LocalLegalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/LocalNaturalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/NationalIdentification.md +1 -1
- package/docs/ivms/types/type-aliases/NationalIdentifierTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPerson.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonName.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonNameID.md +1 -1
- package/docs/ivms/types/type-aliases/NaturalPersonNameTypeCode.md +1 -1
- package/docs/ivms/types/type-aliases/OriginatingVASP.md +1 -1
- package/docs/ivms/types/type-aliases/Originator.md +1 -1
- package/docs/ivms/types/type-aliases/Person.md +1 -1
- package/docs/ivms/types/type-aliases/TransferPath.md +1 -1
- package/docs/ivms/types/type-aliases/TransliterationMethodCode.md +1 -1
- package/docs/notabene/README.md +6 -0
- package/docs/notabene/classes/EmbeddedComponent.md +17 -17
- package/docs/notabene/classes/default.md +44 -6
- package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
- package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
- package/docs/notabene/type-aliases/MessageCallback.md +1 -1
- package/docs/types/README.md +1 -0
- package/docs/types/enumerations/AgentType.md +2 -2
- package/docs/types/enumerations/CMType.md +7 -7
- package/docs/types/enumerations/ErrorIdentifierCode.md +4 -4
- package/docs/types/enumerations/HMType.md +2 -2
- package/docs/types/enumerations/PersonType.md +3 -3
- package/docs/types/enumerations/ProofStatus.md +4 -4
- package/docs/types/enumerations/ProofTypes.md +14 -14
- package/docs/types/enumerations/Status.md +5 -5
- package/docs/types/enumerations/VASPSearchControl.md +2 -2
- package/docs/types/enumerations/ValidationSections.md +4 -4
- package/docs/types/interfaces/Agent.md +6 -6
- package/docs/types/interfaces/CallbackOptions.md +2 -2
- package/docs/types/interfaces/ComponentRequest.md +2 -2
- package/docs/types/interfaces/ComponentResponse.md +4 -4
- package/docs/types/interfaces/ConnectionRecord.md +7 -7
- package/docs/types/interfaces/ConnectionRequest.md +3 -3
- package/docs/types/interfaces/Counterparty.md +10 -10
- package/docs/types/interfaces/DeclarationProof.md +6 -6
- package/docs/types/interfaces/Deposit.md +32 -18
- package/docs/types/interfaces/DepositRequest.md +7 -7
- package/docs/types/interfaces/DepositRequestOptions.md +1 -1
- package/docs/types/interfaces/DepositTransaction.md +147 -0
- package/docs/types/interfaces/LegalPerson.md +13 -13
- package/docs/types/interfaces/MicroTransferProof.md +9 -9
- package/docs/types/interfaces/NaturalPerson.md +13 -13
- package/docs/types/interfaces/OwnershipProof.md +4 -4
- package/docs/types/interfaces/ScreenshotProof.md +5 -5
- package/docs/types/interfaces/SignatureProof.md +8 -8
- package/docs/types/interfaces/ThresholdOptions.md +3 -3
- package/docs/types/interfaces/Transaction.md +9 -9
- package/docs/types/interfaces/TransactionOptions.md +6 -6
- package/docs/types/interfaces/TransactionResponse.md +18 -8
- package/docs/types/interfaces/VASP.md +9 -9
- package/docs/types/interfaces/Wallet.md +8 -8
- package/docs/types/interfaces/Withdrawal.md +9 -9
- package/docs/types/type-aliases/BlockchainAddress.md +1 -1
- package/docs/types/type-aliases/CAIP10.md +1 -1
- package/docs/types/type-aliases/CAIP19.md +1 -1
- package/docs/types/type-aliases/CAIP2.md +1 -1
- package/docs/types/type-aliases/CAIP220.md +1 -1
- package/docs/types/type-aliases/Cancel.md +1 -1
- package/docs/types/type-aliases/Completed.md +1 -1
- package/docs/types/type-aliases/ComponentMessage.md +1 -1
- package/docs/types/type-aliases/ConnectionOptions.md +1 -1
- package/docs/types/type-aliases/CryptoCredential.md +1 -1
- package/docs/types/type-aliases/DID.md +1 -1
- package/docs/types/type-aliases/DTI.md +1 -1
- package/docs/types/type-aliases/Destination.md +1 -1
- package/docs/types/type-aliases/Error.md +1 -1
- package/docs/types/type-aliases/FieldOptions.md +1 -1
- package/docs/types/type-aliases/FieldTypes.md +1 -1
- package/docs/types/type-aliases/HostMessage.md +1 -1
- package/docs/types/type-aliases/ISOCurrency.md +1 -1
- package/docs/types/type-aliases/InvalidValue.md +1 -1
- package/docs/types/type-aliases/LEI.md +1 -1
- package/docs/types/type-aliases/LegalPersonFieldName.md +1 -1
- package/docs/types/type-aliases/LegalPersonFields.md +1 -1
- package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
- package/docs/types/type-aliases/NaturalPersonFields.md +1 -1
- package/docs/types/type-aliases/NotabeneAsset.md +1 -1
- package/docs/types/type-aliases/Ready.md +1 -1
- package/docs/types/type-aliases/ResizeRequest.md +1 -1
- package/docs/types/type-aliases/Source.md +1 -1
- package/docs/types/type-aliases/Theme.md +1 -1
- package/docs/types/type-aliases/TransactionAsset.md +1 -1
- package/docs/types/type-aliases/TravelAddress.md +1 -1
- package/docs/types/type-aliases/URI.md +1 -1
- package/docs/types/type-aliases/UUID.md +1 -1
- package/docs/types/type-aliases/UpdateValue.md +1 -1
- package/docs/types/type-aliases/V1Asset.md +1 -1
- package/docs/types/type-aliases/V1Transaction.md +5 -1
- package/docs/types/type-aliases/VASPOptions.md +1 -1
- package/docs/types/type-aliases/ValidationError.md +1 -1
- package/package.json +1 -1
- package/src/types.ts +10 -1
package/README.md
CHANGED
|
@@ -44,6 +44,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
|
|
|
44
44
|
- [Deposit Assist](#deposit-assist)
|
|
45
45
|
- [Parameters](#parameters-3)
|
|
46
46
|
- [Error handling](#error-handling)
|
|
47
|
+
- [Error reference](#error-reference)
|
|
47
48
|
- [Transaction parameters](#transaction-parameters)
|
|
48
49
|
- [Asset specification](#asset-specification)
|
|
49
50
|
- [Transaction amount](#transaction-amount)
|
|
@@ -63,6 +64,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
|
|
|
63
64
|
- [Full Example](#full-example)
|
|
64
65
|
- [Field reference](#field-reference)
|
|
65
66
|
- [Locales](#locales)
|
|
67
|
+
- [Theming](#theming)
|
|
66
68
|
- [License](#license)
|
|
67
69
|
|
|
68
70
|
## Installation
|
|
@@ -198,6 +200,14 @@ To be notified of any validation errors use:
|
|
|
198
200
|
withdrawal.on('error',error => ...)
|
|
199
201
|
```
|
|
200
202
|
|
|
203
|
+
To be notified when the component is Ready:
|
|
204
|
+
|
|
205
|
+
```js
|
|
206
|
+
withdrawal.on('ready', ({ type }) => {
|
|
207
|
+
console.log(type === 'ready');
|
|
208
|
+
});
|
|
209
|
+
```
|
|
210
|
+
|
|
201
211
|
Calling `on` returns a function that will allow you to cleanly unsubscribe.
|
|
202
212
|
|
|
203
213
|
```js
|
|
@@ -400,6 +410,7 @@ const deposit = notabene.createDepositAssist(
|
|
|
400
410
|
amountDecimal: 1.23,
|
|
401
411
|
origin: '0x...',
|
|
402
412
|
destination: '0x...',
|
|
413
|
+
transactionId: "UUID"
|
|
403
414
|
},
|
|
404
415
|
{
|
|
405
416
|
// Optional transaction options
|
|
@@ -413,6 +424,7 @@ const deposit = notabene.createDepositAssist(
|
|
|
413
424
|
- `origin`: The origin or blockchain address for the deposit. See [Origin](#origin)
|
|
414
425
|
- `destination`: The destination or blockchain address for the deposit. See [Destination](#destination)
|
|
415
426
|
- `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
|
|
427
|
+
- `transactionId`: Optional transactionId of a Notabene transaction. Will be returned with the payload to assist updating the Transaction
|
|
416
428
|
|
|
417
429
|
If any of the required parameters are missing the component will just show the Notabene badge.
|
|
418
430
|
|
|
@@ -423,9 +435,43 @@ If any of the required parameters are missing the component will just show the N
|
|
|
423
435
|
If any error occurs, the `error` event is passed containing a message.
|
|
424
436
|
|
|
425
437
|
```ts
|
|
426
|
-
withdrawal.on('error',
|
|
438
|
+
withdrawal.on('error', (error) => ...)
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
An example error object.
|
|
442
|
+
|
|
443
|
+
```ts
|
|
444
|
+
type Error = {
|
|
445
|
+
type: CMType.Error;
|
|
446
|
+
message: string;
|
|
447
|
+
description: string;
|
|
448
|
+
identifier: ErrorIdentifierCode;
|
|
449
|
+
};
|
|
450
|
+
```
|
|
451
|
+
Errors can be handled in this way:
|
|
452
|
+
|
|
453
|
+
```ts
|
|
454
|
+
component.on('error', (error) => {
|
|
455
|
+
if (error.type === CMType.Error) {
|
|
456
|
+
switch (error.identifier) {
|
|
457
|
+
case ErrorIdentifierCode.SERVICE_UNAVAILABLE:
|
|
458
|
+
// handle the error
|
|
459
|
+
break;
|
|
460
|
+
//...
|
|
461
|
+
}
|
|
462
|
+
}
|
|
463
|
+
});
|
|
427
464
|
```
|
|
428
465
|
|
|
466
|
+
#### Error reference
|
|
467
|
+
|
|
468
|
+
| ErrorIdentifierCode | Description/Message | In Use |
|
|
469
|
+
|--------------------------|----------------------------------------------------------------------------------------------------------|---|
|
|
470
|
+
| SERVICE_UNAVAILABLE | The Notabene service is currently unavailable | ✅ |
|
|
471
|
+
| TOKEN_INVALID | Auth Token is Invalid | ✅ |
|
|
472
|
+
| WALLET_CONNECTION_FAILED | The connection to the wallet service failed, possibly due to network issues or unsupported wallet types. | ✅ |
|
|
473
|
+
| WALLET_NOT_SUPPORTED | The wallet used does not support the required functionality or blockchain. | |
|
|
474
|
+
|
|
429
475
|
## Transaction parameters
|
|
430
476
|
|
|
431
477
|
### Asset specification
|
|
@@ -493,7 +539,7 @@ const options: TransactionOptions = {
|
|
|
493
539
|
amountSubunits: '12344',
|
|
494
540
|
timeout: 86440,
|
|
495
541
|
},
|
|
496
|
-
fallbacks: [ProofTypes.Screenshot, ProofTypes.SelfDeclaration], // js ['screenshot','
|
|
542
|
+
fallbacks: [ProofTypes.Screenshot, ProofTypes.SelfDeclaration], // js ['screenshot','self-declaration']
|
|
497
543
|
deminimis: {
|
|
498
544
|
threshold: 1000,
|
|
499
545
|
currency: 'EUR',
|
|
@@ -729,6 +775,23 @@ const options: TransactionOptions = {
|
|
|
729
775
|
|
|
730
776
|
See [locales](src/locales.ts) for the list of supported locales.
|
|
731
777
|
|
|
778
|
+
## Theming
|
|
779
|
+
|
|
780
|
+
You can optionally theme the UI when creating an instance of `Notabene`
|
|
781
|
+
|
|
782
|
+
```js
|
|
783
|
+
const notabene = new Notabene({
|
|
784
|
+
nodeUrl: 'https://api.notabene.id',
|
|
785
|
+
authToken: 'YOUR_CUSTOMER_TOKEN',
|
|
786
|
+
theme: {
|
|
787
|
+
mode: 'light', // 'light', 'dark'
|
|
788
|
+
primaryColor: '#0a852d',
|
|
789
|
+
secondaryColor: '#f5f7fa',
|
|
790
|
+
fontFamily: 'Montserrat' // Google Fonts Supported
|
|
791
|
+
}
|
|
792
|
+
});
|
|
793
|
+
```
|
|
794
|
+
|
|
732
795
|
## [License](LICENSE.md)
|
|
733
796
|
|
|
734
797
|
MIT © Notabene Inc.
|
package/dist/notabene.d.ts
CHANGED
|
@@ -383,7 +383,7 @@ export declare function decodeFragmentToObject(fragment: string): Record<string,
|
|
|
383
383
|
* An object representing a deposit transaction
|
|
384
384
|
* @public
|
|
385
385
|
*/
|
|
386
|
-
export declare interface Deposit extends OriginatorFields,
|
|
386
|
+
export declare interface Deposit extends OriginatorFields, DepositTransaction {
|
|
387
387
|
}
|
|
388
388
|
|
|
389
389
|
/**
|
|
@@ -413,6 +413,14 @@ declare interface DepositRequestOptions {
|
|
|
413
413
|
showQrCode?: boolean;
|
|
414
414
|
}
|
|
415
415
|
|
|
416
|
+
/**
|
|
417
|
+
* Extended transaction interface for deposits
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
declare interface DepositTransaction extends Transaction {
|
|
421
|
+
transactionId?: string;
|
|
422
|
+
}
|
|
423
|
+
|
|
416
424
|
/**
|
|
417
425
|
* The destination of a transaction either a blockchain address, a CAIP-19 address, or a travel address.
|
|
418
426
|
* @public
|
|
@@ -1539,6 +1547,7 @@ export declare type V1Transaction = {
|
|
|
1539
1547
|
originatorProof?: OwnershipProof;
|
|
1540
1548
|
originator?: Originator;
|
|
1541
1549
|
beneficiary: Beneficiary;
|
|
1550
|
+
transactionId?: string;
|
|
1542
1551
|
};
|
|
1543
1552
|
|
|
1544
1553
|
/**
|
package/docs/README.md
CHANGED
|
@@ -48,6 +48,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
|
|
|
48
48
|
- [Deposit Assist](#deposit-assist)
|
|
49
49
|
- [Parameters](#parameters-3)
|
|
50
50
|
- [Error handling](#error-handling)
|
|
51
|
+
- [Error reference](#error-reference)
|
|
51
52
|
- [Transaction parameters](#transaction-parameters)
|
|
52
53
|
- [Asset specification](#asset-specification)
|
|
53
54
|
- [Transaction amount](#transaction-amount)
|
|
@@ -67,6 +68,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
|
|
|
67
68
|
- [Full Example](#full-example)
|
|
68
69
|
- [Field reference](#field-reference)
|
|
69
70
|
- [Locales](#locales)
|
|
71
|
+
- [Theming](#theming)
|
|
70
72
|
- [License](#license)
|
|
71
73
|
|
|
72
74
|
## Installation
|
|
@@ -202,6 +204,14 @@ To be notified of any validation errors use:
|
|
|
202
204
|
withdrawal.on('error',error => ...)
|
|
203
205
|
```
|
|
204
206
|
|
|
207
|
+
To be notified when the component is Ready:
|
|
208
|
+
|
|
209
|
+
```js
|
|
210
|
+
withdrawal.on('ready', ({ type }) => {
|
|
211
|
+
console.log(type === 'ready');
|
|
212
|
+
});
|
|
213
|
+
```
|
|
214
|
+
|
|
205
215
|
Calling `on` returns a function that will allow you to cleanly unsubscribe.
|
|
206
216
|
|
|
207
217
|
```js
|
|
@@ -404,6 +414,7 @@ const deposit = notabene.createDepositAssist(
|
|
|
404
414
|
amountDecimal: 1.23,
|
|
405
415
|
origin: '0x...',
|
|
406
416
|
destination: '0x...',
|
|
417
|
+
transactionId: "UUID"
|
|
407
418
|
},
|
|
408
419
|
{
|
|
409
420
|
// Optional transaction options
|
|
@@ -417,6 +428,7 @@ const deposit = notabene.createDepositAssist(
|
|
|
417
428
|
- `origin`: The origin or blockchain address for the deposit. See [Origin](#origin)
|
|
418
429
|
- `destination`: The destination or blockchain address for the deposit. See [Destination](#destination)
|
|
419
430
|
- `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
|
|
431
|
+
- `transactionId`: Optional transactionId of a Notabene transaction. Will be returned with the payload to assist updating the Transaction
|
|
420
432
|
|
|
421
433
|
If any of the required parameters are missing the component will just show the Notabene badge.
|
|
422
434
|
|
|
@@ -427,9 +439,43 @@ If any of the required parameters are missing the component will just show the N
|
|
|
427
439
|
If any error occurs, the `error` event is passed containing a message.
|
|
428
440
|
|
|
429
441
|
```ts
|
|
430
|
-
withdrawal.on('error',
|
|
442
|
+
withdrawal.on('error', (error) => ...)
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
An example error object.
|
|
446
|
+
|
|
447
|
+
```ts
|
|
448
|
+
type Error = {
|
|
449
|
+
type: CMType.Error;
|
|
450
|
+
message: string;
|
|
451
|
+
description: string;
|
|
452
|
+
identifier: ErrorIdentifierCode;
|
|
453
|
+
};
|
|
454
|
+
```
|
|
455
|
+
Errors can be handled in this way:
|
|
456
|
+
|
|
457
|
+
```ts
|
|
458
|
+
component.on('error', (error) => {
|
|
459
|
+
if (error.type === CMType.Error) {
|
|
460
|
+
switch (error.identifier) {
|
|
461
|
+
case ErrorIdentifierCode.SERVICE_UNAVAILABLE:
|
|
462
|
+
// handle the error
|
|
463
|
+
break;
|
|
464
|
+
//...
|
|
465
|
+
}
|
|
466
|
+
}
|
|
467
|
+
});
|
|
431
468
|
```
|
|
432
469
|
|
|
470
|
+
#### Error reference
|
|
471
|
+
|
|
472
|
+
| ErrorIdentifierCode | Description/Message | In Use |
|
|
473
|
+
|--------------------------|----------------------------------------------------------------------------------------------------------|---|
|
|
474
|
+
| SERVICE_UNAVAILABLE | The Notabene service is currently unavailable | ✅ |
|
|
475
|
+
| TOKEN_INVALID | Auth Token is Invalid | ✅ |
|
|
476
|
+
| WALLET_CONNECTION_FAILED | The connection to the wallet service failed, possibly due to network issues or unsupported wallet types. | ✅ |
|
|
477
|
+
| WALLET_NOT_SUPPORTED | The wallet used does not support the required functionality or blockchain. | |
|
|
478
|
+
|
|
433
479
|
## Transaction parameters
|
|
434
480
|
|
|
435
481
|
### Asset specification
|
|
@@ -497,7 +543,7 @@ const options: TransactionOptions = {
|
|
|
497
543
|
amountSubunits: '12344',
|
|
498
544
|
timeout: 86440,
|
|
499
545
|
},
|
|
500
|
-
fallbacks: [ProofTypes.Screenshot, ProofTypes.SelfDeclaration], // js ['screenshot','
|
|
546
|
+
fallbacks: [ProofTypes.Screenshot, ProofTypes.SelfDeclaration], // js ['screenshot','self-declaration']
|
|
501
547
|
deminimis: {
|
|
502
548
|
threshold: 1000,
|
|
503
549
|
currency: 'EUR',
|
|
@@ -733,6 +779,23 @@ const options: TransactionOptions = {
|
|
|
733
779
|
|
|
734
780
|
See [locales](_media/locales.ts) for the list of supported locales.
|
|
735
781
|
|
|
782
|
+
## Theming
|
|
783
|
+
|
|
784
|
+
You can optionally theme the UI when creating an instance of `Notabene`
|
|
785
|
+
|
|
786
|
+
```js
|
|
787
|
+
const notabene = new Notabene({
|
|
788
|
+
nodeUrl: 'https://api.notabene.id',
|
|
789
|
+
authToken: 'YOUR_CUSTOMER_TOKEN',
|
|
790
|
+
theme: {
|
|
791
|
+
mode: 'light', // 'light', 'dark'
|
|
792
|
+
primaryColor: '#0a852d',
|
|
793
|
+
secondaryColor: '#f5f7fa',
|
|
794
|
+
fontFamily: 'Montserrat' // Google Fonts Supported
|
|
795
|
+
}
|
|
796
|
+
});
|
|
797
|
+
```
|
|
798
|
+
|
|
736
799
|
## [License](_media/LICENSE.md)
|
|
737
800
|
|
|
738
801
|
MIT © Notabene Inc.
|
|
@@ -16,7 +16,7 @@ Configuration options for Transaction components
|
|
|
16
16
|
|
|
17
17
|
#### Defined in
|
|
18
18
|
|
|
19
|
-
[types.ts:
|
|
19
|
+
[types.ts:781](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L781)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Configuration options for Transaction components
|
|
|
26
26
|
|
|
27
27
|
#### Defined in
|
|
28
28
|
|
|
29
|
-
[types.ts:
|
|
29
|
+
[types.ts:782](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L782)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ Configuration options for Transaction components
|
|
|
36
36
|
|
|
37
37
|
#### Defined in
|
|
38
38
|
|
|
39
|
-
[types.ts:
|
|
39
|
+
[types.ts:783](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L783)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ Configuration options for Transaction components
|
|
|
46
46
|
|
|
47
47
|
#### Defined in
|
|
48
48
|
|
|
49
|
-
[types.ts:
|
|
49
|
+
[types.ts:785](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L785)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -80,7 +80,7 @@ Configuration options for Transaction components
|
|
|
80
80
|
|
|
81
81
|
#### Defined in
|
|
82
82
|
|
|
83
|
-
[types.ts:
|
|
83
|
+
[types.ts:772](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L772)
|
|
84
84
|
|
|
85
85
|
***
|
|
86
86
|
|
|
@@ -90,4 +90,4 @@ Configuration options for Transaction components
|
|
|
90
90
|
|
|
91
91
|
#### Defined in
|
|
92
92
|
|
|
93
|
-
[types.ts:
|
|
93
|
+
[types.ts:784](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/types.ts#L784)
|
|
@@ -18,7 +18,7 @@ Published May 2020
|
|
|
18
18
|
|
|
19
19
|
#### Defined in
|
|
20
20
|
|
|
21
|
-
[ivms/types.ts:365](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
21
|
+
[ivms/types.ts:365](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L365)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -30,4 +30,4 @@ Published August 2023
|
|
|
30
30
|
|
|
31
31
|
#### Defined in
|
|
32
32
|
|
|
33
|
-
[ivms/types.ts:367](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
33
|
+
[ivms/types.ts:367](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L367)
|
|
@@ -19,7 +19,7 @@ The version of IVMS 101 to which the payload complies.
|
|
|
19
19
|
|
|
20
20
|
#### Defined in
|
|
21
21
|
|
|
22
|
-
[ivms/types.ts:358](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
22
|
+
[ivms/types.ts:358](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L358)
|
|
23
23
|
|
|
24
24
|
***
|
|
25
25
|
|
|
@@ -31,4 +31,4 @@ The method used to map from a national system of writing to Latin script.
|
|
|
31
31
|
|
|
32
32
|
#### Defined in
|
|
33
33
|
|
|
34
|
-
[ivms/types.ts:356](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
34
|
+
[ivms/types.ts:356](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L356)
|
|
@@ -111,4 +111,4 @@ Name of a built-up area, with defined boundaries, and a local government.
|
|
|
111
111
|
|
|
112
112
|
## Defined in
|
|
113
113
|
|
|
114
|
-
[ivms/types.ts:119](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
114
|
+
[ivms/types.ts:119](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L119)
|
|
@@ -13,4 +13,4 @@ Specifies the type of address
|
|
|
13
13
|
|
|
14
14
|
## Defined in
|
|
15
15
|
|
|
16
|
-
[ivms/types.ts:44](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
16
|
+
[ivms/types.ts:44](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L44)
|
|
@@ -27,4 +27,4 @@ Array of persons associated with the beneficiary
|
|
|
27
27
|
|
|
28
28
|
## Defined in
|
|
29
29
|
|
|
30
|
-
[ivms/types.ts:313](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
30
|
+
[ivms/types.ts:313](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L313)
|
|
@@ -21,4 +21,4 @@ The beneficiary VASP information
|
|
|
21
21
|
|
|
22
22
|
## Defined in
|
|
23
23
|
|
|
24
|
-
[ivms/types.ts:335](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
24
|
+
[ivms/types.ts:335](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L335)
|
|
@@ -27,4 +27,4 @@ Place of birth (max 70 characters)
|
|
|
27
27
|
|
|
28
28
|
## Defined in
|
|
29
29
|
|
|
30
|
-
[ivms/types.ts:107](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
30
|
+
[ivms/types.ts:107](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L107)
|
|
@@ -19,4 +19,4 @@ ISO-3166 Alpha-2 country code
|
|
|
19
19
|
|
|
20
20
|
## Defined in
|
|
21
21
|
|
|
22
|
-
[ivms/types.ts:6](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
22
|
+
[ivms/types.ts:6](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L6)
|
|
@@ -20,4 +20,4 @@ Format: YYYY-MM-DD
|
|
|
20
20
|
|
|
21
21
|
## Defined in
|
|
22
22
|
|
|
23
|
-
[ivms/types.ts:14](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
23
|
+
[ivms/types.ts:14](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L14)
|
|
@@ -38,4 +38,4 @@ IVMS101 definition
|
|
|
38
38
|
|
|
39
39
|
## Defined in
|
|
40
40
|
|
|
41
|
-
[ivms/types.ts:375](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
41
|
+
[ivms/types.ts:375](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L375)
|
|
@@ -27,4 +27,4 @@ The sequence number of this VASP in the transfer path
|
|
|
27
27
|
|
|
28
28
|
## Defined in
|
|
29
29
|
|
|
30
|
-
[ivms/types.ts:289](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
30
|
+
[ivms/types.ts:289](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L289)
|
|
@@ -45,4 +45,4 @@ A distinct identifier used by governments to uniquely identify a legal person
|
|
|
45
45
|
|
|
46
46
|
## Defined in
|
|
47
47
|
|
|
48
|
-
[ivms/types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
48
|
+
[ivms/types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L259)
|
|
@@ -33,4 +33,4 @@ Array of phonetic name identifiers
|
|
|
33
33
|
|
|
34
34
|
## Defined in
|
|
35
35
|
|
|
36
|
-
[ivms/types.ts:245](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
36
|
+
[ivms/types.ts:245](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L245)
|
|
@@ -27,4 +27,4 @@ The nature of the name specified
|
|
|
27
27
|
|
|
28
28
|
## Defined in
|
|
29
29
|
|
|
30
|
-
[ivms/types.ts:233](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
30
|
+
[ivms/types.ts:233](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L233)
|
|
@@ -13,4 +13,4 @@ Specifies the type of name for a legal person
|
|
|
13
13
|
|
|
14
14
|
## Defined in
|
|
15
15
|
|
|
16
|
-
[ivms/types.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
16
|
+
[ivms/types.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L34)
|
|
@@ -27,4 +27,4 @@ Type of legal person name identifier
|
|
|
27
27
|
|
|
28
28
|
## Defined in
|
|
29
29
|
|
|
30
|
-
[ivms/types.ts:221](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
30
|
+
[ivms/types.ts:221](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L221)
|
|
@@ -33,4 +33,4 @@ Secondary identifier, maximum 100 characters in local format
|
|
|
33
33
|
|
|
34
34
|
## Defined in
|
|
35
35
|
|
|
36
|
-
[ivms/types.ts:159](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
36
|
+
[ivms/types.ts:159](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L159)
|
|
@@ -39,4 +39,4 @@ Registration authority (format: RA followed by 6 digits)
|
|
|
39
39
|
|
|
40
40
|
## Defined in
|
|
41
41
|
|
|
42
|
-
[ivms/types.ts:91](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
42
|
+
[ivms/types.ts:91](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L91)
|
|
@@ -13,4 +13,4 @@ Specifies the type of national identifier
|
|
|
13
13
|
|
|
14
14
|
## Defined in
|
|
15
15
|
|
|
16
|
-
[ivms/types.ts:54](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
16
|
+
[ivms/types.ts:54](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L54)
|
|
@@ -51,4 +51,4 @@ A distinct identifier used by governments to uniquely identify a natural person
|
|
|
51
51
|
|
|
52
52
|
## Defined in
|
|
53
53
|
|
|
54
|
-
[ivms/types.ts:201](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
54
|
+
[ivms/types.ts:201](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L201)
|
|
@@ -33,4 +33,4 @@ Array of phonetic name identifiers
|
|
|
33
33
|
|
|
34
34
|
## Defined in
|
|
35
35
|
|
|
36
|
-
[ivms/types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
36
|
+
[ivms/types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L187)
|
|
@@ -33,4 +33,4 @@ Secondary identifier, maximum 100 characters
|
|
|
33
33
|
|
|
34
34
|
## Defined in
|
|
35
35
|
|
|
36
|
-
[ivms/types.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
36
|
+
[ivms/types.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L173)
|
|
@@ -13,4 +13,4 @@ Specifies the type of name for a natural person
|
|
|
13
13
|
|
|
14
14
|
## Defined in
|
|
15
15
|
|
|
16
|
-
[ivms/types.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
16
|
+
[ivms/types.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L22)
|
|
@@ -21,4 +21,4 @@ The originating VASP information
|
|
|
21
21
|
|
|
22
22
|
## Defined in
|
|
23
23
|
|
|
24
|
-
[ivms/types.ts:325](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
24
|
+
[ivms/types.ts:325](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L325)
|
|
@@ -27,4 +27,4 @@ Array of persons associated with the originator
|
|
|
27
27
|
|
|
28
28
|
## Defined in
|
|
29
29
|
|
|
30
|
-
[ivms/types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
30
|
+
[ivms/types.ts:301](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L301)
|
|
@@ -27,4 +27,4 @@ Natural person information
|
|
|
27
27
|
|
|
28
28
|
## Defined in
|
|
29
29
|
|
|
30
|
-
[ivms/types.ts:277](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
30
|
+
[ivms/types.ts:277](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L277)
|
|
@@ -21,4 +21,4 @@ Array of intermediary VASPs involved in the transfer
|
|
|
21
21
|
|
|
22
22
|
## Defined in
|
|
23
23
|
|
|
24
|
-
[ivms/types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
24
|
+
[ivms/types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L345)
|
|
@@ -13,4 +13,4 @@ Specifies the method used to transliterate text
|
|
|
13
13
|
|
|
14
14
|
## Defined in
|
|
15
15
|
|
|
16
|
-
[ivms/types.ts:71](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/
|
|
16
|
+
[ivms/types.ts:71](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/7acdcab785ebd62ecd50976a47d5189aaae926be/src/ivms/types.ts#L71)
|
package/docs/notabene/README.md
CHANGED
|
@@ -159,6 +159,12 @@ Re-exports [Error](../types/type-aliases/Error.md)
|
|
|
159
159
|
|
|
160
160
|
***
|
|
161
161
|
|
|
162
|
+
### ErrorIdentifierCode
|
|
163
|
+
|
|
164
|
+
Re-exports [ErrorIdentifierCode](../types/enumerations/ErrorIdentifierCode.md)
|
|
165
|
+
|
|
166
|
+
***
|
|
167
|
+
|
|
162
168
|
### FieldTypes
|
|
163
169
|
|
|
164
170
|
Re-exports [FieldTypes](../types/type-aliases/FieldTypes.md)
|