@liquidcommerce/elements-sdk 2.6.0-beta.1 → 2.6.0-beta.100

package/docs/v1/api/injection-methods.md

@@ -0,0 +1,292 @@
+# Injection Methods API
+
+Methods for injecting SDK components into your page.
+
+## injectProductElement()
+
+Inject one or more product displays.
+
+### Signature
+
+```typescript
+injectProductElement(params: IInjectProductElement[]): Promise<IInjectedComponent[]>
+```
+
+### Parameters
+
+```typescript
+interface IInjectProductElement {
+  containerId: string;  // ID of container element
+  identifier: string;   // Product Identifier
+}
+```
+
+### Example
+
+```javascript
+await client.injectProductElement([
+  { containerId: 'product-1', identifier: '00619947000020' },
+  { containerId: 'product-2', identifier: '08504405135' }
+]);
+```
+
+### Returns
+
+Array of injected component objects.
+
+---
+
+## injectAddressElement()
+
+Inject standalone address component.
+
+### Signature
+
+```typescript
+injectAddressElement(
+  containerId: string,
+  options?: IAddressOptions
+): Promise<IInjectedComponent | null>
+```
+
+### Example
+
+```javascript
+await client.injectAddressElement('address-container', {
+  showLabel: true
+});
+
+// Listen for address changes via the published event (dispatched on window)
+window.addEventListener('lce:actions.address_updated', (event) => {
+  console.log('Address set:', event.detail.data);
+});
+```
+
+---
+
+## injectCartElement()
+
+Inject standalone cart (rarely needed - cart drawer is automatic).
+
+### Signature
+
+```typescript
+injectCartElement(containerId: string): Promise<IInjectedComponent | null>
+```
+
+### Example
+
+```javascript
+await client.injectCartElement('cart-container');
+```
+
+---
+
+## injectCheckoutElement()
+
+Inject hosted checkout page.
+
+### Signature
+
+```typescript
+injectCheckoutElement(params: IInjectCheckoutParams): Promise<IInjectedComponent | null>
+```
+
+### Parameters
+
+```typescript
+interface IInjectCheckoutParams {
+  containerId: string;
+  checkoutId?: string;   // Optional checkout token to load
+  hideHeader?: boolean;  // Hide checkout header
+}
+```
+
+### Example
+
+```javascript
+await client.injectCheckoutElement({
+  containerId: 'checkout',
+  checkoutId: 'cart_abc123',
+  hideHeader: false
+});
+```
+
+---
+
+## injectProductList()
+
+Inject product catalog/listing.
+
+### Signature
+
+```typescript
+injectProductList(params: IInjectProductListParams): Promise<void>
+```
+
+### Parameters
+
+```typescript
+interface IInjectProductListParams {
+  containerId: string;
+  slug: string;              // Product list slug identifier
+  rows?: number;             // Default: 4
+  columns?: number;          // Default: 4
+  filters?: ProductListFilterType[];
+  productUrl?: PLCProductUrl;  // string template OR Record<identifier, url> map
+}
+
+// String template: replace {upc} or {grouping} per product.
+// Map: keys are product identifiers (UPC or salsifyGrouping ID); UPC checked first.
+type PLCProductUrl = string | Record<string, string>;
+```
+
+### Example — string template
+
+```javascript
+await client.injectProductList({
+  containerId: 'products',
+  slug: 'best-sellers',
+  rows: 4,
+  columns: 3,
+  filters: ['price', 'brands', 'categories'],
+  productUrl: '/product/{grouping}'
+});
+```
+
+> The `filters` array also acts as the whitelist for **URL query param filtering** —
+> the product list reads `?brands=...&price=...` etc. from `window.location.search`
+> on first mount and applies them. See
+> [URL Query Param Filters](../guides/product-list-component.md#url-query-param-filters).
+
+### Example — URL map (partner-owned dedicated PDPs)
+
+Use this form when each product has a hand-curated URL that can't be derived
+from a single `{upc}` or `{grouping}` token. See the
+[Product List guide](../guides/product-list-component.md#product-url-map) for
+the equivalent declarative `<script type="application/json">` pattern.
+
+```javascript
+await client.injectProductList({
+  containerId: 'products',
+  slug: 'best-sellers',
+  productUrl: {
+    'GROUPING-33277': '/wines/macallan-12-special-edition',
+    '00832889005513': '/spirits/cabernet-2018-club-only',
+  },
+});
+```
+
+---
+
+## injectProductListSearch()
+
+Inject product search box.
+
+### Signature
+
+```typescript
+injectProductListSearch(params: IInjectProductListSearchParams): Promise<void>
+```
+
+### Parameters
+
+```typescript
+interface IInjectProductListSearchParams {
+  containerId: string;
+  slug: string;  // Product list slug identifier
+  filters?: ProductListFilterType[];
+}
+```
+
+### Example
+
+```javascript
+await client.injectProductListSearch({
+  containerId: 'search-box',
+  slug: 'best-sellers'
+});
+```
+
+---
+
+## injectProductListFilters()
+
+Inject product filter panel.
+
+### Signature
+
+```typescript
+injectProductListFilters(params: IInjectProductListFiltersParams): Promise<void>
+```
+
+### Parameters
+
+```typescript
+interface IInjectProductListFiltersParams {
+  containerId: string;
+  slug: string;  // Product list slug identifier
+  filters?: ProductListFilterType[];
+}
+```
+
+### Example
+
+```javascript
+await client.injectProductListFilters({
+  containerId: 'filters',
+  slug: 'best-sellers',
+  filters: ['price', 'brands', 'fulfillment']
+});
+```
+
+---
+
+## Component Management
+
+### getInjectedComponents()
+
+Retrieve all injected components.
+
+```typescript
+getInjectedComponents(): Map<string, IInjectedComponent>
+```
+
+```javascript
+const components = client.getInjectedComponents();
+
+// Get specific component
+const product = components.get('product-1');
+
+// Rerender component
+product.rerender();
+
+// Get container element
+const container = product.getElement();
+
+// Get component type
+const type = product.getType(); // 'product'
+```
+
+### IInjectedComponent Interface
+
+```typescript
+interface IInjectedComponent {
+  getType(): ComponentType;
+  getElement(): HTMLElement;
+  rerender(): void;
+  destroy(): void;
+}
+```
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `getType()` | `ComponentType` | Returns the type of the injected component |
+| `getElement()` | `HTMLElement` | Returns the container element where the component is injected |
+| `rerender()` | `void` | Re-renders the component with the latest data and configurations |
+| `destroy()` | `void` | Removes the component from the DOM and cleans up internal tracking |
+
+## See Also
+
+- [Client API](./client.md)
+- [Component Guides](../guides/)

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

@@ -0,0 +1,423 @@
+# 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;
+}
+```
+
+### ILiquidCommerceElementsBuilderConfig
+
+Same shape as `ILiquidCommerceElementsConfig`, used by `ElementsBuilder()`.
+
+### 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;
+  openShadowDom?: boolean;
+  mockMode?: boolean;  // when true, sends an 'X-Liquid-Api-Mock-Mode' header to receive mock data
+}
+```
+
+### 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
+
+`simulatePresale` and `presaleExpiresInMinutes` are builder-only preview controls (presale lock defaults to 15 minutes) and only take effect via `ElementsBuilder().injectCheckoutElement()`.
+
+```typescript
+interface IInjectCheckoutBuilderParams extends IInjectCheckoutParams {
+  simulatePresale?: boolean;
+  presaleExpiresInMinutes?: number;
+}
+```
+
+### IInjectProductListParams
+
+```typescript
+interface IInjectProductListParams {
+  containerId: string;
+  slug: string;
+  rows?: number;
+  columns?: number;
+  filters?: ProductListFilterType[];
+  productUrl?: PLCProductUrl;
+}
+```
+
+### PLCProductUrl
+
+```typescript
+/**
+ * Product card link configuration.
+ *
+ * - String: template with `{upc}` (selected size's UPC) or `{grouping}`
+ *   (product's salsifyGrouping ID). Replaced per product card.
+ * - Map: keyed by product identifier (UPC or salsifyGrouping ID — same
+ *   identifier types accepted by `injectProductElement`). The card looks up
+ *   UPC first, then grouping ID. Use this when partner PDPs have
+ *   hand-curated URLs that aren't derivable from a single token.
+ */
+type PLCProductUrl = string | Record<string, string>;
+```
+
+### IInjectProductListSearchParams
+
+```typescript
+interface IInjectProductListSearchParams {
+  containerId: string;
+  slug: string;
+  filters?: ProductListFilterType[];
+}
+```
+
+### 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. This is `ICheckoutActions` with `openCheckout`, `closeCheckout`, and `toggleCheckout` omitted -- the checkout-only client renders checkout independently and has no drawer navigation to open, close, or toggle.
+
+```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>>;
+  };
+}
+```
+
+These `Update*Component` types are the arguments to the `ElementsBuilder()` client's `update*Component` methods; see [Client API](./client.md) for their behavior and usage.
+
+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