@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/README.md

@@ -10,39 +10,181 @@
 
 ### Functions
 
-- [createCheckoutButtonInitializer](README.md#createcheckoutbuttoninitializer)
+- [createBodlService](README.md#createbodlservice)
+- [createCheckoutService](README.md#createcheckoutservice)
+- [createCurrencyService](README.md#createcurrencyservice)
+- [createLanguageService](README.md#createlanguageservice)
+- [createStepTracker](README.md#createsteptracker)
+- [embedCheckout](README.md#embedcheckout)
 
 ## Functions
 
-### createCheckoutButtonInitializer
+### createBodlService
 
-▸ **createCheckoutButtonInitializer**(`options?`): [`CheckoutButtonInitializer`](classes/internal_.CheckoutButtonInitializer.md)
+▸ **createBodlService**(`subscribe`): [`BodlService`](interfaces/internal_.BodlService.md)
 
-Creates an instance of `CheckoutButtonInitializer`.
+Creates an instance of BodlService.
 
 **`remarks`** ```js
-const initializer = createCheckoutButtonInitializer();
+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
 
-initializer.initializeButton({
-    methodId: 'braintreepaypal',
-    braintreepaypal: {
-        container: '#checkoutButton',
-    },
+▸ **createCheckoutService**(`options?`): [`CheckoutService`](classes/internal_.CheckoutService.md)
+
+Creates an instance of `CheckoutService`.
+
+**`remarks`** ```js
+const service = createCheckoutService();
+
+service.subscribe(state => {
+    console.log(state);
 });
+
+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();
 ```
 
-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 |
+| :------ | :------ |
+| `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',
+});
+```
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `options?` | [`CheckoutButtonInitializerOptions`](interfaces/internal_.CheckoutButtonInitializerOptions.md) | A set of construction options. |
+| `options` | [`EmbeddedCheckoutOptions`](interfaces/internal_.EmbeddedCheckoutOptions.md) | Options for embedding the checkout form. |
 
 #### Returns
 
-[`CheckoutButtonInitializer`](classes/internal_.CheckoutButtonInitializer.md)
+`Promise`<[`EmbeddedCheckout`](classes/internal_.EmbeddedCheckout.md)\>
 
-an instance of `CheckoutButtonInitializer`.
+A promise that resolves to an instance of `EmbeddedCheckout`.

package/docs/classes/internal_.CartChangedError.md

@@ -0,0 +1,62 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CartChangedError
+
+# Class: CartChangedError
+
+[<internal>](../modules/internal_.md).CartChangedError
+
+This error type should not be constructed directly. It is a base class for
+all custom errors thrown in this library.
+
+## Hierarchy
+
+- [`StandardError`](internal_.StandardError.md)
+
+  ↳ **`CartChangedError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](internal_.CartChangedError.md#constructor)
+
+### Properties
+
+- [name](internal_.CartChangedError.md#name)
+- [type](internal_.CartChangedError.md#type)
+
+## Constructors
+
+### constructor
+
+• **new CartChangedError**(`previous`, `updated`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `previous` | [`ComparableCheckout`](../modules/internal_.md#comparablecheckout) |
+| `updated` | [`ComparableCheckout`](../modules/internal_.md#comparablecheckout) |
+
+#### Overrides
+
+[StandardError](internal_.StandardError.md).[constructor](internal_.StandardError.md#constructor)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[StandardError](internal_.StandardError.md).[name](internal_.StandardError.md#name)
+
+___
+
+### type
+
+• **type**: `string`
+
+#### Inherited from
+
+[StandardError](internal_.StandardError.md).[type](internal_.StandardError.md#type)