airwallex-payment-elements 1.87.0 → 1.96.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.
Files changed (10) hide show
  1. package/lib/bin/airwallex.cjs.js +2 -2
  2. package/lib/bin/airwallex.es.js +2 -2
  3. package/lib/bin/airwallex.iife.js +2 -2
  4. package/package.json +4 -3
  5. package/typedoc.config.js +7 -1
  6. package/types/airwallex.d.ts +42 -18
  7. package/types/cardNumber.d.ts +1 -1
  8. package/types/dropInElement.d.ts +1 -1
  9. package/types/element.d.ts +341 -331
  10. package/types/index.d.ts +4 -0
package/lib/bin/airwallex.cjs.js CHANGED
@@ -1,3 +1,3 @@
1
- /* Airwallex Checkout Component Version [1.87.0] */
2
- "use strict";Object.defineProperty(exports,"__esModule",{value:!0});const e={prod:"checkout.airwallex.com",demo:"checkout-demo.airwallex.com",staging:"checkout-staging.airwallex.com",dev:"checkout-dev.airwallex.com",local:"localhost:3000"},r=r=>`https://${e[r]||e.prod}`,t="/assets/elements.bundle.min.js?version=1.87.0",o=e=>{const r=document.createElement("script");r.src=`${e}${t}`,r.crossOrigin="anonymous";const o=document.head||document.body;if(!o)throw new Error("Airwallex payment scripts requires a <head> or <body> html element in order to be loaded.");return o.appendChild(r),r},n=async e=>{if("undefined"==typeof window)return null;if(window.Airwallex)return window.Airwallex;let n=0;const l=async()=>{const n=document.querySelector(`script[src="${t}"], script[src="${t}/"]`)||o(r((null==e?void 0:e.env)||"prod"));return new Promise(((r,t)=>{n.addEventListener("load",(()=>{window.Airwallex?(window.Airwallex.init(e),r(window.Airwallex)):t(new Error("Failed to load Airwallex on load event"))})),n.addEventListener("error",(()=>{t(new Error("Failed to load Airwallex scripts")),n.remove&&n.remove()}))}))};for(;n<3;)try{return await l()}catch(e){n++,await new Promise((e=>window.setTimeout(e,500)))}return null},l=e=>{window.Airwallex?window.Airwallex.init(e):console.error("Please loadAirwallex() before init();")},a=e=>{if(window.Airwallex)return window.Airwallex.redirectToCheckout(e);console.error("Please loadAirwallex() before redirectToCheckout();")},i=(e,r)=>window.Airwallex?window.Airwallex.createElement(e,r):(console.error("Please loadAirwallex() before createElement();"),null),w=e=>window.Airwallex?window.Airwallex.destroyElement(e):(console.error("Please loadAirwallex() before destroyElement();"),!1),d=e=>window.Airwallex?window.Airwallex.getElement(e):(console.error("Please loadAirwallex() before getElement();"),null),s=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntent(e);{const e="Please loadAirwallex() before confirmPaymentIntent();";throw console.error(e),new Error(e)}},c=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntentWithSavedCard(e);{const e="Please loadAirwallex() before confirmPaymentIntentWithSavedCard();";throw console.error(e),new Error(e)}},x=async(e,r)=>{if(window.Airwallex)return window.Airwallex.createPaymentMethod(e,r);{const e="Please loadAirwallex() before createPaymentMethod();";throw console.error(e),new Error(e)}},m=async(e,r)=>{if(window.Airwallex)return window.Airwallex.getPaymentIntent(e,r);{const e="Please loadAirwallex() before getPaymentIntent();";throw console.error(e),new Error(e)}},A=async e=>{if(window.Airwallex)return window.Airwallex.createPaymentConsent(e);{const e="Please loadAirwallex() before createPaymentConsent();";throw console.error(e),new Error(e)}},y=e=>window.Airwallex.getDeviceFingerprint(e);var u={getGatewayUrl:r,loadAirwallex:n,loadAirwallexJs:o,init:l,redirectToCheckout:a,createElement:i,destroyElement:w,getDeviceFingerprint:y,getElement:d,getPaymentIntent:m,createPaymentMethod:x,createPaymentConsent:A,confirmPaymentIntent:s,confirmPaymentIntentWithSavedCard:c};exports.confirmPaymentIntent=s,exports.confirmPaymentIntentWithSavedCard=c,exports.createElement=i,exports.createPaymentConsent=A,exports.createPaymentMethod=x,exports.default=u,exports.destroyElement=w,exports.getDeviceFingerprint=y,exports.getElement=d,exports.getGatewayUrl=r,exports.getPaymentIntent=m,exports.init=l,exports.loadAirwallex=n,exports.loadAirwallexJs=o,exports.redirectToCheckout=a;
1
+ /* Airwallex Checkout Component Version [1.96.0] */
2
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0});const e={prod:"checkout.airwallex.com",demo:"checkout-demo.airwallex.com",staging:"checkout-staging.airwallex.com",dev:"checkout-dev.airwallex.com",local:"localhost:3000"},r=r=>`https://${e[r]||e.prod}`,t="/assets/elements.bundle.min.js?version=1.96.0",o=e=>{const r=document.createElement("script");r.src=`${e}${t}`,r.crossOrigin="anonymous";const o=document.head||document.body;if(!o)throw new Error("Airwallex payment scripts requires a <head> or <body> html element in order to be loaded.");return o.appendChild(r),r},n=async e=>{if("undefined"==typeof window)return null;if(window.Airwallex)return window.Airwallex;let n=0;const l=async()=>{const n=document.querySelector(`script[src="${t}"], script[src="${t}/"]`)||o(r((null==e?void 0:e.env)||"prod"));return new Promise(((r,t)=>{n.addEventListener("load",(()=>{window.Airwallex?(window.Airwallex.init(e),r(window.Airwallex)):t(new Error("Failed to load Airwallex on load event"))})),n.addEventListener("error",(()=>{t(new Error("Failed to load Airwallex scripts")),n.remove&&n.remove()}))}))};for(;n<3;)try{return await l()}catch(e){n++,await new Promise((e=>window.setTimeout(e,500)))}return null},l=e=>{window.Airwallex?window.Airwallex.init(e):console.error("Please loadAirwallex() before init();")},a=e=>{if(window.Airwallex)return window.Airwallex.redirectToCheckout(e);console.error("Please loadAirwallex() before redirectToCheckout();")},i=(e,r)=>window.Airwallex?window.Airwallex.createElement(e,r):(console.error("Please loadAirwallex() before createElement();"),null),w=e=>window.Airwallex?window.Airwallex.destroyElement(e):(console.error("Please loadAirwallex() before destroyElement();"),!1),d=e=>window.Airwallex?window.Airwallex.getElement(e):(console.error("Please loadAirwallex() before getElement();"),null),s=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntent(e);{const e="Please loadAirwallex() before confirmPaymentIntent();";throw console.error(e),new Error(e)}},c=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntentWithSavedCard(e);{const e="Please loadAirwallex() before confirmPaymentIntentWithSavedCard();";throw console.error(e),new Error(e)}},x=async(e,r)=>{if(window.Airwallex)return window.Airwallex.createPaymentMethod(e,r);{const e="Please loadAirwallex() before createPaymentMethod();";throw console.error(e),new Error(e)}},m=async(e,r)=>{if(window.Airwallex)return window.Airwallex.getPaymentIntent(e,r);{const e="Please loadAirwallex() before getPaymentIntent();";throw console.error(e),new Error(e)}},A=async e=>{if(window.Airwallex)return window.Airwallex.createPaymentConsent(e);{const e="Please loadAirwallex() before createPaymentConsent();";throw console.error(e),new Error(e)}},y=e=>window.Airwallex.getDeviceFingerprint(e);var u={getGatewayUrl:r,loadAirwallex:n,loadAirwallexJs:o,init:l,redirectToCheckout:a,createElement:i,destroyElement:w,getDeviceFingerprint:y,getElement:d,getPaymentIntent:m,createPaymentMethod:x,createPaymentConsent:A,confirmPaymentIntent:s,confirmPaymentIntentWithSavedCard:c};exports.confirmPaymentIntent=s,exports.confirmPaymentIntentWithSavedCard=c,exports.createElement=i,exports.createPaymentConsent=A,exports.createPaymentMethod=x,exports.default=u,exports.destroyElement=w,exports.getDeviceFingerprint=y,exports.getElement=d,exports.getGatewayUrl=r,exports.getPaymentIntent=m,exports.init=l,exports.loadAirwallex=n,exports.loadAirwallexJs=o,exports.redirectToCheckout=a;
3
3
  //# sourceMappingURL=airwallex.cjs.js.map
