@bigcommerce/checkout-sdk 1.576.0 → 1.576.1

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 (45) hide show
  1. package/dist/checkout-button.js +1 -1
  2. package/dist/checkout-button.umd.js +1 -1
  3. package/dist/checkout-sdk.d.ts +20 -330
  4. package/dist/checkout-sdk.js +1 -1
  5. package/dist/checkout-sdk.js.map +1 -1
  6. package/dist/checkout-sdk.umd.js +1 -1
  7. package/dist/checkout-sdk.umd.js.map +1 -1
  8. package/docs/README.md +4 -34
  9. package/docs/enums/AdyenCardFields.md +29 -0
  10. package/docs/interfaces/AdyenBaseCardComponentOptions.md +7 -0
  11. package/docs/interfaces/AdyenComponent.md +11 -0
  12. package/docs/interfaces/AdyenComponentEvents.md +22 -2
  13. package/docs/interfaces/AdyenCreditCardComponentOptions.md +37 -2
  14. package/docs/interfaces/AdyenIdealComponentOptions.md +11 -0
  15. package/docs/interfaces/AdyenPlaceholderData.md +14 -0
  16. package/docs/interfaces/AdyenV2PaymentInitializeOptions.md +2 -2
  17. package/docs/interfaces/AdyenV3PaymentInitializeOptions.md +3 -3
  18. package/docs/interfaces/AdyenValidationState.md +57 -0
  19. package/docs/interfaces/BoletoDataPaymentMethodState.md +1 -7
  20. package/package.json +1 -1
  21. package/docs/enums/AdyenV2CardFields.md +0 -29
  22. package/docs/enums/AdyenV3CardFields.md +0 -29
  23. package/docs/interfaces/AdyenAdditionalActionCallbacks_2.md +0 -66
  24. package/docs/interfaces/AdyenAdditionalActionOptions_2.md +0 -106
  25. package/docs/interfaces/AdyenBaseCardComponentOptions_2.md +0 -40
  26. package/docs/interfaces/AdyenComponentEvents_2.md +0 -94
  27. package/docs/interfaces/AdyenComponent_2.md +0 -83
  28. package/docs/interfaces/AdyenPaymentMethodState_2.md +0 -15
  29. package/docs/interfaces/AdyenPlaceholderData_2.md +0 -54
  30. package/docs/interfaces/AdyenV2ValidationState.md +0 -57
  31. package/docs/interfaces/AdyenV3CreditCardComponentOptions.md +0 -220
  32. package/docs/interfaces/AdyenV3ValidationState.md +0 -57
  33. package/docs/interfaces/CardDataPaymentMethodState_2.md +0 -15
  34. package/docs/interfaces/CardPaymentMethodState_2.md +0 -43
  35. package/docs/interfaces/CardStateErrors_2.md +0 -7
  36. package/docs/interfaces/CardState_2.md +0 -40
  37. package/docs/interfaces/CreditCardPlaceHolder_2.md +0 -29
  38. package/docs/interfaces/CssProperties_2.md +0 -218
  39. package/docs/interfaces/InputDetail_2.md +0 -80
  40. package/docs/interfaces/Item_3.md +0 -26
  41. package/docs/interfaces/SepaPlaceHolder_2.md +0 -22
  42. package/docs/interfaces/StyleOptions_2.md +0 -44
  43. package/docs/interfaces/SubInputDetail_2.md +0 -62
  44. package/docs/interfaces/WechatDataPaymentMethodState_2.md +0 -15
  45. package/docs/interfaces/WechatState_2.md +0 -15
