@notabene/javascript-sdk 2.0.1 → 2.0.2

package/docs/types/type-aliases/FieldTypes.md

@@ -0,0 +1,25 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / FieldTypes
+
+# Type Alias: FieldTypes
+
+> **FieldTypes**: `object`
+
+Field type configuration
+
+## Type declaration
+
+### legalPerson?
+
+> `optional` **legalPerson**: [`LegalPersonFields`](LegalPersonFields.md)
+
+### naturalPerson?
+
+> `optional` **naturalPerson**: [`NaturalPersonFields`](NaturalPersonFields.md)
+
+## Defined in
+
+[types.ts:698](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L698)

package/docs/types/type-aliases/HostMessage.md

@@ -0,0 +1,37 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / HostMessage
+
+# Type Alias: HostMessage\<T, O\>
+
+> **HostMessage**\<`T`, `O`\>: [`UpdateValue`](UpdateValue.md)\<`T`, `O`\>
+
+Union type representing all possible messages that can be sent from the host application
+to a component
+
+## Type Parameters
+
+• **T**
+
+The value type that components operate on
+
+• **O**
+
+The options type used to configure component behavior
+
+## 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.
+
+## See
+
+ - [UpdateValue](UpdateValue.md) For the structure of update messages
+ - [HMType](../enumerations/HMType.md) For message type constants
+
+## Defined in
+
+[types.ts:929](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L929)

package/docs/types/type-aliases/ISOCurrency.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ISOCurrency
+
+# Type Alias: ISOCurrency
+
+> **ISOCurrency**: `string`
+
+3 letter ISO currency code
+
+## Defined in
+
+[types.ts:231](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L231)

package/docs/types/type-aliases/InvalidValue.md