package/lib/bin/airwallex.es.js CHANGED
@@ -1,3 +1,3 @@
1
- /* Airwallex Checkout Component Version [1.87.0] */
2
- const e={prod:"checkout.airwallex.com",demo:"checkout-demo.airwallex.com",staging:"checkout-staging.airwallex.com",dev:"checkout-dev.airwallex.com",local:"localhost:3000"},r=r=>`https://${e[r]||e.prod}`,o="/assets/elements.bundle.min.js?version=1.87.0",n=e=>{const r=document.createElement("script");r.src=`${e}${o}`,r.crossOrigin="anonymous";const n=document.head||document.body;if(!n)throw new Error("Airwallex payment scripts requires a <head> or <body> html element in order to be loaded.");return n.appendChild(r),r},l=async e=>{if("undefined"==typeof window)return null;if(window.Airwallex)return window.Airwallex;let l=0;const t=async()=>{const l=document.querySelector(`script[src="${o}"], script[src="${o}/"]`)||n(r((null==e?void 0:e.env)||"prod"));return new Promise(((r,o)=>{l.addEventListener("load",(()=>{window.Airwallex?(window.Airwallex.init(e),r(window.Airwallex)):o(new Error("Failed to load Airwallex on load event"))})),l.addEventListener("error",(()=>{o(new Error("Failed to load Airwallex scripts")),l.remove&&l.remove()}))}))};for(;l<3;)try{return await t()}catch(e){l++,await new Promise((e=>window.setTimeout(e,500)))}return null},t=e=>{window.Airwallex?window.Airwallex.init(e):console.error("Please loadAirwallex() before init();")},a=e=>{if(window.Airwallex)return window.Airwallex.redirectToCheckout(e);console.error("Please loadAirwallex() before redirectToCheckout();")},i=(e,r)=>window.Airwallex?window.Airwallex.createElement(e,r):(console.error("Please loadAirwallex() before createElement();"),null),w=e=>window.Airwallex?window.Airwallex.destroyElement(e):(console.error("Please loadAirwallex() before destroyElement();"),!1),d=e=>window.Airwallex?window.Airwallex.getElement(e):(console.error("Please loadAirwallex() before getElement();"),null),c=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntent(e);{const e="Please loadAirwallex() before confirmPaymentIntent();";throw console.error(e),new Error(e)}},s=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntentWithSavedCard(e);{const e="Please loadAirwallex() before confirmPaymentIntentWithSavedCard();";throw console.error(e),new Error(e)}},m=async(e,r)=>{if(window.Airwallex)return window.Airwallex.createPaymentMethod(e,r);{const e="Please loadAirwallex() before createPaymentMethod();";throw console.error(e),new Error(e)}},x=async(e,r)=>{if(window.Airwallex)return window.Airwallex.getPaymentIntent(e,r);{const e="Please loadAirwallex() before getPaymentIntent();";throw console.error(e),new Error(e)}},A=async e=>{if(window.Airwallex)return window.Airwallex.createPaymentConsent(e);{const e="Please loadAirwallex() before createPaymentConsent();";throw console.error(e),new Error(e)}},u=e=>window.Airwallex.getDeviceFingerprint(e);var y={getGatewayUrl:r,loadAirwallex:l,loadAirwallexJs:n,init:t,redirectToCheckout:a,createElement:i,destroyElement:w,getDeviceFingerprint:u,getElement:d,getPaymentIntent:x,createPaymentMethod:m,createPaymentConsent:A,confirmPaymentIntent:c,confirmPaymentIntentWithSavedCard:s};export default y;export{c as confirmPaymentIntent,s as confirmPaymentIntentWithSavedCard,i as createElement,A as createPaymentConsent,m as createPaymentMethod,w as destroyElement,u as getDeviceFingerprint,d as getElement,r as getGatewayUrl,x as getPaymentIntent,t as init,l as loadAirwallex,n as loadAirwallexJs,a as redirectToCheckout};
1
+ /* Airwallex Checkout Component Version [1.96.0] */
2
+ const e={prod:"checkout.airwallex.com",demo:"checkout-demo.airwallex.com",staging:"checkout-staging.airwallex.com",dev:"checkout-dev.airwallex.com",local:"localhost:3000"},r=r=>`https://${e[r]||e.prod}`,o="/assets/elements.bundle.min.js?version=1.96.0",n=e=>{const r=document.createElement("script");r.src=`${e}${o}`,r.crossOrigin="anonymous";const n=document.head||document.body;if(!n)throw new Error("Airwallex payment scripts requires a <head> or <body> html element in order to be loaded.");return n.appendChild(r),r},l=async e=>{if("undefined"==typeof window)return null;if(window.Airwallex)return window.Airwallex;let l=0;const t=async()=>{const l=document.querySelector(`script[src="${o}"], script[src="${o}/"]`)||n(r((null==e?void 0:e.env)||"prod"));return new Promise(((r,o)=>{l.addEventListener("load",(()=>{window.Airwallex?(window.Airwallex.init(e),r(window.Airwallex)):o(new Error("Failed to load Airwallex on load event"))})),l.addEventListener("error",(()=>{o(new Error("Failed to load Airwallex scripts")),l.remove&&l.remove()}))}))};for(;l<3;)try{return await t()}catch(e){l++,await new Promise((e=>window.setTimeout(e,500)))}return null},t=e=>{window.Airwallex?window.Airwallex.init(e):console.error("Please loadAirwallex() before init();")},a=e=>{if(window.Airwallex)return window.Airwallex.redirectToCheckout(e);console.error("Please loadAirwallex() before redirectToCheckout();")},i=(e,r)=>window.Airwallex?window.Airwallex.createElement(e,r):(console.error("Please loadAirwallex() before createElement();"),null),w=e=>window.Airwallex?window.Airwallex.destroyElement(e):(console.error("Please loadAirwallex() before destroyElement();"),!1),d=e=>window.Airwallex?window.Airwallex.getElement(e):(console.error("Please loadAirwallex() before getElement();"),null),c=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntent(e);{const e="Please loadAirwallex() before confirmPaymentIntent();";throw console.error(e),new Error(e)}},s=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntentWithSavedCard(e);{const e="Please loadAirwallex() before confirmPaymentIntentWithSavedCard();";throw console.error(e),new Error(e)}},m=async(e,r)=>{if(window.Airwallex)return window.Airwallex.createPaymentMethod(e,r);{const e="Please loadAirwallex() before createPaymentMethod();";throw console.error(e),new Error(e)}},x=async(e,r)=>{if(window.Airwallex)return window.Airwallex.getPaymentIntent(e,r);{const e="Please loadAirwallex() before getPaymentIntent();";throw console.error(e),new Error(e)}},A=async e=>{if(window.Airwallex)return window.Airwallex.createPaymentConsent(e);{const e="Please loadAirwallex() before createPaymentConsent();";throw console.error(e),new Error(e)}},u=e=>window.Airwallex.getDeviceFingerprint(e);var y={getGatewayUrl:r,loadAirwallex:l,loadAirwallexJs:n,init:t,redirectToCheckout:a,createElement:i,destroyElement:w,getDeviceFingerprint:u,getElement:d,getPaymentIntent:x,createPaymentMethod:m,createPaymentConsent:A,confirmPaymentIntent:c,confirmPaymentIntentWithSavedCard:s};export default y;export{c as confirmPaymentIntent,s as confirmPaymentIntentWithSavedCard,i as createElement,A as createPaymentConsent,m as createPaymentMethod,w as destroyElement,u as getDeviceFingerprint,d as getElement,r as getGatewayUrl,x as getPaymentIntent,t as init,l as loadAirwallex,n as loadAirwallexJs,a as redirectToCheckout};
3
3
  //# sourceMappingURL=airwallex.es.js.map