@@ -1,57 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / AdyenV3ValidationState
2
-
3
- # Interface: AdyenV3ValidationState
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [encryptedFieldName](AdyenV3ValidationState.md#encryptedfieldname)
10
- - [endDigits](AdyenV3ValidationState.md#enddigits)
11
- - [error](AdyenV3ValidationState.md#error)
12
- - [errorKey](AdyenV3ValidationState.md#errorkey)
13
- - [fieldType](AdyenV3ValidationState.md#fieldtype)
14
- - [i18n](AdyenV3ValidationState.md#i18n)
15
- - [valid](AdyenV3ValidationState.md#valid)
16
-
17
- ## Properties
18
-
19
- ### encryptedFieldName
20
-
21
- • `Optional` **encryptedFieldName**: `string`
22
-
23
- ___
24
-
25
- ### endDigits
26
-
27
- • `Optional` **endDigits**: `string`
28
-
29
- ___
30
-
31
- ### error
32
-
33
- • `Optional` **error**: `string`
34
-
35
- ___
36
-
37
- ### errorKey
38
-
39
- • `Optional` **errorKey**: `string`
40
-
41
- ___
42
-
43
- ### fieldType
44
-
45
- • `Optional` **fieldType**: [`CardNumber`](../enums/AdyenV3CardFields.md#cardnumber) \| [`SecurityCode`](../enums/AdyenV3CardFields.md#securitycode) \| [`ExpiryDate`](../enums/AdyenV3CardFields.md#expirydate)
46
-
47
- ___
48
-
49
- ### i18n
50
-
51
- • `Optional` **i18n**: `string`
52
-
53
- ___
54
-
55
- ### valid
56
-
57
- • **valid**: `boolean`
@@ -1,15 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / CardDataPaymentMethodState_2
2
-
3
- # Interface: CardDataPaymentMethodState\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [paymentMethod](CardDataPaymentMethodState_2.md#paymentmethod)
10
-
11
- ## Properties
12
-
13
- ### paymentMethod
14
-
15
- • **paymentMethod**: [`CardPaymentMethodState_2`](CardPaymentMethodState_2.md)
@@ -1,43 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / CardPaymentMethodState_2
2
-
3
- # Interface: CardPaymentMethodState\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [encryptedCardNumber](CardPaymentMethodState_2.md#encryptedcardnumber)
10
- - [encryptedExpiryMonth](CardPaymentMethodState_2.md#encryptedexpirymonth)
11
- - [encryptedExpiryYear](CardPaymentMethodState_2.md#encryptedexpiryyear)
12
- - [encryptedSecurityCode](CardPaymentMethodState_2.md#encryptedsecuritycode)
13
- - [holderName](CardPaymentMethodState_2.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`
@@ -1,7 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / CardStateErrors_2
2
-
3
- # Interface: CardStateErrors\_2
4
-
5
- ## Indexable
6
-
7
- ▪ [key: `string`]: `string`
@@ -1,40 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / CardState_2
2
-
3
- # Interface: CardState\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [data](CardState_2.md#data)
10
- - [errors](CardState_2.md#errors)
11
- - [isValid](CardState_2.md#isvalid)
12
- - [valid](CardState_2.md#valid)
13
-
14
- ## Properties
15
-
16
- ### data
17
-
18
- • **data**: [`CardDataPaymentMethodState_2`](CardDataPaymentMethodState_2.md)
19
-
20
- ___
21
-
22
- ### errors
23
-
24
- • `Optional` **errors**: [`CardStateErrors_2`](CardStateErrors_2.md)
25
-
26
- ___
27
-
28
- ### isValid
29
-
30
- • `Optional` **isValid**: `boolean`
31
-
32
- ___
33
-
34
- ### valid
35
-
36
- • `Optional` **valid**: `Object`
37
-
38
- #### Index signature
39
-
40
- ▪ [key: `string`]: `boolean`
@@ -1,29 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / CreditCardPlaceHolder_2
2
-
3
- # Interface: CreditCardPlaceHolder\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [encryptedCardNumber](CreditCardPlaceHolder_2.md#encryptedcardnumber)
10
- - [encryptedExpiryDate](CreditCardPlaceHolder_2.md#encryptedexpirydate)
11
- - [encryptedSecurityCode](CreditCardPlaceHolder_2.md#encryptedsecuritycode)
12
-
13
- ## Properties
14
-
15
- ### encryptedCardNumber
16
-
17
- • `Optional` **encryptedCardNumber**: `string`
18
-
19
- ___
20
-
21
- ### encryptedExpiryDate
22
-
23
- • `Optional` **encryptedExpiryDate**: `string`
24
-
25
- ___
26
-
27
- ### encryptedSecurityCode
28
-
29
- • **encryptedSecurityCode**: `string`
@@ -1,218 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / CssProperties_2
2
-
3
- # Interface: CssProperties\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [background](CssProperties_2.md#background)
10
- - [caretColor](CssProperties_2.md#caretcolor)
11
- - [color](CssProperties_2.md#color)
12
- - [display](CssProperties_2.md#display)
13
- - [font](CssProperties_2.md#font)
14
- - [fontFamily](CssProperties_2.md#fontfamily)
15
- - [fontSize](CssProperties_2.md#fontsize)
16
- - [fontSizeAdjust](CssProperties_2.md#fontsizeadjust)
17
- - [fontSmoothing](CssProperties_2.md#fontsmoothing)
18
- - [fontStretch](CssProperties_2.md#fontstretch)
19
- - [fontStyle](CssProperties_2.md#fontstyle)
20
- - [fontVariant](CssProperties_2.md#fontvariant)
21
- - [fontVariantAlternates](CssProperties_2.md#fontvariantalternates)
22
- - [fontVariantCaps](CssProperties_2.md#fontvariantcaps)
23
- - [fontVariantEastAsian](CssProperties_2.md#fontvarianteastasian)
24
- - [fontVariantLigatures](CssProperties_2.md#fontvariantligatures)
25
- - [fontVariantNumeric](CssProperties_2.md#fontvariantnumeric)
26
- - [fontWeight](CssProperties_2.md#fontweight)
27
- - [letterSpacing](CssProperties_2.md#letterspacing)
28
- - [lineHeight](CssProperties_2.md#lineheight)
29
- - [mozOsxFontSmoothing](CssProperties_2.md#mozosxfontsmoothing)
30
- - [mozTransition](CssProperties_2.md#moztransition)
31
- - [opacity](CssProperties_2.md#opacity)
32
- - [outline](CssProperties_2.md#outline)
33
- - [padding](CssProperties_2.md#padding)
34
- - [textAlign](CssProperties_2.md#textalign)
35
- - [textShadow](CssProperties_2.md#textshadow)
36
- - [transition](CssProperties_2.md#transition)
37
- - [webkitFontSmoothing](CssProperties_2.md#webkitfontsmoothing)
38
- - [webkitTransition](CssProperties_2.md#webkittransition)
39
-
40
- ## Properties
41
-
42
- ### background
43
-
44
- • `Optional` **background**: `string`
45
-
46
- ___
47
-
48
- ### caretColor
49
-
50
- • `Optional` **caretColor**: `string`
51
-
52
- ___
53
-
54
- ### color
55
-
56
- • `Optional` **color**: `string`
57
-
58
- ___
59
-
60
- ### display
61
-
62
- • `Optional` **display**: `string`
63
-
64
- ___
65
-
66
- ### font
67
-
68
- • `Optional` **font**: `string`
69
-
70
- ___
71
-
72
- ### fontFamily
73
-
74
- • `Optional` **fontFamily**: `string`
75
-
76
- ___
77
-
78
- ### fontSize
79
-
80
- • `Optional` **fontSize**: `string`
81
-
82
- ___
83
-
84
- ### fontSizeAdjust
85
-
86
- • `Optional` **fontSizeAdjust**: `string`
87
-
88
- ___
89
-
90
- ### fontSmoothing
91
-
92
- • `Optional` **fontSmoothing**: `string`
93
-
94
- ___
95
-
96
- ### fontStretch
97
-
98
- • `Optional` **fontStretch**: `string`
99
-
100
- ___
101
-
102
- ### fontStyle
103
-
104
- • `Optional` **fontStyle**: `string`
105
-
106
- ___
107
-
108
- ### fontVariant
109
-
110
- • `Optional` **fontVariant**: `string`
111
-
112
- ___
113
-
114
- ### fontVariantAlternates
115
-
116
- • `Optional` **fontVariantAlternates**: `string`
117
-
118
- ___
119
-
120
- ### fontVariantCaps
121
-
122
- • `Optional` **fontVariantCaps**: `string`
123
-
124
- ___
125
-
126
- ### fontVariantEastAsian
127
-
128
- • `Optional` **fontVariantEastAsian**: `string`
129
-
130
- ___
131
-
132
- ### fontVariantLigatures
133
-
134
- • `Optional` **fontVariantLigatures**: `string`
135
-
136
- ___
137
-
138
- ### fontVariantNumeric
139
-
140
- • `Optional` **fontVariantNumeric**: `string`
141
-
142
- ___
143
-
144
- ### fontWeight
145
-
146
- • `Optional` **fontWeight**: `string`
147
-
148
- ___
149
-
150
- ### letterSpacing
151
-
152
- • `Optional` **letterSpacing**: `string`
153
-
154
- ___
155
-
156
- ### lineHeight
157
-
158
- • `Optional` **lineHeight**: `string`
159
-
160
- ___
161
-
162
- ### mozOsxFontSmoothing
163
-
164
- • `Optional` **mozOsxFontSmoothing**: `string`
165
-
166
- ___
167
-
168
- ### mozTransition
169
-
170
- • `Optional` **mozTransition**: `string`
171
-
172
- ___
173
-
174
- ### opacity
175
-
176
- • `Optional` **opacity**: `string` \| `number`
177
-
178
- ___
179
-
180
- ### outline
181
-
182
- • `Optional` **outline**: `string`
183
-
184
- ___
185
-
186
- ### padding
187
-
188
- • `Optional` **padding**: `string`
189
-
190
- ___
191
-
192
- ### textAlign
193
-
194
- • `Optional` **textAlign**: `string`
195
-
196
- ___
197
-
198
- ### textShadow
199
-
200
- • `Optional` **textShadow**: `string`
201
-
202
- ___
203
-
204
- ### transition
205
-
206
- • `Optional` **transition**: `string`
207
-
208
- ___
209
-
210
- ### webkitFontSmoothing
211
-
212
- • `Optional` **webkitFontSmoothing**: `string`
213
-
214
- ___
215
-
216
- ### webkitTransition
217
-
218
- • `Optional` **webkitTransition**: `string`
@@ -1,80 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / InputDetail_2
2
-
3
- # Interface: InputDetail\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [configuration](InputDetail_2.md#configuration)
10
- - [details](InputDetail_2.md#details)
11
- - [itemSearchUrl](InputDetail_2.md#itemsearchurl)
12
- - [items](InputDetail_2.md#items)
13
- - [key](InputDetail_2.md#key)
14
- - [optional](InputDetail_2.md#optional)
15
- - [type](InputDetail_2.md#type)
16
- - [value](InputDetail_2.md#value)
17
-
18
- ## Properties
19
-
20
- ### configuration
21
-
22
- • `Optional` **configuration**: `object`
23
-
24
- Configuration parameters for the required input.
25
-
26
- ___
27
-
28
- ### details
29
-
30
- • `Optional` **details**: [`SubInputDetail_2`](SubInputDetail_2.md)[]
31
-
32
- Input details can also be provided recursively.
33
-
34
- ___
35
-
36
- ### itemSearchUrl
37
-
38
- • `Optional` **itemSearchUrl**: `string`
39
-
40
- In case of a select, the URL from which to query the items.
41
-
42
- ___
43
-
44
- ### items
45
-
46
- • `Optional` **items**: [`Item_3`](Item_3.md)[]
47
-
48
- In case of a select, the items to choose from.
49
-
50
- ___
51
-
52
- ### key
53
-
54
- • `Optional` **key**: `string`
55
-
56
- The value to provide in the result.
57
-
58
- ___
59
-
60
- ### optional
61
-
62
- • `Optional` **optional**: `boolean`
63
-
64
- True if this input value is optional.
65
-
66
- ___
67
-
68
- ### type
69
-
70
- • `Optional` **type**: `string`
71
-
72
- The type of the required input.
73
-
74
- ___
75
-
76
- ### value
77
-
78
- • `Optional` **value**: `string`
79
-
80
- The value can be pre-filled, if available.
@@ -1,26 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / Item_3
2
-
3
- # Interface: Item\_3
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [id](Item_3.md#id)
10
- - [name](Item_3.md#name)
11
-
12
- ## Properties
13
-
14
- ### id
15
-
16
- • `Optional` **id**: `string`
17
-
18
- The value to provide in the result.
19
-
20
- ___
21
-
22
- ### name
23
-
24
- • `Optional` **name**: `string`
25
-
26
- The display name.
@@ -1,22 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / SepaPlaceHolder_2
2
-
3
- # Interface: SepaPlaceHolder\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [ibanNumber](SepaPlaceHolder_2.md#ibannumber)
10
- - [ownerName](SepaPlaceHolder_2.md#ownername)
11
-
12
- ## Properties
13
-
14
- ### ibanNumber
15
-
16
- • `Optional` **ibanNumber**: `string`
17
-
18
- ___
19
-
20
- ### ownerName
21
-
22
- • `Optional` **ownerName**: `string`
@@ -1,44 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / StyleOptions_2
2
-
3
- # Interface: StyleOptions\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [base](StyleOptions_2.md#base)
10
- - [error](StyleOptions_2.md#error)
11
- - [placeholder](StyleOptions_2.md#placeholder)
12
- - [validated](StyleOptions_2.md#validated)
13
-
14
- ## Properties
15
-
16
- ### base
17
-
18
- • `Optional` **base**: [`CssProperties_2`](CssProperties_2.md)
19
-
20
- Base styling applied to the iframe. All styling extends from this style.
21
-
22
- ___
23
-
24
- ### error
25
-
26
- • `Optional` **error**: [`CssProperties_2`](CssProperties_2.md)
27
-
28
- Styling applied when a field fails validation.
29
-
30
- ___
31
-
32
- ### placeholder
33
-
34
- • `Optional` **placeholder**: [`CssProperties_2`](CssProperties_2.md)
35
-
36
- Styling applied to the field's placeholder values.
37
-
38
- ___
39
-
40
- ### validated
41
-
42
- • `Optional` **validated**: [`CssProperties_2`](CssProperties_2.md)
43
-
44
- Styling applied once a field passes validation.
@@ -1,62 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / SubInputDetail_2
2
-
3
- # Interface: SubInputDetail\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [configuration](SubInputDetail_2.md#configuration)
10
- - [items](SubInputDetail_2.md#items)
11
- - [key](SubInputDetail_2.md#key)
12
- - [optional](SubInputDetail_2.md#optional)
13
- - [type](SubInputDetail_2.md#type)
14
- - [value](SubInputDetail_2.md#value)
15
-
16
- ## Properties
17
-
18
- ### configuration
19
-
20
- • `Optional` **configuration**: `object`
21
-
22
- Configuration parameters for the required input.
23
-
24
- ___
25
-
26
- ### items
27
-
28
- • `Optional` **items**: [`Item_3`](Item_3.md)[]
29
-
30
- In case of a select, the items to choose from.
31
-
32
- ___
33
-
34
- ### key
35
-
36
- • `Optional` **key**: `string`
37
-
38
- The value to provide in the result.
39
-
40
- ___
41
-
42
- ### optional
43
-
44
- • `Optional` **optional**: `boolean`
45
-
46
- True if this input is optional to provide.
47
-
48
- ___
49
-
50
- ### type
51
-
52
- • `Optional` **type**: `string`
53
-
54
- The type of the required input.
55
-
56
- ___
57
-
58
- ### value
59
-
60
- • `Optional` **value**: `string`
61
-
62
- The value can be pre-filled, if available.
@@ -1,15 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / WechatDataPaymentMethodState_2
2
-
3
- # Interface: WechatDataPaymentMethodState\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [paymentMethod](WechatDataPaymentMethodState_2.md#paymentmethod)
10
-
11
- ## Properties
12
-
13
- ### paymentMethod
14
-
15
- • **paymentMethod**: [`AdyenPaymentMethodState_2`](AdyenPaymentMethodState_2.md)
@@ -1,15 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / WechatState_2
2
-
3
- # Interface: WechatState\_2
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [data](WechatState_2.md#data)
10
-
11
- ## Properties
12
-
13
- ### data
14
-
15
- • **data**: [`WechatDataPaymentMethodState_2`](WechatDataPaymentMethodState_2.md)