@notabene/javascript-sdk 1.32.0 → 2.0.0-next.2

package/dist/notabene.d.ts

@@ -0,0 +1,678 @@
+/**
+ * 5.2.6
+ * Address
+ */
+declare type Address = {
+    addressType?: AddressTypeCode;
+    department?: string;
+    subDepartment?: string;
+    streetName?: string;
+    buildingNumber?: string;
+    buildingName?: string;
+    floor?: string;
+    postBox?: string;
+    room?: string;
+    postCode?: string;
+    townName?: string;
+    townLocationName?: string;
+    districtName?: string;
+    countrySubDivision?: string;
+    addressLine?: string[];
+    country?: string;
+};
+
+/**
+ * 5.3.11
+ * AddressTypeCode
+ *
+ * `HOME` Residential - Address is the home address.
+ * `BIZZ` Business - Address is the business address.
+ * `GEOG` Geographic - Address is the unspecified physical (geographical) address suitable for identification of the natural or legal person.
+ */
+declare type AddressTypeCode = 'HOME' | 'BIZZ' | 'GEOG';
+
+/**
+ * Who is the agent acting on behalf of the counterparty
+ * @public
+ */
+export declare interface Agent {
+    did: DID;
+    type: AgentType;
+    logo?: string;
+    url?: string;
+    name?: string;
+    verified?: boolean;
+}
+
+/**
+ * The type of Agent. Either a wallet or a VASP
+ * @public
+ */
+export declare enum AgentType {
+    PRIVATE = "WALLET",
+    VASP = "VASP"
+}
+
+/**
+ * 6.3
+ * The beneficiary is defined in Section 1.1 as the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer.
+ */
+declare type Beneficiary = {
+    beneficiaryPersons?: Person[];
+    accountNumber?: string[];
+};
+
+declare type BeneficiaryFields = {
+    destination?: destination;
+};
+
+/**
+ * 6.5
+ * The originating VASP is defined in Section 1.1 as the VASP which initiates the VA transfer, and transfers the VA upon receiving the request for a VA transfer on behalf of the originator.
+ */
+declare type BeneficiaryVASP = {
+    beneficiaryVASP?: Person;
+};
+
+declare type BlockchainAddress = string;
+
+declare type CAIP10 = string;
+
+declare type CAIP19 = string;
+
+declare type CAIP2 = string;
+
+declare interface CallbackOptions {
+    callback?: URI;
+    redirectUri?: URI;
+}
+
+declare type Cancel = {
+    type: CMType.CANCEL;
+};
+
+declare type CloseModal = {
+    type: CMType.CLOSE;
+    reqid: RequestID;
+};
+
+/**
+ * Component Message Types
+ * @internal
+ */
+export declare const enum CMType {
+    COMPLETE = "complete",
+    RESIZE = "resize",
+    RESULT = "result",
+    READY = "ready",
+    INVALID = "invalid",
+    MODAL = "openModal",
+    ERROR = "error",
+    CLOSE = "closeModal",
+    CANCEL = "cancel"
+}
+
+declare type Completed = {
+    type: CMType.COMPLETE;
+    response: TransactionResponse;
+};
+
+/**
+ * Component Message
+ * @internal
+ */
+export declare type ComponentMessage = Completed | Cancel | Error_2 | Result | Ready | ResizeRequest | ModalRequest | InvalidValue | CloseModal;
+
+/**
+ * The counterparty of a transaction.
+ * @public
+ */
+export declare interface Counterparty {
+    name?: string;
+    accountNumber?: string;
+    did?: string;
+    geographicAddress?: string;
+    type?: PersonType;
+    verified?: boolean;
+}
+
+/**
+ * 5.2.7
+ * DateAndPlaceOfBirth
+ */
+declare type DateAndPlaceOfBirth = {
+    dateOfBirth?: string;
+    placeOfBirth?: string;
+};
+
+/**
+ * Ownership Proof using Self Declaration
+ * @public
+ */
+export declare interface DeclarationProof extends OwnershipProof {
+    type: ProofTypes.SelfDeclaration;
+    attestation: string;
+    confirmed: boolean;
+}
+
+/**
+ * The destination of a transaction either a blockchain address, a CAIP-19 address, or a travel address.
+ * @public
+ */
+export declare type destination = BlockchainAddress | CAIP19 | TravelAddress;
+
+declare type DID = string;
+
+declare type DTI = string;
+
+/**
+ * An embedded Notabene component
+ * @public
+ */
+export declare class EmbeddedComponent {
+    private _url;
+    private _value;
+    private _errors;
+    private iframe?;
+    private eventManager;
+    private ready;
+    constructor(url: string, value: Partial<Transaction>);
+    get url(): string;
+    get value(): Partial<Transaction>;
+    get errors(): ValidationError[];
+    open(): void;
+    mount(parentId: string): void;
+    send(message: HostMessage): void;
+    on(messageType: string, callback: MessageCallback): void;
+    off(messageType: string, callback: MessageCallback): void;
+    update(value: Partial<Transaction>): void;
+    completion(): Promise<TransactionResponse>;
+}
+
+declare type Error_2 = {
+    type: CMType.ERROR;
+    message: string;
+};
+
+/**
+ * Host Message Types
+ * @internal
+ */
+declare const enum HMType {
+    UPDATE = "update",
+    REQUEST_RESPONSE = "requestResponse"
+}
+
+/**
+ * Host Messages
+ * @internal
+ */
+export declare type HostMessage = UpdateValue | RequestResponse;
+
+/**
+ * 5.2.13
+ * IntermediaryVASP
+ */
+declare type IntermediaryVASP = {
+    intermediaryVASP?: Person;
+    sequence?: number;
+};
+
+declare type InvalidValue = {
+    type: CMType.INVALID;
+    value: any;
+    errors: ValidationError[];
+};
+
+/**
+ * IVMS101 definition
+ *
+ * @public
+ */
+export declare type IVMS101 = {
+    originator?: Originator;
+    beneficiary?: Beneficiary;
+    originatingVASP?: OriginatingVASP;
+    beneficiaryVASP?: BeneficiaryVASP;
+    transferPath?: TransferPath;
+    payloadMetadata?: PayloadMetadata;
+};
+
+/**
+ * 5.2.9
+ * LegalPerson
+ */
+declare type LegalPerson = {
+    name?: LegalPersonName;
+    geographicAddress?: Address[];
+    customerNumber?: string;
+    nationalIdentification?: NationalIdentification;
+    countryOfRegistration?: string;
+};
+
+/**
+ * 5.2.10
+ * LegalPersonName
+ */
+declare type LegalPersonName = {
+    nameIdentifier?: LegalPersonNameID[];
+    localNameIdentifier?: LocalLegalPersonNameID[];
+    phoneticNameIdentifier?: LocalLegalPersonNameID[];
+};
+
+/**
+ * 5.2.11
+ * LegalPersonNameID
+ */
+declare type LegalPersonNameID = {
+    legalPersonName?: string;
+    legalPersonNameIdentifierType?: LegalPersonNameTypeCode;
+};
+
+/**
+ * 5.3.9
+ * LegalPersonNameTypeCode
+ *
+ * `LEGL` Legal name - Official name under which an organisation is registered.
+ * `SHRT` Short name - Specifies the short name of the organisation.
+ * `TRAD` Trading name - Name used by a business for commercial purposes, although its registered legal name, used for contracts and other formal situations, may be another.
+ */
+declare type LegalPersonNameTypeCode = 'LEGL' | 'SHRT' | 'TRAD';
+
+/**
+ * 5.2.12
+ * LocalLegalPersonNameID
+ */
+declare type LocalLegalPersonNameID = {
+    legalPersonName?: string;
+    legalPersonNameIdentifierType?: LegalPersonNameTypeCode;
+};
+
+/**
+ * 5.2.5
+ * LocalNaturalPersonNameID
+ */
+declare type LocalNaturalPersonNameID = {
+    primaryIdentifier?: string;
+    secondaryIdentifier?: string;
+    nameIdentifierType?: NaturalPersonNameTypeCode;
+};
+
+declare type MessageCallback = (message: ComponentMessage) => void;
+
+/**
+ * Ownership Proof using Micro Transfer
+ * @public
+ */
+export declare interface MicroTransferProof extends OwnershipProof {
+    type: ProofTypes.MicroTransfer;
+    txhash: string;
+    chain: CAIP2;
+    amount: number;
+}
+
+declare type ModalRequest = {
+    type: CMType.MODAL;
+    url: string;
+    reqid: RequestID;
+};
+
+/**
+ * 5.2.8
+ * NationalIdentification
+ */
+declare type NationalIdentification = {
+    nationalIdentifier?: string;
+    nationalIdentifierType?: NationalIdentifierTypeCode;
+    countryOfIssue?: string;
+    registrationAuthority?: string;
+};
+
+/**
+ * 5.3.14
+ * NationalIdentifierTypeCode
+ *
+ * `ARNU` Alien registration number - Number assigned by a government agency to identify foreign nationals.
+ * `CCPT` Passport number - Number assigned by a passport authority.
+ * `RAID` Registration authority identifier - Identifier of a legal entity as maintained by a registration authority.
+ * `DRLC` Driver license number - Number assigned to a driver's license.
+ * `FIIN` Foreign investment identity number - Number assigned to a foreign investor (other than the alien number).
+ * `TXID` Tax identification number - Number assigned by a tax authority to an entity.
+ * `SOCS` Social security number - Number assigned by a social security agency.
+ * `IDCD` Identity card number - Number assigned by a national authority to an identity card.
+ * `LEIX` Legal Entity Identifier - Legal Entity Identifier (LEI) assigned in accordance with ISO 17442 11 .
+ * `MISC` Unspecified - A national identifier which may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine.
+ */
+declare type NationalIdentifierTypeCode = 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC';
+
+/**
+ * 5.2.2
+ * NaturalPerson
+ */
+declare type NaturalPerson = {
+    name?: NaturalPersonName[];
+    geographicAddress?: Address[];
+    nationalIdentification?: NationalIdentification;
+    customerIdentification?: string;
+    dateAndPlaceOfBirth?: DateAndPlaceOfBirth;
+    countryOfResidence?: string;
+};
+
+/**
+ * 5.2.3
+ * NaturalPersonName
+ */
+declare type NaturalPersonName = {
+    nameIdentifier?: NaturalPersonNameID[];
+    localNameIdentifier?: LocalNaturalPersonNameID[];
+    phoneticNameIdentifier?: LocalNaturalPersonNameID[];
+};
+
+/**
+ * 5.2.4
+ * NaturalPersonNameID
+ */
+declare type NaturalPersonNameID = {
+    primaryIdentifier?: string;
+    secondaryIdentifier?: string;
+    nameIdentifierType?: NaturalPersonNameTypeCode;
+};
+
+/**
+ * 5.3.8
+ * NaturalPersonNameTypeCode
+ *
+ * `ALIA` Alias name  - A name other than the legal name by which a natural person is also known.
+ * `BIRT` Name at birth - The name given to a natural person at birth.
+ * `MAID` Maiden name - The original name of a natural person who has changed their name after marriage.
+ * `LEGL` Legal name - The name that identifies a natural person for legal, official or administrative purposes.
+ * `MISC` Unspecified - A name by which a natural person may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine.
+ */
+declare type NaturalPersonNameTypeCode = 'ALIA' | 'BIRT' | 'MAID' | 'LEGL' | 'MISC';
+
+/**
+ * Primary constructor for Notabene UX elements
+ *
+ * @public
+ */
+declare class Notabene {
+    private nodeUrl;
+    private authToken;
+    private uxUrl;
+    private theme?;
+    private dictionary?;
+    constructor(config: NotabeneConfig);
+    componentUrl(path: string, value: Partial<Transaction>, configuration?: any, callbacks?: CallbackOptions): string;
+    createComponent(path: string, value: Partial<Transaction>, options?: any, callbacks?: CallbackOptions): EmbeddedComponent;
+    createWithdrawalAssist(value: Partial<Withdrawal>, options?: any, callbacks?: CallbackOptions): EmbeddedComponent;
+    decodeFragmentToObject(fragment: string): Record<string, string>;
+}
+export { Notabene }
+export default Notabene;
+
+declare type NotabeneAsset = string;
+
+/**
+ * Configuration for the Notabene SDK
+ *
+ * @public
+ */
+export declare interface NotabeneConfig {
+    nodeUrl: string;
+    authToken: string;
+    uxUrl?: string;
+    theme?: Theme;
+    dictionary?: {
+        [key: string]: string;
+    };
+}
+
+/**
+ * 6.4
+ * The originating VASP is defined in Section 1.1 as the VASP which initiates the VA transfer, and transfers the VA upon receiving the request for a VA transfer on behalf of the originator.
+ */
+declare type OriginatingVASP = {
+    originatingVASP?: Person;
+};
+
+/**
+ * 6.2
+ * The originator is defined in Section 1.1 as the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer.
+ */
+declare type Originator = {
+    originatorPersons?: Person[];
+    accountNumber?: string[];
+};
+
+/**
+ * Ownership Proof
+ * @public
+ */
+export declare interface OwnershipProof {
+    type: ProofTypes;
+    status: ProofStatus;
+    did: DID;
+    address: CAIP10;
+}
+
+/**
+ * 6.7
+ * Data describing the contents of the payload.
+ */
+declare type PayloadMetadata = {
+    transferPath?: TransliterationMethodCode[];
+};
+
+/**
+ * 5.2.1
+ * Person
+ */
+declare type Person = {
+    naturalPerson?: NaturalPerson;
+    legalPerson?: LegalPerson;
+};
+
+/**
+ * The type of counterparty. Either a natural person or a legal person. If the customer is the same as the counterparty then the counterparty is a self.
+ * @public
+ */
+export declare enum PersonType {
+    NATURAL = "natural",
+    LEGAL = "legal",
+    SELF = "self"
+}
+
+/**
+ * Status of the proof
+ * @public
+ */
+export declare enum ProofStatus {
+    PENDING = "pending",// Verification is pending
+    FAILED = "rejected",// Rejected
+    FLAGGED = "flagged",// Flagged for manual review
+    VERIFIED = "verified"
+}
+
+/**
+ * The type of Proofs supported
+ * @public
+ **/
+export declare enum ProofTypes {
+    SelfDeclaration = "self-declaration",
+    PersonalSignEIP191 = "eip-191",
+    PersonalSignEIP712 = "eip-712",
+    PersonalSignBIP137 = "bip-137",
+    PersonalSignXPUB = "xpub",
+    MicroTransfer = "microtransfer",
+    Screenshot = "screenshot"
+}
+
+declare type Ready = {
+    type: CMType.READY;
+};
+
+declare type RequestID = string;
+
+declare type RequestResponse = {
+    type: HMType.REQUEST_RESPONSE;
+    reqid: RequestID;
+};
+
+declare type ResizeRequest = {
+    type: CMType.RESIZE;
+    height: number;
+};
+
+declare type Result = {
+    type: CMType.RESULT;
+    reqid: RequestID;
+    response: TransactionResponse;
+};
+
+/**
+ * Ownership Proof using Screenshot
+ * @public
+ */
+export declare interface ScreenshotProof extends OwnershipProof {
+    type: ProofTypes.Screenshot;
+    url: string;
+}
+
+/**
+ * Ownership Proof using Message Signature
+ * @public
+ */
+export declare interface SignatureProof extends OwnershipProof {
+    type: ProofTypes.PersonalSignEIP191 | ProofTypes.PersonalSignEIP712 | ProofTypes.PersonalSignBIP137 | ProofTypes.PersonalSignXPUB;
+    proof: string;
+    attestation: string;
+    wallet_provider: string;
+}
+
+/**
+ * The verification status of a transaction
+ * @public
+ */
+export declare enum Status {
+    EMPTY = "empty",
+    VERIFY = "verify",
+    PENDING = "pending",
+    VERIFIED = "verified",
+    BANNED = "banned"
+}
+
+/**
+ * The theme of the Notabene SDK
+ * @public
+ */
+export declare type Theme = {
+    primaryColor: string;
+    secondaryColor: string;
+    fontFamily: string;
+    logo: string;
+};
+
+/**
+ * An abstract transaction object
+ * @public
+ */
+export declare interface Transaction {
+    agent: Agent;
+    customer?: Counterparty;
+    counterparty: Counterparty;
+    asset: TransactionAsset;
+    amountDecimal: number;
+    customAssetPrice?: {
+        price: number;
+        currency: string;
+    };
+}
+
+/**
+ * The asset of a transaction either a Notabene asset, a CAIP-19 asset, or a DTI.
+ *
+ * @public
+ */
+export declare type TransactionAsset = NotabeneAsset | CAIP19 | DTI;
+
+/**
+ * The response of a transaction
+ * @public
+ */
+export declare type TransactionResponse = {
+    value: Transaction;
+    ivms: IVMS101;
+    proof?: OwnershipProof;
+    valid: boolean;
+    status: Status;
+    errors: ValidationError[];
+};
+
+/**
+ * 6.6
+ * The transfer path refers to the intermediary VASP(s) participating in a serial chain that receive(s) and retransmit(s) a VA transfer on behalf of the originating VASP and the beneficiary VASP, or another intermediary VASP, together with their corresponding sequence number.
+ */
+declare type TransferPath = {
+    transferPath?: IntermediaryVASP[];
+};
+
+/**
+ * 5.3.16
+ * TransliterationMethodCode
+ *
+ * `arab` Arabic (Arabic language) - ISO 233-2:1993
+ * `aran` Arabic (Persian language) - ISO 233-3:1999
+ * `armn` Armenian - ISO 9985:1996
+ * `cyrl` Cyrillic - ISO 9:1995
+ * `deva` Devanagari & related Indic - ISO 15919:2001
+ * `geor` Georgian - ISO 9984:1996
+ * `grek` Greek - ISO 843:1997
+ * `hani` Han (Hanzi, Kanji, Hanja) - ISO 7098:2015
+ * `hebr` Hebrew - ISO 259-2:1994
+ * `kana` Kana - ISO 3602:1989
+ * `kore` Korean - Revised Romanization of Korean
+ * `thai` Thai - ISO 11940-2:2007
+ * `othr` Script other than those listed above - Unspecified
+ */
+declare type TransliterationMethodCode = 'arab' | 'aran' | 'armn' | 'cyrl' | 'deva' | 'geor' | 'grek' | 'hani' | 'hebr' | 'kana' | 'kore' | 'thai' | 'othr';
+
+declare type TravelAddress = string;
+
+declare type UpdateValue = {
+    type: HMType.UPDATE;
+    value: Partial<Transaction>;
+};
+
+declare type URI = string;
+
+declare type ValidationError = {
+    attribute: string;
+    message: string;
+};
+
+/**
+ * A VASP agent acting on behalf of the counterparty
+ * @public
+ */
+export declare interface VASP extends Agent {
+    url?: string;
+    name?: string;
+}
+
+/**
+ * A wallet agent acting on behalf of the counterparty
+ * @public
+ */
+export declare interface Wallet extends Agent {
+    proof: OwnershipProof;
+    wallet_connect_id?: string;
+}
+
+/**
+ * An object representing a withdrawal transaction
+ * @public
+ */
+export declare interface Withdrawal extends BeneficiaryFields, Transaction {
+}
+
+export { }