@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.
Files changed (11) hide show
  1. package/dist/checkout-button.js +1 -1
  2. package/dist/checkout-button.umd.js +1 -1
  3. package/dist/checkout-sdk.d.ts +48 -1
  4. package/dist/checkout-sdk.js +1 -1
  5. package/dist/checkout-sdk.umd.js +1 -1
  6. package/dist/hosted-form-v2-iframe-host.js +1 -1
  7. package/dist/hosted-form-v2-iframe-host.umd.js +1 -1
  8. package/docs/README.md +3 -1
  9. package/docs/interfaces/StripeOCSPaymentInitializeOptions.md +138 -0
  10. package/docs/interfaces/WithStripeOCSPaymentInitializeOptions.md +22 -0
  11. package/package.json +1 -1
package/docs/README.md CHANGED
@@ -444,6 +444,7 @@
444
444
  - [StripeElementStyleVariant](interfaces/StripeElementStyleVariant.md)
445
445
  - [StripeElementUpdateOptions](interfaces/StripeElementUpdateOptions.md)
446
446
  - [StripeEvent](interfaces/StripeEvent.md)
447
+ - [StripeOCSPaymentInitializeOptions](interfaces/StripeOCSPaymentInitializeOptions.md)
447
448
  - [StripeShippingEvent](interfaces/StripeShippingEvent.md)
448
449
  - [StripeUPECustomerInitializeOptions](interfaces/StripeUPECustomerInitializeOptions.md)
449
450
  - [StripeUPEPaymentInitializeOptions](interfaces/StripeUPEPaymentInitializeOptions.md)
@@ -524,6 +525,7 @@
524
525
  - [WithPayPalCommerceVenmoCustomerInitializeOptions](interfaces/WithPayPalCommerceVenmoCustomerInitializeOptions.md)
525
526
  - [WithPayPalCommerceVenmoPaymentInitializeOptions](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md)
526
527
  - [WithSquareV2PaymentInitializeOptions](interfaces/WithSquareV2PaymentInitializeOptions.md)
528
+ - [WithStripeOCSPaymentInitializeOptions](interfaces/WithStripeOCSPaymentInitializeOptions.md)
527
529
  - [WithStripeUPECustomerInitializeOptions](interfaces/WithStripeUPECustomerInitializeOptions.md)
528
530
  - [WithStripeUPEPaymentInitializeOptions](interfaces/WithStripeUPEPaymentInitializeOptions.md)
529
531
  - [WithStripeV3PaymentInitializeOptions](interfaces/WithStripeV3PaymentInitializeOptions.md)
@@ -920,7 +922,7 @@ ___
920
922
 
921
923
  ### PaymentInitializeOptions
922
924
 
