@bigcommerce/checkout-sdk 1.514.3 → 1.516.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 (11) 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 +74 -1
  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 +3 -1
  9. package/docs/interfaces/PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md +109 -0
  10. package/docs/interfaces/WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md +15 -0
  11. package/package.json +1 -1
package/docs/README.md CHANGED
@@ -311,6 +311,7 @@
311
311
  - [PayPalButtonStyleOptions](interfaces/PayPalButtonStyleOptions.md)
312
312
  - [PayPalBuyNowInitializeOptions](interfaces/PayPalBuyNowInitializeOptions.md)
313
313
  - [PayPalCommerceAcceleratedCheckoutCustomerInitializeOptions](interfaces/PayPalCommerceAcceleratedCheckoutCustomerInitializeOptions.md)
314
+ - [PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions](interfaces/PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md)
314
315
  - [PayPalCommerceAlternativeMethodsButtonOptions](interfaces/PayPalCommerceAlternativeMethodsButtonOptions.md)
315
316
  - [PayPalCommerceAlternativeMethodsPaymentOptions](interfaces/PayPalCommerceAlternativeMethodsPaymentOptions.md)
316
317
  - [PayPalCommerceButtonInitializeOptions](interfaces/PayPalCommerceButtonInitializeOptions.md)
@@ -416,6 +417,7 @@
416
417
  - [WithMollieIssuerInstrument](interfaces/WithMollieIssuerInstrument.md)
417
418
  - [WithMolliePaymentInitializeOptions](interfaces/WithMolliePaymentInitializeOptions.md)
418
419
  - [WithPayPalCommerceAcceleratedCheckoutCustomerInitializeOptions](interfaces/WithPayPalCommerceAcceleratedCheckoutCustomerInitializeOptions.md)
420
+ - [WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions](interfaces/WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md)
419
421
  - [WithPayPalCommerceAlternativeMethodsButtonInitializeOptions](interfaces/WithPayPalCommerceAlternativeMethodsButtonInitializeOptions.md)
420
422
  - [WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md)
421
423
  - [WithPayPalCommerceButtonInitializeOptions](interfaces/WithPayPalCommerceButtonInitializeOptions.md)
@@ -770,7 +772,7 @@ ___
770
772
 
771
773
  ### PaymentInitializeOptions
772
774
 
