@liquidcommerce/elements-sdk 2.7.9 → 2.7.11

package/docs/v1/api/typescript-types.md

@@ -1 +1,398 @@
-to be created...
+# TypeScript Types Reference
+
+All public types are exported from the main package entry point. Import them using the `type` keyword for optimal tree-shaking.
+
+## Importing Types
+
+```typescript
+import { Elements } from '@liquidcommerce/elements-sdk';
+import type {
+  ILiquidCommerceElementsClient,
+  ILiquidCommerceElementsConfig,
+  IInjectProductElement,
+  IInjectedComponent
+} from '@liquidcommerce/elements-sdk';
+```
+
+For the checkout-only build:
+
+```typescript
+import { ElementsCheckout } from '@liquidcommerce/elements-sdk/checkout';
+import type {
+  IElementsCheckoutClient,
+  IElementsCheckoutActions,
+  ILiquidCommerceElementsCheckoutClientConfig,
+  IInjectedComponent
+} from '@liquidcommerce/elements-sdk/checkout';
+```
+
+---
+
+## Client Types
+
+### ILiquidCommerceElementsClient
+
+Main SDK client interface returned by `Elements()`.
+
+```typescript
+interface ILiquidCommerceElementsClient {
+  injectProductElement(params: IInjectProductElement[]): Promise<IInjectedComponent[]>;
+  injectAddressElement(containerId: string, options?: IAddressOptions): Promise<IInjectedComponent | null>;
+  injectCartElement(containerId: string): Promise<IInjectedComponent | null>;
+  injectCheckoutElement(params: IInjectCheckoutParams): Promise<IInjectedComponent | null>;
+  injectProductList(params: IInjectProductListParams): Promise<void>;
+  injectProductListSearch(params: IInjectProductListSearchParams): Promise<void>;
+  injectProductListFilters(params: IInjectProductListFiltersParams): Promise<void>;
+  ui: ILiquidCommerceElementsUIMethod;
+  actions: ILiquidCommerceElementsActions;
+  getInjectedComponents(): Map<string, IInjectedComponent>;
+  destroy(): void;
+}
+```
+
+### ILiquidCommerceElementsBuilderClient
+
+Builder-pattern client interface returned by `ElementsBuilder()`.
+
+```typescript
+interface ILiquidCommerceElementsBuilderClient {
+  updateComponentGlobalConfigs(configs: UpdateComponentGlobalConfigs): Promise<void>;
+  updateProductComponent(configs: UpdateProductComponent): Promise<void>;
+  updateAddressComponent(configs: UpdateAddressComponent): void;
+  updateCartComponent(configs: UpdateCartComponent): void;
+  updateCheckoutComponent(configs: UpdateCheckoutComponent): void;
+  updateProductListComponent(configs: UpdateProductListComponent): void;
+  injectElement(params: IBuilderInjectElementParams): Promise<IInjectedComponent | null>;
+  injectProductElement(params: IInjectProductElement[]): Promise<IInjectedComponent[]>;
+  injectAddressElement(containerId: string, options?: IAddressOptions): Promise<IInjectedComponent | null>;
+  injectCartElement(containerId: string): Promise<IInjectedComponent | null>;
+  injectCheckoutElement(params: IInjectCheckoutBuilderParams): Promise<IInjectedComponent | null>;
+  injectProductList(params: IInjectProductListParams): Promise<void>;
+  actions: ILiquidCommerceElementsActions;
+  destroy(): void;
+}
+```
+
+### IElementsCheckoutClient
+
+Checkout-only client interface returned by `ElementsCheckout()`.
+
+```typescript
+interface IElementsCheckoutClient {
+  injectCheckout(params: IInjectCheckoutParams): Promise<IInjectedComponent | null>;
+  actions: { checkout: IElementsCheckoutActions };
+  destroy(): void;
+}
+```
+
+---
+
+## Configuration Types
+
+### ILiquidCommerceElementsConfig
+
+```typescript
+interface ILiquidCommerceElementsConfig {
+  env?: ElementsEnv;
+  promoTicker?: IPromoTicker[];
+  customTheme?: IClientCustomThemeConfig;
+  debugMode?: DebugMode;
+  checkout?: ILiquidCommerceElementsCheckoutConfig;
+  proxy?: IElementsProxyConfig;
+  development?: ILiquidCommerceElementsDevelopmentConfig;
+}
+```
+
+### ILiquidCommerceElementsCheckoutClientConfig
+
+Same shape as `ILiquidCommerceElementsConfig`, used for the checkout-only client.
+
+### IClientCustomThemeConfig
+
+```typescript
+interface IClientCustomThemeConfig {
+  global?: UpdateComponentGlobalConfigs;
+  product?: UpdateProductComponent;
+  address?: UpdateAddressComponent;
+  cart?: UpdateCartComponent;
+  checkout?: UpdateCheckoutComponent;
+  productList?: UpdateProductListComponent;
+}
+```
+
+### IElementsProxyConfig
+
+```typescript
+interface IElementsProxyConfig {
+  baseUrl: string;
+  headers?: Record<string, string>;
+}
+```
+
+### ILiquidCommerceElementsDevelopmentConfig
+
+```typescript
+interface ILiquidCommerceElementsDevelopmentConfig {
+  customApiUrl?: string;
+  paymentMethodId?: string;
+  openShadowDom?: boolean;
+}
+```
+
+### ILiquidCommerceElementsCheckoutConfig
+
+```typescript
+interface ILiquidCommerceElementsCheckoutConfig {
+  pageUrl?: string;
+}
+```
+
+See [Configuration Reference](./configuration.md) for detailed property descriptions.
+
+---
+
+## Injection Types
+
+### IInjectProductElement
+
+```typescript
+interface IInjectProductElement {
+  containerId: string;
+  identifier: string;
+}
+```
+
+### IInjectCheckoutParams
+
+```typescript
+interface IInjectCheckoutParams {
+  containerId: string;
+  checkoutId?: string;
+  hideHeader?: boolean;
+}
+```
+
+### IInjectCheckoutBuilderParams
+
+```typescript
+interface IInjectCheckoutBuilderParams extends IInjectCheckoutParams {
+  simulatePresale?: boolean;
+  presaleExpiresInMinutes?: number;
+}
+```
+
+### IInjectProductListParams
+
+```typescript
+interface IInjectProductListParams {
+  containerId: string;
+  slug: string;
+  rows?: number;
+  columns?: number;
+  filters?: ProductListFilterType[];
+  productUrl?: string;
+}
+```
+
+### IInjectProductListSearchParams
+
+```typescript
+interface IInjectProductListSearchParams {
+  containerId: string;
+  slug: string;
+}
+```
+
+### IInjectProductListFiltersParams
+
+```typescript
+interface IInjectProductListFiltersParams {
+  containerId: string;
+  slug: string;
+  filters?: ProductListFilterType[];
+}
+```
+
+### IBuilderInjectElementParams
+
+```typescript
+interface IBuilderInjectElementParams {
+  type: ComponentType;
+  containerId: string;
+  [key: string]: any;
+}
+```
+
+---
+
+## Component Types
+
+### IInjectedComponent
+
+Returned by all injection methods. Provides control over the injected component.
+
+```typescript
+interface IInjectedComponent {
+  getType(): ComponentType;
+  getElement(): HTMLElement;
+  rerender(): void;
+  destroy(): void;
+}
+```
+
+---
+
+## UI Types
+
+### ILiquidCommerceElementsUIMethod
+
+```typescript
+interface ILiquidCommerceElementsUIMethod {
+  cartButton(containerId: string, showItemsCount?: boolean): void;
+  floatingCartButton(showItemsCount?: boolean): void;
+  cartSubtotal(elementId: string): void;
+  cartItemsCount(elementId: string, options?: { hideZero: boolean }): void;
+}
+```
+
+---
+
+## Action Types
+
+### ILiquidCommerceElementsActions
+
+```typescript
+interface ILiquidCommerceElementsActions {
+  product: IProductActions;
+  address: IAddressActions;
+  cart: ICartActions;
+  checkout: ICheckoutActions;
+}
+```
+
+### IElementsCheckoutActions
+
+Checkout actions available in the checkout-only client. Omits drawer-related methods.
+
+```typescript
+interface IElementsCheckoutActions extends Omit<ICheckoutActions, 'openCheckout' | 'closeCheckout' | 'toggleCheckout'> {}
+```
+
+See [Actions API](./actions/) for detailed method signatures.
+
+---
+
+## Enum Types
+
+### ElementsEnv
+
+```typescript
+type ElementsEnv = 'development' | 'staging' | 'production';
+```
+
+### DebugMode
+
+```typescript
+type DebugMode = 'none' | 'console' | 'panel';
+```
+
+### FulfillmentType
+
+```typescript
+type FulfillmentType = 'onDemand' | 'shipping';
+```
+
+### ComponentType
+
+```typescript
+type ComponentType =
+  | 'address' | 'product' | 'cart' | 'checkout'
+  | 'product-list' | 'product-list-card' | 'product-list-filters' | 'product-list-search'
+  | 'drawer' | 'input' | 'engraving-form' | 'engraving-view'
+  | 'buttons-cart-open' | 'powered-by' | 'lce-element'
+  | 'purchase-min-alert' | 'alert' | 'promo-code-ticker'
+  // ...and additional internal component types
+```
+
+### DisplayModeType
+
+```typescript
+type DisplayModeType = 'modal' | 'drawer';
+```
+
+---
+
+## Theme Configuration Types
+
+### UpdateComponentGlobalConfigs
+
+`DeepPartial<IComponentGlobalConfigs>` -- all properties optional.
+
+### UpdateProductComponent
+
+`DeepPartial<IProductComponent>` -- all properties optional.
+
+### UpdateCartComponent
+
+`DeepPartial<ICartComponent>` -- all properties optional.
+
+### UpdateCheckoutComponent
+
+`DeepPartial<ICheckoutComponent>` -- all properties optional.
+
+### UpdateAddressComponent
+
+`DeepPartial<IAddressComponent>` -- all properties optional.
+
+### UpdateProductListComponent
+
+Special structure for updating product list configuration by slug:
+
+```typescript
+interface UpdateProductListComponent {
+  theme?: { backgroundColor?: string };
+  layout?: {
+    lists?: Record<string, DeepPartial<IPLCList>>;
+  };
+}
+```
+
+See [Configuration Reference](./configuration.md) for detailed theme property descriptions.
+
+---
+
+## Promo Ticker Type
+
+### IPromoTicker
+
+```typescript
+interface IPromoTicker {
+  promoCode: string;
+  text: string[];
+  separator: string;
+  activeFrom: string;   // ISO 8601 UTC
+  activeUntil: string;  // ISO 8601 UTC
+}
+```
+
+---
+
+## Utility Types
+
+### DeepPartial
+
+Used internally for theme update types. Makes all properties in `T` recursively optional.
+
+```typescript
+type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+```
+
+---
+
+## See Also
+
+- [Client API](./client.md) - Client initialization and usage
+- [Configuration Reference](./configuration.md) - Detailed config options
+- [Injection Methods](./injection-methods.md) - Component injection API