923
- Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAmazonPayV2PaymentInitializeOptions`](interfaces/WithAmazonPayV2PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBigCommercePaymentsPayPalPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsPayPalPaymentInitializeOptions.md) & [`WithBigCommercePaymentsFastlanePaymentInitializeOptions`](interfaces/WithBigCommercePaymentsFastlanePaymentInitializeOptions.md) & [`WithBigCommercePaymentsPayLaterPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsPayLaterPaymentInitializeOptions.md) & [`WithBigCommercePaymentsRatePayPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsRatePayPaymentInitializeOptions.md) & [`WithBigCommercePaymentsCreditCardsPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsCreditCardsPaymentInitializeOptions.md) & [`WithBigCommercePaymentsAlternativeMethodsPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsAlternativeMethodsPaymentInitializeOptions.md) & [`WithBigCommercePaymentsVenmoPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsVenmoPaymentInitializeOptions.md) & [`WithBlueSnapDirectAPMPaymentInitializeOptions`](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreeAchPaymentInitializeOptions`](interfaces/WithBraintreeAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithBraintreeFastlanePaymentInitializeOptions`](interfaces/WithBraintreeFastlanePaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithGooglePayPaymentInitializeOptions`](README.md#withgooglepaypaymentinitializeoptions) & [`WithMolliePaymentInitializeOptions`](interfaces/WithMolliePaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithPayPalCommerceRatePayPaymentInitializeOptions`](interfaces/WithPayPalCommerceRatePayPaymentInitializeOptions.md) & [`WithPayPalCommerceFastlanePaymentInitializeOptions`](interfaces/WithPayPalCommerceFastlanePaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md) & [`WithStripeV3PaymentInitializeOptions`](interfaces/WithStripeV3PaymentInitializeOptions.md) & [`WithStripeUPEPaymentInitializeOptions`](interfaces/WithStripeUPEPaymentInitializeOptions.md) & [`WithWorldpayAccessPaymentInitializeOptions`](interfaces/WithWorldpayAccessPaymentInitializeOptions.md)
925
+ Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAmazonPayV2PaymentInitializeOptions`](interfaces/WithAmazonPayV2PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBigCommercePaymentsPayPalPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsPayPalPaymentInitializeOptions.md) & [`WithBigCommercePaymentsFastlanePaymentInitializeOptions`](interfaces/WithBigCommercePaymentsFastlanePaymentInitializeOptions.md) & [`WithBigCommercePaymentsPayLaterPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsPayLaterPaymentInitializeOptions.md) & [`WithBigCommercePaymentsRatePayPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsRatePayPaymentInitializeOptions.md) & [`WithBigCommercePaymentsCreditCardsPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsCreditCardsPaymentInitializeOptions.md) & [`WithBigCommercePaymentsAlternativeMethodsPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsAlternativeMethodsPaymentInitializeOptions.md) & [`WithBigCommercePaymentsVenmoPaymentInitializeOptions`](interfaces/WithBigCommercePaymentsVenmoPaymentInitializeOptions.md) & [`WithBlueSnapDirectAPMPaymentInitializeOptions`](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreeAchPaymentInitializeOptions`](interfaces/WithBraintreeAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithBraintreeFastlanePaymentInitializeOptions`](interfaces/WithBraintreeFastlanePaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithGooglePayPaymentInitializeOptions`](README.md#withgooglepaypaymentinitializeoptions) & [`WithMolliePaymentInitializeOptions`](interfaces/WithMolliePaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithPayPalCommerceRatePayPaymentInitializeOptions`](interfaces/WithPayPalCommerceRatePayPaymentInitializeOptions.md) & [`WithPayPalCommerceFastlanePaymentInitializeOptions`](interfaces/WithPayPalCommerceFastlanePaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md) & [`WithStripeV3PaymentInitializeOptions`](interfaces/WithStripeV3PaymentInitializeOptions.md) & [`WithStripeUPEPaymentInitializeOptions`](interfaces/WithStripeUPEPaymentInitializeOptions.md) & [`WithStripeOCSPaymentInitializeOptions`](interfaces/WithStripeOCSPaymentInitializeOptions.md) & [`WithWorldpayAccessPaymentInitializeOptions`](interfaces/WithWorldpayAccessPaymentInitializeOptions.md)
924
926
 
925
927
  ___
926
928
 
package/docs/interfaces/StripeOCSPaymentInitializeOptions.md ADDED
@@ -0,0 +1,138 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / StripeOCSPaymentInitializeOptions
2
+
3
+ # Interface: StripeOCSPaymentInitializeOptions
4
+
5
+ A set of options that are required to initialize the Stripe payment method.
6
+
7
+ Once Stripe payment is initialized, credit card form fields, provided by the
8
+ payment provider as iframes, will be inserted into the current page. These
9
+ options provide a location and styling for each of the form fields.
10
+
11
+ ```html
12
+ <!-- This is where the credit card component will be inserted -->
13
+ <div id="container"></div>
14
+ ```
15
+
16
+ ```js
17
+ service.initializePayment({
18
+ gateway: 'stripeocs',
19
+ id: 'optimized_checkout',
20
+ stripeocs {
21
+ containerId: 'container',
22
+ },
23
+ });
24
+ ```
25
+
26
+ ## Table of contents
27
+
28
+ ### Properties
29
+
30
+ - [containerId](StripeOCSPaymentInitializeOptions.md#containerid)
31
+ - [layout](StripeOCSPaymentInitializeOptions.md#layout)
32
+ - [style](StripeOCSPaymentInitializeOptions.md#style)
33
+
34
+ ### Methods
35
+
36
+ - [handleClosePaymentMethod](StripeOCSPaymentInitializeOptions.md#handleclosepaymentmethod)
37
+ - [initStripeElementUpdateTrigger](StripeOCSPaymentInitializeOptions.md#initstripeelementupdatetrigger)
38
+ - [onError](StripeOCSPaymentInitializeOptions.md#onerror)
39
+ - [paymentMethodSelect](StripeOCSPaymentInitializeOptions.md#paymentmethodselect)
40
+ - [render](StripeOCSPaymentInitializeOptions.md#render)
41
+
42
+ ## Properties
43
+
44
+ ### containerId
45
+
46
+ • **containerId**: `string`
47
+
48
+ The location to insert the credit card number form field.
49
+
50
+ ___
51
+
52
+ ### layout
53
+
54
+ • `Optional` **layout**: `Record`<`string`, `string` \| `number` \| `boolean`\>
55
+
56
+ Stripe OCS layout options
57
+
58
+ ___
59
+
60
+ ### style
61
+
62
+ • `Optional` **style**: `Record`<`string`, [`StripeUPEAppearanceValues`](../README.md#stripeupeappearancevalues)\>
63
+
64
+ Checkout styles from store theme
65
+
66
+ ## Methods
67
+
68
+ ### handleClosePaymentMethod
69
+
70
+ ▸ `Optional` **handleClosePaymentMethod**(`collapseElement`): `void`
71
+
72
+ #### Parameters
73
+
74
+ | Name | Type |
75
+ | :------ | :------ |
76
+ | `collapseElement` | () => `void` |
77
+
78
+ #### Returns
79
+
80
+ `void`
81
+
82
+ ___
83
+
84
+ ### initStripeElementUpdateTrigger
85
+
86
+ ▸ `Optional` **initStripeElementUpdateTrigger**(`updateTriggerFn`): `void`
87
+
88
+ #### Parameters
89
+
90
+ | Name | Type |
91
+ | :------ | :------ |
92
+ | `updateTriggerFn` | (`payload`: [`StripeElementUpdateOptions`](StripeElementUpdateOptions.md)) => `void` |
93
+
94
+ #### Returns
95
+
96
+ `void`
97
+
98
+ ___
99
+
100
+ ### onError
101
+
102
+ ▸ `Optional` **onError**(`error?`): `void`
103
+
104
+ #### Parameters
105
+
106
+ | Name | Type |
107
+ | :------ | :------ |
108
+ | `error?` | `Error` |
109
+
110
+ #### Returns
111
+
112
+ `void`
113
+
114
+ ___
115
+
116
+ ### paymentMethodSelect
117
+
118
+ ▸ `Optional` **paymentMethodSelect**(`id`): `void`
119
+
120
+ #### Parameters
121
+
122
+ | Name | Type |
123
+ | :------ | :------ |
124
+ | `id` | `string` |
125
+
126
+ #### Returns
127
+
128
+ `void`
129
+
130
+ ___
131
+
132
+ ### render
133
+
134
+ ▸ **render**(): `void`
135
+
136
+ #### Returns
137
+
138
+ `void`
package/docs/interfaces/WithStripeOCSPaymentInitializeOptions.md ADDED
@@ -0,0 +1,22 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / WithStripeOCSPaymentInitializeOptions
2
+
3
+ # Interface: WithStripeOCSPaymentInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [stripeocs](WithStripeOCSPaymentInitializeOptions.md#stripeocs)
10
+ - [stripeupe](WithStripeOCSPaymentInitializeOptions.md#stripeupe)
11
+
12
+ ## Properties
13
+
14
+ ### stripeocs
15
+
16
+ • `Optional` **stripeocs**: [`StripeOCSPaymentInitializeOptions`](StripeOCSPaymentInitializeOptions.md)
17
+
18
+ ___
19
+
20
+ ### stripeupe
21
+
22
+ • `Optional` **stripeupe**: [`StripeOCSPaymentInitializeOptions`](StripeOCSPaymentInitializeOptions.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.739.0",
3
+ "version": "1.740.0",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",