@bigcommerce/checkout-sdk 1.383.2 → 1.384.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 (15) 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 +31 -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/dist/internal-mappers.d.ts +1 -0
  9. package/docs/README.md +3 -1
  10. package/docs/interfaces/BraintreeLocalMethods.md +76 -0
  11. package/docs/interfaces/DigitalItem.md +11 -0
  12. package/docs/interfaces/LineItem.md +7 -0
  13. package/docs/interfaces/PhysicalItem.md +11 -0
  14. package/docs/interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md +15 -0
  15. package/package.json +1 -1
package/dist/internal-mappers.d.ts CHANGED
@@ -535,6 +535,7 @@ declare interface LineItem {
535
535
  couponAmount: number;
536
536
  listPrice: number;
537
537
  salePrice: number;
538
+ retailPrice: number;
538
539
  comparisonPrice: number;
539
540
  extendedListPrice: number;
540
541
  extendedSalePrice: number;
package/docs/README.md CHANGED
@@ -123,6 +123,7 @@
123
123
  - [BraintreeFormFieldValidateEventData](interfaces/BraintreeFormFieldValidateEventData.md)
124
124
  - [BraintreeFormFieldsMap](interfaces/BraintreeFormFieldsMap.md)
125
125
  - [BraintreeFormOptions](interfaces/BraintreeFormOptions.md)
126
+ - [BraintreeLocalMethods](interfaces/BraintreeLocalMethods.md)
126
127
  - [BraintreePaymentInitializeOptions](interfaces/BraintreePaymentInitializeOptions.md)
127
128
  - [BraintreePaypalAchInitializeOptions](interfaces/BraintreePaypalAchInitializeOptions.md)
128
129
  - [BraintreePaypalButtonInitializeOptions](interfaces/BraintreePaypalButtonInitializeOptions.md)
@@ -378,6 +379,7 @@
378
379
  - [WithBoltButtonInitializeOptions](interfaces/WithBoltButtonInitializeOptions.md)
379
380
  - [WithBoltCustomerInitializeOptions](interfaces/WithBoltCustomerInitializeOptions.md)
380
381
  - [WithBoltPaymentInitializeOptions](interfaces/WithBoltPaymentInitializeOptions.md)
382
+ - [WithBraintreeLocalMethodsPaymentInitializeOptions](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md)
381
383
  - [WithBraintreePaypalAchPaymentInitializeOptions](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md)
382
384
  - [WithBraintreePaypalCustomerInitializeOptions](interfaces/WithBraintreePaypalCustomerInitializeOptions.md)
383
385
  - [WithBuyNowFeature](interfaces/WithBuyNowFeature.md)
@@ -721,7 +723,7 @@ ___
721
723
 
722
724
  ### PaymentInitializeOptions
723
725
 
724
- Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreePaypalAchPaymentInitializeOptions`](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
726
+ Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreePaypalAchPaymentInitializeOptions`](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
725
727
 
726
728
  ___
727
729
 
package/docs/interfaces/BraintreeLocalMethods.md ADDED
@@ -0,0 +1,76 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / BraintreeLocalMethods
2
+
3
+ # Interface: BraintreeLocalMethods
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [buttonText](BraintreeLocalMethods.md#buttontext)
10
+ - [container](BraintreeLocalMethods.md#container)
11
+
12
+ ### Methods
13
+
14
+ - [onError](BraintreeLocalMethods.md#onerror)
15
+ - [onRenderButton](BraintreeLocalMethods.md#onrenderbutton)
16
+ - [submitForm](BraintreeLocalMethods.md#submitform)
17
+
18
+ ## Properties
19
+
20
+ ### buttonText
21
+
22
+ • **buttonText**: `string`
23
+
24
+ Text that will be displayed on lpm button
25
+
26
+ ___
27
+
28
+ ### container
29
+
30
+ • **container**: `string`
31
+
32
+ The CSS selector of a container where the payment widget should be inserted into.
33
+
34
+ ## Methods
35
+
36
+ ### onError
37
+
38
+ ▸ **onError**(`error`): `void`
39
+
40
+ A callback for displaying error popup. This callback requires error object as parameter.
41
+
42
+ #### Parameters
43
+
44
+ | Name | Type |
45
+ | :------ | :------ |
46
+ | `error` | `unknown` |
47
+
48
+ #### Returns
49
+
50
+ `void`
51
+
52
+ ___
53
+
54
+ ### onRenderButton
55
+
56
+ ▸ `Optional` **onRenderButton**(): `void`
57
+
58
+ A callback right before render Smart Payment Button that gets called when
59
+ This callback can be used to hide the standard submit button.
60
+
61
+ #### Returns
62
+
63
+ `void`
64
+
65
+ ___
66
+
67
+ ### submitForm
68
+
69
+ ▸ `Optional` **submitForm**(): `void`
70
+
71
+ A callback for submitting payment form that gets called
72
+ when buyer approved PayPal account.
73
+
74
+ #### Returns
75
+
76
+ `void`
package/docs/interfaces/DigitalItem.md CHANGED
@@ -35,6 +35,7 @@
35
35
  - [parentId](DigitalItem.md#parentid)
36
36
  - [productId](DigitalItem.md#productid)
37
37
  - [quantity](DigitalItem.md#quantity)
38
+ - [retailPrice](DigitalItem.md#retailprice)
38
39
  - [salePrice](DigitalItem.md#saleprice)
39
40
  - [sku](DigitalItem.md#sku)
40
41
  - [socialMedia](DigitalItem.md#socialmedia)
@@ -261,6 +262,16 @@ ___
261
262
 
262
263
  ___
263
264
 
265
+ ### retailPrice
266
+
267
+ • **retailPrice**: `number`
268
+
269
+ #### Inherited from
270
+
271
+ [LineItem](LineItem.md).[retailPrice](LineItem.md#retailprice)
272
+
273
+ ___
274
+
264
275
  ### salePrice
265
276
 
266
277
  • **salePrice**: `number`
package/docs/interfaces/LineItem.md CHANGED
@@ -34,6 +34,7 @@
34
34
  - [parentId](LineItem.md#parentid)
35
35
  - [productId](LineItem.md#productid)
36
36
  - [quantity](LineItem.md#quantity)
37
+ - [retailPrice](LineItem.md#retailprice)
37
38
  - [salePrice](LineItem.md#saleprice)
38
39
  - [sku](LineItem.md#sku)
39
40
  - [socialMedia](LineItem.md#socialmedia)
@@ -162,6 +163,12 @@ ___
162
163
 
163
164
  ___
164
165
 
166
+ ### retailPrice
167
+
168
+ • **retailPrice**: `number`
169
+
170
+ ___
171
+
165
172
  ### salePrice
166
173
 
167
174
  • **salePrice**: `number`
package/docs/interfaces/PhysicalItem.md CHANGED
@@ -34,6 +34,7 @@
34
34
  - [parentId](PhysicalItem.md#parentid)
35
35
  - [productId](PhysicalItem.md#productid)
36
36
  - [quantity](PhysicalItem.md#quantity)
37
+ - [retailPrice](PhysicalItem.md#retailprice)
37
38
  - [salePrice](PhysicalItem.md#saleprice)
38
39
  - [sku](PhysicalItem.md#sku)
39
40
  - [socialMedia](PhysicalItem.md#socialmedia)
@@ -262,6 +263,16 @@ ___
262
263
 
263
264
  ___
264
265
 
266
+ ### retailPrice
267
+
268
+ • **retailPrice**: `number`
269
+
270
+ #### Inherited from
271
+
272
+ [LineItem](LineItem.md).[retailPrice](LineItem.md#retailprice)
273
+
274
+ ___
275
+
265
276
  ### salePrice
266
277
 
267
278
  • **salePrice**: `number`
package/docs/interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md ADDED
@@ -0,0 +1,15 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / WithBraintreeLocalMethodsPaymentInitializeOptions
2
+
3
+ # Interface: WithBraintreeLocalMethodsPaymentInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [braintreelocalmethods](WithBraintreeLocalMethodsPaymentInitializeOptions.md#braintreelocalmethods)
10
+
11
+ ## Properties
12
+
13
+ ### braintreelocalmethods
14
+
15
+ • `Optional` **braintreelocalmethods**: [`BraintreeLocalMethods`](BraintreeLocalMethods.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.383.2",
3
+ "version": "1.384.1",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",