@@ -0,0 +1,45 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / InvalidValue
+
+# Type Alias: InvalidValue\<T\>
+
+> **InvalidValue**\<`T`\>: `object`
+
+**`Internal`**
+
+Represents an invalid value component message
+
+## Type Parameters
+
+• **T**
+
+The overall Value type being returned
+
+## Type declaration
+
+### errors
+
+> **errors**: [`ValidationError`](ValidationError.md)[]
+
+### type
+
+> **type**: [`INVALID`](../enumerations/CMType.md#invalid)
+
+### value
+
+> **value**: `Partial`\<`T`\>
+
+## Param
+
+The current Partial value
+
+## Param
+
+Array of validation errors
+
+## Defined in
+
+[types.ts:837](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L837)

package/docs/types/type-aliases/LEI.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / LEI
+
+# Type Alias: LEI
+
+> **LEI**: `string`
+
+A LEI Legal Entity Identifier
+
+## Defined in
+
+[types.ts:225](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L225)

package/docs/types/type-aliases/LegalPersonFieldName.md

@@ -0,0 +1,13 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / LegalPersonFieldName
+
+# Type Alias: LegalPersonFieldName
+
+> **LegalPersonFieldName**: `"name"` \| `"lei"` \| `"website"` \| `"email"` \| `"phone"` \| `"geographicAddress"` \| `"nationalIdentification"` \| `"countryOfRegistration"`
+
+## Defined in
+
+[types.ts:429](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L429)

package/docs/types/type-aliases/LegalPersonFields.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / LegalPersonFields
+
+# Type Alias: LegalPersonFields
+
+> **LegalPersonFields**: `{ [name in LegalPersonFieldName]?: FieldOptions }`
+
+Field properties by field name
+
+## Defined in
+
+[types.ts:443](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L443)

package/docs/types/type-aliases/NaturalPersonFieldName.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / NaturalPersonFieldName
+
+# Type Alias: NaturalPersonFieldName
+
+> **NaturalPersonFieldName**: `"name"` \| `"website"` \| `"email"` \| `"phone"` \| `"geographicAddress"` \| `"nationalIdentification"` \| `"dateOfBirth"` \| `"placeOfBirth"` \| `"countryOfResidence"`
+
+Field names for NaturalPerson
+
+## Defined in
+
+[types.ts:382](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L382)

package/docs/types/type-aliases/NaturalPersonFields.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / NaturalPersonFields
+
+# Type Alias: NaturalPersonFields
+
+> **NaturalPersonFields**: `{ [name in NaturalPersonFieldName]?: FieldOptions }`
+
+Field properties by field name for Natural persons
+
+## Defined in
+
+[types.ts:397](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L397)

package/docs/types/type-aliases/NotabeneAsset.md

@@ -0,0 +1,36 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / NotabeneAsset
+
+# Type Alias: NotabeneAsset
+
+> **NotabeneAsset**: `string`
+
+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.
+
+## Examples
+
+```ts
+"ETH_USDT" // USDT token on Ethereum
+```
+
+```ts
+"BTC" // Bitcoin
+```
+
+## See
+
+ - [CAIP19](CAIP19.md) For chain-agnostic asset identifiers
+ - [DTI](DTI.md) For ISO standardized identifiers
+
+## Defined in
+
+[types.ts:139](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L139)

package/docs/types/type-aliases/Ready.md

@@ -0,0 +1,21 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Ready
+
+# Type Alias: Ready
+
+> **Ready**: `object`
+
+Represents a ready component message
+
+## Type declaration
+
+### type
+
+> **type**: [`READY`](../enumerations/CMType.md#ready)
+
+## Defined in
+
+[types.ts:799](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L799)

package/docs/types/type-aliases/ResizeRequest.md

@@ -0,0 +1,27 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ResizeRequest
+
+# Type Alias: ResizeRequest
+
+> **ResizeRequest**: `object`
+
+**`Internal`**
+
+Represents a resize request component message. This is handled by the library.
+
+## Type declaration
+
+### height
+
+> **height**: `number`
+
+### type
+
+> **type**: [`RESIZE`](../enumerations/CMType.md#resize)
+
+## Defined in
+
+[types.ts:807](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L807)

package/docs/types/type-aliases/Source.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Source
+
+# Type Alias: Source
+
+> **Source**: [`BlockchainAddress`](BlockchainAddress.md) \| [`CAIP10`](CAIP10.md)
+
+The source of a transaction
+
+## Defined in
+
+[types.ts:207](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L207)

package/docs/types/type-aliases/Theme.md

@@ -0,0 +1,33 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / Theme
+
+# Type Alias: Theme
+
+> **Theme**: `object`
+
+The theme of the Notabene SDK
+
+## Type declaration
+
+### fontFamily
+
+> **fontFamily**: `string`
+
+### logo
+
+> **logo**: `string`
+
+### primaryColor
+
+> **primaryColor**: `string`
+
+### secondaryColor
+
+> **secondaryColor**: `string`
+
+## Defined in
+
+[types.ts:237](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L237)

package/docs/types/type-aliases/TransactionAsset.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / TransactionAsset
+
+# Type Alias: TransactionAsset
+
+> **TransactionAsset**: [`NotabeneAsset`](NotabeneAsset.md) \| [`CAIP19`](CAIP19.md) \| [`DTI`](DTI.md)
+
+The asset of a transaction either a Notabene asset, a CAIP-19 asset, or a DTI.
+
+## Defined in
+
+[types.ts:145](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L145)

package/docs/types/type-aliases/TravelAddress.md

@@ -0,0 +1,37 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / TravelAddress
+
+# Type Alias: TravelAddress
+
+> **TravelAddress**: \`ta$\{string\}\`
+
+A travel address
+
+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
+
+```ts
+"ta1234abcd..." // Example travel rule address
+```
+
+## See
+
+ - [BlockchainAddress](BlockchainAddress.md) For native chain addresses
+ - [CAIP10](CAIP10.md) For chain-agnostic addresses
+
+## Defined in
+
+[types.ts:186](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L186)

package/docs/types/type-aliases/URI.md

@@ -0,0 +1,15 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / URI
+
+# Type Alias: URI
+
+> **URI**: `string`
+
+A Uniform Resource Identifier
+
+## Defined in
+
+[types.ts:213](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L213)

package/docs/types/type-aliases/UUID.md

@@ -0,0 +1,27 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / UUID
+
+# Type Alias: UUID
+
+> **UUID**: `string`
+
+UUID v4 string identifier
+A universally unique identifier that follows RFC 4122 format
+Format: 8-4-4-4-12 hexadecimal digits
+
+## Example
+
+```ts
+"550e8400-e29b-41d4-a716-446655440000"
+```
+
+## See
+
+[RFC4122](https://tools.ietf.org/html/rfc4122)
+
+## Defined in
+
+[types.ts:39](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L39)

package/docs/types/type-aliases/UpdateValue.md

@@ -0,0 +1,54 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / UpdateValue
+
+# Type Alias: UpdateValue\<T, O\>
+
+> **UpdateValue**\<`T`, `O`\>: `object`
+
+Message type for updating component state and configuration from host application
+
+## Type Parameters
+
+• **T**
+
+The type of the value being updated
+
+• **O**
+
+The type of the optional configuration parameters
+
+## Type declaration
+
+### options?
+
+> `optional` **options**: `O`
+
+### type
+
+> **type**: [`UPDATE`](../enumerations/HMType.md#update)
+
+### value
+
+> **value**: `Partial`\<`T`\>
+
+## 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.
+
+## See
+
+ - [HMType](../enumerations/HMType.md) For message type constants
+ - [HostMessage](HostMessage.md) For full host message type union
+
+## Defined in
+
+[types.ts:907](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L907)

package/docs/types/type-aliases/V1Asset.md

@@ -0,0 +1,36 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / V1Asset
+
+# Type Alias: V1Asset
+
+> **V1Asset**: [`NotabeneAsset`](NotabeneAsset.md) \| `object`
+
+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
+
+## Examples
+
+```ts
+"ETH_USDT" // Notabene asset format
+```
+
+```ts
+{ caip19: "eip155:1/erc20:0x6b175474e89094c44da98b954eedeac495271d0f" } // CAIP-19 format
+```
+
+## See
+
+ - [NotabeneAsset](NotabeneAsset.md) For Notabene asset format
+ - [CAIP19](CAIP19.md) For CAIP-19 asset format
+
+## Defined in
+
+[types.ts:605](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L605)

package/docs/types/type-aliases/V1Transaction.md

@@ -0,0 +1,49 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / V1Transaction
+
+# Type Alias: V1Transaction
+
+> **V1Transaction**: `object`
+
+Transaction payload suitable for calling Notabene v1 tx/create
+
+## Type declaration
+
+### beneficiary
+
+> **beneficiary**: [`Beneficiary`](../../ivms/types/type-aliases/Beneficiary.md)
+
+### beneficiaryProof?
+
+> `optional` **beneficiaryProof**: [`OwnershipProof`](../interfaces/OwnershipProof.md)
+
+### beneficiaryVASPdid
+
+> **beneficiaryVASPdid**: [`DID`](DID.md)
+
+### originator?
+
+> `optional` **originator**: [`Originator`](../../ivms/types/type-aliases/Originator.md)
+
+### originatorEqualsBeneficiary?
+
+> `optional` **originatorEqualsBeneficiary**: `boolean`
+
+### originatorVASPdid
+
+> **originatorVASPdid**: [`DID`](DID.md)
+
+### transactionAmount
+
+> **transactionAmount**: `string`
+
+### transactionAsset
+
+> **transactionAsset**: [`V1Asset`](V1Asset.md)
+
+## Defined in
+
+[types.ts:611](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L611)

package/docs/types/type-aliases/VASPOptions.md

@@ -0,0 +1,25 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / VASPOptions
+
+# Type Alias: VASPOptions
+
+> **VASPOptions**: `object`
+
+Options for which VASPs to be searchable
+
+## Type declaration
+
+### addUnknown?
+
+> `optional` **addUnknown**: `boolean`
+
+### onlyActive?
+
+> `optional` **onlyActive**: `boolean`
+
+## Defined in
+
+[types.ts:707](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L707)

package/docs/types/type-aliases/ValidationError.md

@@ -0,0 +1,25 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ValidationError
+
+# Type Alias: ValidationError
+
+> **ValidationError**: `object`
+
+Validation error
+
+## Type declaration
+
+### attribute
+
+> **attribute**: `string`
+
+### message
+
+> **message**: `string`
+
+## Defined in
+
+[types.ts:677](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f75feb1dd5dd91003bcc9aa8429d05c94c878b06/src/types.ts#L677)

package/package.json

@@ -10,13 +10,14 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@3.2.2",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "source": "src/notabene.ts",
   "main": "dist/notabene.js",
   "types": "dist/notabene.d.ts",
   "browserslist": "> 0.5%, last 2 versions, not dead",
   "files": [
     "dist",
+    "docs",
     "src",
     "package.json",
     "README.md"
@@ -29,7 +30,7 @@
     "watch": "parcel watch",
     "build:dev": "yarn build && yarn dev",
     "build:clean": "rimraf dist/ ts-out coverage temp etc",
-    "build": "yarn lint && vite build && yarn typecheck && yarn docs",
+    "build": "yarn lint && vite build && tsc && api-extractor run && yarn docs",
     "lint": "eslint .",
     "format": "prettier --write .",
     "test": "vitest",