@bigcommerce/checkout-sdk 1.696.3 → 1.698.0

package/docs/README.md

@@ -12,6 +12,8 @@
 - [CheckoutIncludes](enums/CheckoutIncludes.md)
 - [EmbeddedCheckoutEventType](enums/EmbeddedCheckoutEventType.md)
 - [ExtensionCommandType](enums/ExtensionCommandType.md)
+- [ExtensionEventType](enums/ExtensionEventType.md)
+- [ExtensionMessageType](enums/ExtensionMessageType.md)
 - [ExtensionRegion](enums/ExtensionRegion.md)
 - [GooglePayKey](enums/GooglePayKey.md)
 - [HostedFieldEventType](enums/HostedFieldEventType.md)
@@ -188,6 +190,7 @@
 - [ConsignmentPickupOption](interfaces/ConsignmentPickupOption.md)
 - [ConsignmentSelector](interfaces/ConsignmentSelector.md)
 - [ConsignmentUpdateRequestBody](interfaces/ConsignmentUpdateRequestBody.md)
+- [ConsignmentsChangedEvent](interfaces/ConsignmentsChangedEvent.md)
 - [ContextConfig](interfaces/ContextConfig.md)
 - [Coordinates](interfaces/Coordinates.md)
 - [Country](interfaces/Country.md)
@@ -241,6 +244,8 @@
 - [FormFields](interfaces/FormFields.md)
 - [FormSelector](interfaces/FormSelector.md)
 - [GatewayOrderPayment](interfaces/GatewayOrderPayment.md)
+- [GetConsignmentsCommand](interfaces/GetConsignmentsCommand.md)
+- [GetConsignmentsMessage](interfaces/GetConsignmentsMessage.md)
 - [GiftCertificate](interfaces/GiftCertificate.md)
 - [GiftCertificateItem](interfaces/GiftCertificateItem.md)
 - [GiftCertificateOrderPayment](interfaces/GiftCertificateOrderPayment.md)
