@liquidcommerce/elements-sdk 2.4.0 → 2.4.2

package/dist/types/core/client/client-action.service.d.ts

@@ -1,4 +1,4 @@
-import type { IBaseCartEventData, IBaseProductEventData, ICheckoutDetails } from '@/core/pubsub';
+import type { IBaseCartEventData, IBaseProductEventData, ICheckoutDetailsEventData } from '@/core/pubsub';
 import { type FulfillmentType } from '@/enums';
 import type { IAddress, ICoords } from '@/interfaces/cloud';
 import type { IAddressData } from '@/modules/address';
@@ -32,6 +32,7 @@ export interface ICheckoutActions {
     closeCheckout: () => void;
     toggleCheckout: () => void;
     addProduct: (params: IAddProductParams[], openCheckout?: boolean) => Promise<void>;
+    addPresaleProduct: (params: IAddProductParams) => Promise<void>;
     applyPromoCode: (promoCode: string) => Promise<void>;
     removePromoCode: () => Promise<void>;
     applyGiftCard: (code: string) => Promise<void>;
@@ -42,7 +43,7 @@ export interface ICheckoutActions {
     updateCustomerInfo: (params: Record<CustomerFieldName, string>) => void;
     updateBillingInfo: (params: Record<BillingFieldName, string>) => void;
     updateGiftInfo: (params: Record<GiftFieldName, string>) => void;
-    getDetails: () => ICheckoutDetails;
+    getDetails: () => ICheckoutDetailsEventData;
 }
 export declare class ClientActionService {
     private readonly pubSub;

package/dist/types/core/pubsub/interfaces/cart.interface.d.ts

@@ -55,6 +55,7 @@ export interface IBaseCartEventData {
         subtotal: number;
         total: number;
     };
+    itemCount: number;
     updatedAt: string;
     createdAt: string;
 }

package/dist/types/core/pubsub/interfaces/checkout.interface.d.ts

@@ -1,5 +1,4 @@
-import type { ICheckoutItemStore } from '@/core/store';
-import type { ICheckoutTotalAmounts } from '@/interfaces/cloud';
+import type { ICartItemAttributes, ICheckoutTotalAmounts } from '@/interfaces/cloud';
 export interface IBaseCheckoutEventData {
     cartId: string;
 }
@@ -67,18 +66,59 @@ export interface ICheckoutGiftCardFailedEventData {
 export interface ICheckoutProductAddEventData {
     itemsAdded: number;
     identifiers: string[];
+    isPresale?: boolean;
 }
 export interface ICheckoutProductAddFailedEventData {
     identifiers: string[];
     error: string;
+    isPresale?: boolean;
 }
-export interface ICheckoutDetails {
+export interface ICheckoutItemEventData {
+    liquidId: string;
+    variantId: string;
+    cartItemId: string;
+    retailerId: string;
+    fulfillmentId: string;
+    salsifyGrouping: string;
+    name: string;
+    catPath: string;
+    volume: string;
+    uom: string;
+    proof: string;
+    abv: string;
+    containerType: string;
+    container: string;
+    size: string;
+    pack: boolean;
+    packDesc: string;
+    mainImage: string;
+    brand: string;
+    partNumber: string;
+    upc: string;
+    sku: string;
+    price: number;
+    unitPrice: number;
+    quantity: number;
+    unitTax: number;
+    bottleDeposits: number;
+    attributes: ICartItemAttributes;
+    retailerName: string;
+    expectationDetail: string;
+}
+export interface ICheckoutDetailsEventData {
     cartId: string;
-    amounts: ICheckoutTotalAmounts;
-    items: Record<string, Omit<ICheckoutItemStore, 'attributes'>>;
-    isGift: boolean;
+    acceptedAccountCreation: boolean;
     hasAgeVerify: boolean;
+    hasSubstitutionPolicy: boolean;
+    isGift: boolean;
+    billingSameAsShipping: boolean;
+    marketingPreferences: {
+        canEmail: boolean;
+        canSms: boolean;
+    };
     hasPromoCode: boolean;
     hasGiftCards: boolean;
+    amounts: ICheckoutTotalAmounts;
     itemCount: number;
+    items: Record<string, ICheckoutItemEventData>;
 }

package/dist/types/core/pubsub/interfaces/product.interface.d.ts

@@ -9,6 +9,8 @@ export interface IElementsClientIsReadyEventData {
 export interface IBaseProductFulfillmentEventData {
     price: number;
     partNumber: string;
+    stock: number;
+    isEngravable: boolean;
     fulfillmentId: string;
     fulfillmentType: FulfillmentType;
     modalities: FulfillmentType[];
@@ -17,6 +19,23 @@ export interface IBaseProductFulfillmentEventData {
     retailerAddress: (IAddress & ICoords) | null;
     retailerTimezone: string;
 }
+export interface IBaseProductSizeAttributesEventData {
+    engraving?: {
+        status: boolean;
+        maxLines: number;
+        maxCharsPerLine: number;
+        fee: number;
+        location: string;
+    };
+    presale?: {
+        canPurchaseOn: null | string;
+        estimatedShipBy: null | string;
+        isActive: boolean;
+        language: string;
+        presaleLimit: number;
+        price: number;
+    };
+}
 export interface IBaseProductSizeEventData {
     id: string;
     upc: string;
@@ -29,17 +48,40 @@ export interface IBaseProductSizeEventData {
     image: string;
     uom: string;
     volume: string;
+    attributes: IBaseProductSizeAttributesEventData;
     shippingFulfillments: Record<string, IBaseProductFulfillmentEventData>;
     onDemandFulfillments: Record<string, IBaseProductFulfillmentEventData>;
 }
 export interface IBaseProductEventData {
     identifier: string;
+    selectedSizeId: string | null;
+    selectedFulfillmentId: string | null;
+    selectedFulfillmentType: FulfillmentType;
     id: string;
     name: string;
     brand: string;
-    category: string;
     catPath: string;
+    category: string;
     classification: string;
+    type: string;
+    salsifyGrouping: string;
+    subType: string;
+    mainImage: string | null;
+    images: string[];
+    region: string;
+    country: string;
+    material: string;
+    abv: string;
+    proof: string;
+    age: string;
+    color: string;
+    flavor: string;
+    variety: string;
+    appellation: string;
+    vintage: string;
+    description: string;
+    htmlDescription: string;
+    tastingNotes: string;
     priceInfo: {
         min: number;
         max: number;

package/dist/types/core/singleton-manager.service.d.ts

@@ -1,12 +1,12 @@
 import type { IClientConfigs } from '@/core/client/client-config.service';
-import type { LiquidCommerceElementsClientConstructor } from '@/interfaces/core.interface';
+import type { LiquidCommerceElementsBuilderClientConstructor, LiquidCommerceElementsClientConstructor } from '@/interfaces/core.interface';
 export declare class SingletonManager {
     private static instances;
     private static clientConstructor;
     private static getInstances;
     private constructor();
-    static setClientConstructor(lceConstructor: LiquidCommerceElementsClientConstructor): void;
-    static getClientConstructor(): LiquidCommerceElementsClientConstructor | null;
+    static setClientConstructor(lceConstructor: LiquidCommerceElementsClientConstructor | LiquidCommerceElementsBuilderClientConstructor): void;
+    static getClientConstructor(): LiquidCommerceElementsClientConstructor | LiquidCommerceElementsBuilderClientConstructor | null;
     static getClassInstance<T>(className: string, instanceCreator: () => T): T;
     static getClient<T>(clientConfigs: IClientConfigs): Promise<T>;
 }

package/dist/types/core/store/interfaces/cart.interface.d.ts

@@ -36,6 +36,7 @@ export interface ICartTotalsStore {
     total: number;
     shippingFee: number;
     platformFee: number;
+    giftCardTotal: number;
     engravingFee: number;
     deliveryFee: number;
     discounts: number;

package/dist/types/core/store/interfaces/product.interface.d.ts

@@ -49,20 +49,33 @@ export interface IProductStore {
     id: string;
     name: string;
     brand: string;
-    category: string;
     catPath: string;
+    category: string;
     classification: string;
     type: string;
-    subType: string;
     salsifyGrouping: string;
+    subType: string;
+    mainImage: string | null;
+    images: string[];
+    region: string;
+    country: string;
+    material: string;
+    abv: string;
+    proof: string;
+    age: string;
+    color: string;
+    flavor: string;
+    variety: string;
+    appellation: string;
+    vintage: string;
+    description: string;
+    htmlDescription: string;
+    tastingNotes: string;
     priceInfo?: {
         min: number;
         max: number;
         avg: number;
     };
-    description: string;
-    htmlDescription: string;
-    images: string[];
     quantity: number;
     sizes: Record<string, IProductSizeStore>;
     productHasAvailability: boolean;
@@ -76,5 +89,4 @@ export interface IProductStore {
     error: string | null;
     drawer: IProductDrawerStore;
     rerender: boolean;
-    mainImage: string | null;
 }

package/dist/types/elements-base-client.d.ts

@@ -0,0 +1,49 @@
+import { AuthService } from '@/core/auth.service';
+import { ClientActionService } from '@/core/client/client-action.service';
+import { ClientConfigService, type IClientConfigs } from '@/core/client/client-config.service';
+import { CommandService } from '@/core/command/command.service';
+import { DebugPanelService } from '@/core/debug-panel/debug-panel.service';
+import { FingerPrintService } from '@/core/fingerprint.service';
+import { GoogleTagManagerService } from '@/core/google-tag-manager.service';
+import { LoggerFactory } from '@/core/logger/logger-factory';
+import { StoreService } from '@/core/store';
+import { TelemetryService } from '@/core/telemetry/telemetry.service';
+import { type ComponentType } from '@/enums';
+import type { IInjectedComponent, ILiquidCommerceElementsActions, IProcessInjectElementParams } from '@/interfaces/core.interface';
+import { ApiClientService } from '@/modules/api-client';
+import { ThemeProviderService } from '@/modules/theme-provider';
+export declare abstract class ElementsBaseClient {
+    protected readonly authService: AuthService;
+    protected readonly clientConfig: ClientConfigService;
+    protected readonly store: StoreService;
+    protected readonly commands: CommandService;
+    protected readonly apiClient: ApiClientService;
+    protected readonly themeProvider: ThemeProviderService;
+    protected readonly fingerPrintService: FingerPrintService;
+    protected readonly googleTagManager: GoogleTagManagerService;
+    protected readonly clientAction: ClientActionService;
+    protected readonly telemetry: TelemetryService;
+    protected readonly debugPanel: DebugPanelService;
+    protected readonly logger: ReturnType<typeof LoggerFactory.get>;
+    protected clientPrepared: boolean;
+    protected componentFactoryInitialized: boolean;
+    protected cartDrawerCreated: boolean;
+    protected gtmInitialized: boolean;
+    protected injectedComponents: Map<string, IInjectedComponent>;
+    constructor(clientConfigs: IClientConfigs);
+    prepare(): Promise<void>;
+    private prepareEssentialServices;
+    private deferHeavyInitialization;
+    private initializeHeavyServices;
+    get actions(): ILiquidCommerceElementsActions;
+    protected processInjectElement(params: IProcessInjectElementParams): Promise<IInjectedComponent | null>;
+    protected ensureCartDrawerExists(): void;
+    protected ensureAllComponentsRegistered(): void;
+    protected createInjectedComponentWrapper(containerId: string, type: ComponentType, element: HTMLElement): IInjectedComponent;
+    protected rerenderInjectedComponentsByType(type: ComponentType): void;
+    protected isElementsEnabled(): boolean;
+    protected injectDisabledElementsError(containerId: string, componentName: ComponentType): void;
+    private registerEssentialComponents;
+    protected registerComponents(): void;
+    protected registerAllComponents(): void;
+}

package/dist/types/elements-builder-client.d.ts

@@ -0,0 +1,2 @@
+import type { ILiquidCommerceElementsBuilderClient, ILiquidCommerceElementsBuilderConfig } from '@/interfaces/core.interface';
+export declare function ElementsBuilder(apiKey: string, config: ILiquidCommerceElementsBuilderConfig): Promise<ILiquidCommerceElementsBuilderClient | null>;

package/dist/types/elements-client-helper.d.ts

@@ -1 +1,4 @@
+import { type ComponentType } from '@/enums';
 export declare function deepMergeConfigs<T extends Record<string, any>>(target: T, source: Partial<T>): T;
+export declare const layoutFieldToComponentTypes: Map<string, ComponentType[]>;
+export declare function getComponentTypesForLayoutFields(parentPath: string, layoutFields: Record<string, any>): ComponentType[];

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from './elements-builder-client';
 export * from './elements-client';
 export * from './enums';
 export * from './interfaces/configs';

package/dist/types/index.umd.d.ts

@@ -1,2 +1,2 @@
-import { Elements } from './index';
-export { Elements };
+import { Elements, ElementsBuilder } from './index';
+export { Elements, ElementsBuilder };

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

@@ -153,4 +153,6 @@ export interface IProductPresale {
     estimatedShipBy: null | string;
     isActive: boolean;
     language: string;
+    presaleLimit: number;
+    price: number;
 }

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

@@ -18,6 +18,7 @@ export interface ICheckoutLayout {
     drawerHeaderText: string;
     placeOrderButtonText: string;
     placeOrderButtonShowRequiredFields: boolean;
+    checkoutCompleted: ICheckoutCompleted;
 }
 export interface ICheckoutCompleted {
     customLogo: string;
@@ -25,7 +26,6 @@ export interface ICheckoutCompleted {
 }
 export interface ICheckoutTheme {
     backgroundColor: string;
-    checkoutCompleted: ICheckoutCompleted;
 }
 export interface ICheckoutComponent {
     theme: ICheckoutTheme;

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

@@ -17,12 +17,17 @@ export interface IClientCustomThemeConfig {
     cart?: UpdateCartComponent;
     checkout?: UpdateCheckoutComponent;
 }
+export interface ILiquidCommerceElementsBuilderConfig {
+    env?: ElementsEnv;
+    promoTicker?: IPromoTicker[];
+    customTheme?: IClientCustomThemeConfig;
+    debugMode?: DebugMode;
+}
 export interface ILiquidCommerceElementsConfig {
     env?: ElementsEnv;
     promoTicker?: IPromoTicker[];
     customTheme?: IClientCustomThemeConfig;
     proxy?: IElementsProxyConfig;
-    isBuilder?: boolean;
     debugMode?: DebugMode;
 }
 export interface IInjectProductElement {
@@ -34,17 +39,10 @@ export interface IBuilderInjectElementParams {
     containerId: string;
     [key: string]: any;
 }
-export interface ILiquidCommerceElementsBuilderMethod {
-    updateComponentGlobalConfigs(configs: UpdateComponentGlobalConfigs): Promise<void>;
-    updateProductComponent(configs: UpdateProductComponent): Promise<void>;
-    updateAddressComponent(configs: UpdateAddressComponent): void;
-    updateCartComponent(configs: UpdateCartComponent): void;
-    updateCheckoutComponent(configs: UpdateCheckoutComponent): void;
-    injectElement(params: IBuilderInjectElementParams): Promise<void>;
-    injectProductElement(params: IInjectProductElement[]): Promise<void>;
-    injectAddressElement(containerId: string, options?: IAddressOptions): Promise<void>;
-    injectCartElement(containerId: string): Promise<void>;
-    injectCheckoutElement(containerId: string): Promise<void>;
+export interface IInjectedComponent {
+    getType(): ComponentType;
+    getElement(): HTMLElement;
+    rerender(): void;
 }
 export interface IProcessInjectElementParams {
     type: ComponentType;
@@ -64,13 +62,30 @@ export interface ILiquidCommerceElementsActions {
     cart: ICartActions;
     checkout: ICheckoutActions;
 }
+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;
+    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(containerId: string, options?: {
+        simulatePresale?: boolean;
+        presaleExpiresInMinutes?: number;
+    }): Promise<IInjectedComponent | null>;
+    actions: ILiquidCommerceElementsActions;
+}
 export interface ILiquidCommerceElementsClient {
-    builder: ILiquidCommerceElementsBuilderMethod;
-    injectProductElement(params: IInjectProductElement[]): Promise<void>;
-    injectAddressElement(containerId: string, options?: IAddressOptions): Promise<void>;
-    injectCartElement(containerId: string): Promise<void>;
-    injectCheckoutElement(containerId: string): Promise<void>;
+    injectProductElement(params: IInjectProductElement[]): Promise<IInjectedComponent[]>;
+    injectAddressElement(containerId: string, options?: IAddressOptions): Promise<IInjectedComponent | null>;
+    injectCartElement(containerId: string): Promise<IInjectedComponent | null>;
+    injectCheckoutElement(containerId: string): Promise<IInjectedComponent | null>;
     ui: ILiquidCommerceElementsUIMethod;
     actions: ILiquidCommerceElementsActions;
+    getInjectedComponents(): Map<string, IInjectedComponent>;
 }
 export type LiquidCommerceElementsClientConstructor = new (clientConfigs: IClientConfigs) => ILiquidCommerceElementsClient;
+export type LiquidCommerceElementsBuilderClientConstructor = new (clientConfigs: IClientConfigs) => ILiquidCommerceElementsBuilderClient;

package/dist/types/modules/cart/components/index.d.ts

@@ -1,5 +1,7 @@
 export * from './cart-body.component';
 export * from './cart-footer.component';
+export * from './cart-fulfillment.component';
+export * from './cart-fulfillment.component';
 export * from './cart-header.component';
 export * from './cart-item.component';
 export * from './cart-item-quantity-price.component';

package/dist/types/modules/theme-provider/services/font-manager.service.d.ts

@@ -2,6 +2,7 @@ import type { IFontFamily } from '@/interfaces/configs';
 export declare class FontManagerService {
     private googleFontsUrl;
     private defaultFontFamilies;
+    private readonly fontsLinkAttribute;
     loadGoogleFonts(fonts: IFontFamily[], globalDisplay?: string): void;
     updateGoogleFonts(fonts: IFontFamily[], globalDisplay?: string): void;
     private injectGoogleFontsResourceHints;

package/dist/types/modules/ui-components/lce-element/lce-element.component.d.ts

@@ -2,8 +2,10 @@ import type { ComponentType } from '@/enums';
 export declare class LceElementComponent extends HTMLElement {
     private _initialized;
     protected _container: ShadowRoot | null;
+    private _wrappedComponentRerender;
     constructor();
     initialize(contentType: ComponentType, contentElement: HTMLElement): void;
+    rerender(context?: string): void;
     private applyBasicStyles;
     private isCSSStyleSheetSupported;
     private applyThemeStyles;