@liquidcommerce/elements-sdk 2.6.0-beta.13 → 2.6.0-beta.130

package/dist/types/interfaces/client.interface.d.ts

@@ -0,0 +1,79 @@
+import type { IAddressActions } from '@/core/client/actions/client-address-action.service';
+import type { IAnalyticsActions } from '@/core/client/actions/client-analytics-action.service';
+import type { ICartActions } from '@/core/client/actions/client-cart-action.service';
+import type { ICheckoutActions } from '@/core/client/actions/client-checkout-action.service';
+import type { IProductActions } from '@/core/client/actions/client-product-action.service';
+import type { IClientConfigs } from '@/core/client/client-config.service';
+import type { IAddressOptions } from '@/modules/address/address.interface';
+import type { IInjectedComponent } from './component.interface';
+import type { UpdateAddressComponent, UpdateCartComponent, UpdateCheckoutComponent, UpdateComponentGlobalConfigs, UpdateProductComponent, UpdateProductListComponent } from './configs';
+import type { IBuilderInjectElementParams, IInjectCheckoutBuilderParams, IInjectCheckoutParams, IInjectExpressCheckoutParams, IInjectProductElement, IInjectProductListFiltersParams, IInjectProductListParams, IInjectProductListSearchParams } from './injection.interface';
+export type { IAnalyticsActions };
+export interface ILiquidCommerceElementsUIMethod {
+    cartButton(containerId: string, showItemsCount?: boolean): void;
+    floatingCartButton(showItemsCount?: boolean): void;
+    cartSubtotal(elementId: string): void;
+    cartItemsCount(elementId: string, options?: {
+        hideZero: boolean;
+    }): void;
+}
+export interface ILiquidCommerceElementsActions {
+    product: IProductActions;
+    address: IAddressActions;
+    cart: ICartActions;
+    checkout: ICheckoutActions;
+    analytics: IAnalyticsActions;
+}
+export interface IElementsCheckoutActions extends Omit<ICheckoutActions, 'openCheckout' | 'closeCheckout' | 'toggleCheckout'> {
+}
+export interface IElementsCheckoutClient {
+    injectCheckout: (params: IInjectCheckoutParams) => Promise<IInjectedComponent | null>;
+    injectExpressCheckout: (params: IInjectExpressCheckoutParams) => Promise<IInjectedComponent | null>;
+    actions: {
+        checkout: IElementsCheckoutActions;
+        analytics: IAnalyticsActions;
+    };
+    destroy(): void;
+}
+export 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;
+}
+export 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>;
+    injectExpressCheckoutElement(params: IInjectExpressCheckoutParams): 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;
+}
+export interface ILiquidCommerceElementsCheckoutClient {
+    prepare(): Promise<void>;
+    injectCheckout(params: IInjectCheckoutParams): Promise<IInjectedComponent | null>;
+    actions: {
+        checkout: IElementsCheckoutActions;
+        analytics: IAnalyticsActions;
+    };
+    destroy(): void;
+}
+export type LiquidCommerceElementsClientConstructor = new (clientConfigs: IClientConfigs) => ILiquidCommerceElementsClient;
+export type LiquidCommerceElementsBuilderClientConstructor = new (clientConfigs: IClientConfigs) => ILiquidCommerceElementsBuilderClient;
+export type LiquidCommerceElementsCheckoutClientConstructor = new (clientConfigs: IClientConfigs) => ILiquidCommerceElementsCheckoutClient;

package/dist/types/interfaces/component.interface.d.ts

@@ -0,0 +1,7 @@
+import type { ComponentType } from '@/enums';
+export interface IInjectedComponent {
+    getType(): ComponentType;
+    getElement(): HTMLElement;
+    rerender(): void;
+    destroy(): void;
+}

package/dist/types/interfaces/config.interface.d.ts

