chore(release): 1.397.0 [skip ci]

bigcommerce · Jul 4, 2023 · 3c0f008 · 3c0f008
1 parent 9e2dd90
commit 3c0f008
Show file tree

Hide file tree

Showing 14 changed files with 205 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.397.0](https://github.com/bigcommerce/checkout-sdk-js/compare/v1.396.1...v1.397.0) (2023-07-04)
+
+
+### Features
+
+* **checkout:** PI-168 bluesnapdirect APMs ([9e2dd90](https://github.com/bigcommerce/checkout-sdk-js/commit/9e2dd903f05716065a9716f4378292743cbb967e))
+
 ### [1.396.1](https://github.com/bigcommerce/checkout-sdk-js/compare/v1.396.0...v1.396.1) (2023-07-04)
 
 

diff --git a/dist/checkout-button.js b/dist/checkout-button.js
diff --git a/dist/checkout-button.umd.js b/dist/checkout-button.umd.js
diff --git a/dist/checkout-sdk.d.ts b/dist/checkout-sdk.d.ts
@@ -1296,6 +1296,62 @@ declare interface BlockElementStyles extends InlineElementStyles {
     borderWidth?: string;
 }
 
+/**
+ * A set of options that are required to initialize the BlueSnap V2 payment
+ * method.
+ *
+ * The payment step is done through a web page via an iframe provided by the
+ * strategy.
+ *
+ * ```html
+ * <!-- This is where the BlueSnap iframe will be inserted. It can be an in-page container or a modal -->
+ * <div id="container"></div>
+ *
+ * <!-- This is a cancellation button -->
+ * <button type="button" id="cancel-button"></button>
+ * ```
+ *
+ * ```js
+ * service.initializePayment({
+ *     methodId: 'bluesnapDirect',
+ *     bluesnapDirect: {
+ *         onLoad: (iframe) => {
+ *             document.getElementById('container')
+ *                 .appendChild(iframe);
+ *
+ *             document.getElementById('cancel-button')
+ *                 .addEventListener('click', () => {
+ *                     document.getElementById('container').innerHTML = '';
+ *                 });
+ *         },
+ *     },
+ * });
+ * ```
+ */
+declare interface BlueSnapDirectAPMInitializeOptions {
+    /**
+     * A set of CSS properties to apply to the iframe.
+     */
+    style?: BlueSnapDirectStyleProps;
+    /**
+     * A callback that gets called when the iframe is ready to be added to the
+     * current page. It is responsible for determining where the iframe should
+     * be inserted in the DOM.
+     *
+     * @param iframe - The iframe element containing the payment web page
+     * provided by the strategy.
+     * @param cancel - A function, when called, will cancel the payment
+     * process and remove the iframe.
+     */
+    onLoad(iframe: HTMLIFrameElement, cancel: () => void): void;
+}
+
+declare interface BlueSnapDirectStyleProps {
+    border?: string;
+    height?: string;
+    width?: string;
+}
+
 /**
  * A set of options that are required to initialize the BlueSnap V2 payment
  * method.
@@ -6696,7 +6752,7 @@ declare interface PayPalInstrument extends BaseAccountInstrument {
     method: 'paypal';
 }
 
-declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithAdyenV2PaymentInitializeOptions & WithAdyenV3PaymentInitializeOptions & WithApplePayPaymentInitializeOptions & WithBoltPaymentInitializeOptions & WithBraintreePaypalAchPaymentInitializeOptions & WithBraintreeLocalMethodsPaymentInitializeOptions & WithCreditCardPaymentInitializeOptions & WithPayPalCommercePaymentInitializeOptions & WithPayPalCommerceCreditPaymentInitializeOptions & WithPayPalCommerceVenmoPaymentInitializeOptions & WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions & WithPayPalCommerceCreditCardsPaymentInitializeOptions & WithSquareV2PaymentInitializeOptions;
+declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithAdyenV2PaymentInitializeOptions & WithAdyenV3PaymentInitializeOptions & WithApplePayPaymentInitializeOptions & WithBlueSnapDirectAPMPaymentInitializeOptions & WithBoltPaymentInitializeOptions & WithBraintreePaypalAchPaymentInitializeOptions & WithBraintreeLocalMethodsPaymentInitializeOptions & WithCreditCardPaymentInitializeOptions & WithPayPalCommercePaymentInitializeOptions & WithPayPalCommerceCreditPaymentInitializeOptions & WithPayPalCommerceVenmoPaymentInitializeOptions & WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions & WithPayPalCommerceCreditCardsPaymentInitializeOptions & WithSquareV2PaymentInitializeOptions;
 
 declare type PaymentInstrument = CardInstrument | AccountInstrument;
 
@@ -7848,6 +7904,14 @@ declare interface WithApplePayPaymentInitializeOptions {
     applepay?: ApplePayPaymentInitializeOptions;
 }
 
+declare interface WithBlueSnapDirectAPMPaymentInitializeOptions {
+    /**
+     * The options that are required to initialize the Apple Pay payment
+     * method. They can be omitted unless you need to support Apple Pay.
+     */
+    bluesnapdirect?: BlueSnapDirectAPMInitializeOptions;
+}
+
 declare interface WithBoltButtonInitializeOptions {
     /**
      * The options that are required to initialize the Bolt payment

diff --git a/dist/checkout-sdk.js b/dist/checkout-sdk.js
diff --git a/dist/checkout-sdk.js.map b/dist/checkout-sdk.js.map
diff --git a/dist/checkout-sdk.umd.js b/dist/checkout-sdk.umd.js
diff --git a/dist/checkout-sdk.umd.js.map b/dist/checkout-sdk.umd.js.map
diff --git a/docs/README.md b/docs/README.md
@@ -103,6 +103,8 @@
 - [BillingAddress](interfaces/BillingAddress.md)
 - [BillingAddressRequestBody](interfaces/BillingAddressRequestBody.md)
 - [BlockElementStyles](interfaces/BlockElementStyles.md)
+- [BlueSnapDirectAPMInitializeOptions](interfaces/BlueSnapDirectAPMInitializeOptions.md)
+- [BlueSnapDirectStyleProps](interfaces/BlueSnapDirectStyleProps.md)
 - [BlueSnapV2PaymentInitializeOptions](interfaces/BlueSnapV2PaymentInitializeOptions.md)
 - [BlueSnapV2StyleProps](interfaces/BlueSnapV2StyleProps.md)
 - [BodlEventsPayload](interfaces/BodlEventsPayload.md)
@@ -379,6 +381,7 @@
 - [WithApplePayButtonInitializeOptions](interfaces/WithApplePayButtonInitializeOptions.md)
 - [WithApplePayCustomerInitializeOptions](interfaces/WithApplePayCustomerInitializeOptions.md)
 - [WithApplePayPaymentInitializeOptions](interfaces/WithApplePayPaymentInitializeOptions.md)
+- [WithBlueSnapDirectAPMPaymentInitializeOptions](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md)
 - [WithBoltButtonInitializeOptions](interfaces/WithBoltButtonInitializeOptions.md)
 - [WithBoltCustomerInitializeOptions](interfaces/WithBoltCustomerInitializeOptions.md)
 - [WithBoltPaymentInitializeOptions](interfaces/WithBoltPaymentInitializeOptions.md)
@@ -726,7 +729,7 @@ ___
 
 ### PaymentInitializeOptions
 
-Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreePaypalAchPaymentInitializeOptions`](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
+Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBlueSnapDirectAPMPaymentInitializeOptions`](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreePaypalAchPaymentInitializeOptions`](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
 
 ___
 

diff --git a/docs/interfaces/BlueSnapDirectAPMInitializeOptions.md b/docs/interfaces/BlueSnapDirectAPMInitializeOptions.md
@@ -0,0 +1,73 @@
+[@bigcommerce/checkout-sdk](../README.md) / BlueSnapDirectAPMInitializeOptions
+
+# Interface: BlueSnapDirectAPMInitializeOptions
+
+A set of options that are required to initialize the BlueSnap V2 payment
+method.
+
+The payment step is done through a web page via an iframe provided by the
+strategy.
+
+```html
+<!-- This is where the BlueSnap iframe will be inserted. It can be an in-page container or a modal -->
+<div id="container"></div>
+
+<!-- This is a cancellation button -->
+<button type="button" id="cancel-button"></button>
+```
+
+```js
+service.initializePayment({
+    methodId: 'bluesnapDirect',
+    bluesnapDirect: {
+        onLoad: (iframe) => {
+            document.getElementById('container')
+                .appendChild(iframe);
+
+            document.getElementById('cancel-button')
+                .addEventListener('click', () => {
+                    document.getElementById('container').innerHTML = '';
+                });
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [style](BlueSnapDirectAPMInitializeOptions.md#style)
+
+### Methods
+
+- [onLoad](BlueSnapDirectAPMInitializeOptions.md#onload)
+
+## Properties
+
+### style
+
+• `Optional` **style**: [`BlueSnapDirectStyleProps`](BlueSnapDirectStyleProps.md)
+
+A set of CSS properties to apply to the iframe.
+
+## Methods
+
+### onLoad
+
+▸ **onLoad**(`iframe`, `cancel`): `void`
+
+A callback that gets called when the iframe is ready to be added to the
+current page. It is responsible for determining where the iframe should
+be inserted in the DOM.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `iframe` | `HTMLIFrameElement` | The iframe element containing the payment web page provided by the strategy. |
+| `cancel` | () => `void` | A function, when called, will cancel the payment process and remove the iframe. |
+
+#### Returns
+
+`void`
diff --git a/docs/interfaces/BlueSnapDirectStyleProps.md b/docs/interfaces/BlueSnapDirectStyleProps.md
@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / BlueSnapDirectStyleProps
+
+# Interface: BlueSnapDirectStyleProps
+
+## Table of contents
+
+### Properties
+
+- [border](BlueSnapDirectStyleProps.md#border)
+- [height](BlueSnapDirectStyleProps.md#height)
+- [width](BlueSnapDirectStyleProps.md#width)
+
+## Properties
+
+### border
+
+• `Optional` **border**: `string`
+
+___
+
+### height
+
+• `Optional` **height**: `string`
+
+___
+
+### width
+
+• `Optional` **width**: `string`
diff --git a/docs/interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md b/docs/interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md
@@ -0,0 +1,18 @@
+[@bigcommerce/checkout-sdk](../README.md) / WithBlueSnapDirectAPMPaymentInitializeOptions
+
+# Interface: WithBlueSnapDirectAPMPaymentInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [bluesnapdirect](WithBlueSnapDirectAPMPaymentInitializeOptions.md#bluesnapdirect)
+
+## Properties
+
+### bluesnapdirect
+
+• `Optional` **bluesnapdirect**: [`BlueSnapDirectAPMInitializeOptions`](BlueSnapDirectAPMInitializeOptions.md)
+
+The options that are required to initialize the Apple Pay payment
+method. They can be omitted unless you need to support Apple Pay.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.396.1",
+  "version": "1.397.0",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",