@bigcommerce/checkout-sdk 1.739.0 → 1.741.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/dist/checkout-button.js +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-sdk.d.ts +55 -2
- 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/dist/hosted-form-v2-iframe-host.js +1 -1
- package/dist/hosted-form-v2-iframe-host.umd.js +1 -1
- package/docs/README.md +4 -1
- package/docs/enums/ExtensionType.md +22 -0
- package/docs/interfaces/Extension.md +1 -1
- package/docs/interfaces/StripeOCSPaymentInitializeOptions.md +138 -0
- package/docs/interfaces/WithStripeOCSPaymentInitializeOptions.md +22 -0
- package/package.json +1 -1
package/dist/checkout-sdk.d.ts
CHANGED
|
@@ -2939,6 +2939,7 @@ declare class CheckoutService {
|
|
|
2939
2939
|
private _subscriptionsActionCreator;
|
|
2940
2940
|
private _formFieldsActionCreator;
|
|
2941
2941
|
private _extensionActionCreator;
|
|
2942
|
+
private _workerExtensionMessenger;
|
|
2942
2943
|
private _errorTransformer;
|
|
2943
2944
|
/**
|
|
2944
2945
|
* Returns a snapshot of the current checkout state.
|
|
@@ -5597,7 +5598,7 @@ declare interface Extension {
|
|
|
5597
5598
|
name: string;
|
|
5598
5599
|
region: ExtensionRegion;
|
|
5599
5600
|
url: string;
|
|
5600
|
-
type
|
|
5601
|
+
type: ExtensionType;
|
|
5601
5602
|
}
|
|
5602
5603
|
|
|
5603
5604
|
declare interface ExtensionCommandMap {
|
|
@@ -5650,6 +5651,11 @@ declare interface ExtensionSelector {
|
|
|
5650
5651
|
isLoading(): boolean;
|
|
5651
5652
|
}
|
|
5652
5653
|
|
|
5654
|
+
declare const enum ExtensionType {
|
|
5655
|
+
Iframe = "iframe",
|
|
5656
|
+
Worker = "worker"
|
|
5657
|
+
}
|
|
5658
|
+
|
|
5653
5659
|
declare interface Fee {
|
|
5654
5660
|
id: string;
|
|
5655
5661
|
type: string;
|
|
@@ -7873,7 +7879,7 @@ declare class PaymentHumanVerificationHandler {
|
|
|
7873
7879
|
private _isPaymentHumanVerificationRequest;
|
|
7874
7880
|
}
|
|
7875
7881
|
|
|
7876
|
-
declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithAdyenV3PaymentInitializeOptions & WithAdyenV2PaymentInitializeOptions & WithAmazonPayV2PaymentInitializeOptions & WithApplePayPaymentInitializeOptions & WithBigCommercePaymentsPayPalPaymentInitializeOptions & WithBigCommercePaymentsFastlanePaymentInitializeOptions & WithBigCommercePaymentsPayLaterPaymentInitializeOptions & WithBigCommercePaymentsRatePayPaymentInitializeOptions & WithBigCommercePaymentsCreditCardsPaymentInitializeOptions & WithBigCommercePaymentsAlternativeMethodsPaymentInitializeOptions & WithBigCommercePaymentsVenmoPaymentInitializeOptions & WithBlueSnapDirectAPMPaymentInitializeOptions & WithBoltPaymentInitializeOptions & WithBraintreeAchPaymentInitializeOptions & WithBraintreeLocalMethodsPaymentInitializeOptions & WithBraintreeFastlanePaymentInitializeOptions & WithCreditCardPaymentInitializeOptions & WithGooglePayPaymentInitializeOptions & WithMolliePaymentInitializeOptions & WithPayPalCommercePaymentInitializeOptions & WithPayPalCommerceCreditPaymentInitializeOptions & WithPayPalCommerceVenmoPaymentInitializeOptions & WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions & WithPayPalCommerceCreditCardsPaymentInitializeOptions & WithPayPalCommerceRatePayPaymentInitializeOptions & WithPayPalCommerceFastlanePaymentInitializeOptions & WithSquareV2PaymentInitializeOptions & WithStripeV3PaymentInitializeOptions & WithStripeUPEPaymentInitializeOptions & WithWorldpayAccessPaymentInitializeOptions;
|
|
7882
|
+
declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithAdyenV3PaymentInitializeOptions & WithAdyenV2PaymentInitializeOptions & WithAmazonPayV2PaymentInitializeOptions & WithApplePayPaymentInitializeOptions & WithBigCommercePaymentsPayPalPaymentInitializeOptions & WithBigCommercePaymentsFastlanePaymentInitializeOptions & WithBigCommercePaymentsPayLaterPaymentInitializeOptions & WithBigCommercePaymentsRatePayPaymentInitializeOptions & WithBigCommercePaymentsCreditCardsPaymentInitializeOptions & WithBigCommercePaymentsAlternativeMethodsPaymentInitializeOptions & WithBigCommercePaymentsVenmoPaymentInitializeOptions & WithBlueSnapDirectAPMPaymentInitializeOptions & WithBoltPaymentInitializeOptions & WithBraintreeAchPaymentInitializeOptions & WithBraintreeLocalMethodsPaymentInitializeOptions & WithBraintreeFastlanePaymentInitializeOptions & WithCreditCardPaymentInitializeOptions & WithGooglePayPaymentInitializeOptions & WithMolliePaymentInitializeOptions & WithPayPalCommercePaymentInitializeOptions & WithPayPalCommerceCreditPaymentInitializeOptions & WithPayPalCommerceVenmoPaymentInitializeOptions & WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions & WithPayPalCommerceCreditCardsPaymentInitializeOptions & WithPayPalCommerceRatePayPaymentInitializeOptions & WithPayPalCommerceFastlanePaymentInitializeOptions & WithSquareV2PaymentInitializeOptions & WithStripeV3PaymentInitializeOptions & WithStripeUPEPaymentInitializeOptions & WithStripeOCSPaymentInitializeOptions & WithWorldpayAccessPaymentInitializeOptions;
|
|
7877
7883
|
|
|
7878
7884
|
declare type PaymentInstrument = CardInstrument | AccountInstrument;
|
|
7879
7885
|
|
|
@@ -8735,6 +8741,48 @@ declare interface StripeEvent {
|
|
|
8735
8741
|
|
|
8736
8742
|
declare type StripeEventType = StripeShippingEvent | StripeCustomerEvent;
|
|
8737
8743
|
|
|
8744
|
+
/**
|
|
8745
|
+
* A set of options that are required to initialize the Stripe payment method.
|
|
8746
|
+
*
|
|
8747
|
+
* Once Stripe payment is initialized, credit card form fields, provided by the
|
|
8748
|
+
* payment provider as iframes, will be inserted into the current page. These
|
|
8749
|
+
* options provide a location and styling for each of the form fields.
|
|
8750
|
+
*
|
|
8751
|
+
* ```html
|
|
8752
|
+
* <!-- This is where the credit card component will be inserted -->
|
|
8753
|
+
* <div id="container"></div>
|
|
8754
|
+
* ```
|
|
8755
|
+
*
|
|
8756
|
+
* ```js
|
|
8757
|
+
* service.initializePayment({
|
|
8758
|
+
* gateway: 'stripeocs',
|
|
8759
|
+
* id: 'optimized_checkout',
|
|
8760
|
+
* stripeocs {
|
|
8761
|
+
* containerId: 'container',
|
|
8762
|
+
* },
|
|
8763
|
+
* });
|
|
8764
|
+
* ```
|
|
8765
|
+
*/
|
|
8766
|
+
declare interface StripeOCSPaymentInitializeOptions {
|
|
8767
|
+
/**
|
|
8768
|
+
* The location to insert the credit card number form field.
|
|
8769
|
+
*/
|
|
8770
|
+
containerId: string;
|
|
8771
|
+
/**
|
|
8772
|
+
* Stripe OCS layout options
|
|
8773
|
+
*/
|
|
8774
|
+
layout?: Record<string, string | number | boolean>;
|
|
8775
|
+
/**
|
|
8776
|
+
* Checkout styles from store theme
|
|
8777
|
+
*/
|
|
8778
|
+
style?: Record<string, StripeUPEAppearanceValues>;
|
|
8779
|
+
onError?(error?: Error): void;
|
|
8780
|
+
render(): void;
|
|
8781
|
+
initStripeElementUpdateTrigger?(updateTriggerFn: (payload: StripeElementUpdateOptions) => void): void;
|
|
8782
|
+
paymentMethodSelect?(id: string): void;
|
|
8783
|
+
handleClosePaymentMethod?(collapseElement: () => void): void;
|
|
8784
|
+
}
|
|
8785
|
+
|
|
8738
8786
|
declare interface StripeShippingEvent extends StripeEvent {
|
|
8739
8787
|
mode?: string;
|
|
8740
8788
|
isNewAddress?: boolean;
|
|
@@ -9448,6 +9496,11 @@ declare interface WithSquareV2PaymentInitializeOptions {
|
|
|
9448
9496
|
squarev2?: SquareV2PaymentInitializeOptions;
|
|
9449
9497
|
}
|
|
9450
9498
|
|
|
9499
|
+
declare interface WithStripeOCSPaymentInitializeOptions {
|
|
9500
|
+
stripeupe?: StripeOCSPaymentInitializeOptions;
|
|
9501
|
+
stripeocs?: StripeOCSPaymentInitializeOptions;
|
|
9502
|
+
}
|
|
9503
|
+
|
|
9451
9504
|
declare interface WithStripeUPECustomerInitializeOptions {
|
|
9452
9505
|
/**
|
|
9453
9506
|
* The options that are required to initialize the customer step of checkout
|