@cowprotocol/widget-lib 0.7.0 → 0.8.0

package/IframeCowEventEmitter.d.ts

@@ -4,7 +4,6 @@ export declare class IframeCowEventEmitter {
     private eventEmitter;
     private listeners;
     private widgetListener;
-    private instanceNumber;
     constructor(contentWindow: Window, listeners?: CowEventListeners);
     stopListeningIframe(): void;
     updateListeners(listeners?: CowEventListeners): void;

package/IframeSafeSdkBridge.d.ts

@@ -0,0 +1,8 @@
+export declare class IframeSafeSdkBridge {
+    private appWindow;
+    private iframeWidow;
+    forwardSdkMessage: (event: MessageEvent<unknown>) => void;
+    constructor(appWindow: Window, iframeWidow: Window);
+    private startListening;
+    stopListening(): void;
+}

package/README.md

@@ -10,7 +10,7 @@ See the widget in action in the [widget configurator](https://widget.cow.fi)
 
 ## Docs
 
-You can find a detailed description of all widget parameters in the [documentation](../../libs/widget-lib/docs/README.md)
+You can find a detailed description of all widget parameters in the [documentation](https://docs.cow.fi/cow-protocol/tutorials/widget)
 
 ## Quick start
 
@@ -31,27 +31,28 @@ Create a container somewhere in your website, the widget will be rendered inside
 Import the widget and initialise it:
 
 ```js
-import { cowSwapWidget, CowSwapWidgetParams } from '@cowprotocol/widget-lib'
+import { createCowSwapWidget, CowSwapWidgetParams } from '@cowprotocol/widget-lib'
 
 // Initialise the widget
 const widgetContainer = document.getElementById('cowswap-widget')
 
+// instantiate your own web3 provider
+const provider = window.ethereum
+
 const params: CowSwapWidgetParams = {
-  appCode: '<YOUR_APP_KEY>', // Just an unique identifier for your app
+  appCode: 'NAME-OF-YOU-APP', // Add here the name of your app. e.g. "Pig Swap"
   sell: { asset: 'DAI' },
   buy: { asset: 'USDC', amount: '0.1' },
-  // instantiate your own web3 provider
-  provider: window.ethereum,
 }
 
-const updateWidget = cowSwapWidget(
+const {updateParams} = createCowSwapWidget(
   widgetContainer,
   // Optionally, you can provide some additional params to customise your widget
-  params
+  {params, provider}
 )
 
 // You also can change widget configuration on the fly
-updateWidget({ ...params, tradeType: 'limit' })
+updateParams({ ...params, tradeType: 'limit' })
 ```
 
 ## Developers

package/index.iife.js

@@ -1 +1 @@
-var cowSwapWidget=function(o){"use strict";const w="cowSwapWidget";function E(t,n,e){const i={key:w,method:n,...typeof e=="object"?e:{}};t.postMessage(i,"*")}function p(t,n,e){const s=i=>{!W(i.data)||i.data.key!==w||i.data.method!==n||e(i.data)};return t.addEventListener("message",s),s}function W(t){return typeof t=="object"&&t!==null&&"key"in t&&"method"in t&&typeof t.key=="string"&&typeof t.method=="string"}function T(t,n,e){t.removeEventListener("message",e)}function m(t,n){t.removeEventListener("message",n)}var d=(t=>(t.ACTIVATE="ACTIVATE",t.UPDATE_HEIGHT="UPDATE_HEIGHT",t.EMIT_COW_EVENT="EMIT_COW_EVENT",t.PROVIDER_RPC_REQUEST="PROVIDER_RPC_REQUEST",t))(d||{}),h=(t=>(t.UPDATE_PARAMS="UPDATE_PARAMS",t.UPDATE_APP_DATA="UPDATE_APP_DATA",t.PROVIDER_RPC_RESPONSE="PROVIDER_RPC_RESPONSE",t.PROVIDER_ON_EVENT="PROVIDER_ON_EVENT",t))(h||{}),f=(t=>(t.SWAP="swap",t.LIMIT="limit",t.ADVANCED="advanced",t))(f||{});const D=["connect","disconnect","close","chainChanged","accountsChanged"];class O{constructor(n){this.iframeWidow=n,this.ethereumProvider=null,this.requestWaitingForConnection={},this.processRpcCallFromWindow=({rpcRequest:e})=>{if(!this.ethereumProvider){e.id&&(this.requestWaitingForConnection[e.id]=e);return}this.processRpcRequest(e)}}disconnect(){this.ethereumProvider=null,T(window,d.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow)}onConnect(n){this.ethereumProvider?this.disconnect():p(window,d.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),this.ethereumProvider=n,this.processPendingRequests(),D.forEach(e=>{n.on(e,s=>this.onProviderEvent(e,s))})}processPendingRequests(){Object.keys(this.requestWaitingForConnection).forEach(n=>{this.processRpcRequest(this.requestWaitingForConnection[n])}),this.requestWaitingForConnection={}}processRpcRequest(n){const{id:e,jsonrpc:s,method:i}=n;if(!this.ethereumProvider||!e)return;(i==="enable"?this.ethereumProvider.enable():this.ethereumProvider.request({...n,id:e})).then(r=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:s,id:e,result:r}})).catch(r=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:s,id:e,error:r}}))}onProviderEvent(n,e){E(this.iframeWidow,h.PROVIDER_ON_EVENT,{event:n,params:e})}forwardRpcResponseToIframe(n){E(this.iframeWidow,h.PROVIDER_RPC_RESPONSE,n)}}const R="_";function S(t){const n=typeof t.baseUrl=="string"?t.baseUrl:"https://swap.cow.fi",e=l(t),s=_(t);return n+"/#"+e+"?"+s}function l(t){const{chainId:n=1,sell:e,buy:s,tradeType:i=f.SWAP}=t,c=[(e==null?void 0:e.asset)||R,(s==null?void 0:s.asset)||R].map(encodeURIComponent).join("/");return`/${n}/widget/${i}/${c}`}function _(t){const{sell:n,buy:e,theme:s}=t,i=new URLSearchParams;return n!=null&&n.amount&&i.append("sellAmount",n.amount),e!=null&&e.amount&&i.append("buyAmount",e.amount),s&&i.append("theme",typeof s=="string"?s:s.baseTheme),i}class L{constructor(){this.subscriptions={}}on(n){const{event:e,handler:s}=n;this.subscriptions[e]||(this.subscriptions[e]=[]),this.subscriptions[e].push(s)}off(n){const{event:e,handler:s}=n;this.subscriptions[e]&&(this.subscriptions[e]=this.subscriptions[e].filter(i=>i!==s))}emit(n,e){this.subscriptions[n]&&this.subscriptions[n].forEach(s=>s(e))}}let V=1;class U{constructor(n,e=[]){this.contentWindow=n,this.eventEmitter=new L,this.listeners=[],this.instanceNumber=V++,this.updateListeners(e),this.widgetListener=p(this.contentWindow,d.EMIT_COW_EVENT,s=>this.eventEmitter.emit(s.event,s.payload))}stopListeningIframe(){m(this.contentWindow,this.widgetListener)}updateListeners(n){for(const e of this.listeners)this.eventEmitter.off(e);this.listeners=n||[];for(const e of this.listeners)this.eventEmitter.on(e)}}const g="640px",y="450px",b=20;function F(t,n){const{params:e,provider:s,listeners:i}=n;let c=s;const r=N(e);t.innerHTML="",t.appendChild(r);const{contentWindow:u}=r;if(!u)throw console.error("Iframe does not contain a window",r),new Error("Iframe does not contain a window!");const P=[];P.push(H(u,e.appCode)),P.push(M(r,e.height));const I=new U(window,i);let C=A(u,null,c);return r.addEventListener("load",()=>v(u,e,c)),{updateParams:a=>v(u,a,c),updateListeners:a=>I.updateListeners(a),updateProvider:a=>{c=a,C=A(u,C,a)},destroy:()=>{I.stopListeningIframe(),P.forEach(a=>window.removeEventListener("message",a)),t.removeChild(r)}}}function A(t,n,e){n&&n.disconnect();const s=n||new O(t);return e&&s.onConnect(e),s}function N(t){const{width:n=y,height:e=g}=t,s=document.createElement("iframe");return s.src=S(t),s.width=n,s.height=e,s.style.border="0",s}function v(t,n,e){const s=!!e,i=l(n),c=_(n).toString();E(t,h.UPDATE_PARAMS,{urlParams:{pathname:i,search:c},appParams:{...n},hasProvider:s})}function H(t,n){const e=p(window,d.ACTIVATE,()=>{m(window,e),E(t,h.UPDATE_APP_DATA,{metaData:n?{appCode:n}:void 0})});return e}function M(t,n=g){return p(window,d.UPDATE_HEIGHT,e=>{t.style.height=e.height?`${e.height+b}px`:n})}return o.TradeType=f,o.WidgetMethodsEmit=d,o.WidgetMethodsListen=h,o.createCowSwapWidget=F,o.listenToMessageFromWindow=p,o.postMessageToWindow=E,o.stopListeningToMessageFromWindow=T,o.stopListeningWindowListener=m,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}),o}({});
+var cowSwapWidget=function(o){"use strict";const l="cowSwapWidget";function p(e,n,t){const s={key:l,method:n,...typeof t=="object"?t:{}};e.postMessage(s,"*")}function f(e,n,t){const i=s=>{!C(s.data)||s.data.key!==l||s.data.method!==n||t(s.data)};return e.addEventListener("message",i),i}function C(e){return typeof e=="object"&&e!==null&&"key"in e&&"method"in e&&typeof e.key=="string"&&typeof e.method=="string"}function R(e,n,t){e.removeEventListener("message",t)}function E(e,n){e.removeEventListener("message",n)}var d=(e=>(e.ACTIVATE="ACTIVATE",e.UPDATE_HEIGHT="UPDATE_HEIGHT",e.EMIT_COW_EVENT="EMIT_COW_EVENT",e.PROVIDER_RPC_REQUEST="PROVIDER_RPC_REQUEST",e))(d||{}),u=(e=>(e.UPDATE_PARAMS="UPDATE_PARAMS",e.UPDATE_APP_DATA="UPDATE_APP_DATA",e.PROVIDER_RPC_RESPONSE="PROVIDER_RPC_RESPONSE",e.PROVIDER_ON_EVENT="PROVIDER_ON_EVENT",e))(u||{}),w=(e=>(e.SWAP="swap",e.LIMIT="limit",e.ADVANCED="advanced",e))(w||{});const S=["connect","disconnect","close","chainChanged","accountsChanged"];class D{constructor(n){this.iframeWidow=n,this.ethereumProvider=null,this.requestWaitingForConnection={},this.processRpcCallFromWindow=({rpcRequest:t})=>{if(!this.ethereumProvider){t.id&&(this.requestWaitingForConnection[t.id]=t);return}this.processRpcRequest(t)}}disconnect(){this.ethereumProvider=null,R(window,d.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow)}onConnect(n){this.ethereumProvider?this.disconnect():f(window,d.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),this.ethereumProvider=n,this.processPendingRequests(),S.forEach(t=>{n.on(t,i=>this.onProviderEvent(t,i))})}processPendingRequests(){Object.keys(this.requestWaitingForConnection).forEach(n=>{this.processRpcRequest(this.requestWaitingForConnection[n])}),this.requestWaitingForConnection={}}processRpcRequest(n){const{id:t,jsonrpc:i,method:s}=n;if(!this.ethereumProvider||!t)return;(s==="enable"?this.ethereumProvider.enable():this.ethereumProvider.request({...n,id:t})).then(r=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:i,id:t,result:r}})).catch(r=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:i,id:t,error:r}}))}onProviderEvent(n,t){p(this.iframeWidow,u.PROVIDER_ON_EVENT,{event:n,params:t})}forwardRpcResponseToIframe(n){p(this.iframeWidow,u.PROVIDER_RPC_RESPONSE,n)}}const T="_";function L(e){const n=typeof e.baseUrl=="string"?e.baseUrl:"https://swap.cow.fi",t=g(e),i=_(e);return n+"/#"+t+"?"+i}function g(e){const{chainId:n=1,sell:t,buy:i,tradeType:s=w.SWAP}=e,a=[(t==null?void 0:t.asset)||T,(i==null?void 0:i.asset)||T].map(encodeURIComponent).join("/");return`/${n}/widget/${s}/${a}`}function _(e){const{sell:n,buy:t,theme:i}=e,s=new URLSearchParams;return n!=null&&n.amount&&s.append("sellAmount",n.amount),t!=null&&t.amount&&s.append("buyAmount",t.amount),i&&s.append("theme",typeof i=="string"?i:i.baseTheme),s}class O{constructor(){this.subscriptions={}}on(n){const{event:t,handler:i}=n;this.subscriptions[t]||(this.subscriptions[t]=[]),this.subscriptions[t].push(i)}off(n){const{event:t,handler:i}=n;this.subscriptions[t]&&(this.subscriptions[t]=this.subscriptions[t].filter(s=>s!==i))}emit(n,t){this.subscriptions[n]&&this.subscriptions[n].forEach(i=>i(t))}}class y{constructor(n,t=[]){this.contentWindow=n,this.eventEmitter=new O,this.listeners=[],this.updateListeners(t),this.widgetListener=f(this.contentWindow,d.EMIT_COW_EVENT,i=>this.eventEmitter.emit(i.event,i.payload))}stopListeningIframe(){E(this.contentWindow,this.widgetListener)}updateListeners(n){for(const t of this.listeners)this.eventEmitter.off(t);this.listeners=n||[];for(const t of this.listeners)this.eventEmitter.on(t)}}class V{constructor(n,t){this.appWindow=n,this.iframeWidow=t,this.forwardSdkMessage=i=>{M(i.data)&&(U(i.data)?this.appWindow.parent.postMessage(i.data,"*"):b(i.data)&&this.iframeWidow.postMessage(i.data,"*"))},this.startListening()}startListening(){this.appWindow.addEventListener("message",this.forwardSdkMessage)}stopListening(){this.appWindow.removeEventListener("message",this.forwardSdkMessage)}}function M(e){return typeof e=="object"&&e!==null&&"id"in e&&typeof e.id=="string"}function U(e){return"method"in e&&typeof e.method=="string"&&"params"in e&&"env"in e&&typeof e.env=="object"&&e.env!==null&&"sdkVersion"in e.env}function b(e){return"success"in e&&typeof e.success=="boolean"&&"version"in e&&typeof e.version=="string"}const A="640px",F="450px",N=20;function H(e,n){const{params:t,provider:i,listeners:s}=n;let a=i;const r=q(t);e.innerHTML="",e.appendChild(r);const{contentWindow:h}=r;if(!h)throw console.error("Iframe does not contain a window",r),new Error("Iframe does not contain a window!");const m=[];m.push(k(h,t.appCode)),m.push(G(r,t.height));const I=new y(window,s);let P=v(h,null,a);r.addEventListener("load",()=>W(h,t,a));const Q=new V(window,h);return{updateParams:c=>W(h,c,a),updateListeners:c=>I.updateListeners(c),updateProvider:c=>{a=c,P=v(h,P,c)},destroy:()=>{P.disconnect(),I.stopListeningIframe(),m.forEach(c=>window.removeEventListener("message",c)),Q.stopListening(),e.removeChild(r)}}}function v(e,n,t){n&&n.disconnect();const i=n||new D(e);return t&&i.onConnect(t),i}function q(e){const{width:n=F,height:t=A}=e,i=document.createElement("iframe");return i.src=L(e),i.width=n,i.height=t,i.style.border="0",i}function W(e,n,t){const i=!!t,s=g(n),a=_(n).toString();p(e,u.UPDATE_PARAMS,{urlParams:{pathname:s,search:a},appParams:{...n},hasProvider:i})}function k(e,n){const t=f(window,d.ACTIVATE,()=>{E(window,t),p(e,u.UPDATE_APP_DATA,{metaData:n?{appCode:n}:void 0})});return t}function G(e,n=A){return f(window,d.UPDATE_HEIGHT,t=>{e.style.height=t.height?`${t.height+N}px`:n})}return o.TradeType=w,o.WidgetMethodsEmit=d,o.WidgetMethodsListen=u,o.createCowSwapWidget=H,o.listenToMessageFromWindow=f,o.postMessageToWindow=p,o.stopListeningToMessageFromWindow=R,o.stopListeningWindowListener=E,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"}),o}({});