@@ -0,0 +1,45 @@
+import type { DebugMode, ElementsEnv } from '@/enums';
+import type { IPromoTicker, UpdateAddressComponent, UpdateCartComponent, UpdateCheckoutComponent, UpdateComponentGlobalConfigs, UpdateProductComponent, UpdateProductListComponent } from './configs';
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+export interface IElementsProxyConfig {
+    baseUrl: string;
+    headers?: Record<string, string>;
+}
+export interface IElementsGTMConfig {
+    gatewayUrl?: string;
+}
+export interface ILiquidCommerceElementsDevelopmentConfig {
+    customApiUrl?: string;
+    openShadowDom?: boolean;
+    mockMode?: boolean;
+    enableExpressCheckout?: boolean;
+}
+export interface IClientCustomThemeConfig {
+    global?: UpdateComponentGlobalConfigs;
+    product?: UpdateProductComponent;
+    address?: UpdateAddressComponent;
+    cart?: UpdateCartComponent;
+    checkout?: UpdateCheckoutComponent;
+    productList?: UpdateProductListComponent;
+}
+export interface ILiquidCommerceElementsCheckoutConfig {
+    pageUrl?: string;
+}
+export interface ILiquidCommerceElementsBaseConfig {
+    env?: ElementsEnv;
+    promoTicker?: IPromoTicker[];
+    customTheme?: IClientCustomThemeConfig;
+    debugMode?: DebugMode;
+    checkout?: ILiquidCommerceElementsCheckoutConfig;
+    proxy?: IElementsProxyConfig;
+    gtm?: IElementsGTMConfig;
+    development?: ILiquidCommerceElementsDevelopmentConfig;
+}
+export interface ILiquidCommerceElementsBuilderConfig extends ILiquidCommerceElementsBaseConfig {
+}
+export interface ILiquidCommerceElementsConfig extends ILiquidCommerceElementsBaseConfig {
+}
+export interface ILiquidCommerceElementsCheckoutClientConfig extends ILiquidCommerceElementsBaseConfig {
+}

package/dist/types/interfaces/configs/address.interface.d.ts

@@ -1,4 +1,4 @@
-import type { DeepPartial } from '@/interfaces/core.interface';
+import type { DeepPartial } from '@/interfaces/config.interface';
 export interface IAddressTheme {
     backgroundColor: string;
 }

package/dist/types/interfaces/configs/cart.interface.d.ts

