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

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 c=(r,e,t)=>e in r?d(r,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):r[e]=t;var n=(r,e,t)=>c(r,typeof e!="symbol"?e+"":e,t);var h=(r=>(r.COMPLETE="complete",r.RESIZE="resize",r.RESULT="result",r.READY="ready",r.INVALID="invalid",r.MODAL="openModal",r.ERROR="error",r.CLOSE="closeModal",r.CANCEL="cancel",r))(h||{}),l=(r=>(r.UPDATE="update",r.REQUEST_RESPONSE="requestResponse",r))(l||{});class m{constructor(){n(this,"listeners",new Map);n(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 s=this.listeners.get(e);s&&(s.delete(t),s.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 s=t.type,o=this.listeners.get(s);o&&o.forEach(i=>i(t))}}send(e){this.port&&this.port.postMessage(e)}}class u{constructor(e,t){n(this,"_url");n(this,"_value");n(this,"_errors",[]);n(this,"iframe");n(this,"eventManager");n(this,"ready",!1);n(this,"modal");this._url=e,this._value=t,this.eventManager=new m,this.on(h.INVALID,s=>{s.type===h.INVALID&&(this._errors=s.errors,this._value=s.value)}),this.on(h.RESIZE,s=>{s.type===h.RESIZE&&this.iframe&&(this.iframe.style.height=`${s.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){const t=document.querySelector(e);if(!t)throw new Error(`parentID ${e} not found`);this.embed(t)}embed(e){var t,s;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",this.iframe.setAttribute("allowtransparency","true"),this.iframe.style.backgroundColor="transparent",e.appendChild(this.iframe),window.addEventListener("message",o=>{var i,a;o.source===((i=this.iframe)==null?void 0:i.contentWindow)&&(console.log("received message from iframe",o.data),(a=this.eventManager)==null||a.setPort(o.ports[0]),this.ready=!0)}),(s=(t=this.iframe)==null?void 0:t.contentWindow)==null||s.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:l.UPDATE,value:e})}completion(){return new Promise((e,t)=>{this.closeModal(),this.on(h.COMPLETE,s=>{e(s.response)}),this.on("error",s=>{t(new Error(s.message))})})}openModal(){this.modal&&this.closeModal(),this.modal=document.createElement("dialog"),document.body.appendChild(this.modal),this.embed(this.modal),this.modal.show(),this.modal.addEventListener("click",()=>{this.closeModal()})}closeModal(){var e;this.modal&&(console.log("closeModal"),(e=this.modal)==null||e.close(),this.modal.remove(),this.modal=void 0)}}function f(r){return Object.entries(r).map(([e,t])=>{if(!(e&&t))return;const s=encodeURIComponent(e),o=encodeURIComponent(typeof t=="object"?JSON.stringify(t):t);return`${s}=${o}`}).filter(e=>!!e).join("&")}class p{constructor(e){n(this,"nodeUrl");n(this,"authToken");n(this,"uxUrl");n(this,"theme");n(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,s,o){const i=new URL(this.uxUrl);i.pathname=e;const a=f({authToken:this.authToken,value:t,configuration:s});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),o&&(o.callback&&i.searchParams.set("callback_url",o.callback),o.redirectUri&&i.searchParams.set("redirect_uri",o.redirectUri)),i.toString()}createComponent(e,t,s,o){return new u(this.componentUrl(e,t,s,o),t)}createWithdrawalAssist(e,t,s){return this.createComponent("withdrawal-assist",e,t,s)}createDepositAssist(e,t,s){return this.createComponent("deposit-assist",e,t,s)}createConnect(e,t,s){return this.createComponent("connect",e,t,s)}createDepositRequest(e,t,s){return this.createComponent("deposit-request",e,t,s)}decodeFragmentToObject(e){return e.slice(1).split("&").reduce((s,o)=>{const[i,a]=o.split("=");return s[decodeURIComponent(i)]=decodeURIComponent(a),s},{})}}module.exports=p;

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;
 };
 
 /**
@@ -136,6 +152,8 @@ export declare interface Counterparty {
     verified?: boolean;
 }
 
+declare type CryptoCredential = `${string}.${string}.mastercard`;
+
 /**
  * 5.2.7
  * DateAndPlaceOfBirth
@@ -155,11 +173,29 @@ export declare interface DeclarationProof extends OwnershipProof {
     confirmed: boolean;
 }
 
+/**
+ * An object representing a deposit transaction
+ * @public
+ */
+export declare interface Deposit extends OriginatorFields, Transaction {
+}
+
+/**
+ * An object representing a request for a deposit
+ * @public
+ */
+export declare interface DepositRequest extends DepositRequestFields, Transaction {
+}
+
+declare type DepositRequestFields = {
+    destinations: destination[];
+};
+
 /**
  * The destination of a transaction either a blockchain address, a CAIP-19 address, or a travel address.
  * @public
  */
-export declare type destination = BlockchainAddress | CAIP10 | TravelAddress;
+export declare type destination = BlockchainAddress | CAIP10 | CryptoCredential | TravelAddress;
 
 declare type DID = `did:${string}:${string}`;
 
@@ -176,17 +212,21 @@ export declare class EmbeddedComponent {
     private iframe?;
     private eventManager;
     private ready;
+    private modal?;
     constructor(url: string, value: Partial<Transaction>);
     get url(): string;
     get value(): Partial<Transaction>;
     get errors(): ValidationError[];
     open(): void;
     mount(parentId: string): void;
+    embed(parent: Element): void;
     send(message: HostMessage): void;
     on(messageType: string, callback: MessageCallback): void;
     off(messageType: string, callback: MessageCallback): void;
     update(value: Partial<Transaction>): void;
     completion(): Promise<TransactionResponse>;
+    openModal(): void;
+    private closeModal;
 }
 
 declare type Error_2 = {
@@ -243,10 +283,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 +300,7 @@ declare type LegalPerson = {
  * LegalPersonName
  */
 declare type LegalPersonName = {
-    nameIdentifier?: LegalPersonNameID[];
+    nameIdentifier: LegalPersonNameID[];
     localNameIdentifier?: LocalLegalPersonNameID[];
     phoneticNameIdentifier?: LocalLegalPersonNameID[];
 };
@@ -265,8 +310,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 +397,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,11 +453,14 @@ 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;
-    createWithdrawalAssist(value: Partial<Withdrawal>, options?: any, callbacks?: CallbackOptions): EmbeddedComponent;
+    componentUrl(path: string, value: Partial<Transaction>, configuration?: TransactionOptions, callbacks?: CallbackOptions): string;
+    createComponent(path: string, value: Partial<Transaction>, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent;
+    createWithdrawalAssist(value: Partial<Withdrawal>, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent;
+    createDepositAssist(value: Partial<Deposit>, options?: any, callbacks?: CallbackOptions): EmbeddedComponent;
+    createConnect(value: Partial<Withdrawal>, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent;
+    createDepositRequest(value: Partial<DepositRequest>, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent;
     decodeFragmentToObject(fragment: string): Record<string, string>;
 }
 export { Notabene }
@@ -422,9 +478,7 @@ export declare interface NotabeneConfig {
     authToken?: string;
     uxUrl?: string;
     theme?: Theme;
-    dictionary?: {
-        [key: string]: string;
-    };
+    locale?: string;
 }
 
 /**
@@ -444,6 +498,10 @@ declare type Originator = {
     accountNumber?: string[];
 };
 
+declare type OriginatorFields = {
+    source?: Source;
+};
+
 /**
  * Ownership Proof
  * @public
@@ -459,9 +517,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
@@ -549,6 +620,8 @@ export declare interface SignatureProof extends OwnershipProof {
     wallet_provider: string;
 }
 
+declare type Source = BlockchainAddress | CAIP10;
+
 /**
  * The verification status of a transaction
  * @public
@@ -595,6 +668,15 @@ export declare interface Transaction {
  */
 export declare type TransactionAsset = NotabeneAsset | CAIP19 | DTI;
 
+/**
+ * Configuration options for Transaction components
+ * @public
+ */
+export declare interface TransactionOptions {
+    microTransactionAddress?: BlockchainAddress;
+    proofFallbacks?: ProofTypes[];
+}
+
 /**
  * The response of a transaction
  * @public
@@ -606,6 +688,7 @@ export declare type TransactionResponse = {
     valid: boolean;
     status: Status;
     errors: ValidationError[];
+    txCreate?: V1Transaction;
 };
 
 /**
@@ -636,7 +719,7 @@ declare type TransferPath = {
  */
 declare type TransliterationMethodCode = 'arab' | 'aran' | 'armn' | 'cyrl' | 'deva' | 'geor' | 'grek' | 'hani' | 'hebr' | 'kana' | 'kore' | 'thai' | 'othr';
 
-declare type TravelAddress = string;
+declare type TravelAddress = `ta${string}`;
 
 declare type UpdateValue = {
     type: HMType.UPDATE;
@@ -645,6 +728,25 @@ declare type UpdateValue = {
 
 declare type URI = string;
 
+declare type V1Asset = {
+    caip19: CAIP19;
+} | string;
+
+/**
+ * Transaction payload suitable for calling Notabene v1 tx/create
+ * @public
+ */
+declare type V1Transaction = {
+    transactionAsset: V1Asset;
+    transactionAmount: string;
+    originatorEqualsBeneficiary?: boolean;
+    originatorVASPdid: DID;
+    beneficiaryVASPdid: DID;
+    beneficiaryProof: OwnershipProof;
+    originator: Originator;
+    beneficiary: Beneficiary;
+};
+
 declare type ValidationError = {
     attribute: string;
     message: string;