package/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const _="cowSwapWidget";function u(t,n,e){const i={key:_,method:n,...typeof e=="object"?e:{}};t.postMessage(i,"*")}function E(t,n,e){const s=i=>{!C(i.data)||i.data.key!==_||i.data.method!==n||e(i.data)};return t.addEventListener("message",s),s}function C(t){return typeof t=="object"&&t!==null&&"key"in t&&"method"in t&&typeof t.key=="string"&&typeof t.method=="string"}function g(t,n,e){t.removeEventListener("message",e)}function m(t,n){t.removeEventListener("message",n)}var a=(t=>(t.ACTIVATE="ACTIVATE",t.UPDATE_HEIGHT="UPDATE_HEIGHT",t.EMIT_COW_EVENT="EMIT_COW_EVENT",t.PROVIDER_RPC_REQUEST="PROVIDER_RPC_REQUEST",t))(a||{}),h=(t=>(t.UPDATE_PARAMS="UPDATE_PARAMS",t.UPDATE_APP_DATA="UPDATE_APP_DATA",t.PROVIDER_RPC_RESPONSE="PROVIDER_RPC_RESPONSE",t.PROVIDER_ON_EVENT="PROVIDER_ON_EVENT",t))(h||{}),f=(t=>(t.SWAP="swap",t.LIMIT="limit",t.ADVANCED="advanced",t))(f||{});const W=["connect","disconnect","close","chainChanged","accountsChanged"];class D{constructor(n){this.iframeWidow=n,this.ethereumProvider=null,this.requestWaitingForConnection={},this.processRpcCallFromWindow=({rpcRequest:e})=>{if(!this.ethereumProvider){e.id&&(this.requestWaitingForConnection[e.id]=e);return}this.processRpcRequest(e)}}disconnect(){this.ethereumProvider=null,g(window,a.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow)}onConnect(n){this.ethereumProvider?this.disconnect():E(window,a.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),this.ethereumProvider=n,this.processPendingRequests(),W.forEach(e=>{n.on(e,s=>this.onProviderEvent(e,s))})}processPendingRequests(){Object.keys(this.requestWaitingForConnection).forEach(n=>{this.processRpcRequest(this.requestWaitingForConnection[n])}),this.requestWaitingForConnection={}}processRpcRequest(n){const{id:e,jsonrpc:s,method:i}=n;if(!this.ethereumProvider||!e)return;(i==="enable"?this.ethereumProvider.enable():this.ethereumProvider.request({...n,id:e})).then(o=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:s,id:e,result:o}})).catch(o=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:s,id:e,error:o}}))}onProviderEvent(n,e){u(this.iframeWidow,h.PROVIDER_ON_EVENT,{event:n,params:e})}forwardRpcResponseToIframe(n){u(this.iframeWidow,h.PROVIDER_RPC_RESPONSE,n)}}const T="_";function O(t){const n=typeof t.baseUrl=="string"?t.baseUrl:"https://swap.cow.fi",e=A(t),s=I(t);return n+"/#"+e+"?"+s}function A(t){const{chainId:n=1,sell:e,buy:s,tradeType:i=f.SWAP}=t,r=[(e==null?void 0:e.asset)||T,(s==null?void 0:s.asset)||T].map(encodeURIComponent).join("/");return`/${n}/widget/${i}/${r}`}function I(t){const{sell:n,buy:e,theme:s}=t,i=new URLSearchParams;return n!=null&&n.amount&&i.append("sellAmount",n.amount),e!=null&&e.amount&&i.append("buyAmount",e.amount),s&&i.append("theme",typeof s=="string"?s:s.baseTheme),i}class S{constructor(){this.subscriptions={}}on(n){const{event:e,handler:s}=n;this.subscriptions[e]||(this.subscriptions[e]=[]),this.subscriptions[e].push(s)}off(n){const{event:e,handler:s}=n;this.subscriptions[e]&&(this.subscriptions[e]=this.subscriptions[e].filter(i=>i!==s))}emit(n,e){this.subscriptions[n]&&this.subscriptions[n].forEach(s=>s(e))}}let L=1;class V{constructor(n,e=[]){this.contentWindow=n,this.eventEmitter=new S,this.listeners=[],this.instanceNumber=L++,this.updateListeners(e),this.widgetListener=E(this.contentWindow,a.EMIT_COW_EVENT,s=>this.eventEmitter.emit(s.event,s.payload))}stopListeningIframe(){m(this.contentWindow,this.widgetListener)}updateListeners(n){for(const e of this.listeners)this.eventEmitter.off(e);this.listeners=n||[];for(const e of this.listeners)this.eventEmitter.on(e)}}const v="640px",U="450px",y=20;function b(t,n){const{params:e,provider:s,listeners:i}=n;let r=s;const o=F(e);t.innerHTML="",t.appendChild(o);const{contentWindow:d}=o;if(!d)throw console.error("Iframe does not contain a window",o),new Error("Iframe does not contain a window!");const p=[];p.push(N(d,e.appCode)),p.push(H(o,e.height));const P=new V(window,i);let w=R(d,null,r);return o.addEventListener("load",()=>l(d,e,r)),{updateParams:c=>l(d,c,r),updateListeners:c=>P.updateListeners(c),updateProvider:c=>{r=c,w=R(d,w,c)},destroy:()=>{P.stopListeningIframe(),p.forEach(c=>window.removeEventListener("message",c)),t.removeChild(o)}}}function R(t,n,e){n&&n.disconnect();const s=n||new D(t);return e&&s.onConnect(e),s}function F(t){const{width:n=U,height:e=v}=t,s=document.createElement("iframe");return s.src=O(t),s.width=n,s.height=e,s.style.border="0",s}function l(t,n,e){const s=!!e,i=A(n),r=I(n).toString();u(t,h.UPDATE_PARAMS,{urlParams:{pathname:i,search:r},appParams:{...n},hasProvider:s})}function N(t,n){const e=E(window,a.ACTIVATE,()=>{m(window,e),u(t,h.UPDATE_APP_DATA,{metaData:n?{appCode:n}:void 0})});return e}function H(t,n=v){return E(window,a.UPDATE_HEIGHT,e=>{t.style.height=e.height?`${e.height+y}px`:n})}exports.TradeType=f;exports.WidgetMethodsEmit=a;exports.WidgetMethodsListen=h;exports.createCowSwapWidget=b;exports.listenToMessageFromWindow=E;exports.postMessageToWindow=u;exports.stopListeningToMessageFromWindow=g;exports.stopListeningWindowListener=m;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const g="cowSwapWidget";function u(e,n,t){const i={key:g,method:n,...typeof t=="object"?t:{}};e.postMessage(i,"*")}function p(e,n,t){const s=i=>{!C(i.data)||i.data.key!==g||i.data.method!==n||t(i.data)};return e.addEventListener("message",s),s}function C(e){return typeof e=="object"&&e!==null&&"key"in e&&"method"in e&&typeof e.key=="string"&&typeof e.method=="string"}function _(e,n,t){e.removeEventListener("message",t)}function m(e,n){e.removeEventListener("message",n)}var d=(e=>(e.ACTIVATE="ACTIVATE",e.UPDATE_HEIGHT="UPDATE_HEIGHT",e.EMIT_COW_EVENT="EMIT_COW_EVENT",e.PROVIDER_RPC_REQUEST="PROVIDER_RPC_REQUEST",e))(d||{}),h=(e=>(e.UPDATE_PARAMS="UPDATE_PARAMS",e.UPDATE_APP_DATA="UPDATE_APP_DATA",e.PROVIDER_RPC_RESPONSE="PROVIDER_RPC_RESPONSE",e.PROVIDER_ON_EVENT="PROVIDER_ON_EVENT",e))(h||{}),w=(e=>(e.SWAP="swap",e.LIMIT="limit",e.ADVANCED="advanced",e))(w||{});const S=["connect","disconnect","close","chainChanged","accountsChanged"];class D{constructor(n){this.iframeWidow=n,this.ethereumProvider=null,this.requestWaitingForConnection={},this.processRpcCallFromWindow=({rpcRequest:t})=>{if(!this.ethereumProvider){t.id&&(this.requestWaitingForConnection[t.id]=t);return}this.processRpcRequest(t)}}disconnect(){this.ethereumProvider=null,_(window,d.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow)}onConnect(n){this.ethereumProvider?this.disconnect():p(window,d.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),this.ethereumProvider=n,this.processPendingRequests(),S.forEach(t=>{n.on(t,s=>this.onProviderEvent(t,s))})}processPendingRequests(){Object.keys(this.requestWaitingForConnection).forEach(n=>{this.processRpcRequest(this.requestWaitingForConnection[n])}),this.requestWaitingForConnection={}}processRpcRequest(n){const{id:t,jsonrpc:s,method:i}=n;if(!this.ethereumProvider||!t)return;(i==="enable"?this.ethereumProvider.enable():this.ethereumProvider.request({...n,id:t})).then(o=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:s,id:t,result:o}})).catch(o=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:s,id:t,error:o}}))}onProviderEvent(n,t){u(this.iframeWidow,h.PROVIDER_ON_EVENT,{event:n,params:t})}forwardRpcResponseToIframe(n){u(this.iframeWidow,h.PROVIDER_RPC_RESPONSE,n)}}const l="_";function L(e){const n=typeof e.baseUrl=="string"?e.baseUrl:"https://swap.cow.fi",t=A(e),s=v(e);return n+"/#"+t+"?"+s}function A(e){const{chainId:n=1,sell:t,buy:s,tradeType:i=w.SWAP}=e,r=[(t==null?void 0:t.asset)||l,(s==null?void 0:s.asset)||l].map(encodeURIComponent).join("/");return`/${n}/widget/${i}/${r}`}function v(e){const{sell:n,buy:t,theme:s}=e,i=new URLSearchParams;return n!=null&&n.amount&&i.append("sellAmount",n.amount),t!=null&&t.amount&&i.append("buyAmount",t.amount),s&&i.append("theme",typeof s=="string"?s:s.baseTheme),i}class O{constructor(){this.subscriptions={}}on(n){const{event:t,handler:s}=n;this.subscriptions[t]||(this.subscriptions[t]=[]),this.subscriptions[t].push(s)}off(n){const{event:t,handler:s}=n;this.subscriptions[t]&&(this.subscriptions[t]=this.subscriptions[t].filter(i=>i!==s))}emit(n,t){this.subscriptions[n]&&this.subscriptions[n].forEach(s=>s(t))}}class y{constructor(n,t=[]){this.contentWindow=n,this.eventEmitter=new O,this.listeners=[],this.updateListeners(t),this.widgetListener=p(this.contentWindow,d.EMIT_COW_EVENT,s=>this.eventEmitter.emit(s.event,s.payload))}stopListeningIframe(){m(this.contentWindow,this.widgetListener)}updateListeners(n){for(const t of this.listeners)this.eventEmitter.off(t);this.listeners=n||[];for(const t of this.listeners)this.eventEmitter.on(t)}}class V{constructor(n,t){this.appWindow=n,this.iframeWidow=t,this.forwardSdkMessage=s=>{M(s.data)&&(U(s.data)?this.appWindow.parent.postMessage(s.data,"*"):b(s.data)&&this.iframeWidow.postMessage(s.data,"*"))},this.startListening()}startListening(){this.appWindow.addEventListener("message",this.forwardSdkMessage)}stopListening(){this.appWindow.removeEventListener("message",this.forwardSdkMessage)}}function M(e){return typeof e=="object"&&e!==null&&"id"in e&&typeof e.id=="string"}function U(e){return"method"in e&&typeof e.method=="string"&&"params"in e&&"env"in e&&typeof e.env=="object"&&e.env!==null&&"sdkVersion"in e.env}function b(e){return"success"in e&&typeof e.success=="boolean"&&"version"in e&&typeof e.version=="string"}const W="640px",F="450px",N=20;function H(e,n){const{params:t,provider:s,listeners:i}=n;let r=s;const o=q(t);e.innerHTML="",e.appendChild(o);const{contentWindow:c}=o;if(!c)throw console.error("Iframe does not contain a window",o),new Error("Iframe does not contain a window!");const f=[];f.push(k(c,t.appCode)),f.push(G(o,t.height));const P=new y(window,i);let E=R(c,null,r);o.addEventListener("load",()=>T(c,t,r));const I=new V(window,c);return{updateParams:a=>T(c,a,r),updateListeners:a=>P.updateListeners(a),updateProvider:a=>{r=a,E=R(c,E,a)},destroy:()=>{E.disconnect(),P.stopListeningIframe(),f.forEach(a=>window.removeEventListener("message",a)),I.stopListening(),e.removeChild(o)}}}function R(e,n,t){n&&n.disconnect();const s=n||new D(e);return t&&s.onConnect(t),s}function q(e){const{width:n=F,height:t=W}=e,s=document.createElement("iframe");return s.src=L(e),s.width=n,s.height=t,s.style.border="0",s}function T(e,n,t){const s=!!t,i=A(n),r=v(n).toString();u(e,h.UPDATE_PARAMS,{urlParams:{pathname:i,search:r},appParams:{...n},hasProvider:s})}function k(e,n){const t=p(window,d.ACTIVATE,()=>{m(window,t),u(e,h.UPDATE_APP_DATA,{metaData:n?{appCode:n}:void 0})});return t}function G(e,n=W){return p(window,d.UPDATE_HEIGHT,t=>{e.style.height=t.height?`${t.height+N}px`:n})}exports.TradeType=w;exports.WidgetMethodsEmit=d;exports.WidgetMethodsListen=h;exports.createCowSwapWidget=H;exports.listenToMessageFromWindow=p;exports.postMessageToWindow=u;exports.stopListeningToMessageFromWindow=_;exports.stopListeningWindowListener=m;