package/lib/bin/airwallex.iife.js CHANGED
@@ -1,3 +1,3 @@
1
- /* Airwallex Checkout Component Version [1.87.0] */
2
- var Airwallex=function(e){"use strict";const r={prod:"checkout.airwallex.com",demo:"checkout-demo.airwallex.com",staging:"checkout-staging.airwallex.com",dev:"checkout-dev.airwallex.com",local:"localhost:3000"},n=e=>`https://${r[e]||r.prod}`,t="/assets/elements.bundle.min.js?version=1.87.0",o=e=>{const r=document.createElement("script");r.src=`${e}${t}`,r.crossOrigin="anonymous";const n=document.head||document.body;if(!n)throw new Error("Airwallex payment scripts requires a <head> or <body> html element in order to be loaded.");return n.appendChild(r),r},l=async e=>{if("undefined"==typeof window)return null;if(window.Airwallex)return window.Airwallex;let r=0;const l=async()=>{const r=document.querySelector(`script[src="${t}"], script[src="${t}/"]`)||o(n((null==e?void 0:e.env)||"prod"));return new Promise(((n,t)=>{r.addEventListener("load",(()=>{window.Airwallex?(window.Airwallex.init(e),n(window.Airwallex)):t(new Error("Failed to load Airwallex on load event"))})),r.addEventListener("error",(()=>{t(new Error("Failed to load Airwallex scripts")),r.remove&&r.remove()}))}))};for(;r<3;)try{return await l()}catch(e){r++,await new Promise((e=>window.setTimeout(e,500)))}return null},a=e=>{window.Airwallex?window.Airwallex.init(e):console.error("Please loadAirwallex() before init();")},i=e=>{if(window.Airwallex)return window.Airwallex.redirectToCheckout(e);console.error("Please loadAirwallex() before redirectToCheckout();")},w=(e,r)=>window.Airwallex?window.Airwallex.createElement(e,r):(console.error("Please loadAirwallex() before createElement();"),null),d=e=>window.Airwallex?window.Airwallex.destroyElement(e):(console.error("Please loadAirwallex() before destroyElement();"),!1),c=e=>window.Airwallex?window.Airwallex.getElement(e):(console.error("Please loadAirwallex() before getElement();"),null),s=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntent(e);{const e="Please loadAirwallex() before confirmPaymentIntent();";throw console.error(e),new Error(e)}},m=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntentWithSavedCard(e);{const e="Please loadAirwallex() before confirmPaymentIntentWithSavedCard();";throw console.error(e),new Error(e)}},x=async(e,r)=>{if(window.Airwallex)return window.Airwallex.createPaymentMethod(e,r);{const e="Please loadAirwallex() before createPaymentMethod();";throw console.error(e),new Error(e)}},A=async(e,r)=>{if(window.Airwallex)return window.Airwallex.getPaymentIntent(e,r);{const e="Please loadAirwallex() before getPaymentIntent();";throw console.error(e),new Error(e)}},u=async e=>{if(window.Airwallex)return window.Airwallex.createPaymentConsent(e);{const e="Please loadAirwallex() before createPaymentConsent();";throw console.error(e),new Error(e)}},y=e=>window.Airwallex.getDeviceFingerprint(e);var f={getGatewayUrl:n,loadAirwallex:l,loadAirwallexJs:o,init:a,redirectToCheckout:i,createElement:w,destroyElement:d,getDeviceFingerprint:y,getElement:c,getPaymentIntent:A,createPaymentMethod:x,createPaymentConsent:u,confirmPaymentIntent:s,confirmPaymentIntentWithSavedCard:m};return e.confirmPaymentIntent=s,e.confirmPaymentIntentWithSavedCard=m,e.createElement=w,e.createPaymentConsent=u,e.createPaymentMethod=x,e.default=f,e.destroyElement=d,e.getDeviceFingerprint=y,e.getElement=c,e.getGatewayUrl=n,e.getPaymentIntent=A,e.init=a,e.loadAirwallex=l,e.loadAirwallexJs=o,e.redirectToCheckout=i,Object.defineProperty(e,"__esModule",{value:!0}),e}({});
1
+ /* Airwallex Checkout Component Version [1.96.0] */
2
+ var Airwallex=function(e){"use strict";const r={prod:"checkout.airwallex.com",demo:"checkout-demo.airwallex.com",staging:"checkout-staging.airwallex.com",dev:"checkout-dev.airwallex.com",local:"localhost:3000"},n=e=>`https://${r[e]||r.prod}`,t="/assets/elements.bundle.min.js?version=1.96.0",o=e=>{const r=document.createElement("script");r.src=`${e}${t}`,r.crossOrigin="anonymous";const n=document.head||document.body;if(!n)throw new Error("Airwallex payment scripts requires a <head> or <body> html element in order to be loaded.");return n.appendChild(r),r},l=async e=>{if("undefined"==typeof window)return null;if(window.Airwallex)return window.Airwallex;let r=0;const l=async()=>{const r=document.querySelector(`script[src="${t}"], script[src="${t}/"]`)||o(n((null==e?void 0:e.env)||"prod"));return new Promise(((n,t)=>{r.addEventListener("load",(()=>{window.Airwallex?(window.Airwallex.init(e),n(window.Airwallex)):t(new Error("Failed to load Airwallex on load event"))})),r.addEventListener("error",(()=>{t(new Error("Failed to load Airwallex scripts")),r.remove&&r.remove()}))}))};for(;r<3;)try{return await l()}catch(e){r++,await new Promise((e=>window.setTimeout(e,500)))}return null},a=e=>{window.Airwallex?window.Airwallex.init(e):console.error("Please loadAirwallex() before init();")},i=e=>{if(window.Airwallex)return window.Airwallex.redirectToCheckout(e);console.error("Please loadAirwallex() before redirectToCheckout();")},w=(e,r)=>window.Airwallex?window.Airwallex.createElement(e,r):(console.error("Please loadAirwallex() before createElement();"),null),d=e=>window.Airwallex?window.Airwallex.destroyElement(e):(console.error("Please loadAirwallex() before destroyElement();"),!1),c=e=>window.Airwallex?window.Airwallex.getElement(e):(console.error("Please loadAirwallex() before getElement();"),null),s=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntent(e);{const e="Please loadAirwallex() before confirmPaymentIntent();";throw console.error(e),new Error(e)}},m=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntentWithSavedCard(e);{const e="Please loadAirwallex() before confirmPaymentIntentWithSavedCard();";throw console.error(e),new Error(e)}},x=async(e,r)=>{if(window.Airwallex)return window.Airwallex.createPaymentMethod(e,r);{const e="Please loadAirwallex() before createPaymentMethod();";throw console.error(e),new Error(e)}},A=async(e,r)=>{if(window.Airwallex)return window.Airwallex.getPaymentIntent(e,r);{const e="Please loadAirwallex() before getPaymentIntent();";throw console.error(e),new Error(e)}},u=async e=>{if(window.Airwallex)return window.Airwallex.createPaymentConsent(e);{const e="Please loadAirwallex() before createPaymentConsent();";throw console.error(e),new Error(e)}},y=e=>window.Airwallex.getDeviceFingerprint(e);var f={getGatewayUrl:n,loadAirwallex:l,loadAirwallexJs:o,init:a,redirectToCheckout:i,createElement:w,destroyElement:d,getDeviceFingerprint:y,getElement:c,getPaymentIntent:A,createPaymentMethod:x,createPaymentConsent:u,confirmPaymentIntent:s,confirmPaymentIntentWithSavedCard:m};return e.confirmPaymentIntent=s,e.confirmPaymentIntentWithSavedCard=m,e.createElement=w,e.createPaymentConsent=u,e.createPaymentMethod=x,e.default=f,e.destroyElement=d,e.getDeviceFingerprint=y,e.getElement=c,e.getGatewayUrl=n,e.getPaymentIntent=A,e.init=a,e.loadAirwallex=l,e.loadAirwallexJs=o,e.redirectToCheckout=i,Object.defineProperty(e,"__esModule",{value:!0}),e}({});
3
3
  //# sourceMappingURL=airwallex.iife.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "airwallex-payment-elements",
3
- "version": "1.87.0",
3
+ "version": "1.96.0",
4
4
  "module": "lib/bin/airwallex.es.js",
5
5
  "main": "lib/bin/airwallex.cjs.js",
6
6
  "bin": "lib/bin/airwallex.cjs.js",
@@ -40,7 +40,7 @@
40
40
  },
41
41
  "author": "Charlie.Lang",
42
42
  "devDependencies": {
43
- "@airwallex/typedoc-plugin": "^1.57.0",
43
+ "@airwallex/typedoc-plugin": "^1.61.0",
44
44
  "@babel/core": "^7.12.17",
45
45
  "@commitlint/cli": "^11.0.0",
46
46
  "@commitlint/config-conventional": "^11.0.0",
@@ -100,6 +100,7 @@
100
100
  "dependencies": {
101
101
  "@types/applepayjs": "^14.0.9",
102
102
  "@types/googlepay": "^0.7.6",
103
- "csstype": "^3.0.6"
103
+ "csstype": "^3.0.6",
104
+ "eslint-plugin-tsdoc": "^0.4.0"
104
105
  }
105
106
  }
package/typedoc.config.js CHANGED
@@ -26,13 +26,19 @@ const config = {
26
26
  'https://developers.google.com/pay/api/web/reference/request-objects#PaymentDataRequest',
27
27
  'google.payments.api.PaymentDataCallbacks':
28
28
  'https://developers.google.com/pay/api/web/reference/request-objects#PaymentDataCallbacks',
29
+ 'google.payments.api.CheckoutOption':
30
+ 'https://developers.google.com/pay/api/web/reference/request-objects#final-price-example',
29
31
  'google.payments.api.PaymentDataRequest':
30
32
  'https://developers.google.com/pay/api/web/reference/request-objects#PaymentDataRequest',
31
33
  'google.payments.api.PaymentDataRequest.ShippingOptionParameters':
32
34
  'https://developers.google.com/pay/api/web/reference/request-objects#ShippingOptionParameters',
35
+ 'google.payments.api.DisplayItem':
36
+ 'https://developers.google.com/pay/api/web/reference/request-objects#DisplayItem',
37
+ 'google.payments.api.PaymentDataError':
38
+ 'https://developers.google.com/pay/api/web/reference/response-objects#PaymentDataError',
33
39
  },
34
40
  csstype: {
35
- 'Properties': 'https://www.w3schools.com/cssref/index.php',
41
+ Properties: 'https://www.w3schools.com/cssref/index.php',
36
42
  },
37
43
  },
38
44
  };
