chore(release): 1.401.0 [skip ci]

bigcommerce · Jul 16, 2023 · 5c5e2e5 · 5c5e2e5
1 parent b43adec
commit 5c5e2e5
Show file tree

Hide file tree

Showing 18 changed files with 251 additions and 14 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.401.0](https://github.com/bigcommerce/checkout-sdk-js/compare/v1.400.0...v1.401.0) (2023-07-16)
+
+
+### Features
+
+* **checkout:** CHECKOUT-7538 Introduce extension messenger and command handler ([#2050](https://github.com/bigcommerce/checkout-sdk-js/issues/2050)) ([b43adec](https://github.com/bigcommerce/checkout-sdk-js/commit/b43adecf32105a6a7bf9451e4c80fd0beb77eae2))
+
 ## [1.400.0](https://github.com/bigcommerce/checkout-sdk-js/compare/v1.399.2...v1.400.0) (2023-07-13)
 
 

diff --git a/dist/checkout-button.js b/dist/checkout-button.js
diff --git a/dist/checkout-button.js.map b/dist/checkout-button.js.map
diff --git a/dist/checkout-button.umd.js b/dist/checkout-button.umd.js
diff --git a/dist/checkout-button.umd.js.map b/dist/checkout-button.umd.js.map
diff --git a/dist/checkout-sdk.d.ts b/dist/checkout-sdk.d.ts
@@ -2450,6 +2450,7 @@ declare interface CheckoutSelectors {
  */
 declare class CheckoutService {
     private _store;
+    private _extensionMessenger;
     private _billingAddressActionCreator;
     private _checkoutActionCreator;
     private _configActionCreator;
@@ -3435,11 +3436,21 @@ declare class CheckoutService {
      * Currently, only one extension is allowed per region.
      *
      * @alpha
-     * @param container The ID of a container which the extension should be inserted.
-     * @param region The name of an area where the extension should be presented.
+     * @param container - The ID of a container which the extension should be inserted.
+     * @param region - The name of an area where the extension should be presented.
      * @returns A promise that resolves to the current state.
      */
     renderExtension(container: string, region: ExtensionRegion): Promise<CheckoutSelectors>;
+    /**
+     * Manages the command handler for an extension.
+     *
+     * @alpha
+     * @param extensionId - The ID of the extension sending the command.
+     * @param command - The command to be handled.
+     * @param handler - The handler function for the extension command.
+     * @returns A function that, when called, will deregister the command handler.
+     */
+    listenExtensionCommand(extensionId: string, command: ExtensionCommand, handler: ExtensionCommandHandler): () => void;
     /**
      * Dispatches an action through the data store and returns the current state
      * once the action is dispatched.
@@ -4971,7 +4982,17 @@ declare interface Extension {
     url: string;
 }
 
-declare enum ExtensionRegion {
+declare const enum ExtensionCommand {
+    ReloadCheckout = "RELOAD_CHECKOUT",
+    ShowLoadingIndicator = "SHOW_LOADING_INDICATOR",
+    SetIframeStyle = "SET_IFRAME_STYLE"
+}
+
+declare type ExtensionCommandHandler = (data: ExtensionOriginEvent) => void;
+
+declare type ExtensionOriginEvent = ReloadCheckoutEvent | ShowLoadingIndicatorEvent | SetIframeStylePayload;
+
+declare const enum ExtensionRegion {
     ShippingShippingAddressFormBefore = "shipping.shippingAddressForm.before",
     ShippingShippingAddressFormAfter = "shipping.shippingAddressForm.after"
 }
@@ -6953,6 +6974,13 @@ declare interface Region {
     name: string;
 }
 
+declare interface ReloadCheckoutEvent {
+    type: ExtensionCommand.ReloadCheckout;
+    payload: {
+        extensionId: string;
+    };
+}
+
 /**
  * Throw this error if we are unable to make a request to the server. It wraps
  * any server response into a JS error object.
@@ -7007,6 +7035,16 @@ declare interface SepaPlaceHolder_2 {
     ibanNumber?: string;
 }
 
+declare interface SetIframeStylePayload {
+    type: ExtensionCommand.ReloadCheckout;
+    payload: {
+        extensionId: string;
+        style: {
+            [key: string]: string | number | null;
+        };
+    };
+}
+
 /**
  * A set of options that are required to initialize the shipping step of the
  * current checkout flow.
@@ -7065,6 +7103,14 @@ declare interface ShopperCurrency extends StoreCurrency {
     isTransactional: boolean;
 }
 
+declare interface ShowLoadingIndicatorEvent {
+    type: ExtensionCommand.ReloadCheckout;
+    payload: {
+        extensionId: string;
+        show: boolean;
+    };
+}
+
 declare interface SignInEmail {
     sent_email: string;
     expiry: number;

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
@@ -20,6 +20,7 @@
 - [CheckoutButtonMethodType](enums/CheckoutButtonMethodType.md)
 - [CheckoutIncludes](enums/CheckoutIncludes.md)
 - [EmbeddedCheckoutEventType](enums/EmbeddedCheckoutEventType.md)
+- [ExtensionCommand](enums/ExtensionCommand.md)
 - [ExtensionRegion](enums/ExtensionRegion.md)
 - [HostedFieldType](enums/HostedFieldType.md)
 - [HostedInputEventType](enums/HostedInputEventType.md)
@@ -325,15 +326,18 @@
 - [Promotion](interfaces/Promotion.md)
 - [Radius](interfaces/Radius.md)
 - [Region](interfaces/Region.md)
+- [ReloadCheckoutEvent](interfaces/ReloadCheckoutEvent.md)
 - [RequestOptions](interfaces/RequestOptions.md)
 - [SearchArea](interfaces/SearchArea.md)
 - [SepaPlaceHolder](interfaces/SepaPlaceHolder.md)
 - [SepaPlaceHolder_2](interfaces/SepaPlaceHolder_2.md)
+- [SetIframeStylePayload](interfaces/SetIframeStylePayload.md)
 - [ShippingInitializeOptions](interfaces/ShippingInitializeOptions.md)
 - [ShippingOption](interfaces/ShippingOption.md)
 - [ShippingRequestOptions](interfaces/ShippingRequestOptions.md)
 - [ShopperConfig](interfaces/ShopperConfig.md)
 - [ShopperCurrency](interfaces/ShopperCurrency.md)
+- [ShowLoadingIndicatorEvent](interfaces/ShowLoadingIndicatorEvent.md)
 - [SignInEmail](interfaces/SignInEmail.md)
 - [SignInEmailRequestBody](interfaces/SignInEmailRequestBody.md)
 - [SpamProtectionOptions](interfaces/SpamProtectionOptions.md)
@@ -434,6 +438,8 @@
 - [ConsignmentsRequestBody](README.md#consignmentsrequestbody)
 - [CustomerAddressRequestBody](README.md#customeraddressrequestbody)
 - [CustomerInitializeOptions](README.md#customerinitializeoptions)
+- [ExtensionCommandHandler](README.md#extensioncommandhandler)
+- [ExtensionOriginEvent](README.md#extensionoriginevent)
 - [FlashMessageType](README.md#flashmessagetype)
 - [FormFieldFieldType](README.md#formfieldfieldtype)
 - [FormFieldType](README.md#formfieldtype)
@@ -600,6 +606,32 @@ ___
 
 ___
 
+### ExtensionCommandHandler
+
+Ƭ **ExtensionCommandHandler**: (`data`: [`ExtensionOriginEvent`](README.md#extensionoriginevent)) => `void`
+
+#### Type declaration
+
+▸ (`data`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`ExtensionOriginEvent`](README.md#extensionoriginevent) |
+
+##### Returns
+
+`void`
+
+___
+
+### ExtensionOriginEvent
+
+Ƭ **ExtensionOriginEvent**: [`ReloadCheckoutEvent`](interfaces/ReloadCheckoutEvent.md) \| [`ShowLoadingIndicatorEvent`](interfaces/ShowLoadingIndicatorEvent.md) \| [`SetIframeStylePayload`](interfaces/SetIframeStylePayload.md)
+
+___
+
 ### FlashMessageType
 
 Ƭ **FlashMessageType**: ``"error"`` \| ``"info"`` \| ``"warning"`` \| ``"success"``

diff --git a/docs/classes/CheckoutService.md b/docs/classes/CheckoutService.md
@@ -38,6 +38,7 @@ retrieve the current checkout state and subscribe to its changes.
 - [initializePayment](CheckoutService.md#initializepayment)
 - [initializeShipping](CheckoutService.md#initializeshipping)
 - [initializeSpamProtection](CheckoutService.md#initializespamprotection)
+- [listenExtensionCommand](CheckoutService.md#listenextensioncommand)
 - [loadBillingAddressFields](CheckoutService.md#loadbillingaddressfields)
 - [loadBillingCountries](CheckoutService.md#loadbillingcountries)
 - [loadCheckout](CheckoutService.md#loadcheckout)
@@ -775,6 +776,42 @@ A promise that resolves to the current state.
 
 ___
 
+### listenExtensionCommand
+
+▸ **listenExtensionCommand**(`extensionId`, `command`, `handler`): () => `void`
+
+Manages the command handler for an extension.
+
+**`alpha`**
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `extensionId` | `string` | The ID of the extension sending the command. |
+| `command` | [`ExtensionCommand`](../enums/ExtensionCommand.md) | The command to be handled. |
+| `handler` | [`ExtensionCommandHandler`](../README.md#extensioncommandhandler) | The handler function for the extension command. |
+
+#### Returns
+
+`fn`
+
+A function that, when called, will deregister the command handler.
+
+▸ (): `void`
+
+Manages the command handler for an extension.
+
+**`alpha`**
+
+##### Returns
+
+`void`
+
+A function that, when called, will deregister the command handler.
+
+___
+
 ### loadBillingAddressFields
 
 ▸ **loadBillingAddressFields**(`options?`): `Promise`<[`CheckoutSelectors`](../interfaces/CheckoutSelectors.md)\>

diff --git a/docs/enums/ExtensionCommand.md b/docs/enums/ExtensionCommand.md
@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / ExtensionCommand
+
+# Enumeration: ExtensionCommand
+
+## Table of contents
+
+### Enumeration Members
+
+- [ReloadCheckout](ExtensionCommand.md#reloadcheckout)
+- [SetIframeStyle](ExtensionCommand.md#setiframestyle)
+- [ShowLoadingIndicator](ExtensionCommand.md#showloadingindicator)
+
+## Enumeration Members
+
+### ReloadCheckout
+
+• **ReloadCheckout**
+
+___
+
+### SetIframeStyle
+
+• **SetIframeStyle**
+
+___
+
+### ShowLoadingIndicator
+
+• **ShowLoadingIndicator**
diff --git a/docs/interfaces/ReloadCheckoutEvent.md b/docs/interfaces/ReloadCheckoutEvent.md
@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / ReloadCheckoutEvent
+
+# Interface: ReloadCheckoutEvent
+
+## Table of contents
+
+### Properties
+
+- [payload](ReloadCheckoutEvent.md#payload)
+- [type](ReloadCheckoutEvent.md#type)
+
+## Properties
+
+### payload
+
+• **payload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `extensionId` | `string` |
+
+___
+
+### type
+
+• **type**: [`ReloadCheckout`](../enums/ExtensionCommand.md#reloadcheckout)
diff --git a/docs/interfaces/SetIframeStylePayload.md b/docs/interfaces/SetIframeStylePayload.md
@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / SetIframeStylePayload
+
+# Interface: SetIframeStylePayload
+
+## Table of contents
+
+### Properties
+
+- [payload](SetIframeStylePayload.md#payload)
+- [type](SetIframeStylePayload.md#type)
+
+## Properties
+
+### payload
+
+• **payload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `extensionId` | `string` |
+| `style` | `Object` |
+
+___
+
+### type
+
+• **type**: [`ReloadCheckout`](../enums/ExtensionCommand.md#reloadcheckout)
diff --git a/docs/interfaces/ShowLoadingIndicatorEvent.md b/docs/interfaces/ShowLoadingIndicatorEvent.md
@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / ShowLoadingIndicatorEvent
+
+# Interface: ShowLoadingIndicatorEvent
+
+## Table of contents
+
+### Properties
+
+- [payload](ShowLoadingIndicatorEvent.md#payload)
+- [type](ShowLoadingIndicatorEvent.md#type)
+
+## Properties
+
+### payload
+
+• **payload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `extensionId` | `string` |
+| `show` | `boolean` |
+
+___
+
+### type
+
+• **type**: [`ReloadCheckout`](../enums/ExtensionCommand.md#reloadcheckout)
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.400.0",
+  "version": "1.401.0",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",