@notabene/javascript-sdk 2.0.1 → 2.0.3

package/docs/notabene/classes/default.md

@@ -0,0 +1,221 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [notabene](../README.md) / default
+
+# Class: default
+
+Primary constructor for Notabene UX elements
+
+This class provides methods to create and manage various Notabene components
+such as withdrawal assist, deposit assist, connect, and deposit request.
+It also handles URL generation and fragment decoding for these components.
+
+## Constructors
+
+### new default()
+
+> **new default**(`config`): [`default`](default.md)
+
+Creates a new instance of the Notabene SDK
+
+#### Parameters
+
+• **config**: [`NotabeneConfig`](../interfaces/NotabeneConfig.md)
+
+Configuration options for the Notabene SDK
+
+#### Returns
+
+[`default`](default.md)
+
+#### Defined in
+
+[notabene.ts:185](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L185)
+
+## Methods
+
+### componentUrl()
+
+> **componentUrl**\<`V`, `O`\>(`path`, `value`, `configuration`?, `callbacks`?): `string`
+
+**`Internal`**
+
+Generates a URL for a Notabene component
+
+#### Type Parameters
+
+• **V**
+
+• **O**
+
+#### Parameters
+
+• **path**: `string`
+
+The path of the component
+
+• **value**: `V`
+
+Transaction data
+
+• **configuration?**: `O`
+
+Optional transaction configuration
+
+• **callbacks?**: [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
+
+Optional callback configuration
+
+#### Returns
+
+`string`
+
+component URL
+
+#### Defined in
+
+[notabene.ts:203](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L203)
+
+***
+
+### createComponent()
+
+> **createComponent**\<`V`, `O`\>(`path`, `value`, `options`?, `callbacks`?): [`EmbeddedComponent`](EmbeddedComponent.md)\<`V`, `O`\>
+
+**`Internal`**
+
+Creates a new embedded component
+
+#### Type Parameters
+
+• **V**
+
+• **O**
+
+#### Parameters
+
+• **path**: `string`
+
+The path of the component
+
+• **value**: `Partial`\<`V`\>
+
+Transaction data
+
+• **options?**: `O`
+
+Optional transaction options
+
+• **callbacks?**: [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
+
+Optional callback configuration
+
+#### Returns
+
+[`EmbeddedComponent`](EmbeddedComponent.md)\<`V`, `O`\>
+
+A new EmbeddedComponent instance
+
+#### Defined in
+
+[notabene.ts:245](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L245)
+
+***
+
+### createConnectWallet()
+
+> **createConnectWallet**(`value`, `options`?, `callbacks`?): [`EmbeddedComponent`](EmbeddedComponent.md)\<[`ConnectionRequest`](../../types/interfaces/ConnectionRequest.md), [`ConnectionOptions`](../../types/type-aliases/ConnectionOptions.md)\>
+
+**`Alpha`**
+
+Creates a connect component
+
+#### Parameters
+
+• **value**: [`ConnectionRequest`](../../types/interfaces/ConnectionRequest.md)
+
+Connection request data
+
+• **options?**: [`ConnectionOptions`](../../types/type-aliases/ConnectionOptions.md)
+
+Optional transaction options
+
+• **callbacks?**: [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
+
+Optional callback configuration
+
+#### Returns
+
+[`EmbeddedComponent`](EmbeddedComponent.md)\<[`ConnectionRequest`](../../types/interfaces/ConnectionRequest.md), [`ConnectionOptions`](../../types/type-aliases/ConnectionOptions.md)\>
+
+A new EmbeddedComponent instance for connection
+
+#### Defined in
+
+[notabene.ts:288](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L288)
+
+***
+
+### createDepositRequest()
+
+> **createDepositRequest**(`value`, `options`?, `callbacks`?): [`EmbeddedComponent`](EmbeddedComponent.md)\<[`DepositRequest`](../../types/interfaces/DepositRequest.md), [`DepositRequestOptions`](../../types/interfaces/DepositRequestOptions.md)\>
+
+Creates a deposit request component
+
+#### Parameters
+
+• **value**: [`DepositRequest`](../../types/interfaces/DepositRequest.md)
+
+Deposit request data
+
+• **options?**: [`DepositRequestOptions`](../../types/interfaces/DepositRequestOptions.md)
+
+Optional transaction options
+
+• **callbacks?**: [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
+
+Optional callback configuration
+
+#### Returns
+
+[`EmbeddedComponent`](EmbeddedComponent.md)\<[`DepositRequest`](../../types/interfaces/DepositRequest.md), [`DepositRequestOptions`](../../types/interfaces/DepositRequestOptions.md)\>
+
+A new EmbeddedComponent instance for deposit requests
+
+#### Defined in
+
+[notabene.ts:310](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L310)
+
+***
+
+### createWithdrawalAssist()
+
+> **createWithdrawalAssist**(`value`, `options`?, `callbacks`?): [`EmbeddedComponent`](EmbeddedComponent.md)\<[`Withdrawal`](../../types/interfaces/Withdrawal.md), [`TransactionOptions`](../../types/interfaces/TransactionOptions.md)\>
+
+Creates a withdrawal assist component
+
+#### Parameters
+
+• **value**: `Partial`\<[`Withdrawal`](../../types/interfaces/Withdrawal.md)\>
+
+Withdrawal transaction data
+
+• **options?**: [`TransactionOptions`](../../types/interfaces/TransactionOptions.md)
+
+Optional transaction options
+
+• **callbacks?**: [`CallbackOptions`](../../types/interfaces/CallbackOptions.md)
+
+Optional callback configuration
+
+#### Returns
+
+[`EmbeddedComponent`](EmbeddedComponent.md)\<[`Withdrawal`](../../types/interfaces/Withdrawal.md), [`TransactionOptions`](../../types/interfaces/TransactionOptions.md)\>
+
+A new EmbeddedComponent instance for withdrawal assistance
+
+#### Defined in
+
+[notabene.ts:266](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L266)

package/docs/notabene/functions/decodeFragmentToObject.md

@@ -0,0 +1,27 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [notabene](../README.md) / decodeFragmentToObject
+
+# Function: decodeFragmentToObject()
+
+> **decodeFragmentToObject**(`fragment`): `Record`\<`string`, `string`\>
+
+Decodes a URL fragment into an object
+
+## Parameters
+
+• **fragment**: `string`
+
+The URL fragment to decode
+
+## Returns
+
+`Record`\<`string`, `string`\>
+
+An object containing the decoded key-value pairs
+
+## Defined in
+
+[utils/urls.ts:22](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/utils/urls.ts#L22)

package/docs/notabene/interfaces/NotabeneConfig.md

@@ -0,0 +1,69 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [notabene](../README.md) / NotabeneConfig
+
+# Interface: NotabeneConfig
+
+Configuration for the Notabene SDK
+
+## Properties
+
+### authToken?
+
+> `optional` **authToken**: `string`
+
+The authentication token for the Notabene API
+
+#### Defined in
+
+[notabene.ts:147](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L147)
+
+***
+
+### locale?
+
+> `optional` **locale**: `string`
+
+The locale to use for the UX components
+
+#### Defined in
+
+[notabene.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L162)
+
+***
+
+### nodeUrl?
+
+> `optional` **nodeUrl**: `string`
+
+The URL of the Notabene API node
+
+#### Defined in
+
+[notabene.ts:142](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L142)
+
+***
+
+### theme?
+
+> `optional` **theme**: [`Theme`](../../types/type-aliases/Theme.md)
+
+Custom theme configuration for the UX components
+
+#### Defined in
+
+[notabene.ts:157](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L157)
+
+***
+
+### uxUrl?
+
+> `optional` **uxUrl**: `string`
+
+The URL of the Notabene UX components
+
+#### Defined in
+
+[notabene.ts:152](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/notabene.ts#L152)

package/docs/notabene/type-aliases/MessageCallback.md

@@ -0,0 +1,31 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [notabene](../README.md) / MessageCallback
+
+# Type Alias: MessageCallback()\<T\>
+
+> **MessageCallback**\<`T`\>: (`message`) => `void`
+
+Callback function for handling component messages.
+
+## Type Parameters
+
+• **T**
+
+The type of data contained in the component message
+
+## Parameters
+
+• **message**: [`ComponentMessage`](../../types/type-aliases/ComponentMessage.md)\<`T`\>
+
+The message object containing the component data and type
+
+## Returns
+
+`void`
+
+## Defined in
+
+[utils/MessageEventManager.ts:11](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/utils/MessageEventManager.ts#L11)

package/docs/types/README.md

@@ -0,0 +1,154 @@
+[**@notabene/javascript-sdk**](../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../modules.md) / types
+
+# types
+
+## Index
+
+### Enumerations
+
+- [AgentType](enumerations/AgentType.md)
+- [CMType](enumerations/CMType.md)
+- [HMType](enumerations/HMType.md)
+- [PersonType](enumerations/PersonType.md)
+- [ProofStatus](enumerations/ProofStatus.md)
+- [ProofTypes](enumerations/ProofTypes.md)
+- [Status](enumerations/Status.md)
+- [ValidationSections](enumerations/ValidationSections.md)
+
+### Interfaces
+
+- [Agent](interfaces/Agent.md)
+- [CallbackOptions](interfaces/CallbackOptions.md)
+- [ComponentRequest](interfaces/ComponentRequest.md)
+- [ComponentResponse](interfaces/ComponentResponse.md)
+- [ConnectionRecord](interfaces/ConnectionRecord.md)
+- [ConnectionRequest](interfaces/ConnectionRequest.md)
+- [Counterparty](interfaces/Counterparty.md)
+- [DeclarationProof](interfaces/DeclarationProof.md)
+- [Deposit](interfaces/Deposit.md)
+- [DepositRequest](interfaces/DepositRequest.md)
+- [DepositRequestOptions](interfaces/DepositRequestOptions.md)
+- [LegalPerson](interfaces/LegalPerson.md)
+- [MicroTransferProof](interfaces/MicroTransferProof.md)
+- [NaturalPerson](interfaces/NaturalPerson.md)
+- [OwnershipProof](interfaces/OwnershipProof.md)
+- [ScreenshotProof](interfaces/ScreenshotProof.md)
+- [SignatureProof](interfaces/SignatureProof.md)
+- [ThresholdOptions](interfaces/ThresholdOptions.md)
+- [Transaction](interfaces/Transaction.md)
+- [TransactionOptions](interfaces/TransactionOptions.md)
+- [TransactionResponse](interfaces/TransactionResponse.md)
+- [VASP](interfaces/VASP.md)
+- [Wallet](interfaces/Wallet.md)
+- [Withdrawal](interfaces/Withdrawal.md)
+
+### Type Aliases
+
+- [BlockchainAddress](type-aliases/BlockchainAddress.md)
+- [CAIP10](type-aliases/CAIP10.md)
+- [CAIP19](type-aliases/CAIP19.md)
+- [CAIP2](type-aliases/CAIP2.md)
+- [CAIP220](type-aliases/CAIP220.md)
+- [Cancel](type-aliases/Cancel.md)
+- [Completed](type-aliases/Completed.md)
+- [ComponentMessage](type-aliases/ComponentMessage.md)
+- [ConnectionOptions](type-aliases/ConnectionOptions.md)
+- [CryptoCredential](type-aliases/CryptoCredential.md)
+- [Destination](type-aliases/Destination.md)
+- [DID](type-aliases/DID.md)
+- [DTI](type-aliases/DTI.md)
+- [Error](type-aliases/Error.md)
+- [FieldOptions](type-aliases/FieldOptions.md)
+- [FieldTypes](type-aliases/FieldTypes.md)
+- [HostMessage](type-aliases/HostMessage.md)
+- [InvalidValue](type-aliases/InvalidValue.md)
+- [ISOCurrency](type-aliases/ISOCurrency.md)
+- [LegalPersonFieldName](type-aliases/LegalPersonFieldName.md)
+- [LegalPersonFields](type-aliases/LegalPersonFields.md)
+- [LEI](type-aliases/LEI.md)
+- [NaturalPersonFieldName](type-aliases/NaturalPersonFieldName.md)
+- [NaturalPersonFields](type-aliases/NaturalPersonFields.md)
+- [NotabeneAsset](type-aliases/NotabeneAsset.md)
+- [Ready](type-aliases/Ready.md)
+- [ResizeRequest](type-aliases/ResizeRequest.md)
+- [Source](type-aliases/Source.md)
+- [Theme](type-aliases/Theme.md)
+- [TransactionAsset](type-aliases/TransactionAsset.md)
+- [TravelAddress](type-aliases/TravelAddress.md)
+- [UpdateValue](type-aliases/UpdateValue.md)
+- [URI](type-aliases/URI.md)
+- [UUID](type-aliases/UUID.md)
+- [V1Asset](type-aliases/V1Asset.md)
+- [V1Transaction](type-aliases/V1Transaction.md)
+- [ValidationError](type-aliases/ValidationError.md)
+- [VASPOptions](type-aliases/VASPOptions.md)
+
+## References
+
+### Address
+
+Re-exports [Address](../ivms/types/type-aliases/Address.md)
+
+***
+
+### Beneficiary
+
+Re-exports [Beneficiary](../ivms/types/type-aliases/Beneficiary.md)
+
+***
+
+### BeneficiaryVASP
+
+Re-exports [BeneficiaryVASP](../ivms/types/type-aliases/BeneficiaryVASP.md)
+
+***
+
+### ISOCountryCode
+
+Re-exports [ISOCountryCode](../ivms/types/type-aliases/ISOCountryCode.md)
+
+***
+
+### ISODate
+
+Re-exports [ISODate](../ivms/types/type-aliases/ISODate.md)
+
+***
+
+### IVMS101
+
+Re-exports [IVMS101](../ivms/types/type-aliases/IVMS101.md)
+
+***
+
+### NationalIdentification
+
+Re-exports [NationalIdentification](../ivms/types/type-aliases/NationalIdentification.md)
+
+***
+
+### OriginatingVASP
+
+Re-exports [OriginatingVASP](../ivms/types/type-aliases/OriginatingVASP.md)
+
+***
+
+### Originator
+
+Re-exports [Originator](../ivms/types/type-aliases/Originator.md)
+
+***
+
+### PayloadMetadata
+
+Re-exports [PayloadMetadata](../ivms/types/interfaces/PayloadMetadata.md)
+
+***
+
+### TransferPath
+
+Re-exports [TransferPath](../ivms/types/type-aliases/TransferPath.md)

package/docs/types/enumerations/AgentType.md

@@ -0,0 +1,29 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / AgentType
+
+# Enumeration: AgentType
+
+The type of Agent. Either a wallet or a VASP
+
+## Enumeration Members
+
+### PRIVATE
+
+> **PRIVATE**: `"WALLET"`
+
+#### Defined in
+
+[types.ts:249](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L249)
+
+***
+
+### VASP
+
+> **VASP**: `"VASP"`
+
+#### Defined in
+
+[types.ts:250](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L250)

package/docs/types/enumerations/CMType.md

@@ -0,0 +1,90 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / CMType
+
+# Enumeration: CMType
+
+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
+
+## Enumeration Members
+
+### CANCEL
+
+> **CANCEL**: `"cancel"`
+
+#### Defined in
+
+[types.ts:781](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L781)
+
+***
+
+### COMPLETE
+
+> **COMPLETE**: `"complete"`
+
+#### Defined in
+
+[types.ts:775](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L775)
+
+***
+
+### ERROR
+
+> **ERROR**: `"error"`
+
+#### Defined in
+
+[types.ts:780](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L780)
+
+***
+
+### INVALID
+
+> **INVALID**: `"invalid"`
+
+#### Defined in
+
+[types.ts:779](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L779)
+
+***
+
+### READY
+
+> **READY**: `"ready"`
+
+#### Defined in
+
+[types.ts:778](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L778)
+
+***
+
+### RESIZE
+
+> **RESIZE**: `"resize"`
+
+#### Defined in
+
+[types.ts:776](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L776)
+
+***
+
+### RESULT
+
+> **RESULT**: `"result"`
+
+#### Defined in
+
+[types.ts:777](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L777)

package/docs/types/enumerations/HMType.md

@@ -0,0 +1,35 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / HMType
+
+# Enumeration: HMType
+
+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
+
+## Enumeration Members
+
+### REQUEST\_RESPONSE
+
+> **REQUEST\_RESPONSE**: `"requestResponse"`
+
+#### Defined in
+
+[types.ts:885](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L885)
+
+***
+
+### UPDATE
+
+> **UPDATE**: `"update"`
+
+#### Defined in
+
+[types.ts:884](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L884)