@stripe/stripe-js 1.20.2 → 1.21.2

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 (53) hide show
  1. package/dist/pure.esm.js +1 -1
  2. package/dist/pure.js +1 -1
  3. package/dist/stripe.esm.js +1 -1
  4. package/dist/stripe.js +1 -1
  5. package/package.json +5 -5
  6. package/src/shared.ts +1 -2
  7. package/types/api/bank-accounts.d.ts +61 -0
  8. package/types/api/cards.d.ts +130 -0
  9. package/types/api/index.d.ts +9 -9
  10. package/types/api/payment-intents.d.ts +330 -0
  11. package/types/api/payment-methods.d.ts +349 -0
  12. package/types/api/setup-intents.d.ts +184 -0
  13. package/types/api/shared.d.ts +124 -126
  14. package/types/api/sources.d.ts +1045 -0
  15. package/types/api/tokens.d.ts +634 -0
  16. package/types/api/verification-sessions.d.ts +9 -0
  17. package/types/index.d.ts +14 -12
  18. package/types/stripe-js/checkout.d.ts +134 -136
  19. package/types/stripe-js/elements/affirm-message.d.ts +59 -61
  20. package/types/stripe-js/elements/afterpay-clearpay-message.d.ts +118 -120
  21. package/types/stripe-js/elements/au-bank-account.d.ts +123 -120
  22. package/types/stripe-js/elements/base.d.ts +263 -263
  23. package/types/stripe-js/elements/card-cvc.d.ts +107 -103
  24. package/types/stripe-js/elements/card-expiry.d.ts +107 -104
  25. package/types/stripe-js/elements/card-number.d.ts +128 -125
  26. package/types/stripe-js/elements/card.d.ts +157 -154
  27. package/types/stripe-js/elements/eps-bank.d.ts +125 -121
  28. package/types/stripe-js/elements/fpx-bank.d.ts +120 -116
  29. package/types/stripe-js/elements/iban.d.ts +134 -131
  30. package/types/stripe-js/elements/ideal-bank.d.ts +125 -121
  31. package/types/stripe-js/elements/index.d.ts +17 -0
  32. package/types/stripe-js/elements/link-authentication.d.ts +92 -94
  33. package/types/stripe-js/elements/p24-bank.d.ts +125 -121
  34. package/types/stripe-js/elements/payment-request-button.d.ts +127 -127
  35. package/types/stripe-js/elements/payment.d.ts +190 -169
  36. package/types/stripe-js/elements/shipping-address.d.ts +123 -125
  37. package/types/stripe-js/elements-group.d.ts +619 -0
  38. package/types/stripe-js/index.d.ts +8 -1057
  39. package/types/stripe-js/payment-intents.d.ts +951 -919
  40. package/types/stripe-js/payment-request.d.ts +503 -503
  41. package/types/stripe-js/setup-intents.d.ts +149 -135
  42. package/types/stripe-js/stripe.d.ts +1070 -0
  43. package/types/stripe-js/token-and-sources.d.ts +80 -80
  44. package/types/utils.d.ts +2 -0
  45. package/types/api/BankAccounts.d.ts +0 -63
  46. package/types/api/Cards.d.ts +0 -130
  47. package/types/api/PaymentIntents.d.ts +0 -329
  48. package/types/api/PaymentMethods.d.ts +0 -349
  49. package/types/api/SetupIntents.d.ts +0 -184
  50. package/types/api/Sources.d.ts +0 -1045
  51. package/types/api/Tokens.d.ts +0 -632
  52. package/types/api/VerificationSessions.d.ts +0 -11
  53. package/types/stripe-js/elements.d.ts +0 -525
