@bigcommerce/checkout-sdk 1.342.0 → 1.344.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 +15 -0
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-sdk.d.ts +30 -4
- 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 +10 -1
- package/docs/interfaces/CheckoutSettings.md +1 -7
- package/docs/interfaces/CheckoutStoreSelector.md +15 -0
- package/docs/interfaces/PayPalCommerceVenmoCustomerInitializeOptions.md +40 -0
- package/docs/interfaces/WithPayPalCommerceVenmoCustomerInitializeOptions.md +15 -0
- package/package.json +1 -1
package/dist/checkout-sdk.d.ts
CHANGED
|
@@ -3306,9 +3306,7 @@ declare interface CheckoutSettings {
|
|
|
3306
3306
|
[featureName: string]: boolean;
|
|
3307
3307
|
};
|
|
3308
3308
|
checkoutBillingSameAsShippingEnabled: boolean;
|
|
3309
|
-
checkoutUserExperienceSettings:
|
|
3310
|
-
[key in UserExperienceSettingNames]: boolean;
|
|
3311
|
-
};
|
|
3309
|
+
checkoutUserExperienceSettings: UserExperienceSettings;
|
|
3312
3310
|
enableOrderComments: boolean;
|
|
3313
3311
|
enableTermsAndConditions: boolean;
|
|
3314
3312
|
googleMapsApiKey: string;
|
|
@@ -3812,6 +3810,12 @@ declare interface CheckoutStoreSelector {
|
|
|
3812
3810
|
* otherwise undefined.
|
|
3813
3811
|
*/
|
|
3814
3812
|
getPickupOptions(consignmentId: string, searchArea: SearchArea): PickupOptionResult[] | undefined;
|
|
3813
|
+
/**
|
|
3814
|
+
* Gets user experience settings.
|
|
3815
|
+
*
|
|
3816
|
+
* @returns The object of user experience settings if it is loaded, otherwise undefined.
|
|
3817
|
+
*/
|
|
3818
|
+
getUserExperienceSettings(): UserExperienceSettings | undefined;
|
|
3815
3819
|
}
|
|
3816
3820
|
|
|
3817
3821
|
/**
|
|
@@ -4474,7 +4478,7 @@ declare interface CustomerGroup {
|
|
|
4474
4478
|
name: string;
|
|
4475
4479
|
}
|
|
4476
4480
|
|
|
4477
|
-
declare type CustomerInitializeOptions = BaseCustomerInitializeOptions & WithApplePayCustomerInitializeOptions & WithPayPalCommerceCustomerInitializeOptions;
|
|
4481
|
+
declare type CustomerInitializeOptions = BaseCustomerInitializeOptions & WithApplePayCustomerInitializeOptions & WithPayPalCommerceCustomerInitializeOptions & WithPayPalCommerceVenmoCustomerInitializeOptions;
|
|
4478
4482
|
|
|
4479
4483
|
declare interface CustomerPasswordRequirements {
|
|
4480
4484
|
alpha: string;
|
|
@@ -6079,6 +6083,20 @@ declare interface PayPalCommerceVenmoButtonInitializeOptions {
|
|
|
6079
6083
|
};
|
|
6080
6084
|
}
|
|
6081
6085
|
|
|
6086
|
+
declare interface PayPalCommerceVenmoCustomerInitializeOptions {
|
|
6087
|
+
/**
|
|
6088
|
+
* The ID of a container which the checkout button should be inserted into.
|
|
6089
|
+
*/
|
|
6090
|
+
container: string;
|
|
6091
|
+
/**
|
|
6092
|
+
* A callback that gets called if unable to initialize the widget or select
|
|
6093
|
+
* one of the address options provided by the widget.
|
|
6094
|
+
*
|
|
6095
|
+
* @param error - The error object describing the failure.
|
|
6096
|
+
*/
|
|
6097
|
+
onError?(error?: Error): void;
|
|
6098
|
+
}
|
|
6099
|
+
|
|
6082
6100
|
declare interface PayPalInstrument extends BaseAccountInstrument {
|
|
6083
6101
|
method: 'paypal';
|
|
6084
6102
|
}
|
|
@@ -7500,6 +7518,10 @@ declare interface UnknownObject {
|
|
|
7500
7518
|
|
|
7501
7519
|
declare type UserExperienceSettingNames = 'walletButtonsOnTop';
|
|
7502
7520
|
|
|
7521
|
+
declare type UserExperienceSettings = {
|
|
7522
|
+
[key in UserExperienceSettingNames]: boolean;
|
|
7523
|
+
};
|
|
7524
|
+
|
|
7503
7525
|
declare interface VaultedInstrument {
|
|
7504
7526
|
instrumentId: string;
|
|
7505
7527
|
ccCvv?: string;
|
|
@@ -7622,6 +7644,10 @@ declare interface WithPayPalCommerceVenmoButtonInitializeOptions {
|
|
|
7622
7644
|
paypalcommercevenmo?: PayPalCommerceVenmoButtonInitializeOptions;
|
|
7623
7645
|
}
|
|
7624
7646
|
|
|
7647
|
+
declare interface WithPayPalCommerceVenmoCustomerInitializeOptions {
|
|
7648
|
+
paypalcommercevenmo?: PayPalCommerceVenmoCustomerInitializeOptions;
|
|
7649
|
+
}
|
|
7650
|
+
|
|
7625
7651
|
declare interface WithSquareV2PaymentInitializeOptions {
|
|
7626
7652
|
/**
|
|
7627
7653
|
* The options that are required to initialize the Square payment method.
|