package/index.mjs

@@ -1,61 +1,61 @@
-const T = "cowSwapWidget";
-function u(t, n, e) {
+const l = "cowSwapWidget";
+function u(e, n, t) {
   const i = {
-    key: T,
+    key: l,
     method: n,
-    ...typeof e == "object" ? e : {}
+    ...typeof t == "object" ? t : {}
   };
-  t.postMessage(
+  e.postMessage(
     i,
     "*"
     // TODO: Change to CoW specific origin in production. https://github.com/cowprotocol/cowswap/issues/3828
   );
 }
-function E(t, n, e) {
+function p(e, n, t) {
   const s = (i) => {
-    !v(i.data) || i.data.key !== T || i.data.method !== n || e(i.data);
+    !C(i.data) || i.data.key !== l || i.data.method !== n || t(i.data);
   };
-  return t.addEventListener("message", s), s;
+  return e.addEventListener("message", s), s;
 }
-function v(t) {
-  return typeof t == "object" && t !== null && "key" in t && "method" in t && typeof t.key == "string" && typeof t.method == "string";
+function C(e) {
+  return typeof e == "object" && e !== null && "key" in e && "method" in e && typeof e.key == "string" && typeof e.method == "string";
 }
-function C(t, n, e) {
-  t.removeEventListener("message", e);
+function W(e, n, t) {
+  e.removeEventListener("message", t);
 }
-function l(t, n) {
-  t.removeEventListener("message", n);
+function T(e, n) {
+  e.removeEventListener("message", n);
 }
-var h = /* @__PURE__ */ ((t) => (t.ACTIVATE = "ACTIVATE", t.UPDATE_HEIGHT = "UPDATE_HEIGHT", t.EMIT_COW_EVENT = "EMIT_COW_EVENT", t.PROVIDER_RPC_REQUEST = "PROVIDER_RPC_REQUEST", t))(h || {}), d = /* @__PURE__ */ ((t) => (t.UPDATE_PARAMS = "UPDATE_PARAMS", t.UPDATE_APP_DATA = "UPDATE_APP_DATA", t.PROVIDER_RPC_RESPONSE = "PROVIDER_RPC_RESPONSE", t.PROVIDER_ON_EVENT = "PROVIDER_ON_EVENT", t))(d || {}), _ = /* @__PURE__ */ ((t) => (t.SWAP = "swap", t.LIMIT = "limit", t.ADVANCED = "advanced", t))(_ || {});
-const D = ["connect", "disconnect", "close", "chainChanged", "accountsChanged"];
-class W {
+var d = /* @__PURE__ */ ((e) => (e.ACTIVATE = "ACTIVATE", e.UPDATE_HEIGHT = "UPDATE_HEIGHT", e.EMIT_COW_EVENT = "EMIT_COW_EVENT", e.PROVIDER_RPC_REQUEST = "PROVIDER_RPC_REQUEST", e))(d || {}), h = /* @__PURE__ */ ((e) => (e.UPDATE_PARAMS = "UPDATE_PARAMS", e.UPDATE_APP_DATA = "UPDATE_APP_DATA", e.PROVIDER_RPC_RESPONSE = "PROVIDER_RPC_RESPONSE", e.PROVIDER_ON_EVENT = "PROVIDER_ON_EVENT", e))(h || {}), _ = /* @__PURE__ */ ((e) => (e.SWAP = "swap", e.LIMIT = "limit", e.ADVANCED = "advanced", e))(_ || {});
+const S = ["connect", "disconnect", "close", "chainChanged", "accountsChanged"];
+class D {
   /**
    * Creates an instance of IframeRpcProviderBridge.
    * @param iframeWidow - The iFrame window that will post up general RPC messages and to which the IframeRpcProviderBridge will forward the RPC result.
    *  Also it will receive some special RPC events coming from the wallet, like connect/chainChanged,accountChanged
    */
   constructor(n) {
-    this.iframeWidow = n, this.ethereumProvider = null, this.requestWaitingForConnection = {}, this.processRpcCallFromWindow = ({ rpcRequest: e }) => {
+    this.iframeWidow = n, this.ethereumProvider = null, this.requestWaitingForConnection = {}, this.processRpcCallFromWindow = ({ rpcRequest: t }) => {
       if (!this.ethereumProvider) {
-        e.id && (this.requestWaitingForConnection[e.id] = e);
+        t.id && (this.requestWaitingForConnection[t.id] = t);
         return;
       }
-      this.processRpcRequest(e);
+      this.processRpcRequest(t);
     };
   }
   /**
    * Disconnects the JSON-RPC bridge from the Ethereum provider.
    */
   disconnect() {
-    this.ethereumProvider = null, C(window, h.PROVIDER_RPC_REQUEST, this.processRpcCallFromWindow);
+    this.ethereumProvider = null, W(window, d.PROVIDER_RPC_REQUEST, this.processRpcCallFromWindow);
   }
   /**
    * Handles the 'connect' event and sets up event listeners for Ethereum provider events.
    * @param newProvider - The Ethereum provider to connect.
    */
   onConnect(n) {
-    this.ethereumProvider ? this.disconnect() : E(window, h.PROVIDER_RPC_REQUEST, this.processRpcCallFromWindow), this.ethereumProvider = n, this.processPendingRequests(), D.forEach((e) => {
-      n.on(e, (s) => this.onProviderEvent(e, s));
+    this.ethereumProvider ? this.disconnect() : p(window, d.PROVIDER_RPC_REQUEST, this.processRpcCallFromWindow), this.ethereumProvider = n, this.processPendingRequests(), S.forEach((t) => {
+      n.on(t, (s) => this.onProviderEvent(t, s));
     });
   }
   processPendingRequests() {
@@ -68,117 +68,140 @@ class W {
    * @param request - The JSON-RPC request to be processed.
    */
   processRpcRequest(n) {
-    const { id: e, jsonrpc: s, method: i } = n;
-    if (!this.ethereumProvider || !e)
+    const { id: t, jsonrpc: s, method: i } = n;
+    if (!this.ethereumProvider || !t)
       return;
-    (i === "enable" ? this.ethereumProvider.enable() : this.ethereumProvider.request({ ...n, id: e })).then(
+    (i === "enable" ? this.ethereumProvider.enable() : this.ethereumProvider.request({ ...n, id: t })).then(
       (o) => this.forwardRpcResponseToIframe({
-        rpcResponse: { jsonrpc: s, id: e, result: o }
+        rpcResponse: { jsonrpc: s, id: t, result: o }
       })
     ).catch(
       (o) => this.forwardRpcResponseToIframe({
-        rpcResponse: { jsonrpc: s, id: e, error: o }
+        rpcResponse: { jsonrpc: s, id: t, error: o }
       })
     );
   }
-  onProviderEvent(n, e) {
-    u(this.iframeWidow, d.PROVIDER_ON_EVENT, {
+  onProviderEvent(n, t) {
+    u(this.iframeWidow, h.PROVIDER_ON_EVENT, {
       event: n,
-      params: e
+      params: t
     });
   }
   /**
    * Forward a JSON-RPC message to the content window.
    */
   forwardRpcResponseToIframe(n) {
-    u(this.iframeWidow, d.PROVIDER_RPC_RESPONSE, n);
+    u(this.iframeWidow, h.PROVIDER_RPC_RESPONSE, n);
   }
 }
-const P = "_";
-function O(t) {
-  const n = typeof t.baseUrl == "string" ? t.baseUrl : "https://swap.cow.fi", e = A(t), s = I(t);
-  return n + "/#" + e + "?" + s;
+const w = "_";
+function O(e) {
+  const n = typeof e.baseUrl == "string" ? e.baseUrl : "https://swap.cow.fi", t = g(e), s = A(e);
+  return n + "/#" + t + "?" + s;
 }
-function A(t) {
-  const { chainId: n = 1, sell: e, buy: s, tradeType: i = _.SWAP } = t, r = [(e == null ? void 0 : e.asset) || P, (s == null ? void 0 : s.asset) || P].map(encodeURIComponent).join("/");
+function g(e) {
+  const { chainId: n = 1, sell: t, buy: s, tradeType: i = _.SWAP } = e, r = [(t == null ? void 0 : t.asset) || w, (s == null ? void 0 : s.asset) || w].map(encodeURIComponent).join("/");
   return `/${n}/widget/${i}/${r}`;
 }
-function I(t) {
-  const { sell: n, buy: e, theme: s } = t, i = new URLSearchParams();
-  return n != null && n.amount && i.append("sellAmount", n.amount), e != null && e.amount && i.append("buyAmount", e.amount), s && i.append("theme", typeof s == "string" ? s : s.baseTheme), i;
+function A(e) {
+  const { sell: n, buy: t, theme: s } = e, i = new URLSearchParams();
+  return n != null && n.amount && i.append("sellAmount", n.amount), t != null && t.amount && i.append("buyAmount", t.amount), s && i.append("theme", typeof s == "string" ? s : s.baseTheme), i;
 }
-class S {
+class L {
   constructor() {
     this.subscriptions = {};
   }
   on(n) {
-    const { event: e, handler: s } = n;
-    this.subscriptions[e] || (this.subscriptions[e] = []), this.subscriptions[e].push(s);
+    const { event: t, handler: s } = n;
+    this.subscriptions[t] || (this.subscriptions[t] = []), this.subscriptions[t].push(s);
   }
   off(n) {
-    const { event: e, handler: s } = n;
-    this.subscriptions[e] && (this.subscriptions[e] = this.subscriptions[e].filter((i) => i !== s));
+    const { event: t, handler: s } = n;
+    this.subscriptions[t] && (this.subscriptions[t] = this.subscriptions[t].filter((i) => i !== s));
   }
-  emit(n, e) {
-    this.subscriptions[n] && this.subscriptions[n].forEach((s) => s(e));
+  emit(n, t) {
+    this.subscriptions[n] && this.subscriptions[n].forEach((s) => s(t));
   }
 }
-let V = 1;
-class L {
-  constructor(n, e = []) {
-    this.contentWindow = n, this.eventEmitter = new S(), this.listeners = [], this.instanceNumber = V++, this.updateListeners(e), this.widgetListener = E(
+class V {
+  constructor(n, t = []) {
+    this.contentWindow = n, this.eventEmitter = new L(), this.listeners = [], this.updateListeners(t), this.widgetListener = p(
       this.contentWindow,
-      h.EMIT_COW_EVENT,
+      d.EMIT_COW_EVENT,
       (s) => this.eventEmitter.emit(s.event, s.payload)
     );
   }
   stopListeningIframe() {
-    l(this.contentWindow, this.widgetListener);
+    T(this.contentWindow, this.widgetListener);
   }
   updateListeners(n) {
-    for (const e of this.listeners)
-      this.eventEmitter.off(e);
+    for (const t of this.listeners)
+      this.eventEmitter.off(t);
     this.listeners = n || [];
-    for (const e of this.listeners)
-      this.eventEmitter.on(e);
+    for (const t of this.listeners)
+      this.eventEmitter.on(t);
+  }
+}
+class y {
+  constructor(n, t) {
+    this.appWindow = n, this.iframeWidow = t, this.forwardSdkMessage = (s) => {
+      U(s.data) && (M(s.data) ? this.appWindow.parent.postMessage(s.data, "*") : N(s.data) && this.iframeWidow.postMessage(s.data, "*"));
+    }, this.startListening();
+  }
+  startListening() {
+    this.appWindow.addEventListener("message", this.forwardSdkMessage);
   }
+  stopListening() {
+    this.appWindow.removeEventListener("message", this.forwardSdkMessage);
+  }
+}
+function U(e) {
+  return typeof e == "object" && e !== null && "id" in e && typeof e.id == "string";
+}
+function M(e) {
+  return "method" in e && typeof e.method == "string" && "params" in e && "env" in e && typeof e.env == "object" && e.env !== null && "sdkVersion" in e.env;
+}
+function N(e) {
+  return "success" in e && typeof e.success == "boolean" && "version" in e && typeof e.version == "string";
 }
-const g = "640px", U = "450px", N = 20;
-function H(t, n) {
-  const { params: e, provider: s, listeners: i } = n;
+const v = "640px", b = "450px", F = 20;
+function G(e, n) {
+  const { params: t, provider: s, listeners: i } = n;
   let r = s;
-  const o = b(e);
-  t.innerHTML = "", t.appendChild(o);
-  const { contentWindow: a } = o;
-  if (!a)
+  const o = H(t);
+  e.innerHTML = "", e.appendChild(o);
+  const { contentWindow: c } = o;
+  if (!c)
     throw console.error("Iframe does not contain a window", o), new Error("Iframe does not contain a window!");
-  const p = [];
-  p.push(y(a, e.appCode)), p.push(F(o, e.height));
-  const m = new L(window, i);
-  let f = R(a, null, r);
-  return o.addEventListener("load", () => w(a, e, r)), {
-    updateParams: (c) => w(a, c, r),
-    updateListeners: (c) => m.updateListeners(c),
-    updateProvider: (c) => {
-      r = c, f = R(a, f, c);
+  const f = [];
+  f.push(q(c, t.appCode)), f.push(k(o, t.height));
+  const m = new V(window, i);
+  let E = P(c, null, r);
+  o.addEventListener("load", () => R(c, t, r));
+  const I = new y(window, c);
+  return {
+    updateParams: (a) => R(c, a, r),
+    updateListeners: (a) => m.updateListeners(a),
+    updateProvider: (a) => {
+      r = a, E = P(c, E, a);
     },
     destroy: () => {
-      m.stopListeningIframe(), p.forEach((c) => window.removeEventListener("message", c)), t.removeChild(o);
+      E.disconnect(), m.stopListeningIframe(), f.forEach((a) => window.removeEventListener("message", a)), I.stopListening(), e.removeChild(o);
     }
   };
 }
-function R(t, n, e) {
+function P(e, n, t) {
   n && n.disconnect();
-  const s = n || new W(t);
-  return e && s.onConnect(e), s;
+  const s = n || new D(e);
+  return t && s.onConnect(t), s;
 }
-function b(t) {
-  const { width: n = U, height: e = g } = t, s = document.createElement("iframe");
-  return s.src = O(t), s.width = n, s.height = e, s.style.border = "0", s;
+function H(e) {
+  const { width: n = b, height: t = v } = e, s = document.createElement("iframe");
+  return s.src = O(e), s.width = n, s.height = t, s.style.border = "0", s;
 }
-function w(t, n, e) {
-  const s = !!e, i = A(n), r = I(n).toString();
-  u(t, d.UPDATE_PARAMS, {
+function R(e, n, t) {
+  const s = !!t, i = g(n), r = A(n).toString();
+  u(e, h.UPDATE_PARAMS, {
     urlParams: {
       pathname: i,
       search: r
@@ -189,26 +212,26 @@ function w(t, n, e) {
     hasProvider: s
   });
 }
-function y(t, n) {
-  const e = E(window, h.ACTIVATE, () => {
-    l(window, e), u(t, d.UPDATE_APP_DATA, {
+function q(e, n) {
+  const t = p(window, d.ACTIVATE, () => {
+    T(window, t), u(e, h.UPDATE_APP_DATA, {
       metaData: n ? { appCode: n } : void 0
     });
   });
-  return e;
+  return t;
 }
-function F(t, n = g) {
-  return E(window, h.UPDATE_HEIGHT, (e) => {
-    t.style.height = e.height ? `${e.height + N}px` : n;
+function k(e, n = v) {
+  return p(window, d.UPDATE_HEIGHT, (t) => {
+    e.style.height = t.height ? `${t.height + F}px` : n;
   });
 }
 export {
   _ as TradeType,
-  h as WidgetMethodsEmit,
-  d as WidgetMethodsListen,
-  H as createCowSwapWidget,
-  E as listenToMessageFromWindow,
+  d as WidgetMethodsEmit,
+  h as WidgetMethodsListen,
+  G as createCowSwapWidget,
+  p as listenToMessageFromWindow,
   u as postMessageToWindow,
-  C as stopListeningToMessageFromWindow,
-  l as stopListeningWindowListener
+  W as stopListeningToMessageFromWindow,
+  T as stopListeningWindowListener
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/widget-lib",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "type": "commonjs",
   "description": "CoW Swap Widget Library. Allows you to easily embed a CoW Swap widget on your website.",
   "main": "index.js",
@@ -21,6 +21,6 @@
     "widget-lib"
   ],
   "dependencies": {
-    "@cowprotocol/events": "^0.2.0"
+    "@cowprotocol/events": "^1.1.0"
   }
 }

package/types.d.ts

@@ -82,6 +82,17 @@ export interface PartnerFee {
      */
     recipient: string;
 }
+/**
+ * ERC-20 token information
+ */
+export type TokenInfo = {
+    chainId: number;
+    address: string;
+    name: string;
+    decimals: number;
+    symbol: string;
+    logoURI?: string;
+};
 export interface CowSwapWidgetPalette {
     baseTheme: CowSwapTheme;
     primary: string;
@@ -94,6 +105,43 @@ export interface CowSwapWidgetPalette {
     info: string;
     success: string;
 }
+export interface CowSwapWidgetSounds {
+    /**
+     * The sound to play when the order is executed. Defaults to world wide famous CoW Swap moooooooooo!
+     * Alternatively, you can use a URL to a custom sound file, or set to null to disable the sound.
+     */
+    postOrder?: string | null;
+    /**
+     * The sound to play when the order is executed. Defaults to world wide famous CoW Swap happy moooooooooo!
+     * Alternatively, you can use a URL to a custom sound file, or set to null to disable the sound.
+     */
+    orderExecuted?: string | null;
+    /**
+     * The sound to play when the order is executed. Defaults to world wide famous CoW Swap unhappy moooooooooo!
+     * Alternatively, you can use a URL to a custom sound file, or set to null to disable the sound.
+     */
+    orderError?: string | null;
+}
+export interface CowSwapWidgetImages {
+    /**
+     * The image to display when the orders table is empty (no orders yet). It defaults to "Yoga CoW" image.
+     * Alternatively, you can use a URL to a custom image file, or set to null to disable the image.
+     */
+    emptyOrders?: string | null;
+}
+export interface CowSwapWidgetBanners {
+    /**
+     * Banner text: "Use Safe web app..."
+     *
+     * Conditions for displaying the banner:
+     *  - Safe-like app is connected to CoW Swap via WalletConnect
+     *  - Selling native token via Swap
+     *  - Sell token needs approval
+     *
+     *  If the flag is set to true, the banner will not be displayed
+     */
+    hideSafeWebAppBanner?: boolean;
+}
 export interface CowSwapWidgetParams {
     /**
      * The unique identifier of the widget consumer.
@@ -122,9 +170,7 @@ export interface CowSwapWidgetParams {
     tradeType?: TradeType;
     /**
      * The base url of the widget implementation
-     *
      * The parameter can have the URL directly, or an object with the environment property,
-     *
      * The base URL will default to the production environment if not specified, so it will use https://swap.cow.fi by default.
      */
     baseUrl?: string;
@@ -177,40 +223,22 @@ export interface CowSwapWidgetParams {
      * The theme of the widget UI.
      */
     theme?: CowSwapTheme | CowSwapWidgetPalette;
-    /**
-     * Allows to set a custom logo for the widget.
-     */
-    logoUrl?: string;
     /**
      * Customizable images for the widget.
      */
-    images?: {
-        /**
-         * The image to display when the orders table is empty (no orders yet). It defaults to "Yoga CoW" image.
-         * Alternatively, you can use a URL to a custom image file, or set to null to disable the image.
-         */
-        emptyOrders?: string | null;
-    };
+    images?: CowSwapWidgetImages;
     /**
      * Sounds configuration for the app.
      */
-    sounds?: {
-        /**
-         * The sound to play when the order is executed. Defaults to world wide famous CoW Swap moooooooooo!
-         * Alternatively, you can use a URL to a custom sound file, or set to null to disable the sound.
-         */
-        postOrder?: string | null;
-        /**
-         * The sound to play when the order is executed. Defaults to world wide famous CoW Swap happy moooooooooo!
-         * Alternatively, you can use a URL to a custom sound file, or set to null to disable the sound.
-         */
-        orderExecuted?: string | null;
-        /**
-         * The sound to play when the order is executed. Defaults to world wide famous CoW Swap unhappy moooooooooo!
-         * Alternatively, you can use a URL to a custom sound file, or set to null to disable the sound.
-         */
-        orderError?: string | null;
-    };
+    sounds?: CowSwapWidgetSounds;
+    /**
+     * Flags to control the display of banners in the widget.
+     */
+    banners?: CowSwapWidgetBanners;
+    /**
+     * In case when widget does not support some tokens, you can provide a list of tokens to be used in the widget
+     */
+    customTokens?: TokenInfo[];
 }
 export interface WidgetMethodsEmitPayloadMap {
     [WidgetMethodsEmit.ACTIVATE]: void;