@bigcommerce/checkout-sdk 1.743.1 → 1.744.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 +88 -5
- 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 +18 -7
- package/docs/interfaces/BigCommercePaymentsFastlaneShippingInitializeOptions.md +47 -0
- package/docs/interfaces/CssFontSource.md +22 -0
- package/docs/interfaces/CustomFontSource.md +65 -0
- package/docs/interfaces/ShippingInitializeOptions.md +10 -0
- package/docs/interfaces/StripeAppearanceOptions.md +24 -0
- package/docs/interfaces/StripeOCSPaymentInitializeOptions.md +16 -7
- package/docs/interfaces/StripeUPEPaymentInitializeOptions.md +1 -1
- package/package.json +1 -1
package/dist/checkout-sdk.d.ts
CHANGED
|
@@ -1132,6 +1132,26 @@ declare interface BigCommercePaymentsFastlanePaymentInitializeOptions {
|
|
|
1132
1132
|
styles?: PayPalFastlaneStylesOption;
|
|
1133
1133
|
}
|
|
1134
1134
|
|
|
1135
|
+
/**
|
|
1136
|
+
* A set of options that are required to initialize the shipping step of
|
|
1137
|
+
* checkout in order to support BigCommercePayments Fastlane.
|
|
1138
|
+
*/
|
|
1139
|
+
declare interface BigCommercePaymentsFastlaneShippingInitializeOptions {
|
|
1140
|
+
/**
|
|
1141
|
+
* Is a stylisation options for customizing BigCommercePayments Fastlane components
|
|
1142
|
+
*
|
|
1143
|
+
* Note: the styles for all BigCommercePayments Fastlane strategies should be the same,
|
|
1144
|
+
* because they will be provided to fastlane library only for the first strategy initialization
|
|
1145
|
+
* no matter what strategy was initialised first
|
|
1146
|
+
*/
|
|
1147
|
+
styles?: PayPalFastlaneStylesOption;
|
|
1148
|
+
/**
|
|
1149
|
+
* Is a callback that shows BigCommercePayments Fastlane popup with customer addresses
|
|
1150
|
+
* when get triggered
|
|
1151
|
+
*/
|
|
1152
|
+
onPayPalFastlaneAddressChange?: (showPayPalFastlaneAddressSelector: () => Promise<CustomerAddress_2 | undefined>) => void;
|
|
1153
|
+
}
|
|
1154
|
+
|
|
1135
1155
|
declare interface BigCommercePaymentsFieldsStyleOptions {
|
|
1136
1156
|
variables?: {
|
|
1137
1157
|
fontFamily?: string;
|
|
@@ -5131,6 +5151,19 @@ declare interface CreditCardPlaceHolder {
|
|
|
5131
5151
|
encryptedSecurityCode: string;
|
|
5132
5152
|
}
|
|
5133
5153
|
|
|
5154
|
+
/**
|
|
5155
|
+
* This object is used to pass custom fonts when creating an [Elements](https://stripe.com/docs/js/elements_object/create) object.
|
|
5156
|
+
*/
|
|
5157
|
+
declare interface CssFontSource {
|
|
5158
|
+
/**
|
|
5159
|
+
* A relative or absolute URL pointing to a CSS file with [@font-face](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face) definitions, for example:
|
|
5160
|
+
* `https://fonts.googleapis.com/css?family=Open+Sans`
|
|
5161
|
+
* Note that if you are using a [content security policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) (CSP),
|
|
5162
|
+
* [additional directives](https://stripe.com/docs/security#content-security-policy) may be necessary.
|
|
5163
|
+
*/
|
|
5164
|
+
cssSrc: string;
|
|
5165
|
+
}
|
|
5166
|
+
|
|
5134
5167
|
declare interface CssProperties {
|
|
5135
5168
|
background?: string;
|
|
5136
5169
|
caretColor?: string;
|
|
@@ -5188,6 +5221,37 @@ declare interface CustomError extends Error {
|
|
|
5188
5221
|
subtype?: string;
|
|
5189
5222
|
}
|
|
5190
5223
|
|
|
5224
|
+
/**
|
|
5225
|
+
* This object is used to pass custom fonts when creating an [Elements](https://stripe.com/docs/js/elements_object/create) object.
|
|
5226
|
+
*/
|
|
5227
|
+
declare interface CustomFontSource {
|
|
5228
|
+
/**
|
|
5229
|
+
* The name to give the font.
|
|
5230
|
+
*/
|
|
5231
|
+
family: string;
|
|
5232
|
+
/**
|
|
5233
|
+
* A valid [src](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src) value pointing to your
|
|
5234
|
+
* custom font file. This is usually (though not always) a link to a file with a .woff , .otf, or .svg suffix.
|
|
5235
|
+
*/
|
|
5236
|
+
src: string;
|
|
5237
|
+
/**
|
|
5238
|
+
* A valid [font-display](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display) value.
|
|
5239
|
+
*/
|
|
5240
|
+
display?: string;
|
|
5241
|
+
/**
|
|
5242
|
+
* One of normal, italic, oblique. Defaults to normal.
|
|
5243
|
+
*/
|
|
5244
|
+
style?: string;
|
|
5245
|
+
/**
|
|
5246
|
+
* A valid [unicode-range](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/unicode-range) value.
|
|
5247
|
+
*/
|
|
5248
|
+
unicodeRange?: string;
|
|
5249
|
+
/**
|
|
5250
|
+
* A valid [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight). Note that this is a string, not a number.
|
|
5251
|
+
*/
|
|
5252
|
+
weight?: string;
|
|
5253
|
+
}
|
|
5254
|
+
|
|
5191
5255
|
declare interface CustomItem {
|
|
5192
5256
|
id: string;
|
|
5193
5257
|
listPrice: number;
|
|
@@ -8308,6 +8372,11 @@ declare interface ShippingInitializeOptions<T = {}> extends ShippingRequestOptio
|
|
|
8308
8372
|
* when using PayPal Commerce Fastlane.
|
|
8309
8373
|
*/
|
|
8310
8374
|
paypalcommercefastlane?: PayPalCommerceFastlaneShippingInitializeOptions;
|
|
8375
|
+
/**
|
|
8376
|
+
* The options that are required to initialize the shipping step of checkout
|
|
8377
|
+
* when using BigCommercePayments Fastlane.
|
|
8378
|
+
*/
|
|
8379
|
+
bigcommerce_payments_fastlane?: BigCommercePaymentsFastlaneShippingInitializeOptions;
|
|
8311
8380
|
}
|
|
8312
8381
|
|
|
8313
8382
|
declare interface ShippingOption {
|
|
@@ -8574,6 +8643,18 @@ declare class StoredCardHostedFormService {
|
|
|
8574
8643
|
deinitialize(): void;
|
|
8575
8644
|
}
|
|
8576
8645
|
|
|
8646
|
+
/**
|
|
8647
|
+
* All available options are here https://stripe.com/docs/stripe-js/appearance-api#supported-css-properties
|
|
8648
|
+
*/
|
|
8649
|
+
declare interface StripeAppearanceOptions {
|
|
8650
|
+
variables?: Record<string, StripeAppearanceValues>;
|
|
8651
|
+
rules?: Record<string, Record<string, StripeAppearanceValues>>;
|
|
8652
|
+
}
|
|
8653
|
+
|
|
8654
|
+
declare type StripeAppearanceValues = string | string[] | number | undefined;
|
|
8655
|
+
|
|
8656
|
+
declare type StripeCustomFont = CssFontSource | CustomFontSource;
|
|
8657
|
+
|
|
8577
8658
|
declare interface StripeCustomerEvent extends StripeEvent {
|
|
8578
8659
|
collapsed?: boolean;
|
|
8579
8660
|
authenticated: boolean;
|
|
@@ -8773,9 +8854,13 @@ declare interface StripeOCSPaymentInitializeOptions {
|
|
|
8773
8854
|
*/
|
|
8774
8855
|
layout?: Record<string, string | number | boolean>;
|
|
8775
8856
|
/**
|
|
8776
|
-
*
|
|
8857
|
+
* Stripe OCS appearance options for styling the accordion.
|
|
8777
8858
|
*/
|
|
8778
|
-
|
|
8859
|
+
appearance?: StripeAppearanceOptions;
|
|
8860
|
+
/**
|
|
8861
|
+
* Stripe OCS fonts options for styling the accordion.
|
|
8862
|
+
*/
|
|
8863
|
+
fonts?: StripeCustomFont[];
|
|
8779
8864
|
onError?(error?: Error): void;
|
|
8780
8865
|
render(): void;
|
|
8781
8866
|
initStripeElementUpdateTrigger?(updateTriggerFn: (payload: StripeElementUpdateOptions) => void): void;
|
|
@@ -8809,8 +8894,6 @@ declare interface StripeShippingEvent extends StripeEvent {
|
|
|
8809
8894
|
};
|
|
8810
8895
|
}
|
|
8811
8896
|
|
|
8812
|
-
declare type StripeUPEAppearanceValues = string | string[] | number | undefined;
|
|
8813
|
-
|
|
8814
8897
|
declare interface StripeUPECustomerInitializeOptions {
|
|
8815
8898
|
/**
|
|
8816
8899
|
* The ID of a container which the stripe iframe should be inserted.
|
|
@@ -8874,7 +8957,7 @@ declare interface StripeUPEPaymentInitializeOptions {
|
|
|
8874
8957
|
/**
|
|
8875
8958
|
* Checkout styles from store theme
|
|
8876
8959
|
*/
|
|
8877
|
-
style?: Record<string,
|
|
8960
|
+
style?: Record<string, StripeAppearanceValues>;
|
|
8878
8961
|
onError?(error?: Error): void;
|
|
8879
8962
|
render(): void;
|
|
8880
8963
|
initStripeElementUpdateTrigger?(updateTriggerFn: (payload: StripeElementUpdateOptions) => void): void;
|