@bigcommerce/checkout-sdk 1.675.0 → 1.675.2
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 +0 -97
- 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 +0 -3
- package/docs/interfaces/BasePaymentInitializeOptions.md +0 -10
- package/package.json +1 -1
- package/docs/interfaces/NonceGenerationError.md +0 -29
- package/docs/interfaces/SquareFormElement.md +0 -28
- package/docs/interfaces/SquarePaymentInitializeOptions.md +0 -131
package/docs/README.md
CHANGED
|
@@ -316,7 +316,6 @@
|
|
|
316
316
|
- [MonerisStylingProps](interfaces/MonerisStylingProps.md)
|
|
317
317
|
- [MutationObeserverCreator](interfaces/MutationObeserverCreator.md)
|
|
318
318
|
- [MutationObserverWindow](interfaces/MutationObserverWindow.md)
|
|
319
|
-
- [NonceGenerationError](interfaces/NonceGenerationError.md)
|
|
320
319
|
- [NonceInstrument](interfaces/NonceInstrument.md)
|
|
321
320
|
- [Option](interfaces/Option.md)
|
|
322
321
|
- [OptionsResponse](interfaces/OptionsResponse.md)
|
|
@@ -398,8 +397,6 @@
|
|
|
398
397
|
- [SignInEmailRequestBody](interfaces/SignInEmailRequestBody.md)
|
|
399
398
|
- [SignInEmailSelector](interfaces/SignInEmailSelector.md)
|
|
400
399
|
- [SpamProtectionOptions](interfaces/SpamProtectionOptions.md)
|
|
401
|
-
- [SquareFormElement](interfaces/SquareFormElement.md)
|
|
402
|
-
- [SquarePaymentInitializeOptions](interfaces/SquarePaymentInitializeOptions.md)
|
|
403
400
|
- [SquareV2PaymentInitializeOptions](interfaces/SquareV2PaymentInitializeOptions.md)
|
|
404
401
|
- [StepStyles](interfaces/StepStyles.md)
|
|
405
402
|
- [StepTracker](interfaces/StepTracker.md)
|
|
@@ -27,7 +27,6 @@ current checkout flow.
|
|
|
27
27
|
- [opy](BasePaymentInitializeOptions.md#opy)
|
|
28
28
|
- [params](BasePaymentInitializeOptions.md#params)
|
|
29
29
|
- [paypalexpress](BasePaymentInitializeOptions.md#paypalexpress)
|
|
30
|
-
- [square](BasePaymentInitializeOptions.md#square)
|
|
31
30
|
- [timeout](BasePaymentInitializeOptions.md#timeout)
|
|
32
31
|
|
|
33
32
|
## Properties
|
|
@@ -154,15 +153,6 @@ They can be omitted unless you need to support PayPal Express.
|
|
|
154
153
|
|
|
155
154
|
___
|
|
156
155
|
|
|
157
|
-
### square
|
|
158
|
-
|
|
159
|
-
• `Optional` **square**: [`SquarePaymentInitializeOptions`](SquarePaymentInitializeOptions.md)
|
|
160
|
-
|
|
161
|
-
The options that are required to initialize the Square payment method.
|
|
162
|
-
They can be omitted unless you need to support Square.
|
|
163
|
-
|
|
164
|
-
___
|
|
165
|
-
|
|
166
156
|
### timeout
|
|
167
157
|
|
|
168
158
|
• `Optional` **timeout**: `default`
|
package/package.json
CHANGED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / NonceGenerationError
|
|
2
|
-
|
|
3
|
-
# Interface: NonceGenerationError
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [field](NonceGenerationError.md#field)
|
|
10
|
-
- [message](NonceGenerationError.md#message)
|
|
11
|
-
- [type](NonceGenerationError.md#type)
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### field
|
|
16
|
-
|
|
17
|
-
• **field**: `string`
|
|
18
|
-
|
|
19
|
-
___
|
|
20
|
-
|
|
21
|
-
### message
|
|
22
|
-
|
|
23
|
-
• **message**: `string`
|
|
24
|
-
|
|
25
|
-
___
|
|
26
|
-
|
|
27
|
-
### type
|
|
28
|
-
|
|
29
|
-
• **type**: `string`
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / SquareFormElement
|
|
2
|
-
|
|
3
|
-
# Interface: SquareFormElement
|
|
4
|
-
|
|
5
|
-
Configures any form element provided by Square payment.
|
|
6
|
-
|
|
7
|
-
## Table of contents
|
|
8
|
-
|
|
9
|
-
### Properties
|
|
10
|
-
|
|
11
|
-
- [elementId](SquareFormElement.md#elementid)
|
|
12
|
-
- [placeholder](SquareFormElement.md#placeholder)
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### elementId
|
|
17
|
-
|
|
18
|
-
• **elementId**: `string`
|
|
19
|
-
|
|
20
|
-
The ID of the container which the form element should insert into.
|
|
21
|
-
|
|
22
|
-
___
|
|
23
|
-
|
|
24
|
-
### placeholder
|
|
25
|
-
|
|
26
|
-
• `Optional` **placeholder**: `string`
|
|
27
|
-
|
|
28
|
-
The placeholder text to use for the form element, if provided.
|
|
@@ -1,131 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / SquarePaymentInitializeOptions
|
|
2
|
-
|
|
3
|
-
# Interface: SquarePaymentInitializeOptions
|
|
4
|
-
|
|
5
|
-
A set of options that are required to initialize the Square payment method.
|
|
6
|
-
|
|
7
|
-
Once Square 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
|
-
<!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
|
|
13
|
-
<div id="card-number"></div>
|
|
14
|
-
<div id="card-name"></div>
|
|
15
|
-
<div id="card-expiry"></div>
|
|
16
|
-
<div id="card-code"></div>
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
```js
|
|
20
|
-
service.initializePayment({
|
|
21
|
-
methodId: 'squarev2',
|
|
22
|
-
square: {
|
|
23
|
-
cardNumber: {
|
|
24
|
-
elementId: 'card-number',
|
|
25
|
-
},
|
|
26
|
-
cvv: {
|
|
27
|
-
elementId: 'card-code',
|
|
28
|
-
},
|
|
29
|
-
expirationDate: {
|
|
30
|
-
elementId: 'card-expiry',
|
|
31
|
-
},
|
|
32
|
-
postalCode: {
|
|
33
|
-
elementId: 'card-code',
|
|
34
|
-
},
|
|
35
|
-
},
|
|
36
|
-
});
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
## Table of contents
|
|
40
|
-
|
|
41
|
-
### Properties
|
|
42
|
-
|
|
43
|
-
- [cardNumber](SquarePaymentInitializeOptions.md#cardnumber)
|
|
44
|
-
- [cvv](SquarePaymentInitializeOptions.md#cvv)
|
|
45
|
-
- [expirationDate](SquarePaymentInitializeOptions.md#expirationdate)
|
|
46
|
-
- [inputClass](SquarePaymentInitializeOptions.md#inputclass)
|
|
47
|
-
- [inputStyles](SquarePaymentInitializeOptions.md#inputstyles)
|
|
48
|
-
- [postalCode](SquarePaymentInitializeOptions.md#postalcode)
|
|
49
|
-
|
|
50
|
-
### Methods
|
|
51
|
-
|
|
52
|
-
- [onError](SquarePaymentInitializeOptions.md#onerror)
|
|
53
|
-
- [onPaymentSelect](SquarePaymentInitializeOptions.md#onpaymentselect)
|
|
54
|
-
|
|
55
|
-
## Properties
|
|
56
|
-
|
|
57
|
-
### cardNumber
|
|
58
|
-
|
|
59
|
-
• **cardNumber**: [`SquareFormElement`](SquareFormElement.md)
|
|
60
|
-
|
|
61
|
-
The location to insert the credit card number form field.
|
|
62
|
-
|
|
63
|
-
___
|
|
64
|
-
|
|
65
|
-
### cvv
|
|
66
|
-
|
|
67
|
-
• **cvv**: [`SquareFormElement`](SquareFormElement.md)
|
|
68
|
-
|
|
69
|
-
The location to insert the CVV form field.
|
|
70
|
-
|
|
71
|
-
___
|
|
72
|
-
|
|
73
|
-
### expirationDate
|
|
74
|
-
|
|
75
|
-
• **expirationDate**: [`SquareFormElement`](SquareFormElement.md)
|
|
76
|
-
|
|
77
|
-
The location to insert the expiration date form field.
|
|
78
|
-
|
|
79
|
-
___
|
|
80
|
-
|
|
81
|
-
### inputClass
|
|
82
|
-
|
|
83
|
-
• `Optional` **inputClass**: `string`
|
|
84
|
-
|
|
85
|
-
The CSS class to apply to all form fields.
|
|
86
|
-
|
|
87
|
-
___
|
|
88
|
-
|
|
89
|
-
### inputStyles
|
|
90
|
-
|
|
91
|
-
• `Optional` **inputStyles**: { [key: string]: `string`; }[]
|
|
92
|
-
|
|
93
|
-
The set of CSS styles to apply to all form fields.
|
|
94
|
-
|
|
95
|
-
___
|
|
96
|
-
|
|
97
|
-
### postalCode
|
|
98
|
-
|
|
99
|
-
• **postalCode**: [`SquareFormElement`](SquareFormElement.md)
|
|
100
|
-
|
|
101
|
-
The location to insert the postal code form field.
|
|
102
|
-
|
|
103
|
-
## Methods
|
|
104
|
-
|
|
105
|
-
### onError
|
|
106
|
-
|
|
107
|
-
▸ `Optional` **onError**(`errors?`): `void`
|
|
108
|
-
|
|
109
|
-
A callback that gets called when an error occurs in the card nonce generation
|
|
110
|
-
|
|
111
|
-
#### Parameters
|
|
112
|
-
|
|
113
|
-
| Name | Type |
|
|
114
|
-
| :------ | :------ |
|
|
115
|
-
| `errors?` | [`NonceGenerationError`](NonceGenerationError.md)[] |
|
|
116
|
-
|
|
117
|
-
#### Returns
|
|
118
|
-
|
|
119
|
-
`void`
|
|
120
|
-
|
|
121
|
-
___
|
|
122
|
-
|
|
123
|
-
### onPaymentSelect
|
|
124
|
-
|
|
125
|
-
▸ `Optional` **onPaymentSelect**(): `void`
|
|
126
|
-
|
|
127
|
-
A callback that gets called when the customer selects a payment option.
|
|
128
|
-
|
|
129
|
-
#### Returns
|
|
130
|
-
|
|
131
|
-
`void`
|