@bigcommerce/checkout-sdk 1.743.1 → 1.744.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/dist/checkout-button.js +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-sdk.d.ts +88 -5
- 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 +18 -7
- package/docs/interfaces/BigCommercePaymentsFastlaneShippingInitializeOptions.md +47 -0
- package/docs/interfaces/CssFontSource.md +22 -0
- package/docs/interfaces/CustomFontSource.md +65 -0
- package/docs/interfaces/ShippingInitializeOptions.md +10 -0
- package/docs/interfaces/StripeAppearanceOptions.md +24 -0
- package/docs/interfaces/StripeOCSPaymentInitializeOptions.md +16 -7
- package/docs/interfaces/StripeUPEPaymentInitializeOptions.md +1 -1
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -105,6 +105,7 @@
|
|
|
105
105
|
- [BigCommercePaymentsCreditCardsPaymentInitializeOptions](interfaces/BigCommercePaymentsCreditCardsPaymentInitializeOptions.md)
|
|
106
106
|
- [BigCommercePaymentsFastlaneCustomerInitializeOptions](interfaces/BigCommercePaymentsFastlaneCustomerInitializeOptions.md)
|
|
107
107
|
- [BigCommercePaymentsFastlanePaymentInitializeOptions](interfaces/BigCommercePaymentsFastlanePaymentInitializeOptions.md)
|
|
108
|
+
- [BigCommercePaymentsFastlaneShippingInitializeOptions](interfaces/BigCommercePaymentsFastlaneShippingInitializeOptions.md)
|
|
108
109
|
- [BigCommercePaymentsFieldsStyleOptions](interfaces/BigCommercePaymentsFieldsStyleOptions.md)
|
|
109
110
|
- [BigCommercePaymentsPayLaterButtonInitializeOptions](interfaces/BigCommercePaymentsPayLaterButtonInitializeOptions.md)
|
|
110
111
|
- [BigCommercePaymentsPayLaterCustomerInitializeOptions](interfaces/BigCommercePaymentsPayLaterCustomerInitializeOptions.md)
|
|
@@ -222,9 +223,11 @@
|
|
|
222
223
|
- [CreditCardInstrument](interfaces/CreditCardInstrument.md)
|
|
223
224
|
- [CreditCardPaymentInitializeOptions_2](interfaces/CreditCardPaymentInitializeOptions_2.md)
|
|
224
225
|
- [CreditCardPlaceHolder](interfaces/CreditCardPlaceHolder.md)
|
|
226
|
+
- [CssFontSource](interfaces/CssFontSource.md)
|
|
225
227
|
- [CssProperties](interfaces/CssProperties.md)
|
|
226
228
|
- [Currency](interfaces/Currency.md)
|
|
227
229
|
- [CustomError](interfaces/CustomError.md)
|
|
230
|
+
- [CustomFontSource](interfaces/CustomFontSource.md)
|
|
228
231
|
- [CustomItem](interfaces/CustomItem.md)
|
|
229
232
|
- [Customer](interfaces/Customer.md)
|
|
230
233
|
- [CustomerAccountRequestBody](interfaces/CustomerAccountRequestBody.md)
|
|
@@ -438,6 +441,7 @@
|
|
|
438
441
|
- [StoredCardHostedFormBillingAddress](interfaces/StoredCardHostedFormBillingAddress.md)
|
|
439
442
|
- [StoredCardHostedFormData](interfaces/StoredCardHostedFormData.md)
|
|
440
443
|
- [StoredCardHostedFormInstrumentFields](interfaces/StoredCardHostedFormInstrumentFields.md)
|
|
444
|
+
- [StripeAppearanceOptions](interfaces/StripeAppearanceOptions.md)
|
|
441
445
|
- [StripeCustomerEvent](interfaces/StripeCustomerEvent.md)
|
|
442
446
|
- [StripeElementCSSProperties](interfaces/StripeElementCSSProperties.md)
|
|
443
447
|
- [StripeElementClasses](interfaces/StripeElementClasses.md)
|
|
@@ -589,9 +593,10 @@
|
|
|
589
593
|
- [PaymentInstrument](README.md#paymentinstrument)
|
|
590
594
|
- [PaymentProviderCustomer](README.md#paymentprovidercustomer)
|
|
591
595
|
- [ReadableCheckoutStore](README.md#readablecheckoutstore)
|
|
596
|
+
- [StripeAppearanceValues](README.md#stripeappearancevalues)
|
|
597
|
+
- [StripeCustomFont](README.md#stripecustomfont)
|
|
592
598
|
- [StripeElementOptions](README.md#stripeelementoptions)
|
|
593
599
|
- [StripeEventType](README.md#stripeeventtype)
|
|
594
|
-
- [StripeUPEAppearanceValues](README.md#stripeupeappearancevalues)
|
|
595
600
|
- [WithGooglePayButtonInitializeOptions](README.md#withgooglepaybuttoninitializeoptions)
|
|
596
601
|
- [WithGooglePayCustomerInitializeOptions](README.md#withgooglepaycustomerinitializeoptions)
|
|
597
602
|
- [WithGooglePayPaymentInitializeOptions](README.md#withgooglepaypaymentinitializeoptions)
|
|
@@ -945,21 +950,27 @@ ___
|
|
|
945
950
|
|
|
946
951
|
___
|
|
947
952
|
|
|
948
|
-
###
|
|
953
|
+
### StripeAppearanceValues
|
|
949
954
|
|
|
950
|
-
Ƭ **
|
|
955
|
+
Ƭ **StripeAppearanceValues**: `string` \| `string`[] \| `number` \| `undefined`
|
|
951
956
|
|
|
952
957
|
___
|
|
953
958
|
|
|
954
|
-
###
|
|
959
|
+
### StripeCustomFont
|
|
955
960
|
|
|
956
|
-
Ƭ **
|
|
961
|
+
Ƭ **StripeCustomFont**: [`CssFontSource`](interfaces/CssFontSource.md) \| [`CustomFontSource`](interfaces/CustomFontSource.md)
|
|
962
|
+
|
|
963
|
+
___
|
|
964
|
+
|
|
965
|
+
### StripeElementOptions
|
|
966
|
+
|
|
967
|
+
Ƭ **StripeElementOptions**: [`CardElementOptions`](interfaces/CardElementOptions.md) \| [`CardExpiryElementOptions`](interfaces/CardExpiryElementOptions.md) \| [`CardNumberElementOptions`](interfaces/CardNumberElementOptions.md) \| [`CardCvcElementOptions`](interfaces/CardCvcElementOptions.md) \| [`IdealElementOptions`](interfaces/IdealElementOptions.md) \| [`IbanElementOptions`](interfaces/IbanElementOptions.md) \| [`ZipCodeElementOptions`](interfaces/ZipCodeElementOptions.md)
|
|
957
968
|
|
|
958
969
|
___
|
|
959
970
|
|
|
960
|
-
###
|
|
971
|
+
### StripeEventType
|
|
961
972
|
|
|
962
|
-
Ƭ **
|
|
973
|
+
Ƭ **StripeEventType**: [`StripeShippingEvent`](interfaces/StripeShippingEvent.md) \| [`StripeCustomerEvent`](interfaces/StripeCustomerEvent.md)
|
|
963
974
|
|
|
964
975
|
___
|
|
965
976
|
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BigCommercePaymentsFastlaneShippingInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: BigCommercePaymentsFastlaneShippingInitializeOptions
|
|
4
|
+
|
|
5
|
+
A set of options that are required to initialize the shipping step of
|
|
6
|
+
checkout in order to support BigCommercePayments Fastlane.
|
|
7
|
+
|
|
8
|
+
## Table of contents
|
|
9
|
+
|
|
10
|
+
### Properties
|
|
11
|
+
|
|
12
|
+
- [styles](BigCommercePaymentsFastlaneShippingInitializeOptions.md#styles)
|
|
13
|
+
|
|
14
|
+
### Methods
|
|
15
|
+
|
|
16
|
+
- [onPayPalFastlaneAddressChange](BigCommercePaymentsFastlaneShippingInitializeOptions.md#onpaypalfastlaneaddresschange)
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
### styles
|
|
21
|
+
|
|
22
|
+
• `Optional` **styles**: `PayPalFastlaneStylesOption`
|
|
23
|
+
|
|
24
|
+
Is a stylisation options for customizing BigCommercePayments Fastlane components
|
|
25
|
+
|
|
26
|
+
Note: the styles for all BigCommercePayments Fastlane strategies should be the same,
|
|
27
|
+
because they will be provided to fastlane library only for the first strategy initialization
|
|
28
|
+
no matter what strategy was initialised first
|
|
29
|
+
|
|
30
|
+
## Methods
|
|
31
|
+
|
|
32
|
+
### onPayPalFastlaneAddressChange
|
|
33
|
+
|
|
34
|
+
▸ `Optional` **onPayPalFastlaneAddressChange**(`showPayPalFastlaneAddressSelector`): `void`
|
|
35
|
+
|
|
36
|
+
Is a callback that shows BigCommercePayments Fastlane popup with customer addresses
|
|
37
|
+
when get triggered
|
|
38
|
+
|
|
39
|
+
#### Parameters
|
|
40
|
+
|
|
41
|
+
| Name | Type |
|
|
42
|
+
| :------ | :------ |
|
|
43
|
+
| `showPayPalFastlaneAddressSelector` | () => `Promise`<`undefined` \| `CustomerAddress`\> |
|
|
44
|
+
|
|
45
|
+
#### Returns
|
|
46
|
+
|
|
47
|
+
`void`
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / CssFontSource
|
|
2
|
+
|
|
3
|
+
# Interface: CssFontSource
|
|
4
|
+
|
|
5
|
+
This object is used to pass custom fonts when creating an [Elements](https://stripe.com/docs/js/elements_object/create) object.
|
|
6
|
+
|
|
7
|
+
## Table of contents
|
|
8
|
+
|
|
9
|
+
### Properties
|
|
10
|
+
|
|
11
|
+
- [cssSrc](CssFontSource.md#csssrc)
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### cssSrc
|
|
16
|
+
|
|
17
|
+
• **cssSrc**: `string`
|
|
18
|
+
|
|
19
|
+
A relative or absolute URL pointing to a CSS file with [@font-face](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face) definitions, for example:
|
|
20
|
+
`https://fonts.googleapis.com/css?family=Open+Sans`
|
|
21
|
+
Note that if you are using a [content security policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) (CSP),
|
|
22
|
+
[additional directives](https://stripe.com/docs/security#content-security-policy) may be necessary.
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / CustomFontSource
|
|
2
|
+
|
|
3
|
+
# Interface: CustomFontSource
|
|
4
|
+
|
|
5
|
+
This object is used to pass custom fonts when creating an [Elements](https://stripe.com/docs/js/elements_object/create) object.
|
|
6
|
+
|
|
7
|
+
## Table of contents
|
|
8
|
+
|
|
9
|
+
### Properties
|
|
10
|
+
|
|
11
|
+
- [display](CustomFontSource.md#display)
|
|
12
|
+
- [family](CustomFontSource.md#family)
|
|
13
|
+
- [src](CustomFontSource.md#src)
|
|
14
|
+
- [style](CustomFontSource.md#style)
|
|
15
|
+
- [unicodeRange](CustomFontSource.md#unicoderange)
|
|
16
|
+
- [weight](CustomFontSource.md#weight)
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
### display
|
|
21
|
+
|
|
22
|
+
• `Optional` **display**: `string`
|
|
23
|
+
|
|
24
|
+
A valid [font-display](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display) value.
|
|
25
|
+
|
|
26
|
+
___
|
|
27
|
+
|
|
28
|
+
### family
|
|
29
|
+
|
|
30
|
+
• **family**: `string`
|
|
31
|
+
|
|
32
|
+
The name to give the font.
|
|
33
|
+
|
|
34
|
+
___
|
|
35
|
+
|
|
36
|
+
### src
|
|
37
|
+
|
|
38
|
+
• **src**: `string`
|
|
39
|
+
|
|
40
|
+
A valid [src](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src) value pointing to your
|
|
41
|
+
custom font file. This is usually (though not always) a link to a file with a .woff , .otf, or .svg suffix.
|
|
42
|
+
|
|
43
|
+
___
|
|
44
|
+
|
|
45
|
+
### style
|
|
46
|
+
|
|
47
|
+
• `Optional` **style**: `string`
|
|
48
|
+
|
|
49
|
+
One of normal, italic, oblique. Defaults to normal.
|
|
50
|
+
|
|
51
|
+
___
|
|
52
|
+
|
|
53
|
+
### unicodeRange
|
|
54
|
+
|
|
55
|
+
• `Optional` **unicodeRange**: `string`
|
|
56
|
+
|
|
57
|
+
A valid [unicode-range](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/unicode-range) value.
|
|
58
|
+
|
|
59
|
+
___
|
|
60
|
+
|
|
61
|
+
### weight
|
|
62
|
+
|
|
63
|
+
• `Optional` **weight**: `string`
|
|
64
|
+
|
|
65
|
+
A valid [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight). Note that this is a string, not a number.
|
|
@@ -28,6 +28,7 @@ step of checkout.
|
|
|
28
28
|
### Properties
|
|
29
29
|
|
|
30
30
|
- [amazonpay](ShippingInitializeOptions.md#amazonpay)
|
|
31
|
+
- [bigcommerce_payments_fastlane](ShippingInitializeOptions.md#bigcommerce_payments_fastlane)
|
|
31
32
|
- [braintreefastlane](ShippingInitializeOptions.md#braintreefastlane)
|
|
32
33
|
- [methodId](ShippingInitializeOptions.md#methodid)
|
|
33
34
|
- [params](ShippingInitializeOptions.md#params)
|
|
@@ -46,6 +47,15 @@ when using AmazonPayV2.
|
|
|
46
47
|
|
|
47
48
|
___
|
|
48
49
|
|
|
50
|
+
### bigcommerce\_payments\_fastlane
|
|
51
|
+
|
|
52
|
+
• `Optional` **bigcommerce\_payments\_fastlane**: [`BigCommercePaymentsFastlaneShippingInitializeOptions`](BigCommercePaymentsFastlaneShippingInitializeOptions.md)
|
|
53
|
+
|
|
54
|
+
The options that are required to initialize the shipping step of checkout
|
|
55
|
+
when using BigCommercePayments Fastlane.
|
|
56
|
+
|
|
57
|
+
___
|
|
58
|
+
|
|
49
59
|
### braintreefastlane
|
|
50
60
|
|
|
51
61
|
• `Optional` **braintreefastlane**: [`BraintreeFastlaneShippingInitializeOptions`](BraintreeFastlaneShippingInitializeOptions.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / StripeAppearanceOptions
|
|
2
|
+
|
|
3
|
+
# Interface: StripeAppearanceOptions
|
|
4
|
+
|
|
5
|
+
All available options are here https://stripe.com/docs/stripe-js/appearance-api#supported-css-properties
|
|
6
|
+
|
|
7
|
+
## Table of contents
|
|
8
|
+
|
|
9
|
+
### Properties
|
|
10
|
+
|
|
11
|
+
- [rules](StripeAppearanceOptions.md#rules)
|
|
12
|
+
- [variables](StripeAppearanceOptions.md#variables)
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
### rules
|
|
17
|
+
|
|
18
|
+
• `Optional` **rules**: `Record`<`string`, `Record`<`string`, [`StripeAppearanceValues`](../README.md#stripeappearancevalues)\>\>
|
|
19
|
+
|
|
20
|
+
___
|
|
21
|
+
|
|
22
|
+
### variables
|
|
23
|
+
|
|
24
|
+
• `Optional` **variables**: `Record`<`string`, [`StripeAppearanceValues`](../README.md#stripeappearancevalues)\>
|
|
@@ -27,9 +27,10 @@ service.initializePayment({
|
|
|
27
27
|
|
|
28
28
|
### Properties
|
|
29
29
|
|
|
30
|
+
- [appearance](StripeOCSPaymentInitializeOptions.md#appearance)
|
|
30
31
|
- [containerId](StripeOCSPaymentInitializeOptions.md#containerid)
|
|
32
|
+
- [fonts](StripeOCSPaymentInitializeOptions.md#fonts)
|
|
31
33
|
- [layout](StripeOCSPaymentInitializeOptions.md#layout)
|
|
32
|
-
- [style](StripeOCSPaymentInitializeOptions.md#style)
|
|
33
34
|
|
|
34
35
|
### Methods
|
|
35
36
|
|
|
@@ -41,6 +42,14 @@ service.initializePayment({
|
|
|
41
42
|
|
|
42
43
|
## Properties
|
|
43
44
|
|
|
45
|
+
### appearance
|
|
46
|
+
|
|
47
|
+
• `Optional` **appearance**: [`StripeAppearanceOptions`](StripeAppearanceOptions.md)
|
|
48
|
+
|
|
49
|
+
Stripe OCS appearance options for styling the accordion.
|
|
50
|
+
|
|
51
|
+
___
|
|
52
|
+
|
|
44
53
|
### containerId
|
|
45
54
|
|
|
46
55
|
• **containerId**: `string`
|
|
@@ -49,19 +58,19 @@ The location to insert the credit card number form field.
|
|
|
49
58
|
|
|
50
59
|
___
|
|
51
60
|
|
|
52
|
-
###
|
|
61
|
+
### fonts
|
|
53
62
|
|
|
54
|
-
• `Optional` **
|
|
63
|
+
• `Optional` **fonts**: [`StripeCustomFont`](../README.md#stripecustomfont)[]
|
|
55
64
|
|
|
56
|
-
Stripe OCS
|
|
65
|
+
Stripe OCS fonts options for styling the accordion.
|
|
57
66
|
|
|
58
67
|
___
|
|
59
68
|
|
|
60
|
-
###
|
|
69
|
+
### layout
|
|
61
70
|
|
|
62
|
-
• `Optional` **
|
|
71
|
+
• `Optional` **layout**: `Record`<`string`, `string` \| `number` \| `boolean`\>
|
|
63
72
|
|
|
64
|
-
|
|
73
|
+
Stripe OCS layout options
|
|
65
74
|
|
|
66
75
|
## Methods
|
|
67
76
|
|
|
@@ -47,7 +47,7 @@ ___
|
|
|
47
47
|
|
|
48
48
|
### style
|
|
49
49
|
|
|
50
|
-
• `Optional` **style**: `Record`<`string`, [`
|
|
50
|
+
• `Optional` **style**: `Record`<`string`, [`StripeAppearanceValues`](../README.md#stripeappearancevalues)\>
|
|
51
51
|
|
|
52
52
|
Checkout styles from store theme
|
|
53
53
|
|