@internetarchive/donation-form 1.0.1 → 1.0.3-alpha-webdev7960.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 (211) hide show
  1. package/LICENSE +661 -661
  2. package/README.md +115 -115
  3. package/dist/demo/braintree-endpoint-manager.js.map +1 -1
  4. package/dist/demo/demo-analytics-handler.js.map +1 -1
  5. package/dist/demo/submit-form-with.js.map +1 -1
  6. package/dist/index.js.map +1 -1
  7. package/dist/src/braintree-manager/braintree-interfaces.js.map +1 -1
  8. package/dist/src/braintree-manager/braintree-manager.js.map +1 -1
  9. package/dist/src/braintree-manager/payment-clients.js.map +1 -1
  10. package/dist/src/braintree-manager/payment-providers/apple-pay/apple-pay-interface.js.map +1 -1
  11. package/dist/src/braintree-manager/payment-providers/apple-pay/apple-pay-session-datasource-delegate.js.map +1 -1
  12. package/dist/src/braintree-manager/payment-providers/apple-pay/apple-pay-session-datasource-interface.js.map +1 -1
  13. package/dist/src/braintree-manager/payment-providers/apple-pay/apple-pay-session-datasource.js.map +1 -1
  14. package/dist/src/braintree-manager/payment-providers/apple-pay/apple-pay-session-manager.js.map +1 -1
  15. package/dist/src/braintree-manager/payment-providers/apple-pay/apple-pay.js.map +1 -1
  16. package/dist/src/braintree-manager/payment-providers/credit-card/credit-card-interface.js.map +1 -1
  17. package/dist/src/braintree-manager/payment-providers/credit-card/credit-card.js.map +1 -1
  18. package/dist/src/braintree-manager/payment-providers/credit-card/hosted-field-configuration.js.map +1 -1
  19. package/dist/src/braintree-manager/payment-providers/credit-card/hosted-field-container.js.map +1 -1
  20. package/dist/src/braintree-manager/payment-providers/google-pay-interface.js.map +1 -1
  21. package/dist/src/braintree-manager/payment-providers/google-pay.js.map +1 -1
  22. package/dist/src/braintree-manager/payment-providers/paypal/paypal-button-datasource.js.map +1 -1
  23. package/dist/src/braintree-manager/payment-providers/paypal/paypal-interface.js.map +1 -1
  24. package/dist/src/braintree-manager/payment-providers/paypal/paypal.js.map +1 -1
  25. package/dist/src/braintree-manager/payment-providers/venmo-interface.js.map +1 -1
  26. package/dist/src/braintree-manager/payment-providers/venmo.js.map +1 -1
  27. package/dist/src/braintree-manager/payment-providers-interface.js.map +1 -1
  28. package/dist/src/braintree-manager/payment-providers.js.map +1 -1
  29. package/dist/src/donation-form-controller.js +123 -123
  30. package/dist/src/donation-form-controller.js.map +1 -1
  31. package/dist/src/donation-form-error.js.map +1 -1
  32. package/dist/src/donation-form.js +107 -107
  33. package/dist/src/donation-form.js.map +1 -1
  34. package/dist/src/form-elements/badged-input.js +47 -47
  35. package/dist/src/form-elements/badged-input.js.map +1 -1
  36. package/dist/src/form-elements/contact-form/autocomplete-field-options.js.map +1 -1
  37. package/dist/src/form-elements/contact-form/contact-form.js +157 -157
  38. package/dist/src/form-elements/contact-form/contact-form.js.map +1 -1
  39. package/dist/src/form-elements/contact-form/countries.js.map +1 -1
  40. package/dist/src/form-elements/header/donation-form-header.js +14 -14
  41. package/dist/src/form-elements/header/donation-form-header.js.map +1 -1
  42. package/dist/src/form-elements/header/donation-summary.js +15 -15
  43. package/dist/src/form-elements/header/donation-summary.js.map +1 -1
  44. package/dist/src/form-elements/payment-selector.js +164 -164
  45. package/dist/src/form-elements/payment-selector.js.map +1 -1
  46. package/dist/src/form-elements/total-amount.js +16 -16
  47. package/dist/src/form-elements/total-amount.js.map +1 -1
  48. package/dist/src/modals/confirm-donation-modal-content.js +51 -51
  49. package/dist/src/modals/confirm-donation-modal-content.js.map +1 -1
  50. package/dist/src/modals/error-modal-content.js +22 -22
  51. package/dist/src/modals/error-modal-content.js.map +1 -1
  52. package/dist/src/modals/upsell-modal-content.js +182 -182
  53. package/dist/src/modals/upsell-modal-content.js.map +1 -1
  54. package/dist/src/payment-flow-handlers/donation-flow-modal-manager.js +20 -20
  55. package/dist/src/payment-flow-handlers/donation-flow-modal-manager.js.map +1 -1
  56. package/dist/src/payment-flow-handlers/handlers/applepay-flow-handler.js.map +1 -1
  57. package/dist/src/payment-flow-handlers/handlers/creditcard-flow-handler.js.map +1 -1
  58. package/dist/src/payment-flow-handlers/handlers/googlepay-flow-handler.js.map +1 -1
  59. package/dist/src/payment-flow-handlers/handlers/paypal-flow-handler.js.map +1 -1
  60. package/dist/src/payment-flow-handlers/handlers/venmo-flow-handler.js.map +1 -1
  61. package/dist/src/payment-flow-handlers/handlers/venmo-restoration-state-handler.js.map +1 -1
  62. package/dist/src/payment-flow-handlers/payment-flow-handlers.js.map +1 -1
  63. package/dist/src/recaptcha-manager/recaptcha-manager.js.map +1 -1
  64. package/dist/src/util/promisedSleep.js.map +1 -1
  65. package/dist/test/helpers/fillInContactForm.js.map +1 -1
  66. package/dist/test/mocks/flow-handlers/individual-handlers/mock-applepay-flow-handler.js.map +1 -1
  67. package/dist/test/mocks/flow-handlers/individual-handlers/mock-creditcard-flow-handler.js.map +1 -1
  68. package/dist/test/mocks/flow-handlers/individual-handlers/mock-googlepay-flow-handler.js.map +1 -1
  69. package/dist/test/mocks/flow-handlers/individual-handlers/mock-paypal-flow-handler.js.map +1 -1
  70. package/dist/test/mocks/flow-handlers/individual-handlers/mock-venmo-flow-handler.js.map +1 -1
  71. package/dist/test/mocks/flow-handlers/mock-payment-flow-handlers.js.map +1 -1
  72. package/dist/test/mocks/mock-braintree-manager.js.map +1 -1
  73. package/dist/test/mocks/mock-donation-info.js.map +1 -1
  74. package/dist/test/mocks/mock-endpoint-manager.js.map +1 -1
  75. package/dist/test/mocks/mock-hosted-fields-config.js.map +1 -1
  76. package/dist/test/mocks/mock-hosted-fields-container.js.map +1 -1
  77. package/dist/test/mocks/mock-lazy-loader.js.map +1 -1
  78. package/dist/test/mocks/mock-modal-manager.js.map +1 -1
  79. package/dist/test/mocks/mock-payment-clients.js.map +1 -1
  80. package/dist/test/mocks/mock-paypal-button-renderer.js.map +1 -1
  81. package/dist/test/mocks/mock-recaptcha-manager.js.map +1 -1
  82. package/dist/test/mocks/models/mock-billing-info.js.map +1 -1
  83. package/dist/test/mocks/models/mock-custom-fields.js.map +1 -1
  84. package/dist/test/mocks/models/mock-customer-info.js.map +1 -1
  85. package/dist/test/mocks/models/mock-donation-request.js.map +1 -1
  86. package/dist/test/mocks/models/mock-success-response.js.map +1 -1
  87. package/dist/test/mocks/payment-clients/mock-applepay-client.js.map +1 -1
  88. package/dist/test/mocks/payment-clients/mock-applepay-payment.js.map +1 -1
  89. package/dist/test/mocks/payment-clients/mock-applepay-paymentauthorizedevent.js.map +1 -1
  90. package/dist/test/mocks/payment-clients/mock-applepay-session.js.map +1 -1
  91. package/dist/test/mocks/payment-clients/mock-applepay-sessionmanager.js.map +1 -1
  92. package/dist/test/mocks/payment-clients/mock-applepay-validatemerchantevent.js.map +1 -1
  93. package/dist/test/mocks/payment-clients/mock-braintree-client.js.map +1 -1
  94. package/dist/test/mocks/payment-clients/mock-data-collector.js.map +1 -1
  95. package/dist/test/mocks/payment-clients/mock-googlepay-client.js.map +1 -1
  96. package/dist/test/mocks/payment-clients/mock-googlepay-library.js.map +1 -1
  97. package/dist/test/mocks/payment-clients/mock-grecaptcha.js.map +1 -1
  98. package/dist/test/mocks/payment-clients/mock-hostedfields-client.js.map +1 -1
  99. package/dist/test/mocks/payment-clients/mock-hostedfieldstateobject-generator.js.map +1 -1
  100. package/dist/test/mocks/payment-clients/mock-hostedfieldtokenizepayload.js.map +1 -1
  101. package/dist/test/mocks/payment-clients/mock-paypal-client.js.map +1 -1
  102. package/dist/test/mocks/payment-clients/mock-paypal-library.js.map +1 -1
  103. package/dist/test/mocks/payment-clients/mock-venmo-client.js.map +1 -1
  104. package/dist/test/mocks/payment-providers/individual-providers/mock-applepay-datasource-delegate.js.map +1 -1
  105. package/dist/test/mocks/payment-providers/individual-providers/mock-applepay-handler.js.map +1 -1
  106. package/dist/test/mocks/payment-providers/individual-providers/mock-creditcard-handler.js.map +1 -1
  107. package/dist/test/mocks/payment-providers/individual-providers/mock-googlepay-handler.js.map +1 -1
  108. package/dist/test/mocks/payment-providers/individual-providers/mock-paypal-button-datasource-delegate.js.map +1 -1
  109. package/dist/test/mocks/payment-providers/individual-providers/mock-paypal-button-datasource.js.map +1 -1
  110. package/dist/test/mocks/payment-providers/individual-providers/mock-paypal-handler.js.map +1 -1
  111. package/dist/test/mocks/payment-providers/individual-providers/mock-venmo-handler.js.map +1 -1
  112. package/dist/test/mocks/payment-providers/mock-payment-providers.js.map +1 -1
  113. package/dist/test/tests/braintree-manager.test.js.map +1 -1
  114. package/dist/test/tests/donation-form-controller.test.js +39 -39
  115. package/dist/test/tests/donation-form-controller.test.js.map +1 -1
  116. package/dist/test/tests/donation-form.test.js +4 -4
  117. package/dist/test/tests/donation-form.test.js.map +1 -1
  118. package/dist/test/tests/flow-handlers/donation-flow-modal-manager.test.js +14 -14
  119. package/dist/test/tests/flow-handlers/donation-flow-modal-manager.test.js.map +1 -1
  120. package/dist/test/tests/form-elements/donation-summary.test.js.map +1 -1
  121. package/dist/test/tests/form-elements/payment-selector.test.js.map +1 -1
  122. package/dist/test/tests/modals/error-modal-content.test.js +2 -2
  123. package/dist/test/tests/modals/error-modal-content.test.js.map +1 -1
  124. package/dist/test/tests/modals/upsell-modal-content.test.js +31 -31
  125. package/dist/test/tests/modals/upsell-modal-content.test.js.map +1 -1
  126. package/dist/test/tests/models/donation-payment-info.test.js +5 -5
  127. package/dist/test/tests/models/donation-payment-info.test.js.map +1 -1
  128. package/dist/test/tests/payment-clients.test.js.map +1 -1
  129. package/dist/test/tests/payment-providers/applepay-sessiondatasource.test.js.map +1 -1
  130. package/dist/test/tests/payment-providers/applepay-sessionmanager.test.js.map +1 -1
  131. package/dist/test/tests/payment-providers/applepay.test.js.map +1 -1
  132. package/dist/test/tests/payment-providers/creditcard.test.js.map +1 -1
  133. package/dist/test/tests/payment-providers/googlepay.test.js.map +1 -1
  134. package/dist/test/tests/payment-providers/payment-providers.test.js.map +1 -1
  135. package/dist/test/tests/payment-providers/paypal-button-datasource.test.js.map +1 -1
  136. package/dist/test/tests/payment-providers/paypal.test.js.map +1 -1
  137. package/dist/test/tests/payment-providers/venmo.test.js.map +1 -1
  138. package/dist/test/tests/recaptcha-manager.test.js.map +1 -1
  139. package/package.json +107 -107
  140. package/src/@types/analytics-handler/index.d.ts +8 -8
  141. package/src/@types/braintree-web/LICENSE +21 -21
  142. package/src/@types/braintree-web/index.d.ts +93 -93
  143. package/src/@types/braintree-web/modules/american-express.d.ts +50 -50
  144. package/src/@types/braintree-web/modules/apple-pay.d.ts +213 -213
  145. package/src/@types/braintree-web/modules/client.d.ts +103 -103
  146. package/src/@types/braintree-web/modules/core.d.ts +34 -34
  147. package/src/@types/braintree-web/modules/data-collector.d.ts +13 -13
  148. package/src/@types/braintree-web/modules/google-payment.d.ts +269 -269
  149. package/src/@types/braintree-web/modules/hosted-fields.d.ts +366 -366
  150. package/src/@types/braintree-web/modules/paypal-checkout.d.ts +262 -262
  151. package/src/@types/braintree-web/modules/paypal.d.ts +177 -177
  152. package/src/@types/braintree-web/modules/three-d-secure.d.ts +141 -141
  153. package/src/@types/braintree-web/modules/unionpay.d.ts +224 -224
  154. package/src/@types/braintree-web/modules/us-bank-account.d.ts +81 -81
  155. package/src/@types/braintree-web/modules/venmo.d.ts +110 -110
  156. package/src/@types/braintree-web/package.json +64 -64
  157. package/src/@types/paypal-checkout-components/LICENSE +21 -21
  158. package/src/@types/paypal-checkout-components/index.d.ts +67 -67
  159. package/src/@types/paypal-checkout-components/modules/button.d.ts +50 -50
  160. package/src/@types/paypal-checkout-components/modules/callback-data.d.ts +244 -244
  161. package/src/@types/paypal-checkout-components/modules/configuration.d.ts +114 -114
  162. package/src/@types/paypal-checkout-components/package.json +58 -58
  163. package/src/braintree-manager/braintree-interfaces.ts +172 -172
  164. package/src/braintree-manager/braintree-manager.ts +281 -281
  165. package/src/braintree-manager/payment-clients.ts +146 -146
  166. package/src/braintree-manager/payment-providers/apple-pay/apple-pay-interface.ts +13 -13
  167. package/src/braintree-manager/payment-providers/apple-pay/apple-pay-session-datasource-delegate.ts +8 -8
  168. package/src/braintree-manager/payment-providers/apple-pay/apple-pay-session-datasource-interface.ts +10 -10
  169. package/src/braintree-manager/payment-providers/apple-pay/apple-pay-session-datasource.ts +119 -119
  170. package/src/braintree-manager/payment-providers/apple-pay/apple-pay-session-manager.ts +21 -21
  171. package/src/braintree-manager/payment-providers/apple-pay/apple-pay.ts +97 -97
  172. package/src/braintree-manager/payment-providers/credit-card/credit-card-interface.ts +21 -21
  173. package/src/braintree-manager/payment-providers/credit-card/credit-card.ts +130 -130
  174. package/src/braintree-manager/payment-providers/credit-card/hosted-field-configuration.ts +19 -19
  175. package/src/braintree-manager/payment-providers/credit-card/hosted-field-container.ts +85 -85
  176. package/src/braintree-manager/payment-providers/google-pay-interface.ts +8 -8
  177. package/src/braintree-manager/payment-providers/google-pay.ts +59 -59
  178. package/src/braintree-manager/payment-providers/paypal/paypal-button-datasource.ts +218 -218
  179. package/src/braintree-manager/payment-providers/paypal/paypal-interface.ts +13 -13
  180. package/src/braintree-manager/payment-providers/paypal/paypal.ts +78 -78
  181. package/src/braintree-manager/payment-providers/venmo-interface.ts +8 -8
  182. package/src/braintree-manager/payment-providers/venmo.ts +67 -67
  183. package/src/braintree-manager/payment-providers-interface.ts +25 -25
  184. package/src/braintree-manager/payment-providers.ts +147 -147
  185. package/src/donation-form-controller.ts +623 -623
  186. package/src/donation-form-error.ts +6 -6
  187. package/src/donation-form.ts +576 -576
  188. package/src/form-elements/badged-input.ts +109 -109
  189. package/src/form-elements/contact-form/autocomplete-field-options.ts +63 -63
  190. package/src/form-elements/contact-form/contact-form.ts +434 -434
  191. package/src/form-elements/contact-form/countries.ts +252 -252
  192. package/src/form-elements/header/donation-form-header.ts +98 -98
  193. package/src/form-elements/header/donation-summary.ts +61 -61
  194. package/src/form-elements/payment-selector.ts +365 -365
  195. package/src/form-elements/total-amount.ts +46 -46
  196. package/src/modals/confirm-donation-modal-content.ts +168 -168
  197. package/src/modals/error-modal-content.ts +48 -48
  198. package/src/modals/upsell-modal-content.ts +284 -284
  199. package/src/payment-flow-handlers/donation-flow-modal-manager.ts +439 -439
  200. package/src/payment-flow-handlers/handlers/applepay-flow-handler.ts +109 -109
  201. package/src/payment-flow-handlers/handlers/creditcard-flow-handler.ts +232 -232
  202. package/src/payment-flow-handlers/handlers/googlepay-flow-handler.ts +111 -111
  203. package/src/payment-flow-handlers/handlers/paypal-flow-handler.ts +331 -331
  204. package/src/payment-flow-handlers/handlers/venmo-flow-handler.ts +119 -119
  205. package/src/payment-flow-handlers/handlers/venmo-restoration-state-handler.ts +127 -127
  206. package/src/payment-flow-handlers/payment-flow-handlers.ts +218 -218
  207. package/src/recaptcha-manager/recaptcha-manager.ts +123 -123
  208. package/src/util/promisedSleep.ts +3 -3
  209. package/dist/demo/app-root.d.ts +0 -0
  210. package/dist/demo/app-root.js +0 -2
  211. package/dist/demo/app-root.js.map +0 -1