@@ -1,525 +0,0 @@
1
- ///<reference path='./elements/card.d.ts' />
2
- ///<reference path='./elements/card-number.d.ts' />
3
- ///<reference path='./elements/card-expiry.d.ts' />
4
- ///<reference path='./elements/card-cvc.d.ts' />
5
- ///<reference path='./elements/iban.d.ts' />
6
- ///<reference path='./elements/ideal-bank.d.ts' />
7
- ///<reference path='./elements/fpx-bank.d.ts' />
8
- ///<reference path='./elements/payment-request-button.d.ts' />
9
- ///<reference path='./elements/au-bank-account.d.ts' />
10
- ///<reference path='./elements/eps-bank.d.ts' />
11
- ///<reference path='./elements/p24-bank.d.ts' />
12
- ///<reference path='./elements/affirm-message.d.ts' />
13
- ///<reference path='./elements/afterpay-clearpay-message.d.ts' />
14
- ///<reference path='./elements/payment.d.ts' />
15
- ///<reference path='./elements/link-authentication.d.ts' />
16
- ///<reference path='./elements/shipping-address.d.ts' />
17
-
18
- import {StripeAuBankAccountElement} from '@stripe/stripe-js';
19
-
20
- declare module '@stripe/stripe-js' {
21
- interface StripeElements {
22
- /**
23
- * Updates the options that `Elements` was initialized with.
24
- * Updates are shallowly merged into the existing configuration.
25
- */
26
- update(options: StripeElementsUpdateOptions): void;
27
-
28
- /////////////////////////////
29
- /// affirmMessage
30
- /////////////////////////////
31
-
32
- /**
33
- * Creates an `AffirmMessageElement`.
34
- */
35
- create(
36
- elementType: 'affirmMessage',
37
- options: StripeAffirmMessageElementOptions
38
- ): StripeAffirmMessageElement;
39
-
40
- /**
41
- * Looks up a previously created `Element` by its type.
42
- */
43
- getElement(elementType: 'affirmMessage'): StripeAffirmMessageElement | null;
44
-
45
- /////////////////////////////
46
- /// afterpayClearpayMessage
47
- /////////////////////////////
48
-
49
- /**
50
- * Creates an `AfterpayClearpayMessageElement`.
51
- */
52
- create(
53
- elementType: 'afterpayClearpayMessage',
54
- options: StripeAfterpayClearpayMessageElementOptions
55
- ): StripeAfterpayClearpayMessageElement;
56
-
57
- /**
58
- * Looks up a previously created `Element` by its type.
59
- */
60
- getElement(
61
- elementType: 'afterpayClearpayMessage'
62
- ): StripeAfterpayClearpayMessageElement | null;
63
-
64
- /////////////////////////////
65
- /// auBankAccount
66
- /////////////////////////////
67
-
68
- /**
69
- * Requires beta access:
70
- * Contact [Stripe support](https://support.stripe.com/) for more information.
71
- *
72
- * Creates an `AuBankAccountElement`.
73
- */
74
- create(
75
- elementType: 'auBankAccount',
76
- options?: StripeAuBankAccountElementOptions
77
- ): StripeAuBankAccountElement;
78
-
79
- /**
80
- * Requires beta access:
81
- * Contact [Stripe support](https://support.stripe.com/) for more information.
82
- *
83
- * Looks up a previously created `Element` by its type.
84
- */
85
- getElement(elementType: 'auBankAccount'): StripeAuBankAccountElement | null;
86
-
87
- /////////////////////////////
88
- /// card
89
- /////////////////////////////
90
-
91
- /**
92
- * Creates a `CardElement`.
93
- */
94
- create(
95
- elementType: 'card',
96
- options?: StripeCardElementOptions
97
- ): StripeCardElement;
98
-
99
- /**
100
- * Looks up a previously created `Element` by its type.
101
- */
102
- getElement(elementType: 'card'): StripeCardElement | null;
103
-
104
- /////////////////////////////
105
- /// cardNumber
106
- /////////////////////////////
107
-
108
- /**
109
- * Creates a `CardNumberElement`.
110
- */
111
- create(
112
- elementType: 'cardNumber',
113
- options?: StripeCardNumberElementOptions
114
- ): StripeCardNumberElement;
115
-
116
- /**
117
- * Looks up a previously created `Element` by its type.
118
- */
119
- getElement(elementType: 'cardNumber'): StripeCardNumberElement | null;
120
-
121
- /////////////////////////////
122
- /// cardExpiry
123
- /////////////////////////////
124
-
125
- /**
126
- * Creates a `CardExpiryElement`.
127
- */
128
- create(
129
- elementType: 'cardExpiry',
130
- options?: StripeCardExpiryElementOptions
131
- ): StripeCardExpiryElement;
132
-
133
- /**
134
- * Looks up a previously created `Element` by its type.
135
- */
136
- getElement(elementType: 'cardExpiry'): StripeCardExpiryElement | null;
137
-
138
- /////////////////////////////
139
- /// cardCvc
140
- /////////////////////////////
141
-
142
- /**
143
- * Creates a `CardCvcElement`.
144
- */
145
- create(
146
- elementType: 'cardCvc',
147
- options?: StripeCardCvcElementOptions
148
- ): StripeCardCvcElement;
149
-
150
- /**
151
- * Looks up a previously created `Element` by its type.
152
- */
153
- getElement(elementType: 'cardCvc'): StripeCardCvcElement | null;
154
-
155
- /////////////////////////////
156
- /// fpxBank
157
- /////////////////////////////
158
-
159
- /**
160
- * Creates an `FpxBankElement`.
161
- */
162
- create(
163
- elementType: 'fpxBank',
164
- options: StripeFpxBankElementOptions
165
- ): StripeFpxBankElement;
166
-
167
- /**
168
- * Looks up a previously created `Element` by its type.
169
- */
170
- getElement(elementType: 'fpxBank'): StripeFpxBankElement | null;
171
-
172
- /////////////////////////////
173
- /// epsBank
174
- /////////////////////////////
175
-
176
- /**
177
- *
178
- * Creates an `EpsBankElement`.
179
- */
180
- create(
181
- elementType: 'epsBank',
182
- options: StripeEpsBankElementOptions
183
- ): StripeEpsBankElement;
184
-
185
- /**
186
- * Requires beta access:
187
- * Contact [Stripe support](https://support.stripe.com/) for more information.
188
- *
189
- * Looks up a previously created `Element` by its type.
190
- */
191
- getElement(elementType: 'epsBank'): StripeEpsBankElement | null;
192
-
193
- /////////////////////////////
194
- /// p24Bank
195
- /////////////////////////////
196
-
197
- /**
198
- *
199
- * Creates an `P24BankElement`.
200
- */
201
- create(
202
- elementType: 'p24Bank',
203
- options: StripeP24BankElementOptions
204
- ): StripeP24BankElement;
205
-
206
- /**
207
- *
208
- * Looks up a previously created `Element` by its type.
209
- */
210
- getElement(elementType: 'p24Bank'): StripeP24BankElement | null;
211
-
212
- /////////////////////////////
213
- /// iban
214
- /////////////////////////////
215
-
216
- /**
217
- * Creates an `IbanElement`.
218
- */
219
- create(
220
- elementType: 'iban',
221
- options?: StripeIbanElementOptions
222
- ): StripeIbanElement;
223
-
224
- /**
225
- * Looks up a previously created `Element` by its type.
226
- */
227
- getElement(elementType: 'iban'): StripeIbanElement | null;
228
-
229
- /////////////////////////////
230
- /// idealBank
231
- /////////////////////////////
232
-
233
- /**
234
- * Creates an `IdealBankElement`.
235
- */
236
- create(
237
- elementType: 'idealBank',
238
- options?: StripeIdealBankElementOptions
239
- ): StripeIdealBankElement;
240
-
241
- /**
242
- * Looks up a previously created `Element` by its type.
243
- */
244
- getElement(elementType: 'idealBank'): StripeIdealBankElement | null;
245
-
246
- /////////////////////////////
247
- /// linkAuthentication
248
- /////////////////////////////
249
-
250
- /**
251
- * Requires beta access:
252
- * Contact [Stripe support](https://support.stripe.com/) for more information.
253
- *
254
- * Creates a `LinkAuthenticationElement`.
255
- */
256
- create(elementType: 'linkAuthentication'): StripeLinkAuthenticationElement;
257
-
258
- /**
259
- * Requires beta access:
260
- * Contact [Stripe support](https://support.stripe.com/) for more information.
261
- *
262
- * Looks up a previously created `Element` by its type.
263
- */
264
- getElement(
265
- elementType: 'linkAuthentication'
266
- ): StripeLinkAuthenticationElement | null;
267
-
268
- /////////////////////////////
269
- /// payment
270
- /////////////////////////////
271
-
272
- /**
273
- * Requires beta access:
274
- * Contact [Stripe support](https://support.stripe.com/) for more information.
275
- *
276
- * Creates a `PaymentElement`.
277
- */
278
- create(
279
- elementType: 'payment',
280
- options?: StripePaymentElementOptions
281
- ): StripePaymentElement;
282
-
283
- /**
284
- * Requires beta access:
285
- * Contact [Stripe support](https://support.stripe.com/) for more information.
286
- *
287
- * Looks up a previously created `Element` by its type.
288
- */
289
- getElement(elementType: 'payment'): StripePaymentElement | null;
290
-
291
- /////////////////////////////
292
- /// paymentRequestButton
293
- /////////////////////////////
294
-
295
- /**
296
- * Creates a `PaymentRequestButtonElement`.
297
- *
298
- * @docs https://stripe.com/docs/stripe-js/elements/payment-request-button
299
- */
300
- create(
301
- elementType: 'paymentRequestButton',
302
- options: StripePaymentRequestButtonElementOptions
303
- ): StripePaymentRequestButtonElement;
304
-
305
- /**
306
- * Looks up a previously created `Element` by its type.
307
- */
308
- getElement(
309
- elementType: 'paymentRequestButton'
310
- ): StripePaymentRequestButtonElement | null;
311
-
312
- /**
313
- * Requires beta access:
314
- * Contact [Stripe support](https://support.stripe.com/) for more information.
315
- *
316
- * Creates a `ShippingAddressElement`.
317
- */
318
- create(
319
- elementType: 'shippingAddress',
320
- options?: StripeShippingAddressElementOptions
321
- ): StripeShippingAddressElement;
322
-
323
- /**
324
- * Requires beta access:
325
- * Contact [Stripe support](https://support.stripe.com/) for more information.
326
- *
327
- * Looks up a previously created `Element` by its type.
328
- */
329
- getElement(
330
- elementType: 'shippingAddress'
331
- ): StripeShippingAddressElement | null;
332
- }
333
-
334
- type StripeElementType =
335
- | 'affirmMessage'
336
- | 'afterpayClearpayMessage'
337
- | 'auBankAccount'
338
- | 'card'
339
- | 'cardNumber'
340
- | 'cardExpiry'
341
- | 'cardCvc'
342
- | 'epsBank'
343
- | 'fpxBank'
344
- | 'iban'
345
- | 'idealBank'
346
- | 'p24Bank'
347
- | 'payment'
348
- | 'paymentRequestButton'
349
- | 'linkAuthentication'
350
- | 'shippingAddress';
351
-
352
- type StripeElement =
353
- | StripeAffirmMessageElement
354
- | StripeAfterpayClearpayMessageElement
355
- | StripeAuBankAccountElement
356
- | StripeCardElement
357
- | StripeCardNumberElement
358
- | StripeCardExpiryElement
359
- | StripeCardCvcElement
360
- | StripeEpsBankElement
361
- | StripeFpxBankElement
362
- | StripeIbanElement
363
- | StripeIdealBankElement
364
- | StripeP24BankElement
365
- | StripePaymentElement
366
- | StripePaymentRequestButtonElement;
367
-
368
- type StripeElementLocale =
369
- | 'auto'
370
- | 'ar'
371
- | 'bg'
372
- | 'cs'
373
- | 'da'
374
- | 'de'
375
- | 'el'
376
- | 'en'
377
- | 'en-AU'
378
- | 'en-CA'
379
- | 'en-NZ'
380
- | 'en-GB'
381
- | 'es'
382
- | 'es-ES'
383
- | 'es-419'
384
- | 'et'
385
- | 'fi'
386
- | 'fr'
387
- | 'fr-FR'
388
- | 'hu'
389
- | 'he'
390
- | 'id'
391
- | 'it'
392
- | 'it-IT'
393
- | 'ja'
394
- | 'lt'
395
- | 'lv'
396
- | 'ms'
397
- | 'mt'
398
- | 'nb'
399
- | 'nl'
400
- | 'no'
401
- | 'pl'
402
- | 'pt'
403
- | 'pt-BR'
404
- | 'ro'
405
- | 'ru'
406
- | 'sk'
407
- | 'sl'
408
- | 'sv'
409
- | 'th'
410
- | 'tr'
411
- | 'zh'
412
- | 'zh-HK'
413
- | 'zh-TW';
414
-
415
- /**
416
- * Options to create an `Elements` instance with.
417
- */
418
- interface StripeElementsOptions {
419
- /**
420
- * An array of custom fonts, which elements created from the `Elements` object can use.
421
- */
422
- fonts?: Array<CssFontSource | CustomFontSource>;
423
-
424
- /**
425
- * The [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the locale to display placeholders and error strings in.
426
- * Default is `auto` (Stripe detects the locale of the browser).
427
- * Setting the locale does not affect the behavior of postal code validation—a valid postal code for the billing country of the card is still required.
428
- */
429
- locale?: StripeElementLocale;
430
-
431
- /**
432
- * Used with the Payment Element, requires beta access:
433
- * Contact [Stripe support](https://support.stripe.com/) for more information.
434
- *
435
- * Match the design of your site with the appearance option.
436
- * The layout of each Element stays consistent, but you can modify colors, fonts, borders, padding, and more.
437
- *
438
- * @docs https://stripe.com/docs/stripe-js/appearance-api
439
- */
440
- appearance?: Record<string, unknown>;
441
-
442
- /**
443
- * Used with the Payment Element, requires beta access:
444
- * Contact [Stripe support](https://support.stripe.com/) for more information.
445
- *
446
- * The client secret for a PaymentIntent or SetupIntent
447
- *
448
- * @docs https://stripe.com/docs/api/payment_intents/object#payment_intent_object-client_secret
449
- */
450
- clientSecret?: string;
451
- }
452
-
453
- /*
454
- * Updatable options for an `Elements` instance
455
- */
456
- interface StripeElementsUpdateOptions {
457
- /**
458
- * The [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the locale to display placeholders and error strings in.
459
- * Default is `auto` (Stripe detects the locale of the browser).
460
- * Setting the locale does not affect the behavior of postal code validation—a valid postal code for the billing country of the card is still required.
461
- */
462
- locale?: StripeElementLocale;
463
-
464
- /**
465
- * Used with the Payment Element, requires beta access:
466
- * Contact [Stripe support](https://support.stripe.com/) for more information.
467
- *
468
- * Match the design of your site with the appearance option.
469
- * The layout of each Element stays consistent, but you can modify colors, fonts, borders, padding, and more.
470
- *
471
- * @docs https://stripe.com/docs/stripe-js/appearance-api
472
- */
473
- appearance?: Record<string, unknown>;
474
- }
475
-
476
- /*
477
- * Use a `CssFontSource` to pass custom fonts via a stylesheet URL when creating an `Elements` object.
478
- */
479
- interface CssFontSource {
480
- /**
481
- * A relative or absolute URL pointing to a CSS file with [@font-face](https://developer.mozilla.org/en/docs/Web/CSS/@font-face) definitions, for example:
482
- *
483
- * https://fonts.googleapis.com/css?family=Open+Sans
484
- *
485
- * Note that if you are using a [content security policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) (CSP), [additional directives](https://stripe.com/docs/security#content-security-policy) may be necessary.
486
- */
487
- cssSrc: string;
488
- }
489
-
490
- /*
491
- * Use a `CustomFontSource` to pass custom fonts when creating an `Elements` object.
492
- */
493
- interface CustomFontSource {
494
- /**
495
- * The name to give the font
496
- */
497
- family: string;
498
-
499
- /**
500
- * A valid [src](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src) value pointing to your custom font file.
501
- * This is usually (though not always) a link to a file with a `.woff` , `.otf`, or `.svg` suffix.
502
- */
503
- src: string;
504
-
505
- /**
506
- * A valid [font-display](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display) value.
507
- */
508
- display?: string;
509
-
510
- /**
511
- * Defaults to `normal`.
512
- */
513
- style?: 'normal' | 'italic' | 'oblique';
514
-
515
- /**
516
- * A valid [unicode-range](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/unicode-range) value.
517
- */
518
- unicodeRange?: string;
519
-
520
- /**
521
- * A valid [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight), as a string.
522
- */
523
- weight?: string;
524
- }
525
- }