@notabene/javascript-sdk 2.0.0 → 2.0.2

package/docs/types/enumerations/PersonType.md

@@ -0,0 +1,55 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / PersonType
+
+# Enumeration: PersonType
+
+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
+
+ - [NaturalPerson](../interfaces/NaturalPerson.md) For natural person data requirements
+ - [LegalPerson](../interfaces/LegalPerson.md) For legal person data requirements
+
+## Enumeration Members
+
+### LEGAL
+
+> **LEGAL**: `"legal"`
+
+#### Defined in
+
+[types.ts:289](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L289)
+
+***
+
+### NATURAL
+
+> **NATURAL**: `"natural"`
+
+#### Defined in
+
+[types.ts:288](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L288)
+
+***
+
+### SELF
+
+> **SELF**: `"self"`
+
+#### Defined in
+
+[types.ts:290](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L290)

package/docs/types/enumerations/ProofStatus.md

@@ -0,0 +1,57 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ProofStatus
+
+# Enumeration: ProofStatus
+
+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
+
+## Enumeration Members
+
+### FAILED
+
+> **FAILED**: `"rejected"`
+
+#### Defined in
+
+[types.ts:954](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L954)
+
+***
+
+### FLAGGED
+
+> **FLAGGED**: `"flagged"`
+
+#### Defined in
+
+[types.ts:955](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L955)
+
+***
+
+### PENDING
+
+> **PENDING**: `"pending"`
+
+#### Defined in
+
+[types.ts:953](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L953)
+
+***
+
+### VERIFIED
+
+> **VERIFIED**: `"verified"`
+
+#### Defined in
+
+[types.ts:956](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L956)

package/docs/types/enumerations/ProofTypes.md

@@ -0,0 +1,148 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ProofTypes
+
+# Enumeration: ProofTypes
+
+Types of ownership proofs supported by the system
+
+## Remarks
+
+Supported proof types:
+- SelfDeclaration: User self-declares ownership without cryptographic proof
+- EIP191: Ethereum personal signature following EIP-191 standard
+- SIWE: Sign-In with Ethereum message signature (EIP-4361)
+- EIP712: Ethereum typed data signature following EIP-712 standard
+- BIP137: Bitcoin message signature following BIP-137
+- XPUB: Extended public key signature for HD wallets
+- MicroTransfer: Proof via small blockchain transaction
+- Screenshot: Image proof of ownership/access
+
+## See
+
+ - [SignatureProof](../interfaces/SignatureProof.md) For signature-based proofs
+ - [DeclarationProof](../interfaces/DeclarationProof.md) For self-declaration proofs
+ - [MicroTransferProof](../interfaces/MicroTransferProof.md) For transaction-based proofs
+ - [ScreenshotProof](../interfaces/ScreenshotProof.md) For screenshot proofs
+
+## Enumeration Members
+
+### BIP137
+
+> **BIP137**: `"bip-137"`
+
+#### Defined in
+
+[types.ts:986](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L986)
+
+***
+
+### BIP137\_XPUB
+
+> **BIP137\_XPUB**: `"xpub"`
+
+#### Defined in
+
+[types.ts:987](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L987)
+
+***
+
+### Connect
+
+> **Connect**: `"connect"`
+
+#### Defined in
+
+[types.ts:991](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L991)
+
+***
+
+### ED25519
+
+> **ED25519**: `"ed25519"`
+
+#### Defined in
+
+[types.ts:988](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L988)
+
+***
+
+### EIP1271
+
+> **EIP1271**: `"eip-1271"`
+
+#### Defined in
+
+[types.ts:985](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L985)
+
+***
+
+### EIP191
+
+> **EIP191**: `"eip-191"`
+
+#### Defined in
+
+[types.ts:983](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L983)
+
+***
+
+### EIP712
+
+> **EIP712**: `"eip-712"`
+
+#### Defined in
+
+[types.ts:984](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L984)
+
+***
+
+### MicroTransfer
+
+> **MicroTransfer**: `"microtransfer"`
+
+#### Defined in
+
+[types.ts:989](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L989)
+
+***
+
+### Screenshot
+
+> **Screenshot**: `"screenshot"`
+
+#### Defined in
+
+[types.ts:990](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L990)
+
+***
+
+### SelfDeclaration
+
+> **SelfDeclaration**: `"self-declaration"`
+
+#### Defined in
+
+[types.ts:980](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L980)
+
+***
+
+### SIWE
+
+> **SIWE**: `"siwe"`
+
+#### Defined in
+
+[types.ts:981](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L981)
+
+***
+
+### SIWX
+
+> **SIWX**: `"siwx"`
+
+#### Defined in
+
+[types.ts:982](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L982)

package/docs/types/enumerations/Status.md