@@ -1,8 +1,9 @@
-import type { DeepPartial } from '@/interfaces/core.interface';
+import type { DeepPartial } from '@/interfaces/config.interface';
 export interface ICartTheme {
     backgroundColor: string;
 }
 export interface ICartLayout {
+    showShopRetailerButton?: boolean;
     showQuantityCounter: boolean;
     quantityCounterStyle: 'outlined' | 'ghost';
     drawerHeaderText: string;

package/dist/types/interfaces/configs/checkout.interface.d.ts

@@ -1,4 +1,4 @@
-import type { DeepPartial } from '@/interfaces/core.interface';
+import type { DeepPartial } from '@/interfaces/config.interface';
 export interface ICheckoutMarketingOptIn {
     show: boolean;
     checked: boolean;
@@ -12,7 +12,9 @@ export interface ICheckoutLayout {
     emailOptIn: ICheckoutMarketingOptIn;
     smsOptIn: ICheckoutMarketingOptIn;
     allowGiftCards: boolean;
+    requireBirthDate?: boolean;
     legalMessage: ICheckoutLegalMessage;
+    continueShoppingUrl: string;
     exitUrl: string;
     thankYouButtonText: string;
     drawerHeaderText: string;

package/dist/types/interfaces/configs/global.interface.d.ts

@@ -1,9 +1,10 @@
+import type { DeepPartial } from '@/interfaces/config.interface';
 import type { IElementsConfigurations } from '@/interfaces/configs/configurations.interface';
-import type { DeepPartial } from '@/interfaces/core.interface';
 import type { IAddressComponent } from './address.interface';
 import type { ICartComponent } from './cart.interface';
 import type { ICheckoutComponent } from './checkout.interface';
 import type { IProductComponent } from './product.interface';
+import type { IProductListComponent } from './product-list.interface';
 export interface IFontFamily {
     name: string;
     weights: number[];
@@ -22,6 +23,8 @@ export interface IGlobalTheme {
     warningColor: string;
     successColor: string;
     drawerBackgroundColor: string;
+    inputBorderColor?: string;
+    focusRingColor?: string;
 }
 export interface IPromoTicker {
     promoCode: string;
@@ -39,6 +42,8 @@ export interface IGlobalLayout {
     personalizationCardStyle: 'outlined' | 'filled';
     allowPromoCodes: boolean;
     inputFieldStyle: 'outlined' | 'filled';
+    enableOrderedProductSizes: boolean;
+    orderedProductSizes: string[];
     showPoweredBy: boolean;
     poweredByMode: 'light' | 'dark';
 }
@@ -52,9 +57,10 @@ export interface IAllConfigs {
     configurations: IElementsConfigurations;
     global: IComponentGlobalConfigs;
     product: IProductComponent;
+    productList: IProductListComponent;
     address: IAddressComponent;
     cart: ICartComponent;
     checkout: ICheckoutComponent;
 }
-export type ConfigsKeyType = 'all' | 'configurations' | 'global' | 'product' | 'address' | 'cart' | 'checkout';
-export type ConfigsType = IAllConfigs | IElementsConfigurations | IComponentGlobalConfigs | IProductComponent | IAddressComponent | ICartComponent | ICheckoutComponent;
+export type ConfigsKeyType = 'all' | 'configurations' | 'global' | 'product' | 'address' | 'cart' | 'checkout' | 'productList';
+export type ConfigsType = IAllConfigs | IElementsConfigurations | IComponentGlobalConfigs | IProductComponent | IAddressComponent | ICartComponent | ICheckoutComponent | IProductListComponent;

package/dist/types/interfaces/configs/index.d.ts

@@ -4,3 +4,4 @@ export * from './checkout.interface';
 export * from './configurations.interface';
 export * from './global.interface';
 export * from './product.interface';
+export * from './product-list.interface';

package/dist/types/interfaces/configs/product-list.interface.d.ts

@@ -0,0 +1,49 @@
+import type { DeepPartial } from '@/interfaces/config.interface';
+import type { ProductListFilterType } from '@/interfaces/injection.interface';
+export type PLCPresentationModeType = 'drawer' | 'modal';
+export type PLCListType = 'curated' | 'dynamic';
+export type PLCCardStyle = 'card' | 'ghost';
+export type PLCProductUrl = string | Record<string, string>;
+export interface IPLCProductCard {
+    style: PLCCardStyle;
+    cornerRadius: string;
+    showPrice: boolean;
+    showSizes: boolean;
+    showRetailerName: boolean;
+    showFulfillmentOptions: boolean;
+    enableShippingFulfillment: boolean;
+    enableOnDemandFulfillment: boolean;
+    enablePersonalization: boolean;
+    showQuantityCounter: boolean;
+    enablePreCart: boolean;
+    showCollectionTags: boolean;
+    productUrl: PLCProductUrl | null;
+    noAvailabilityText: string;
+}
+export interface IPLCList {
+    type: PLCListType;
+    name: string;
+    slug: string;
+    filters: Record<string, string[]>;
+    productCard: IPLCProductCard;
+    presentationMode: PLCPresentationModeType;
+    availableFilters: ProductListFilterType[];
+    rows: number;
+    columns: number;
+}
+export interface IProductListLayout {
+    lists: IPLCList[];
+}
+export interface IProductListTheme {
+    backgroundColor: string;
+}
+export interface IProductListComponent {
+    theme: IProductListTheme;
+    layout: IProductListLayout;
+}
+export interface UpdateProductListComponent {
+    theme?: DeepPartial<IProductListTheme>;
+    layout?: {
+        lists?: Record<string, DeepPartial<IPLCList>>;
+    };
+}

package/dist/types/interfaces/configs/product.interface.d.ts

@@ -1,16 +1,22 @@
-import type { DeepPartial } from '@/interfaces/core.interface';
+import type { FulfillmentType } from '@/enums';
+import type { DeepPartial } from '@/interfaces/config.interface';
 export type FulfillmentDisplayType = 'carousel' | 'popup';
+export type DescriptionPositionType = 'above' | 'below';
 export interface IProductLayout {
     showImages: boolean;
     showOnlyMainImage: boolean;
     showTitle: boolean;
     showDescription: boolean;
+    descriptionPosition: DescriptionPositionType;
     showQuantityCounter: boolean;
     showOffHours: boolean;
     quantityCounterStyle: 'outlined' | 'ghost';
     fulfillmentDisplay: FulfillmentDisplayType;
     enableShippingFulfillment: boolean;
     enableOnDemandFulfillment: boolean;
+    primaryFulfillmentMethod: FulfillmentType;
+    showOnlyOneRetailer: boolean;
+    hideRetailerName: boolean;
     addToCartButtonText: string;
     addToCartButtonShowTotalPrice: boolean;
     buyNowButtonText: string;

package/dist/types/interfaces/injection.interface.d.ts

@@ -0,0 +1,56 @@
+import type { PRODUCT_LIST_FILTER_TYPES } from '@/constants';
+import type { ComponentType } from '@/enums';
+import type { PLCProductUrl } from '@/interfaces/configs/product-list.interface';
+import type { IAddressOptions } from '@/modules/address/address.interface';
+export interface IInjectProductElement {
+    containerId: string;
+    identifier: string;
+}
+export type ProductListFilterType = (typeof PRODUCT_LIST_FILTER_TYPES)[keyof typeof PRODUCT_LIST_FILTER_TYPES];
+export interface IInjectProductListParams {
+    containerId: string;
+    slug: string;
+    rows?: number;
+    columns?: number;
+    filters?: ProductListFilterType[];
+    productUrl?: PLCProductUrl;
+    productOrder?: string[];
+}
+export interface IInjectProductListSearchParams {
+    containerId: string;
+    slug: string;
+    filters?: ProductListFilterType[];
+}
+export interface IInjectProductListFiltersParams {
+    containerId: string;
+    slug: string;
+    filters?: ProductListFilterType[];
+}
+export interface IBuilderInjectElementParams {
+    type: ComponentType;
+    containerId: string;
+    [key: string]: any;
+}
+export interface IProcessInjectElementParams {
+    type: ComponentType;
+    containerId: string;
+    identifier?: string;
+    options?: IAddressOptions;
+    checkoutId?: string;
+    hideHeader?: boolean;
+    variant?: 'section' | 'buttons';
+}
+export interface IInjectCheckoutParams {
+    containerId: string;
+    checkoutId?: string;
+    hideHeader?: boolean;
+}
+export interface IInjectExpressCheckoutParams {
+    containerId: string;
+    checkoutId?: string;
+    variant?: 'section' | 'buttons';
+}
+export interface IInjectCheckoutBuilderParams extends IInjectCheckoutParams {
+    simulatePresale?: boolean;
+    presaleExpiresInMinutes?: number;
+}

package/dist/types/modules/address/address-display.component.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponent } from '@/core/base-component.service';
+import { BaseComponent, type IOnStoreChanged } from '@/core/base-component.service';
 import type { IAddressComponent } from '@/interfaces/configs';
 import type { IAddressOptions } from './address.interface';
 export interface IAddressDisplayComponentParams {
@@ -8,6 +8,8 @@ export interface IAddressDisplayComponentParams {
 }
 export declare class AddressDisplayComponent extends BaseComponent<IAddressDisplayComponentParams, IAddressComponent> {
     get hostClasses(): string[];
+    private lastAnnouncedAddress;
     constructor();
+    onStoreChanged(changes: IOnStoreChanged[]): boolean | undefined;
     protected template(): HTMLElement[];
 }

package/dist/types/modules/address/address-input.component.d.ts

@@ -12,6 +12,7 @@ export declare class AddressInputComponent extends BaseComponent<IAddressInputCo
     private selectedAddress;
     private searchTimeout?;
     private minSearchLength;
+    private placesSessionToken;
     private inputElement;
     private suggestionsContainer;
     private errorContainer;
@@ -25,10 +26,19 @@ export declare class AddressInputComponent extends BaseComponent<IAddressInputCo
     private handleCancel;
     private handleCheckAvailability;
     private handleSuggestionClick;
-    private handleDocumentClick;
+    private suggestionsStatus;
+    private activeSuggestionIndex;
+    private handleRootClick;
+    private handleFocusOut;
     private searchAddresses;
     private updateErrorDisplay;
     private updateSuggestionsDisplay;
+    private updateSuggestionsStatus;
+    private getSuggestionOptions;
+    private moveActiveSuggestion;
+    private setActiveSuggestion;
+    private isSuggestionListOpen;
+    private handleComboboxKeydown;
     private showSuggestions;
     private hideSuggestions;
     private createElement;

package/dist/types/modules/address/address.command.d.ts

@@ -5,10 +5,11 @@ export declare class AddressCommands extends BaseCommand {
     private cartCommands;
     constructor();
     static getInstance(): AddressCommands;
-    searchAddresses(query: string): Promise<IAddressAutocompleteResult[]>;
-    getAddressDetails(addressId: string): Promise<IAddressDetailsResult>;
+    searchAddresses(query: string, sessionToken?: string): Promise<IAddressAutocompleteResult[]>;
+    getAddressDetails(addressId: string, sessionToken?: string): Promise<IAddressDetailsResult | null>;
     setSelectedAddress(addressData: IAddressData): Promise<void>;
     setAddressManually(address: IAddressAddress, coordinates: IAddressCoordinates): Promise<void>;
     clearSelectedAddress(): Promise<void>;
     getDetails(): IAddressData | null;
+    private buildFormattedAddressString;
 }

package/dist/types/modules/address/styles/register-styles.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/modules/cart/cart.commands.d.ts

@@ -1,5 +1,6 @@
 import { BaseCommand } from '@/core/command/base-command.service';
-import type { IBaseCartEventData } from '@/core/pubsub/interfaces/cart.interface';
+import type { IBaseCartEventData, ICartShopRetailerEventData } from '@/core/pubsub/interfaces/cart.interface';
+import type { ICartStore } from '@/core/store/interfaces/cart.interface';
 export interface AddItemParams {
     fulfillmentId: string;
     partNumber: string;
@@ -8,17 +9,20 @@ export interface AddItemParams {
     identifier: string;
 }
 export declare class CartCommands extends BaseCommand {
-    private readonly uiCommands;
-    private readonly checkoutCommands;
-    private readonly commonCommands;
     constructor();
     static getInstance(): CartCommands;
+    getShopRetailerTarget(fulfillmentId: string): (ICartShopRetailerEventData & {
+        retailerName: string;
+    }) | null;
+    shopRetailer(fulfillmentId: string): void;
     updateItemQuantity(itemId: string, delta: number): Promise<void>;
     removeItem(itemId: string, isNotStandAlone?: boolean): Promise<void>;
     updateItemEngraving(productItemId: string, engravingLines: string[]): Promise<void>;
     addItem(params: AddItemParams): Promise<void>;
-    addPresaleItem(params: AddItemParams): Promise<void>;
     handleGoToCheckout(): Promise<void>;
+    trackViewCart(): void;
+    trackBeginCheckout(cartStore: ICartStore): void;
+    private resolveCheckoutRedirectUrl;
     applyPromoCode(promoCode: string): Promise<void>;
     removePromoCode(): Promise<void>;
     rerenderCart(): void;
@@ -31,4 +35,6 @@ export declare class CartCommands extends BaseCommand {
     private updateFulfillment;
     private addNewFulfillmentAndRetailer;
     private cleanupAfterItemRemoval;
+    private syncCartState;
+    private buildCartLoadedEventData;
 }

package/dist/types/modules/cart/components/cart-body.component.d.ts

@@ -10,6 +10,7 @@ export declare class CartBodyComponent extends BaseComponent<null, ICartComponen
     private getRetailerElementById;
     private getLoadingElement;
     private showEmptyCartState;
+    private preserveDialogFocus;
     private addLoadingOverlay;
     private removeLoadingOverlay;
     private setupEmptyCartListeners;

package/dist/types/modules/cart/components/cart-fulfillment.component.d.ts

@@ -9,6 +9,7 @@ export declare class CartFulfillmentComponent extends BaseComponent<ICartFulfill
     private handleItemsUpdate;
     private setupItemElements;
     private setupMinimumPurchaseAlert;
+    private removeMinimumControl;
     private createLoadingOverlay;
     private hasLoadingOverlay;
     private showLoadingOverlay;
@@ -16,7 +17,6 @@ export declare class CartFulfillmentComponent extends BaseComponent<ICartFulfill
     private isAnyItemUpdating;
     private checkAndUpdateLoadingState;
     onStoreChanged(changes: IOnStoreChanged[]): boolean | undefined;
-    private hasFulfillmentDataChanged;
     protected afterRender(): void;
     protected disconnected(): void;
     protected template(): HTMLElement[];

package/dist/types/modules/cart/components/cart-item-quantity-price.component.d.ts

@@ -7,14 +7,19 @@ export declare class CartItemQuantityPriceComponent extends BaseComponent<ICartI
     private qtyIncreaseButton;
     private qtyDecreaseButton;
     private quantitySpan;
+    private priceElement;
+    private unitPriceElement;
     get hostClasses(): string[];
     constructor();
+    onStoreChanged(changes: IOnStoreChanged[]): boolean;
     onStoreWatch(changes: IOnStoreChanged[]): void;
     private getItemStore;
     private calculateQuantityLimits;
     private getAvailableQuantity;
     private updateButtonStates;
     private handleQuantityChange;
+    private updatePriceText;
+    private applyUnitPrice;
     private createQuantityContainer;
     private createPriceContainer;
     protected template(): HTMLElement[];

package/dist/types/modules/cart/components/cart-item.component.d.ts

@@ -6,6 +6,12 @@ export declare class CartItemComponent extends BaseComponent<ICartItemComponentP
     get hostClasses(): string[];
     get hostAttributes(): Record<string, string>;
     constructor();
+    private lastFocusedKey;
+    private cancelFocusRestore;
+    protected connected(): void;
+    protected disconnected(): void;
+    private readonly handleFocusIn;
+    protected afterRender(): void;
     private handleOpenEngravingForm;
     protected template(): HTMLElement[];
 }

package/dist/types/modules/cart/styles/register-styles.d.ts

@@ -0,0 +1 @@
+export {};