@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/README.md

@@ -10,181 +10,39 @@
 
 ### Functions
 
-- [createBodlService](README.md#createbodlservice)
-- [createCheckoutService](README.md#createcheckoutservice)
-- [createCurrencyService](README.md#createcurrencyservice)
-- [createLanguageService](README.md#createlanguageservice)
-- [createStepTracker](README.md#createsteptracker)
-- [embedCheckout](README.md#embedcheckout)
+- [createCheckoutButtonInitializer](README.md#createcheckoutbuttoninitializer)
 
 ## Functions
 
-### createBodlService
+### createCheckoutButtonInitializer
 
-▸ **createBodlService**(`subscribe`): [`BodlService`](interfaces/internal_.BodlService.md)
+▸ **createCheckoutButtonInitializer**(`options?`): [`CheckoutButtonInitializer`](classes/internal_.CheckoutButtonInitializer.md)
 
-Creates an instance of BodlService.
+Creates an instance of `CheckoutButtonInitializer`.
 
 **`remarks`** ```js
-const bodlService = BodlService();
-bodlService.checkoutBegin();
-```
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `subscribe` | (`subscriber`: (`state`: [`CheckoutSelectors`](interfaces/internal_.CheckoutSelectors.md)) => `void`) => `void` |
-
-#### Returns
-
-[`BodlService`](interfaces/internal_.BodlService.md)
-
-an instance of `BodlService`.
-
-___
-
-### createCheckoutService
+const initializer = createCheckoutButtonInitializer();
 
-▸ **createCheckoutService**(`options?`): [`CheckoutService`](classes/internal_.CheckoutService.md)
-
-Creates an instance of `CheckoutService`.
-
-**`remarks`** ```js
-const service = createCheckoutService();
-
-service.subscribe(state => {
-    console.log(state);
+initializer.initializeButton({
+    methodId: 'braintreepaypal',
+    braintreepaypal: {
+        container: '#checkoutButton',
+    },
 });
-
-service.loadCheckout();
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `options?` | [`CheckoutServiceOptions`](interfaces/internal_.CheckoutServiceOptions.md) | A set of construction options. |
-
-#### Returns
-
-[`CheckoutService`](classes/internal_.CheckoutService.md)
-
-an instance of `CheckoutService`.
-
-___
-
-### createCurrencyService
-
-▸ **createCurrencyService**(`config`): [`CurrencyService`](classes/internal_.CurrencyService.md)
-
-Creates an instance of `CurrencyService`.
-
-**`remarks`** ```js
-const { data } = checkoutService.getState();
-const config = data.getConfig();
-const checkout = data.getCheckout();
-const currencyService = createCurrencyService(config);
-
-currencyService.toStoreCurrency(checkout.grandTotal);
-currencyService.toCustomerCurrency(checkout.grandTotal);
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `config` | [`StoreConfig`](interfaces/internal_.StoreConfig.md) | The config object containing the currency configuration |
-
-#### Returns
-
-[`CurrencyService`](classes/internal_.CurrencyService.md)
-
-an instance of `CurrencyService`.
-
-___
-
-### createLanguageService
-
-▸ **createLanguageService**(`config?`): [`LanguageService`](classes/internal_.LanguageService.md)
-
-Creates an instance of `LanguageService`.
-
-**`remarks`** ```js
-const language = {{{langJson 'optimized_checkout'}}}; // `langJson` is a Handlebars helper provided by BigCommerce's Stencil template engine.
-const service = createLanguageService(language);
-
-console.log(service.translate('address.city_label'));
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `config?` | `Partial`<[`LanguageConfig`](interfaces/internal_.LanguageConfig.md)\> | A configuration object. |
-
-#### Returns
-
-[`LanguageService`](classes/internal_.LanguageService.md)
-
-An instance of `LanguageService`.
-
-___
-
-### createStepTracker
-
-▸ **createStepTracker**(`checkoutService`, `stepTrackerConfig?`): [`StepTracker`](interfaces/internal_.StepTracker.md)
-
-Creates an instance of `StepTracker`.
-
-**`remarks`** ```js
-const checkoutService = createCheckoutService();
-await checkoutService.loadCheckout();
-const stepTracker = createStepTracker(checkoutService);
-
-stepTracker.trackCheckoutStarted();
 ```
 
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `checkoutService` | [`CheckoutService`](classes/internal_.CheckoutService.md) |
-| `stepTrackerConfig?` | [`StepTrackerConfig`](interfaces/internal_.StepTrackerConfig.md) |
-
-#### Returns
-
-[`StepTracker`](interfaces/internal_.StepTracker.md)
-
-an instance of `StepTracker`.
-
-___
-
-### embedCheckout
-
-▸ **embedCheckout**(`options`): `Promise`<[`EmbeddedCheckout`](classes/internal_.EmbeddedCheckout.md)\>
-
-Embed the checkout form in an iframe.
-
-**`remarks`** Once the iframe is embedded, it will automatically resize according to the
-size of the checkout form. It will also notify the parent window when certain
-events have occurred. i.e.: when the form is loaded and ready to be used.
-
-```js
-embedCheckout({
-    url: 'https://checkout/url',
-    containerId: 'container-id',
-});
-```
+Please note that `CheckoutButtonInitializer` is currently in an early stage
+of development. Therefore the API is unstable and not ready for public
+consumption.
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `options` | [`EmbeddedCheckoutOptions`](interfaces/internal_.EmbeddedCheckoutOptions.md) | Options for embedding the checkout form. |
+| `options?` | [`CheckoutButtonInitializerOptions`](interfaces/internal_.CheckoutButtonInitializerOptions.md) | A set of construction options. |
 
 #### Returns
 
-`Promise`<[`EmbeddedCheckout`](classes/internal_.EmbeddedCheckout.md)\>
+[`CheckoutButtonInitializer`](classes/internal_.CheckoutButtonInitializer.md)
 
-A promise that resolves to an instance of `EmbeddedCheckout`.
+an instance of `CheckoutButtonInitializer`.

package/docs/classes/internal_.CheckoutButtonErrorSelector.md

@@ -0,0 +1,54 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonErrorSelector
+
+# Class: CheckoutButtonErrorSelector
+
+[<internal>](../modules/internal_.md).CheckoutButtonErrorSelector
+
+## Table of contents
+
+### Constructors
+
+- [constructor](internal_.CheckoutButtonErrorSelector.md#constructor)
+
+### Methods
+
+- [getDeinitializeButtonError](internal_.CheckoutButtonErrorSelector.md#getdeinitializebuttonerror)
+- [getInitializeButtonError](internal_.CheckoutButtonErrorSelector.md#getinitializebuttonerror)
+
+## Constructors
+
+### constructor
+
+• **new CheckoutButtonErrorSelector**()
+
+## Methods
+
+### getDeinitializeButtonError
+
+▸ **getDeinitializeButtonError**(`methodId?`): `undefined` \| `Error`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `methodId?` | [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md) |
+
+#### Returns
+
+`undefined` \| `Error`
+
+___
+
+### getInitializeButtonError
+
+▸ **getInitializeButtonError**(`methodId?`): `undefined` \| `Error`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `methodId?` | [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md) |
+
+#### Returns
+
+`undefined` \| `Error`

package/docs/classes/internal_.CheckoutButtonInitializer.md

@@ -0,0 +1,179 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonInitializer
+
+# Class: CheckoutButtonInitializer
+
+[<internal>](../modules/internal_.md).CheckoutButtonInitializer
+
+## Table of contents
+
+### Constructors
+
+- [constructor](internal_.CheckoutButtonInitializer.md#constructor)
+
+### Methods
+
+- [deinitializeButton](internal_.CheckoutButtonInitializer.md#deinitializebutton)
+- [getState](internal_.CheckoutButtonInitializer.md#getstate)
+- [initializeButton](internal_.CheckoutButtonInitializer.md#initializebutton)
+- [subscribe](internal_.CheckoutButtonInitializer.md#subscribe)
+
+## Constructors
+
+### constructor
+
+• **new CheckoutButtonInitializer**()
+
+## Methods
+
+### deinitializeButton
+
+▸ **deinitializeButton**(`options`): `Promise`<[`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)\>
+
+De-initializes the checkout button by performing any necessary clean-ups.
+
+```js
+await service.deinitializeButton({
+    methodId: 'braintreepaypal',
+});
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options` | [`CheckoutButtonOptions`](../interfaces/internal_.CheckoutButtonOptions.md) | Options for deinitializing the checkout button. |
+
+#### Returns
+
+`Promise`<[`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)\>
+
+A promise that resolves to the current state.
+
+___
+
+### getState
+
+▸ **getState**(): [`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)
+
+Returns a snapshot of the current state.
+
+The method returns a new instance every time there is a change in the
+state. You can query the state by calling any of its getter methods.
+
+```js
+const state = service.getState();
+
+console.log(state.errors.getInitializeButtonError());
+console.log(state.statuses.isInitializingButton());
+```
+
+#### Returns
+
+[`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)
+
+The current customer's checkout state
+
+___
+
+### initializeButton
+
+▸ **initializeButton**(`options`): `Promise`<[`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)\>
+
+Initializes the checkout button of a payment method.
+
+When the checkout button is initialized, it will be inserted into the DOM,
+ready to be interacted with by the customer.
+
+```js
+initializer.initializeButton({
+    methodId: 'braintreepaypal',
+    containerId: 'checkoutButton',
+    braintreepaypal: {
+    },
+});
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options` | [`CheckoutButtonInitializeOptions`](../modules/internal_.md#checkoutbuttoninitializeoptions) | Options for initializing the checkout button. |
+
+#### Returns
+
+`Promise`<[`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)\>
+
+A promise that resolves to the current state.
+
+___
+
+### subscribe
+
+▸ **subscribe**(`subscriber`, ...`filters`): () => `void`
+
+Subscribes to any changes to the current state.
+
+The method registers a callback function and executes it every time there
+is a change in the current state.
+
+```js
+service.subscribe(state => {
+    console.log(state.statuses.isInitializingButton());
+});
+```
+
+The method can be configured to notify subscribers only regarding
+relevant changes, by providing a filter function.
+
+```js
+const filter = state => state.errors.getInitializeButtonError();
+
+// Only trigger the subscriber when the cart changes.
+service.subscribe(state => {
+    console.log(state.errors.getInitializeButtonError())
+}, filter);
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `subscriber` | (`state`: [`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)) => `void` | The function to subscribe to state changes. |
+| `...filters` | (`state`: [`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)) => `any`[] | One or more functions to filter out irrelevant state changes. If more than one function is provided, the subscriber will only be triggered if all conditions are met. |
+
+#### Returns
+
+`fn`
+
+A function, if called, will unsubscribe the subscriber.
+
+▸ (): `void`
+
+Subscribes to any changes to the current state.
+
+The method registers a callback function and executes it every time there
+is a change in the current state.
+
+```js
+service.subscribe(state => {
+    console.log(state.statuses.isInitializingButton());
+});
+```
+
+The method can be configured to notify subscribers only regarding
+relevant changes, by providing a filter function.
+
+```js
+const filter = state => state.errors.getInitializeButtonError();
+
+// Only trigger the subscriber when the cart changes.
+service.subscribe(state => {
+    console.log(state.errors.getInitializeButtonError())
+}, filter);
+```
+
+##### Returns
+
+`void`
+
+A function, if called, will unsubscribe the subscriber.

package/docs/classes/internal_.CheckoutButtonStatusSelector.md

@@ -0,0 +1,54 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonStatusSelector
+
+# Class: CheckoutButtonStatusSelector
+
+[<internal>](../modules/internal_.md).CheckoutButtonStatusSelector
+
+## Table of contents
+
+### Constructors
+
+- [constructor](internal_.CheckoutButtonStatusSelector.md#constructor)
+
+### Methods
+
+- [isDeinitializingButton](internal_.CheckoutButtonStatusSelector.md#isdeinitializingbutton)
+- [isInitializingButton](internal_.CheckoutButtonStatusSelector.md#isinitializingbutton)
+
+## Constructors
+
+### constructor
+
+• **new CheckoutButtonStatusSelector**()
+
+## Methods
+
+### isDeinitializingButton
+
+▸ **isDeinitializingButton**(`methodId?`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `methodId?` | [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md) |
+
+#### Returns
+
+`boolean`
+
+___
+
+### isInitializingButton
+
+▸ **isInitializingButton**(`methodId?`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `methodId?` | [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md) |
+
+#### Returns
+
+`boolean`

package/docs/classes/internal_.StandardError.md

@@ -13,10 +13,6 @@ all custom errors thrown in this library.
 
   ↳ **`StandardError`**
 
-  ↳↳ [`CartChangedError`](internal_.CartChangedError.md)
-
-  ↳↳ [`RequestError`](internal_.RequestError.md)
-
 ## Implements
 
 - [`CustomError`](../interfaces/internal_.CustomError.md)

package/docs/enums/internal_.AmazonPayV2ButtonColor.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2ButtonColor
+
+# Enumeration: AmazonPayV2ButtonColor
+
+[<internal>](../modules/internal_.md).AmazonPayV2ButtonColor
+
+## Table of contents
+
+### Enumeration Members
+
+- [DarkGray](internal_.AmazonPayV2ButtonColor.md#darkgray)
+- [Gold](internal_.AmazonPayV2ButtonColor.md#gold)
+- [LightGray](internal_.AmazonPayV2ButtonColor.md#lightgray)
+
+## Enumeration Members
+
+### DarkGray
+
+• **DarkGray**
+
+___
+
+### Gold
+
+• **Gold**
+
+___
+
+### LightGray
+
+• **LightGray**

package/docs/enums/internal_.AmazonPayV2CheckoutLanguage.md

@@ -0,0 +1,59 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2CheckoutLanguage
+
+# Enumeration: AmazonPayV2CheckoutLanguage
+
+[<internal>](../modules/internal_.md).AmazonPayV2CheckoutLanguage
+
+## Table of contents
+
+### Enumeration Members
+
+- [de\_DE](internal_.AmazonPayV2CheckoutLanguage.md#de_de)
+- [en\_GB](internal_.AmazonPayV2CheckoutLanguage.md#en_gb)
+- [en\_US](internal_.AmazonPayV2CheckoutLanguage.md#en_us)
+- [es\_ES](internal_.AmazonPayV2CheckoutLanguage.md#es_es)
+- [fr\_FR](internal_.AmazonPayV2CheckoutLanguage.md#fr_fr)
+- [it\_IT](internal_.AmazonPayV2CheckoutLanguage.md#it_it)
+- [ja\_JP](internal_.AmazonPayV2CheckoutLanguage.md#ja_jp)
+
+## Enumeration Members
+
+### de\_DE
+
+• **de\_DE**
+
+___
+
+### en\_GB
+
+• **en\_GB**
+
+___
+
+### en\_US
+
+• **en\_US**
+
+___
+
+### es\_ES
+
+• **es\_ES**
+
+___
+
+### fr\_FR
+
+• **fr\_FR**
+
+___
+
+### it\_IT
+
+• **it\_IT**
+
+___
+
+### ja\_JP
+
+• **ja\_JP**

package/docs/enums/internal_.AmazonPayV2LedgerCurrency.md

@@ -0,0 +1,38 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2LedgerCurrency
+
+# Enumeration: AmazonPayV2LedgerCurrency
+
+[<internal>](../modules/internal_.md).AmazonPayV2LedgerCurrency
+
+## Table of contents
+
+### Enumeration Members
+
+- [EUR](internal_.AmazonPayV2LedgerCurrency.md#eur)
+- [GBP](internal_.AmazonPayV2LedgerCurrency.md#gbp)
+- [JPY](internal_.AmazonPayV2LedgerCurrency.md#jpy)
+- [USD](internal_.AmazonPayV2LedgerCurrency.md#usd)
+
+## Enumeration Members
+
+### EUR
+
+• **EUR**
+
+___
+
+### GBP
+
+• **GBP**
+
+___
+
+### JPY
+
+• **JPY**
+
+___
+
+### USD
+
+• **USD**

package/docs/enums/internal_.AmazonPayV2PayOptions.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2PayOptions
+
+# Enumeration: AmazonPayV2PayOptions
+
+[<internal>](../modules/internal_.md).AmazonPayV2PayOptions
+
+## Table of contents
+
+### Enumeration Members
+
+- [PayAndShip](internal_.AmazonPayV2PayOptions.md#payandship)
+- [PayOnly](internal_.AmazonPayV2PayOptions.md#payonly)
+
+## Enumeration Members
+
+### PayAndShip
+
+• **PayAndShip**
+
+Select this product type if you need the buyer's shipping details.
+
+___
+
+### PayOnly
+
+• **PayOnly**
+
+Select this product type if you do not need the buyer's shipping details.

package/docs/enums/internal_.AmazonPayV2Placement.md

@@ -0,0 +1,55 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2Placement
+
+# Enumeration: AmazonPayV2Placement
+
+[<internal>](../modules/internal_.md).AmazonPayV2Placement
+
+## Table of contents
+
+### Enumeration Members
+
+- [Cart](internal_.AmazonPayV2Placement.md#cart)
+- [Checkout](internal_.AmazonPayV2Placement.md#checkout)
+- [Home](internal_.AmazonPayV2Placement.md#home)
+- [Other](internal_.AmazonPayV2Placement.md#other)
+- [Product](internal_.AmazonPayV2Placement.md#product)
+
+## Enumeration Members
+
+### Cart
+
+• **Cart**
+
+Cart review page before buyer starts checkout.
+
+___
+
+### Checkout
+
+• **Checkout**
+
+Any page after buyer starts checkout.
+
+___
+
+### Home
+
+• **Home**
+
+Initial or main page.
+
+___
+
+### Other
+
+• **Other**
+
+Any page that doesn't fit the previous descriptions.
+
+___
+
+### Product
+
+• **Product**
+
+Product details page.