@bigcommerce/checkout-sdk 1.308.4 → 1.309.0

package/docs/README.md

@@ -328,6 +328,7 @@
 - [SpamProtectionOptions](interfaces/SpamProtectionOptions.md)
 - [SquareFormElement](interfaces/SquareFormElement.md)
 - [SquarePaymentInitializeOptions](interfaces/SquarePaymentInitializeOptions.md)
+- [SquareV2PaymentInitializeOptions](interfaces/SquareV2PaymentInitializeOptions.md)
 - [StepStyles](interfaces/StepStyles.md)
 - [StepTracker](interfaces/StepTracker.md)
 - [StepTrackerConfig](interfaces/StepTrackerConfig.md)
@@ -374,6 +375,7 @@
 - [WithCheckoutcomiDealInstrument](interfaces/WithCheckoutcomiDealInstrument.md)
 - [WithDocumentInstrument](interfaces/WithDocumentInstrument.md)
 - [WithMollieIssuerInstrument](interfaces/WithMollieIssuerInstrument.md)
+- [WithSquareV2PaymentInitializeOptions](interfaces/WithSquareV2PaymentInitializeOptions.md)
 - [WorldpayAccessPaymentInitializeOptions](interfaces/WorldpayAccessPaymentInitializeOptions.md)
 - [ZipCodeElementOptions](interfaces/ZipCodeElementOptions.md)
 
@@ -665,7 +667,7 @@ ___
 
 ### PaymentInitializeOptions
 
-Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md)
+Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
 
 ___
 

package/docs/interfaces/SquareV2PaymentInitializeOptions.md

@@ -0,0 +1,90 @@
+[@bigcommerce/checkout-sdk](../README.md) / SquareV2PaymentInitializeOptions
+
+# Interface: SquareV2PaymentInitializeOptions
+
+A set of options that are required to initialize the Square payment method.
+
+Once Square payment is initialized, an iframed payment element will be
+inserted into the current page. These options provide a location, styling,
+and a callback function that advises when it's safe to pay.
+
+**`example`**
+
+```html
+<!-- These container is where the hosted (iframed) payment method element will be inserted -->
+<div id="card-payment"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'squarev2',
+    squarev2: {
+        containerId: 'card-payment',
+        style: {
+            input: {
+                backgroundColor: '#F7F8F9',
+                color: '#373F4A',
+                fontFamily: 'Helvetica Neue',
+                fontSize: '16px',
+                fontWeight: 'normal'
+            }
+        },
+        onValidationChange: (isReadyToPay: boolean) => {
+            if (isReadyToPay) {
+                // Show or hide some component or message...
+            }
+        }
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [containerId](SquareV2PaymentInitializeOptions.md#containerid)
+- [style](SquareV2PaymentInitializeOptions.md#style)
+
+### Methods
+
+- [onValidationChange](SquareV2PaymentInitializeOptions.md#onvalidationchange)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The ID of a container which the payment widget should insert into.
+
+___
+
+### style
+
+• `Optional` **style**: `CardClassSelectors`
+
+A map of .css classes and values that customize the style of the
+input fields from the card element.
+
+For more information about applying custom styles to the card form, see
+the available [CardClassSelectors](https://developer.squareup.com/reference/sdks/web/payments/objects/CardClassSelectors)
+for styling.
+
+## Methods
+
+### onValidationChange
+
+▸ `Optional` **onValidationChange**(`isReadyToPay`): `void`
+
+A callback that gets called when the validity of the
+payment component changes.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `isReadyToPay` | `boolean` |
+
+#### Returns
+
+`void`

package/docs/interfaces/WithSquareV2PaymentInitializeOptions.md

@@ -0,0 +1,18 @@
+[@bigcommerce/checkout-sdk](../README.md) / WithSquareV2PaymentInitializeOptions
+
+# Interface: WithSquareV2PaymentInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [squarev2](WithSquareV2PaymentInitializeOptions.md#squarev2)
+
+## Properties
+
+### squarev2
+
+• `Optional` **squarev2**: [`SquareV2PaymentInitializeOptions`](SquareV2PaymentInitializeOptions.md)
+
+The options that are required to initialize the Square payment method.
+They can be omitted unless you need to support Square.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.308.4",
+  "version": "1.309.0",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",
@@ -84,6 +84,7 @@
     "@nrwl/jest": "^13.10.3",
     "@nrwl/nx-plugin": "^13.10.3",
     "@nrwl/workspace": "^13.10.3",
+    "@square/web-payments-sdk-types": "^1.44.1",
     "@types/applepayjs": "^3.0.2",
     "@types/glob": "^7.2.0",
     "@types/grecaptcha": "^2.0.36",