@bigcommerce/checkout-sdk 1.325.0 → 1.326.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 +7 -0
- package/dist/checkout-button.d.ts +74 -1
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.js.map +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-button.umd.js.map +1 -1
- package/dist/checkout-sdk.d.ts +74 -1
- 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/docs/README.md +8 -1
- package/docs/enums/StyleButtonColor_2.md +43 -0
- package/docs/enums/StyleButtonLabel_2.md +43 -0
- package/docs/enums/StyleButtonLayout_2.md +22 -0
- package/docs/enums/StyleButtonShape_2.md +22 -0
- package/docs/interfaces/PayPalButtonStyleOptions.md +67 -0
- package/docs/interfaces/PayPalCommerceInlineButtonInitializeOptions.md +61 -0
- package/docs/interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md +15 -0
- package/package.json +1 -1
package/dist/checkout-sdk.d.ts
CHANGED
|
@@ -2239,7 +2239,7 @@ declare class CheckoutButtonErrorSelector {
|
|
|
2239
2239
|
getDeinitializeButtonError(methodId?: CheckoutButtonMethodType): Error | undefined;
|
|
2240
2240
|
}
|
|
2241
2241
|
|
|
2242
|
-
declare type CheckoutButtonInitializeOptions = BaseCheckoutButtonInitializeOptions & WithApplePayButtonInitializeOptions;
|
|
2242
|
+
declare type CheckoutButtonInitializeOptions = BaseCheckoutButtonInitializeOptions & WithApplePayButtonInitializeOptions & WithPayPalCommerceInlineButtonInitializeOptions;
|
|
2243
2243
|
|
|
2244
2244
|
declare class CheckoutButtonInitializer {
|
|
2245
2245
|
private _store;
|
|
@@ -6031,6 +6031,23 @@ declare interface PasswordRequirements {
|
|
|
6031
6031
|
error: string;
|
|
6032
6032
|
}
|
|
6033
6033
|
|
|
6034
|
+
declare interface PayPalButtonStyleOptions {
|
|
6035
|
+
layout?: StyleButtonLayout_2;
|
|
6036
|
+
color?: StyleButtonColor_2;
|
|
6037
|
+
shape?: StyleButtonShape_2;
|
|
6038
|
+
height?: number;
|
|
6039
|
+
label?: StyleButtonLabel_2;
|
|
6040
|
+
tagline?: boolean;
|
|
6041
|
+
custom?: {
|
|
6042
|
+
label?: string;
|
|
6043
|
+
css?: {
|
|
6044
|
+
background?: string;
|
|
6045
|
+
color?: string;
|
|
6046
|
+
width?: string;
|
|
6047
|
+
};
|
|
6048
|
+
};
|
|
6049
|
+
}
|
|
6050
|
+
|
|
6034
6051
|
/**
|
|
6035
6052
|
* A set of options that are required to initialize the customer step of
|
|
6036
6053
|
* checkout to support PayPalCommerce.
|
|
@@ -6053,6 +6070,32 @@ declare interface PayPalCommerceCustomerInitializeOptions {
|
|
|
6053
6070
|
onComplete?(): void;
|
|
6054
6071
|
}
|
|
6055
6072
|
|
|
6073
|
+
/**
|
|
6074
|
+
* A set of options that are required to initialize ApplePay in cart.
|
|
6075
|
+
*
|
|
6076
|
+
* When ApplePay is initialized, an ApplePay button will be inserted into the
|
|
6077
|
+
* DOM. When a customer clicks on it, it will trigger Apple sheet.
|
|
6078
|
+
*/
|
|
6079
|
+
declare interface PayPalCommerceInlineButtonInitializeOptions {
|
|
6080
|
+
/**
|
|
6081
|
+
* A class name used to add special class for container where the button will be generated in
|
|
6082
|
+
* Default: 'PaypalCommerceInlineButton'
|
|
6083
|
+
*/
|
|
6084
|
+
buttonContainerClassName?: string;
|
|
6085
|
+
/**
|
|
6086
|
+
* A set of styling options for the checkout button.
|
|
6087
|
+
*/
|
|
6088
|
+
style?: Pick<PayPalButtonStyleOptions, 'custom'>;
|
|
6089
|
+
/**
|
|
6090
|
+
* A callback that gets called when payment complete on paypal side.
|
|
6091
|
+
*/
|
|
6092
|
+
onComplete(): void;
|
|
6093
|
+
/**
|
|
6094
|
+
* A callback that gets called on any error
|
|
6095
|
+
*/
|
|
6096
|
+
onError?(): void;
|
|
6097
|
+
}
|
|
6098
|
+
|
|
6056
6099
|
declare interface PayPalInstrument extends BaseAccountInstrument {
|
|
6057
6100
|
method: 'paypal';
|
|
6058
6101
|
}
|
|
@@ -7464,6 +7507,14 @@ declare enum StyleButtonColor {
|
|
|
7464
7507
|
white = "white"
|
|
7465
7508
|
}
|
|
7466
7509
|
|
|
7510
|
+
declare enum StyleButtonColor_2 {
|
|
7511
|
+
GOLD = "gold",
|
|
7512
|
+
BLUE = "blue",
|
|
7513
|
+
SILVER = "silver",
|
|
7514
|
+
BLACK = "black",
|
|
7515
|
+
WHITE = "white"
|
|
7516
|
+
}
|
|
7517
|
+
|
|
7467
7518
|
declare enum StyleButtonLabel {
|
|
7468
7519
|
paypal = "paypal",
|
|
7469
7520
|
checkout = "checkout",
|
|
@@ -7472,16 +7523,34 @@ declare enum StyleButtonLabel {
|
|
|
7472
7523
|
installment = "installment"
|
|
7473
7524
|
}
|
|
7474
7525
|
|
|
7526
|
+
declare enum StyleButtonLabel_2 {
|
|
7527
|
+
PAYPAL = "paypal",
|
|
7528
|
+
CHECKOUT = "checkout",
|
|
7529
|
+
BUYNOW = "buynow",
|
|
7530
|
+
PAY = "pay",
|
|
7531
|
+
INSTALLMENT = "installment"
|
|
7532
|
+
}
|
|
7533
|
+
|
|
7475
7534
|
declare enum StyleButtonLayout {
|
|
7476
7535
|
vertical = "vertical",
|
|
7477
7536
|
horizontal = "horizontal"
|
|
7478
7537
|
}
|
|
7479
7538
|
|
|
7539
|
+
declare enum StyleButtonLayout_2 {
|
|
7540
|
+
VERTICAL = "vertical",
|
|
7541
|
+
HORIZONTAL = "horizontal"
|
|
7542
|
+
}
|
|
7543
|
+
|
|
7480
7544
|
declare enum StyleButtonShape {
|
|
7481
7545
|
pill = "pill",
|
|
7482
7546
|
rect = "rect"
|
|
7483
7547
|
}
|
|
7484
7548
|
|
|
7549
|
+
declare enum StyleButtonShape_2 {
|
|
7550
|
+
PILL = "pill",
|
|
7551
|
+
RECT = "rect"
|
|
7552
|
+
}
|
|
7553
|
+
|
|
7485
7554
|
declare interface StyleOptions {
|
|
7486
7555
|
/**
|
|
7487
7556
|
* Base styling applied to the iframe. All styling extends from this style.
|
|
@@ -7711,6 +7780,10 @@ declare interface WithPayPalCommerceCustomerInitializeOptions {
|
|
|
7711
7780
|
paypalcommerce?: PayPalCommerceCustomerInitializeOptions;
|
|
7712
7781
|
}
|
|
7713
7782
|
|
|
7783
|
+
declare interface WithPayPalCommerceInlineButtonInitializeOptions {
|
|
7784
|
+
paypalcommerceinline?: PayPalCommerceInlineButtonInitializeOptions;
|
|
7785
|
+
}
|
|
7786
|
+
|
|
7714
7787
|
declare interface WithSquareV2PaymentInitializeOptions {
|
|
7715
7788
|
/**
|
|
7716
7789
|
* The options that are required to initialize the Square payment method.
|