@notabene/javascript-sdk 2.0.1 → 2.0.3

package/docs/notabene/README.md

@@ -0,0 +1,368 @@
+[**@notabene/javascript-sdk**](../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../modules.md) / notabene
+
+# notabene
+
+## Index
+
+### Classes
+
+- [default](classes/default.md)
+- [EmbeddedComponent](classes/EmbeddedComponent.md)
+
+### Interfaces
+
+- [NotabeneConfig](interfaces/NotabeneConfig.md)
+
+### Type Aliases
+
+- [MessageCallback](type-aliases/MessageCallback.md)
+
+### Functions
+
+- [decodeFragmentToObject](functions/decodeFragmentToObject.md)
+
+## References
+
+### Agent
+
+Re-exports [Agent](../types/interfaces/Agent.md)
+
+***
+
+### AgentType
+
+Re-exports [AgentType](../types/enumerations/AgentType.md)
+
+***
+
+### BlockchainAddress
+
+Re-exports [BlockchainAddress](../types/type-aliases/BlockchainAddress.md)
+
+***
+
+### CAIP10
+
+Re-exports [CAIP10](../types/type-aliases/CAIP10.md)
+
+***
+
+### CAIP19
+
+Re-exports [CAIP19](../types/type-aliases/CAIP19.md)
+
+***
+
+### CAIP2
+
+Re-exports [CAIP2](../types/type-aliases/CAIP2.md)
+
+***
+
+### CallbackOptions
+
+Re-exports [CallbackOptions](../types/interfaces/CallbackOptions.md)
+
+***
+
+### Cancel
+
+Re-exports [Cancel](../types/type-aliases/Cancel.md)
+
+***
+
+### CMType
+
+Re-exports [CMType](../types/enumerations/CMType.md)
+
+***
+
+### Completed
+
+Re-exports [Completed](../types/type-aliases/Completed.md)
+
+***
+
+### ComponentMessage
+
+Re-exports [ComponentMessage](../types/type-aliases/ComponentMessage.md)
+
+***
+
+### ComponentResponse
+
+Re-exports [ComponentResponse](../types/interfaces/ComponentResponse.md)
+
+***
+
+### ConnectionRequest
+
+Re-exports [ConnectionRequest](../types/interfaces/ConnectionRequest.md)
+
+***
+
+### Counterparty
+
+Re-exports [Counterparty](../types/interfaces/Counterparty.md)
+
+***
+
+### CryptoCredential
+
+Re-exports [CryptoCredential](../types/type-aliases/CryptoCredential.md)
+
+***
+
+### DeclarationProof
+
+Re-exports [DeclarationProof](../types/interfaces/DeclarationProof.md)
+
+***
+
+### Deposit
+
+Re-exports [Deposit](../types/interfaces/Deposit.md)
+
+***
+
+### DepositRequest
+
+Re-exports [DepositRequest](../types/interfaces/DepositRequest.md)
+
+***
+
+### Destination
+
+Re-exports [Destination](../types/type-aliases/Destination.md)
+
+***
+
+### DID
+
+Re-exports [DID](../types/type-aliases/DID.md)
+
+***
+
+### DTI
+
+Re-exports [DTI](../types/type-aliases/DTI.md)
+
+***
+
+### Error
+
+Re-exports [Error](../types/type-aliases/Error.md)
+
+***
+
+### FieldTypes
+
+Re-exports [FieldTypes](../types/type-aliases/FieldTypes.md)
+
+***
+
+### HMType
+
+Re-exports [HMType](../types/enumerations/HMType.md)
+
+***
+
+### HostMessage
+
+Re-exports [HostMessage](../types/type-aliases/HostMessage.md)
+
+***
+
+### InvalidValue
+
+Re-exports [InvalidValue](../types/type-aliases/InvalidValue.md)
+
+***
+
+### IVMS101
+
+Re-exports [IVMS101](../ivms/types/type-aliases/IVMS101.md)
+
+***
+
+### LegalPerson
+
+Re-exports [LegalPerson](../types/interfaces/LegalPerson.md)
+
+***
+
+### LEI
+
+Re-exports [LEI](../types/type-aliases/LEI.md)
+
+***
+
+### MicroTransferProof
+
+Re-exports [MicroTransferProof](../types/interfaces/MicroTransferProof.md)
+
+***
+
+### NationalIdentification
+
+Re-exports [NationalIdentification](../ivms/types/type-aliases/NationalIdentification.md)
+
+***
+
+### NaturalPerson
+
+Re-exports [NaturalPerson](../types/interfaces/NaturalPerson.md)
+
+***
+
+### NotabeneAsset
+
+Re-exports [NotabeneAsset](../types/type-aliases/NotabeneAsset.md)
+
+***
+
+### OwnershipProof
+
+Re-exports [OwnershipProof](../types/interfaces/OwnershipProof.md)
+
+***
+
+### PersonType
+
+Re-exports [PersonType](../types/enumerations/PersonType.md)
+
+***
+
+### ProofStatus
+
+Re-exports [ProofStatus](../types/enumerations/ProofStatus.md)
+
+***
+
+### ProofTypes
+
+Re-exports [ProofTypes](../types/enumerations/ProofTypes.md)
+
+***
+
+### Ready
+
+Re-exports [Ready](../types/type-aliases/Ready.md)
+
+***
+
+### ResizeRequest
+
+Re-exports [ResizeRequest](../types/type-aliases/ResizeRequest.md)
+
+***
+
+### ScreenshotProof
+
+Re-exports [ScreenshotProof](../types/interfaces/ScreenshotProof.md)
+
+***
+
+### SignatureProof
+
+Re-exports [SignatureProof](../types/interfaces/SignatureProof.md)
+
+***
+
+### Status
+
+Re-exports [Status](../types/enumerations/Status.md)
+
+***
+
+### Theme
+
+Re-exports [Theme](../types/type-aliases/Theme.md)
+
+***
+
+### ThresholdOptions
+
+Re-exports [ThresholdOptions](../types/interfaces/ThresholdOptions.md)
+
+***
+
+### Transaction
+
+Re-exports [Transaction](../types/interfaces/Transaction.md)
+
+***
+
+### TransactionAsset
+
+Re-exports [TransactionAsset](../types/type-aliases/TransactionAsset.md)
+
+***
+
+### TransactionOptions
+
+Re-exports [TransactionOptions](../types/interfaces/TransactionOptions.md)
+
+***
+
+### TransactionResponse
+
+Re-exports [TransactionResponse](../types/interfaces/TransactionResponse.md)
+
+***
+
+### TravelAddress
+
+Re-exports [TravelAddress](../types/type-aliases/TravelAddress.md)
+
+***
+
+### UpdateValue
+
+Re-exports [UpdateValue](../types/type-aliases/UpdateValue.md)
+
+***
+
+### V1Transaction
+
+Re-exports [V1Transaction](../types/type-aliases/V1Transaction.md)
+
+***
+
+### ValidationError
+
+Re-exports [ValidationError](../types/type-aliases/ValidationError.md)
+
+***
+
+### ValidationSections
+
+Re-exports [ValidationSections](../types/enumerations/ValidationSections.md)
+
+***
+
+### VASP
+
+Re-exports [VASP](../types/interfaces/VASP.md)
+
+***
+
+### VASPOptions
+
+Re-exports [VASPOptions](../types/type-aliases/VASPOptions.md)
+
+***
+
+### Wallet
+
+Re-exports [Wallet](../types/interfaces/Wallet.md)
+
+***
+
+### Withdrawal
+
+Re-exports [Withdrawal](../types/interfaces/Withdrawal.md)

