@notabene/javascript-sdk 2.8.0-next.5 → 2.8.0

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

@@ -12,4 +12,4 @@ A Decentralized Identifier
 
 ## Defined in
 
-[types.ts:219](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L219)
+[types.ts:220](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L220)

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

@@ -35,4 +35,4 @@ Format: `DTI[NNNNN]` where N is a digit
 
 ## Defined in
 
-[types.ts:117](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L117)
+[types.ts:118](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L118)

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

@@ -12,4 +12,4 @@ The destination of a transaction either a blockchain address, a CAIP-19 address,
 
 ## Defined in
 
-[types.ts:197](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L197)
+[types.ts:198](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L198)

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

@@ -42,4 +42,4 @@ Identifier code of the error message
 
 ## Defined in
 
-[types.ts:874](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L874)
+[types.ts:902](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L902)

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

@@ -12,4 +12,4 @@ Field properties
 
 ## Defined in
 
-[types.ts:714](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L714)
+[types.ts:742](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L742)

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

@@ -22,4 +22,4 @@ Field type configuration
 
 ## Defined in
 
-[types.ts:727](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L727)
+[types.ts:755](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L755)

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

@@ -34,4 +34,4 @@ without requiring full reinitialization.
 
 ## Defined in
 
-[types.ts:986](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L986)
+[types.ts:1014](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L1014)

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

@@ -12,4 +12,4 @@
 
 ## Defined in
 
-[types.ts:231](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L231)
+[types.ts:232](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L232)

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

@@ -42,4 +42,4 @@ Array of validation errors
 
 ## Defined in
 
-[types.ts:896](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L896)
+[types.ts:924](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L924)

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

@@ -12,4 +12,4 @@ A LEI Legal Entity Identifier
 
 ## Defined in
 
-[types.ts:225](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L225)
+[types.ts:226](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L226)

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

@@ -10,4 +10,4 @@
 
 ## Defined in
 
-[types.ts:430](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L430)
+[types.ts:449](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L449)

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

@@ -6,10 +6,10 @@
 
 # Type Alias: LegalPersonFields
 
-> **LegalPersonFields**: `{ [name in LegalPersonFieldName]?: FieldOptions }`
+> **LegalPersonFields**: `Partial`\<\{ `countryOfRegistration`: [`FieldOptions`](FieldOptions.md); `email`: [`FieldOptions`](FieldOptions.md); `geographicAddress`: [`FieldOptions`](FieldOptions.md); `lei`: [`FieldOptions`](FieldOptions.md); `name`: [`FieldOptions`](FieldOptions.md); `nationalIdentification`: [`FieldOptions`](FieldOptions.md) & `object`; `phone`: [`FieldOptions`](FieldOptions.md); `website`: [`FieldOptions`](FieldOptions.md); \}\>
 
-Field properties by field name
+Field properties for legal person fields
 
 ## Defined in
 
-[types.ts:444](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L444)
+[types.ts:463](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L463)

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

@@ -0,0 +1,21 @@
+[**@notabene/javascript-sdk**](../../README.md)
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / NationalIdentifierTypeFieldOptions
+
+# Type Alias: NationalIdentifierTypeFieldOptions
+
+> **NationalIdentifierTypeFieldOptions**: `object`
+
+Field properties for national identifier type selection
+
+## Type declaration
+
+### values?
+
+> `optional` **values**: [`NationalIdentifierTypeCode`](../../ivms/types/type-aliases/NationalIdentifierTypeCode.md)[]
+
+## Defined in
+
+[types.ts:399](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L399)

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

@@ -12,4 +12,4 @@ Field names for NaturalPerson
 
 ## Defined in
 
-[types.ts:383](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L383)
+[types.ts:384](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L384)

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

@@ -6,10 +6,10 @@
 
 # Type Alias: NaturalPersonFields
 
-> **NaturalPersonFields**: `{ [name in NaturalPersonFieldName]?: FieldOptions }`
+> **NaturalPersonFields**: `Partial`\<\{ `countryOfResidence`: [`FieldOptions`](FieldOptions.md); `dateOfBirth`: [`FieldOptions`](FieldOptions.md); `email`: [`FieldOptions`](FieldOptions.md); `geographicAddress`: [`FieldOptions`](FieldOptions.md); `name`: [`FieldOptions`](FieldOptions.md); `nationalIdentification`: [`FieldOptions`](FieldOptions.md) & `object`; `phone`: [`FieldOptions`](FieldOptions.md); `placeOfBirth`: [`FieldOptions`](FieldOptions.md); `website`: [`FieldOptions`](FieldOptions.md); \}\>
 
-Field properties by field name for Natural persons
+Field properties for natural person fields
 
 ## Defined in
 
-[types.ts:398](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L398)
+[types.ts:407](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L407)

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

@@ -33,4 +33,4 @@ system that may be used alongside CAIP-19 and DTI identifiers.
 
 ## Defined in
 