package/types/airwallex.d.ts CHANGED
@@ -108,6 +108,10 @@ export interface InitOptions {
108
108
  * The locale for your website.
109
109
  */
110
110
  locale?: Locale;
111
+ /**
112
+ * @deprecated This field is no longer used.
113
+ */
114
+ origin?: string;
111
115
  /**
112
116
  * Global option to customize font styles of Elements.
113
117
  */
@@ -115,7 +119,7 @@ export interface InitOptions {
115
119
  }
116
120
 
117
121
  /**
118
- * Theme configuration options for Host Payment Page.
122
+ * Theme configuration options for Hosted Payment Page.
119
123
  */
120
124
  export interface HppTheme extends BoxStyle {
121
125
  fonts?: FontOptions[];
@@ -144,8 +148,15 @@ export interface RecurringOptions extends HppRecurringOptions {
144
148
  connected_account_id?: string;
145
149
  /**
146
150
  * Set it to `true` if you want to skip 3DS regardless of the risk score and Strong Customer Authentication (SCA) regulation. Only applicable when it's a card recurring flow.
151
+ * @deprecated use {@link three_ds_action} instead
152
+ * @hidden
147
153
  */
148
154
  skip_3ds?: boolean;
155
+ /**
156
+ * Set it to `SKIP_3DS` if you want to skip 3DS regardless of the risk score and Strong Customer Authentication (SCA) regulation. Only applicable when it's a card recurring flow.
157
+ * Set it to `FORCE_3DS` if you want to force 3DS regardless of the risk score and Strong Customer Authentication (SCA) regulation. Only applicable when it's a card recurring flow.
158
+ */
159
+ three_ds_action?: 'SKIP_3DS' | 'FORCE_3DS';
149
160
  /**
150
161
  * Descriptor that may be displayed to the customer during verification.
151
162
  */
@@ -501,6 +512,12 @@ export interface PaymentMethodRequestData {
501
512
  * The `client_secret` of the Payment Intent when Payment Intent is provided. Otherwise, this should be the `client_secret` of the Customer object.
502
513
  */
503
514
  client_secret: string;
515
+ /**
516
+ * The payment intent you would like to checkout
517
+ * Refer to [Airwallex Client API](https://www.airwallex.com/docs/api#/Payment_Acceptance/Payment_Intents/Intro)
518
+ * @deprecated use {@link intent_id} instead
519
+ */
520
+ id?: string;
504
521
  /**
505
522
  * The ID of the Payment Intent you would like to checkout. Required when `mode` is `'payment'`.
506
523
  * Refer to [Airwallex Client API](https://www.airwallex.com/docs/api#/Payment_Acceptance/Payment_Intents/)
@@ -544,22 +561,22 @@ export interface PaymentMethodRequestData {
544
561
  export declare const init: (options?: InitOptions | undefined) => void;
545
562
 
546
563
  /**
547
- * Function to redirect the shopper in a Hosted Payment Page(HPP) integration.
548
- * @example
549
- * ```ts
550
- import { init } from '@airwallex/components-sdk';
551
-
552
- const { payment } = await init({
553
- env: 'demo', // Choose the Airwallex environment ('staging', 'demo', or 'prod')
554
- enabledElements: ['payments'],
555
- });
556
- payment.redirectToCheckout({
557
- intent_id: 'replace-with-your-intent-id',
558
- client_secret: 'replace-with-your-client-secret',
559
- currency: 'replace-with-your-currency',
560
- country_code: 'replace-with-your-country-code',
561
- });
562
- ```
564
+ * Function to redirect the shopper in a Hosted Payment Page(HPP) integration.
565
+ * @example
566
+ ```ts
567
+ import { init } from '@airwallex/components-sdk';
568
+
569
+ const { payment } = await init({
570
+ env: 'demo', // Choose the Airwallex environment ('demo' or 'prod')
571
+ enabledElements: ['payments'],
572
+ });
573
+ payment.redirectToCheckout({
574
+ intent_id: 'replace-with-your-intent-id',
575
+ client_secret: 'replace-with-your-client-secret',
576
+ currency: 'replace-with-your-currency',
577
+ country_code: 'replace-with-your-country-code',
578
+ });
579
+ ```
563
580
  */
564
581
  export declare const redirectToCheckout: (props: HostPaymentPage) => void | string;
565
582
 
@@ -868,9 +885,16 @@ export interface PaymentConsentRequestData {
868
885
  */
869
886
  metadata?: Record<string, unknown>;
870
887
  /**
871
- * Set it to `true` if you want to skip 3DS regardless of the risk score and SCA. Only applicable to card recurring payments.
888
+ * Set it to `true` if you want to skip 3DS regardless of the risk score and Strong Customer Authentication (SCA) regulation. Only applicable when it's a card recurring flow.
889
+ * @deprecated use {@link threeDsAction} instead
890
+ * @hidden
872
891
  */
873
892
  skip_3ds?: boolean;
893
+ /**
894
+ * Set it to `SKIP_3DS` if you want to skip 3DS regardless of the risk score and Strong Customer Authentication (SCA) regulation. Only applicable when it's a card recurring flow.
895
+ * Set it to `FORCE_3DS` if you want to force 3DS regardless of the risk score and Strong Customer Authentication (SCA) regulation. Only applicable when it's a card recurring flow.
896
+ */
897
+ three_ds_action?: 'SKIP_3DS' | 'FORCE_3DS';
874
898
  }
875
899
 
876
900
  /**
package/types/cardNumber.d.ts CHANGED
@@ -15,7 +15,7 @@ import { Billing } from './airwallex';
15
15
  */
16
16
  export interface Intent {
17
17
  /**
18
- * The ID of the Paymnent Intent.
18
+ * The ID of the Payment Intent.
19
19
  */
20
20
  id: string;
21
21
  /**
package/types/dropInElement.d.ts CHANGED
@@ -13,7 +13,7 @@ interface DropinTheme {
13
13
  }
14
14
 
15
15
  /**
16
- * Apply to dropIn element type integration, interface used when createElement called with type `dropIn`
16
+ * Apply to `dropIn` element type integration, interface used when `createElement` called with type `dropIn`
17
17
  */
18
18
  export interface DropInElementOptions {
19
19
  /**
package/types/element.d.ts CHANGED
@@ -352,11 +352,11 @@ export interface ElementEvent {
352
352
  */
353
353
  export interface PopUpStyle {
354
354
  /**
355
- * Customized Popup overlay width like 3DS payment flow
355
+ * Customized Popup overlay width like 3DS payment flow.
356
356
  */
357
357
  popupWidth?: number;
358
358
  /**
359
- * Customized Popup overlay height like 3DS payment flow
359
+ * Customized Popup overlay height like 3DS payment flow.
360
360
  */
361
361
  popupHeight?: number;
362
362
  }
@@ -380,13 +380,13 @@ export interface Appearance {
380
380
  }
381
381
 
382
382
  /**
383
- * Supported customized pseudo css style for `cardNumber` | `expiry` | `cvc` Elements
383
+ * Supported customized pseudo css style for `cardNumber` | `expiry` | `cvc` Elements.
384
384
  * https://developer.mozilla.org/en-US/docs/Web/CSS/Pseudo-classes
385
385
  */
386
386
  type PseudoClasses = ':hover' | ':focus' | ':autofill' | '::placeholder' | '::selection' | ':disabled';
387
387
 
388
388
  /**
389
- * Pseudo-classes object
389
+ * Pseudo-classes object.
390
390
  */
391
391
  type PseudoClassStyle = { [K in PseudoClasses]?: CSSProperties };
392
392
 
@@ -418,11 +418,11 @@ export interface BoxStyle extends PopUpStyle {
418
418
  */
419
419
  base?: CSSProperties;
420
420
  /**
421
- * Styling applied to the input element
421
+ * Styling applied to the input element.
422
422
  */
423
423
  input?: CSSProperties & PseudoClassStyle;
424
424
  /**
425
- * Input variation
425
+ * Input variation.
426
426
  */
427
427
  variant?: 'outlined' | 'filled' | 'standard' | 'bootstrap';
428
428
  }
@@ -653,7 +653,7 @@ export interface ApplePayRecurringLineItem {
653
653
 
654
654
  export interface ApplePayRequestOriginalOptions {
655
655
  /**
656
- * The merchant's two-letter ISO 3166 country code, e.g. 'US'.
656
+ * The merchant's two-letter ISO 3166 country code. For example, 'US'.
657
657
  */
658
658
  countryCode: string;
659
659
 
@@ -788,18 +788,13 @@ export interface GooglePayRequestOptions {
788
788
  * - `FINAL`:
789
789
  * The total price is the final total price of the transaction, and will
790
790
  * not change based on selections made by the shopper.
791
- * * @defaultValue `'FINAL'`
791
+ * @defaultValue `'FINAL'`
792
792
  */
793
793
  totalPriceStatus?: 'NOT_CURRENTLY_KNOWN' | 'ESTIMATED' | 'FINAL';
794
794
  /**
795
795
  * Total price label of this transaction.
796
- *
797
- * The string will be shown as the total price label on the cart modal
798
- * dialog page.
799
- *
800
- * This field is optional, but required if developer wants to show cart
801
- * information. Otherwise the cart modal dialog will not be rendered
802
- * even if transactionInfo.displayItems is set.
796
+ * The string will be shown as the total price label on the cart modal dialog page.
797
+ * This field is optional, but required if developer wants to show cart information. Otherwise the cart modal dialog will not be rendered.
803
798
  */
804
799
  totalPriceLabel?: string;
805
800
  /**
@@ -857,11 +852,7 @@ export interface GooglePayRequestOptions {
857
852
  shippingAddressRequired?: false | true | undefined;
858
853
 
859
854
  /**
860
- * Optional shipping address parameters.
861
- *
862
- * If omitted, the default values specified in
863
- * [[ShippingAddressParameters|`ShippingAddressParameters`]] will be
864
- * used.
855
+ * Optional shipping address parameters for the returned shipping address.
865
856
  */
866
857
  shippingAddressParameters?: google.payments.api.ShippingAddressParameters;
867
858
  /**
@@ -881,11 +872,6 @@ export interface GooglePayRequestOptions {
881
872
 
882
873
  /**
883
874
  * Parameters for shipping option that can be used in this request.
884
- *
885
- * This should only be set if
886
- * [[PaymentDataRequest.shippingOptionRequired|`PaymentDataRequest.shippingOptionRequired`]]
887
- * is set to `true`.
888
- *
889
875
  * Note: This field is currently for web only.
890
876
  */
891
877
  shippingOptionParameters?: google.payments.api.ShippingOptionParameters;
@@ -893,7 +879,7 @@ export interface GooglePayRequestOptions {
893
879
  /**
894
880
  * List of callbacks that the developer intents to handle.
895
881
  * Upon selection by the shopper, these intents can be used to update the
896
- * request with new data based on that selection (e.g. if a shipping
882
+ * request with new data based on that selection (For exmaple, if a shipping
897
883
  * option is selected, the developer could update the `transactionInfo`
898
884
  * with new `totalPrice` and `diplayItems`).
899
885
  *
@@ -901,6 +887,9 @@ export interface GooglePayRequestOptions {
901
887
  callbackIntents?: google.payments.api.CallbackIntent[];
902
888
  }
903
889
 
890
+ /**
891
+ * Applies to `googlePayButton` element type integration, the interface used when `createElement()` is called with type `googlePayButton`.
892
+ */
904
893
  export interface GooglePayButtonOptions extends GooglePayRequestOptions {
905
894
  /**
906
895
  * The layout of each element stays consistent, but you can modify width, height, and more.
@@ -956,7 +945,7 @@ export interface GooglePayButtonOptions extends GooglePayRequestOptions {
956
945
  authFormContainer?: string;
957
946
  /**
958
947
  * Error displayed to the shopper for erroneous payment data.
959
- * For example, you can update error when user selects the wrong shipping option
948
+ * For example, you can update error when user selects the wrong shipping option.
960
949
  * Note: This field is currently available for web only.
961
950
  */
962
951
  error?: google.payments.api.PaymentDataError;
@@ -1088,6 +1077,9 @@ interface Amount {
1088
1077
  currency: string;
1089
1078
  }
1090
1079
 
1080
+ /**
1081
+ * Applies to `applePayButton` element type integration, the interface used when `createElement()` is called with type `applePayButton`.
1082
+ */
1091
1083
  export interface ApplePayButtonOptions extends ApplePayRequestOptions {
1092
1084
  /**
1093
1085
  * The ID of the Payment Intent you would like to checkout.
@@ -1195,16 +1187,16 @@ export interface Element {
1195
1187
  */
1196
1188
  mount(domElement: string | HTMLElement): null | HTMLElement;
1197
1189
  /**
1198
- * Blurs the input html Element.
1190
+ * Blurs the the HTML Input element.
1199
1191
  * https://developer.mozilla.org/en-US/docs/Web/API/HTMLOrForeignElement/blur
1200
1192
  */
1201
1193
  blur(): void;
1202
1194
  /**
1203
- * Clears the input html Element.
1195
+ * Clears the the HTML Input element.
1204
1196
  */
1205
1197
  clear(): void;
1206
1198
  /**
1207
- * Focuses the input html Element.
1199
+ * Focuses the the HTML Input element.
1208
1200
  * https://developer.mozilla.org/en-US/docs/Web/API/HTMLOrForeignElement/focus
1209
1201
  */
1210
1202
  focus(): void;
@@ -1247,40 +1239,32 @@ interface ElementBaseType {
1247
1239
  * Mounts Element to your HTML DOM.
1248
1240
  * @example
1249
1241
  * ```ts
1250
- // type
1251
- element.mount: (domElement: string | HTMLElement) => void
1252
-
1253
- // There are two ways to mount the element:
1254
- // 1. Call with the container DOM id
1255
- element.mount('container-dom-id');
1256
-
1257
- // 2. Find the created DOM in the existing HTML and call with the container DOM element
1258
- const containerElement = document.getElementById('container-dom-id');
1259
- element.mount(containerElement);
1260
- ```
1261
- */
1242
+ * // There are two ways to mount the element:
1243
+ * // 1. Call with the container DOM id
1244
+ * element.mount('container-dom-id');
1245
+ *
1246
+ * // 2. Find the created DOM in the existing HTML and call with the container DOM element
1247
+ * const containerElement = document.getElementById('container-dom-id');
1248
+ * element.mount(containerElement);
1249
+ * ```
1250
+ */
1262
1251
  mount(domElement: string | HTMLElement): null | HTMLElement;
1263
1252
 
1264
1253
  /**
1265
1254
  * Unmounts the Element. Note that the Element instance will remain.
1266
-
1267
1255
  * @example
1268
1256
  * ```ts
1269
- element.unmount();
1270
- ```
1257
+ * element.unmount();
1258
+ * ```
1271
1259
  */
1272
1260
  unmount(): void;
1273
1261
 
1274
1262
  /**
1275
- * Destroys the Element instance.
1263
+ * Destroys the Element instance.
1276
1264
  * @example
1277
- ```ts
1278
- element.destroy();
1279
- ```
1280
- *
1281
- * ***IMPORTANT***
1282
- *
1283
- * Once Element is destroyed by calling destroyElement() function, the Element reference is no longer valid.
1265
+ * ```ts
1266
+ * element.destroy();
1267
+ * ```
1284
1268
  */
1285
1269
  destroy(): void;
1286
1270
  }
@@ -1291,49 +1275,51 @@ type CardElementEvent = 'ready' | 'click' | 'focus' | 'blur' | 'change';
1291
1275
  */
1292
1276
  export interface CardElementType extends ElementBaseType {
1293
1277
  /**
1294
- * Using this function to blur the input html element
1295
- *@example
1296
- ```ts
1297
- element.blur();
1298
- ```
1278
+ * Using this function to blur the HTML Input element
1279
+ * @example
1280
+ * ```ts
1281
+ * element.blur();
1282
+ * ```
1299
1283
  */
1300
1284
  blur(): void;
1301
1285
  /**
1302
- * Using this function to clear the input html element.
1286
+ * Using this function to clear the HTML Input element
1303
1287
  * @example
1304
- ```ts
1305
- element.clear();
1306
- ```
1288
+ * ```ts
1289
+ * element.clear();
1290
+ * ```
1307
1291
  */
1308
1292
  clear(): void;
1309
1293
  /**
1310
- * Using this function to focus the input html element.
1294
+ * Using this function to focus the HTML Input element
1311
1295
  * @example
1312
- ```ts
1313
- element.focus();
1314
- ```
1296
+ * ```ts
1297
+ * element.focus();
1298
+ * ```
1315
1299
  */
1316
1300
  focus(): void;
1317
1301
  /**
1318
1302
  * Creates a Payment Consent, which represents the consent between you and the shopper to use the shopper’s saved card details for future payments.
1319
1303
  * @param data - Payment consent request payload
1320
1304
  * @example
1321
- ```ts
1322
- element.createPaymentConsent({client_secret: 'mock_client_secret'});
1323
- ```
1305
+ * ```ts
1306
+ * element.createPaymentConsent({
1307
+ * client_secret: 'replace-with-your-client-secret',
1308
+ * });
1309
+ * ```
1324
1310
  */
1325
1311
  createPaymentConsent(data: PaymentConsentRequestData): Promise<PaymentConsentResponse>;
1326
1312
  /**
1327
1313
  * Using this function to verify consent
1328
1314
  * @param data - Verify consent request payload
1329
1315
  * @example
1330
- ```ts
1331
- element.verifyConsent({
1332
- consent_id: 'mock_consent_id',
1333
- client_secret: 'mock_client_secret',
1334
- currency: 'mock_currency'
1335
- });
1336
- ```
1316
+ * ```ts
1317
+ * element.verifyConsent({
1318
+ * consent_id: 'replace-with-your-consent-id',
1319
+ * client_secret: 'replace-with-your-client-secret',
1320
+ * currency: 'replace-with-your-currency',
1321
+ * });
1322
+ * ```
1337
1323
  */
1338
1324
  verifyConsent(data: VerifyConsentRequest): Promise<PaymentConsentResponse | boolean>;
1339
1325
  /**
@@ -1341,31 +1327,33 @@ export interface CardElementType extends ElementBaseType {
1341
1327
  * Confirms the Payment Intent. Call this function when the shopper is ready to make a payment as per the details in the Payment Intent.
1342
1328
  * @param data - Payment method request payload
1343
1329
  * @example
1344
- ```ts
1345
- element.confirm({client_secret: 'mock_client_secret'});
1346
- ```
1330
+ * ```ts
1331
+ * element.confirm({
1332
+ * client_secret: 'replace-with-your-client-secret',
1333
+ * });
1334
+ * ```
1347
1335
  */
1348
1336
  confirm(data: PaymentMethodRequestData): Promise<Intent>;
1349
1337
  /**
1350
1338
  * Using this function to update the element option after create the element
1351
1339
  * @example
1352
- ```ts
1353
- element.update({autoCapture: true});
1354
- ```
1340
+ * ```ts
1341
+ * element.update({autoCapture: true});
1342
+ * ```
1355
1343
  */
1356
1344
  update(options?: Partial<CardElementOptions>, initOptions?: Partial<InitOptions>): void;
1357
1345
  /**
1358
1346
  * Listen to Element events.
1359
- *
1347
+ *
1360
1348
  * @param event - The event name
1361
1349
  * @param handler - The event handler
1362
1350
  * @example
1363
- ```ts
1364
- element.on('success', () => {
1365
- // Handle success event
1366
- });
1367
- ```
1368
- */
1351
+ * ```ts
1352
+ * element.on('success', () => {
1353
+ * // Handle success event
1354
+ * });
1355
+ * ```
1356
+ */
1369
1357
  on(event: CardElementEvent, handler: EventListener): void;
1370
1358
  }
1371
1359
 
@@ -1376,76 +1364,82 @@ export type CardNumberElementEvent = 'ready' | 'change' | 'focus' | 'blur' | 'pr
1376
1364
  */
1377
1365
  export interface CardNumberElementType extends ElementBaseType {
1378
1366
  /**
1379
- * Using this function to blur the input html element.
1367
+ * Using this function to blur the HTML Input element.
1380
1368
  * @example
1381
- ```ts
1382
- element.blur();
1383
- ```
1369
+ * ```ts
1370
+ * element.blur();
1371
+ * ```
1384
1372
  */
1385
1373
  blur(): void;
1386
1374
  /**
1387
- * Using this function to clear the input html element.
1375
+ * Using this function to clear the HTML Input element.
1388
1376
  * @example
1389
- ```ts
1390
- element.clear();
1391
- ```
1377
+ * ```ts
1378
+ * element.clear();
1379
+ * ```
1392
1380
  */
1393
1381
  clear(): void;
1394
1382
  /**
1395
- * Using this function to focus the input html element.
1383
+ * Using this function to focus the HTML Input element
1396
1384
  * @example
1397
- ```ts
1398
- element.focus();
1399
- ```
1385
+ * ```ts
1386
+ * element.focus();
1387
+ * ```
1400
1388
  */
1401
1389
  focus(): void;
1402
1390
  /**
1403
1391
  * Creates a Payment Consent, which represents the consent between you and the shopper to use the shopper’s saved card details for future payments.
1404
- *@example
1405
- ```ts
1406
- element.createPaymentConsent({client_secret: 'mock_client_secret'});
1407
- ```
1392
+ * @example
1393
+ * ```ts
1394
+ * element.createPaymentConsent({
1395
+ * client_secret: 'replace-with-your-client-secret',
1396
+ * });
1397
+ * ```
1408
1398
  */
1409
1399
  createPaymentConsent(data: PaymentConsentRequestData): Promise<PaymentConsentResponse>;
1410
1400
  /**
1411
1401
  * Using this function to verify payment consent.
1412
- *@example
1413
- ```ts
1414
- element.verifyConsent({
1415
- consent_id: 'mock_consent_id',
1416
- client_secret: 'mock_client_secret',
1417
- currency: 'mock_currency'
1418
- });
1419
- ```
1402
+ * @example
1403
+ * ```ts
1404
+ * element.verifyConsent({
1405
+ * consent_id: 'replace-with-your-consent-id',
1406
+ * client_secret: 'replace-with-your-client-secret',
1407
+ * currency: 'replace-with-your-currency',
1408
+ * });
1409
+ * ```
1420
1410
  */
1421
1411
  verifyConsent(data: VerifyConsentRequest): Promise<PaymentConsentResponse | boolean>;
1422
1412
  /**
1423
1413
  * Using this function to confirm payment intent.
1424
1414
  * Confirms the Payment Intent.
1425
1415
  *@example
1426
- ```ts
1427
- element.confirm({client_secret: 'mock_client_secret'});
1428
- ```
1416
+ * ```ts
1417
+ * element.confirm({
1418
+ * client_secret: 'replace-with-your-client-secret',
1419
+ * });
1420
+ * ```
1429
1421
  */
1430
1422
  confirm(data: PaymentMethodRequestData): Promise<Intent>;
1431
1423
  /**
1432
- * Using this function to update the element option after create the element
1433
- *@example
1434
- ```ts
1435
- element.update({autoCapture: false});
1436
- ```
1424
+ * Using this function to update the element option after create the element.
1425
+ * @example
1426
+ * ```ts
1427
+ * element.update({
1428
+ * autoCapture: false,
1429
+ * });
1430
+ * ```
1437
1431
  */
1438
1432
  update(options?: Partial<CardNumberElementOptions>, initOptions?: Partial<InitOptions>): void;
1439
1433
  /**
1440
- * Listen to element events.
1441
- *
1434
+ * Listen to element events.
1435
+ *
1442
1436
  * @example
1443
- ```ts
1444
- element.on('change', () => {
1445
- // Handle change event
1446
- });
1447
- ```
1448
- */
1437
+ * ```ts
1438
+ * element.on('change', () => {
1439
+ * // Handle change event
1440
+ * });
1441
+ * ```
1442
+ */
1449
1443
  on(event: CardNumberElementEvent, handler: EventListener): void;
1450
1444
  }
1451
1445
 
@@ -1456,114 +1450,122 @@ export type ExpiryElementEvent = 'ready' | 'change' | 'focus' | 'blur' | 'pressA
1456
1450
  */
1457
1451
  export interface ExpiryDateElementType extends ElementBaseType {
1458
1452
  /**
1459
- * Using this function to blur the input html element.
1453
+ * Using this function to blur the HTML Input element.
1460
1454
  * @example
1461
- ```ts
1462
- element.blur();
1463
- ```
1455
+ * ```ts
1456
+ * element.blur();
1457
+ * ```
1464
1458
  */
1465
1459
  blur(): void;
1466
1460
  /**
1467
- * Using this function to clear the input html element.
1461
+ * Using this function to clear the HTML Input element.
1468
1462
  * @example
1469
- ```ts
1470
- element.clear();
1471
- ```
1463
+ * ```ts
1464
+ * element.clear();
1465
+ * ```
1472
1466
  */
1473
1467
  clear(): void;
1474
1468
  /**
1475
- * Using this function to focus the input html element
1469
+ * Using this function to focus the HTML Input element
1476
1470
  * @example
1477
- ```ts
1478
- element.focus();
1479
- ```
1471
+ * ```ts
1472
+ * element.focus();
1473
+ * ```
1480
1474
  */
1481
1475
  focus(): void;
1482
1476
  /**
1483
- * Using this function to update the element option after create the element
1484
- *@example
1485
- ```ts
1486
- element.update({placeholder: 'mock placeholder'});
1487
- ```
1477
+ * Using this function to update the element option after create the element.
1478
+ * @example
1479
+ * ```ts
1480
+ * element.update({
1481
+ * placeholder: 'replace-with-your-placeholder',
1482
+ * });
1483
+ * ```
1488
1484
  */
1489
1485
  update(options?: Partial<ExpiryDateElementOptions>, initOptions?: Partial<InitOptions>): void;
1490
1486
  /**
1491
1487
  * Listen to element event
1492
- *
1488
+ *
1493
1489
  * @example
1494
- ```ts
1495
- element.on('change', () => {
1496
- // Handle change event
1497
- });
1498
- ```
1499
- */
1490
+ * ```ts
1491
+ * element.on('change', () => {
1492
+ * // Handle change event
1493
+ * });
1494
+ * ```
1495
+ */
1500
1496
  on(event: ExpiryElementEvent, handler: EventListener): void;
1501
1497
  }
1502
1498
 
1503
1499
  export type CvcElementEvent = 'ready' | 'change' | 'focus' | 'blur' | 'pressArrowKey' | 'submit';
1504
1500
 
1505
1501
  /**
1506
- * Functions and external fields can be used in your integration flow with Airwallex element
1502
+ * Element functions can be used in your integration flow with Airwallex element.
1507
1503
  */
1508
1504
  export interface CvcElementType extends ElementBaseType {
1509
1505
  /**
1510
- * Using this function to blur the input html element
1506
+ * Using this function to blur the HTML Input element.
1511
1507
  * @example
1512
- ```ts
1513
- element.blur();
1514
- ```
1508
+ * ```ts
1509
+ * element.blur();
1510
+ * ```
1515
1511
  */
1516
1512
  blur(): void;
1517
1513
  /**
1518
- * Using this function to clear the input html element
1514
+ * Using this function to clear the HTML Input element.
1519
1515
  * @example
1520
- ```ts
1521
- element.clear();
1522
- ```
1516
+ * ```ts
1517
+ * element.clear();
1518
+ * ```
1523
1519
  */
1524
1520
  clear(): void;
1525
1521
  /**
1526
- * Using this function to focus the input html element
1522
+ * Using this function to focus the HTML Input element.
1527
1523
  * @example
1528
- ```ts
1529
- element.focus();
1530
- ```
1524
+ * ```ts
1525
+ * element.focus();
1526
+ * ```
1531
1527
  */
1532
1528
  focus(): void;
1533
1529
  /**
1534
- * Using this function to confirm payment intent
1530
+ * Using this function to confirm payment intent.
1535
1531
  * @example
1536
- ```ts
1537
- element.confirm({client_secret: 'mocked client_secret'});
1538
- ```
1532
+ * ```ts
1533
+ * element.confirm({
1534
+ * client_secret: 'replace-with-your-client-secret',
1535
+ * });
1536
+ * ```
1539
1537
  */
1540
1538
  confirm(data: PaymentMethodRequestData): Promise<Intent>;
1541
1539
  /**
1542
- * Using this function to create payment consent
1540
+ * Using this function to create payment consent.
1543
1541
  * @example
1544
- ```ts
1545
- element.createPaymentConsent({client_secret: 'mocked client_secret'});
1546
- ```
1542
+ * ```ts
1543
+ * element.createPaymentConsent({
1544
+ * client_secret: 'replace-with-your-client-secret',
1545
+ * });
1546
+ * ```
1547
1547
  */
1548
1548
  createPaymentConsent(data: PaymentConsentRequestData): Promise<PaymentConsentResponse>;
1549
1549
  /**
1550
- * Using this function to update the element option after create the element
1550
+ * Using this function to update the element option after create the element.
1551
1551
  * @example
1552
- ```ts
1553
- element.update({placeholder: 'mocked placeholder'});
1554
- ```
1552
+ * ```ts
1553
+ * element.update({
1554
+ * placeholder: 'replace-with-your-placeholder',
1555
+ * });
1556
+ * ```
1555
1557
  */
1556
1558
  update(options?: Partial<CvcElementOptions>, initOptions?: Partial<InitOptions>): void;
1557
1559
  /**
1558
1560
  * Listen to element event
1559
- *
1561
+ *
1560
1562
  * @example
1561
- ```ts
1562
- element.on('change', () => {
1563
- // Handle change event
1564
- });
1565
- ```
1566
- */
1563
+ * ```ts
1564
+ * element.on('change', () => {
1565
+ * // Handle change event
1566
+ * });
1567
+ * ```
1568
+ */
1567
1569
  on(event: CvcElementEvent, handler: EventListener): void;
1568
1570
  }
1569
1571
 
@@ -1586,72 +1588,72 @@ interface ParameterObject {
1586
1588
  }
1587
1589
 
1588
1590
  /**
1589
- * Functions and external fields can be used in your integration flow with Airwallex element
1591
+ * Element functions can be used in your integration flow with Airwallex element.
1590
1592
  */
1591
1593
  export interface ApplePayButtonElementType extends ElementBaseType {
1592
1594
  /**
1593
- * Using this function to update the element option after create the element
1595
+ * Using this function to update the element option after create the element.
1594
1596
  * @example
1595
- ```ts
1596
- element.update({
1597
- buttonType: 'donate',
1598
- }, {
1599
- locale: 'en',
1600
- });
1601
- ```
1597
+ * ```ts
1598
+ * element.update({
1599
+ * buttonType: 'donate',
1600
+ * }, {
1601
+ * locale: 'en',
1602
+ * });
1603
+ * ```
1602
1604
  */
1603
1605
  update(options?: Partial<ApplePayButtonUpdateOptions>, initOptions?: Partial<InitOptions>): void;
1604
1606
 
1605
1607
  /**
1606
1608
  * Listen to element event
1607
- *
1609
+ *
1608
1610
  * @example
1609
- ```ts
1610
- element.on('success', () => {
1611
- // Handle success event
1612
- });
1613
- ```
1614
- */
1611
+ * ```ts
1612
+ * element.on('success', () => {
1613
+ * // Handle success event
1614
+ * });
1615
+ * ```
1616
+ */
1615
1617
  on(event: ApplePayButtonEvent, handler: EventListener): void;
1616
1618
  /**
1617
- * Using this function to confirm payment intent
1619
+ * Using this function to confirm payment intent.
1618
1620
  * @example
1619
- ```ts
1620
- element.confirmIntent({
1621
- client_secret: intent?.client_secret,
1622
- });
1623
- ```
1621
+ * ```ts
1622
+ * element.confirmIntent({
1623
+ * client_secret: intent?.client_secret,
1624
+ * });
1625
+ * ```
1624
1626
  */
1625
1627
  confirmIntent(data: ParameterObject): Promise<Intent>;
1626
1628
  /**
1627
- * Using this function to create payment consent
1629
+ * Using this function to create payment consent.
1628
1630
  * @example
1629
- ```ts
1630
- element.createPaymentConsent({
1631
- client_secret: intent?.client_secret,
1632
- });
1633
- ```
1631
+ * ```ts
1632
+ * element.createPaymentConsent({
1633
+ * client_secret: intent?.client_secret,
1634
+ * });
1635
+ * ```
1634
1636
  */
1635
1637
  createPaymentConsent(data: ParameterObject): Promise<Consent | undefined>;
1636
1638
  /**
1637
1639
  *
1638
1640
  * @param merchantSession - An opaque message session object.
1639
1641
  * @example
1640
- ```ts
1641
- element.completeValidation({
1642
- epochTimestamp: 1721269728247,
1643
- expiresAt: 1721273328247,
1644
- merchantSessionIdentifier: 'xxx',
1645
- nonce: '9c283350',
1646
- merchantIdentifier: 'xxx',
1647
- domainName: 'your domain name',
1648
- displayName: 'Sawayn, O\'Conner and Quigley',
1649
- signature: 'xxx',
1650
- operationalAnalyticsIdentifier: 'xxx',
1651
- retries: 0,
1652
- pspId: 'xxx',
1653
- });
1654
- ```
1642
+ * ```ts
1643
+ * element.completeValidation({
1644
+ * epochTimestamp: 1721269728247,
1645
+ * expiresAt: 1721273328247,
1646
+ * merchantSessionIdentifier: 'SSH16075688527B4E',
1647
+ * nonce: '9c283350',
1648
+ * merchantIdentifier: '3409DA66CE0',
1649
+ * domainName: 'your domain name',
1650
+ * displayName: 'Sawayn, Conner and Quigley',
1651
+ * signature: '308006092a86',
1652
+ * operationalAnalyticsIdentifier: 'Carroll, Swaniawski',
1653
+ * retries: 0,
1654
+ * pspId: '803FB3E0FC',
1655
+ * });
1656
+ * ```
1655
1657
  */
1656
1658
  completeValidation(merchantSession: unknown): void;
1657
1659
  }
@@ -1666,31 +1668,31 @@ export type DropInElementEvent =
1666
1668
  | 'pendingVerifyAccount';
1667
1669
 
1668
1670
  /**
1669
- * Functions and external fields can be used in your integration flow with Airwallex element
1671
+ * Element functions can be used in your integration flow with Airwallex element.
1670
1672
  */
1671
1673
  export interface DropInElementType extends ElementBaseType {
1672
1674
  /**
1673
- * Using this function to update the element option after create the element
1675
+ * Using this function to update the element option after create the element.
1674
1676
  * @example
1675
- ```ts
1676
- element.update({
1677
- methods: ['card'],
1678
- }, {
1679
- locale: 'en',
1680
- });
1681
- ```
1677
+ * ```ts
1678
+ * element.update({
1679
+ * methods: ['card'],
1680
+ * }, {
1681
+ * locale: 'en',
1682
+ * });
1683
+ * ```
1682
1684
  */
1683
1685
  update(options?: Partial<DropInElementOptions>, initOptions?: Partial<InitOptions>): void;
1684
1686
  /**
1685
- * Listen to element event
1686
- *
1687
+ * Listen to element event.
1688
+ *
1687
1689
  * @example
1688
- ```ts
1689
- element.on('success', () => {
1690
- // Handle success event
1691
- });
1692
- ```
1693
- */
1690
+ * ```ts
1691
+ * element.on('success', () => {
1692
+ * // Handle success event
1693
+ * });
1694
+ * ```
1695
+ */
1694
1696
  on(event: DropInElementEvent, handler: EventListener): void;
1695
1697
  }
1696
1698
 
@@ -1704,159 +1706,167 @@ export type GooglePayButtonEvent =
1704
1706
  | 'shippingAddressChange'
1705
1707
  | 'shippingMethodChange';
1706
1708
  /**
1707
- * Functions and external fields can be used in your integration flow with Airwallex element
1709
+ * Element functions can be used in your integration flow with Airwallex element.
1708
1710
  */
1709
1711
  export interface GooglePayButtonElementType extends ElementBaseType {
1710
1712
  /**
1711
- * Using this function to update the element option after create the element
1713
+ * Using this function to update the element option after create the element.
1712
1714
  * @example
1713
- ```ts
1714
- element.update({
1715
- autoCapture: true,
1716
- }, {
1717
- locale: 'en',
1718
- });
1715
+ * ```ts
1716
+ * element.update({
1717
+ * autoCapture: true,
1718
+ * }, {
1719
+ * locale: 'en',
1720
+ * });
1721
+ * ```
1719
1722
  ```
1720
1723
  */
1721
1724
  update(options?: Partial<GooglePayButtonOptions>, initOptions?: Partial<InitOptions>): void;
1722
1725
 
1723
1726
  /**
1724
- * Listen to element event
1725
- *
1727
+ * Listen to element event.
1728
+ *
1726
1729
  * @example
1727
- ```ts
1728
- element.on('success', () => {
1729
- // Handle success event
1730
- });
1731
- ```
1732
- */
1730
+ * ```ts
1731
+ * element.on('success', () => {
1732
+ * // Handle success event
1733
+ * });
1734
+ * ```
1735
+ */
1733
1736
  on(event: GooglePayButtonEvent, handler: EventListener): void;
1734
1737
 
1735
1738
  /**
1736
- * Using this function to confirm payment intent
1739
+ * Using this function to confirm payment intent.
1737
1740
  * @example
1738
- ```ts
1739
- element.confirmIntent({
1740
- client_secret: 'xxx'
1741
- });
1742
- ```
1741
+ * ```ts
1742
+ * element.confirmIntent({
1743
+ * client_secret: 'replace-with-your-client-secret',
1744
+ * });
1745
+ * ```
1743
1746
  */
1744
1747
  confirmIntent(data: ParameterObject): Promise<Intent>;
1745
1748
  /**
1746
- * Using this function to create payment consent
1747
- * @param data client_secret returned in create intent response or returned in create customer response
1748
- * @example
1749
- ```ts
1750
- element.createPaymentConsent({
1751
- client_secret: 'xxx'
1752
- });
1753
- ```
1749
+ * Using this function to create payment consent.
1750
+ * @example
1751
+ * ```ts
1752
+ * element.createPaymentConsent({
1753
+ * client_secret: 'replace-with-your-client-secret',
1754
+ * });
1755
+ * ```
1754
1756
  */
1755
1757
  createPaymentConsent(data: ParameterObject): Promise<Consent | undefined>;
1756
1758
  }
1757
1759
 
1758
1760
  export type WechatElementEvent = 'ready' | 'success' | 'error';
1759
1761
  /**
1760
- * @deprecated Use {@link DropInElementType} instead
1762
+ * @deprecated Use {@link DropInElementType} instead.
1761
1763
  */
1762
1764
  export interface WechatElementType extends ElementBaseType {
1763
1765
  /**
1764
- * Using this function to update the element option after create the element
1765
- * @example
1766
- ```ts
1767
- element.update({
1768
- intent: {
1769
- id: 'xxx',
1770
- client_secret: 'xxx',
1771
- }
1772
- });
1773
- ```
1766
+ * Using this function to update the element option after create the element.
1767
+ * @example
1768
+ * ```ts
1769
+ * element.update({
1770
+ * intent: {
1771
+ * id: 'replace-with-your-intent-id',
1772
+ * client_secret: 'replace-with-your-client-secret',
1773
+ * }
1774
+ * });
1775
+ * ```
1774
1776
  */
1775
1777
  update(options?: Partial<WechatElementOptions>, initOptions?: Partial<InitOptions>): void;
1776
1778
  /**
1777
- * Listen to element event
1778
- *
1779
+ * Listen to element event.
1780
+ *
1779
1781
  * @example
1780
- ```ts
1781
- element.on('ready', () => {
1782
- // Handle ready event
1783
- });
1784
- ```
1785
- */
1782
+ * ```ts
1783
+ * element.on('ready', () => {
1784
+ * // Handle ready event
1785
+ * });
1786
+ * ```
1787
+ */
1786
1788
  on(event: WechatElementEvent, handler: EventListener): void;
1787
1789
  }
1788
1790
 
1789
1791
  export type QrcodeElementEvent = 'ready' | 'success' | 'error';
1790
1792
  /**
1791
- * @deprecated Use {@link DropInElementType} instead
1793
+ * @deprecated Use {@link DropInElementType} instead.
1792
1794
  */
1793
1795
  export interface QrcodeElementType extends ElementBaseType {
1794
1796
  /**
1795
- * Using this function to update the element option after create the element
1797
+ * Using this function to update the element option after create the element.
1798
+ * @example
1799
+ * ```ts
1800
+ * element.update({
1801
+ * autoCapture: true,
1802
+ * }, {
1803
+ * locale: 'en',
1804
+ * });
1805
+ * ```
1796
1806
  */
1797
1807
  update(options?: Partial<QrcodeElementOptions>, initOptions?: Partial<InitOptions>): void;
1798
1808
  /**
1799
- * Listen to element event
1800
- *
1809
+ * Listen to element event.
1810
+ *
1801
1811
  * @example
1802
- ```ts
1803
- element.on('change', () => {
1804
- // Handle change event
1805
- });
1806
- ```
1807
- */
1812
+ * ```ts
1813
+ * element.on('change', () => {
1814
+ * // Handle change event
1815
+ * });
1816
+ * ```
1817
+ */
1808
1818
  on(event: QrcodeElementEvent, handler: EventListener): void;
1809
1819
  }
1810
1820
 
1811
1821
  type FullFeaturedCardElementEvent = 'ready' | 'success' | 'error';
1812
1822
 
1813
1823
  /**
1814
- * @deprecated Use {@link DropInElementType} instead
1824
+ * @deprecated Use {@link DropInElementType} instead.
1815
1825
  */
1816
1826
  export interface FullFeaturedCardElementType extends ElementBaseType {
1817
1827
  /**
1818
- * Using this function to update the element option after create the element
1828
+ * Using this function to update the element option after create the element.
1819
1829
  * @example
1820
- ```ts
1821
- element.update({
1822
- autoCapture: true,
1823
- }, {
1824
- locale: 'en',
1825
- });
1826
- ```
1830
+ * ```ts
1831
+ * element.update({
1832
+ * autoCapture: true,
1833
+ * }, {
1834
+ * locale: 'en',
1835
+ * });
1836
+ * ```
1827
1837
  */
1828
1838
  update(options?: Partial<FullFeaturedCardElementOptions>, initOptions?: Partial<InitOptions>): void;
1829
1839
  /**
1830
- * Listen to element event
1831
- *
1840
+ * Listen to element event.
1841
+ *
1832
1842
  * @example
1833
- ```ts
1834
- element.on('change', () => {
1835
- // Handle change event
1836
- });
1837
- ```
1838
- */
1843
+ * ```ts
1844
+ * element.on('change', () => {
1845
+ * // Handle change event
1846
+ * });
1847
+ * ```
1848
+ */
1839
1849
  on(event: FullFeaturedCardElementEvent, handler: EventListener): void;
1840
1850
  }
1841
1851
 
1842
1852
  export type RedirectElementEvent = 'ready' | 'success' | 'error';
1843
1853
  /**
1844
- * @deprecated Use {@link DropInElementType} instead
1854
+ * @deprecated Use {@link DropInElementType} instead.
1845
1855
  */
1846
1856
  export interface RedirectElementType extends ElementBaseType {
1847
1857
  /**
1848
- * Using this function to update the element option after create the element
1858
+ * Using this function to update the element option after create the element.
1849
1859
  */
1850
1860
  update(options?: Partial<RedirectElementOptions>, initOptions?: Partial<InitOptions>): void;
1851
1861
  /**
1852
- * Listen to element event
1853
- *
1862
+ * Listen to element event.
1863
+ *
1854
1864
  * @example
1855
- ```ts
1856
- element.on('change', () => {
1857
- // Handle change event
1858
- });
1859
- ```
1860
- */
1865
+ * ```ts
1866
+ * element.on('change', () => {
1867
+ * // Handle change event
1868
+ * });
1869
+ * ```
1870
+ */
1861
1871
  on(event: RedirectElementEvent, handler: EventListener): void;
1862
1872
  }
package/types/index.d.ts CHANGED
@@ -16,6 +16,8 @@ import Airwallex, {
16
16
  confirmPaymentIntentWithSavedCard,
17
17
  createPaymentMethod,
18
18
  PaymentConsentRequest,
19
+ PaymentConsentRequestData,
20
+ PaymentMethodRequestData,
19
21
  PaymentConsentResponse,
20
22
  createPaymentConsent,
21
23
  getPaymentIntent,
@@ -46,6 +48,8 @@ export {
46
48
  confirmPaymentIntentWithSavedCard,
47
49
  createPaymentMethod,
48
50
  PaymentConsentRequest,
51
+ PaymentConsentRequestData,
52
+ PaymentMethodRequestData,
49
53
  PaymentConsentResponse,
50
54
  createPaymentConsent,
51
55
  getPaymentIntent,