@bigcommerce/checkout-sdk 1.205.1 → 1.207.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.
- package/CHANGELOG.md +28 -0
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.js.map +1 -1
- package/dist/checkout-button.umd.js +5 -5
- package/dist/checkout-button.umd.js.map +1 -1
- package/dist/checkout-sdk.d.ts +52 -1
- package/dist/checkout-sdk.js +1 -1
- package/dist/checkout-sdk.js.map +1 -1
- package/dist/checkout-sdk.umd.js +7 -7
- package/dist/checkout-sdk.umd.js.map +1 -1
- package/dist/embedded-checkout.js +1 -1
- package/dist/embedded-checkout.umd.js +5 -5
- package/dist/embedded-checkout.umd.js.map +1 -1
- package/dist/hosted-form.umd.js +2 -2
- package/dist/hosted-form.umd.js.map +1 -1
- package/dist/internal-mappers.umd.js +1 -1
- package/dist/internal-mappers.umd.js.map +1 -1
- package/docs/README.md +2 -0
- package/docs/interfaces/adyencomponent.md +24 -0
- package/docs/interfaces/adyencomponentevents.md +16 -0
- package/docs/interfaces/adyencreditcardcomponentoptions.md +18 -0
- package/docs/interfaces/adyenv2paymentinitializeoptions.md +25 -0
- package/docs/interfaces/cardpaymentmethodstate.md +3 -3
- package/docs/interfaces/cardstate.md +14 -0
- package/docs/interfaces/cardstateerrors.md +11 -0
- package/docs/interfaces/paymentinitializeoptions.md +10 -0
- package/docs/interfaces/stripeupepaymentinitializeoptions.md +41 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -106,6 +106,7 @@
|
|
|
106
106
|
* [CardNumberElementOptions](interfaces/cardnumberelementoptions.md)
|
|
107
107
|
* [CardPaymentMethodState](interfaces/cardpaymentmethodstate.md)
|
|
108
108
|
* [CardState](interfaces/cardstate.md)
|
|
109
|
+
* [CardStateErrors](interfaces/cardstateerrors.md)
|
|
109
110
|
* [Cart](interfaces/cart.md)
|
|
110
111
|
* [ChasePayCustomerInitializeOptions](interfaces/chasepaycustomerinitializeoptions.md)
|
|
111
112
|
* [ChasePayInitializeOptions](interfaces/chasepayinitializeoptions.md)
|
|
@@ -276,6 +277,7 @@
|
|
|
276
277
|
* [StripeElementClasses](interfaces/stripeelementclasses.md)
|
|
277
278
|
* [StripeElementStyle](interfaces/stripeelementstyle.md)
|
|
278
279
|
* [StripeElementStyleVariant](interfaces/stripeelementstylevariant.md)
|
|
280
|
+
* [StripeUPEPaymentInitializeOptions](interfaces/stripeupepaymentinitializeoptions.md)
|
|
279
281
|
* [StripeV3PaymentInitializeOptions](interfaces/stripev3paymentinitializeoptions.md)
|
|
280
282
|
* [StyleOptions](interfaces/styleoptions.md)
|
|
281
283
|
* [SubInputDetail](interfaces/subinputdetail.md)
|
|
@@ -8,11 +8,35 @@
|
|
|
8
8
|
|
|
9
9
|
## Index
|
|
10
10
|
|
|
11
|
+
### Properties
|
|
12
|
+
|
|
13
|
+
* [componentRef](adyencomponent.md#optional-componentref)
|
|
14
|
+
* [props](adyencomponent.md#optional-props)
|
|
15
|
+
* [state](adyencomponent.md#optional-state)
|
|
16
|
+
|
|
11
17
|
### Methods
|
|
12
18
|
|
|
13
19
|
* [mount](adyencomponent.md#mount)
|
|
14
20
|
* [unmount](adyencomponent.md#unmount)
|
|
15
21
|
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
### `Optional` componentRef
|
|
25
|
+
|
|
26
|
+
• **componentRef**? : *undefined | object*
|
|
27
|
+
|
|
28
|
+
___
|
|
29
|
+
|
|
30
|
+
### `Optional` props
|
|
31
|
+
|
|
32
|
+
• **props**? : *undefined | object*
|
|
33
|
+
|
|
34
|
+
___
|
|
35
|
+
|
|
36
|
+
### `Optional` state
|
|
37
|
+
|
|
38
|
+
• **state**? : *[CardState](cardstate.md)*
|
|
39
|
+
|
|
16
40
|
## Methods
|
|
17
41
|
|
|
18
42
|
### mount
|
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
|
|
15
15
|
* [onChange](adyencomponentevents.md#optional-onchange)
|
|
16
16
|
* [onError](adyencomponentevents.md#optional-onerror)
|
|
17
|
+
* [onFieldValid](adyencomponentevents.md#optional-onfieldvalid)
|
|
17
18
|
|
|
18
19
|
## Methods
|
|
19
20
|
|
|
@@ -50,3 +51,18 @@ Name | Type |
|
|
|
50
51
|
`component` | [AdyenComponent](adyencomponent.md) |
|
|
51
52
|
|
|
52
53
|
**Returns:** *void*
|
|
54
|
+
|
|
55
|
+
___
|
|
56
|
+
|
|
57
|
+
### `Optional` onFieldValid
|
|
58
|
+
|
|
59
|
+
▸ **onFieldValid**(`state`: [AdyenComponentState](../README.md#adyencomponentstate), `component`: [AdyenComponent](adyencomponent.md)): *void*
|
|
60
|
+
|
|
61
|
+
**Parameters:**
|
|
62
|
+
|
|
63
|
+
Name | Type |
|
|
64
|
+
------ | ------ |
|
|
65
|
+
`state` | [AdyenComponentState](../README.md#adyencomponentstate) |
|
|
66
|
+
`component` | [AdyenComponent](adyencomponent.md) |
|
|
67
|
+
|
|
68
|
+
**Returns:** *void*
|
|
@@ -28,6 +28,7 @@
|
|
|
28
28
|
|
|
29
29
|
* [onChange](adyencreditcardcomponentoptions.md#optional-onchange)
|
|
30
30
|
* [onError](adyencreditcardcomponentoptions.md#optional-onerror)
|
|
31
|
+
* [onFieldValid](adyencreditcardcomponentoptions.md#optional-onfieldvalid)
|
|
31
32
|
|
|
32
33
|
## Properties
|
|
33
34
|
|
|
@@ -149,3 +150,20 @@ Name | Type |
|
|
|
149
150
|
`component` | [AdyenComponent](adyencomponent.md) |
|
|
150
151
|
|
|
151
152
|
**Returns:** *void*
|
|
153
|
+
|
|
154
|
+
___
|
|
155
|
+
|
|
156
|
+
### `Optional` onFieldValid
|
|
157
|
+
|
|
158
|
+
▸ **onFieldValid**(`state`: [AdyenComponentState](../README.md#adyencomponentstate), `component`: [AdyenComponent](adyencomponent.md)): *void*
|
|
159
|
+
|
|
160
|
+
*Inherited from [AdyenComponentEvents](adyencomponentevents.md).[onFieldValid](adyencomponentevents.md#optional-onfieldvalid)*
|
|
161
|
+
|
|
162
|
+
**Parameters:**
|
|
163
|
+
|
|
164
|
+
Name | Type |
|
|
165
|
+
------ | ------ |
|
|
166
|
+
`state` | [AdyenComponentState](../README.md#adyencomponentstate) |
|
|
167
|
+
`component` | [AdyenComponent](adyencomponent.md) |
|
|
168
|
+
|
|
169
|
+
**Returns:** *void*
|
|
@@ -76,9 +76,14 @@ service.initializePayment({
|
|
|
76
76
|
* [containerId](adyenv2paymentinitializeoptions.md#containerid)
|
|
77
77
|
* [hasVaultedInstruments](adyenv2paymentinitializeoptions.md#optional-hasvaultedinstruments)
|
|
78
78
|
* [options](adyenv2paymentinitializeoptions.md#optional-options)
|
|
79
|
+
* [shouldShowNumberField](adyenv2paymentinitializeoptions.md#optional-shouldshownumberfield)
|
|
79
80
|
* [threeDS2ContainerId](adyenv2paymentinitializeoptions.md#threeds2containerid)
|
|
80
81
|
* [threeDS2Options](adyenv2paymentinitializeoptions.md#threeds2options)
|
|
81
82
|
|
|
83
|
+
### Methods
|
|
84
|
+
|
|
85
|
+
* [validateCardFields](adyenv2paymentinitializeoptions.md#validatecardfields)
|
|
86
|
+
|
|
82
87
|
## Properties
|
|
83
88
|
|
|
84
89
|
### additionalActionOptions
|
|
@@ -121,6 +126,12 @@ Optional. Overwriting the default options
|
|
|
121
126
|
|
|
122
127
|
___
|
|
123
128
|
|
|
129
|
+
### `Optional` shouldShowNumberField
|
|
130
|
+
|
|
131
|
+
• **shouldShowNumberField**? : *undefined | false | true*
|
|
132
|
+
|
|
133
|
+
___
|
|
134
|
+
|
|
124
135
|
### threeDS2ContainerId
|
|
125
136
|
|
|
126
137
|
• **threeDS2ContainerId**: *string*
|
|
@@ -136,3 +147,17 @@ ___
|
|
|
136
147
|
|
|
137
148
|
**`deprecated`**
|
|
138
149
|
Use additionalActionOptions instead as this property will be removed in the future
|
|
150
|
+
|
|
151
|
+
## Methods
|
|
152
|
+
|
|
153
|
+
### validateCardFields
|
|
154
|
+
|
|
155
|
+
▸ **validateCardFields**(`componentState`: [AdyenComponentState](../README.md#adyencomponentstate)): *void*
|
|
156
|
+
|
|
157
|
+
**Parameters:**
|
|
158
|
+
|
|
159
|
+
Name | Type |
|
|
160
|
+
------ | ------ |
|
|
161
|
+
`componentState` | [AdyenComponentState](../README.md#adyencomponentstate) |
|
|
162
|
+
|
|
163
|
+
**Returns:** *void*
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
* [encryptedExpiryMonth](cardpaymentmethodstate.md#encryptedexpirymonth)
|
|
17
17
|
* [encryptedExpiryYear](cardpaymentmethodstate.md#encryptedexpiryyear)
|
|
18
18
|
* [encryptedSecurityCode](cardpaymentmethodstate.md#encryptedsecuritycode)
|
|
19
|
-
* [holderName](cardpaymentmethodstate.md#
|
|
19
|
+
* [holderName](cardpaymentmethodstate.md#holdername)
|
|
20
20
|
* [type](cardpaymentmethodstate.md#type)
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
@@ -45,9 +45,9 @@ ___
|
|
|
45
45
|
|
|
46
46
|
___
|
|
47
47
|
|
|
48
|
-
###
|
|
48
|
+
### holderName
|
|
49
49
|
|
|
50
|
-
• **holderName
|
|
50
|
+
• **holderName**: *string*
|
|
51
51
|
|
|
52
52
|
___
|
|
53
53
|
|
|
@@ -11,7 +11,9 @@
|
|
|
11
11
|
### Properties
|
|
12
12
|
|
|
13
13
|
* [data](cardstate.md#data)
|
|
14
|
+
* [errors](cardstate.md#optional-errors)
|
|
14
15
|
* [isValid](cardstate.md#optional-isvalid)
|
|
16
|
+
* [valid](cardstate.md#optional-valid)
|
|
15
17
|
|
|
16
18
|
## Properties
|
|
17
19
|
|
|
@@ -21,6 +23,18 @@
|
|
|
21
23
|
|
|
22
24
|
___
|
|
23
25
|
|
|
26
|
+
### `Optional` errors
|
|
27
|
+
|
|
28
|
+
• **errors**? : *[CardStateErrors](cardstateerrors.md)*
|
|
29
|
+
|
|
30
|
+
___
|
|
31
|
+
|
|
24
32
|
### `Optional` isValid
|
|
25
33
|
|
|
26
34
|
• **isValid**? : *undefined | false | true*
|
|
35
|
+
|
|
36
|
+
___
|
|
37
|
+
|
|
38
|
+
### `Optional` valid
|
|
39
|
+
|
|
40
|
+
• **valid**? : *undefined | object*
|
|
@@ -48,6 +48,7 @@ current checkout flow.
|
|
|
48
48
|
* [paypalcommerce](paymentinitializeoptions.md#optional-paypalcommerce)
|
|
49
49
|
* [paypalexpress](paymentinitializeoptions.md#optional-paypalexpress)
|
|
50
50
|
* [square](paymentinitializeoptions.md#optional-square)
|
|
51
|
+
* [stripeupe](paymentinitializeoptions.md#optional-stripeupe)
|
|
51
52
|
* [stripev3](paymentinitializeoptions.md#optional-stripev3)
|
|
52
53
|
* [timeout](paymentinitializeoptions.md#optional-timeout)
|
|
53
54
|
|
|
@@ -322,6 +323,15 @@ They can be omitted unless you need to support Square.
|
|
|
322
323
|
|
|
323
324
|
___
|
|
324
325
|
|
|
326
|
+
### `Optional` stripeupe
|
|
327
|
+
|
|
328
|
+
• **stripeupe**? : *[StripeUPEPaymentInitializeOptions](stripeupepaymentinitializeoptions.md)*
|
|
329
|
+
|
|
330
|
+
The options that are required to initialize the StripeUPE payment method.
|
|
331
|
+
They can be omitted unless you need to support StripeUPE.
|
|
332
|
+
|
|
333
|
+
___
|
|
334
|
+
|
|
325
335
|
### `Optional` stripev3
|
|
326
336
|
|
|
327
337
|
• **stripev3**? : *[StripeV3PaymentInitializeOptions](stripev3paymentinitializeoptions.md)*
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) › [StripeUPEPaymentInitializeOptions](stripeupepaymentinitializeoptions.md)
|
|
2
|
+
|
|
3
|
+
# Interface: StripeUPEPaymentInitializeOptions
|
|
4
|
+
|
|
5
|
+
A set of options that are required to initialize the Stripe payment method.
|
|
6
|
+
|
|
7
|
+
Once Stripe payment is initialized, credit card form fields, provided by the
|
|
8
|
+
payment provider as iframes, will be inserted into the current page. These
|
|
9
|
+
options provide a location and styling for each of the form fields.
|
|
10
|
+
|
|
11
|
+
```html
|
|
12
|
+
<!-- This is where the credit card component will be inserted -->
|
|
13
|
+
<div id="container"></div>
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
```js
|
|
17
|
+
service.initializePayment({
|
|
18
|
+
methodId: 'stripeupe',
|
|
19
|
+
stripeupe {
|
|
20
|
+
containerId: 'container',
|
|
21
|
+
},
|
|
22
|
+
});
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Hierarchy
|
|
26
|
+
|
|
27
|
+
* **StripeUPEPaymentInitializeOptions**
|
|
28
|
+
|
|
29
|
+
## Index
|
|
30
|
+
|
|
31
|
+
### Properties
|
|
32
|
+
|
|
33
|
+
* [containerId](stripeupepaymentinitializeoptions.md#containerid)
|
|
34
|
+
|
|
35
|
+
## Properties
|
|
36
|
+
|
|
37
|
+
### containerId
|
|
38
|
+
|
|
39
|
+
• **containerId**: *string*
|
|
40
|
+
|
|
41
|
+
The location to insert the credit card number form field.
|