@bigcommerce/checkout-sdk 1.739.0 → 1.740.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 +48 -1
- package/dist/checkout-sdk.js +1 -1
- package/dist/checkout-sdk.umd.js +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 +3 -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
|
@@ -7873,7 +7873,7 @@ declare class PaymentHumanVerificationHandler {
|
|
|
7873
7873
|
private _isPaymentHumanVerificationRequest;
|
|
7874
7874
|
}
|
|
7875
7875
|
|
|
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;
|
|
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 & WithStripeOCSPaymentInitializeOptions & WithWorldpayAccessPaymentInitializeOptions;
|
|
7877
7877
|
|
|
7878
7878
|
declare type PaymentInstrument = CardInstrument | AccountInstrument;
|
|
7879
7879
|
|
|
@@ -8735,6 +8735,48 @@ declare interface StripeEvent {
|
|
|
8735
8735
|
|
|
8736
8736
|
declare type StripeEventType = StripeShippingEvent | StripeCustomerEvent;
|
|
8737
8737
|
|
|
8738
|
+
/**
|
|
8739
|
+
* A set of options that are required to initialize the Stripe payment method.
|
|
8740
|
+
*
|
|
8741
|
+
* Once Stripe payment is initialized, credit card form fields, provided by the
|
|
8742
|
+
* payment provider as iframes, will be inserted into the current page. These
|
|
8743
|
+
* options provide a location and styling for each of the form fields.
|
|
8744
|
+
*
|
|
8745
|
+
* ```html
|
|
8746
|
+
* <!-- This is where the credit card component will be inserted -->
|
|
8747
|
+
* <div id="container"></div>
|
|
8748
|
+
* ```
|
|
8749
|
+
*
|
|
8750
|
+
* ```js
|
|
8751
|
+
* service.initializePayment({
|
|
8752
|
+
* gateway: 'stripeocs',
|
|
8753
|
+
* id: 'optimized_checkout',
|
|
8754
|
+
* stripeocs {
|
|
8755
|
+
* containerId: 'container',
|
|
8756
|
+
* },
|
|
8757
|
+
* });
|
|
8758
|
+
* ```
|
|
8759
|
+
*/
|
|
8760
|
+
declare interface StripeOCSPaymentInitializeOptions {
|
|
8761
|
+
/**
|
|
8762
|
+
* The location to insert the credit card number form field.
|
|
8763
|
+
*/
|
|
8764
|
+
containerId: string;
|
|
8765
|
+
/**
|
|
8766
|
+
* Stripe OCS layout options
|
|
8767
|
+
*/
|
|
8768
|
+
layout?: Record<string, string | number | boolean>;
|
|
8769
|
+
/**
|
|
8770
|
+
* Checkout styles from store theme
|
|
8771
|
+
*/
|
|
8772
|
+
style?: Record<string, StripeUPEAppearanceValues>;
|
|
8773
|
+
onError?(error?: Error): void;
|
|
8774
|
+
render(): void;
|
|
8775
|
+
initStripeElementUpdateTrigger?(updateTriggerFn: (payload: StripeElementUpdateOptions) => void): void;
|
|
8776
|
+
paymentMethodSelect?(id: string): void;
|
|
8777
|
+
handleClosePaymentMethod?(collapseElement: () => void): void;
|
|
8778
|
+
}
|
|
8779
|
+
|
|
8738
8780
|
declare interface StripeShippingEvent extends StripeEvent {
|
|
8739
8781
|
mode?: string;
|
|
8740
8782
|
isNewAddress?: boolean;
|
|
@@ -9448,6 +9490,11 @@ declare interface WithSquareV2PaymentInitializeOptions {
|
|
|
9448
9490
|
squarev2?: SquareV2PaymentInitializeOptions;
|
|
9449
9491
|
}
|
|
9450
9492
|
|
|
9493
|
+
declare interface WithStripeOCSPaymentInitializeOptions {
|
|
9494
|
+
stripeupe?: StripeOCSPaymentInitializeOptions;
|
|
9495
|
+
stripeocs?: StripeOCSPaymentInitializeOptions;
|
|
9496
|
+
}
|
|
9497
|
+
|
|
9451
9498
|
declare interface WithStripeUPECustomerInitializeOptions {
|
|
9452
9499
|
/**
|
|
9453
9500
|
* The options that are required to initialize the customer step of checkout
|