@notabene/javascript-sdk 2.9.3 → 2.10.0-next.4

package/README.md

@@ -303,6 +303,10 @@ const withdrawal = notabene.createWithdrawalAssist({
     currency: 'USD', // ISO currency code
     price: 1700.12, // Asset price
   },
+  customer: {
+    name: 'John Smith',
+    email: "john.smith@domain.com",
+  },
 });
 ```
 
@@ -312,6 +316,7 @@ const withdrawal = notabene.createWithdrawalAssist({
 - `destination`: The destination or blockchain address for the withdrawal. See [Destination](#destination)
 - `amountDecimal`: The amount to transfer in decimal format. See [Transaction Amount](#transaction-amount)
 - `assetPrice`: Optional price information in a fiat currency. See [Asset Price](#asset-price)
+- `customer`: Optional Customer object containing their name and email
 
 If any of the required parameters are missing the component will just show the Notabene badge.
 
@@ -329,6 +334,10 @@ const withdrawal = notabene.createWithdrawalAssist(
       currency: 'USD', // ISO currency code
       price: 1700.12, // Asset price
     },
+    customer: {
+      name: 'John Smith',
+      email: "john.smith@domain.com",
+    },
   },
   {
     proofs: {
@@ -348,6 +357,10 @@ See [Transaction Options](#transaction-options)
 
 The Connect Wallet component helps you collect and verify the address of your users self-hosted wallet in one go.
 
+### Parameters
+
+- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
+
 ```js
 const connect = notabene.createConnectWallet({
   asset: 'ETH',
@@ -356,31 +369,6 @@ const connect = notabene.createConnectWallet({
 const { proof, txCreate } = await connect.openModal();
 ```
 
-### Parameters
-
-- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
-
-### Configuration Options
-
-Include configuration Options as a second optional parameter:
-
-```js
-const connect = notabene.createConnectWallet(
-  {
-    asset: 'ETH',
-  },
-  {
-    proofs: {
-      microTransfer: {
-        destination: '0x...',
-        amountSubunits: '12344',
-        timeout: 86440,
-      },
-    },
-  },
-);
-```
-
 ## Deposit Request
 
 The Deposit Request lets your customers request deposits that are fully Travel Rule compliant.
@@ -720,6 +708,7 @@ import Notabene, {
 } from '@notabene/javascript-sdk';
 
 const options: TransactionOptions = {
+  jurisdiction: "US", // Defaults to the jurisdiction associated with customer token
   proofs: {
     reuseProof: true, // Defaults true
     microTransfer: {
@@ -920,9 +909,13 @@ The two options are:
 
 ### Counterparty Field Properties
 
-The fields requested from a customer about a counterparty can be configured with the fields object. You can configure required and optional fields individually for both natural and legal persons.
+By default, counterparty fields are determined based on the rules of the jurisdiction associated with the VASP using the component. This ensures compliance even when fields are not explicitly configured.
 
-We recommend working closely with your compliance team for this. Bearing in mind that different jurisdictions have different rules.
+If a specific jurisdiction is manually configured, the component will instead derive the fields according to that jurisdiction’s rules.
+
+For VASPs seeking more granular control over the fields displayed to customers about counterparties, the fields object can be used to customize visibility. Required and optional fields can be configured independently for both natural and legal persons.
+
+We recommend working closely with your compliance team when making these configurations, as regulatory requirements vary significantly across jurisdictions.
 
 Each field can be configured like this:
 
@@ -968,8 +961,8 @@ const options: TransactionOptions = {
     },
     legalPerson: {
       name: true, // Default true
-      lei: true, // Default true
-      website: { optional: true }, // Default true
+      lei: {optional: true }, // Default optional
+      website: { optional: true }, // Default optional
       email: true,
       phone: true,
       geographicAddress: false,

package/dist/cjs/notabene.cjs

@@ -1 +1 @@
-"use strict";var U=Object.defineProperty;var _=(t,e,n)=>e in t?U(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n;var a=(t,e,n)=>_(t,typeof e!="symbol"?e+"":e,n);Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});var f=(t=>(t.PRIVATE="WALLET",t.VASP="VASP",t))(f||{}),w=(t=>(t.NATURAL="natural",t.LEGAL="legal",t.SELF="self",t))(w||{}),g=(t=>(t.EMPTY="empty",t.VERIFY="verify",t.PENDING="pending",t.VERIFIED="verified",t.BANNED="banned",t))(g||{}),v=(t=>(t.ALLOWED="allowed",t.PENDING="pending",t))(v||{}),y=(t=>(t.ASSET="asset",t.DESTINATION="destination",t.COUNTERPARTY="counterparty",t.AGENT="agent",t))(y||{}),l=(t=>(t.COMPLETE="complete",t.RESIZE="resize",t.RESULT="result",t.READY="ready",t.INVALID="invalid",t.ERROR="error",t.CANCEL="cancel",t))(l||{}),A=(t=>(t.SERVICE_UNAVAILABLE="SERVICE_UNAVAILABLE",t.WALLET_CONNECTION_FAILED="WALLET_CONNECTION_FAILED",t.WALLET_NOT_SUPPORTED="WALLET_NOT_SUPPORTED",t.TOKEN_INVALID="TOKEN_INVALID",t))(A||{}),p=(t=>(t.UPDATE="update",t.REQUEST_RESPONSE="requestResponse",t))(p||{}),C=(t=>(t.PENDING="pending",t.FAILED="rejected",t.FLAGGED="flagged",t.VERIFIED="verified",t))(C||{}),b=(t=>(t.SelfDeclaration="self-declaration",t.SIWE="siwe",t.SIWX="siwx",t.EIP191="eip-191",t.EIP712="eip-712",t.EIP1271="eip-1271",t.BIP137="bip-137",t.BIP322="bip-322",t.BIP137_XPUB="xpub",t.TIP191="tip-191",t.ED25519="ed25519",t.XRP_ED25519="xrp-ed25519",t.XLM_ED25519="xlm-ed25519",t.CIP8="cip-8",t.MicroTransfer="microtransfer",t.Screenshot="screenshot",t.Connect="connect",t))(b||{});class R{constructor(){a(this,"listeners",new Map);a(this,"port");this.handleMessage=this.handleMessage.bind(this)}setPort(e){this.port=e,this.port.onmessage=this.handleMessage,this.port.start()}on(e,n){return this.listeners.has(e)||this.listeners.set(e,new Set),this.listeners.get(e).add(n),()=>this.off(e,n)}off(e,n){const r=this.listeners.get(e);r&&(r.delete(n),r.size===0&&this.listeners.delete(e))}handleMessage(e){const n=e.data;if(typeof n=="object"&&n!==null&&"type"in n){const r=n.type,s=this.listeners.get(r);s&&s.forEach(i=>i(n))}}send(e){this.port&&this.port.postMessage(e)}}class I{constructor(e,n,r){a(this,"_url");a(this,"_value");a(this,"_options");a(this,"_errors",[]);a(this,"iframe");a(this,"eventManager");a(this,"modal");this._url=e,this._value=n,this._options=r,this.eventManager=new R,this.on(l.INVALID,s=>{s.type===l.INVALID&&(this._errors=s.errors,this._value=s.value)}),this.on(l.RESIZE,s=>{s.type===l.RESIZE&&this.iframe&&(this.iframe.style.height=`${s.height}px`)})}get url(){return this._url}get value(){return this._value}get options(){return this._options}get errors(){return this._errors}open(){document.location.href=this.url}mount(e){const n=document.querySelector(e);if(!n)throw new Error(`parentID ${e} not found`);this.embed(n)}embed(e,n=!1){var r,s;this.removeEmbed(),this.iframe=document.createElement("iframe"),this.iframe.src=this.url+(n?"":"&embedded=true"),this.iframe.allow="web-share; clipboard-write; hid; bluetooth;",this.iframe.style.width="100%",this.iframe.style.height="0px",this.iframe.style.border="none",this.iframe.style.overflow="hidden",this.iframe.scrolling="no",e.appendChild(this.iframe),window.addEventListener("message",i=>{var o,c;i.source===((o=this.iframe)==null?void 0:o.contentWindow)&&((c=this.eventManager)==null||c.setPort(i.ports[0]))}),(s=(r=this.iframe)==null?void 0:r.contentWindow)==null||s.focus()}removeEmbed(){this.iframe&&this.iframe.remove()}send(e){this.eventManager.send(e)}on(e,n){return this.eventManager.on(e,n)}off(e,n){this.eventManager.off(e,n)}update(e,n){this._value=e,n&&(this._options=n),this.send({type:p.UPDATE,value:e,options:this._options})}completion(){return new Promise((e,n)=>{let r,s,i;function o(){r&&r(),s&&s(),i&&i()}r=this.on(l.COMPLETE,c=>{e(c.response),o()}),s=this.on(l.CANCEL,()=>{n(new Error("User cancelled")),o()}),i=this.on("error",c=>{n(new Error(c.message)),o()})})}async openModal(){this.modal&&this.closeModal(),this.modal=document.createElement("dialog"),this.modal.style.border="none",this.modal.style.backgroundColor="white",this.modal.style.maxWidth="100vw",this.modal.style.maxHeight="100vh",this.modal.style.width="600px",this.modal.style.height="600px",document.body.appendChild(this.modal),this.embed(this.modal,!0);const e=this.on(l.CANCEL,()=>{this.closeModal()}),n=this.on(l.COMPLETE,()=>{this.closeModal()});return this.modal.showModal(),this.modal.addEventListener("click",()=>{this.closeModal()}),this.completion().finally(()=>{e(),n()})}closeModal(){var e;this.modal&&((e=this.modal)==null||e.close(),this.modal.remove(),this.modal=void 0)}async popup(){const e=window.open(this.url,"_blank","popup=true,width=600,height=600");window.addEventListener("message",s=>{var i;s.source===e&&(console.log("received message from popup",s.data),(i=this.eventManager)==null||i.setPort(s.ports[0]))});const n=this.on(l.CANCEL,()=>{e==null||e.close()}),r=this.on(l.COMPLETE,()=>{e==null||e.close()});return this.completion().finally(()=>{n(),r()})}}function x(t){return Object.entries(t).map(([e,n])=>{if(n==null)return;const r=encodeURIComponent(e),s=encodeURIComponent(typeof n=="object"?JSON.stringify(n):String(n));return`${r}=${s}`}).filter(e=>e!==void 0).join("&")}function D(t){const e=t.slice(1);return e?e.split("&").filter(Boolean).reduce((r,s)=>{const[i,o]=s.split("=");return i&&(r[decodeURIComponent(i)]=o?decodeURIComponent(o):""),r},{}):{}}async function E(t,e){const n=JSON.stringify(t),r=new TextEncoder,s=e?m(e):crypto.getRandomValues(new Uint8Array(32)),i=await crypto.subtle.importKey("raw",s,{name:"AES-GCM"},!1,["encrypt"]),o=crypto.getRandomValues(new Uint8Array(12)),c=await crypto.subtle.encrypt({name:"AES-GCM",iv:o},i,r.encode(n));return{ciphertext:`${u(o)}-${u(c)}`,key:u(s)}}async function L({ciphertext:t,key:e}){const[n,r]=t.split("-"),s=new Uint8Array(atob(e).split("").map(N=>N.charCodeAt(0))),i=m(n),o=m(r),c=await crypto.subtle.importKey("raw",s,{name:"AES-GCM"},!1,["decrypt"]),d=new TextDecoder,h=await crypto.subtle.decrypt({name:"AES-GCM",iv:new Uint8Array(i)},c,o);return JSON.parse(d.decode(h))}function u(t){const e=new Uint8Array(t);let n="";for(let r=0;r<e.length;r++)n+=String.fromCharCode(e[r]);return btoa(n)}function m(t){const e=atob(t),n=new Uint8Array(e.length);for(let r=0;r<e.length;r++)n[r]=e.charCodeAt(r);return n}async function S(t){const e=await fetch(t.url,{method:"GET"});if(!e.ok)throw new Error(`Failed to get connection: ${await e.text()}`);const n=await e.json();if(!n.id||!n.metadata||!n.status||!n.sealed)throw new Error("Data missing from server response");const r={id:n.id,metadata:n.metadata,status:n.status};if(n.status==="closed")return r;const s=n.sealed[n.sealed.length-1],i=await L({ciphertext:s,key:t.key});return n.status==="completed"?{...r,result:i.result}:{...r,tx:i.tx}}class M{constructor(e){a(this,"endpoint");this.endpoint=e}async create(e,n){const r=await E(e),s={metadata:n,sealed:r.ciphertext},i=await fetch(this.endpoint,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(s)});if(!i.ok)throw new Error(`Failed to create connection: ${await i.text()}`);const o=await i.json();return{id:o.id,version:o.version,status:o.status,metadata:n,data:e,key:r.key}}async update(e,n,r,s,i){const o=await E(n,i),c={sealed:o.ciphertext,version:r,status:s},d=await fetch(`${this.endpoint}/${e}`,{method:"PATCH",headers:{"Content-Type":"application/json"},body:JSON.stringify(c)});if(!d.ok)throw new Error(`Failed to update connection: ${await d.text()}`);const h=await d.json();return{id:h.id,metadata:h.metadata,version:h.version,status:h.status,data:n,key:o.key}}async get(e,n){const r=await fetch(`${this.endpoint}/${e}`,{method:"GET"});if(!r.ok)throw new Error(`Failed to get connection: ${await r.text()}`);const s=await r.json(),i=s.sealed[s.sealed.length-1],o=await L({ciphertext:i,key:n});return{id:s.id,status:s.status,version:s.version,metadata:s.metadata,data:o,key:n}}async close(e){const n=await fetch(`${this.endpoint}/${e}`,{method:"DELETE"});if(!n.ok)throw new Error(`Failed to close connection: ${await n.text()}`)}}class O{constructor(e){a(this,"nodeUrl");a(this,"authToken");a(this,"uxUrl");a(this,"theme");a(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,n,r,s){const i=new URL(this.uxUrl);i.pathname=e;const o=x({authToken:this.authToken,value:n,configuration:r});return i.hash=o,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),s&&(s.callback&&i.searchParams.set("callback_url",s.callback),s.redirectUri&&i.searchParams.set("redirect_uri",s.redirectUri)),i.toString()}createComponent(e,n,r,s){return new I(this.componentUrl(e,n,r,s),n,r)}createWithdrawalAssist(e,n,r){return this.createComponent("withdrawal-assist",e,n,r)}createConnectWallet(e,n,r){return this.createComponent("connect",e,n,r)}createDepositRequest(e,n,r){return this.createComponent("deposit-request",e,n,r)}createDepositAssist(e,n,r){return this.createComponent("deposit-assist",e,n,r)}}exports.AgentType=f;exports.CMType=l;exports.ConnectionManager=M;exports.EmbeddedComponent=I;exports.ErrorIdentifierCode=A;exports.HMType=p;exports.PersonType=w;exports.ProofStatus=C;exports.ProofTypes=b;exports.Status=g;exports.VASPSearchControl=v;exports.ValidationSections=y;exports.decodeFragmentToObject=D;exports.default=O;exports.getRefreshResult=S;
+"use strict";var U=Object.defineProperty;var R=(t,e,n)=>e in t?U(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n;var a=(t,e,n)=>R(t,typeof e!="symbol"?e+"":e,n);Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});var f=(t=>(t.PRIVATE="WALLET",t.VASP="VASP",t))(f||{}),w=(t=>(t.NATURAL="natural",t.LEGAL="legal",t.SELF="self",t))(w||{}),g=(t=>(t.EMPTY="empty",t.VERIFY="verify",t.PENDING="pending",t.VERIFIED="verified",t.BANNED="banned",t))(g||{}),v=(t=>(t.ALLOWED="allowed",t.PENDING="pending",t))(v||{}),A=(t=>(t.ASSET="asset",t.DESTINATION="destination",t.COUNTERPARTY="counterparty",t.AGENT="agent",t))(A||{}),l=(t=>(t.COMPLETE="complete",t.RESIZE="resize",t.RESULT="result",t.READY="ready",t.INVALID="invalid",t.ERROR="error",t.CANCEL="cancel",t.WARNING="warning",t.INFO="info",t))(l||{}),y=(t=>(t.SERVICE_UNAVAILABLE="SERVICE_UNAVAILABLE",t.WALLET_CONNECTION_FAILED="WALLET_CONNECTION_FAILED",t.WALLET_NOT_SUPPORTED="WALLET_NOT_SUPPORTED",t.TOKEN_INVALID="TOKEN_INVALID",t))(y||{}),p=(t=>(t.UPDATE="update",t.REQUEST_RESPONSE="requestResponse",t))(p||{}),C=(t=>(t.PENDING="pending",t.FAILED="rejected",t.FLAGGED="flagged",t.VERIFIED="verified",t))(C||{}),I=(t=>(t.SelfDeclaration="self-declaration",t.SIWE="siwe",t.SIWX="siwx",t.EIP191="eip-191",t.EIP712="eip-712",t.EIP1271="eip-1271",t.BIP137="bip-137",t.BIP322="bip-322",t.BIP137_XPUB="xpub",t.TIP191="tip-191",t.ED25519="ed25519",t.XRP_ED25519="xrp-ed25519",t.XLM_ED25519="xlm-ed25519",t.CIP8="cip-8",t.MicroTransfer="microtransfer",t.Screenshot="screenshot",t.Connect="connect",t.CONCORDIUM="concordium",t))(I||{});class _{constructor(){a(this,"listeners",new Map);a(this,"port");this.handleMessage=this.handleMessage.bind(this)}setPort(e){this.port=e,this.port.onmessage=this.handleMessage,this.port.start()}on(e,n){return this.listeners.has(e)||this.listeners.set(e,new Set),this.listeners.get(e).add(n),()=>this.off(e,n)}off(e,n){const r=this.listeners.get(e);r&&(r.delete(n),r.size===0&&this.listeners.delete(e))}handleMessage(e){const n=e.data;if(typeof n=="object"&&n!==null&&"type"in n){const r=n.type,s=this.listeners.get(r);s&&s.forEach(i=>i(n))}}send(e){this.port&&this.port.postMessage(e)}}class b{constructor(e,n,r){a(this,"_url");a(this,"_value");a(this,"_options");a(this,"_errors",[]);a(this,"iframe");a(this,"eventManager");a(this,"modal");this._url=e,this._value=n,this._options=r,this.eventManager=new _,this.on(l.INVALID,s=>{s.type===l.INVALID&&(this._errors=s.errors,this._value=s.value)}),this.on(l.RESIZE,s=>{s.type===l.RESIZE&&this.iframe&&(this.iframe.style.height=`${s.height}px`)})}get url(){return this._url}get value(){return this._value}get options(){return this._options}get errors(){return this._errors}open(){document.location.href=this.url}mount(e){const n=document.querySelector(e);if(!n)throw new Error(`parentID ${e} not found`);this.embed(n)}embed(e,n=!1){var r,s;this.removeEmbed(),this.iframe=document.createElement("iframe"),this.iframe.src=this.url+(n?"":"&embedded=true"),this.iframe.allow="web-share; clipboard-write; hid; bluetooth;",this.iframe.style.width="100%",this.iframe.style.height="0px",this.iframe.style.border="none",this.iframe.style.overflow="hidden",this.iframe.scrolling="no",e.appendChild(this.iframe),window.addEventListener("message",i=>{var o,c;i.source===((o=this.iframe)==null?void 0:o.contentWindow)&&((c=this.eventManager)==null||c.setPort(i.ports[0]))}),(s=(r=this.iframe)==null?void 0:r.contentWindow)==null||s.focus()}removeEmbed(){this.iframe&&this.iframe.remove()}send(e){this.eventManager.send(e)}on(e,n){return this.eventManager.on(e,n)}off(e,n){this.eventManager.off(e,n)}update(e,n){this._value=e,n&&(this._options=n),this.send({type:p.UPDATE,value:e,options:this._options})}completion(){return new Promise((e,n)=>{let r,s,i;function o(){r&&r(),s&&s(),i&&i()}r=this.on(l.COMPLETE,c=>{e(c.response),o()}),s=this.on(l.CANCEL,()=>{n(new Error("User cancelled")),o()}),i=this.on("error",c=>{n(new Error(c.message)),o()})})}async openModal(){this.modal&&this.closeModal(),this.modal=document.createElement("dialog"),this.modal.style.border="none",this.modal.style.backgroundColor="white",this.modal.style.maxWidth="100vw",this.modal.style.maxHeight="100vh",this.modal.style.width="600px",this.modal.style.height="600px",document.body.appendChild(this.modal),this.embed(this.modal,!0);const e=this.on(l.CANCEL,()=>{this.closeModal()}),n=this.on(l.COMPLETE,()=>{this.closeModal()});return this.modal.showModal(),this.modal.addEventListener("click",()=>{this.closeModal()}),this.completion().finally(()=>{e(),n()})}closeModal(){var e;this.modal&&((e=this.modal)==null||e.close(),this.modal.remove(),this.modal=void 0)}async popup(){const e=window.open(this.url,"_blank","popup=true,width=600,height=600");window.addEventListener("message",s=>{var i;s.source===e&&(console.log("received message from popup",s.data),(i=this.eventManager)==null||i.setPort(s.ports[0]))});const n=this.on(l.CANCEL,()=>{e==null||e.close()}),r=this.on(l.COMPLETE,()=>{e==null||e.close()});return this.completion().finally(()=>{n(),r()})}}function O(t){return Object.entries(t).map(([e,n])=>{if(n==null)return;const r=encodeURIComponent(e),s=encodeURIComponent(typeof n=="object"?JSON.stringify(n):String(n));return`${r}=${s}`}).filter(e=>e!==void 0).join("&")}function D(t){const e=t.slice(1);return e?e.split("&").filter(Boolean).reduce((r,s)=>{const[i,o]=s.split("=");return i&&(r[decodeURIComponent(i)]=o?decodeURIComponent(o):""),r},{}):{}}async function E(t,e){const n=JSON.stringify(t),r=new TextEncoder,s=e?m(e):crypto.getRandomValues(new Uint8Array(32)),i=await crypto.subtle.importKey("raw",s,{name:"AES-GCM"},!1,["encrypt"]),o=crypto.getRandomValues(new Uint8Array(12)),c=await crypto.subtle.encrypt({name:"AES-GCM",iv:o},i,r.encode(n));return{ciphertext:`${u(o)}-${u(c)}`,key:u(s)}}async function N({ciphertext:t,key:e}){const[n,r]=t.split("-"),s=new Uint8Array(atob(e).split("").map(L=>L.charCodeAt(0))),i=m(n),o=m(r),c=await crypto.subtle.importKey("raw",s,{name:"AES-GCM"},!1,["decrypt"]),d=new TextDecoder,h=await crypto.subtle.decrypt({name:"AES-GCM",iv:new Uint8Array(i)},c,o);return JSON.parse(d.decode(h))}function u(t){const e=new Uint8Array(t);let n="";for(let r=0;r<e.length;r++)n+=String.fromCharCode(e[r]);return btoa(n)}function m(t){const e=atob(t),n=new Uint8Array(e.length);for(let r=0;r<e.length;r++)n[r]=e.charCodeAt(r);return n}async function x(t){const e=await fetch(t.url,{method:"GET"});if(!e.ok)throw new Error(`Failed to get connection: ${await e.text()}`);const n=await e.json();if(!n.id||!n.metadata||!n.status||!n.sealed)throw new Error("Data missing from server response");const r={id:n.id,metadata:n.metadata,status:n.status};if(n.status==="closed")return r;const s=n.sealed[n.sealed.length-1],i=await N({ciphertext:s,key:t.key});return n.status==="completed"?{...r,result:i.result}:{...r,tx:i.tx}}class S{constructor(e){a(this,"endpoint");this.endpoint=e}async create(e,n){const r=await E(e),s={metadata:n,sealed:r.ciphertext},i=await fetch(this.endpoint,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(s)});if(!i.ok)throw new Error(`Failed to create connection: ${await i.text()}`);const o=await i.json();return{id:o.id,version:o.version,status:o.status,metadata:n,data:e,key:r.key}}async update(e,n,r,s,i){const o=await E(n,i),c={sealed:o.ciphertext,version:r,status:s},d=await fetch(`${this.endpoint}/${e}`,{method:"PATCH",headers:{"Content-Type":"application/json"},body:JSON.stringify(c)});if(!d.ok)throw new Error(`Failed to update connection: ${await d.text()}`);const h=await d.json();return{id:h.id,metadata:h.metadata,version:h.version,status:h.status,data:n,key:o.key}}async get(e,n){const r=await fetch(`${this.endpoint}/${e}`,{method:"GET"});if(!r.ok)throw new Error(`Failed to get connection: ${await r.text()}`);const s=await r.json(),i=s.sealed[s.sealed.length-1],o=await N({ciphertext:i,key:n});return{id:s.id,status:s.status,version:s.version,metadata:s.metadata,data:o,key:n}}async close(e){const n=await fetch(`${this.endpoint}/${e}`,{method:"DELETE"});if(!n.ok)throw new Error(`Failed to close connection: ${await n.text()}`)}}class M{constructor(e){a(this,"nodeUrl");a(this,"authToken");a(this,"uxUrl");a(this,"theme");a(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,n,r,s){const i=new URL(this.uxUrl);i.pathname=e;const o=O({authToken:this.authToken,value:n,configuration:r});return i.hash=o,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),s&&(s.callback&&i.searchParams.set("callback_url",s.callback),s.redirectUri&&i.searchParams.set("redirect_uri",s.redirectUri)),i.toString()}createComponent(e,n,r,s){return new b(this.componentUrl(e,n,r,s),n,r)}createWithdrawalAssist(e,n,r){return this.createComponent("withdrawal-assist",e,n,r)}createConnectWallet(e,n,r){return this.createComponent("connect",e,n,r)}createDepositRequest(e,n,r){return this.createComponent("deposit-request",e,n,r)}createDepositAssist(e,n,r){return this.createComponent("deposit-assist",e,n,r)}}exports.AgentType=f;exports.CMType=l;exports.ConnectionManager=S;exports.EmbeddedComponent=b;exports.ErrorIdentifierCode=y;exports.HMType=p;exports.PersonType=w;exports.ProofStatus=C;exports.ProofTypes=I;exports.Status=g;exports.VASPSearchControl=v;exports.ValidationSections=A;exports.decodeFragmentToObject=D;exports.default=M;exports.getRefreshResult=x;

package/dist/cjs/notabene.d.ts

@@ -218,7 +218,9 @@ export declare enum CMType {
     READY = "ready",
     INVALID = "invalid",
     ERROR = "error",
-    CANCEL = "cancel"
+    CANCEL = "cancel",
+    WARNING = "warning",
+    INFO = "info"
 }
 
 /**
@@ -249,11 +251,14 @@ export declare type Completed<T> = {
  * @see {@link Completed} For successful completion message format
  * @see {@link Cancel} For cancellation message format
  * @see {@link Error} For error message format
+ * @see {@link Ready} For ready message format
  * @see {@link ResizeRequest} For resize message format
  * @see {@link InvalidValue} For validation failure message format
+ * @see {@link Warning} For warning message format
+ * @see {@link Info} For info message format
  * @public
  */
-export declare type ComponentMessage<T> = Completed<T> | Cancel | Error_2 | Ready | ResizeRequest | InvalidValue<T>;
+export declare type ComponentMessage<T> = Completed<T> | Cancel | Error_2 | Ready | ResizeRequest | InvalidValue<T> | Warning | Info;
 
 /**
  * Base interface for requests sent to SDK components
@@ -303,10 +308,10 @@ export declare interface ComponentResponse {
 }
 
 export declare interface ConnectionData<T extends ComponentRequest> {
-    tx: T;
-    authToken?: string;
-    txOptions?: TransactionOptions;
-    result?: TransactionResponse<T>;
+    readonly tx: T;
+    readonly authToken?: string;
+    readonly txOptions?: TransactionOptions;
+    readonly result?: TransactionResponse<T>;
 }
 
 /**
@@ -317,21 +322,26 @@ export declare class ConnectionManager {
     constructor(endpoint: string);
     /**
      * Creates a new encrypted connection
+     * @template T Type of component request
      * @param data The component request data to encrypt and store
-     * @param participants Array of participant identifiers
+     * @param metadata Connection metadata including participants and transaction type
      * @returns Promise resolving to connection details including ID, version, and encryption key
      */
     create<T extends ComponentRequest>(data: ConnectionData<T>, metadata: ConnectionMetadata): Promise<ConnectionResponse<T>>;
     /**
      * Updates an existing connection with new encrypted data
+     * @template T Type of component request
      * @param id Connection ID
      * @param data New data to encrypt and store
      * @param version Current version number
+     * @param status New connection status
+     * @param key Current encryption key
      * @returns Promise resolving to updated connection details including new encryption key
      */
     update<T extends ComponentRequest>(id: UUID, data: ConnectionData<T>, version: number, status: ConnectionStatus, key: string): Promise<ConnectionResponse<T>>;
     /**
      * Retrieves and decrypts connection data
+     * @template T Type of component request
      * @param id Connection ID
      * @param key Encryption key from previous create/update operation
      * @returns Promise resolving to connection details including decrypted data
@@ -340,14 +350,16 @@ export declare class ConnectionManager {
     /**
      * Closes a connection
      * @param id Connection ID
+     * @returns Promise resolving when the connection is closed
      */
     close(id: UUID): Promise<void>;
 }
 
 export declare interface ConnectionMetadata {
-    nodeUrl?: string;
-    participants: string[];
-    transactionType: TransactionType;
+    readonly nodeUrl?: string;
+    readonly participants: readonly string[];
+    readonly transactionType: TransactionType;
+    readonly locale?: string;
 }
 
 /**
@@ -365,21 +377,29 @@ export declare interface ConnectionRequest extends ComponentRequest {
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {
-    id: UUID;
-    version: number;
-    status: ConnectionStatus;
-    metadata: ConnectionMetadata;
-    data: ConnectionData<T>;
-    key: string;
+    readonly id: UUID;
+    readonly version: number;
+    readonly status: ConnectionStatus;
+    readonly metadata: ConnectionMetadata;
+    readonly data: ConnectionData<T>;
+    readonly key: string;
 }
 
-export declare interface ConnectionResult<T extends ComponentRequest> {
-    id: UUID;
-    metadata: ConnectionMetadata;
-    status: ConnectionStatus;
-    tx?: T;
-    result?: TransactionResponse<T>;
-}
+export declare type ConnectionResult<T extends ComponentRequest> = {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'closed';
+} | {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'completed';
+    readonly result: TransactionResponse<T>;
+} | {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'active';
+    readonly tx: T;
+};
 
 export declare type ConnectionStatus = 'active' | 'completed' | 'closed';
 
@@ -666,7 +686,6 @@ export declare enum ErrorIdentifierCode {
  */
 export declare type FieldOptions = boolean | string[] | {
     optional: boolean;
-    transmit: boolean;
 };
 
 /**
@@ -678,6 +697,12 @@ export declare type FieldTypes = {
     legalPerson?: LegalPersonFields;
 };
 
+/**
+ * Retrieves and processes connection refresh data
+ * @template T Type of component request
+ * @param refreshSource Source information for the refresh operation
+ * @returns Promise resolving to connection result with decrypted data
+ */
 export declare function getRefreshResult<T extends ComponentRequest>(refreshSource: RefreshSource): Promise<ConnectionResult<T>>;
 
 /**
@@ -712,6 +737,18 @@ export declare enum HMType {
  */
 export declare type HostMessage<T, O> = UpdateValue<T, O>;
 
+/**
+ * Represents an info component message
+ * @param message - Info message
+ * @param description - Description of the info message
+ * @public
+ */
+declare type Info = {
+    type: CMType.INFO;
+    message: string;
+    description?: string;
+};
+
 /**
  * Intermediary VASP
  * Represents an intermediary Virtual Asset Service Provider
@@ -1375,7 +1412,8 @@ export declare enum ProofTypes {
     CIP8 = "cip-8",
     MicroTransfer = "microtransfer",
     Screenshot = "screenshot",
-    Connect = "connect"
+    Connect = "connect",
+    CONCORDIUM = "concordium"
 }
 
 /**
@@ -1433,7 +1471,7 @@ export declare interface ScreenshotProof extends OwnershipProof {
  * @public
  */
 export declare interface SignatureProof extends OwnershipProof {
-    type: ProofTypes.EIP191 | ProofTypes.EIP712 | ProofTypes.EIP1271 | ProofTypes.BIP137 | ProofTypes.BIP322 | ProofTypes.BIP137_XPUB | ProofTypes.ED25519 | ProofTypes.TIP191 | ProofTypes.SIWX | ProofTypes.SIWE | ProofTypes.CIP8 | ProofTypes.XRP_ED25519 | ProofTypes.XLM_ED25519;
+    type: ProofTypes.EIP191 | ProofTypes.EIP712 | ProofTypes.EIP1271 | ProofTypes.BIP137 | ProofTypes.BIP322 | ProofTypes.BIP137_XPUB | ProofTypes.ED25519 | ProofTypes.TIP191 | ProofTypes.SIWX | ProofTypes.SIWE | ProofTypes.CIP8 | ProofTypes.XRP_ED25519 | ProofTypes.CONCORDIUM | ProofTypes.XLM_ED25519;
     proof: string;
     attestation: string;
     wallet_provider: string;
@@ -1547,6 +1585,7 @@ export declare interface TransactionOptions {
         fallbacks?: ProofTypes[];
         deminimis?: ThresholdOptions;
     };
+    jurisdiction?: string;
     allowedAgentTypes?: AgentType[];
     allowedCounterpartyTypes?: PersonType[];
     fields?: FieldTypes;
@@ -1727,6 +1766,7 @@ export declare interface VASP extends Agent {
     logo?: URI;
     website?: URI;
     countryOfRegistration?: ISOCountryCode;
+    jurisdictions?: string;
 }
 
 /**
@@ -1761,6 +1801,18 @@ export declare interface Wallet extends Agent {
     wallet_connect_id?: string;
 }
 
+/**
+ * Represents a warning component message
+ * @param message - Warning message
+ * @param description - Description of the warning message
+ * @public
+ */
+declare type Warning = {
+    type: CMType.WARNING;
+    message: string;
+    description?: string;
+};
+
 /**
  * An object representing a withdrawal transaction
  * @public

package/dist/cjs/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.9.3",
+  "version": "2.10.0-next.4",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",
@@ -53,6 +53,7 @@
     "build:dev": "yarn build && yarn dev",
     "build:clean": "rimraf dist ts-out coverage temp",
     "build": "vite build && yarn typecheck && api-extractor run --local && node scripts/copy-types.mjs && yarn docs",
+    "build:no-docs": "vite build && yarn typecheck && api-extractor run --local && node scripts/copy-types.mjs",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "yarn lint --fix --cache --no-warn-ignored",
     "format": "prettier --write --cache .",

package/dist/esm/notabene.d.ts

@@ -218,7 +218,9 @@ export declare enum CMType {
     READY = "ready",
     INVALID = "invalid",
     ERROR = "error",
-    CANCEL = "cancel"
+    CANCEL = "cancel",
+    WARNING = "warning",
+    INFO = "info"
 }
 
 /**
@@ -249,11 +251,14 @@ export declare type Completed<T> = {
  * @see {@link Completed} For successful completion message format
  * @see {@link Cancel} For cancellation message format
  * @see {@link Error} For error message format
+ * @see {@link Ready} For ready message format
  * @see {@link ResizeRequest} For resize message format
  * @see {@link InvalidValue} For validation failure message format
+ * @see {@link Warning} For warning message format
+ * @see {@link Info} For info message format
  * @public
  */
-export declare type ComponentMessage<T> = Completed<T> | Cancel | Error_2 | Ready | ResizeRequest | InvalidValue<T>;
+export declare type ComponentMessage<T> = Completed<T> | Cancel | Error_2 | Ready | ResizeRequest | InvalidValue<T> | Warning | Info;
 
 /**
  * Base interface for requests sent to SDK components
@@ -303,10 +308,10 @@ export declare interface ComponentResponse {
 }
 
 export declare interface ConnectionData<T extends ComponentRequest> {
-    tx: T;
-    authToken?: string;
-    txOptions?: TransactionOptions;
-    result?: TransactionResponse<T>;
+    readonly tx: T;
+    readonly authToken?: string;
+    readonly txOptions?: TransactionOptions;
+    readonly result?: TransactionResponse<T>;
 }
 
 /**
@@ -317,21 +322,26 @@ export declare class ConnectionManager {
     constructor(endpoint: string);
     /**
      * Creates a new encrypted connection
+     * @template T Type of component request
      * @param data The component request data to encrypt and store
-     * @param participants Array of participant identifiers
+     * @param metadata Connection metadata including participants and transaction type
      * @returns Promise resolving to connection details including ID, version, and encryption key
      */
     create<T extends ComponentRequest>(data: ConnectionData<T>, metadata: ConnectionMetadata): Promise<ConnectionResponse<T>>;
     /**
      * Updates an existing connection with new encrypted data
+     * @template T Type of component request
      * @param id Connection ID
      * @param data New data to encrypt and store
      * @param version Current version number
+     * @param status New connection status
+     * @param key Current encryption key
      * @returns Promise resolving to updated connection details including new encryption key
      */
     update<T extends ComponentRequest>(id: UUID, data: ConnectionData<T>, version: number, status: ConnectionStatus, key: string): Promise<ConnectionResponse<T>>;
     /**
      * Retrieves and decrypts connection data
+     * @template T Type of component request
      * @param id Connection ID
      * @param key Encryption key from previous create/update operation
      * @returns Promise resolving to connection details including decrypted data
@@ -340,14 +350,16 @@ export declare class ConnectionManager {
     /**
      * Closes a connection
      * @param id Connection ID
+     * @returns Promise resolving when the connection is closed
      */
     close(id: UUID): Promise<void>;
 }
 
 export declare interface ConnectionMetadata {
-    nodeUrl?: string;
-    participants: string[];
-    transactionType: TransactionType;
+    readonly nodeUrl?: string;
+    readonly participants: readonly string[];
+    readonly transactionType: TransactionType;
+    readonly locale?: string;
 }
 
 /**
@@ -365,21 +377,29 @@ export declare interface ConnectionRequest extends ComponentRequest {
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {
-    id: UUID;
-    version: number;
-    status: ConnectionStatus;
-    metadata: ConnectionMetadata;
-    data: ConnectionData<T>;
-    key: string;
+    readonly id: UUID;
+    readonly version: number;
+    readonly status: ConnectionStatus;
+    readonly metadata: ConnectionMetadata;
+    readonly data: ConnectionData<T>;
+    readonly key: string;
 }
 
-export declare interface ConnectionResult<T extends ComponentRequest> {
-    id: UUID;
-    metadata: ConnectionMetadata;
-    status: ConnectionStatus;
-    tx?: T;
-    result?: TransactionResponse<T>;
-}
+export declare type ConnectionResult<T extends ComponentRequest> = {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'closed';
+} | {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'completed';
+    readonly result: TransactionResponse<T>;
+} | {
+    readonly id: UUID;
+    readonly metadata: ConnectionMetadata;
+    readonly status: 'active';
+    readonly tx: T;
+};
 
 export declare type ConnectionStatus = 'active' | 'completed' | 'closed';
 
@@ -666,7 +686,6 @@ export declare enum ErrorIdentifierCode {
  */
 export declare type FieldOptions = boolean | string[] | {
     optional: boolean;
-    transmit: boolean;
 };
 
 /**
@@ -678,6 +697,12 @@ export declare type FieldTypes = {
     legalPerson?: LegalPersonFields;
 };
 
+/**
+ * Retrieves and processes connection refresh data
+ * @template T Type of component request
+ * @param refreshSource Source information for the refresh operation
+ * @returns Promise resolving to connection result with decrypted data
+ */
 export declare function getRefreshResult<T extends ComponentRequest>(refreshSource: RefreshSource): Promise<ConnectionResult<T>>;
 
 /**
@@ -712,6 +737,18 @@ export declare enum HMType {
  */
 export declare type HostMessage<T, O> = UpdateValue<T, O>;
 
+/**
+ * Represents an info component message
+ * @param message - Info message
+ * @param description - Description of the info message
+ * @public
+ */
+declare type Info = {
+    type: CMType.INFO;
+    message: string;
+    description?: string;
+};
+
 /**
  * Intermediary VASP
  * Represents an intermediary Virtual Asset Service Provider
@@ -1375,7 +1412,8 @@ export declare enum ProofTypes {
     CIP8 = "cip-8",
     MicroTransfer = "microtransfer",
     Screenshot = "screenshot",
-    Connect = "connect"
+    Connect = "connect",
+    CONCORDIUM = "concordium"
 }
 
 /**
@@ -1433,7 +1471,7 @@ export declare interface ScreenshotProof extends OwnershipProof {
  * @public
  */
 export declare interface SignatureProof extends OwnershipProof {
-    type: ProofTypes.EIP191 | ProofTypes.EIP712 | ProofTypes.EIP1271 | ProofTypes.BIP137 | ProofTypes.BIP322 | ProofTypes.BIP137_XPUB | ProofTypes.ED25519 | ProofTypes.TIP191 | ProofTypes.SIWX | ProofTypes.SIWE | ProofTypes.CIP8 | ProofTypes.XRP_ED25519 | ProofTypes.XLM_ED25519;
+    type: ProofTypes.EIP191 | ProofTypes.EIP712 | ProofTypes.EIP1271 | ProofTypes.BIP137 | ProofTypes.BIP322 | ProofTypes.BIP137_XPUB | ProofTypes.ED25519 | ProofTypes.TIP191 | ProofTypes.SIWX | ProofTypes.SIWE | ProofTypes.CIP8 | ProofTypes.XRP_ED25519 | ProofTypes.CONCORDIUM | ProofTypes.XLM_ED25519;
     proof: string;
     attestation: string;
     wallet_provider: string;
@@ -1547,6 +1585,7 @@ export declare interface TransactionOptions {
         fallbacks?: ProofTypes[];
         deminimis?: ThresholdOptions;
     };
+    jurisdiction?: string;
     allowedAgentTypes?: AgentType[];
     allowedCounterpartyTypes?: PersonType[];
     fields?: FieldTypes;
@@ -1727,6 +1766,7 @@ export declare interface VASP extends Agent {
     logo?: URI;
     website?: URI;
     countryOfRegistration?: ISOCountryCode;
+    jurisdictions?: string;
 }
 
 /**
@@ -1761,6 +1801,18 @@ export declare interface Wallet extends Agent {
     wallet_connect_id?: string;
 }
 
+/**
+ * Represents a warning component message
+ * @param message - Warning message
+ * @param description - Description of the warning message
+ * @public
+ */
+declare type Warning = {
+    type: CMType.WARNING;
+    message: string;
+    description?: string;
+};
+
 /**
  * An object representing a withdrawal transaction
  * @public