@stripe/stripe-js 1.20.3 → 1.21.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 (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 -180
  36. package/types/stripe-js/elements/shipping-address.d.ts +123 -125
  37. package/types/stripe-js/elements-group.d.ts +617 -0
  38. package/types/stripe-js/index.d.ts +7 -1069
  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 -604
@@ -1,140 +1,143 @@
1
- ///<reference path='./base.d.ts' />
1
+ import {
2
+ StripeElementBase,
3
+ StripeElementStyle,
4
+ StripeElementClasses,
5
+ StripeElementChangeEvent,
6
+ } from './base';
2
7
 
3
- declare module '@stripe/stripe-js' {
4
- type StripeCardNumberElement = StripeElementBase & {
5
- /**
6
- * The change event is triggered when the `Element`'s value changes.
7
- */
8
- on(
9
- eventType: 'change',
10
- handler: (event: StripeCardNumberElementChangeEvent) => any
11
- ): StripeCardNumberElement;
12
- once(
13
- eventType: 'change',
14
- handler: (event: StripeCardNumberElementChangeEvent) => any
15
- ): StripeCardNumberElement;
16
- off(
17
- eventType: 'change',
18
- handler?: (event: StripeCardNumberElementChangeEvent) => any
19
- ): StripeCardNumberElement;
8
+ export type StripeCardNumberElement = StripeElementBase & {
9
+ /**
10
+ * The change event is triggered when the `Element`'s value changes.
11
+ */
12
+ on(
13
+ eventType: 'change',
14
+ handler: (event: StripeCardNumberElementChangeEvent) => any
15
+ ): StripeCardNumberElement;
16
+ once(
17
+ eventType: 'change',
18
+ handler: (event: StripeCardNumberElementChangeEvent) => any
19
+ ): StripeCardNumberElement;
20
+ off(
21
+ eventType: 'change',
22
+ handler?: (event: StripeCardNumberElementChangeEvent) => any
23
+ ): StripeCardNumberElement;
20
24
 
21
- /**
22
- * Triggered when the element is fully rendered and can accept `element.focus` calls.
23
- */
24
- on(
25
- eventType: 'ready',
26
- handler: (event: {elementType: 'cardNumber'}) => any
27
- ): StripeCardNumberElement;
28
- once(
29
- eventType: 'ready',
30
- handler: (event: {elementType: 'cardNumber'}) => any
31
- ): StripeCardNumberElement;
32
- off(
33
- eventType: 'ready',
34
- handler?: (event: {elementType: 'cardNumber'}) => any
35
- ): StripeCardNumberElement;
25
+ /**
26
+ * Triggered when the element is fully rendered and can accept `element.focus` calls.
27
+ */
28
+ on(
29
+ eventType: 'ready',
30
+ handler: (event: {elementType: 'cardNumber'}) => any
31
+ ): StripeCardNumberElement;
32
+ once(
33
+ eventType: 'ready',
34
+ handler: (event: {elementType: 'cardNumber'}) => any
35
+ ): StripeCardNumberElement;
36
+ off(
37
+ eventType: 'ready',
38
+ handler?: (event: {elementType: 'cardNumber'}) => any
39
+ ): StripeCardNumberElement;
36
40
 
37
- /**
38
- * Triggered when the element gains focus.
39
- */
40
- on(
41
- eventType: 'focus',
42
- handler: (event: {elementType: 'cardNumber'}) => any
43
- ): StripeCardNumberElement;
44
- once(
45
- eventType: 'focus',
46
- handler: (event: {elementType: 'cardNumber'}) => any
47
- ): StripeCardNumberElement;
48
- off(
49
- eventType: 'focus',
50
- handler?: (event: {elementType: 'cardNumber'}) => any
51
- ): StripeCardNumberElement;
41
+ /**
42
+ * Triggered when the element gains focus.
43
+ */
44
+ on(
45
+ eventType: 'focus',
46
+ handler: (event: {elementType: 'cardNumber'}) => any
47
+ ): StripeCardNumberElement;
48
+ once(
49
+ eventType: 'focus',
50
+ handler: (event: {elementType: 'cardNumber'}) => any
51
+ ): StripeCardNumberElement;
52
+ off(
53
+ eventType: 'focus',
54
+ handler?: (event: {elementType: 'cardNumber'}) => any
55
+ ): StripeCardNumberElement;
52
56
 
53
- /**
54
- * Triggered when the element loses focus.
55
- */
56
- on(
57
- eventType: 'blur',
58
- handler: (event: {elementType: 'cardNumber'}) => any
59
- ): StripeCardNumberElement;
60
- once(
61
- eventType: 'blur',
62
- handler: (event: {elementType: 'cardNumber'}) => any
63
- ): StripeCardNumberElement;
64
- off(
65
- eventType: 'blur',
66
- handler?: (event: {elementType: 'cardNumber'}) => any
67
- ): StripeCardNumberElement;
57
+ /**
58
+ * Triggered when the element loses focus.
59
+ */
60
+ on(
61
+ eventType: 'blur',
62
+ handler: (event: {elementType: 'cardNumber'}) => any
63
+ ): StripeCardNumberElement;
64
+ once(
65
+ eventType: 'blur',
66
+ handler: (event: {elementType: 'cardNumber'}) => any
67
+ ): StripeCardNumberElement;
68
+ off(
69
+ eventType: 'blur',
70
+ handler?: (event: {elementType: 'cardNumber'}) => any
71
+ ): StripeCardNumberElement;
68
72
 
69
- /**
70
- * Triggered when the escape key is pressed within the element.
71
- */
72
- on(
73
- eventType: 'escape',
74
- handler: (event: {elementType: 'cardNumber'}) => any
75
- ): StripeCardNumberElement;
76
- once(
77
- eventType: 'escape',
78
- handler: (event: {elementType: 'cardNumber'}) => any
79
- ): StripeCardNumberElement;
80
- off(
81
- eventType: 'escape',
82
- handler?: (event: {elementType: 'cardNumber'}) => any
83
- ): StripeCardNumberElement;
73
+ /**
74
+ * Triggered when the escape key is pressed within the element.
75
+ */
76
+ on(
77
+ eventType: 'escape',
78
+ handler: (event: {elementType: 'cardNumber'}) => any
79
+ ): StripeCardNumberElement;
80
+ once(
81
+ eventType: 'escape',
82
+ handler: (event: {elementType: 'cardNumber'}) => any
83
+ ): StripeCardNumberElement;
84
+ off(
85
+ eventType: 'escape',
86
+ handler?: (event: {elementType: 'cardNumber'}) => any
87
+ ): StripeCardNumberElement;
84
88
 
85
- /**
86
- * Updates the options the `CardNumberElement` was initialized with.
87
- * Updates are merged into the existing configuration.
88
- *
89
- * The styles of an `Element` can be dynamically changed using `element.update`.
90
- * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
91
- */
92
- update(options: Partial<StripeCardNumberElementOptions>): void;
93
- };
89
+ /**
90
+ * Updates the options the `CardNumberElement` was initialized with.
91
+ * Updates are merged into the existing configuration.
92
+ *
93
+ * The styles of an `Element` can be dynamically changed using `element.update`.
94
+ * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
95
+ */
96
+ update(options: Partial<StripeCardNumberElementOptions>): void;
97
+ };
94
98
 
95
- interface StripeCardNumberElementOptions {
96
- classes?: StripeElementClasses;
99
+ export interface StripeCardNumberElementOptions {
100
+ classes?: StripeElementClasses;
97
101
 
98
- style?: StripeElementStyle;
102
+ style?: StripeElementStyle;
99
103
 
100
- placeholder?: string;
104
+ placeholder?: string;
101
105
 
102
- /**
103
- * Applies a disabled state to the Element such that user input is not accepted.
104
- * Default is false.
105
- */
106
- disabled?: boolean;
106
+ /**
107
+ * Applies a disabled state to the Element such that user input is not accepted.
108
+ * Default is false.
109
+ */
110
+ disabled?: boolean;
107
111
 
108
- /**
109
- * Show a card brand icon in the Element.
110
- * Default is `false`.
111
- */
112
- showIcon?: boolean;
112
+ /**
113
+ * Show a card brand icon in the Element.
114
+ * Default is `false`.
115
+ */
116
+ showIcon?: boolean;
113
117
 
114
- /**
115
- * Appearance of the brand icon in the Element.
116
- */
117
- iconStyle?: 'default' | 'solid';
118
- }
118
+ /**
119
+ * Appearance of the brand icon in the Element.
120
+ */
121
+ iconStyle?: 'default' | 'solid';
122
+ }
119
123
 
120
- interface StripeCardNumberElementChangeEvent
121
- extends StripeElementChangeEvent {
122
- /**
123
- * The type of element that emitted this event.
124
- */
125
- elementType: 'cardNumber';
124
+ export interface StripeCardNumberElementChangeEvent
125
+ extends StripeElementChangeEvent {
126
+ /**
127
+ * The type of element that emitted this event.
128
+ */
129
+ elementType: 'cardNumber';
126
130
 
127
- /*
128
- * The card brand of the card number being entered.
129
- */
130
- brand:
131
- | 'visa'
132
- | 'mastercard'
133
- | 'amex'
134
- | 'discover'
135
- | 'diners'
136
- | 'jcb'
137
- | 'unionpay'
138
- | 'unknown';
139
- }
131
+ /*
132
+ * The card brand of the card number being entered.
133
+ */
134
+ brand:
135
+ | 'visa'
136
+ | 'mastercard'
137
+ | 'amex'
138
+ | 'discover'
139
+ | 'diners'
140
+ | 'jcb'
141
+ | 'unionpay'
142
+ | 'unknown';
140
143
  }
@@ -1,155 +1,158 @@
1
- ///<reference path='./base.d.ts' />
2
-
3
- declare module '@stripe/stripe-js' {
4
- type StripeCardElement = StripeElementBase & {
5
- /**
6
- * The change event is triggered when the `Element`'s value changes.
7
- */
8
- on(
9
- eventType: 'change',
10
- handler: (event: StripeCardElementChangeEvent) => any
11
- ): StripeCardElement;
12
- once(
13
- eventType: 'change',
14
- handler: (event: StripeCardElementChangeEvent) => any
15
- ): StripeCardElement;
16
- off(
17
- eventType: 'change',
18
- handler?: (event: StripeCardElementChangeEvent) => any
19
- ): StripeCardElement;
20
-
21
- /**
22
- * Triggered when the element is fully rendered and can accept `element.focus` calls.
23
- */
24
- on(
25
- eventType: 'ready',
26
- handler: (event: {elementType: 'card'}) => any
27
- ): StripeCardElement;
28
- once(
29
- eventType: 'ready',
30
- handler: (event: {elementType: 'card'}) => any
31
- ): StripeCardElement;
32
- off(
33
- eventType: 'ready',
34
- handler?: (event: {elementType: 'card'}) => any
35
- ): StripeCardElement;
36
-
37
- /**
38
- * Triggered when the element gains focus.
39
- */
40
- on(
41
- eventType: 'focus',
42
- handler: (event: {elementType: 'card'}) => any
43
- ): StripeCardElement;
44
- once(
45
- eventType: 'focus',
46
- handler: (event: {elementType: 'card'}) => any
47
- ): StripeCardElement;
48
- off(
49
- eventType: 'focus',
50
- handler?: (event: {elementType: 'card'}) => any
51
- ): StripeCardElement;
52
-
53
- /**
54
- * Triggered when the element loses focus.
55
- */
56
- on(
57
- eventType: 'blur',
58
- handler: (event: {elementType: 'card'}) => any
59
- ): StripeCardElement;
60
- once(
61
- eventType: 'blur',
62
- handler: (event: {elementType: 'card'}) => any
63
- ): StripeCardElement;
64
- off(
65
- eventType: 'blur',
66
- handler?: (event: {elementType: 'card'}) => any
67
- ): StripeCardElement;
68
-
69
- /**
70
- * Triggered when the escape key is pressed within the element.
71
- */
72
- on(
73
- eventType: 'escape',
74
- handler: (event: {elementType: 'card'}) => any
75
- ): StripeCardElement;
76
- once(
77
- eventType: 'escape',
78
- handler: (event: {elementType: 'card'}) => any
79
- ): StripeCardElement;
80
- off(
81
- eventType: 'escape',
82
- handler?: (event: {elementType: 'card'}) => any
83
- ): StripeCardElement;
84
-
85
- /**
86
- * Updates the options the `CardElement` was initialized with.
87
- * Updates are merged into the existing configuration.
88
- *
89
- * The styles of an `CardElement` can be dynamically changed using `element.update`.
90
- * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
91
- */
92
- update(options: Partial<StripeCardElementOptions>): void;
93
- };
94
-
95
- interface StripeCardElementOptions {
96
- classes?: StripeElementClasses;
97
-
98
- style?: StripeElementStyle;
99
-
100
- /**
101
- * A pre-filled set of values to include in the input (e.g., `{postalCode: '94110'}`).
102
- * Note that sensitive card information (card number, CVC, and expiration date) cannot be pre-filled.
103
- */
104
- value?: {postalCode?: string};
105
-
106
- /**
107
- * Hide the postal code field.
108
- * Default is `false`.
109
- * If you are already collecting a full billing address or postal code elsewhere, set this to `true`.
110
- */
111
- hidePostalCode?: boolean;
112
-
113
- /**
114
- * Appearance of the icon in the Element.
115
- */
116
- iconStyle?: 'default' | 'solid';
117
-
118
- /**
119
- * Hides the icon in the Element.
120
- * Default is `false`.
121
- */
122
- hideIcon?: boolean;
123
-
124
- /**
125
- * Applies a disabled state to the Element such that user input is not accepted.
126
- * Default is false.
127
- */
128
- disabled?: boolean;
129
- }
130
-
131
- interface StripeCardElementChangeEvent extends StripeElementChangeEvent {
132
- /**
133
- * The type of element that emitted this event.
134
- */
135
- elementType: 'card';
136
-
137
- /**
138
- * An object containing the currently entered `postalCode`.
139
- */
140
- value: {postalCode: string};
141
-
142
- /*
143
- * The card brand of the card number being entered.
144
- */
145
- brand:
146
- | 'visa'
147
- | 'mastercard'
148
- | 'amex'
149
- | 'discover'
150
- | 'diners'
151
- | 'jcb'
152
- | 'unionpay'
153
- | 'unknown';
154
- }
1
+ import {
2
+ StripeElementBase,
3
+ StripeElementStyle,
4
+ StripeElementClasses,
5
+ StripeElementChangeEvent,
6
+ } from './base';
7
+
8
+ export type StripeCardElement = StripeElementBase & {
9
+ /**
10
+ * The change event is triggered when the `Element`'s value changes.
11
+ */
12
+ on(
13
+ eventType: 'change',
14
+ handler: (event: StripeCardElementChangeEvent) => any
15
+ ): StripeCardElement;
16
+ once(
17
+ eventType: 'change',
18
+ handler: (event: StripeCardElementChangeEvent) => any
19
+ ): StripeCardElement;
20
+ off(
21
+ eventType: 'change',
22
+ handler?: (event: StripeCardElementChangeEvent) => any
23
+ ): StripeCardElement;
24
+
25
+ /**
26
+ * Triggered when the element is fully rendered and can accept `element.focus` calls.
27
+ */
28
+ on(
29
+ eventType: 'ready',
30
+ handler: (event: {elementType: 'card'}) => any
31
+ ): StripeCardElement;
32
+ once(
33
+ eventType: 'ready',
34
+ handler: (event: {elementType: 'card'}) => any
35
+ ): StripeCardElement;
36
+ off(
37
+ eventType: 'ready',
38
+ handler?: (event: {elementType: 'card'}) => any
39
+ ): StripeCardElement;
40
+
41
+ /**
42
+ * Triggered when the element gains focus.
43
+ */
44
+ on(
45
+ eventType: 'focus',
46
+ handler: (event: {elementType: 'card'}) => any
47
+ ): StripeCardElement;
48
+ once(
49
+ eventType: 'focus',
50
+ handler: (event: {elementType: 'card'}) => any
51
+ ): StripeCardElement;
52
+ off(
53
+ eventType: 'focus',
54
+ handler?: (event: {elementType: 'card'}) => any
55
+ ): StripeCardElement;
56
+
57
+ /**
58
+ * Triggered when the element loses focus.
59
+ */
60
+ on(
61
+ eventType: 'blur',
62
+ handler: (event: {elementType: 'card'}) => any
63
+ ): StripeCardElement;
64
+ once(
65
+ eventType: 'blur',
66
+ handler: (event: {elementType: 'card'}) => any
67
+ ): StripeCardElement;
68
+ off(
69
+ eventType: 'blur',
70
+ handler?: (event: {elementType: 'card'}) => any
71
+ ): StripeCardElement;
72
+
73
+ /**
74
+ * Triggered when the escape key is pressed within the element.
75
+ */
76
+ on(
77
+ eventType: 'escape',
78
+ handler: (event: {elementType: 'card'}) => any
79
+ ): StripeCardElement;
80
+ once(
81
+ eventType: 'escape',
82
+ handler: (event: {elementType: 'card'}) => any
83
+ ): StripeCardElement;
84
+ off(
85
+ eventType: 'escape',
86
+ handler?: (event: {elementType: 'card'}) => any
87
+ ): StripeCardElement;
88
+
89
+ /**
90
+ * Updates the options the `CardElement` was initialized with.
91
+ * Updates are merged into the existing configuration.
92
+ *
93
+ * The styles of an `CardElement` can be dynamically changed using `element.update`.
94
+ * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
95
+ */
96
+ update(options: Partial<StripeCardElementOptions>): void;
97
+ };
98
+
99
+ export interface StripeCardElementOptions {
100
+ classes?: StripeElementClasses;
101
+
102
+ style?: StripeElementStyle;
103
+
104
+ /**
105
+ * A pre-filled set of values to include in the input (e.g., `{postalCode: '94110'}`).
106
+ * Note that sensitive card information (card number, CVC, and expiration date) cannot be pre-filled.
107
+ */
108
+ value?: {postalCode?: string};
109
+
110
+ /**
111
+ * Hide the postal code field.
112
+ * Default is `false`.
113
+ * If you are already collecting a full billing address or postal code elsewhere, set this to `true`.
114
+ */
115
+ hidePostalCode?: boolean;
116
+
117
+ /**
118
+ * Appearance of the icon in the Element.
119
+ */
120
+ iconStyle?: 'default' | 'solid';
121
+
122
+ /**
123
+ * Hides the icon in the Element.
124
+ * Default is `false`.
125
+ */
126
+ hideIcon?: boolean;
127
+
128
+ /**
129
+ * Applies a disabled state to the Element such that user input is not accepted.
130
+ * Default is false.
131
+ */
132
+ disabled?: boolean;
133
+ }
134
+
135
+ export interface StripeCardElementChangeEvent extends StripeElementChangeEvent {
136
+ /**
137
+ * The type of element that emitted this event.
138
+ */
139
+ elementType: 'card';
140
+
141
+ /**
142
+ * An object containing the currently entered `postalCode`.
143
+ */
144
+ value: {postalCode: string};
145
+
146
+ /*
147
+ * The card brand of the card number being entered.
148
+ */
149
+ brand:
150
+ | 'visa'
151
+ | 'mastercard'
152
+ | 'amex'
153
+ | 'discover'
154
+ | 'diners'
155
+ | 'jcb'
156
+ | 'unionpay'
157
+ | 'unknown';
155
158
  }