airwallexInit.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514
  1. import { init, type InitResult,createElement, type Payment } from '@airwallex/components-sdk';
  2. import { env } from "@/env";
  3. // ============================================================
  4. // Types
  5. // ============================================================
  6. export type AirwallexCartNumberElementType = Payment.CardNumberElementType;
  7. export type AirwallexCvcElementType = Payment.CvcElementType;
  8. export type AirwallexExpiryDateElementType = Payment.ExpiryDateElementType;
  9. export interface AirwallexCardElements{
  10. cardNumber?: AirwallexCartNumberElementType;
  11. cvc?: AirwallexCvcElementType;
  12. expiry?: AirwallexExpiryDateElementType;
  13. }
  14. type ElementType =
  15. | AirwallexCartNumberElementType
  16. | AirwallexCvcElementType
  17. | AirwallexExpiryDateElementType;
  18. // ============================================================
  19. // Snapshot
  20. // ============================================================
  21. export interface AirwallexCardSnapshot {
  22. cardNumberReady: boolean;
  23. cvcReady: boolean;
  24. expiryReady: boolean;
  25. cardNumberValid: boolean;
  26. cvcValid: boolean;
  27. expiryValid: boolean;
  28. cardNumberErrorMsg: string;
  29. cvcErrorMsg: string;
  30. expiryErrorMsg: string;
  31. }
  32. // ============================================================
  33. // Initial Snapshot
  34. // ============================================================
  35. const initialSnapshot: AirwallexCardSnapshot = {
  36. cardNumberReady: false,
  37. cvcReady: false,
  38. expiryReady: false,
  39. cardNumberValid: false,
  40. cvcValid: false,
  41. expiryValid: false,
  42. cardNumberErrorMsg: '',
  43. cvcErrorMsg: '',
  44. expiryErrorMsg: '',
  45. };
  46. // ============================================================
  47. // Airwallex SDK init
  48. // ============================================================
  49. let initPromise: Promise<InitResult> | null = null;
  50. export function airwallexInit() {
  51. if (!initPromise) {
  52. initPromise = init({
  53. env:
  54. env.NEXT_PUBLIC_APP_ENV !== 'production'
  55. ? 'demo'
  56. : 'prod',
  57. enabledElements: ['payments'],
  58. }).catch((err) => {
  59. initPromise = null;
  60. throw err;
  61. });
  62. }
  63. return initPromise;
  64. }
  65. // ============================================================
  66. // Manager
  67. // ============================================================
  68. // 创建的cardNumber,cvc,expiry输入框挂载到页面上的某个元素上才能渲染出来
  69. // 修改购物车数据后,需要重新获取支付方式列表,要想实现销毁-->重建卡支付输入框,必须要在销毁后把挂载的那个元素也删除,否则新创建的输入框上的绑定的事件会重发触发
  70. // 所以进行此次优化
  71. class AirwallexManager {
  72. // --------------------------------------------------------
  73. // Airwallex Elements
  74. // --------------------------------------------------------
  75. private elements: AirwallexCardElements = {};
  76. private createPromise: Promise<AirwallexCardElements> | null = null;
  77. // 引入使用者计数(现在是全局单例模式,这里的全局指的是以页面的生命周期为准,对于卡支付输入框,全局只有一个地方可以初始化,每次初始化后,全局只有一个实例)
  78. // 所以这里引入的refCount是一个过度防御
  79. // 当把airwallex的卡支付初始化与卡支付输入框的状态订阅拆分后,这个refCount已不那么需要(可以删除),但还是保留
  80. private refCount = 0;
  81. // --------------------------------------------------------
  82. // React external store
  83. // --------------------------------------------------------
  84. private snapshot: AirwallexCardSnapshot = {
  85. ...initialSnapshot,
  86. };
  87. private listeners = new Set<() => void>(); // 集合类型,用来保存监听器
  88. // 参数listener是react内部的监听函数
  89. // 当把subscribe传给useSyncExternalStore后,react在内部调用subscribe时把自己的监听函数传给subscribe
  90. subscribe = (listener: () => void) => {
  91. // 把react的监听函数保存到集合
  92. this.listeners.add(listener);
  93. // 取消订阅时(比如组件卸载时),删除保存的监听函数
  94. return () => {
  95. this.listeners.delete(listener);
  96. };
  97. };
  98. // react传给subscribe的监听函数里会调用getSnapshot重新获取数据快照
  99. getSnapshot = () => {
  100. return this.snapshot;
  101. };
  102. private emit() {
  103. this.listeners.forEach((listener) => {
  104. listener();
  105. });
  106. }
  107. private updateSnapshot( patch: Partial<AirwallexCardSnapshot> ) {
  108. this.snapshot = {
  109. ...this.snapshot,
  110. ...patch,
  111. };
  112. // 修改数据后,触发react的监听器,监听器里重现获取数据快照,数据变了,react重新渲染组件
  113. this.emit();
  114. }
  115. private resetSnapshot() {
  116. this.snapshot = {
  117. ...initialSnapshot,
  118. };
  119. this.emit();
  120. }
  121. //
  122. setRefCount() {
  123. this.refCount++;
  124. console.log(
  125. '[Airwallex] acquire:',
  126. this.refCount
  127. );
  128. }
  129. release() {
  130. if (this.refCount === 0) {
  131. return;
  132. }
  133. this.refCount--;
  134. console.log(
  135. '[Airwallex] release:',
  136. this.refCount
  137. );
  138. if (this.refCount === 0) {
  139. console.log('_____________________________AirwallexCard destory ___________________________________')
  140. this.destroy();
  141. }
  142. }
  143. async createElements() {
  144. if (this.elements.cardNumber) {
  145. return this.elements;
  146. }
  147. if (this.createPromise) {
  148. return this.createPromise;
  149. }
  150. this.createPromise = Promise.all([
  151. createElement("cardNumber"),
  152. createElement("cvc"),
  153. createElement("expiry")
  154. ]).then(([cardNumber,cvc,expiry]) => {
  155. this.elements = {
  156. cardNumber,
  157. cvc,
  158. expiry
  159. };
  160. return this.elements;
  161. }).catch((error) => {
  162. // 创建失败,允许下一次重新创建
  163. this.createPromise = null;
  164. throw error;
  165. });
  166. return this.createPromise;
  167. }
  168. mount(containerIds: {
  169. cardNumber: string;
  170. cvc: string;
  171. expiry: string;
  172. }) {
  173. this.elements.cardNumber?.mount(containerIds.cardNumber);
  174. this.elements.cvc?.mount(containerIds.cvc);
  175. this.elements.expiry?.mount(containerIds.expiry);
  176. }
  177. on<EventCode extends Payment.SplitElementEventCode>(
  178. el: ElementType,
  179. event: EventCode,
  180. handler: Payment.SplitElementEventHandler<EventCode>
  181. ) {
  182. el.on(event, handler);
  183. }
  184. elementsBindHandler() {
  185. const { cardNumber, cvc, expiry } = this.elements;
  186. if(!cardNumber || !cvc || !expiry) {
  187. throw new Error('Airwallex elements have not been created!');
  188. }
  189. cardNumber.on("focus", (e) => {
  190. this.handleFocus(e)
  191. });
  192. cardNumber.on("blur", (e) => {
  193. this.handleBlur(e);
  194. });
  195. cardNumber.on("change", (e) => {
  196. this.handleChange(e);
  197. });
  198. cardNumber.on("ready", (e) => {
  199. this.handleReady(e);
  200. });
  201. cvc.on("focus", (e) => {
  202. this.handleFocus(e)
  203. });
  204. cvc.on("blur", (e) => {
  205. this.handleBlur(e);
  206. });
  207. cvc.on("change", (e) => {
  208. this.handleChange(e);
  209. });
  210. cvc.on("ready", (e) => {
  211. this.handleReady(e);
  212. });
  213. expiry.on("focus", (e) => {
  214. this.handleFocus(e)
  215. });
  216. expiry.on("blur", (e) => {
  217. this.handleBlur(e);
  218. });
  219. expiry.on("change", (e) => {
  220. this.handleChange(e);
  221. });
  222. expiry.on("ready", (e) => {
  223. this.handleReady(e);
  224. });
  225. }
  226. // ========================================================
  227. // Airwallex event handlers
  228. // ========================================================
  229. handleReady(event: any) {
  230. console.log('-----------------airwallex card ready-----------------');
  231. const { type } = event.detail;
  232. if (type === 'cardNumber') {
  233. this.updateSnapshot({
  234. cardNumberReady: true,
  235. });
  236. return;
  237. }
  238. if (type === 'cvc') {
  239. this.updateSnapshot({
  240. cvcReady: true,
  241. });
  242. return;
  243. }
  244. if (type === 'expiry') {
  245. this.updateSnapshot({
  246. expiryReady: true,
  247. });
  248. return;
  249. }
  250. }
  251. handleChange(event: any) {
  252. const {
  253. type,
  254. complete,
  255. error,
  256. } = event.detail;
  257. const message = error?.message ?? '';
  258. if (type === 'cardNumber') {
  259. this.updateSnapshot({
  260. cardNumberValid: complete,
  261. cardNumberErrorMsg: message,
  262. });
  263. return;
  264. }
  265. if (type === 'cvc') {
  266. this.updateSnapshot({
  267. cvcValid: complete,
  268. cvcErrorMsg: message,
  269. });
  270. return;
  271. }
  272. if (type === 'expiry') {
  273. this.updateSnapshot({
  274. expiryValid: complete,
  275. expiryErrorMsg: message,
  276. });
  277. return;
  278. }
  279. }
  280. handleFocus(event: any) {
  281. const { type } = event.detail;
  282. if (type === 'cardNumber') {
  283. this.updateSnapshot({
  284. cardNumberErrorMsg: '',
  285. });
  286. return;
  287. }
  288. if (type === 'cvc') {
  289. this.updateSnapshot({
  290. cvcErrorMsg: '',
  291. });
  292. return;
  293. }
  294. if (type === 'expiry') {
  295. this.updateSnapshot({
  296. expiryErrorMsg: '',
  297. });
  298. return;
  299. }
  300. }
  301. handleBlur(event: any) {
  302. const {
  303. type,
  304. error,
  305. } = event.detail;
  306. const message = error?.message ?? JSON.stringify(error);
  307. if (type === 'cardNumber') {
  308. this.updateSnapshot({
  309. cardNumberErrorMsg: message,
  310. });
  311. return;
  312. }
  313. if (type === 'cvc') {
  314. this.updateSnapshot({
  315. cvcErrorMsg: message,
  316. });
  317. return;
  318. }
  319. if (type === 'expiry') {
  320. this.updateSnapshot({
  321. expiryErrorMsg: message,
  322. });
  323. return;
  324. }
  325. }
  326. // ========================================================
  327. // Validation
  328. // ========================================================
  329. validateCard(): {valid: boolean; msg: string} {
  330. const state = this.snapshot;
  331. if (!state.cardNumberReady) {
  332. return {
  333. valid: false,
  334. msg: 'Card number input has not ready. Please wait a minute.'
  335. };
  336. }
  337. if (!state.expiryReady) {
  338. return {
  339. valid: false,
  340. msg: 'Card expiry date input has not ready. Please wait a minute.'
  341. };
  342. }
  343. if (!state.cvcReady) {
  344. return {
  345. valid: false,
  346. msg: 'Card cvc input has not ready. Please wait a minute.'
  347. };
  348. }
  349. if (!state.cardNumberValid) {
  350. return {
  351. valid: false,
  352. msg: state.cardNumberErrorMsg || 'Please input your card number.'
  353. };
  354. }
  355. if (!state.expiryValid) {
  356. return {
  357. valid: false,
  358. msg: state.expiryErrorMsg || 'Please input expiry date.'
  359. };
  360. }
  361. if (!state.cvcValid) {
  362. return {
  363. valid: false,
  364. msg: state.cvcErrorMsg || 'Please input cvc.'
  365. };
  366. }
  367. return {
  368. valid: true,
  369. msg: ''
  370. };
  371. }
  372. destroy() {
  373. const { cardNumber, cvc, expiry } = this.elements;
  374. [cardNumber, cvc, expiry].forEach((el) => {
  375. if (!el) return;
  376. el.unmount();
  377. el.destroy();
  378. });
  379. this.elements = {};
  380. this.createPromise=null;
  381. this.resetSnapshot();
  382. }
  383. getElements() {
  384. return this.elements;
  385. }
  386. getCardNumberElement() {
  387. return this.elements.cardNumber;
  388. }
  389. }
  390. export const airwallexManager = new AirwallexManager();