@cowprotocol/widget-react 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -7,33 +7,26 @@ React component that creates a CoW Swap widget. It is based on [https://npmjs.co
7
7
  Install dependency
8
8
 
9
9
  ```bash
10
- # Install the dependency using NPM
11
- npm install @cowprotocol/widget-react --save
12
-
13
- # ...or alternativelly use YARN
14
10
  yarn add @cowprotocol/widget-react
15
11
  ```
16
12
 
13
+ ```bash
14
+ npm install @cowprotocol/widget-react
15
+ ```
16
+
17
17
  Import component and some convenient types
18
18
 
19
19
  ```ts
20
- import { CowSwapWidget, CowSwapWidgetParams, CowSwapWidgetSettings } from '@cowprotocol/widget-react'
20
+ import { CowSwapWidget, CowSwapWidgetParams } from '@cowprotocol/widget-react'
21
21
  ```
22
22
 
23
23
  Prepare the config for the widget:
24
24
 
25
25
  ```ts
26
26
  const cowSwapWidgetParams: CowSwapWidgetParams = {
27
- container: document.getElementById('cow-swap-widget'),
28
- metaData: {
29
- appKey: '<YOUR_APP_KEY>',
30
- appUrl: '<YOUR_APP_URL>',
31
- },
32
- width: 600,
33
- height: 700,
34
- }
35
-
36
- const cowSwapWidgetSettings: CowSwapWidgetSettings = {
27
+ appCode: '<YOUR_APP_KEY>',
28
+ width: '600px',
29
+ height: '700px',
37
30
  tradeType: 'swap',
38
31
  }
39
32
  ```
@@ -41,7 +34,7 @@ const cowSwapWidgetSettings: CowSwapWidgetSettings = {
41
34
  Render the component:
42
35
 
43
36
  ```jsx
44
- <CowSwapWidget params={cowSwapWidgetParams} settings={cowSwapWidgetSettings} />
37
+ <CowSwapWidget params={cowSwapWidgetParams} />
45
38
  ```
46
39
 
47
40
  ## Developers
package/index.js CHANGED
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("react/jsx-runtime"),i=require("react"),l="2.0",m="*",w=["connect","disconnect","close","chainChanged","accountsChanged"];class g{constructor(e){this.contentWindow=e,window.addEventListener("message",this.processEvent)}ethereumProvider=null;requests={};disconnect(){this.ethereumProvider=null,window.removeEventListener("message",this.processEvent)}onConnect(e){this.ethereumProvider=e,Object.keys(this.requests).forEach(t=>{this.processRequest(this.requests[t])}),this.requests={},w.forEach(t=>{e.on(t,s=>{this.postMessage({method:t,params:[s]})})})}processRequest(e){if(!this.ethereumProvider)return;(e.method==="enable"?this.ethereumProvider.enable():this.ethereumProvider.request(e)).then(s=>{this.postMessage({id:e.id,result:s})}).catch(s=>{this.postMessage({id:e.id,error:s})})}processEvent=e=>{e.data.jsonrpc==="2.0"&&(this.ethereumProvider?this.processRequest(e.data):this.requests[e.data.id]=e.data)};postMessage(e){this.contentWindow.postMessage({jsonrpc:l,...e},m)}}const E={local:"http://localhost:3000",prod:"https://swap.cow.fi",dev:"https://dev.swap.cow.fi",pr:window.location.origin};var u=(n=>(n.SWAP="swap",n.LIMIT="limit",n.ADVANCED="advanced",n))(u||{});function R(n){const e=E[n.env||"prod"],t=h(n),s=f(n);return e+"/#"+t+"?"+s}function h(n){const{chainId:e=1,tradeAssets:t,tradeType:s=u.SWAP}=n,o=t?[t.sell.asset,t.buy.asset].map(encodeURIComponent).join("/"):"";return`/${e}/widget/${s}/${o}`}function f(n){const{tradeAssets:e,theme:t}=n,s=new URLSearchParams;if(e){const{sell:o,buy:r}=e;o.amount&&s.append("sellAmount",o.amount),r.amount&&s.append("buyAmount",r.amount)}return t&&s.append("theme",t),s}const a="cowSwapWidget";function y(n,e){const{container:t,provider:s}=n,o=W(n,e);t.innerHTML="",t.appendChild(o);const{contentWindow:r}=o;if(!r)throw new Error("Iframe does not contain a window!");return P(r,n.metaData),S(o,n.height),s&&new g(r).onConnect(s),o.addEventListener("load",()=>{d(e,r,o)}),c=>d(c,r,o)}function W(n,e){const{width:t,height:s}=n,o=document.createElement("iframe");return o.src=R(e),o.width=`${t}px`,o.height=`${s}px`,o.style.border="0",o}function d(n,e,t){const s=h(n),o=f(n).toString();n.dynamicHeightEnabled||(t.style.height=""),e.postMessage({key:a,method:"update",urlParams:{pathname:s,search:o},appParams:n},"*")}function P(n,e){window.addEventListener("message",t=>{t.data.key!==a||t.data.method!=="activate"||n.postMessage({key:a,method:"metaData",metaData:e},"*")})}function S(n,e){window.addEventListener("message",t=>{if(t.data.key!==a||t.data.method!=="iframeHeight")return;const s=t.data.height||e;n.style.height=`${s}px`})}function v({params:n,settings:e,provider:t}){const s=i.useRef(),o=i.useRef(null),r=i.useRef(null);return i.useEffect(()=>{o.current&&(t&&s.current!==t&&(r.current=null),r.current?r.current(e):r.current=y({...n,container:o.current},e))},[t,n,e]),i.useEffect(()=>{s.current=t},[t]),p.jsx("div",{ref:o})}exports.CowSwapWidget=v;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const l=require("react/jsx-runtime"),r=require("react"),w="2.0",g="*",m=["connect","disconnect","close","chainChanged","accountsChanged"];class E{constructor(e){this.contentWindow=e,window.addEventListener("message",this.processEvent)}ethereumProvider=null;requests={};disconnect(){this.ethereumProvider=null,window.removeEventListener("message",this.processEvent)}onConnect(e){this.ethereumProvider=e,Object.keys(this.requests).forEach(s=>{this.processRequest(this.requests[s])}),this.requests={},m.forEach(s=>{e.on(s,n=>{this.postMessage({method:s,params:[n]})})})}processRequest(e){if(!this.ethereumProvider)return;(e.method==="enable"?this.ethereumProvider.enable():this.ethereumProvider.request(e)).then(n=>{this.postMessage({id:e.id,result:n})}).catch(n=>{this.postMessage({id:e.id,error:n})})}processEvent=e=>{e.data.jsonrpc==="2.0"&&(this.ethereumProvider?this.processRequest(e.data):this.requests[e.data.id]=e.data)};postMessage(e){this.contentWindow.postMessage({jsonrpc:w,...e},g)}}function y(){return typeof window>"u"||!window?"":`https://swap-dev-git-${window.location.hostname.replace("widget-configurator-git-","").replace("-cowswap.vercel.app","")}-cowswap.vercel.app`}const R={local:"http://localhost:3000",prod:"https://swap.cow.fi",dev:"https://dev.swap.cow.fi",pr:y()};var d=(t=>(t.SWAP="swap",t.LIMIT="limit",t.ADVANCED="advanced",t))(d||{});function v(t){const e=R[t.env||"prod"],s=u(t),n=h(t);return e+"/#"+s+"?"+n}function u(t){const{chainId:e=1,sell:s,buy:n,tradeType:o=d.SWAP}=t,i=[];s?.asset&&i.push(s.asset),n?.asset&&i.push(n.asset);const f=i.map(encodeURIComponent).join("/");return`/${e}/widget/${o}/${f}`}function h(t){const{sell:e,buy:s,theme:n}=t,o=new URLSearchParams;return e?.amount&&o.append("sellAmount",e.amount),s?.amount&&o.append("buyAmount",s.amount),n&&o.append("theme",typeof n=="string"?n:n.baseTheme),o}const a="cowSwapWidget",p="640px",W="450px",P=20;function S(t,e={}){const{provider:s}=e,n=C(e);t.innerHTML="",t.appendChild(n);const{contentWindow:o}=n;if(!o)throw new Error("Iframe does not contain a window!");return b(o,e.appCode),A(n,e.height),s&&new E(o).onConnect(s),n.addEventListener("load",()=>{c(e,o)}),i=>c(i,o)}function C(t){const{width:e=W,height:s=p}=t,n=document.createElement("iframe");return n.src=v(t),n.width=e,n.height=s,n.style.border="0",n}function c(t,e){const s=u(t),n=h(t).toString();e.postMessage({key:a,method:"update",urlParams:{pathname:s,search:n},appParams:{...t,provider:void 0}},"*")}function b(t,e){window.addEventListener("message",s=>{s.data.key!==a||s.data.method!=="activate"||t.postMessage({key:a,method:"metaData",metaData:e?{appCode:e}:void 0},"*")})}function A(t,e=p){window.addEventListener("message",s=>{s.data.key!==a||s.data.method!=="iframeHeight"||(t.style.height=s.data.height?`${s.data.height+P}px`:e)})}function M({params:t,provider:e}){const s=r.useRef(),n=r.useRef(null),o=r.useRef(null);return r.useEffect(()=>{n.current&&(e&&s.current!==e&&(o.current=null),o.current?o.current(t):o.current=S(n.current,t))},[e,t]),r.useEffect(()=>{s.current=e},[e]),l.jsx("div",{ref:n})}exports.CowSwapWidget=M;
package/index.mjs CHANGED
@@ -1,31 +1,51 @@
1
- import { jsx as f } from "react/jsx-runtime";
2
- import { useRef as i, useEffect as d } from "react";
3
- const l = "2.0", w = "*", g = ["connect", "disconnect", "close", "chainChanged", "accountsChanged"];
4
- class E {
1
+ import { jsx as w } from "react/jsx-runtime";
2
+ import { useRef as a, useEffect as c } from "react";
3
+ const m = "2.0", g = "*", E = ["connect", "disconnect", "close", "chainChanged", "accountsChanged"];
4
+ class v {
5
+ /**
6
+ * Creates an instance of JsonRpcManager.
7
+ * @param contentWindow - The window for handling events.
8
+ */
5
9
  constructor(e) {
6
10
  this.contentWindow = e, window.addEventListener("message", this.processEvent);
7
11
  }
12
+ /**
13
+ * The Ethereum provider instance.
14
+ * When is null the JSON-RPC manager is disconnected from the Ethereum provider.
15
+ * */
8
16
  ethereumProvider = null;
17
+ /** Stored JSON-RPC requests. */
9
18
  requests = {};
19
+ /**
20
+ * Disconnects the JSON-RPC manager from the Ethereum provider.
21
+ */
10
22
  disconnect() {
11
23
  this.ethereumProvider = null, window.removeEventListener("message", this.processEvent);
12
24
  }
25
+ /**
26
+ * Handles the 'connect' event and sets up event listeners for Ethereum provider events.
27
+ * @param ethereumProvider - The Ethereum provider to connect.
28
+ */
13
29
  onConnect(e) {
14
- this.ethereumProvider = e, Object.keys(this.requests).forEach((t) => {
15
- this.processRequest(this.requests[t]);
16
- }), this.requests = {}, g.forEach((t) => {
17
- e.on(t, (s) => {
18
- this.postMessage({ method: t, params: [s] });
30
+ this.ethereumProvider = e, Object.keys(this.requests).forEach((s) => {
31
+ this.processRequest(this.requests[s]);
32
+ }), this.requests = {}, E.forEach((s) => {
33
+ e.on(s, (n) => {
34
+ this.postMessage({ method: s, params: [n] });
19
35
  });
20
36
  });
21
37
  }
38
+ /**
39
+ * Processes a JSON-RPC request and sends appropriate response or error via the content window.
40
+ * @param request - The JSON-RPC request to be processed.
41
+ */
22
42
  processRequest(e) {
23
43
  if (!this.ethereumProvider)
24
44
  return;
25
- (e.method === "enable" ? this.ethereumProvider.enable() : this.ethereumProvider.request(e)).then((s) => {
26
- this.postMessage({ id: e.id, result: s });
27
- }).catch((s) => {
28
- this.postMessage({ id: e.id, error: s });
45
+ (e.method === "enable" ? this.ethereumProvider.enable() : this.ethereumProvider.request(e)).then((n) => {
46
+ this.postMessage({ id: e.id, result: n });
47
+ }).catch((n) => {
48
+ this.postMessage({ id: e.id, error: n });
29
49
  });
30
50
  }
31
51
  processEvent = (e) => {
@@ -34,94 +54,95 @@ class E {
34
54
  postMessage(e) {
35
55
  this.contentWindow.postMessage(
36
56
  {
37
- jsonrpc: l,
57
+ jsonrpc: m,
38
58
  ...e
39
59
  },
40
- w
60
+ g
41
61
  );
42
62
  }
43
63
  }
64
+ function y() {
65
+ return typeof window > "u" || !window ? "" : `https://swap-dev-git-${window.location.hostname.replace("widget-configurator-git-", "").replace("-cowswap.vercel.app", "")}-cowswap.vercel.app`;
66
+ }
44
67
  const W = {
45
68
  local: "http://localhost:3000",
46
69
  prod: "https://swap.cow.fi",
47
70
  dev: "https://dev.swap.cow.fi",
48
- pr: window.location.origin
71
+ pr: y()
49
72
  };
50
- var u = /* @__PURE__ */ ((n) => (n.SWAP = "swap", n.LIMIT = "limit", n.ADVANCED = "advanced", n))(u || {});
51
- function y(n) {
52
- const e = W[n.env || "prod"], t = p(n), s = m(n);
53
- return e + "/#" + t + "?" + s;
73
+ var u = /* @__PURE__ */ ((t) => (t.SWAP = "swap", t.LIMIT = "limit", t.ADVANCED = "advanced", t))(u || {});
74
+ function P(t) {
75
+ const e = W[t.env || "prod"], s = h(t), n = p(t);
76
+ return e + "/#" + s + "?" + n;
54
77
  }
55
- function p(n) {
56
- const { chainId: e = 1, tradeAssets: t, tradeType: s = u.SWAP } = n, o = t ? [t.sell.asset, t.buy.asset].map(encodeURIComponent).join("/") : "";
57
- return `/${e}/widget/${s}/${o}`;
78
+ function h(t) {
79
+ const { chainId: e = 1, sell: s, buy: n, tradeType: o = u.SWAP } = t, i = [];
80
+ s?.asset && i.push(s.asset), n?.asset && i.push(n.asset);
81
+ const l = i.map(encodeURIComponent).join("/");
82
+ return `/${e}/widget/${o}/${l}`;
58
83
  }
59
- function m(n) {
60
- const { tradeAssets: e, theme: t } = n, s = new URLSearchParams();
61
- if (e) {
62
- const { sell: o, buy: r } = e;
63
- o.amount && s.append("sellAmount", o.amount), r.amount && s.append("buyAmount", r.amount);
64
- }
65
- return t && s.append("theme", t), s;
84
+ function p(t) {
85
+ const { sell: e, buy: s, theme: n } = t, o = new URLSearchParams();
86
+ return e?.amount && o.append("sellAmount", e.amount), s?.amount && o.append("buyAmount", s.amount), n && o.append("theme", typeof n == "string" ? n : n.baseTheme), o;
66
87
  }
67
- const a = "cowSwapWidget";
68
- function P(n, e) {
69
- const { container: t, provider: s } = n, o = R(n, e);
70
- t.innerHTML = "", t.appendChild(o);
71
- const { contentWindow: r } = o;
72
- if (!r)
88
+ const r = "cowSwapWidget", f = "640px", R = "450px", A = 20;
89
+ function C(t, e = {}) {
90
+ const { provider: s } = e, n = S(e);
91
+ t.innerHTML = "", t.appendChild(n);
92
+ const { contentWindow: o } = n;
93
+ if (!o)
73
94
  throw new Error("Iframe does not contain a window!");
74
- return v(r, n.metaData), M(o, n.height), s && new E(r).onConnect(s), o.addEventListener("load", () => {
75
- h(e, r, o);
76
- }), (c) => h(c, r, o);
95
+ return I(o, e.appCode), L(n, e.height), s && new v(o).onConnect(s), n.addEventListener("load", () => {
96
+ d(e, o);
97
+ }), (i) => d(i, o);
77
98
  }
78
- function R(n, e) {
79
- const { width: t, height: s } = n, o = document.createElement("iframe");
80
- return o.src = y(e), o.width = `${t}px`, o.height = `${s}px`, o.style.border = "0", o;
99
+ function S(t) {
100
+ const { width: e = R, height: s = f } = t, n = document.createElement("iframe");
101
+ return n.src = P(t), n.width = e, n.height = s, n.style.border = "0", n;
81
102
  }
82
- function h(n, e, t) {
83
- const s = p(n), o = m(n).toString();
84
- n.dynamicHeightEnabled || (t.style.height = ""), e.postMessage(
103
+ function d(t, e) {
104
+ const s = h(t), n = p(t).toString();
105
+ e.postMessage(
85
106
  {
86
- key: a,
107
+ key: r,
87
108
  method: "update",
88
109
  urlParams: {
89
110
  pathname: s,
90
- search: o
111
+ search: n
91
112
  },
92
- appParams: n
113
+ appParams: {
114
+ ...t,
115
+ provider: void 0
116
+ }
93
117
  },
94
118
  "*"
95
119
  );
96
120
  }
97
- function v(n, e) {
98
- window.addEventListener("message", (t) => {
99
- t.data.key !== a || t.data.method !== "activate" || n.postMessage(
121
+ function I(t, e) {
122
+ window.addEventListener("message", (s) => {
123
+ s.data.key !== r || s.data.method !== "activate" || t.postMessage(
100
124
  {
101
- key: a,
125
+ key: r,
102
126
  method: "metaData",
103
- metaData: e
127
+ metaData: e ? { appCode: e } : void 0
104
128
  },
105
129
  "*"
106
130
  );
107
131
  });
108
132
  }
109
- function M(n, e) {
110
- window.addEventListener("message", (t) => {
111
- if (t.data.key !== a || t.data.method !== "iframeHeight")
112
- return;
113
- const s = t.data.height || e;
114
- n.style.height = `${s}px`;
133
+ function L(t, e = f) {
134
+ window.addEventListener("message", (s) => {
135
+ s.data.key !== r || s.data.method !== "iframeHeight" || (t.style.height = s.data.height ? `${s.data.height + A}px` : e);
115
136
  });
116
137
  }
117
- function S({ params: n, settings: e, provider: t }) {
118
- const s = i(), o = i(null), r = i(null);
119
- return d(() => {
120
- o.current && (t && s.current !== t && (r.current = null), r.current ? r.current(e) : r.current = P({ ...n, container: o.current }, e));
121
- }, [t, n, e]), d(() => {
122
- s.current = t;
123
- }, [t]), /* @__PURE__ */ f("div", { ref: o });
138
+ function b({ params: t, provider: e }) {
139
+ const s = a(), n = a(null), o = a(null);
140
+ return c(() => {
141
+ n.current && (e && s.current !== e && (o.current = null), o.current ? o.current(t) : o.current = C(n.current, t));
142
+ }, [e, t]), c(() => {
143
+ s.current = e;
144
+ }, [e]), /* @__PURE__ */ w("div", { ref: n });
124
145
  }
125
146
  export {
126
- S as CowSwapWidget
147
+ b as CowSwapWidget
127
148
  };
@@ -1,7 +1,6 @@
1
- import { CowSwapWidgetParams, CowSwapWidgetSettings, EthereumProvider } from '@cowprotocol/widget-lib';
1
+ import { CowSwapWidgetParams, EthereumProvider } from '@cowprotocol/widget-lib';
2
2
  export interface CowSwapWidgetProps {
3
- params: Omit<CowSwapWidgetParams, 'container'>;
4
- settings: CowSwapWidgetSettings;
3
+ params: CowSwapWidgetParams;
5
4
  provider?: EthereumProvider;
6
5
  }
7
- export declare function CowSwapWidget({ params, settings, provider }: CowSwapWidgetProps): import("react/jsx-runtime").JSX.Element;
6
+ export declare function CowSwapWidget({ params, provider }: CowSwapWidgetProps): import("react/jsx-runtime").JSX.Element;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cowprotocol/widget-react",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "main": "./index.js",
5
5
  "types": "./index.d.ts",
6
6
  "exports": {