@notabene/javascript-sdk 2.9.0-next.3 → 2.9.0-next.5
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 +13 -14
- package/dist/cjs/notabene.d.ts +14 -1
- package/dist/cjs/package.json +1 -1
- package/dist/esm/notabene.d.ts +14 -1
- package/dist/esm/package.json +1 -1
- package/dist/notabene.d.ts +14 -1
- package/docs/README.md +12 -3
- package/docs/_media/TransactionOptions.md +16 -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 +15 -0
- package/docs/notabene/classes/ConnectionManager.md +14 -6
- package/docs/notabene/classes/EmbeddedComponent.md +17 -17
- package/docs/notabene/classes/default.md +7 -7
- package/docs/notabene/functions/decodeFragmentToObject.md +1 -1
- package/docs/notabene/functions/getRefreshResult.md +27 -0
- package/docs/notabene/interfaces/ConnectionData.md +13 -3
- package/docs/notabene/interfaces/ConnectionMetadata.md +3 -3
- package/docs/notabene/interfaces/ConnectionResponse.md +15 -5
- package/docs/notabene/interfaces/ConnectionResult.md +61 -0
- package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
- package/docs/notabene/type-aliases/ConnectionStatus.md +13 -0
- package/docs/notabene/type-aliases/MessageCallback.md +1 -1
- package/docs/notabene/type-aliases/TransactionType.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 +17 -17
- 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 +11 -11
- package/docs/types/interfaces/DepositRequest.md +7 -7
- package/docs/types/interfaces/DepositRequestOptions.md +1 -1
- package/docs/types/interfaces/DepositTransaction.md +9 -9
- 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/RefreshSource.md +2 -2
- package/docs/types/interfaces/Refreshable.md +1 -1
- package/docs/types/interfaces/ScreenshotProof.md +5 -5
- package/docs/types/interfaces/SignatureProof.md +9 -9
- package/docs/types/interfaces/ThresholdOptions.md +3 -3
- package/docs/types/interfaces/Transaction.md +8 -8
- package/docs/types/interfaces/TransactionOptions.md +16 -6
- package/docs/types/interfaces/TransactionResponse.md +9 -9
- package/docs/types/interfaces/VASP.md +9 -9
- package/docs/types/interfaces/Wallet.md +8 -8
- package/docs/types/interfaces/Withdrawal.md +10 -10
- 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/CounterpartyAssistConfig.md +19 -0
- 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/NationalIdentifierTypeFieldOptions.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 +1 -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/notabene.ts +2 -0
- package/src/types.ts +16 -1
package/README.md
CHANGED
|
@@ -380,7 +380,7 @@ const connect = notabene.createConnectWallet(
|
|
|
380
380
|
The Deposit Request lets your customers request deposits that are fully Travel Rule compliant.
|
|
381
381
|
|
|
382
382
|
```js
|
|
383
|
-
const
|
|
383
|
+
const depositRequest = notabene.createDepositRequest({
|
|
384
384
|
asset: 'ETH',
|
|
385
385
|
destination: '0x...',
|
|
386
386
|
amountDecimal: 1.23,
|
|
@@ -408,7 +408,7 @@ const deposit = notabene.createDepositAssist(
|
|
|
408
408
|
{
|
|
409
409
|
asset: 'ETH',
|
|
410
410
|
amountDecimal: 1.23,
|
|
411
|
-
|
|
411
|
+
source: '0x...',
|
|
412
412
|
destination: '0x...',
|
|
413
413
|
transactionId: "UUID"
|
|
414
414
|
},
|
|
@@ -421,7 +421,7 @@ const deposit = notabene.createDepositAssist(
|
|
|
421
421
|
### Parameters
|
|
422
422
|
|
|
423
423
|
- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
|
|
424
|
-
- `
|
|
424
|
+
- `source`: The source or blockchain address for the deposit. See [Origin](#origin)
|
|
425
425
|
- `destination`: The destination or blockchain address for the deposit. See [Destination](#destination)
|
|
426
426
|
- `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
|
|
427
427
|
- `transactionId`: Optional transactionId of a Notabene transaction. Will be returned with the payload to assist updating the Transaction
|
|
@@ -480,7 +480,6 @@ The `asset` field the following types of assets specified:
|
|
|
480
480
|
|
|
481
481
|
- `notabene_asset` code passed as a`string`. See [Notabene Assets Service](https://devx.notabene.id/docs/coins-decimals#assets-service-api).
|
|
482
482
|
- [CAIP-19](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md_) is a chain agnostic format allows you to support the widest amount of assets and blockchains including NFTs.
|
|
483
|
-
- [DTI](https://www.iso.org/standard/80601.html) is the ISO Digital Token Identifier format. See [DTI registry](https://dtif.org/registry-search/) for supported tokens.
|
|
484
483
|
|
|
485
484
|
### Transaction amount
|
|
486
485
|
|
|
@@ -497,9 +496,9 @@ Specify the beneficiary address as `destination` using one of the following form
|
|
|
497
496
|
- [BIP-21](https://en.bitcoin.it/wiki/BIP_0021) Bitcoin URI
|
|
498
497
|
- Native blockchain address
|
|
499
498
|
|
|
500
|
-
###
|
|
499
|
+
### Source
|
|
501
500
|
|
|
502
|
-
Specify the originator address as `
|
|
501
|
+
Specify the originator address as `source` using one of the following formats:
|
|
503
502
|
|
|
504
503
|
- [CAIP-10](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-10.md_) is a chain agnostic format allows you to specify the specific blockchain and address
|
|
505
504
|
- [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770) EVM URI
|
|
@@ -575,16 +574,16 @@ const options: TransactionOptions = {
|
|
|
575
574
|
nationalIdentification: false,
|
|
576
575
|
countryOfRegistration: true,
|
|
577
576
|
},
|
|
578
|
-
vasps: {
|
|
579
|
-
addUnknown: true, // Allow users to add a missing VASP - Defaults to false
|
|
580
|
-
onlyActive: true, // Only list active VASPs - Default false
|
|
581
|
-
searchable: [
|
|
582
|
-
VASPSearchControl.ALLOWED, // JS: 'allowed'
|
|
583
|
-
VASPSearchControl.PENDING, // JS: 'pending'
|
|
584
|
-
], // Control searches for VASPs - Defaults to undefined
|
|
585
|
-
},
|
|
586
577
|
hide: [ValidationSections.ASSET, ValidationSections.DESTINATION], // Don't show specific sections of component
|
|
587
578
|
},
|
|
579
|
+
vasps: {
|
|
580
|
+
addUnknown: true, // Allow users to add a missing VASP - Defaults to false
|
|
581
|
+
onlyActive: true, // Only list active VASPs - Default false
|
|
582
|
+
searchable: [
|
|
583
|
+
VASPSearchControl.ALLOWED, // JS: 'allowed'
|
|
584
|
+
VASPSearchControl.PENDING, // JS: 'pending'
|
|
585
|
+
], // Control searches for VASPs - Defaults to undefined
|
|
586
|
+
},
|
|
588
587
|
};
|
|
589
588
|
const withdrawal = notabene.createWithdrawalAssist(tx, options);
|
|
590
589
|
```
|
package/dist/cjs/notabene.d.ts
CHANGED
|
@@ -422,6 +422,18 @@ export declare interface Counterparty {
|
|
|
422
422
|
email?: string;
|
|
423
423
|
}
|
|
424
424
|
|
|
425
|
+
/**
|
|
426
|
+
* Counterparty Assist Configuration options for recipient selection
|
|
427
|
+
*
|
|
428
|
+
* @remarks
|
|
429
|
+
* Controls for each person type, whether to show the share feature or not.
|
|
430
|
+
*
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
export declare type CounterpartyAssistConfig = boolean | {
|
|
434
|
+
counterpartyTypes: PersonType[];
|
|
435
|
+
};
|
|
436
|
+
|
|
425
437
|
/**
|
|
426
438
|
* A crypto credential
|
|
427
439
|
* @public
|
|
@@ -479,7 +491,7 @@ export declare interface DepositRequest extends DepositRequestFields, ComponentR
|
|
|
479
491
|
declare type DepositRequestFields = {
|
|
480
492
|
destination: BlockchainAddress | CAIP10;
|
|
481
493
|
asset: TransactionAsset;
|
|
482
|
-
amountDecimal
|
|
494
|
+
amountDecimal: number;
|
|
483
495
|
travelAddress?: TravelAddress;
|
|
484
496
|
cryptoCredential?: CryptoCredential;
|
|
485
497
|
};
|
|
@@ -1540,6 +1552,7 @@ export declare interface TransactionOptions {
|
|
|
1540
1552
|
fields?: FieldTypes;
|
|
1541
1553
|
vasps?: VASPOptions;
|
|
1542
1554
|
hide?: ValidationSections[];
|
|
1555
|
+
counterpartyAssist?: CounterpartyAssistConfig;
|
|
1543
1556
|
}
|
|
1544
1557
|
|
|
1545
1558
|
/**
|
package/dist/cjs/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.9.0-next.
|
|
13
|
+
"version": "2.9.0-next.5",
|
|
14
14
|
"source": "src/notabene.ts",
|
|
15
15
|
"main": "dist/cjs/notabene.cjs",
|
|
16
16
|
"module": "dist/esm/notabene.js",
|
package/dist/esm/notabene.d.ts
CHANGED
|
@@ -422,6 +422,18 @@ export declare interface Counterparty {
|
|
|
422
422
|
email?: string;
|
|
423
423
|
}
|
|
424
424
|
|
|
425
|
+
/**
|
|
426
|
+
* Counterparty Assist Configuration options for recipient selection
|
|
427
|
+
*
|
|
428
|
+
* @remarks
|
|
429
|
+
* Controls for each person type, whether to show the share feature or not.
|
|
430
|
+
*
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
export declare type CounterpartyAssistConfig = boolean | {
|
|
434
|
+
counterpartyTypes: PersonType[];
|
|
435
|
+
};
|
|
436
|
+
|
|
425
437
|
/**
|
|
426
438
|
* A crypto credential
|
|
427
439
|
* @public
|
|
@@ -479,7 +491,7 @@ export declare interface DepositRequest extends DepositRequestFields, ComponentR
|
|
|
479
491
|
declare type DepositRequestFields = {
|
|
480
492
|
destination: BlockchainAddress | CAIP10;
|
|
481
493
|
asset: TransactionAsset;
|
|
482
|
-
amountDecimal
|
|
494
|
+
amountDecimal: number;
|
|
483
495
|
travelAddress?: TravelAddress;
|
|
484
496
|
cryptoCredential?: CryptoCredential;
|
|
485
497
|
};
|
|
@@ -1540,6 +1552,7 @@ export declare interface TransactionOptions {
|
|
|
1540
1552
|
fields?: FieldTypes;
|
|
1541
1553
|
vasps?: VASPOptions;
|
|
1542
1554
|
hide?: ValidationSections[];
|
|
1555
|
+
counterpartyAssist?: CounterpartyAssistConfig;
|
|
1543
1556
|
}
|
|
1544
1557
|
|
|
1545
1558
|
/**
|
package/dist/esm/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.9.0-next.
|
|
13
|
+
"version": "2.9.0-next.5",
|
|
14
14
|
"source": "src/notabene.ts",
|
|
15
15
|
"main": "dist/cjs/notabene.cjs",
|
|
16
16
|
"module": "dist/esm/notabene.js",
|
package/dist/notabene.d.ts
CHANGED
|
@@ -422,6 +422,18 @@ export declare interface Counterparty {
|
|
|
422
422
|
email?: string;
|
|
423
423
|
}
|
|
424
424
|
|
|
425
|
+
/**
|
|
426
|
+
* Counterparty Assist Configuration options for recipient selection
|
|
427
|
+
*
|
|
428
|
+
* @remarks
|
|
429
|
+
* Controls for each person type, whether to show the share feature or not.
|
|
430
|
+
*
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
export declare type CounterpartyAssistConfig = boolean | {
|
|
434
|
+
counterpartyTypes: PersonType[];
|
|
435
|
+
};
|
|
436
|
+
|
|
425
437
|
/**
|
|
426
438
|
* A crypto credential
|
|
427
439
|
* @public
|
|
@@ -479,7 +491,7 @@ export declare interface DepositRequest extends DepositRequestFields, ComponentR
|
|
|
479
491
|
declare type DepositRequestFields = {
|
|
480
492
|
destination: BlockchainAddress | CAIP10;
|
|
481
493
|
asset: TransactionAsset;
|
|
482
|
-
amountDecimal
|
|
494
|
+
amountDecimal: number;
|
|
483
495
|
travelAddress?: TravelAddress;
|
|
484
496
|
cryptoCredential?: CryptoCredential;
|
|
485
497
|
};
|
|
@@ -1540,6 +1552,7 @@ export declare interface TransactionOptions {
|
|
|
1540
1552
|
fields?: FieldTypes;
|
|
1541
1553
|
vasps?: VASPOptions;
|
|
1542
1554
|
hide?: ValidationSections[];
|
|
1555
|
+
counterpartyAssist?: CounterpartyAssistConfig;
|
|
1543
1556
|
}
|
|
1544
1557
|
|
|
1545
1558
|
/**
|
package/docs/README.md
CHANGED
|
@@ -398,7 +398,7 @@ const withdrawal = notabene.createDepositRequest({
|
|
|
398
398
|
|
|
399
399
|
- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
|
|
400
400
|
- `destination`: The destination or blockchain address for the withdrawal. See [Destination](#destination)
|
|
401
|
-
- `amountDecimal`:
|
|
401
|
+
- `amountDecimal`: The amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
|
|
402
402
|
- `customer`: Optional Customer object containing their name
|
|
403
403
|
|
|
404
404
|
If any of the required parameters are missing the component will just show the Notabene badge.
|
|
@@ -412,7 +412,7 @@ const deposit = notabene.createDepositAssist(
|
|
|
412
412
|
{
|
|
413
413
|
asset: 'ETH',
|
|
414
414
|
amountDecimal: 1.23,
|
|
415
|
-
|
|
415
|
+
source: '0x...',
|
|
416
416
|
destination: '0x...',
|
|
417
417
|
transactionId: "UUID"
|
|
418
418
|
},
|
|
@@ -425,7 +425,7 @@ const deposit = notabene.createDepositAssist(
|
|
|
425
425
|
### Parameters
|
|
426
426
|
|
|
427
427
|
- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
|
|
428
|
-
- `
|
|
428
|
+
- `source`: The source or blockchain address for the deposit. See [Source](#source)
|
|
429
429
|
- `destination`: The destination or blockchain address for the deposit. See [Destination](#destination)
|
|
430
430
|
- `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
|
|
431
431
|
- `transactionId`: Optional transactionId of a Notabene transaction. Will be returned with the payload to assist updating the Transaction
|
|
@@ -510,6 +510,15 @@ Specify the originator address as `origin` using one of the following formats:
|
|
|
510
510
|
- [BIP-21](https://en.bitcoin.it/wiki/BIP_0021) Bitcoin URI
|
|
511
511
|
- Native blockchain address
|
|
512
512
|
|
|
513
|
+
### Source
|
|
514
|
+
|
|
515
|
+
Specify the source address as `source` using one of the following formats:
|
|
516
|
+
|
|
517
|
+
- [CAIP-10](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-10.md_) is a chain agnostic format allows you to specify the specific blockchain and address
|
|
518
|
+
- [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770) EVM URI
|
|
519
|
+
- [BIP-21](https://en.bitcoin.it/wiki/BIP_0021) Bitcoin URI
|
|
520
|
+
- Native blockchain address
|
|
521
|
+
|
|
513
522
|
### Asset Price
|
|
514
523
|
|
|
515
524
|
The price of the asset is used to determine certain rules based on thresholds. We recommond you pass in your price like this:
|
|
@@ -16,7 +16,7 @@ Configuration options for Transaction components
|
|
|
16
16
|
|
|
17
17
|
#### Defined in
|
|
18
18
|
|
|
19
|
-
[types.ts:
|
|
19
|
+
[types.ts:844](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L844)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
@@ -26,7 +26,17 @@ Configuration options for Transaction components
|
|
|
26
26
|
|
|
27
27
|
#### Defined in
|
|
28
28
|
|
|
29
|
-
[types.ts:
|
|
29
|
+
[types.ts:845](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L845)
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### counterpartyAssistConfig?
|
|
34
|
+
|
|
35
|
+
> `optional` **counterpartyAssistConfig**: [`CounterpartyAssistConfig`](../type-aliases/CounterpartyAssistConfig.md)
|
|
36
|
+
|
|
37
|
+
#### Defined in
|
|
38
|
+
|
|
39
|
+
[types.ts:849](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L849)
|
|
30
40
|
|
|
31
41
|
***
|
|
32
42
|
|
|
@@ -36,7 +46,7 @@ Configuration options for Transaction components
|
|
|
36
46
|
|
|
37
47
|
#### Defined in
|
|
38
48
|
|
|
39
|
-
[types.ts:
|
|
49
|
+
[types.ts:846](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L846)
|
|
40
50
|
|
|
41
51
|
***
|
|
42
52
|
|
|
@@ -46,7 +56,7 @@ Configuration options for Transaction components
|
|
|
46
56
|
|
|
47
57
|
#### Defined in
|
|
48
58
|
|
|
49
|
-
[types.ts:
|
|
59
|
+
[types.ts:848](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L848)
|
|
50
60
|
|
|
51
61
|
***
|
|
52
62
|
|
|
@@ -84,7 +94,7 @@ Configuration options for Transaction components
|
|
|
84
94
|
|
|
85
95
|
#### Defined in
|
|
86
96
|
|
|
87
|
-
[types.ts:
|
|
97
|
+
[types.ts:834](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L834)
|
|
88
98
|
|
|
89
99
|
***
|
|
90
100
|
|
|
@@ -94,4 +104,4 @@ Configuration options for Transaction components
|
|
|
94
104
|
|
|
95
105
|
#### Defined in
|
|
96
106
|
|
|
97
|
-
[types.ts:
|
|
107
|
+
[types.ts:847](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L847)
|
|
@@ -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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/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/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L71)
|
package/docs/notabene/README.md
CHANGED
|
@@ -19,16 +19,19 @@
|
|
|
19
19
|
- [ConnectionData](interfaces/ConnectionData.md)
|
|
20
20
|
- [ConnectionMetadata](interfaces/ConnectionMetadata.md)
|
|
21
21
|
- [ConnectionResponse](interfaces/ConnectionResponse.md)
|
|
22
|
+
- [ConnectionResult](interfaces/ConnectionResult.md)
|
|
22
23
|
- [NotabeneConfig](interfaces/NotabeneConfig.md)
|
|
23
24
|
|
|
24
25
|
### Type Aliases
|
|
25
26
|
|
|
27
|
+
- [ConnectionStatus](type-aliases/ConnectionStatus.md)
|
|
26
28
|
- [MessageCallback](type-aliases/MessageCallback.md)
|
|
27
29
|
- [TransactionType](type-aliases/TransactionType.md)
|
|
28
30
|
|
|
29
31
|
### Functions
|
|
30
32
|
|
|
31
33
|
- [decodeFragmentToObject](functions/decodeFragmentToObject.md)
|
|
34
|
+
- [getRefreshResult](functions/getRefreshResult.md)
|
|
32
35
|
|
|
33
36
|
## References
|
|
34
37
|
|
|
@@ -122,6 +125,12 @@ Re-exports [Counterparty](../types/interfaces/Counterparty.md)
|
|
|
122
125
|
|
|
123
126
|
***
|
|
124
127
|
|
|
128
|
+
### CounterpartyAssistConfig
|
|
129
|
+
|
|
130
|
+
Re-exports [CounterpartyAssistConfig](../types/type-aliases/CounterpartyAssistConfig.md)
|
|
131
|
+
|
|
132
|
+
***
|
|
133
|
+
|
|
125
134
|
### CryptoCredential
|
|
126
135
|
|
|
127
136
|
Re-exports [CryptoCredential](../types/type-aliases/CryptoCredential.md)
|
|
@@ -308,6 +317,12 @@ Re-exports [Ready](../types/type-aliases/Ready.md)
|
|
|
308
317
|
|
|
309
318
|
***
|
|
310
319
|
|
|
320
|
+
### RefreshSource
|
|
321
|
+
|
|
322
|
+
Re-exports [RefreshSource](../types/interfaces/RefreshSource.md)
|
|
323
|
+
|
|
324
|
+
***
|
|
325
|
+
|
|
311
326
|
### ResizeRequest
|
|
312
327
|
|
|
313
328
|
Re-exports [ResizeRequest](../types/type-aliases/ResizeRequest.md)
|