@notabene/javascript-sdk 2.0.0-next.6 → 2.0.0-next.7

package/README.md

@@ -10,7 +10,7 @@
 
 This library is the JavaScript SDK for loading the Notabene UX components in the front-end.
 
-[Documentation](https://devx.notabene.id/docs/widget-v2) •
+[Documentation](https://devx.notabene.id/docs/embedded=ux)
 [Installation](#installation)
 
 </div>
@@ -31,12 +31,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
   - [Customization](#customization)
     - [Functionality](#functionality)
     - [Pass the variables in the configuration](#pass-the-variables-in-the-configuration)
-    - [Theme](#theme)
-    - [Dictionary](#dictionary)
-          - [The property name must be the same as the text in the widget, for it to be replaced](#the-property-name-must-be-the-same-as-the-text-in-the-widget-for-it-to-be-replaced)
     - [Fields Properties](#fields-properties)
-    - [Fallbacks](#fallbacks)
-    - [Opt-In Features](#opt-in-features)
     - [Transaction Custom Asset Price](#transaction-custom-asset-price)
   - [License](#license)
 
@@ -70,7 +65,8 @@ Create a new Notabene instance:
 
 const notabene = new Notabene({
   nodeUrl: 'https://api.notabene.id',
-  authToken: '{CUSTOMER_TOKEN}'
+  authToken: '{CUSTOMER_TOKEN}',
+  locale: 'de' // default locale
 });
 ```
 
@@ -223,18 +219,6 @@ Type | Code | Title | Detail
 
 ## Customization
 
-### Functionality
-
-`transactionTypeAllowed`: `ALL` | `VASP_2_VASP_ONLY` | `FIRST_PARTY_ONLY`
-
-For limiting the type of transaction destinations you can pass.
-
-`ALL`: All transaction destinations are allowed. (DEFAULT)
-`VASP_2_VASP_ONLY`: Only transaction destinations that are VASPs are allowed.
-`FIRST_PARTY_ONLY`: Only transaction destinations that the originator owns are allowed.
-
----
-
 `nonCustodialDeclarationType`: `SIGNATURE` | `DECLARATION`
 
 For deciding which ownership proof type you want to use.
@@ -248,83 +232,6 @@ For deciding which ownership proof type you want to use.
 
 For deciding if you would like to allow your customer to provide a manual counterparty vasp name in the counterparty field.
 
-### Pass the variables in the configuration
-
-```js
-const notabene = new Notabene({
-    vaspDID: 'did:ethr:0x94c38fd29ef36f5cb2f7bc771f9d5bd9f7d05f27',
-    widget: 'https://beta-widget.notabene.id',
-    container: '#container',
-    authToken: '{CUSTOMER_TOKEN}'
-    allowedTransactionTypes: 'VASP_2_VASP_ONLY',
-    nonCustodialDeclarationType: 'DECLARATION',
-});
-```
-
----
-
-### Theme
-
-Pass a `theme` object when creating an instance
-
-Here you can pass configuration which will customize the styles of the widget to meet your brand needs, all values are optional.
-
-```js
-{
-  primaryColor: '#fff',
-  secondaryColor: '#fff',
-  primaryFontColor: '#fff',
-  secondaryFontColor: '#fff',
-  backgroundColor: '#fff',
-  fontFamily: Arial,
-  logo: {LOGO_URL},
-  mode: 'dark', // default: 'light'
-
-  // If you are using the Signature flow, here is the full list of custom theme that can be applied to the WalletConnect Modal.
-  '--w3m-font-family',
-  '--w3m-font-feature-settings',
-  '--w3m-overlay-background-color',
-  '--w3m-overlay-backdrop-filter',
-  '--w3m-z-index',
-  '--w3m-accent-color',
-  '--w3m-accent-fill-color',
-  '--w3m-background-color',
-  '--w3m-background-image-url',
-  '--w3m-logo-image-url',
-  '--w3m-background-border-radius',
-  '--w3m-container-border-radius',
-  '--w3m-wallet-icon-border-radius',
-  '--w3m-wallet-icon-large-border-radius',
-  '--w3m-wallet-icon-small-border-radius',
-  '--w3m-input-border-radius',
-  '--w3m-notification-border-radius',
-  '--w3m-button-border-radius',
-  '--w3m-secondary-button-border-radius',
-  '--w3m-icon-button-border-radius',
-  '--w3m-button-hover-highlight-border-radius',
-}
-```
-
-To get a list of supported fonts, visit [https://fonts.google.com/](https://fonts.google.com/)
-
-To get more details about the WalletConnect theme variables, visit [General style variables](https://docs.walletconnect.com/2.0/web/web3modal/react/wagmi/theming#general-style-variables).
-
----
-
-### Dictionary
-
-Pass a `dictionary` object mapping in text in the widget to your own language, for example:
-
-To replace `Loading...` with `Cargando...`
-
-```js
-{
-  'Loading...': 'Cargando...',
-}
-```
-
-###### The property name must be the same as the text in the widget, for it to be replaced
-
 ---
 
 ### Fields Properties
@@ -333,10 +240,8 @@ Possible fields customization support:
 
 | field name               | `forceDisplay` | `optional` | description                                             |
 | ------------------------ | -------------- | ---------- | ------------------------------------------------------- |
-| `counterparty`           | --             | ☑️         | Counterparty VASP or Wallet (destination or originator) |
 | `dateAndPlaceOfBirth`    | ☑️             | --         | Recipient (or Sender) Date and Place of Birth           |
 | `geographicAddress`      | ☑️             | ☑️          | Recipient (or Sender) Address                           |
-| `firstName`              | ☑️             | --         | Recipient (or Sender) First name                        |
 | `name`                   | ☑️             | --         | Recipient (or Sender) Last Name / Company Name          |
 | `nationalIdentification` | ☑️             | --️         | Recipient (or Sender) National Identification           |
 | `country`                | ☑️             | ☑️          | Recipient (or Sender) Country of Residence (for natural person) / Country of Registration (for legal person)           |
@@ -358,87 +263,7 @@ Possible fields customization support:
 }
 ```
 
----
-
-**_Beneficiary Details_ [DEPRECATED]**
-
-You can require specific beneficiary fields that are not required by your jurisdiction.
-
-Possible fields:
-
-- `beneficiaryName` - Recipient Name
-- `beneficiaryGeographicAddress` - Recipient Address
-- `beneficiaryNationalIdentification` - Recipient National Identification
-- `beneficiaryDateAndPlaceOfBirth` - Recipient Date and Place of Birth
-
-```js
-beneficiaryDetails: [
-  'benficiaryName',
-  'beneficiaryGeographicAddress',
-  'beneficiaryNationalIdentification',
-  'beneficiaryDateAndPlaceOfBirth',
-];
-```
-
----
-
-### Fallbacks
-
-Fallbacks are custom options provided when desired outcome is not achieved
-
-Possible options and actions:
-
-- `WALLET_NOT_SUPPORTED` - Performs one of the following options when wallet is not supported
-  - `DECLARATION` - Falls back to the self declaration flow
-  - `REJECT` - Rejects the transaction and throws an error
-    - The error that will be thrown here will have the following structure
-
-      ```js
-        {
-          "type": "WALLET_NOT_SUPPORTED",
-          "title": "Wallet Not Supported",
-          "status": 501,
-          "detail": "We don't support the wallet for the provided asset"
-        }
-      ```
-
-```js
-fallbacks: [{flow: "WALLET_NOT_SUPPORTED", action: "DECLARATION"}]
-```
-
----
-
-Finally you pass the configuration to a Notabene instance:
-
-```js
-const notabene = new Notabene({
-    widget: 'https://beta-widget.notabene.id',
-    container: '#container',
-    authToken: '{CUSTOMER_TOKEN}'
-    theme: {THEME},
-    dictionary: {DICTIONARY},
-    fallbacks: [{flow: "WALLET_NOT_SUPPORTED", action: "DECLARATION"}]
-});
-```
-
----
-
-### Opt-In Features
-
-```js
-const notabene = new Notabene({
-    widget: 'https://beta-widget.notabene.id',
-    container: '#container',
-    authToken: '{CUSTOMER_TOKEN}'
-    theme: {THEME},
-    dictionary: {DICTIONARY},
-    optInFeatures: ['REUSE_ADDRESS_OWNERSHIP_PROOF']
-});
-```
-
-**Available Opt-In Features**
 
-- `REUSE_ADDRESS_OWNERSHIP_PROOF`: For a given unique customer (identified by the `customerRef` from the customer token used) + unique wallet address, the widget would not ask for data collection if the customer previously verified the address ownership in a previous first party self-hosted transfer.
 
 ### Transaction Custom Asset Price
 

package/dist/notabene.cjs

@@ -1 +1 @@
-"use strict";var l=Object.defineProperty;var u=(s,e,t)=>e in s?l(s,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):s[e]=t;var o=(s,e,t)=>u(s,typeof e!="symbol"?e+"":e,t);var h=(s=>(s.COMPLETE="complete",s.RESIZE="resize",s.RESULT="result",s.READY="ready",s.INVALID="invalid",s.MODAL="openModal",s.ERROR="error",s.CLOSE="closeModal",s.CANCEL="cancel",s))(h||{}),d=(s=>(s.UPDATE="update",s.REQUEST_RESPONSE="requestResponse",s))(d||{});class m{constructor(){o(this,"listeners",new Map);o(this,"port");this.handleMessage=this.handleMessage.bind(this)}setPort(e){this.port=e,this.port.onmessage=this.handleMessage,this.port.start()}on(e,t){this.listeners.has(e)||this.listeners.set(e,new Set),this.listeners.get(e).add(t)}off(e,t){const r=this.listeners.get(e);r&&(r.delete(t),r.size===0&&this.listeners.delete(e))}handleMessage(e){console.log("received message",e.data);const t=e.data;if(typeof t=="object"&&t!==null&&"type"in t){const r=t.type,i=this.listeners.get(r);i&&i.forEach(n=>n(t))}}send(e){if(!this.port)throw new Error("No port set");this.port.postMessage(e)}}class f{constructor(e,t){o(this,"_url");o(this,"_value");o(this,"_errors",[]);o(this,"iframe");o(this,"eventManager");o(this,"ready",!1);this._url=e,this._value=t,this.eventManager=new m,this.on(h.INVALID,r=>{r.type===h.INVALID&&(this._errors=r.errors,this._value=r.value)}),this.on(h.RESIZE,r=>{r.type===h.RESIZE&&this.iframe&&(this.iframe.style.height=`${r.height}px`)})}get url(){return this._url}get value(){return this._value}get errors(){return this._errors}open(){document.location.href=this.url}mount(e){var r,i;this.iframe=document.createElement("iframe"),this.iframe.src=this.url,this.iframe.style.width="100%",this.iframe.style.height="100px",this.iframe.style.border="none",this.iframe.style.overflow="hidden",window.addEventListener("message",n=>{var a,c;n.source===((a=this.iframe)==null?void 0:a.contentWindow)&&(console.log("received message from iframe",n.data),(c=this.eventManager)==null||c.setPort(n.ports[0]),this.ready=!0)});const t=document.querySelector(e);if(!t)throw new Error(`parentID ${e} not found`);t.appendChild(this.iframe),(i=(r=this.iframe)==null?void 0:r.contentWindow)==null||i.focus()}send(e){this.eventManager.send(e)}on(e,t){this.eventManager.on(e,t)}off(e,t){this.eventManager.off(e,t)}update(e){this._value=e,this.send({type:d.UPDATE,value:e})}completion(){return new Promise((e,t)=>{this.on(h.COMPLETE,r=>{e(r.response)}),this.on("error",r=>{t(new Error(r.message))})})}}function p(s){return Object.entries(s).map(([e,t])=>{if(!(e&&t))return;const r=encodeURIComponent(e),i=encodeURIComponent(typeof t=="object"?JSON.stringify(t):t);return`${r}=${i}`}).filter(e=>!!e).join("&")}class E{constructor(e){o(this,"nodeUrl");o(this,"authToken");o(this,"uxUrl");o(this,"theme");o(this,"dictionary");this.uxUrl=e.uxUrl||"https://connect.notabene.id",this.nodeUrl=e.nodeUrl,this.authToken=e.authToken,this.theme=e.theme,this.dictionary=e.dictionary}componentUrl(e,t,r,i){const n=new URL(this.uxUrl);n.pathname=e;const a=p({authToken:this.authToken,value:t,configuration:r});return n.hash=a,this.nodeUrl&&n.searchParams.set("nodeUrl",this.nodeUrl),this.theme&&n.searchParams.set("theme",JSON.stringify(this.theme)),this.dictionary&&n.searchParams.set("dictionary",JSON.stringify(this.dictionary)),i&&(i.callback&&n.searchParams.set("callback_url",i.callback),i.redirectUri&&n.searchParams.set("redirect_uri",i.redirectUri)),n.toString()}createComponent(e,t,r,i){return new f(this.componentUrl(e,t,r,i),t)}createWithdrawalAssist(e,t,r){return this.createComponent("withdrawal-assist",e,t,r)}decodeFragmentToObject(e){return e.slice(1).split("&").reduce((r,i)=>{const[n,a]=i.split("=");return r[decodeURIComponent(n)]=decodeURIComponent(a),r},{})}}module.exports=E;
+"use strict";var d=Object.defineProperty;var u=(s,e,t)=>e in s?d(s,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):s[e]=t;var o=(s,e,t)=>u(s,typeof e!="symbol"?e+"":e,t);var h=(s=>(s.COMPLETE="complete",s.RESIZE="resize",s.RESULT="result",s.READY="ready",s.INVALID="invalid",s.MODAL="openModal",s.ERROR="error",s.CLOSE="closeModal",s.CANCEL="cancel",s))(h||{}),c=(s=>(s.UPDATE="update",s.REQUEST_RESPONSE="requestResponse",s))(c||{});class m{constructor(){o(this,"listeners",new Map);o(this,"port");this.handleMessage=this.handleMessage.bind(this)}setPort(e){this.port=e,this.port.onmessage=this.handleMessage,this.port.start()}on(e,t){this.listeners.has(e)||this.listeners.set(e,new Set),this.listeners.get(e).add(t)}off(e,t){const r=this.listeners.get(e);r&&(r.delete(t),r.size===0&&this.listeners.delete(e))}handleMessage(e){console.log("received message",e.data);const t=e.data;if(typeof t=="object"&&t!==null&&"type"in t){const r=t.type,n=this.listeners.get(r);n&&n.forEach(i=>i(t))}}send(e){this.port&&this.port.postMessage(e)}}class f{constructor(e,t){o(this,"_url");o(this,"_value");o(this,"_errors",[]);o(this,"iframe");o(this,"eventManager");o(this,"ready",!1);this._url=e,this._value=t,this.eventManager=new m,this.on(h.INVALID,r=>{r.type===h.INVALID&&(this._errors=r.errors,this._value=r.value)}),this.on(h.RESIZE,r=>{r.type===h.RESIZE&&this.iframe&&(this.iframe.style.height=`${r.height}px`)})}get url(){return this._url}get value(){return this._value}get errors(){return this._errors}open(){document.location.href=this.url}mount(e){var r,n;this.iframe=document.createElement("iframe"),this.iframe.src=this.url,this.iframe.style.width="100%",this.iframe.style.height="100px",this.iframe.style.border="none",this.iframe.style.overflow="hidden",window.addEventListener("message",i=>{var a,l;i.source===((a=this.iframe)==null?void 0:a.contentWindow)&&(console.log("received message from iframe",i.data),(l=this.eventManager)==null||l.setPort(i.ports[0]),this.ready=!0)});const t=document.querySelector(e);if(!t)throw new Error(`parentID ${e} not found`);t.appendChild(this.iframe),(n=(r=this.iframe)==null?void 0:r.contentWindow)==null||n.focus()}send(e){this.eventManager.send(e)}on(e,t){this.eventManager.on(e,t)}off(e,t){this.eventManager.off(e,t)}update(e){this._value=e,this.send({type:c.UPDATE,value:e})}completion(){return new Promise((e,t)=>{this.on(h.COMPLETE,r=>{e(r.response)}),this.on("error",r=>{t(new Error(r.message))})})}}function p(s){return Object.entries(s).map(([e,t])=>{if(!(e&&t))return;const r=encodeURIComponent(e),n=encodeURIComponent(typeof t=="object"?JSON.stringify(t):t);return`${r}=${n}`}).filter(e=>!!e).join("&")}class E{constructor(e){o(this,"nodeUrl");o(this,"authToken");o(this,"uxUrl");o(this,"theme");o(this,"locale");this.uxUrl=e.uxUrl||"https://connect.notabene.id",this.nodeUrl=e.nodeUrl,this.authToken=e.authToken,this.theme=e.theme,this.locale=e.locale}componentUrl(e,t,r,n){const i=new URL(this.uxUrl);i.pathname=e;const a=p({authToken:this.authToken,value:t,configuration:r});return i.hash=a,this.nodeUrl&&i.searchParams.set("nodeUrl",this.nodeUrl),this.theme&&i.searchParams.set("theme",JSON.stringify(this.theme)),this.locale&&i.searchParams.set("locale",this.locale),n&&(n.callback&&i.searchParams.set("callback_url",n.callback),n.redirectUri&&i.searchParams.set("redirect_uri",n.redirectUri)),i.toString()}createComponent(e,t,r,n){return new f(this.componentUrl(e,t,r,n),t)}createWithdrawalAssist(e,t,r){return this.createComponent("withdrawal-assist",e,t,r)}decodeFragmentToObject(e){return e.slice(1).split("&").reduce((r,n)=>{const[i,a]=n.split("=");return r[decodeURIComponent(i)]=decodeURIComponent(a),r},{})}}module.exports=E;

package/dist/notabene.d.ts

@@ -3,22 +3,38 @@
  * Address
  */
 declare type Address = {
-    addressType?: AddressTypeCode;
+    /** Identifies the nature of the address. */
+    addressType: AddressTypeCode;
+    /** Identification of a division of a large organisation or building. */
     department?: string;
+    /** Identification of a sub-division of a large organisation or building. */
     subDepartment?: string;
+    /** Name of a street or thoroughfare. */
     streetName?: string;
+    /** Number that identifies the position of a building on a street. */
     buildingNumber?: string;
+    /** Name of the building or house. */
     buildingName?: string;
+    /** Floor or storey within a building. */
     floor?: string;
+    /** Numbered box in a post office. */
     postBox?: string;
+    /** Building room number. */
     room?: string;
-    postCode?: string;
-    townName?: string;
+    /** Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. */
+    postcode?: string;
+    /** Name of a built-up area, with defined boundaries, and a local government. */
+    townName: string;
+    /** Specific location name within the town. */
     townLocationName?: string;
+    /** Identifies a subdivision within a country subdivision. */
     districtName?: string;
+    /** Identifies a subdivision of a country such as state, region, province. */
     countrySubDivision?: string;
+    /** Information that locates and identifies a specific address, presented in free format text. */
     addressLine?: string[];
-    country?: string;
+    /** Nation with its own government. */
+    country: string;
 };
 
 /**
@@ -243,10 +259,15 @@ export declare type IVMS101 = {
  * LegalPerson
  */
 declare type LegalPerson = {
-    name?: LegalPersonName;
+    /** The name of the legal person. */
+    name: LegalPersonName;
+    /** The address of the legal person. */
     geographicAddress?: Address[];
+    /** A distinct identifier that uniquely identifies the person to the institution in context. */
     customerNumber?: string;
+    /** A distinct identifier used by governments to uniquely identify a legal person. */
     nationalIdentification?: NationalIdentification;
+    /** The country in which the legal person is registered. */
     countryOfRegistration?: string;
 };
 
@@ -255,7 +276,7 @@ declare type LegalPerson = {
  * LegalPersonName
  */
 declare type LegalPersonName = {
-    nameIdentifier?: LegalPersonNameID[];
+    nameIdentifier: LegalPersonNameID[];
     localNameIdentifier?: LocalLegalPersonNameID[];
     phoneticNameIdentifier?: LocalLegalPersonNameID[];
 };
@@ -265,8 +286,10 @@ declare type LegalPersonName = {
  * LegalPersonNameID
  */
 declare type LegalPersonNameID = {
-    legalPersonName?: string;
-    legalPersonNameIdentifierType?: LegalPersonNameTypeCode;
+    /** Name by which the legal person is known. */
+    legalPersonName: string;
+    /** The nature of the name specified. */
+    legalPersonNameIdentifierType: LegalPersonNameTypeCode;
 };
 
 /**
@@ -350,11 +373,17 @@ declare type NationalIdentifierTypeCode = 'ARNU' | 'CCPT' | 'RAID' | 'DRLC' | 'F
  * NaturalPerson
  */
 declare type NaturalPerson = {
-    name?: NaturalPersonName[];
+    /** The distinct words used as identification for an individual. */
+    name: NaturalPersonName;
+    /** The particulars of a location at which a person may be communicated with. */
     geographicAddress?: Address[];
+    /** A distinct identifier used by governments to uniquely identify a natural person. */
     nationalIdentification?: NationalIdentification;
+    /** A distinct identifier that uniquely identifies the person to the institution in context. */
     customerIdentification?: string;
+    /** Date and place of birth of a person. */
     dateAndPlaceOfBirth?: DateAndPlaceOfBirth;
+    /** Country in which a person resides (the place of a person's home). */
     countryOfResidence?: string;
 };
 
@@ -400,7 +429,7 @@ declare class Notabene {
     private authToken?;
     private uxUrl;
     private theme?;
-    private dictionary?;
+    private locale?;
     constructor(config: NotabeneConfig);
     componentUrl(path: string, value: Partial<Transaction>, configuration?: any, callbacks?: CallbackOptions): string;
     createComponent(path: string, value: Partial<Transaction>, options?: any, callbacks?: CallbackOptions): EmbeddedComponent;
@@ -422,9 +451,7 @@ export declare interface NotabeneConfig {
     authToken?: string;
     uxUrl?: string;
     theme?: Theme;
-    dictionary?: {
-        [key: string]: string;
-    };
+    locale?: string;
 }
 
 /**
@@ -459,9 +486,22 @@ export declare interface OwnershipProof {
  * 6.7
  * Data describing the contents of the payload.
  */
-declare type PayloadMetadata = {
-    transferPath?: TransliterationMethodCode[];
-};
+declare interface PayloadMetadata {
+    /** The method used to map from a national system of writing to Latin script. */
+    transliterationMethod?: TransliterationMethodCode[];
+    /** The version of IVMS 101 to which the payload complies. */
+    payloadVersion: PayloadVersionCode;
+}
+
+/**
+ * The version of IVMS 101 to which the payload complies.
+ */
+declare enum PayloadVersionCode {
+    /** Published May 2020 */
+    V101 = "101",
+    /** Published August 2023 */
+    V101_2023 = "101.2023"
+}
 
 /**
  * 5.2.1

package/dist/notabene.js

@@ -1,8 +1,8 @@
-var l = Object.defineProperty;
-var u = (s, e, t) => e in s ? l(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
+var d = Object.defineProperty;
+var u = (s, e, t) => e in s ? d(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
 var o = (s, e, t) => u(s, typeof e != "symbol" ? e + "" : e, t);
 var h = /* @__PURE__ */ ((s) => (s.COMPLETE = "complete", s.RESIZE = "resize", s.RESULT = "result", s.READY = "ready", s.INVALID = "invalid", s.MODAL = "openModal", s.ERROR = "error", s.CLOSE = "closeModal", s.CANCEL = "cancel", s))(h || {}), c = /* @__PURE__ */ ((s) => (s.UPDATE = "update", s.REQUEST_RESPONSE = "requestResponse", s))(c || {});
-class f {
+class m {
   constructor() {
     o(this, "listeners", /* @__PURE__ */ new Map());
     o(this, "port");
@@ -22,18 +22,16 @@ class f {
     console.log("received message", e.data);
     const t = e.data;
     if (typeof t == "object" && t !== null && "type" in t) {
-      const r = t.type, i = this.listeners.get(r);
-      i && i.forEach((n) => n(t));
+      const r = t.type, n = this.listeners.get(r);
+      n && n.forEach((i) => i(t));
     }
   }
   // Method to send messages through the port
   send(e) {
-    if (!this.port)
-      throw new Error("No port set");
-    this.port.postMessage(e);
+    this.port && this.port.postMessage(e);
   }
 }
-class m {
+class f {
   constructor(e, t) {
     o(this, "_url");
     o(this, "_value");
@@ -41,7 +39,7 @@ class m {
     o(this, "iframe");
     o(this, "eventManager");
     o(this, "ready", !1);
-    this._url = e, this._value = t, this.eventManager = new f(), this.on(h.INVALID, (r) => {
+    this._url = e, this._value = t, this.eventManager = new m(), this.on(h.INVALID, (r) => {
       r.type === h.INVALID && (this._errors = r.errors, this._value = r.value);
     }), this.on(h.RESIZE, (r) => {
       r.type === h.RESIZE && this.iframe && (this.iframe.style.height = `${r.height}px`);
@@ -60,14 +58,14 @@ class m {
     document.location.href = this.url;
   }
   mount(e) {
-    var r, i;
-    this.iframe = document.createElement("iframe"), this.iframe.src = this.url, this.iframe.style.width = "100%", this.iframe.style.height = "100px", this.iframe.style.border = "none", this.iframe.style.overflow = "hidden", window.addEventListener("message", (n) => {
-      var a, d;
-      n.source === ((a = this.iframe) == null ? void 0 : a.contentWindow) && (console.log("received message from iframe", n.data), (d = this.eventManager) == null || d.setPort(n.ports[0]), this.ready = !0);
+    var r, n;
+    this.iframe = document.createElement("iframe"), this.iframe.src = this.url, this.iframe.style.width = "100%", this.iframe.style.height = "100px", this.iframe.style.border = "none", this.iframe.style.overflow = "hidden", window.addEventListener("message", (i) => {
+      var a, l;
+      i.source === ((a = this.iframe) == null ? void 0 : a.contentWindow) && (console.log("received message from iframe", i.data), (l = this.eventManager) == null || l.setPort(i.ports[0]), this.ready = !0);
     });
     const t = document.querySelector(e);
     if (!t) throw new Error(`parentID ${e} not found`);
-    t.appendChild(this.iframe), (i = (r = this.iframe) == null ? void 0 : r.contentWindow) == null || i.focus();
+    t.appendChild(this.iframe), (n = (r = this.iframe) == null ? void 0 : r.contentWindow) == null || n.focus();
   }
   send(e) {
     this.eventManager.send(e);
@@ -94,10 +92,10 @@ class m {
 function p(s) {
   return Object.entries(s).map(([e, t]) => {
     if (!(e && t)) return;
-    const r = encodeURIComponent(e), i = encodeURIComponent(
+    const r = encodeURIComponent(e), n = encodeURIComponent(
       typeof t == "object" ? JSON.stringify(t) : t
     );
-    return `${r}=${i}`;
+    return `${r}=${n}`;
   }).filter((e) => !!e).join("&");
 }
 class g {
@@ -106,22 +104,22 @@ class g {
     o(this, "authToken");
     o(this, "uxUrl");
     o(this, "theme");
-    o(this, "dictionary");
-    this.uxUrl = e.uxUrl || "https://connect.notabene.id", this.nodeUrl = e.nodeUrl, this.authToken = e.authToken, this.theme = e.theme, this.dictionary = e.dictionary;
+    o(this, "locale");
+    this.uxUrl = e.uxUrl || "https://connect.notabene.id", this.nodeUrl = e.nodeUrl, this.authToken = e.authToken, this.theme = e.theme, this.locale = e.locale;
   }
-  componentUrl(e, t, r, i) {
-    const n = new URL(this.uxUrl);
-    n.pathname = e;
+  componentUrl(e, t, r, n) {
+    const i = new URL(this.uxUrl);
+    i.pathname = e;
     const a = p({
       authToken: this.authToken,
       value: t,
       configuration: r
     });
-    return n.hash = a, this.nodeUrl && n.searchParams.set("nodeUrl", this.nodeUrl), this.theme && n.searchParams.set("theme", JSON.stringify(this.theme)), this.dictionary && n.searchParams.set("dictionary", JSON.stringify(this.dictionary)), i && (i.callback && n.searchParams.set("callback_url", i.callback), i.redirectUri && n.searchParams.set("redirect_uri", i.redirectUri)), n.toString();
+    return i.hash = a, this.nodeUrl && i.searchParams.set("nodeUrl", this.nodeUrl), this.theme && i.searchParams.set("theme", JSON.stringify(this.theme)), this.locale && i.searchParams.set("locale", this.locale), n && (n.callback && i.searchParams.set("callback_url", n.callback), n.redirectUri && i.searchParams.set("redirect_uri", n.redirectUri)), i.toString();
   }
-  createComponent(e, t, r, i) {
-    return new m(
-      this.componentUrl(e, t, r, i),
+  createComponent(e, t, r, n) {
+    return new f(
+      this.componentUrl(e, t, r, n),
       t
     );
   }
@@ -130,9 +128,9 @@ class g {
   }
   decodeFragmentToObject(e) {
     return e.slice(1).split("&").reduce(
-      (r, i) => {
-        const [n, a] = i.split("=");
-        return r[decodeURIComponent(n)] = decodeURIComponent(a), r;
+      (r, n) => {
+        const [i, a] = n.split("=");
+        return r[decodeURIComponent(i)] = decodeURIComponent(a), r;
       },
       {}
     );

package/package.json

@@ -9,7 +9,7 @@
   },
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
-  "version": "2.0.0-next.6",
+  "version": "2.0.0-next.7",
   "source": "src/notabene.ts",
   "main": "dist/notabene.js",
   "types": "dist/notabene.d.ts",

package/src/__tests__/notabene.test.ts

@@ -2,6 +2,7 @@ import { fc, test } from '@fast-check/vitest';
 import { describe } from 'vitest';
 import { abitraryCallbackOptions, arbitraryComponent } from '../arbitraries';
 import Notabene from '../notabene';
+import { arbitraryLocale } from '../utils/arbitraries';
 
 describe('Notabene', () => {
   describe('defaults', () => {
@@ -28,6 +29,33 @@ describe('Notabene', () => {
     );
   });
 
+  describe('locale', () => {
+    test.prop([
+      fc.string({ minLength: 3 }),
+      fc.webUrl(),
+      arbitraryComponent(),
+      fc.object(),
+      arbitraryLocale(),
+    ])(
+      'Should set the correct values',
+      (authToken, nodeUrl, component, value, locale) => {
+        const notabene = new Notabene({
+          nodeUrl,
+          authToken,
+          locale,
+        });
+        const url = new URL(notabene.componentUrl(component, value));
+        return (
+          url.hash ===
+            `#authToken=${encodeURIComponent(authToken)}&value=${encodeURIComponent(JSON.stringify(value))}` &&
+          url.searchParams.get('nodeUrl') === nodeUrl &&
+          url.searchParams.get('locale') === locale &&
+          url.pathname === `/${component}`
+        );
+      },
+    );
+  });
+
   describe('minimal', () => {
     test.prop([arbitraryComponent(), fc.object()])(
       'Should set the correct values',

package/src/ivms/types.ts

@@ -120,22 +120,38 @@ export type DateAndPlaceOfBirth = {
  * Address
  */
 export type Address = {
-  addressType?: AddressTypeCode;
-  department?: string; //Max50Text
-  subDepartment?: string; //Max70Text
-  streetName?: string; //Max70Text
-  buildingNumber?: string; //Max16Text
-  buildingName?: string; //Max35Text
-  floor?: string; //Max70Text
-  postBox?: string; //Max16Text
-  room?: string; //Max70Text
-  postCode?: string; //Max16Text
-  townName?: string; //Max35Text
-  townLocationName?: string; //Max35Text
-  districtName?: string; //Max35Text
-  countrySubDivision?: string; //Max35Text
-  addressLine?: string[]; //Max35Text max 7 items in array
-  country?: string; //CountryCode (^[A-Z]= {2}$)
+  /** Identifies the nature of the address. */
+  addressType: AddressTypeCode;
+  /** Identification of a division of a large organisation or building. */
+  department?: string;
+  /** Identification of a sub-division of a large organisation or building. */
+  subDepartment?: string;
+  /** Name of a street or thoroughfare. */
+  streetName?: string;
+  /** Number that identifies the position of a building on a street. */
+  buildingNumber?: string;
+  /** Name of the building or house. */
+  buildingName?: string;
+  /** Floor or storey within a building. */
+  floor?: string;
+  /** Numbered box in a post office. */
+  postBox?: string;
+  /** Building room number. */
+  room?: string;
+  /** Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. */
+  postcode?: string;
+  /** Name of a built-up area, with defined boundaries, and a local government. */
+  townName: string;
+  /** Specific location name within the town. */
+  townLocationName?: string;
+  /** Identifies a subdivision within a country subdivision. */
+  districtName?: string;
+  /** Identifies a subdivision of a country such as state, region, province. */
+  countrySubDivision?: string;
+  /** Information that locates and identifies a specific address, presented in free format text. */
+  addressLine?: string[];
+  /** Nation with its own government. */
+  country: string;
 };
 
 /**
@@ -173,12 +189,18 @@ export type NaturalPersonName = {
  * NaturalPerson
  */
 export type NaturalPerson = {
-  name?: NaturalPersonName[];
+  /** The distinct words used as identification for an individual. */
+  name: NaturalPersonName;
+  /** The particulars of a location at which a person may be communicated with. */
   geographicAddress?: Address[];
+  /** A distinct identifier used by governments to uniquely identify a natural person. */
   nationalIdentification?: NationalIdentification;
-  customerIdentification?: string; //Max50Text
+  /** A distinct identifier that uniquely identifies the person to the institution in context. */
+  customerIdentification?: string;
+  /** Date and place of birth of a person. */
   dateAndPlaceOfBirth?: DateAndPlaceOfBirth;
-  countryOfResidence?: string; //CountryCode (^[A-Z]{2}$)
+  /** Country in which a person resides (the place of a person's home). */
+  countryOfResidence?: string;
 };
 
 /**
@@ -195,8 +217,10 @@ export type LocalLegalPersonNameID = {
  * LegalPersonNameID
  */
 export type LegalPersonNameID = {
-  legalPersonName?: string; //Max100Text
-  legalPersonNameIdentifierType?: LegalPersonNameTypeCode;
+  /** Name by which the legal person is known. */
+  legalPersonName: string;
+  /** The nature of the name specified. */
+  legalPersonNameIdentifierType: LegalPersonNameTypeCode;
 };
 
 /**
@@ -204,7 +228,7 @@ export type LegalPersonNameID = {
  * LegalPersonName
  */
 export type LegalPersonName = {
-  nameIdentifier?: LegalPersonNameID[];
+  nameIdentifier: LegalPersonNameID[];
   localNameIdentifier?: LocalLegalPersonNameID[];
   phoneticNameIdentifier?: LocalLegalPersonNameID[];
 };
@@ -214,11 +238,16 @@ export type LegalPersonName = {
  * LegalPerson
  */
 export type LegalPerson = {
-  name?: LegalPersonName;
+  /** The name of the legal person. */
+  name: LegalPersonName;
+  /** The address of the legal person. */
   geographicAddress?: Address[];
-  customerNumber?: string; //Max50Text
+  /** A distinct identifier that uniquely identifies the person to the institution in context. */
+  customerNumber?: string;
+  /** A distinct identifier used by governments to uniquely identify a legal person. */
   nationalIdentification?: NationalIdentification;
-  countryOfRegistration?: string; //CountryCode (^[A-Z]{2}$);
+  /** The country in which the legal person is registered. */
+  countryOfRegistration?: string;
 };
 
 /**
@@ -285,9 +314,21 @@ export type TransferPath = {
  * 6.7
  * Data describing the contents of the payload.
  */
-export type PayloadMetadata = {
-  transferPath?: TransliterationMethodCode[];
-};
+export interface PayloadMetadata {
+  /** The method used to map from a national system of writing to Latin script. */
+  transliterationMethod?: TransliterationMethodCode[];
+  /** The version of IVMS 101 to which the payload complies. */
+  payloadVersion: PayloadVersionCode;
+}
+/**
+ * The version of IVMS 101 to which the payload complies.
+ */
+export enum PayloadVersionCode {
+  /** Published May 2020 */
+  V101 = '101',
+  /** Published August 2023 */
+  V101_2023 = '101.2023',
+}
 
 /**
  * IVMS101 definition

package/src/notabene.ts

@@ -66,7 +66,7 @@ export interface NotabeneConfig {
   authToken?: string;
   uxUrl?: string;
   theme?: Theme;
-  dictionary?: { [key: string]: string };
+  locale?: string;
 }
 
 /**
@@ -80,14 +80,14 @@ export default class Notabene {
   private authToken?: string;
   private uxUrl: string;
   private theme?: Theme;
-  private dictionary?: { [key: string]: string };
+  private locale?: string;
 
   constructor(config: NotabeneConfig) {
     this.uxUrl = config.uxUrl || 'https://connect.notabene.id';
     this.nodeUrl = config.nodeUrl;
     this.authToken = config.authToken;
     this.theme = config.theme;
-    this.dictionary = config.dictionary;
+    this.locale = config.locale;
   }
 
   public componentUrl(
@@ -110,8 +110,8 @@ export default class Notabene {
     if (this.theme) {
       url.searchParams.set('theme', JSON.stringify(this.theme));
     }
-    if (this.dictionary) {
-      url.searchParams.set('dictionary', JSON.stringify(this.dictionary));
+    if (this.locale) {
+      url.searchParams.set('locale', this.locale);
     }
     if (callbacks) {
       if (callbacks.callback)

package/src/utils/MessageEventManager.ts

@@ -47,9 +47,8 @@ export class MessageEventManager {
 
   // Method to send messages through the port
   send(message: HostMessage): void {
-    if (!this.port) {
-      throw new Error('No port set');
+    if (this.port) {
+      this.port.postMessage(message);
     }
-    this.port.postMessage(message);
   }
 }

package/src/utils/arbitraries.ts

@@ -7,6 +7,8 @@ import {
   CAIP2_MATCHER,
 } from './caip';
 
+const LOCALE = new RegExp(/^[a-z]{2}(-[A-Z]{2})?$/);
+
 // Arbitraries
 export const arbitraryCAIP10 = (): fc.Arbitrary<CAIP10> =>
   fc.stringMatching(CAIP10_MATCHER) as fc.Arbitrary<CAIP10>;
@@ -19,3 +21,6 @@ export const arbitraryCAIP19 = (): fc.Arbitrary<CAIP19> =>
 
 export const arbitraryCAIP220 = (): fc.Arbitrary<CAIP220> =>
   fc.stringMatching(CAIP220_MATCHER) as fc.Arbitrary<CAIP220>;
+
+export const arbitraryLocale = (): fc.Arbitrary<string> =>
+  fc.stringMatching(LOCALE) as fc.Arbitrary<string>;