@bigcommerce/checkout-sdk 1.700.2 → 1.701.0

package/docs/README.md

@@ -14,6 +14,7 @@
 - [ExtensionCommandType](enums/ExtensionCommandType.md)
 - [ExtensionEventType](enums/ExtensionEventType.md)
 - [ExtensionMessageType](enums/ExtensionMessageType.md)
+- [ExtensionQueryType](enums/ExtensionQueryType.md)
 - [ExtensionRegion](enums/ExtensionRegion.md)
 - [GooglePayKey](enums/GooglePayKey.md)
 - [HostedFieldEventType](enums/HostedFieldEventType.md)
@@ -235,6 +236,7 @@
 - [ExecutePaymentMethodCheckoutOptions](interfaces/ExecutePaymentMethodCheckoutOptions.md)
 - [Extension](interfaces/Extension.md)
 - [ExtensionCommandMap](interfaces/ExtensionCommandMap.md)
+- [ExtensionQueryMap](interfaces/ExtensionQueryMap.md)
 - [ExtensionSelector](interfaces/ExtensionSelector.md)
 - [Fee](interfaces/Fee.md)
 - [FlashMessage](interfaces/FlashMessage.md)
@@ -244,8 +246,8 @@
 - [FormFields](interfaces/FormFields.md)
 - [FormSelector](interfaces/FormSelector.md)
 - [GatewayOrderPayment](interfaces/GatewayOrderPayment.md)
-- [GetConsignmentsCommand](interfaces/GetConsignmentsCommand.md)
 - [GetConsignmentsMessage](interfaces/GetConsignmentsMessage.md)
+- [GetConsignmentsQuery](interfaces/GetConsignmentsQuery.md)
 - [GiftCertificate](interfaces/GiftCertificate.md)
 - [GiftCertificateItem](interfaces/GiftCertificateItem.md)
 - [GiftCertificateOrderPayment](interfaces/GiftCertificateOrderPayment.md)

package/docs/classes/CheckoutService.md

@@ -36,6 +36,7 @@ retrieve the current checkout state and subscribe to its changes.
 - [finalizeOrderIfNeeded](CheckoutService.md#finalizeorderifneeded)
 - [getState](CheckoutService.md#getstate)
 - [handleExtensionCommand](CheckoutService.md#handleextensioncommand)
+- [handleExtensionQuery](CheckoutService.md#handleextensionquery)
 - [initializeCustomer](CheckoutService.md#initializecustomer)
 - [initializePayment](CheckoutService.md#initializepayment)
 - [initializeShipping](CheckoutService.md#initializeshipping)
@@ -708,6 +709,48 @@ A function that, when called, will deregister the command handler.
 
 ___
 
+### handleExtensionQuery
+
+▸ **handleExtensionQuery**<`T`\>(`extensionId`, `query`, `handler`): () => `void`
+
+Manages the query handler for an extension.
+
+**`alpha`**
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`GetConsignments`](../enums/ExtensionQueryType.md#getconsignments) |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `extensionId` | `string` | The ID of the extension sending the query. |
+| `query` | `T` | The query to be handled. |
+| `handler` | (`command`: [`ExtensionQueryMap`](../interfaces/ExtensionQueryMap.md)[`T`]) => `void` | The handler function for the extension query. |
+
+#### Returns
+
+`fn`
+
+A function that, when called, will deregister the query handler.
+
+▸ (): `void`
+
+Manages the query handler for an extension.
+
+**`alpha`**
+
+##### Returns
+
+`void`
+
+A function that, when called, will deregister the query handler.
+
+___
+
 ### initializeCustomer
 
 ▸ **initializeCustomer**(`options?`): `Promise`<[`CheckoutSelectors`](../interfaces/CheckoutSelectors.md)\>

package/docs/enums/ExtensionCommandType.md

@@ -6,19 +6,12 @@
 
 ### 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/ExtensionQueryType.md

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

package/docs/interfaces/ExtensionCommandMap.md

@@ -6,19 +6,12 @@
 
 ### 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/ExtensionQueryMap.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / ExtensionQueryMap
+
+# Interface: ExtensionQueryMap
+
+## Table of contents
+
+### Properties
+
+- [EXTENSION%3AGET_CONSIGNMENTS](ExtensionQueryMap.md#extension:get_consignments)
+
+## Properties
+
+### EXTENSION:GET\_CONSIGNMENTS
+
+• **EXTENSION:GET\_CONSIGNMENTS**: [`GetConsignmentsQuery`](GetConsignmentsQuery.md)

package/docs/interfaces/GetConsignmentsQuery.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / GetConsignmentsQuery
+
+# Interface: GetConsignmentsQuery
+
+## Table of contents
+
+### Properties
+
+- [payload](GetConsignmentsQuery.md#payload)
+- [type](GetConsignmentsQuery.md#type)
+
+## Properties
+
+### payload
+
+• `Optional` **payload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `useCache?` | `boolean` |
+
+___
+
+### type
+
+• **type**: [`GetConsignments`](../enums/ExtensionQueryType.md#getconsignments)

package/package.json

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

package/docs/interfaces/GetConsignmentsCommand.md

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