@@ -1,177 +1,177 @@
1
- /* eslint-disable @typescript-eslint/no-explicit-any */
2
- import { callback } from './core';
3
- import { Client } from './client';
4
- export interface PayPalTokenizeReturn {
5
- close: () => any;
6
- }
7
-
8
- /**
9
- * Not available to all merchants; [contact PayPal](https://developers.braintreepayments.com/support/guides/paypal/setup-guide#contacting-paypal-support)
10
- * for details on eligibility and enabling this feature.
11
- * To enable this feature, [contact PayPal](https://developers.braintreepayments.com/support/guides/paypal/setup-guide#contacting-paypal-support).
12
- * Alternatively, see `shippingAddress` above as an available client opt
13
- * To enable this feature, [contact PayPal](https://developers.braintreepayments.com/support/guides/paypal/setup-guide#contacting-paypal-support).
14
- */
15
- export interface PayPalShippingAddress {
16
- recipientName: string;
17
- line1: string;
18
- line2: string;
19
- city: string;
20
- state: string;
21
- postalCode: string;
22
- countryCode: string;
23
- }
24
-
25
- export interface PayPalBillingAddress {
26
- line1: string;
27
- line2: string;
28
- city: string;
29
- state: string;
30
- postalCode: string;
31
- countryCode: string;
32
- }
33
-
34
- export interface PayPalAccountDetails {
35
- email: string;
36
- payerId: string;
37
- firstName: string;
38
- lastName: string;
39
- countryCode: string;
40
- phone: string;
41
- shippingAddress: PayPalShippingAddress;
42
- billingAddress: PayPalBillingAddress;
43
- }
44
-
45
- export interface PayPalTokenizePayload {
46
- nonce: string;
47
- type: string;
48
- details: PayPalAccountDetails;
49
- }
50
-
51
- export interface PayPal {
52
- /**
53
- * @example
54
- * braintree.paypal.create({
55
- * client: clientInstance
56
- * }, function (createErr, paypalInstance) {
57
- * if (createErr) {
58
- * if (createErr.code === 'PAYPAL_BROWSER_NOT_SUPPORTED') {
59
- * console.error('This browser is not supported.');
60
- * } else {
61
- * console.error('Error!', createErr);
62
- * }
63
- * }
64
- * });
65
- */
66
- create(options: { client: Client }): Promise<PayPal>;
67
- create(options: { client: Client }, callback: callback): void;
68
-
69
- VERSION: string;
70
-
71
- /**
72
- * Launches the PayPal login flow and returns a nonce payload. Only one PayPal login flow should be active at a time.
73
- * One way to achieve this is to disable your PayPal button while the flow is open.
74
- * * Checkout flows only.
75
- * * `authorize` - Submits the transaction for authorization but not settlement.
76
- * * `sale` - Payment will be immediately submitted for settlement upon creating a transaction.
77
- * * Changes the call-to-action in the PayPal flow. By default the final button will show the localized
78
- * word for "Continue" and implies that the final amount billed is not yet known.
79
- *
80
- * Setting this option to `commit` changes the button text to "Pay Now" and page text will convey to
81
- * the user that billing will take place immediately. *
82
- * Supported locales are:
83
- * `da_DK`,
84
- * `de_DE`,
85
- * `en_AU`,
86
- * `en_GB`,
87
- * `en_US`,
88
- * `es_ES`,
89
- * `fr_CA`,
90
- * `fr_FR`,
91
- * `id_ID`,
92
- * `it_IT`,
93
- * `ja_JP`,
94
- * `ko_KR`,
95
- * `nl_NL`,
96
- * `no_NO`,
97
- * `pl_PL`,
98
- * `pt_BR`,
99
- * `pt_PT`,
100
- * `ru_RU`,
101
- * `sv_SE`,
102
- * `th_TH`,
103
- * `zh_CN`,
104
- * `zh_HK`,
105
- * and `zh_TW`.
106
- * @example
107
- * button.addEventListener('click', function () {
108
- * // Disable the button so that we don't attempt to open multiple popups.
109
- * button.setAttribute('disabled', 'disabled');
110
- *
111
- * // Because PayPal tokenization opens a popup, this must be called
112
- * // as a result of a user action, such as a button click.
113
- * paypalInstance.tokenize({
114
- * flow: 'vault' // Required
115
- * // Any other tokenization options
116
- * }, function (tokenizeErr, payload) {
117
- * button.removeAttribute('disabled');
118
- *
119
- * if (tokenizeErr) {
120
- * // Handle tokenization errors or premature flow closure
121
- *
122
- * switch (tokenizeErr.code) {
123
- * case 'PAYPAL_POPUP_CLOSED':
124
- * console.error('Customer closed PayPal popup.');
125
- * break;
126
- * case 'PAYPAL_ACCOUNT_TOKENIZATION_FAILED':
127
- * console.error('PayPal tokenization failed. See details:', tokenizeErr.details);
128
- * break;
129
- * case 'PAYPAL_FLOW_FAILED':
130
- * console.error('Unable to initialize PayPal flow. Are your options correct?', tokenizeErr.details);
131
- * break;
132
- * default:
133
- * console.error('Error!', tokenizeErr);
134
- * }
135
- * } else {
136
- * // Submit payload.nonce to your server
137
- * }
138
- * });
139
- * });
140
- */
141
- tokenize(options: {
142
- flow: string;
143
- intent?: string;
144
- offerCredit?: boolean;
145
- useraction?: string;
146
- amount?: string | number;
147
- currency?: string;
148
- displayName?: string;
149
- locale?: string;
150
- enableShippingAddress?: boolean;
151
- shippingAddressOverride?: PayPalShippingAddress;
152
- shippingAddressEditable?: boolean;
153
- billingAgreementDescription?: string;
154
- }): Promise<PayPalTokenizeReturn>;
155
- tokenize(
156
- options: {
157
- flow: string;
158
- intent?: string;
159
- offerCredit?: boolean;
160
- useraction?: string;
161
- amount?: string | number;
162
- currency?: string;
163
- displayName?: string;
164
- locale?: string;
165
- enableShippingAddress?: boolean;
166
- shippingAddressOverride?: PayPalShippingAddress;
167
- shippingAddressEditable?: boolean;
168
- billingAgreementDescription?: string;
169
- },
170
- callback: callback,
171
- ): PayPalTokenizeReturn;
172
-
173
- /**
174
- * Cleanly tear down anything set up by `create`.
175
- */
176
- teardown(callback?: () => void): void;
177
- }
1
+ /* eslint-disable @typescript-eslint/no-explicit-any */
2
+ import { callback } from './core';
3
+ import { Client } from './client';
4
+ export interface PayPalTokenizeReturn {
5
+ close: () => any;
6
+ }
7
+
8
+ /**
9
+ * Not available to all merchants; [contact PayPal](https://developers.braintreepayments.com/support/guides/paypal/setup-guide#contacting-paypal-support)
10
+ * for details on eligibility and enabling this feature.
11
+ * To enable this feature, [contact PayPal](https://developers.braintreepayments.com/support/guides/paypal/setup-guide#contacting-paypal-support).
12
+ * Alternatively, see `shippingAddress` above as an available client opt
13
+ * To enable this feature, [contact PayPal](https://developers.braintreepayments.com/support/guides/paypal/setup-guide#contacting-paypal-support).
14
+ */
15
+ export interface PayPalShippingAddress {
16
+ recipientName: string;
17
+ line1: string;
18
+ line2: string;
19
+ city: string;
20
+ state: string;
21
+ postalCode: string;
22
+ countryCode: string;
23
+ }
24
+
25
+ export interface PayPalBillingAddress {
26
+ line1: string;
27
+ line2: string;
28
+ city: string;
29
+ state: string;
30
+ postalCode: string;
31
+ countryCode: string;
32
+ }
33
+
34
+ export interface PayPalAccountDetails {
35
+ email: string;
36
+ payerId: string;
37
+ firstName: string;
38
+ lastName: string;
39
+ countryCode: string;
40
+ phone: string;
41
+ shippingAddress: PayPalShippingAddress;
42
+ billingAddress: PayPalBillingAddress;
43
+ }
44
+
45
+ export interface PayPalTokenizePayload {
46
+ nonce: string;
47
+ type: string;
48
+ details: PayPalAccountDetails;
49
+ }
50
+
51
+ export interface PayPal {
52
+ /**
53
+ * @example
54
+ * braintree.paypal.create({
55
+ * client: clientInstance
56
+ * }, function (createErr, paypalInstance) {
57
+ * if (createErr) {
58
+ * if (createErr.code === 'PAYPAL_BROWSER_NOT_SUPPORTED') {
59
+ * console.error('This browser is not supported.');
60
+ * } else {
61
+ * console.error('Error!', createErr);
62
+ * }
63
+ * }
64
+ * });
65
+ */
66
+ create(options: { client: Client }): Promise<PayPal>;
67
+ create(options: { client: Client }, callback: callback): void;
68
+
69
+ VERSION: string;
70
+
71
+ /**
72
+ * Launches the PayPal login flow and returns a nonce payload. Only one PayPal login flow should be active at a time.
73
+ * One way to achieve this is to disable your PayPal button while the flow is open.
74
+ * * Checkout flows only.
75
+ * * `authorize` - Submits the transaction for authorization but not settlement.
76
+ * * `sale` - Payment will be immediately submitted for settlement upon creating a transaction.
77
+ * * Changes the call-to-action in the PayPal flow. By default the final button will show the localized
78
+ * word for "Continue" and implies that the final amount billed is not yet known.
79
+ *
80
+ * Setting this option to `commit` changes the button text to "Pay Now" and page text will convey to
81
+ * the user that billing will take place immediately. *
82
+ * Supported locales are:
83
+ * `da_DK`,
84
+ * `de_DE`,
85
+ * `en_AU`,
86
+ * `en_GB`,
87
+ * `en_US`,
88
+ * `es_ES`,
89
+ * `fr_CA`,
90
+ * `fr_FR`,
91
+ * `id_ID`,
92
+ * `it_IT`,
93
+ * `ja_JP`,
94
+ * `ko_KR`,
95
+ * `nl_NL`,
96
+ * `no_NO`,
97
+ * `pl_PL`,
98
+ * `pt_BR`,
99
+ * `pt_PT`,
100
+ * `ru_RU`,
101
+ * `sv_SE`,
102
+ * `th_TH`,
103
+ * `zh_CN`,
104
+ * `zh_HK`,
105
+ * and `zh_TW`.
106
+ * @example
107
+ * button.addEventListener('click', function () {
108
+ * // Disable the button so that we don't attempt to open multiple popups.
109
+ * button.setAttribute('disabled', 'disabled');
110
+ *
111
+ * // Because PayPal tokenization opens a popup, this must be called
112
+ * // as a result of a user action, such as a button click.
113
+ * paypalInstance.tokenize({
114
+ * flow: 'vault' // Required
115
+ * // Any other tokenization options
116
+ * }, function (tokenizeErr, payload) {
117
+ * button.removeAttribute('disabled');
118
+ *
119
+ * if (tokenizeErr) {
120
+ * // Handle tokenization errors or premature flow closure
121
+ *
122
+ * switch (tokenizeErr.code) {
123
+ * case 'PAYPAL_POPUP_CLOSED':
124
+ * console.error('Customer closed PayPal popup.');
125
+ * break;
126
+ * case 'PAYPAL_ACCOUNT_TOKENIZATION_FAILED':
127
+ * console.error('PayPal tokenization failed. See details:', tokenizeErr.details);
128
+ * break;
129
+ * case 'PAYPAL_FLOW_FAILED':
130
+ * console.error('Unable to initialize PayPal flow. Are your options correct?', tokenizeErr.details);
131
+ * break;
132
+ * default:
133
+ * console.error('Error!', tokenizeErr);
134
+ * }
135
+ * } else {
136
+ * // Submit payload.nonce to your server
137
+ * }
138
+ * });
139
+ * });
140
+ */
141
+ tokenize(options: {
142
+ flow: string;
143
+ intent?: string;
144
+ offerCredit?: boolean;
145
+ useraction?: string;
146
+ amount?: string | number;
147
+ currency?: string;
148
+ displayName?: string;
149
+ locale?: string;
150
+ enableShippingAddress?: boolean;
151
+ shippingAddressOverride?: PayPalShippingAddress;
152
+ shippingAddressEditable?: boolean;
153
+ billingAgreementDescription?: string;
154
+ }): Promise<PayPalTokenizeReturn>;
155
+ tokenize(
156
+ options: {
157
+ flow: string;
158
+ intent?: string;
159
+ offerCredit?: boolean;
160
+ useraction?: string;
161
+ amount?: string | number;
162
+ currency?: string;
163
+ displayName?: string;
164
+ locale?: string;
165
+ enableShippingAddress?: boolean;
166
+ shippingAddressOverride?: PayPalShippingAddress;
167
+ shippingAddressEditable?: boolean;
168
+ billingAgreementDescription?: string;
169
+ },
170
+ callback: callback,
171
+ ): PayPalTokenizeReturn;
172
+
173
+ /**
174
+ * Cleanly tear down anything set up by `create`.
175
+ */
176
+ teardown(callback?: () => void): void;
177
+ }
@@ -1,141 +1,141 @@
1
- import { callback, BraintreeError } from './core';
2
- import { Client } from './client';
3
-
4
- export interface ThreeDSecureAccountDetails {
5
- cardType: string;
6
- lastTwo: string;
7
- }
8
-
9
- export interface ThreeDSecureVerifyPayload {
10
- nonce: string;
11
- details: ThreeDSecureAccountDetails;
12
- description: string;
13
- liabilityShiftPossible: boolean;
14
- liabilityShifted: boolean;
15
- }
16
-
17
- export interface ThreeDSecure {
18
- /**
19
- * braintree.threeDSecure.create({
20
- * client: client
21
- * }, callback);
22
- */
23
- create(options: {
24
- authorization?: string;
25
- version?: 1 | '1' | 2 | '2' | '2-bootstrap3-modal' | '2-inline-iframe';
26
- client?: Client;
27
- }): Promise<ThreeDSecure>;
28
- create(
29
- options: {
30
- authorization?: string;
31
- version?: 1 | '1' | 2 | '2' | '2-bootstrap3-modal' | '2-inline-iframe';
32
- client?: Client;
33
- },
34
- callback: callback,
35
- ): void;
36
-
37
- /**
38
- * @description The current version of the SDK, i.e. `3.0.2`.
39
- */
40
- VERSION: string;
41
-
42
- addFrameCallback: (err?: BraintreeError, iframe?: HTMLIFrameElement) => void;
43
-
44
- /**
45
- * @description The callback used for options.removeFrame in {@link ThreeDSecure#verifyCard|verifyCard}.
46
- */
47
- removeFrameCallback: () => void;
48
-
49
- /**
50
- * Launch the 3D Secure login flow, returning a nonce payload.
51
- * @example
52
- * <caption>Verifying an existing nonce with 3DS</caption>
53
- * var my3DSContainer;
54
- *
55
- * threeDSecure.verifyCard({
56
- * nonce: existingNonce,
57
- * amount: 123.45,
58
- * addFrame: function (err, iframe) {
59
- * // Set up your UI and add the iframe.
60
- * my3DSContainer = document.createElement('div');
61
- * my3DSContainer.appendChild(iframe);
62
- * document.body.appendChild(my3DSContainer);
63
- * },
64
- * removeFrame: function () {
65
- * // Remove UI that you added in addFrame.
66
- * document.body.removeChild(my3DSContainer);
67
- * }
68
- * }, function (err, payload) {
69
- * if (err) {
70
- * console.error(err);
71
- * return;
72
- * }
73
- *
74
- * if (payload.liabilityShifted) {
75
- * // Liablity has shifted
76
- * submitNonceToServer(payload.nonce);
77
- * } else if (payload.liabilityShiftPossible) {
78
- * // Liablity may still be shifted
79
- * // Decide if you want to submit the nonce
80
- * } else {
81
- * // Liablity has not shifted and will not shift
82
- * // Decide if you want to submit the nonce
83
- * }
84
- * });
85
- */
86
- verifyCard(options: {
87
- nonce: string;
88
- amount: number;
89
- addFrame: (err?: BraintreeError, iframe?: HTMLIFrameElement) => void;
90
- removeFrame?: () => void;
91
- }): Promise<ThreeDSecureVerifyPayload>;
92
- verifyCard(
93
- options: {
94
- nonce: string;
95
- amount: number;
96
- addFrame: (err?: BraintreeError, iframe?: HTMLIFrameElement) => void;
97
- removeFrame: () => void;
98
- },
99
- callback: callback,
100
- ): void;
101
-
102
- /**
103
- * Cancel the 3DS flow and return the verification payload if available. * @example
104
- * threeDSecure.cancelVerifyCard(function (err, verifyPayload) {
105
- * if (err) {
106
- * // Handle error
107
- * console.log(err.message); // No verification payload available
108
- * return;
109
- * }
110
- *
111
- * verifyPayload.nonce; // The nonce returned from the 3ds lookup call
112
- * verifyPayload.liabilityShifted; // boolean
113
- * verifyPayload.liabilityShiftPossible; // boolean
114
- * });
115
- */
116
- cancelVerifyCard(callback: callback): void;
117
-
118
- /**
119
- * Gather the data needed for a 3D Secure lookup call.
120
- * * @example
121
- * <caption>Preparing data for a 3D Secure lookup</caption>
122
- * threeDSecure.prepareLookup({
123
- * nonce: hostedFieldsTokenizationPayload.nonce,
124
- * bin: hostedFieldsTokenizationPayload.details.bin
125
- * }, function (err, payload) {
126
- * if (err) {
127
- * console.error(err);
128
- * return;
129
- * }
130
- *
131
- * // send payload to server to do server side lookup
132
- * });
133
- */
134
- prepareLookup(options: { nonce: string; bin: string }): Promise<string>;
135
- prepareLookup(options: { nonce: string; bin: string }, callback: callback): void;
136
-
137
- /**
138
- * Cleanly tear down anything set up by {@link module:braintree-web/three-d-secure.create|create}
139
- */
140
- teardown(callback?: callback): void;
141
- }
1
+ import { callback, BraintreeError } from './core';
2
+ import { Client } from './client';
3
+
4
+ export interface ThreeDSecureAccountDetails {
5
+ cardType: string;
6
+ lastTwo: string;
7
+ }
8
+
9
+ export interface ThreeDSecureVerifyPayload {
10
+ nonce: string;
11
+ details: ThreeDSecureAccountDetails;
12
+ description: string;
13
+ liabilityShiftPossible: boolean;
14
+ liabilityShifted: boolean;
15
+ }
16
+
17
+ export interface ThreeDSecure {
18
+ /**
19
+ * braintree.threeDSecure.create({
20
+ * client: client
21
+ * }, callback);
22
+ */
23
+ create(options: {
24
+ authorization?: string;
25
+ version?: 1 | '1' | 2 | '2' | '2-bootstrap3-modal' | '2-inline-iframe';
26
+ client?: Client;
27
+ }): Promise<ThreeDSecure>;
28
+ create(
29
+ options: {
30
+ authorization?: string;
31
+ version?: 1 | '1' | 2 | '2' | '2-bootstrap3-modal' | '2-inline-iframe';
32
+ client?: Client;
33
+ },
34
+ callback: callback,
35
+ ): void;
36
+
37
+ /**
38
+ * @description The current version of the SDK, i.e. `3.0.2`.
39
+ */
40
+ VERSION: string;
41
+
42
+ addFrameCallback: (err?: BraintreeError, iframe?: HTMLIFrameElement) => void;
43
+
44
+ /**
45
+ * @description The callback used for options.removeFrame in {@link ThreeDSecure#verifyCard|verifyCard}.
46
+ */
47
+ removeFrameCallback: () => void;
48
+
49
+ /**
50
+ * Launch the 3D Secure login flow, returning a nonce payload.
51
+ * @example
52
+ * <caption>Verifying an existing nonce with 3DS</caption>
53
+ * var my3DSContainer;
54
+ *
55
+ * threeDSecure.verifyCard({
56
+ * nonce: existingNonce,
57
+ * amount: 123.45,
58
+ * addFrame: function (err, iframe) {
59
+ * // Set up your UI and add the iframe.
60
+ * my3DSContainer = document.createElement('div');
61
+ * my3DSContainer.appendChild(iframe);
62
+ * document.body.appendChild(my3DSContainer);
63
+ * },
64
+ * removeFrame: function () {
65
+ * // Remove UI that you added in addFrame.
66
+ * document.body.removeChild(my3DSContainer);
67
+ * }
68
+ * }, function (err, payload) {
69
+ * if (err) {
70
+ * console.error(err);
71
+ * return;
72
+ * }
73
+ *
74
+ * if (payload.liabilityShifted) {
75
+ * // Liablity has shifted
76
+ * submitNonceToServer(payload.nonce);
77
+ * } else if (payload.liabilityShiftPossible) {
78
+ * // Liablity may still be shifted
79
+ * // Decide if you want to submit the nonce
80
+ * } else {
81
+ * // Liablity has not shifted and will not shift
82
+ * // Decide if you want to submit the nonce
83
+ * }
84
+ * });
85
+ */
86
+ verifyCard(options: {
87
+ nonce: string;
88
+ amount: number;
89
+ addFrame: (err?: BraintreeError, iframe?: HTMLIFrameElement) => void;
90
+ removeFrame?: () => void;
91
+ }): Promise<ThreeDSecureVerifyPayload>;
92
+ verifyCard(
93
+ options: {
94
+ nonce: string;
95
+ amount: number;
96
+ addFrame: (err?: BraintreeError, iframe?: HTMLIFrameElement) => void;
97
+ removeFrame: () => void;
98
+ },
99
+ callback: callback,
100
+ ): void;
101
+
102
+ /**
103
+ * Cancel the 3DS flow and return the verification payload if available. * @example
104
+ * threeDSecure.cancelVerifyCard(function (err, verifyPayload) {
105
+ * if (err) {
106
+ * // Handle error
107
+ * console.log(err.message); // No verification payload available
108
+ * return;
109
+ * }
110
+ *
111
+ * verifyPayload.nonce; // The nonce returned from the 3ds lookup call
112
+ * verifyPayload.liabilityShifted; // boolean
113
+ * verifyPayload.liabilityShiftPossible; // boolean
114
+ * });
115
+ */
116
+ cancelVerifyCard(callback: callback): void;
117
+
118
+ /**
119
+ * Gather the data needed for a 3D Secure lookup call.
120
+ * * @example
121
+ * <caption>Preparing data for a 3D Secure lookup</caption>
122
+ * threeDSecure.prepareLookup({
123
+ * nonce: hostedFieldsTokenizationPayload.nonce,
124
+ * bin: hostedFieldsTokenizationPayload.details.bin
125
+ * }, function (err, payload) {
126
+ * if (err) {
127
+ * console.error(err);
128
+ * return;
129
+ * }
130
+ *
131
+ * // send payload to server to do server side lookup
132
+ * });
133
+ */
134
+ prepareLookup(options: { nonce: string; bin: string }): Promise<string>;
135
+ prepareLookup(options: { nonce: string; bin: string }, callback: callback): void;
136
+
137
+ /**
138
+ * Cleanly tear down anything set up by {@link module:braintree-web/three-d-secure.create|create}
139
+ */
140
+ teardown(callback?: callback): void;
141
+ }