package/docs/notabene/classes/EmbeddedComponent.md

@@ -0,0 +1,347 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [notabene](../README.md) / EmbeddedComponent
+
+# Class: EmbeddedComponent\<V, O\>
+
+An embedded Notabene component
+
+## Type Parameters
+
+• **V**
+
+• **O**
+
+## Constructors
+
+### new EmbeddedComponent()
+
+> **new EmbeddedComponent**\<`V`, `O`\>(`url`, `value`, `options`?): [`EmbeddedComponent`](EmbeddedComponent.md)\<`V`, `O`\>
+
+Creates an instance of EmbeddedComponent.
+
+#### Parameters
+
+• **url**: `string`
+
+The URL of the embedded component
+
+• **value**: `Partial`\<`V`\>
+
+The initial transaction value
+
+• **options?**: `O`
+
+#### Returns
+
+[`EmbeddedComponent`](EmbeddedComponent.md)\<`V`, `O`\>
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L34)
+
+## Accessors
+
+### errors
+
+#### Get Signature
+
+> **get** **errors**(): [`ValidationError`](../../types/type-aliases/ValidationError.md)[]
+
+##### Returns
+
+[`ValidationError`](../../types/type-aliases/ValidationError.md)[]
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:72](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L72)
+
+***
+
+### options
+
+#### Get Signature
+
+> **get** **options**(): `undefined` \| `O`
+
+##### Returns
+
+`undefined` \| `O`
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:68](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L68)
+
+***
+
+### url
+
+#### Get Signature
+
+> **get** **url**(): `string`
+
+Gets the URL of the embedded component
+
+##### Returns
+
+`string`
+
+The URL of the embedded component
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:56](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L56)
+
+***
+
+### value
+
+#### Get Signature
+
+> **get** **value**(): `Partial`\<`V`\>
+
+Gets the current transaction value
+
+##### Returns
+
+`Partial`\<`V`\>
+
+The current transaction value
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:64](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L64)
+
+## Methods
+
+### closeModal()
+
+> **closeModal**(): `void`
+
+Closes the modal dialog
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:230](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L230)
+
+***
+
+### completion()
+
+> **completion**(): `Promise`\<[`TransactionResponse`](../../types/interfaces/TransactionResponse.md)\<`V`\>\>
+
+Waits for the component to complete and returns the transaction response
+
+#### Returns
+
+`Promise`\<[`TransactionResponse`](../../types/interfaces/TransactionResponse.md)\<`V`\>\>
+
+A promise that resolves with the transaction response
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:173](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L173)
+
+***
+
+### embed()
+
+> **embed**(`parent`, `modal`): `void`
+
+Embeds the component into a parent element
+
+#### Parameters
+
+• **parent**: `Element`
+
+The parent element to embed the component into
+
+• **modal**: `boolean` = `false`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:100](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L100)
+
+***
+
+### mount()
+
+> **mount**(`parentId`): `void`
+
+Mounts the component to a parent element
+
+#### Parameters
+
+• **parentId**: `string`
+
+The ID of the parent element
+
+#### Returns
+
+`void`
+
+#### Throws
+
+Will throw an error if the parent element is not found
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:90](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L90)
+
+***
+
+### off()
+
+> **off**(`messageType`, `callback`): `void`
+
+Removes an event listener for a specific message type
+
+#### Parameters
+
+• **messageType**: `string`
+
+The type of message to stop listening for
+
+• **callback**: [`MessageCallback`](../type-aliases/MessageCallback.md)\<`V`\>
+
+The callback function to remove
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:154](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L154)
+
+***
+
+### on()
+
+> **on**(`messageType`, `callback`): () => `void`
+
+Adds an event listener for a specific message type
+
+#### Parameters
+
+• **messageType**: `string`
+
+The type of message to listen for
+
+• **callback**: [`MessageCallback`](../type-aliases/MessageCallback.md)\<`V`\>
+
+The callback function to execute when the message is received
+
+#### Returns
+
+`Function`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:144](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L144)
+
+***
+
+### open()
+
+> **open**(): `void`
+
+Opens the component URL in the current window
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:80](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L80)
+
+***
+
+### openModal()
+
+> **openModal**(): `Promise`\<[`TransactionResponse`](../../types/interfaces/TransactionResponse.md)\<`V`\>\>
+
+Opens the component in a modal dialog
+
+#### Returns
+
+`Promise`\<[`TransactionResponse`](../../types/interfaces/TransactionResponse.md)\<`V`\>\>
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:196](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L196)
+
+***
+
+### removeEmbed()
+
+> **removeEmbed**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:126](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L126)
+
+***
+
+### send()
+
+> **send**(`message`): `void`
+
+Sends a message to the embedded component
+
+#### Parameters
+
+• **message**: [`HostMessage`](../../types/type-aliases/HostMessage.md)\<`V`, `O`\>
+
+The message to send
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:134](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L134)
+
+***
+
+### update()
+
+> **update**(`value`, `options`?): `void`
+
+Updates the transaction value and sends an update message to the component
+
+#### Parameters
+
+• **value**: `Partial`\<`V`\>
+
+The new transaction value
+
+• **options?**: `O`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[components/EmbeddedComponent.ts:162](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/components/EmbeddedComponent.ts#L162)