@bigcommerce/checkout-sdk 1.542.1 → 1.543.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 (12) 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 -74
  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 -3
  9. package/docs/interfaces/{PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md → PayPalCommerceFastlanePaymentInitializeOptions.md} +19 -19
  10. package/docs/interfaces/WithPayPalCommerceFastlanePaymentInitializeOptions.md +22 -0
  11. package/package.json +1 -1
  12. package/docs/interfaces/WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md +0 -15
package/docs/README.md CHANGED
@@ -373,7 +373,6 @@
373
373
  - [PasswordRequirements](interfaces/PasswordRequirements.md)
374
374
  - [PayPalButtonStyleOptions](interfaces/PayPalButtonStyleOptions.md)
375
375
  - [PayPalBuyNowInitializeOptions](interfaces/PayPalBuyNowInitializeOptions.md)
376
- - [PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions](interfaces/PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md)
377
376
  - [PayPalCommerceAlternativeMethodsButtonOptions](interfaces/PayPalCommerceAlternativeMethodsButtonOptions.md)
378
377
  - [PayPalCommerceAlternativeMethodsPaymentOptions](interfaces/PayPalCommerceAlternativeMethodsPaymentOptions.md)
379
378
  - [PayPalCommerceButtonInitializeOptions](interfaces/PayPalCommerceButtonInitializeOptions.md)
@@ -384,6 +383,7 @@
384
383
  - [PayPalCommerceCreditPaymentInitializeOptions](interfaces/PayPalCommerceCreditPaymentInitializeOptions.md)
385
384
  - [PayPalCommerceCustomerInitializeOptions](interfaces/PayPalCommerceCustomerInitializeOptions.md)
386
385
  - [PayPalCommerceFastlaneCustomerInitializeOptions](interfaces/PayPalCommerceFastlaneCustomerInitializeOptions.md)
386
+ - [PayPalCommerceFastlanePaymentInitializeOptions](interfaces/PayPalCommerceFastlanePaymentInitializeOptions.md)
387
387
  - [PayPalCommerceFieldsStyleOptions](interfaces/PayPalCommerceFieldsStyleOptions.md)
388
388
  - [PayPalCommercePaymentInitializeOptions](interfaces/PayPalCommercePaymentInitializeOptions.md)
389
389
  - [PayPalCommerceVenmoButtonInitializeOptions](interfaces/PayPalCommerceVenmoButtonInitializeOptions.md)
@@ -501,7 +501,6 @@
501
501
  - [WithIdealInstrument](interfaces/WithIdealInstrument.md)
502
502
  - [WithMollieIssuerInstrument](interfaces/WithMollieIssuerInstrument.md)
503
503
  - [WithMolliePaymentInitializeOptions](interfaces/WithMolliePaymentInitializeOptions.md)
504
- - [WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions](interfaces/WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md)
505
504
  - [WithPayPalCommerceAlternativeMethodsButtonInitializeOptions](interfaces/WithPayPalCommerceAlternativeMethodsButtonInitializeOptions.md)
506
505
  - [WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md)
507
506
  - [WithPayPalCommerceButtonInitializeOptions](interfaces/WithPayPalCommerceButtonInitializeOptions.md)
@@ -511,6 +510,7 @@
511
510
  - [WithPayPalCommerceCreditPaymentInitializeOptions](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md)
512
511
  - [WithPayPalCommerceCustomerInitializeOptions](interfaces/WithPayPalCommerceCustomerInitializeOptions.md)
513
512
  - [WithPayPalCommerceFastlaneCustomerInitializeOptions](interfaces/WithPayPalCommerceFastlaneCustomerInitializeOptions.md)
513
+ - [WithPayPalCommerceFastlanePaymentInitializeOptions](interfaces/WithPayPalCommerceFastlanePaymentInitializeOptions.md)
514
514
  - [WithPayPalCommercePaymentInitializeOptions](interfaces/WithPayPalCommercePaymentInitializeOptions.md)
515
515
  - [WithPayPalCommerceRatePayPaymentInitializeOptions](interfaces/WithPayPalCommerceRatePayPaymentInitializeOptions.md)
516
516
  - [WithPayPalCommerceVenmoButtonInitializeOptions](interfaces/WithPayPalCommerceVenmoButtonInitializeOptions.md)
@@ -903,7 +903,7 @@ ___
903
903
 
904
904
  ### PaymentInitializeOptions
905
905
 
906
- Ƭ **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) & [`WithStripeUPEPaymentInitializeOptions`](interfaces/WithStripeUPEPaymentInitializeOptions.md)
906
+ Ƭ **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) & [`WithPayPalCommerceFastlanePaymentInitializeOptions`](interfaces/WithPayPalCommerceFastlanePaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md) & [`WithStripeV3PaymentInitializeOptions`](interfaces/WithStripeV3PaymentInitializeOptions.md) & [`WithStripeUPEPaymentInitializeOptions`](interfaces/WithStripeUPEPaymentInitializeOptions.md)
907
907
 
908
908
  ___
909
909
 
package/docs/interfaces/{PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md → PayPalCommerceFastlanePaymentInitializeOptions.md} RENAMED
@@ -1,21 +1,21 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions
1
+ [@bigcommerce/checkout-sdk](../README.md) / PayPalCommerceFastlanePaymentInitializeOptions
2
2
 
3
- # Interface: PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions
3
+ # Interface: PayPalCommerceFastlanePaymentInitializeOptions
4
4
 
5
5
  A set of options that are required to initialize the PayPalCommerce Accelerated Checkout payment
6
6
  method for presenting on the page.
7
7
 