@@ -0,0 +1,59 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Status
+
+# Enumeration: Status
+
+The verification status of a transaction
+
+## Enumeration Members
+
+### BANNED
+
+> **BANNED**: `"banned"`
+
+#### Defined in
+
+[types.ts:588](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L588)
+
+***
+
+### EMPTY
+
+> **EMPTY**: `"empty"`
+
+#### Defined in
+
+[types.ts:584](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L584)
+
+***
+
+### PENDING
+
+> **PENDING**: `"pending"`
+
+#### Defined in
+
+[types.ts:586](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L586)
+
+***
+
+### VERIFIED
+
+> **VERIFIED**: `"verified"`
+
+#### Defined in
+
+[types.ts:587](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L587)
+
+***
+
+### VERIFY
+
+> **VERIFY**: `"verify"`
+
+#### Defined in
+
+[types.ts:585](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L585)

package/docs/types/enumerations/ValidationSections.md

@@ -0,0 +1,59 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ValidationSections
+
+# Enumeration: ValidationSections
+
+**`Alpha`**
+
+Sections in a WithdrawalAssist screen
+
+## Enumeration Members
+
+### AGENT
+
+> **AGENT**: `"agent"`
+
+**`Alpha`**
+
+#### Defined in
+
+[types.ts:721](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L721)
+
+***
+
+### ASSET
+
+> **ASSET**: `"asset"`
+
+**`Alpha`**
+
+#### Defined in
+
+[types.ts:718](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L718)
+
+***
+
+### COUNTERPARTY
+
+> **COUNTERPARTY**: `"counterparty"`
+
+**`Alpha`**
+
+#### Defined in
+
+[types.ts:720](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L720)
+
+***
+
+### DESTINATION
+
+> **DESTINATION**: `"destination"`
+
+**`Alpha`**
+
+#### Defined in
+
+[types.ts:719](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L719)

package/docs/types/interfaces/Agent.md

@@ -0,0 +1,74 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Agent
+
+# Interface: Agent
+
+Who is the agent acting on behalf of the counterparty
+
+## Extended by
+
+- [`VASP`](VASP.md)
+- [`Wallet`](Wallet.md)
+
+## Properties
+
+### did
+
+> **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Defined in
+
+[types.ts:258](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L258)
+
+***
+
+### logo?
+
+> `optional` **logo**: `string`
+
+#### Defined in
+
+[types.ts:260](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L260)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+#### Defined in
+
+[types.ts:262](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L262)
+
+***
+
+### type
+
+> **type**: [`AgentType`](../enumerations/AgentType.md)
+
+#### Defined in
+
+[types.ts:259](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L259)
+
+***
+
+### url?
+
+> `optional` **url**: `string`
+
+#### Defined in
+
+[types.ts:261](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L261)
+
+***
+
+### verified?
+
+> `optional` **verified**: `boolean`
+
+#### Defined in
+
+[types.ts:263](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L263)

package/docs/types/interfaces/CallbackOptions.md

@@ -0,0 +1,29 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / CallbackOptions
+
+# Interface: CallbackOptions
+
+Options for callback and redirect URIs
+
+## Properties
+
+### callback?
+
+> `optional` **callback**: `string`
+
+#### Defined in
+
+[types.ts:936](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L936)
+
+***
+
+### redirectUri?
+
+> `optional` **redirectUri**: `string`
+
+#### Defined in
+
+[types.ts:937](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L937)

package/docs/types/interfaces/ComponentRequest.md

@@ -0,0 +1,50 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ComponentRequest
+
+# Interface: ComponentRequest
+
+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
+
+ - [Transaction](Transaction.md) For transaction-specific request properties
+ - [ConnectionRequest](ConnectionRequest.md) For connection-specific request properties
+
+## Extended by
+
+- [`Transaction`](Transaction.md)
+- [`DepositRequest`](DepositRequest.md)
+- [`ConnectionRequest`](ConnectionRequest.md)
+
+## Properties
+
+### customer?
+
+> `optional` **customer**: [`Counterparty`](Counterparty.md)
+
+#### Defined in
+
+[types.ts:495](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L495)
+
+***
+
+### requestId?
+
+> `optional` **requestId**: `string`
+
+#### Defined in
+
+[types.ts:494](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L494)

package/docs/types/interfaces/ComponentResponse.md

@@ -0,0 +1,71 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ComponentResponse
+
+# 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
+
+ - [Status](../enumerations/Status.md) For possible status values
+ - [ValidationError](../type-aliases/ValidationError.md) For error structure
+ - [TransactionResponse](TransactionResponse.md) For transaction-specific responses
+
+## Extended by
+
+- [`TransactionResponse`](TransactionResponse.md)
+
+## Properties
+
+### errors
+
+> **errors**: [`ValidationError`](../type-aliases/ValidationError.md)[]
+
+#### Defined in
+
+[types.ts:645](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L645)
+
+***
+
+### requestID
+
+> **requestID**: `string`
+
+#### Defined in
+
+[types.ts:642](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L642)
+
+***
+
+### status
+
+> **status**: [`Status`](../enumerations/Status.md)
+
+#### Defined in
+
+[types.ts:644](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L644)
+
+***
+
+### valid
+
+> **valid**: `boolean`
+
+#### Defined in
+
+[types.ts:643](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L643)