@bigcommerce/checkout-sdk 1.661.4 → 1.661.5
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.
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-sdk.d.ts +32 -10
- package/dist/checkout-sdk.js +1 -1
- package/dist/checkout-sdk.js.map +1 -1
- package/dist/checkout-sdk.umd.js +1 -1
- package/dist/checkout-sdk.umd.js.map +1 -1
- package/dist/hosted-form-v2-iframe-host.js +1 -1
- package/dist/hosted-form-v2-iframe-host.umd.js +1 -1
- package/docs/README.md +7 -3
- package/docs/interfaces/AdyenComponent.md +1 -1
- package/docs/interfaces/AdyenComponentEvents.md +4 -2
- package/docs/interfaces/AdyenComponentState.md +47 -0
- package/docs/interfaces/AdyenCreditCardComponentOptions.md +2 -2
- package/docs/interfaces/AdyenIdealComponentOptions.md +101 -0
- package/docs/interfaces/CardState.md +0 -7
- package/docs/interfaces/CardStateData.md +43 -0
- package/docs/interfaces/IdealStateData.md +15 -0
- package/docs/interfaces/SepaStateData.md +22 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -67,6 +67,7 @@
|
|
|
67
67
|
- [AdyenBaseCardComponentOptions](interfaces/AdyenBaseCardComponentOptions.md)
|
|
68
68
|
- [AdyenComponent](interfaces/AdyenComponent.md)
|
|
69
69
|
- [AdyenComponentEvents](interfaces/AdyenComponentEvents.md)
|
|
70
|
+
- [AdyenComponentState](interfaces/AdyenComponentState.md)
|
|
70
71
|
- [AdyenCreditCardComponentOptions](interfaces/AdyenCreditCardComponentOptions.md)
|
|
71
72
|
- [AdyenIdealComponentOptions](interfaces/AdyenIdealComponentOptions.md)
|
|
72
73
|
- [AdyenPaymentMethodState](interfaces/AdyenPaymentMethodState.md)
|
|
@@ -150,6 +151,7 @@
|
|
|
150
151
|
- [CardNumberElementOptions](interfaces/CardNumberElementOptions.md)
|
|
151
152
|
- [CardPaymentMethodState](interfaces/CardPaymentMethodState.md)
|
|
152
153
|
- [CardState](interfaces/CardState.md)
|
|
154
|
+
- [CardStateData](interfaces/CardStateData.md)
|
|
153
155
|
- [CardStateErrors](interfaces/CardStateErrors.md)
|
|
154
156
|
- [CardingProtectionActionData](interfaces/CardingProtectionActionData.md)
|
|
155
157
|
- [Cart](interfaces/Cart.md)
|
|
@@ -280,6 +282,7 @@
|
|
|
280
282
|
- [HostedStoredCardFieldOptionsMap](interfaces/HostedStoredCardFieldOptionsMap.md)
|
|
281
283
|
- [IbanElementOptions](interfaces/IbanElementOptions.md)
|
|
282
284
|
- [IdealElementOptions](interfaces/IdealElementOptions.md)
|
|
285
|
+
- [IdealStateData](interfaces/IdealStateData.md)
|
|
283
286
|
- [IframeEvent](interfaces/IframeEvent.md)
|
|
284
287
|
- [IframeEventPostOptions](interfaces/IframeEventPostOptions.md)
|
|
285
288
|
- [IndividualCardElementOptions](interfaces/IndividualCardElementOptions.md)
|
|
@@ -380,6 +383,7 @@
|
|
|
380
383
|
- [RequestOptions](interfaces/RequestOptions.md)
|
|
381
384
|
- [SearchArea](interfaces/SearchArea.md)
|
|
382
385
|
- [SepaPlaceHolder](interfaces/SepaPlaceHolder.md)
|
|
386
|
+
- [SepaStateData](interfaces/SepaStateData.md)
|
|
383
387
|
- [SetIframeStyleCommand](interfaces/SetIframeStyleCommand.md)
|
|
384
388
|
- [ShippingAddressSelector](interfaces/ShippingAddressSelector.md)
|
|
385
389
|
- [ShippingCountrySelector](interfaces/ShippingCountrySelector.md)
|
|
@@ -488,7 +492,7 @@
|
|
|
488
492
|
|
|
489
493
|
- [AccountInstrument](README.md#accountinstrument)
|
|
490
494
|
- [AddressKey](README.md#addresskey)
|
|
491
|
-
- [
|
|
495
|
+
- [AdyenComponentEventState](README.md#adyencomponenteventstate)
|
|
492
496
|
- [AmazonPayV2ButtonInitializeOptions](README.md#amazonpayv2buttoninitializeoptions)
|
|
493
497
|
- [AnalyticStepType](README.md#analyticsteptype)
|
|
494
498
|
- [BraintreeFormErrorData](README.md#braintreeformerrordata)
|
|
@@ -570,9 +574,9 @@ ___
|
|
|
570
574
|
|
|
571
575
|
___
|
|
572
576
|
|
|
573
|
-
###
|
|
577
|
+
### AdyenComponentEventState
|
|
574
578
|
|
|
575
|
-
Ƭ **
|
|
579
|
+
Ƭ **AdyenComponentEventState**: [`CardState`](interfaces/CardState.md) \| [`BoletoState`](interfaces/BoletoState.md) \| [`WechatState`](interfaces/WechatState.md)
|
|
576
580
|
|
|
577
581
|
___
|
|
578
582
|
|
|
@@ -8,6 +8,8 @@
|
|
|
8
8
|
|
|
9
9
|
↳ [`AdyenCreditCardComponentOptions`](AdyenCreditCardComponentOptions.md)
|
|
10
10
|
|
|
11
|
+
↳ [`AdyenIdealComponentOptions`](AdyenIdealComponentOptions.md)
|
|
12
|
+
|
|
11
13
|
## Table of contents
|
|
12
14
|
|
|
13
15
|
### Methods
|
|
@@ -30,7 +32,7 @@ Here you have the option to override your main Adyen Checkout configuration.
|
|
|
30
32
|
|
|
31
33
|
| Name | Type |
|
|
32
34
|
| :------ | :------ |
|
|
33
|
-
| `state` | [`
|
|
35
|
+
| `state` | [`AdyenComponentEventState`](../README.md#adyencomponenteventstate) |
|
|
34
36
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
35
37
|
|
|
36
38
|
#### Returns
|
|
@@ -86,7 +88,7 @@ Called when the shopper selects the Pay button and payment details are valid.
|
|
|
86
88
|
|
|
87
89
|
| Name | Type |
|
|
88
90
|
| :------ | :------ |
|
|
89
|
-
| `state` | [`
|
|
91
|
+
| `state` | [`AdyenComponentEventState`](../README.md#adyencomponenteventstate) |
|
|
90
92
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
91
93
|
|
|
92
94
|
#### Returns
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AdyenComponentState
|
|
2
|
+
|
|
3
|
+
# Interface: AdyenComponentState
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [data](AdyenComponentState.md#data)
|
|
10
|
+
- [errors](AdyenComponentState.md#errors)
|
|
11
|
+
- [isValid](AdyenComponentState.md#isvalid)
|
|
12
|
+
- [issuer](AdyenComponentState.md#issuer)
|
|
13
|
+
- [valid](AdyenComponentState.md#valid)
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### data
|
|
18
|
+
|
|
19
|
+
• `Optional` **data**: [`CardStateData`](CardStateData.md) \| [`IdealStateData`](IdealStateData.md) \| [`SepaStateData`](SepaStateData.md)
|
|
20
|
+
|
|
21
|
+
___
|
|
22
|
+
|
|
23
|
+
### errors
|
|
24
|
+
|
|
25
|
+
• `Optional` **errors**: [`CardStateErrors`](CardStateErrors.md)
|
|
26
|
+
|
|
27
|
+
___
|
|
28
|
+
|
|
29
|
+
### isValid
|
|
30
|
+
|
|
31
|
+
• `Optional` **isValid**: `boolean`
|
|
32
|
+
|
|
33
|
+
___
|
|
34
|
+
|
|
35
|
+
### issuer
|
|
36
|
+
|
|
37
|
+
• `Optional` **issuer**: `string`
|
|
38
|
+
|
|
39
|
+
___
|
|
40
|
+
|
|
41
|
+
### valid
|
|
42
|
+
|
|
43
|
+
• `Optional` **valid**: `Object`
|
|
44
|
+
|
|
45
|
+
#### Index signature
|
|
46
|
+
|
|
47
|
+
▪ [key: `string`]: `boolean`
|
|
@@ -140,7 +140,7 @@ Here you have the option to override your main Adyen Checkout configuration.
|
|
|
140
140
|
|
|
141
141
|
| Name | Type |
|
|
142
142
|
| :------ | :------ |
|
|
143
|
-
| `state` | [`
|
|
143
|
+
| `state` | [`AdyenComponentEventState`](../README.md#adyencomponenteventstate) |
|
|
144
144
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
145
145
|
|
|
146
146
|
#### Returns
|
|
@@ -208,7 +208,7 @@ Called when the shopper selects the Pay button and payment details are valid.
|
|
|
208
208
|
|
|
209
209
|
| Name | Type |
|
|
210
210
|
| :------ | :------ |
|
|
211
|
-
| `state` | [`
|
|
211
|
+
| `state` | [`AdyenComponentEventState`](../README.md#adyencomponenteventstate) |
|
|
212
212
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
213
213
|
|
|
214
214
|
#### Returns
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
- [`AdyenBaseCardComponentOptions`](AdyenBaseCardComponentOptions.md)
|
|
8
8
|
|
|
9
|
+
- [`AdyenComponentEvents`](AdyenComponentEvents.md)
|
|
10
|
+
|
|
9
11
|
↳ **`AdyenIdealComponentOptions`**
|
|
10
12
|
|
|
11
13
|
## Table of contents
|
|
@@ -17,6 +19,13 @@
|
|
|
17
19
|
- [showImage](AdyenIdealComponentOptions.md#showimage)
|
|
18
20
|
- [styles](AdyenIdealComponentOptions.md#styles)
|
|
19
21
|
|
|
22
|
+
### Methods
|
|
23
|
+
|
|
24
|
+
- [onChange](AdyenIdealComponentOptions.md#onchange)
|
|
25
|
+
- [onError](AdyenIdealComponentOptions.md#onerror)
|
|
26
|
+
- [onFieldValid](AdyenIdealComponentOptions.md#onfieldvalid)
|
|
27
|
+
- [onSubmit](AdyenIdealComponentOptions.md#onsubmit)
|
|
28
|
+
|
|
20
29
|
## Properties
|
|
21
30
|
|
|
22
31
|
### brands
|
|
@@ -59,3 +68,95 @@ for a list of supported properties.
|
|
|
59
68
|
#### Inherited from
|
|
60
69
|
|
|
61
70
|
[AdyenBaseCardComponentOptions](AdyenBaseCardComponentOptions.md).[styles](AdyenBaseCardComponentOptions.md#styles)
|
|
71
|
+
|
|
72
|
+
## Methods
|
|
73
|
+
|
|
74
|
+
### onChange
|
|
75
|
+
|
|
76
|
+
▸ `Optional` **onChange**(`state`, `component`): `void`
|
|
77
|
+
|
|
78
|
+
Called when the shopper enters data in the card input fields.
|
|
79
|
+
Here you have the option to override your main Adyen Checkout configuration.
|
|
80
|
+
|
|
81
|
+
#### Parameters
|
|
82
|
+
|
|
83
|
+
| Name | Type |
|
|
84
|
+
| :------ | :------ |
|
|
85
|
+
| `state` | [`AdyenComponentEventState`](../README.md#adyencomponenteventstate) |
|
|
86
|
+
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
87
|
+
|
|
88
|
+
#### Returns
|
|
89
|
+
|
|
90
|
+
`void`
|
|
91
|
+
|
|
92
|
+
#### Inherited from
|
|
93
|
+
|
|
94
|
+
[AdyenComponentEvents](AdyenComponentEvents.md).[onChange](AdyenComponentEvents.md#onchange)
|
|
95
|
+
|
|
96
|
+
___
|
|
97
|
+
|
|
98
|
+
### onError
|
|
99
|
+
|
|
100
|
+
▸ `Optional` **onError**(`state`, `component`): `void`
|
|
101
|
+
|
|
102
|
+
Called in case of an invalid card number, invalid expiry date, or
|
|
103
|
+
incomplete field. Called again when errors are cleared.
|
|
104
|
+
|
|
105
|
+
#### Parameters
|
|
106
|
+
|
|
107
|
+
| Name | Type |
|
|
108
|
+
| :------ | :------ |
|
|
109
|
+
| `state` | [`AdyenValidationState`](AdyenValidationState.md) |
|
|
110
|
+
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
111
|
+
|
|
112
|
+
#### Returns
|
|
113
|
+
|
|
114
|
+
`void`
|
|
115
|
+
|
|
116
|
+
#### Inherited from
|
|
117
|
+
|
|
118
|
+
[AdyenComponentEvents](AdyenComponentEvents.md).[onError](AdyenComponentEvents.md#onerror)
|
|
119
|
+
|
|
120
|
+
___
|
|
121
|
+
|
|
122
|
+
### onFieldValid
|
|
123
|
+
|
|
124
|
+
▸ `Optional` **onFieldValid**(`state`, `component`): `void`
|
|
125
|
+
|
|
126
|
+
#### Parameters
|
|
127
|
+
|
|
128
|
+
| Name | Type |
|
|
129
|
+
| :------ | :------ |
|
|
130
|
+
| `state` | [`AdyenValidationState`](AdyenValidationState.md) |
|
|
131
|
+
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
132
|
+
|
|
133
|
+
#### Returns
|
|
134
|
+
|
|
135
|
+
`void`
|
|
136
|
+
|
|
137
|
+
#### Inherited from
|
|
138
|
+
|
|
139
|
+
[AdyenComponentEvents](AdyenComponentEvents.md).[onFieldValid](AdyenComponentEvents.md#onfieldvalid)
|
|
140
|
+
|
|
141
|
+
___
|
|
142
|
+
|
|
143
|
+
### onSubmit
|
|
144
|
+
|
|
145
|
+
▸ `Optional` **onSubmit**(`state`, `component`): `void`
|
|
146
|
+
|
|
147
|
+
Called when the shopper selects the Pay button and payment details are valid.
|
|
148
|
+
|
|
149
|
+
#### Parameters
|
|
150
|
+
|
|
151
|
+
| Name | Type |
|
|
152
|
+
| :------ | :------ |
|
|
153
|
+
| `state` | [`AdyenComponentEventState`](../README.md#adyencomponenteventstate) |
|
|
154
|
+
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
155
|
+
|
|
156
|
+
#### Returns
|
|
157
|
+
|
|
158
|
+
`void`
|
|
159
|
+
|
|
160
|
+
#### Inherited from
|
|
161
|
+
|
|
162
|
+
[AdyenComponentEvents](AdyenComponentEvents.md).[onSubmit](AdyenComponentEvents.md#onsubmit)
|
|
@@ -9,7 +9,6 @@
|
|
|
9
9
|
- [data](CardState.md#data)
|
|
10
10
|
- [errors](CardState.md#errors)
|
|
11
11
|
- [isValid](CardState.md#isvalid)
|
|
12
|
-
- [issuer](CardState.md#issuer)
|
|
13
12
|
- [valid](CardState.md#valid)
|
|
14
13
|
|
|
15
14
|
## Properties
|
|
@@ -32,12 +31,6 @@ ___
|
|
|
32
31
|
|
|
33
32
|
___
|
|
34
33
|
|
|
35
|
-
### issuer
|
|
36
|
-
|
|
37
|
-
• `Optional` **issuer**: `string`
|
|
38
|
-
|
|
39
|
-
___
|
|
40
|
-
|
|
41
34
|
### valid
|
|
42
35
|
|
|
43
36
|
• `Optional` **valid**: `Object`
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / CardStateData
|
|
2
|
+
|
|
3
|
+
# Interface: CardStateData
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [encryptedCardNumber](CardStateData.md#encryptedcardnumber)
|
|
10
|
+
- [encryptedExpiryMonth](CardStateData.md#encryptedexpirymonth)
|
|
11
|
+
- [encryptedExpiryYear](CardStateData.md#encryptedexpiryyear)
|
|
12
|
+
- [encryptedSecurityCode](CardStateData.md#encryptedsecuritycode)
|
|
13
|
+
- [holderName](CardStateData.md#holdername)
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### encryptedCardNumber
|
|
18
|
+
|
|
19
|
+
• **encryptedCardNumber**: `string`
|
|
20
|
+
|
|
21
|
+
___
|
|
22
|
+
|
|
23
|
+
### encryptedExpiryMonth
|
|
24
|
+
|
|
25
|
+
• **encryptedExpiryMonth**: `string`
|
|
26
|
+
|
|
27
|
+
___
|
|
28
|
+
|
|
29
|
+
### encryptedExpiryYear
|
|
30
|
+
|
|
31
|
+
• **encryptedExpiryYear**: `string`
|
|
32
|
+
|
|
33
|
+
___
|
|
34
|
+
|
|
35
|
+
### encryptedSecurityCode
|
|
36
|
+
|
|
37
|
+
• **encryptedSecurityCode**: `string`
|
|
38
|
+
|
|
39
|
+
___
|
|
40
|
+
|
|
41
|
+
### holderName
|
|
42
|
+
|
|
43
|
+
• **holderName**: `string`
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / SepaStateData
|
|
2
|
+
|
|
3
|
+
# Interface: SepaStateData
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [ibanNumber](SepaStateData.md#ibannumber)
|
|
10
|
+
- [ownerName](SepaStateData.md#ownername)
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### ibanNumber
|
|
15
|
+
|
|
16
|
+
• **ibanNumber**: `string`
|
|
17
|
+
|
|
18
|
+
___
|
|
19
|
+
|
|
20
|
+
### ownerName
|
|
21
|
+
|
|
22
|
+
• **ownerName**: `string`
|