8
- Also, PayPalCommerce requires specific options to initialize PayPalCommerce Accelerated Checkout Credit Card Component
8
+ Also, PayPalCommerce requires specific options to initialize PayPal Fastlane Card Component
9
9
  ```html
10
- <!-- This is where the PayPalCommerce Credit Card Component will be inserted -->
10
+ <!-- This is where the PayPal Fastlane Card Component will be inserted -->
11
11
  <div id="container"></div>
12
12
  ```
13
13
  ```js
14
14
  service.initializePayment({
15
- methodId: 'paypalcommerceacceleratedcheckout',
16
- paypalcommerceacceleratedcheckout: {
17
- onInit: (renderPayPalComponentMethod) => renderPayPalComponentMethod('#container-id'),
18
- onChange: (showPayPalConnectCardSelector) => showPayPalConnectCardSelector(),
15
+ methodId: 'paypalcommerceacceleratedcheckout', // PayPal Fastlane has 'paypalcommerceacceleratedcheckout' method id
16
+ paypalcommercefastlane: {
17
+ onInit: (renderPayPalCardComponent) => renderPayPalCardComponent('#container-id'),
18
+ onChange: (showPayPalCardSelector) => showPayPalCardSelector(),
19
19
  styles: {
20
20
  root: {
21
21
  backgroundColorPrimary: 'transparent',
@@ -51,22 +51,22 @@ service.initializePayment({
51
51
 
52
52
  ### Properties
53
53
 
54
- - [styles](PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md#styles)
54
+ - [styles](PayPalCommerceFastlanePaymentInitializeOptions.md#styles)
55
55
 
56
56
  ### Methods
57
57
 
58
- - [onChange](PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md#onchange)
59
- - [onInit](PayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md#oninit)
58
+ - [onChange](PayPalCommerceFastlanePaymentInitializeOptions.md#onchange)
59
+ - [onInit](PayPalCommerceFastlanePaymentInitializeOptions.md#oninit)
60
60
 
61
61
  ## Properties
62
62
 
63
63
  ### styles
64
64
 
65
- • `Optional` **styles**: `PayPalCommerceConnectStylesOption`
65
+ • `Optional` **styles**: `PayPalFastlaneStylesOption`
66
66
 
67
- Is a stylisation options for customizing PayPal Connect components
67
+ Is a stylisation options for customizing PayPal Fastlane components
68
68
 
69
- Note: the styles for all PayPalCommerce Accelerated Checkout strategies should be the same,
69
+ Note: the styles for all PayPalCommerceFastlane strategies should be the same,
70
70
  because they will be provided to PayPal library only for the first strategy initialization
71
71
  no matter what strategy was initialised first
72
72
 
@@ -74,7 +74,7 @@ no matter what strategy was initialised first
74
74
 
75
75
  ### onChange
76
76
 
77
- ▸ `Optional` **onChange**(`showPayPalConnectCardSelector`): `void`
77
+ ▸ `Optional` **onChange**(`showPayPalCardSelector`): `void`
78
78
 
79
79
  Is a callback that shows PayPal stored instruments
80
80
  when get triggered
@@ -83,7 +83,7 @@ when get triggered
83
83
 
84
84
  | Name | Type |
85
85
  | :------ | :------ |
86
- | `showPayPalConnectCardSelector` | () => `Promise`<`undefined` \| `CardInstrument`\> |
86
+ | `showPayPalCardSelector` | () => `Promise`<`undefined` \| `CardInstrument`\> |
87
87
 
88
88
  #### Returns
89
89
 
@@ -93,16 +93,16 @@ ___
93
93
 
94
94
  ### onInit
95
95
 
96
- ▸ `Optional` **onInit**(`renderPayPalConnectCardComponent`): `void`
96
+ ▸ `Optional` **onInit**(`renderPayPalCardComponent`): `void`
97
97
 
98
98
  Is a callback that takes the CSS selector of a container
99
- where the PayPal Connect form should be inserted into.
99
+ where the PayPal Fastlane form should be inserted into.
100
100
 
101
101
  #### Parameters
102
102
 
103
103
  | Name | Type |
104
104
  | :------ | :------ |
105
- | `renderPayPalConnectCardComponent` | (`container`: `string`) => `void` |
105
+ | `renderPayPalCardComponent` | (`container`: `string`) => `void` |
106
106
 
107
107
  #### Returns
108
108
 
package/docs/interfaces/WithPayPalCommerceFastlanePaymentInitializeOptions.md ADDED
@@ -0,0 +1,22 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / WithPayPalCommerceFastlanePaymentInitializeOptions
2
+
3
+ # Interface: WithPayPalCommerceFastlanePaymentInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [paypalcommerceacceleratedcheckout](WithPayPalCommerceFastlanePaymentInitializeOptions.md#paypalcommerceacceleratedcheckout)
10
+ - [paypalcommercefastlane](WithPayPalCommerceFastlanePaymentInitializeOptions.md#paypalcommercefastlane)
11
+
12
+ ## Properties
13
+
14
+ ### paypalcommerceacceleratedcheckout
15
+
16
+ • `Optional` **paypalcommerceacceleratedcheckout**: [`PayPalCommerceFastlanePaymentInitializeOptions`](PayPalCommerceFastlanePaymentInitializeOptions.md)
17
+
18
+ ___
19
+
20
+ ### paypalcommercefastlane
21
+
22
+ • `Optional` **paypalcommercefastlane**: [`PayPalCommerceFastlanePaymentInitializeOptions`](PayPalCommerceFastlanePaymentInitializeOptions.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.542.1",
3
+ "version": "1.543.0",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",
package/docs/interfaces/WithPayPalCommerceAcceleratedCheckoutPaymentInitializeOptions.md DELETED
@@ -1,15 +0,0 @@
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)