@notabene/javascript-sdk 2.8.0-next.5 → 2.8.0-next.6
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 +30 -0
- package/dist/cjs/notabene.d.ts +37 -10
- package/dist/cjs/package.json +1 -1
- package/dist/esm/notabene.d.ts +37 -10
- package/dist/esm/package.json +1 -1
- package/dist/notabene.d.ts +37 -10
- package/docs/README.md +30 -0
- 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 +5 -0
- package/docs/notabene/classes/ConnectionManager.md +165 -0
- 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/interfaces/ConnectionData.md +41 -0
- package/docs/notabene/interfaces/ConnectionMetadata.md +37 -0
- package/docs/notabene/interfaces/ConnectionResponse.md +61 -0
- package/docs/notabene/interfaces/NotabeneConfig.md +5 -5
- package/docs/notabene/type-aliases/MessageCallback.md +1 -1
- package/docs/notabene/type-aliases/TransactionType.md +13 -0
- 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 +16 -16
- 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 +6 -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/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 +3 -3
- package/docs/types/type-aliases/NationalIdentifierTypeFieldOptions.md +21 -0
- package/docs/types/type-aliases/NaturalPersonFieldName.md +1 -1
- package/docs/types/type-aliases/NaturalPersonFields.md +3 -3
- 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/types.ts +35 -7
package/README.md
CHANGED
|
@@ -638,6 +638,36 @@ const options: TransactionOptions = {
|
|
|
638
638
|
};
|
|
639
639
|
```
|
|
640
640
|
|
|
641
|
+
### Configuring National Identifier Type
|
|
642
|
+
|
|
643
|
+
The National Identifier Type is a dropdown that allows the developer configure the types of national identifiers they are supporting.
|
|
644
|
+
|
|
645
|
+
```ts
|
|
646
|
+
const options: TransactionOptions = {
|
|
647
|
+
fields: {
|
|
648
|
+
naturalPerson: {
|
|
649
|
+
name: {optional: false},
|
|
650
|
+
nationalIdentification: {
|
|
651
|
+
optional: true, // allow optional national identification
|
|
652
|
+
nationalIdentifierType: {
|
|
653
|
+
values: ['ARNU', 'CCPT', 'RAID', 'DRLC', 'TXID', 'SOCS'], // default values
|
|
654
|
+
},
|
|
655
|
+
},
|
|
656
|
+
},
|
|
657
|
+
legalPerson: {
|
|
658
|
+
name: true,
|
|
659
|
+
lei: {optional: true},
|
|
660
|
+
nationalIdentification: {
|
|
661
|
+
optional: false, // require national identification
|
|
662
|
+
nationalIdentifierType: {
|
|
663
|
+
values: ['RAID', 'TXID', 'MISC'], // default values
|
|
664
|
+
},
|
|
665
|
+
},
|
|
666
|
+
},
|
|
667
|
+
},
|
|
668
|
+
};
|
|
669
|
+
```
|
|
670
|
+
|
|
641
671
|
### Configuring ownership proofs
|
|
642
672
|
|
|
643
673
|
By default components support message signing proofs.
|
package/dist/cjs/notabene.d.ts
CHANGED
|
@@ -783,12 +783,21 @@ declare type LegalPerson_2 = {
|
|
|
783
783
|
export declare type LegalPersonFieldName = 'name' | 'lei' | 'website' | 'email' | 'phone' | 'geographicAddress' | 'nationalIdentification' | 'countryOfRegistration';
|
|
784
784
|
|
|
785
785
|
/**
|
|
786
|
-
* Field properties
|
|
787
|
-
* @public
|
|
788
|
-
*/
|
|
789
|
-
export declare type LegalPersonFields = {
|
|
790
|
-
|
|
791
|
-
|
|
786
|
+
* Field properties for legal person fields
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
export declare type LegalPersonFields = Partial<{
|
|
790
|
+
name: FieldOptions;
|
|
791
|
+
lei: FieldOptions;
|
|
792
|
+
website: FieldOptions;
|
|
793
|
+
email: FieldOptions;
|
|
794
|
+
phone: FieldOptions;
|
|
795
|
+
geographicAddress: FieldOptions;
|
|
796
|
+
nationalIdentification: FieldOptions & {
|
|
797
|
+
nationalIdentifierType: NationalIdentifierTypeFieldOptions;
|
|
798
|
+
};
|
|
799
|
+
countryOfRegistration: FieldOptions;
|
|
800
|
+
}>;
|
|
792
801
|
|
|
793
802
|
/**
|
|
794
803
|
* Legal Person Name
|
|
@@ -900,6 +909,14 @@ export declare type NationalIdentification = {
|
|
|
900
909
|
*/
|
|
901
910
|
declare type NationalIdentifierTypeCode = 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC';
|
|
902
911
|
|
|
912
|
+
/**
|
|
913
|
+
* Field properties for national identifier type selection
|
|
914
|
+
* @public
|
|
915
|
+
*/
|
|
916
|
+
declare type NationalIdentifierTypeFieldOptions = {
|
|
917
|
+
values?: NationalIdentifierTypeCode[];
|
|
918
|
+
};
|
|
919
|
+
|
|
903
920
|
/**
|
|
904
921
|
* Interface representing a natural person (individual) involved in a transaction
|
|
905
922
|
*
|
|
@@ -954,12 +971,22 @@ declare type NaturalPerson_2 = {
|
|
|
954
971
|
export declare type NaturalPersonFieldName = 'name' | 'website' | 'email' | 'phone' | 'geographicAddress' | 'nationalIdentification' | 'dateOfBirth' | 'placeOfBirth' | 'countryOfResidence';
|
|
955
972
|
|
|
956
973
|
/**
|
|
957
|
-
* Field properties
|
|
974
|
+
* Field properties for natural person fields
|
|
958
975
|
* @public
|
|
959
976
|
*/
|
|
960
|
-
export declare type NaturalPersonFields = {
|
|
961
|
-
|
|
962
|
-
|
|
977
|
+
export declare type NaturalPersonFields = Partial<{
|
|
978
|
+
name: FieldOptions;
|
|
979
|
+
website: FieldOptions;
|
|
980
|
+
email: FieldOptions;
|
|
981
|
+
phone: FieldOptions;
|
|
982
|
+
geographicAddress: FieldOptions;
|
|
983
|
+
nationalIdentification: FieldOptions & {
|
|
984
|
+
nationalIdentifierType: NationalIdentifierTypeFieldOptions;
|
|
985
|
+
};
|
|
986
|
+
dateOfBirth: FieldOptions;
|
|
987
|
+
placeOfBirth: FieldOptions;
|
|
988
|
+
countryOfResidence: FieldOptions;
|
|
989
|
+
}>;
|
|
963
990
|
|
|
964
991
|
/**
|
|
965
992
|
* Natural Person Name
|
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.8.0-next.
|
|
13
|
+
"version": "2.8.0-next.6",
|
|
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
|
@@ -783,12 +783,21 @@ declare type LegalPerson_2 = {
|
|
|
783
783
|
export declare type LegalPersonFieldName = 'name' | 'lei' | 'website' | 'email' | 'phone' | 'geographicAddress' | 'nationalIdentification' | 'countryOfRegistration';
|
|
784
784
|
|
|
785
785
|
/**
|
|
786
|
-
* Field properties
|
|
787
|
-
* @public
|
|
788
|
-
*/
|
|
789
|
-
export declare type LegalPersonFields = {
|
|
790
|
-
|
|
791
|
-
|
|
786
|
+
* Field properties for legal person fields
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
export declare type LegalPersonFields = Partial<{
|
|
790
|
+
name: FieldOptions;
|
|
791
|
+
lei: FieldOptions;
|
|
792
|
+
website: FieldOptions;
|
|
793
|
+
email: FieldOptions;
|
|
794
|
+
phone: FieldOptions;
|
|
795
|
+
geographicAddress: FieldOptions;
|
|
796
|
+
nationalIdentification: FieldOptions & {
|
|
797
|
+
nationalIdentifierType: NationalIdentifierTypeFieldOptions;
|
|
798
|
+
};
|
|
799
|
+
countryOfRegistration: FieldOptions;
|
|
800
|
+
}>;
|
|
792
801
|
|
|
793
802
|
/**
|
|
794
803
|
* Legal Person Name
|
|
@@ -900,6 +909,14 @@ export declare type NationalIdentification = {
|
|
|
900
909
|
*/
|
|
901
910
|
declare type NationalIdentifierTypeCode = 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC';
|
|
902
911
|
|
|
912
|
+
/**
|
|
913
|
+
* Field properties for national identifier type selection
|
|
914
|
+
* @public
|
|
915
|
+
*/
|
|
916
|
+
declare type NationalIdentifierTypeFieldOptions = {
|
|
917
|
+
values?: NationalIdentifierTypeCode[];
|
|
918
|
+
};
|
|
919
|
+
|
|
903
920
|
/**
|
|
904
921
|
* Interface representing a natural person (individual) involved in a transaction
|
|
905
922
|
*
|
|
@@ -954,12 +971,22 @@ declare type NaturalPerson_2 = {
|
|
|
954
971
|
export declare type NaturalPersonFieldName = 'name' | 'website' | 'email' | 'phone' | 'geographicAddress' | 'nationalIdentification' | 'dateOfBirth' | 'placeOfBirth' | 'countryOfResidence';
|
|
955
972
|
|
|
956
973
|
/**
|
|
957
|
-
* Field properties
|
|
974
|
+
* Field properties for natural person fields
|
|
958
975
|
* @public
|
|
959
976
|
*/
|
|
960
|
-
export declare type NaturalPersonFields = {
|
|
961
|
-
|
|
962
|
-
|
|
977
|
+
export declare type NaturalPersonFields = Partial<{
|
|
978
|
+
name: FieldOptions;
|
|
979
|
+
website: FieldOptions;
|
|
980
|
+
email: FieldOptions;
|
|
981
|
+
phone: FieldOptions;
|
|
982
|
+
geographicAddress: FieldOptions;
|
|
983
|
+
nationalIdentification: FieldOptions & {
|
|
984
|
+
nationalIdentifierType: NationalIdentifierTypeFieldOptions;
|
|
985
|
+
};
|
|
986
|
+
dateOfBirth: FieldOptions;
|
|
987
|
+
placeOfBirth: FieldOptions;
|
|
988
|
+
countryOfResidence: FieldOptions;
|
|
989
|
+
}>;
|
|
963
990
|
|
|
964
991
|
/**
|
|
965
992
|
* Natural Person Name
|
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.8.0-next.
|
|
13
|
+
"version": "2.8.0-next.6",
|
|
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
|
@@ -783,12 +783,21 @@ declare type LegalPerson_2 = {
|
|
|
783
783
|
export declare type LegalPersonFieldName = 'name' | 'lei' | 'website' | 'email' | 'phone' | 'geographicAddress' | 'nationalIdentification' | 'countryOfRegistration';
|
|
784
784
|
|
|
785
785
|
/**
|
|
786
|
-
* Field properties
|
|
787
|
-
* @public
|
|
788
|
-
*/
|
|
789
|
-
export declare type LegalPersonFields = {
|
|
790
|
-
|
|
791
|
-
|
|
786
|
+
* Field properties for legal person fields
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
export declare type LegalPersonFields = Partial<{
|
|
790
|
+
name: FieldOptions;
|
|
791
|
+
lei: FieldOptions;
|
|
792
|
+
website: FieldOptions;
|
|
793
|
+
email: FieldOptions;
|
|
794
|
+
phone: FieldOptions;
|
|
795
|
+
geographicAddress: FieldOptions;
|
|
796
|
+
nationalIdentification: FieldOptions & {
|
|
797
|
+
nationalIdentifierType: NationalIdentifierTypeFieldOptions;
|
|
798
|
+
};
|
|
799
|
+
countryOfRegistration: FieldOptions;
|
|
800
|
+
}>;
|
|
792
801
|
|
|
793
802
|
/**
|
|
794
803
|
* Legal Person Name
|
|
@@ -900,6 +909,14 @@ export declare type NationalIdentification = {
|
|
|
900
909
|
*/
|
|
901
910
|
declare type NationalIdentifierTypeCode = 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC';
|
|
902
911
|
|
|
912
|
+
/**
|
|
913
|
+
* Field properties for national identifier type selection
|
|
914
|
+
* @public
|
|
915
|
+
*/
|
|
916
|
+
declare type NationalIdentifierTypeFieldOptions = {
|
|
917
|
+
values?: NationalIdentifierTypeCode[];
|
|
918
|
+
};
|
|
919
|
+
|
|
903
920
|
/**
|
|
904
921
|
* Interface representing a natural person (individual) involved in a transaction
|
|
905
922
|
*
|
|
@@ -954,12 +971,22 @@ declare type NaturalPerson_2 = {
|
|
|
954
971
|
export declare type NaturalPersonFieldName = 'name' | 'website' | 'email' | 'phone' | 'geographicAddress' | 'nationalIdentification' | 'dateOfBirth' | 'placeOfBirth' | 'countryOfResidence';
|
|
955
972
|
|
|
956
973
|
/**
|
|
957
|
-
* Field properties
|
|
974
|
+
* Field properties for natural person fields
|
|
958
975
|
* @public
|
|
959
976
|
*/
|
|
960
|
-
export declare type NaturalPersonFields = {
|
|
961
|
-
|
|
962
|
-
|
|
977
|
+
export declare type NaturalPersonFields = Partial<{
|
|
978
|
+
name: FieldOptions;
|
|
979
|
+
website: FieldOptions;
|
|
980
|
+
email: FieldOptions;
|
|
981
|
+
phone: FieldOptions;
|
|
982
|
+
geographicAddress: FieldOptions;
|
|
983
|
+
nationalIdentification: FieldOptions & {
|
|
984
|
+
nationalIdentifierType: NationalIdentifierTypeFieldOptions;
|
|
985
|
+
};
|
|
986
|
+
dateOfBirth: FieldOptions;
|
|
987
|
+
placeOfBirth: FieldOptions;
|
|
988
|
+
countryOfResidence: FieldOptions;
|
|
989
|
+
}>;
|
|
963
990
|
|
|
964
991
|
/**
|
|
965
992
|
* Natural Person Name
|
package/docs/README.md
CHANGED
|
@@ -642,6 +642,36 @@ const options: TransactionOptions = {
|
|
|
642
642
|
};
|
|
643
643
|
```
|
|
644
644
|
|
|
645
|
+
### Configuring National Identifier Type
|
|
646
|
+
|
|
647
|
+
The National Identifier Type is a dropdown that allows the developer configure the types of national identifiers they are supporting.
|
|
648
|
+
|
|
649
|
+
```ts
|
|
650
|
+
const options: TransactionOptions = {
|
|
651
|
+
fields: {
|
|
652
|
+
naturalPerson: {
|
|
653
|
+
name: {optional: false},
|
|
654
|
+
nationalIdentification: {
|
|
655
|
+
optional: false,
|
|
656
|
+
nationalIdentifierType: {
|
|
657
|
+
values: [NationalIdentifierTypeCode.ARNU, NationalIdentifierTypeCode.CCPT],
|
|
658
|
+
},
|
|
659
|
+
},
|
|
660
|
+
},
|
|
661
|
+
legalPerson: {
|
|
662
|
+
name: true,
|
|
663
|
+
lei: {optional: true},
|
|
664
|
+
nationalIdentification: {
|
|
665
|
+
optional: false,
|
|
666
|
+
nationalIdentifierType: {
|
|
667
|
+
values: [NationalIdentifierTypeCode.LEIX],
|
|
668
|
+
},
|
|
669
|
+
},
|
|
670
|
+
},
|
|
671
|
+
},
|
|
672
|
+
};
|
|
673
|
+
```
|
|
674
|
+
|
|
645
675
|
### Configuring ownership proofs
|
|
646
676
|
|
|
647
677
|
By default components support message signing proofs.
|
|
@@ -16,7 +16,7 @@ Configuration options for Transaction components
|
|
|
16
16
|
|
|
17
17
|
#### Defined in
|
|
18
18
|
|
|
19
|
-
[types.ts:
|
|
19
|
+
[types.ts:826](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L826)
|
|
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:827](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L827)
|
|
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:828](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L828)
|
|
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:830](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L830)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -84,7 +84,7 @@ Configuration options for Transaction components
|
|
|
84
84
|
|
|
85
85
|
#### Defined in
|
|
86
86
|
|
|
87
|
-
[types.ts:
|
|
87
|
+
[types.ts:816](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L816)
|
|
88
88
|
|
|
89
89
|
***
|
|
90
90
|
|
|
@@ -94,4 +94,4 @@ Configuration options for Transaction components
|
|
|
94
94
|
|
|
95
95
|
#### Defined in
|
|
96
96
|
|
|
97
|
-
[types.ts:
|
|
97
|
+
[types.ts:829](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L829)
|
|
@@ -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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/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/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/ivms/types.ts#L71)
|
package/docs/notabene/README.md
CHANGED
|
@@ -10,16 +10,21 @@
|
|
|
10
10
|
|
|
11
11
|
### Classes
|
|
12
12
|
|
|
13
|
+
- [ConnectionManager](classes/ConnectionManager.md)
|
|
13
14
|
- [default](classes/default.md)
|
|
14
15
|
- [EmbeddedComponent](classes/EmbeddedComponent.md)
|
|
15
16
|
|
|
16
17
|
### Interfaces
|
|
17
18
|
|
|
19
|
+
- [ConnectionData](interfaces/ConnectionData.md)
|
|
20
|
+
- [ConnectionMetadata](interfaces/ConnectionMetadata.md)
|
|
21
|
+
- [ConnectionResponse](interfaces/ConnectionResponse.md)
|
|
18
22
|
- [NotabeneConfig](interfaces/NotabeneConfig.md)
|
|
19
23
|
|
|
20
24
|
### Type Aliases
|
|
21
25
|
|
|
22
26
|
- [MessageCallback](type-aliases/MessageCallback.md)
|
|
27
|
+
- [TransactionType](type-aliases/TransactionType.md)
|
|
23
28
|
|
|
24
29
|
### Functions
|
|
25
30
|
|