@notabene/javascript-sdk 2.0.0-next.17 → 2.0.0-next.19

package/dist/notabene.d.ts

@@ -84,7 +84,7 @@ declare type Beneficiary = {
  * @public
  */
 declare type BeneficiaryFields = {
-    destination?: destination;
+    destination?: Destination;
 };
 
 /**
@@ -101,34 +101,72 @@ declare type BeneficiaryVASP = {
  * A blockchain address
  * @public
  */
-declare type BlockchainAddress = string;
+/**
+ * A native blockchain address string
+ *
+ * @remarks
+ * Represents a blockchain address in the native format specific to a particular chain.
+ * This could be an Ethereum address, Bitcoin address, or other chain-specific format.
+ * The address format and validation rules depend on the underlying blockchain.
+ *
+ * @example "0x742d35Cc6634C0532925a3b844Bc454e4438f44e" // Ethereum address
+ * @example "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa" // Bitcoin address
+ * @example "cosmos1t2uflqwqe0fsj0shcfkrvpukewcw40yjj6hdc0" // Cosmos address
+ * @public
+ */
+export declare type BlockchainAddress = string;
 
 /**
- * Chain Agnostic Account Identifier
- * Represents an account on a specific blockchain
+ * Chain Agnostic Account Identifier (CAIP-10)
+ * Represents an account/address on a specific blockchain following the CAIP-10 specification.
+ * Extends CAIP-2 by adding the account address specific to that chain.
+ *
  * Format: `{caip2}:{address}`
- * @example "eip155:1:0x742d35Cc6634C0532925a3b844Bc454e4438f44e" for an Ethereum account
+ * - caip2: The CAIP-2 chain identifier (e.g. 'eip155:1')
+ * - address: Chain-specific account address format
+ *
+ * @example "eip155:1:0x742d35Cc6634C0532925a3b844Bc454e4438f44e" // Ethereum account on mainnet
+ * @example "bip122:000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f:128Lkh3S7CkDTBZ8W7BbpsN3YYizJMp8p6" // Bitcoin account on mainnet
+ * @example "cosmos:cosmoshub-3:cosmos1t2uflqwqe0fsj0shcfkrvpukewcw40yjj6hdc0" // Cosmos account
+ * @see {@link https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-10.md | CAIP-10 Specification}
  * @public
  */
-declare type CAIP10 = `${CAIP2}:${string}`;
+export declare type CAIP10 = `${CAIP2}:${string}`;
 
 /**
- * Chain Agnostic Asset Identifier
- * Represents an asset on a specific blockchain
+ * Chain Agnostic Asset Identifier (CAIP-19)
+ * Represents an asset/token on a specific blockchain following the CAIP-19 specification.
+ * Extends CAIP-2 by adding asset type and identifier information.
+ *
  * Format: `{caip2}/{asset_namespace}:{asset_reference}`
- * @example "eip155:1/erc20:0x6b175474e89094c44da98b954eedeac495271d0f" for DAI on Ethereum
+ * - caip2: The CAIP-2 chain identifier (e.g. 'eip155:1')
+ * - asset_namespace: The asset standard (e.g. 'erc20', 'erc721', 'slip44')
+ * - asset_reference: Chain/standard-specific asset identifier
+ *
+ * @example "eip155:1/erc20:0x6b175474e89094c44da98b954eedeac495271d0f" // DAI token on Ethereum mainnet
+ * @example "eip155:1/erc721:0x06012c8cf97BEaD5deAe237070F9587f8E7A266d" // CryptoKitties NFT contract
+ * @example "cosmos:cosmoshub-3/slip44:118" // ATOM token on Cosmos Hub
+ * @see {@link https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-19.md | CAIP-19 Specification}
  * @public
  */
-declare type CAIP19 = `${CAIP2}/${string}:${string}`;
+export declare type CAIP19 = `${CAIP2}/${string}:${string}`;
 
 /**
- * Chain Agnostic Blockchain Identifier
- * Represents a blockchain in a chain-agnostic way
+ * Chain Agnostic Blockchain Identifier (CAIP-2)
+ * Represents a blockchain in a chain-agnostic way following the CAIP-2 specification.
+ * The identifier consists of a namespace and reference separated by a colon.
+ *
  * Format: `namespace:reference`
- * @example "eip155:1" for Ethereum Mainnet
+ * - namespace: Represents the blockchain namespace (e.g. 'eip155', 'bip122', 'cosmos')
+ * - reference: Chain-specific identifier within that namespace
+ *
+ * @example "eip155:1" // Ethereum Mainnet
+ * @example "bip122:000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f" // Bitcoin Mainnet
+ * @example "cosmos:cosmoshub-3" // Cosmos Hub Mainnet
+ * @see {@link https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md | CAIP-2 Specification}
  * @public
  */
-declare type CAIP2 = `${string}:${string}`;
+export declare type CAIP2 = `${string}:${string}`;
 
 /**
  * Options for callback and redirect URIs
@@ -143,12 +181,22 @@ export declare interface CallbackOptions {
  * Represents a cancel component message
  * @internal
  */
-declare type Cancel = {
+export declare type Cancel = {
     type: CMType.CANCEL;
 };
 
 /**
- * Component Message Types
+ * Component Message Type enum representing different message types that can be sent
+ * between the host and component.
+ *
+ * @remarks
+ * - COMPLETE: Indicates a completed operation with response data
+ * - RESIZE: Request to adjust component size/dimensions
+ * - RESULT: Operation result notification
+ * - READY: Component is initialized and ready
+ * - INVALID: Validation failed with errors
+ * - ERROR: Operation encountered an error
+ * - CANCEL: Operation was cancelled
  * @public
  */
 export declare const enum CMType {
@@ -167,19 +215,50 @@ export declare const enum CMType {
  * @param response - The Response object which wraps T
  * @public
  */
-declare type Completed<T> = {
+export declare type Completed<T> = {
     type: CMType.COMPLETE;
     response: TransactionResponse<T>;
 };
 
 /**
- * Component Message
+ * Union type representing all possible messages that can be sent from a component
+ *
+ * @remarks
+ * Components communicate their state and results back to the host application
+ * through these message types:
+ * - Completed: Operation finished successfully with response data
+ * - Cancel: User cancelled the operation
+ * - Error: Operation failed with error message
+ * - Ready: Component initialized and ready for use
+ * - ResizeRequest: Component needs to adjust its dimensions
+ * - InvalidValue: Validation failed with current partial value
+ *
+ * @typeParam T - The value type that will be returned in Completed messages
+ *
+ * @see {@link Completed} For successful completion message format
+ * @see {@link Cancel} For cancellation message format
+ * @see {@link Error} For error message format
+ * @see {@link Ready} For ready message format
+ * @see {@link ResizeRequest} For resize message format
+ * @see {@link InvalidValue} For validation failure message format
  * @public
  */
 export declare type ComponentMessage<T> = Completed<T> | Cancel | Error_2 | Ready | ResizeRequest | InvalidValue<T>;
 
 /**
- * An abstract request for communicating with a component
+ * Base interface for requests sent to SDK components
+ *
+ * @remarks
+ * Defines core properties that all component requests share:
+ * - Optional unique request ID for tracking/correlating requests and responses
+ * - Optional customer detailsfor pre-filling component data
+ *
+ * This interface is extended by specific request types like:
+ * - Transaction requests for sending/receiving assets
+ * - Connection requests for establishing VASP to VASP communication
+ *
+ * @see {@link Transaction} For transaction-specific request properties
+ * @see {@link ConnectionRequest} For connection-specific request properties
  * @public
  */
 declare interface ComponentRequest {
@@ -187,7 +266,26 @@ declare interface ComponentRequest {
     customer?: Counterparty;
 }
 
-declare interface ComponentResponse {
+/**
+ * Base response interface for all SDK component operations
+ *
+ * @remarks
+ * Provides standardized response propertiesfor component interactions:
+ * - requestID: Links response back to the originating request
+ * - valid: Boolean indicating if the operation was valid/successful
+ * - status: Current verification status of the operation
+ * - errors: Array of validation errors if any occurred
+ *
+ * This interface is extended by specific response types like:
+ * - TransResponse for transaction operations
+ * - ConnectionResponse for VASP connection operations
+ *
+ * @see {@link Status} For possible status values
+ * @see {@link ValidationError} For error structure
+ * @see {@link TransactionResponse} For transaction-specific responses
+ * @public
+ */
+export declare interface ComponentResponse {
     requestID: RequestID;
     valid: boolean;
     status: Status;
@@ -206,6 +304,28 @@ export declare interface ConnectionRequest extends ComponentRequest {
  * The counterparty of a transaction.
  * @public
  */
+/**
+ * Interface representing a party involved in a transaction other than the initiator
+ *
+ * @remarks
+ fines the core properties that identify and describe a counterparty:
+ * - name: The display or legal name of the counterparty
+ * - accountNumber: An account identifier/reference number
+ * - did: Decentralized identifier for the counterparty
+ * - type: Classification as natural person, legal entity, or self
+ * - verified: Whether the counterparty's identity has been verified
+ * - geographicAddress: Physical/mailing address information
+ * - nationalIdentification: Government-issued ID details
+ * - website: Official web presence
+ * - phone: Contact phone number
+ * - email: Contact email address
+ *
+ * This interface serves as the base for more specific counterparty types:
+ * @see {@link NaturalPerson} For individual person properties
+ * @see {@link LegalPerson} For organization/entity properties
+ *
+ * @public
+ */
 export declare interface Counterparty {
     name?: string;
     accountNumber?: string;
@@ -222,8 +342,7 @@ export declare interface Counterparty {
 /**
  * A crypto credential
  * @public
- */
-declare type CryptoCredential = `${string}.${string}.mastercard`;
+ */ export declare type CryptoCredential = `${string}.${string}.mastercard`;
 
 /**
  * Date and Place of Birth
@@ -275,27 +394,41 @@ declare type DepositRequestFields = {
  * The destination of a transaction either a blockchain address, a CAIP-19 address, or a travel address.
  * @public
  */
-export declare type destination = BlockchainAddress | CAIP10 | CryptoCredential | TravelAddress;
+export declare type Destination = BlockchainAddress | CAIP10 | CryptoCredential | TravelAddress;
 
 /**
  * A Decentralized Identifier
  * @public
  */
-declare type DID = `did:${string}:${string}`;
+export declare type DID = `did:${string}:${string}`;
 
 /**
- * Digital Token Identifier
+ * Digital Token Identifier (DTI) following ISO 24165 standard
+ *
+ * @remarks
+ * A standardized identifier for digital assets and cryptocurrencies. The DTI system
+ * provides unique and unambiguous identification of digital tokens, supporting interoperability
+ * and clarity in financial markets.
+ *
+ * Format: `DTI[NNNNN]` where N is a digit
+ *
+ * @example "DTI00001" // Example DTI for Bitcoin
+ * @example "DTI00002" // Example DTI for Ethereum
+ *
+ * @see {@link https://dtif.org/ | Digital Token Identifier Foundation}
+ * @see {@link https://www.iso.org/standard/77895.html | ISO 24165}
  * @public
  */
-declare type DTI = string;
+export declare type DTI = string;
 
 /**
  * An embedded Notabene component
  * @public
  */
-export declare class EmbeddedComponent<V> {
+export declare class EmbeddedComponent<V, O> {
     private _url;
     private _value;
+    private _options?;
     private _errors;
     private iframe?;
     private eventManager;
@@ -305,7 +438,7 @@ export declare class EmbeddedComponent<V> {
      * @param url - The URL of the embedded component
      * @param value - The initial transaction value
      */
-    constructor(url: string, value: Partial<V>);
+    constructor(url: string, value: Partial<V>, options?: O);
     /**
      * Gets the URL of the embedded component
      * @returns The URL of the embedded component
@@ -316,6 +449,7 @@ export declare class EmbeddedComponent<V> {
      * @returns The current transaction value
      */
     get value(): Partial<V>;
+    get options(): O | undefined;
     get errors(): ValidationError[];
     /**
      * Opens the component URL in the current window
@@ -332,11 +466,12 @@ export declare class EmbeddedComponent<V> {
      * @param parent - The parent element to embed the component into
      */
     embed(parent: Element, modal?: boolean): void;
+    removeEmbed(): void;
     /**
      * Sends a message to the embedded component
      * @param message - The message to send
      */
-    send(message: HostMessage<V>): void;
+    send(message: HostMessage<V, O>): void;
     /**
      * Adds an event listener for a specific message type
      * @param messageType - The type of message to listen for
@@ -353,7 +488,7 @@ export declare class EmbeddedComponent<V> {
      * Updates the transaction value and sends an update message to the component
      * @param value - The new transaction value
      */
-    update(value: Partial<V>): void;
+    update(value: Partial<V>, options?: O): void;
     /**
      * Waits for the component to complete and returns the transaction response
      * @returns A promise that resolves with the transaction response
@@ -379,6 +514,7 @@ declare type Error_2 = {
     type: CMType.ERROR;
     message: string;
 };
+export { Error_2 as Error }
 
 /**
  * Field properties
@@ -389,25 +525,46 @@ declare type FieldOptions = boolean | {
     transmit: boolean;
 };
 
-declare type FieldTypes = {
+/**
+ * Field type configuration
+ * @public
+ */
+export declare type FieldTypes = {
     naturalPerson?: NaturalPersonFields;
     legalPerson?: LegalPersonFields;
 };
 
 /**
- * Host Message Types
+ * Host Message Type enum representing different message types that can be sent
+ * from the host application.
+ *
+ * @remarks
+ * - UPDATE: Message to update component value/state
+ * - REQUEST_RESPONSE: Message requesting a response from component
  * @public
  */
-declare const enum HMType {
+export declare const enum HMType {
     UPDATE = "update",
     REQUEST_RESPONSE = "requestResponse"
 }
 
 /**
- * Host Messages
+ * Union type representing all possible messages that can be sent from the host application
+ * to a component
+ *
+ * @remarks
+ * Currently only supports update messages which allow the host to modify component
+ * and configuration. The host uses these messages to communicate changes to the component
+ * without requiring full reinitialization.
+ *
+ * @typeParam T - The value type that components operate on
+ * @typeParam O - The options type used to configure component behavior
+ *
+ * @see {@link UpdateValue} For the structure of update messages
+ * @see {@link HMType} For message type constants
  * @public
  */
-export declare type HostMessage<T> = UpdateValue<T>;
+export declare type HostMessage<T, O> = UpdateValue<T, O>;
 
 /**
  * Intermediary VASP
@@ -428,7 +585,7 @@ declare type IntermediaryVASP = {
  * @param errors - Array of validation errors
  * @internal
  */
-declare type InvalidValue<T> = {
+export declare type InvalidValue<T> = {
     type: CMType.INVALID;
     value: Partial<T>;
     errors: ValidationError[];
@@ -469,12 +626,40 @@ export declare type IVMS101 = {
     payloadMetadata?: PayloadMetadata;
 };
 
+/**
+ * Interface representing a legal entity (organization/company) involved in a transaction
+ *
+ * @remarks
+ * Extends the baseface to add properties specific to legal entities:
+ * - type: MustPersonType.LEGAL to identify as an organization
+ * - name: Required registered legal name of the entity
+ * - lei: Optional Legal Entity Identifier for regulated entities
+ * - logo: Optional URI to the organization's logo image
+ * - countryOfRegistration: Optional ISO country code where entity is registered
+ *
+ * This interface captures the additional identifying information required for
+ * legal persons under FATF Travel Rule requirements. The properties align with
+ * standard business KYC (Know Your Businessta collection practices.
+ *
+ * @see {@link Counterparty} For base properties common to all counterparties
+ * @see {@link PersonType} For person type classification
+ * @see {@link LEI} For Legal Entity Identifier format
+ * @public
+ */
+export declare interface LegalPerson extends Counterparty {
+    type: PersonType.LEGAL;
+    name: string;
+    lei?: LEI;
+    logo?: URI;
+    countryOfRegistration?: ISOCountryCode;
+}
+
 /**
  * Legal Person
  * Represents a legal person with all associated information
  * @public
  */
-declare type LegalPerson = {
+declare type LegalPerson_2 = {
     /** The name of the legal person */
     name: LegalPersonName;
     /** The address of the legal person */
@@ -487,10 +672,6 @@ declare type LegalPerson = {
     countryOfRegistration?: ISOCountryCode;
 };
 
-/**
- * Field names for LegalPerson
- * @public
- */
 declare type LegalPersonFieldName = 'name' | 'lei' | 'website' | 'email' | 'phone' | 'geographicAddress' | 'nationalIdentification' | 'countryOfRegistration';
 
 /**
@@ -538,7 +719,7 @@ declare type LegalPersonNameTypeCode = 'LEGL' | 'SHRT' | 'TRAD';
  * A LEI Legal Entity Identifier
  * @public
  */
-declare type LEI = string;
+export declare type LEI = string;
 
 /**
  * Local Legal Person Name ID
@@ -566,7 +747,14 @@ declare type LocalNaturalPersonNameID = {
     nameIdentifierType?: NaturalPersonNameTypeCode;
 };
 
-declare type MessageCallback<T> = (message: ComponentMessage<T>) => void;
+/**
+ * Callback function for handling component messages.
+ *
+ * @typeParam T - The type of data contained in the component message
+ * @param message - The message object containing the component data and type
+ * @public
+ */
+export declare type MessageCallback<T> = (message: ComponentMessage<T>) => void;
 
 /**
  * Ownership Proof using Micro Transfer
@@ -576,6 +764,7 @@ export declare interface MicroTransferProof extends OwnershipProof {
     type: ProofTypes.MicroTransfer;
     txhash: string;
     chain: CAIP2;
+    destination: BlockchainAddress;
     amountSubunits: string;
 }
 
@@ -584,7 +773,7 @@ export declare interface MicroTransferProof extends OwnershipProof {
  * Represents a national identifier for a person or entity
  * @public
  */
-declare type NationalIdentification = {
+export declare type NationalIdentification = {
     /** National identifier (max 35 characters) */
     nationalIdentifier?: string;
     /** Type of national identifier */
@@ -602,12 +791,39 @@ declare type NationalIdentification = {
  */
 declare type NationalIdentifierTypeCode = 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'FIIN' | 'TXID' | 'SOCS' | 'IDCD' | 'LEIX' | 'MISC';
 
+/**
+ * Interface representing a natural person (individual) involved in a transaction
+ *
+ * @remarks
+ * Extends the baseinterface to add properties specific to individual persons:
+ * - type: Must be PersonType.NATURAL to identify as an individual
+ * - dateOfBirth: Optional ISO format birth date for identity verification
+ * - placeOfBirth: Optional birth place for identity verification
+ * - countryOfResidence: Optional ISO country code of current residence
+ * - name: Required full legal name of the individual
+ *
+ * This interface captures the additional identifying information required for
+ * natural persons under FATF Travel Rule requirements. The properties align
+ * with standard KYC (Know Your Customer) data collection practices.
+ *
+ * @see {@link Counterparty} For base properties common to all counterparties
+ * @see {@link PersonType} For person type classification
+ * @public
+ */
+export declare interface NaturalPerson extends Counterparty {
+    type: PersonType.NATURAL;
+    dateOfBirth?: ISODate;
+    placeOfBirth?: string;
+    countryOfResidence?: ISOCountryCode;
+    name: string;
+}
+
 /**
  * Natural Person
  * Represents a natural person with all associated information
  * @public
  */
-declare type NaturalPerson = {
+declare type NaturalPerson_2 = {
     /** The distinct words used as identification for an individual */
     name: NaturalPersonName;
     /** The particulars of a location at which a person may be communicated with */
@@ -629,7 +845,7 @@ declare type NaturalPerson = {
 declare type NaturalPersonFieldName = 'name' | 'website' | 'email' | 'phone' | 'geographicAddress' | 'nationalIdentification' | 'dateOfBirth' | 'placeOfBirth' | 'countryOfResidence';
 
 /**
- * Field properties by field name
+ * Field properties by field name for Natural persons
  * @public
  */
 declare type NaturalPersonFields = {
@@ -703,7 +919,7 @@ declare class Notabene {
      * @returns component URL
      * @internal
      */
-    componentUrl<V>(path: string, value: V, configuration?: TransactionOptions, callbacks?: CallbackOptions): string;
+    componentUrl<V, O>(path: string, value: V, configuration?: O, callbacks?: CallbackOptions): string;
     /**
      * Creates a new embedded component
      *
@@ -714,7 +930,7 @@ declare class Notabene {
      * @returns A new EmbeddedComponent instance
      * @internal
      */
-    createComponent<V>(path: string, value: Partial<V>, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent<V>;
+    createComponent<V, O>(path: string, value: Partial<V>, options?: O, callbacks?: CallbackOptions): EmbeddedComponent<V, O>;
     /**
      * Creates a withdrawal assist component
      *
@@ -723,7 +939,7 @@ declare class Notabene {
      * @param callbacks - Optional callback configuration
      * @returns A new EmbeddedComponent instance for withdrawal assistance
      */
-    createWithdrawalAssist(value: Partial<Withdrawal>, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent<Withdrawal>;
+    createWithdrawalAssist(value: Partial<Withdrawal>, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent<Withdrawal, TransactionOptions>;
     /**
      * Creates a wallet assist component
      *
@@ -733,7 +949,7 @@ declare class Notabene {
      * @returns A new EmbeddedComponent instance for withdrawal assistance
      * @alpha
      */
-    createWalletAssist(value: Partial<Withdrawal>, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent<Withdrawal>;
+    createWalletAssist(value: Partial<Withdrawal>, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent<Withdrawal, TransactionOptions>;
     /**
      * Creates a deposit assist component
      *
@@ -743,7 +959,7 @@ declare class Notabene {
      * @returns A new EmbeddedComponent instance for deposit assistance
      * @alpha
      */
-    createDepositAssist(value: Partial<Deposit>, options?: any, callbacks?: CallbackOptions): EmbeddedComponent<Deposit>;
+    createDepositAssist(value: Partial<Deposit>, options?: any, callbacks?: CallbackOptions): EmbeddedComponent<Deposit, any>;
     /**
      * Creates a connect component
      *
@@ -753,7 +969,7 @@ declare class Notabene {
      * @returns A new EmbeddedComponent instance for connection
      * @alpha
      */
-    createConnectWallet(value: ConnectionRequest, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent<ConnectionRequest>;
+    createConnectWallet(value: ConnectionRequest, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent<ConnectionRequest, TransactionOptions>;
     /**
      * Creates a deposit request component
      *
@@ -763,7 +979,7 @@ declare class Notabene {
      * @returns A new EmbeddedComponent instance for deposit requests
      * @public
      */
-    createDepositRequest(value: DepositRequest, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent<DepositRequest>;
+    createDepositRequest(value: DepositRequest, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent<DepositRequest, TransactionOptions>;
     /**
      * Decodes a URL fragment into an object
      *
@@ -772,20 +988,28 @@ declare class Notabene {
      */
     decodeFragmentToObject(fragment: string): Record<string, string>;
 }
-export { Notabene }
 export default Notabene;
 
 /**
  * Notabene Asset Identifier
  * @public
  */
-declare type NotabeneAsset = string;
-
 /**
- * Configuration for the Notabene SDK
+ * Internal identifier for assets in the Notabene system
+ *
+ * @remarks
+ * A standardized string format used within Notabene to identify cryptocurrencies,
+ * tokens, and other digital assets. This is Notabene's legacy asset identification
+ * system that may be used alongside CAIP-19 and DTI identifiers.
  *
+ * @example "ETH_USDT" // USDT token on Ethereum
+ * @example "BTC" // Bitcoin
+ * @see {@link CAIP19} For chain-agnostic asset identifiers
+ * @see {@link DTI} For ISO standardized identifiers
  * @public
  */
+export declare type NotabeneAsset = string;
+
 /**
  * Configuration for the Notabene SDK
  *
@@ -845,7 +1069,24 @@ declare type OriginatorFields = {
 };
 
 /**
- * Ownership Proof
+ * Base interface for proving ownership of an account or address
+ *
+ * @remarks
+ * TheOwnershipProof interface provides a common structure for different types of ownership verification:
+ * - All proofs must specify their type from the supported ProofTypes enum
+ * - Current verification status is tracked via ProofStatus
+ * - Links the proof to a decentralized identifier (DID)
+ * - Specifies the blockchain account/address being proven using CAIP-10 format
+ *
+ * This interface is extended by specific proof types like:
+ * - SignatureProof for cryptographic signatures
+ * - DeclarationProof for self-declarations
+ * - MicroTransferProof for transaction-based proof
+ * - ScreenshotProof for image-based verification
+ *
+ * @see {@link ProofTypes} For supported proof methods
+ * @see {@link ProofStatus} For possible verification states
+ * @see {@link CAIP10} For address format specification
  * @public
  */
 export declare interface OwnershipProof {
@@ -883,15 +1124,32 @@ declare enum PayloadVersionCode {
  */
 declare type Person = {
     /** Natural person information */
-    naturalPerson?: NaturalPerson;
+    naturalPerson?: NaturalPerson_2;
     /** Legal person information */
-    legalPerson?: LegalPerson;
+    legalPerson?: LegalPerson_2;
 };
 
 /**
  * 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
  */
+/**
+ * Enum defining the types of persons/entities in a transaction
+ *
+ * @remarks
+ * This classification system aligns with FATF travel rule requirements and defines:
+ * - NATURAL: Individual human persons acting in their own capacity
+ * - LEGAL: Registered organizations, companies, or other legal entities
+ * - SELF: When the counterparty is the same as the customer (first party transaction)
+ *
+ * The type affects what information must be collected and transmitted as part of
+ * travel rule compliance. Different verification and due diligence requirements
+ * apply to each type.
+ *
+ * @see {@link NaturalPerson} For natural person data requirements
+ * @see {@link LegalPerson} For legal person data requirements
+ * @public
+ */
 export declare enum PersonType {
     NATURAL = "natural",
     LEGAL = "legal",
@@ -899,7 +1157,15 @@ export declare enum PersonType {
 }
 
 /**
- * Status of the proof
+ * Status of the ownership proof verification process
+ *
+ * @remarks
+ * Represents the different states that an ownership proof can be in during and after verification:
+ * - PENDING: Initial state where verification is in progress or awaiting processing
+ * - FAILED: The proof was rejected due to failing verification checks
+ * - FLAGGED: The proof requires manual review due to suspicious or unclear verification results
+ * - VERIFIED: The proof has passed all verification checks successfully
+ *
  * @public
  */
 export declare enum ProofStatus {
@@ -910,7 +1176,23 @@ export declare enum ProofStatus {
 }
 
 /**
- * The type of Proofs supported
+ * Types of ownership proofs supported by the system
+ *
+ * @remarks
+ * Supported proof types:
+ * - SelfDeclaration: User self-declares ownership without cryptographic proof
+ * - PersonalSignEIP191: Ethereum personal signature following EIP-191 standard
+ * - SIWE: Sign-In with Ethereum message signature (EIP-4361)
+ * - PersonalSignEIP712: Ethereum typed data signature following EIP-712 standard
+ * - PersonalSignBIP137: Bitcoin message signature following BIP-137
+ * - PersonalSignXPUB: Extended public key signature for HD wallets
+ * - MicroTransfer: Proof via small blockchain transaction
+ * - Screenshot: Image proof of ownership/access
+ *
+ * @see {@link SignatureProof} For signature-based proofs
+ * @see {@link DeclarationProof} For self-declaration proofs
+ * @see {@link MicroTransferProof} For transaction-based proofs
+ * @see {@link ScreenshotProof} For screenshot proofs
  * @public
  */
 export declare enum ProofTypes {
@@ -928,7 +1210,7 @@ export declare enum ProofTypes {
  * Represents a ready component message
  * @public
  */
-declare type Ready = {
+export declare type Ready = {
     type: CMType.READY;
 };
 
@@ -938,7 +1220,7 @@ declare type RequestID = UUID;
  * Represents a resize request component message. This is handled by the library.
  * @internal
  */
-declare type ResizeRequest = {
+export declare type ResizeRequest = {
     type: CMType.RESIZE;
     height: number;
 };
@@ -953,7 +1235,20 @@ export declare interface ScreenshotProof extends OwnershipProof {
 }
 
 /**
- * Ownership Proof using Message Signature
+ * Interface for signature-based ownership proofs that use cryptographic message signing
+ *
+ * @remarks
+ * Extends the base OwnershipProface to add signature-specific properties:
+ * - Supports multiple signature standards like EIP-191, EIP-712, BIP-137, SIWE
+ * - Includes the cryptographic proof signature string
+ * - Contains an attestation message that was signed
+ * - Records which wallet provider was used for signing
+ *
+ * The signature proves ownership by demonstrating control of the private keys
+ * associated with the claimed address.
+ *
+ * @see {@link ProofTypes} For supported signature types
+ * @see {@link OwnershipProof} For base proof properties
  * @public
  */
 export declare interface SignatureProof extends OwnershipProof {
@@ -993,7 +1288,26 @@ export declare type Theme = {
 };
 
 /**
- * An abstract transaction object
+ * Core transaction interface representing a crypto asset transfer between parties
+ *
+ * @remarks
+ * Extends ComponentRequest to add transaction-specific properties:
+ * - agent: The entity facilitating/executing the transaction
+ * - counterparty: The other party involved in the transaction
+ * - asset: The cryptocurrency or token being transferred
+ * - amountDecimal: The amount to transfer in decimal format
+ * - proof: Optional ownership proof verifying control of involved addresses
+ * - assetPrice: Optional price information in a fiat currency
+ *
+ * This interface serves as the base for specific transaction types like:
+ * - Withdrawals for sending assets out
+ * - Deposits for receiving assets
+ * - Deposit requests for requesting asset transfers
+ *
+ * @see {@link Withdrawal} For withdrawal-specific transaction properties
+ * @see {@link Deposit} For deposit-specific transaction properties
+ * @see {@link Agent} For agent details
+ * @see {@link Counterparty} For counterparty information
  * @public
  */
 export declare interface Transaction extends ComponentRequest {
@@ -1034,12 +1348,26 @@ export declare interface TransactionOptions {
 }
 
 /**
- * The response of a transaction
+ * Response interface for transaction-related operations
+ *
+ * @remarks
+ * Extends ComponentResponse to add transaction-specific response data:
+ * - value: The resulting transaction value of generic type V
+ * - ivms101: IVMS 101 travel rule data for the transaction
+ * - proof: Optional ownership proof details if required
+ * - txCreate: Optional V1 transaction payload for legacy API compatibility
+ *
+ * @typeParam V - Type of the transaction value being returned
+ *
+ * @see {@link ComponentResponse} For base response properties
+ * @see {@link IVMS101} For travel rule data structure
+ * @see {@link OwnershipProof} For proof details
+ * @see {@link V1Transaction} For legacy transaction format
  * @public
  */
 export declare interface TransactionResponse<V> extends ComponentResponse {
     value: V;
-    ivms: IVMS101;
+    ivms101: IVMS101;
     proof?: OwnershipProof;
     txCreate?: V1Transaction;
 }
@@ -1064,16 +1392,46 @@ declare type TransliterationMethodCode = 'arab' | 'aran' | 'armn' | 'cyrl' | 'de
 /**
  * A travel address
  * @public
- */
-declare type TravelAddress = `ta${string}`;
+
+ * A standardized travel rule address format
+ *
+ * @remarks
+ * Represents a special address format used for travel rule compliance. Travel addresses
+ * are prefixed with 'ta' and contain encoded information about the transaction
+ * and counterparty details required for travel rule reporting.
+ *
+ * The format ensures consistent handling of travel rule data across different
+ * VASPs and blockchain networks while maintaining privacy.
+ *
+ * @example "ta1234abcd..." // Example travel rule address
+ * @see {@link BlockchainAddress} For native chain addresses
+ * @see {@link CAIP10} For chain-agnostic addresses
+
+ */ export declare type TravelAddress = `ta${string}`;
 
 /**
- * Represents an update value host message. This is sent from Host to component.
+ * Message type for updating component state and configuration from host application
+ *
+ * @remarks
+ * Defines the structure of update messages sent from host to component:
+ * - type: Identifies this as an update message
+ * - value: New partial state/data to update the component with
+ * - options: Optional configuration parameters to modify component behavior
+ *
+ * The host can use this to dynamically update both the component's data
+ * and its configuration without requiring a full reload/reinitialize.
+ *
+ * @typeParam T - The type of the value being updated
+ * @typeParam O - The type of the optional configuration parameters
+ *
+ * @see {@link HMType} For message type constants
+ * @see {@link HostMessage} For full host message type union
  * @public
  */
-declare type UpdateValue<T> = {
+export declare type UpdateValue<T, O> = {
     type: HMType.UPDATE;
     value: Partial<T>;
+    options?: O;
 };
 
 /**
@@ -1083,11 +1441,29 @@ declare type UpdateValue<T> = {
 declare type URI = string;
 
 /**
- * UUID v4
+ * UUID v4 string identifier
+ * A universally unique identifier that follows RFC 4122 format
+ * Format: 8-4-4-4-12 hexadecimal digits
+ * @example "550e8400-e29b-41d4-a716-446655440000"
+ * @see {@link https://tools.ietf.org/html/rfc4122 | RFC4122}
  * @public
  */
 declare type UUID = string;
 
+/**
+ * Represents a legacy V1 API asset format supporting both Notabene and CAIP-19 identifiers
+ *
+ * @remarks
+ * Used for backwards compatibility with V1 API transaction payloads:
+ * - Can be either a simple Notabene asset string
+ * - Or an object containing a CAIP-19 identifier
+ *
+ * @example "ETH_USDT" // Notabene asset format
+ * @example \{ caip19: "eip155:1/erc20:0x6b175474e89094c44da98b954eedeac495271d0f" \} // CAIP-19 format
+ * @see {@link NotabeneAsset} For Notabene asset format
+ * @see {@link CAIP19} For CAIP-19 asset format
+ * @public
+ */
 declare type V1Asset = NotabeneAsset | {
     caip19: CAIP19;
 };
@@ -1096,7 +1472,7 @@ declare type V1Asset = NotabeneAsset | {
  * Transaction payload suitable for calling Notabene v1 tx/create
  * @public
  */
-declare type V1Transaction = {
+export declare type V1Transaction = {
     transactionAsset: V1Asset;
     transactionAmount: string;
     originatorEqualsBeneficiary?: boolean;
@@ -1111,7 +1487,7 @@ declare type V1Transaction = {
  * Validation error
  * @public
  */
-declare type ValidationError = {
+export declare type ValidationError = {
     attribute: string;
     message: string;
 };
@@ -1127,7 +1503,11 @@ export declare interface VASP extends Agent {
     countryOfRegistration?: ISOCountryCode;
 }
 
-declare type VASPOptions = {
+/**
+ * Options for which VASPs to be searchable
+ * @public
+ */
+export declare type VASPOptions = {
     addUnknown?: boolean;
     onlyActive?: boolean;
 };