773
- Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBlueSnapDirectAPMPaymentInitializeOptions`](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreePaypalAchPaymentInitializeOptions`](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithBraintreeAcceleratedCheckoutPaymentInitializeOptions`](interfaces/WithBraintreeAcceleratedCheckoutPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithGooglePayPaymentInitializeOptions`](README.md#withgooglepaypaymentinitializeoptions) & [`WithMolliePaymentInitializeOptions`](interfaces/WithMolliePaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithPayPalCommerceRatePayPaymentInitializeOptions`](interfaces/WithPayPalCommerceRatePayPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md) & [`WithStripeV3PaymentInitializeOptions`](interfaces/WithStripeV3PaymentInitializeOptions.md)
775
+ Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBlueSnapDirectAPMPaymentInitializeOptions`](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreePaypalAchPaymentInitializeOptions`](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithBraintreeAcceleratedCheckoutPaymentInitializeOptions`](interfaces/WithBraintreeAcceleratedCheckoutPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithGooglePayPaymentInitializeOptions`](README.md#withgooglepaypaymentinitializeoptions) & [`WithMolliePaymentInitializeOptions`](interfaces/WithMolliePaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithPayPalCommerceRatePayPaymentInitializeOptions`](interfaces/WithPayPalCommerceRatePayPaymentInitializeOptions.md) & [`WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions`](interfaces/WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md) & [`WithStripeV3PaymentInitializeOptions`](interfaces/WithStripeV3PaymentInitializeOptions.md)
774
776
 
775
777
  ___
776
778
 
package/docs/interfaces/PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md ADDED
@@ -0,0 +1,109 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions
2
+
3
+ # Interface: PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions
4
+
5
+ A set of options that are required to initialize the PayPalCommerce Accelerated Checkout payment
6
+ method for presenting on the page.
7
+
8
+ Also, PayPalCommerce requires specific options to initialize PayPalCommerce Accelerated Checkout Credit Card Component
9
+ ```html
10
+ <!-- This is where the PayPalCommerce Credit Card Component will be inserted -->
11
+ <div id="container"></div>
12
+ ```
13
+ ```js
14
+ service.initializePayment({
15
+ methodId: 'paypalcommerceacceleratedcheckout',
16
+ paypalcommerceacceleratedcheckout: {
17
+ onInit: (renderPayPalComponentMethod) => renderPayPalComponentMethod('#container-id'),
18
+ onChange: (showPayPalConnectCardSelector) => showPayPalConnectCardSelector(),
19
+ styles: {
20
+ root: {
21
+ backgroundColorPrimary: 'transparent',
22
+ errorColor: '#C40B0B',
23
+ fontFamily: 'Montserrat, Helvetica, Arial, sans-serif',
24
+ },
25
+ input: {
26
+ borderRadius: '0.25rem',
27
+ borderColor: '#9E9E9E',
28
+ focusBorderColor: '#4496F6',
29
+ },
30
+ toggle: {
31
+ colorPrimary: '#0F005E',
32
+ colorSecondary: '#ffffff',
33
+ },
34
+ text: {
35
+ body: {
36
+ color: '#222222',
37
+ fontSize: '1rem',
38
+ },
39
+ caption: {
40
+ color: '#515151',
41
+ fontSize: '0.875rem',
42
+ },
43
+ },
44
+ branding: 'light',
45
+ },
46
+ },
47
+ });
48
+ ```
49
+
50
+ ## Table of contents
51
+
52
+ ### Properties
53
+
54
+ - [styles](PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md#styles)
55
+
56
+ ### Methods
57
+
58
+ - [onChange](PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md#onchange)
59
+ - [onInit](PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md#oninit)
60
+
61
+ ## Properties
62
+
63
+ ### styles
64
+
65
+ • `Optional` **styles**: `PayPalCommerceConnectStylesOption`
66
+
67
+ Is a stylisation options for customizing PayPal Connect components
68
+
69
+ Note: the styles for all PayPalCommerce Accelerated Checkout strategies should be the same,
70
+ because they will be provided to PayPal library only for the first strategy initialization
71
+ no matter what strategy was initialised first
72
+
73
+ ## Methods
74
+
75
+ ### onChange
76
+
77
+ ▸ `Optional` **onChange**(`showPayPalConnectCardSelector`): `void`
78
+
79
+ Is a callback that shows PayPal stored instruments
80
+ when get triggered
81
+
82
+ #### Parameters
83
+
84
+ | Name | Type |
85
+ | :------ | :------ |
86
+ | `showPayPalConnectCardSelector` | () => `Promise`<`undefined` \| `CardInstrument`\> |
87
+
88
+ #### Returns
89
+
90
+ `void`
91
+
92
+ ___
93
+
94
+ ### onInit
95
+
96
+ ▸ `Optional` **onInit**(`renderPayPalConnectCardComponent`): `void`
97
+
98
+ Is a callback that takes the CSS selector of a container
99
+ where the PayPal Connect form should be inserted into.
100
+
101
+ #### Parameters
102
+
103
+ | Name | Type |
104
+ | :------ | :------ |
105
+ | `renderPayPalConnectCardComponent` | (`container`: `string`) => `void` |
106
+
107
+ #### Returns
108
+
109
+ `void`
package/docs/interfaces/WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md ADDED
@@ -0,0 +1,15 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions
2
+
3
+ # Interface: WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [paypalcommerceacceleratedcheckout](WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md#paypalcommerceacceleratedcheckout)
10
+
11
+ ## Properties
12
+
13
+ ### paypalcommerceacceleratedcheckout
14
+
15
+ • `Optional` **paypalcommerceacceleratedcheckout**: [`PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions`](PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.514.3",
3
+ "version": "1.516.0",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",