package/docs/v1/examples/advanced-patterns.md

@@ -88,6 +88,108 @@ const client = await Elements('YOUR_API_KEY', {
 });
 ```
 
+## 7) Cleanup on SPA Navigation
+
+```javascript
+let client = null;
+
+async function mountElements() {
+  client = await Elements('YOUR_API_KEY', { env: 'production' });
+  await client.injectProductElement([
+    { containerId: 'product', identifier: '00619947000020' }
+  ]);
+}
+
+function unmountElements() {
+  if (client) {
+    client.destroy();
+    client = null;
+  }
+}
+
+// React example
+useEffect(() => {
+  mountElements();
+  return () => unmountElements();
+}, []);
+```
+
+## 8) Checkout-Only Page
+
+For a dedicated checkout page, use the tree-shaken checkout build:
+
+```javascript
+import { ElementsCheckout } from '@liquidcommerce/elements-sdk/checkout';
+
+const client = await ElementsCheckout('YOUR_API_KEY', {
+  env: 'production'
+});
+
+await client.injectCheckout({
+  containerId: 'checkout',
+  checkoutId: new URLSearchParams(window.location.search).get('lce_checkout'),
+  hideHeader: false
+});
+```
+
+## 9) Promo Ticker with Time Windows
+
+```javascript
+const client = await Elements('YOUR_API_KEY', {
+  env: 'production',
+  promoTicker: [
+    {
+      promoCode: 'SUMMER20',
+      text: ['20% Off Summer Sale', 'Free Shipping on $50+'],
+      separator: '|',
+      activeFrom: '2026-06-01T00:00:00Z',
+      activeUntil: '2026-08-31T23:59:59Z'
+    },
+    {
+      promoCode: 'FALL10',
+      text: ['10% Off Fall Collection'],
+      separator: '|',
+      activeFrom: '2026-09-01T00:00:00Z',
+      activeUntil: '2026-11-30T23:59:59Z'
+    }
+  ]
+});
+```
+
+## 10) Product List with Filters and Search
+
+```javascript
+const client = await Elements('YOUR_API_KEY', { env: 'production' });
+
+await client.injectProductListSearch({
+  containerId: 'search-box',
+  slug: 'whiskey-collection'
+});
+
+await client.injectProductListFilters({
+  containerId: 'sidebar-filters',
+  slug: 'whiskey-collection',
+  filters: ['price', 'brands', 'sizes', 'fulfillment']
+});
+
+await client.injectProductList({
+  containerId: 'product-grid',
+  slug: 'whiskey-collection',
+  rows: 4,
+  columns: 3,
+  productUrl: '/products/{identifier}'
+});
+```
+
+## 11) Check Product Availability by State
+
+```javascript
+const availability = await window.LiquidCommerce.elements.actions.product
+  .getProductAvailabilityByState(['00619947000020', '08504405135'], 'CA');
+
+console.log('Availability in CA:', availability);
+```
+
 ## Related Docs
 
 - [Events Guide](../guides/events.md)

package/docs/v1/guides/best-practices.md

@@ -188,6 +188,35 @@ document.getElementById('clear-cart-btn').addEventListener('click', async () =>
 });
 ```
 
+## Cleanup
+
+### Destroy Components When Done
+
+In single-page applications, clean up when navigating away:
+
+```javascript
+// Destroy individual component
+const component = client.getInjectedComponents().get('product-1');
+component?.destroy();
+
+// Destroy entire client (on route change)
+client.destroy();
+```
+
+### Avoid Leaking References
+
+```javascript
+// Good - clean up on unmount
+useEffect(() => {
+  const init = async () => {
+    const c = await Elements('KEY', { env: 'production' });
+    clientRef.current = c;
+  };
+  init();
+  return () => clientRef.current?.destroy();
+}, []);
+```
+
 ## Events
 
 ### Use Events for Reactive Updates