-[types.ts:139](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L139)
+[types.ts:140](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L140)

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

@@ -18,4 +18,4 @@ Represents a ready component message
 
 ## Defined in
 
-[types.ts:843](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L843)
+[types.ts:871](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L871)

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

@@ -24,4 +24,4 @@ Represents a resize request component message. This is handled by the library.
 
 ## Defined in
 
-[types.ts:851](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L851)
+[types.ts:879](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L879)

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

@@ -12,4 +12,4 @@ The source of a transaction
 
 ## Defined in
 
-[types.ts:207](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L207)
+[types.ts:208](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L208)

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

@@ -34,4 +34,4 @@ The theme of the Notabene SDK
 
 ## Defined in
 
-[types.ts:237](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L237)
+[types.ts:238](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L238)

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

@@ -12,4 +12,4 @@ 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/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L145)
+[types.ts:146](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L146)

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

@@ -34,4 +34,4 @@ VASPs and blockchain networks while maintaining privacy.
 
 ## Defined in
 
-[types.ts:186](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L186)
+[types.ts:187](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L187)

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

@@ -12,4 +12,4 @@ A Uniform Resource Identifier
 
 ## Defined in
 
-[types.ts:213](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L213)
+[types.ts:214](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L214)

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

@@ -24,4 +24,4 @@ Format: 8-4-4-4-12 hexadecimal digits
 
 ## Defined in
 
-[types.ts:39](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L39)
+[types.ts:40](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L40)

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

@@ -51,4 +51,4 @@ and its configuration without requiring a full reload/reinitialize.
 
 ## Defined in
 
-[types.ts:964](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L964)
+[types.ts:992](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L992)

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

@@ -33,4 +33,4 @@ Used for backwards compatibility with V1 API transaction payloads:
 
 ## Defined in
 
-[types.ts:629](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L629)
+[types.ts:657](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L657)

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

@@ -54,4 +54,4 @@ Transaction payload suitable for calling Notabene v1 tx/create
 
 ## Defined in
 
-[types.ts:635](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L635)
+[types.ts:663](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L663)

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

@@ -26,4 +26,4 @@ Options for which VASPs to be searchable
 
 ## Defined in
 
-[types.ts:749](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L749)
+[types.ts:777](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L777)

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

@@ -22,4 +22,4 @@ Validation error
 
 ## Defined in
 
-[types.ts:705](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/80aada173fac6a9b5f05869abafa3c1c6cc56aa9/src/types.ts#L705)
+[types.ts:733](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/27e5c6c27d8a3a0bdafefd6e32c1654e964838a3/src/types.ts#L733)

package/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.8.0-next.5",
+  "version": "2.8.0",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",

package/src/types.ts

@@ -5,6 +5,7 @@ import type {
   ISODate,
   IVMS101,
   NationalIdentification,
+  NationalIdentifierTypeCode,
   Originator,
 } from './ivms/types';
 
@@ -392,13 +393,31 @@ export type NaturalPersonFieldName =
   | 'countryOfResidence'; // ISO Country code of residence of Natural Person
 
 /**
- * Field properties by field name for Natural persons
+ * Field properties for national identifier type selection
  * @public
  */
-export type NaturalPersonFields = {
-  [name in NaturalPersonFieldName]?: FieldOptions;
+export type NationalIdentifierTypeFieldOptions = {
+  values?: NationalIdentifierTypeCode[];
 };
 
+/**
+ * Field properties for natural person fields
+ * @public
+ */
+export type NaturalPersonFields = Partial<{
+  name: FieldOptions;
+  website: FieldOptions;
+  email: FieldOptions;
+  phone: FieldOptions;
+  geographicAddress: FieldOptions;
+  nationalIdentification: FieldOptions & {
+    nationalIdentifierType: NationalIdentifierTypeFieldOptions;
+  };
+  dateOfBirth: FieldOptions;
+  placeOfBirth: FieldOptions;
+  countryOfResidence: FieldOptions;
+}>;
+
 /**
  * Interface representing a legal entity (organization/company) involved in a transaction
  *
@@ -438,12 +457,21 @@ export type LegalPersonFieldName =
   | 'countryOfRegistration'; // ISO Country code of registration of Legal Person
 
 /**
- * Field properties by field name
+ * Field properties for legal person fields
  * @public
  */
-export type LegalPersonFields = {
-  [name in LegalPersonFieldName]?: FieldOptions;
-};
+export type LegalPersonFields = Partial<{
+  name: FieldOptions;
+  lei: FieldOptions;
+  website: FieldOptions;
+  email: FieldOptions;
+  phone: FieldOptions;
+  geographicAddress: FieldOptions;
+  nationalIdentification: FieldOptions & {
+    nationalIdentifierType: NationalIdentifierTypeFieldOptions;
+  };
+  countryOfRegistration: FieldOptions;
+}>;
 
 /**
  * Fields specific to the originator of a transaction