@@ -504,6 +509,8 @@
 - [ConsignmentsRequestBody](README.md#consignmentsrequestbody)
 - [CustomerAddressRequestBody](README.md#customeraddressrequestbody)
 - [CustomerInitializeOptions](README.md#customerinitializeoptions)
+- [ExtensionEvent](README.md#extensionevent)
+- [ExtensionMessage](README.md#extensionmessage)
 - [FlashMessageType](README.md#flashmessagetype)
 - [FormFieldFieldType](README.md#formfieldfieldtype)
 - [FormFieldType](README.md#formfieldtype)
@@ -673,6 +680,18 @@ ___
 
 ___
 
+### ExtensionEvent
+
+Ƭ **ExtensionEvent**: [`ConsignmentsChangedEvent`](interfaces/ConsignmentsChangedEvent.md)
+
+___
+
+### ExtensionMessage
+
+Ƭ **ExtensionMessage**: [`ExtensionEvent`](README.md#extensionevent) \| [`GetConsignmentsMessage`](interfaces/GetConsignmentsMessage.md)
+
+___
+
 ### FlashMessageType
 
 Ƭ **FlashMessageType**: ``"error"`` \| ``"info"`` \| ``"warning"`` \| ``"success"``

package/docs/classes/CheckoutService.md

@@ -53,6 +53,7 @@ retrieve the current checkout state and subscribe to its changes.
 - [loadShippingCountries](CheckoutService.md#loadshippingcountries)
 - [loadShippingOptions](CheckoutService.md#loadshippingoptions)
 - [notifyState](CheckoutService.md#notifystate)
+- [postMessageToExtension](CheckoutService.md#postmessagetoextension)
 - [removeCoupon](CheckoutService.md#removecoupon)
 - [removeGiftCertificate](CheckoutService.md#removegiftcertificate)
 - [renderExtension](CheckoutService.md#renderextension)
@@ -1231,6 +1232,27 @@ they have any filters applied.
 
 ___
 
+### postMessageToExtension
+
+▸ **postMessageToExtension**(`extensionId`, `message`): `void`
+
+Posts a message to a checkout extension.
+
+**`alpha`**
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `extensionId` | `string` | The ID of an extension to post the event to. |
+| `message` | [`ExtensionMessage`](../README.md#extensionmessage) | The message to post to an extension. |
+
+#### Returns
+
+`void`
+
+___
+
 ### removeCoupon
 
 ▸ **removeCoupon**(`code`, `options?`): `Promise`<[`CheckoutSelectors`](../interfaces/CheckoutSelectors.md)\>

package/docs/enums/ExtensionCommandType.md

@@ -6,12 +6,19 @@
 
 ### Enumeration Members
 
+- [GetConsignments](ExtensionCommandType.md#getconsignments)
 - [ReloadCheckout](ExtensionCommandType.md#reloadcheckout)
 - [SetIframeStyle](ExtensionCommandType.md#setiframestyle)
 - [ShowLoadingIndicator](ExtensionCommandType.md#showloadingindicator)
 
 ## Enumeration Members
 
+### GetConsignments
+
+• **GetConsignments**
+
+___
+
 ### ReloadCheckout
 
 • **ReloadCheckout**

package/docs/enums/ExtensionEventType.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / ExtensionEventType
+
+# Enumeration: ExtensionEventType
+
+## Table of contents
+
+### Enumeration Members
+
+- [ConsignmentsChanged](ExtensionEventType.md#consignmentschanged)
+
+## Enumeration Members
+
+### ConsignmentsChanged
+
+• **ConsignmentsChanged**

package/docs/enums/ExtensionMessageType.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / ExtensionMessageType
+
+# Enumeration: ExtensionMessageType
+
+## Table of contents
+
+### Enumeration Members
+
+- [GetConsignments](ExtensionMessageType.md#getconsignments)
+
+## Enumeration Members
+
+### GetConsignments
+
+• **GetConsignments**

package/docs/interfaces/ConsignmentsChangedEvent.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / ConsignmentsChangedEvent
+
+# Interface: ConsignmentsChangedEvent
+
+## Table of contents
+
+### Properties
+
+- [payload](ConsignmentsChangedEvent.md#payload)
+- [type](ConsignmentsChangedEvent.md#type)
+
+## Properties
+
+### payload
+
+• **payload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `consignments` | [`Consignment`](Consignment.md)[] |
+| `previousConsignments` | [`Consignment`](Consignment.md)[] |
+
+___
+
+### type
+
+• **type**: [`ConsignmentsChanged`](../enums/ExtensionEventType.md#consignmentschanged)

package/docs/interfaces/ExtensionCommandMap.md

@@ -6,12 +6,19 @@
 
 ### Properties
 
+- [EXTENSION%3AGET_CONSIGNMENTS](ExtensionCommandMap.md#extension:get_consignments)
 - [EXTENSION%3ARELOAD_CHECKOUT](ExtensionCommandMap.md#extension:reload_checkout)
 - [EXTENSION%3ASET_IFRAME_STYLE](ExtensionCommandMap.md#extension:set_iframe_style)
 - [EXTENSION%3ASHOW_LOADING_INDICATOR](ExtensionCommandMap.md#extension:show_loading_indicator)
 
 ## Properties
 
+### EXTENSION:GET\_CONSIGNMENTS
+
+• **EXTENSION:GET\_CONSIGNMENTS**: [`GetConsignmentsCommand`](GetConsignmentsCommand.md)
+
+___
+
 ### EXTENSION:RELOAD\_CHECKOUT
 
 • **EXTENSION:RELOAD\_CHECKOUT**: [`ReloadCheckoutCommand`](ReloadCheckoutCommand.md)

package/docs/interfaces/GetConsignmentsCommand.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / GetConsignmentsCommand
+
+# Interface: GetConsignmentsCommand
+
+## Table of contents
+
+### Properties
+
+- [type](GetConsignmentsCommand.md#type)
+
+## Properties
+
+### type
+
+• **type**: [`GetConsignments`](../enums/ExtensionCommandType.md#getconsignments)

package/docs/interfaces/GetConsignmentsMessage.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / GetConsignmentsMessage
+
+# Interface: GetConsignmentsMessage
+
+## Table of contents
+
+### Properties
+
+- [payload](GetConsignmentsMessage.md#payload)
+- [type](GetConsignmentsMessage.md#type)
+
+## Properties
+
+### payload
+
+• **payload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `consignments` | [`Consignment`](Consignment.md)[] |
+
+___
+
+### type
+
+• **type**: [`GetConsignments`](../enums/ExtensionMessageType.md#getconsignments)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.696.3",
+  "version": "1.698.0",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",