@liquidcommerce/elements-sdk 2.6.0-beta.3 → 2.6.0-beta.30

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

@@ -10,7 +10,7 @@ import { LoggerFactory } from '@/core/logger/logger-factory';
 import { StoreService } from '@/core/store/store.service';
 import { TelemetryService } from '@/core/telemetry/telemetry.service';
 import { type ComponentType } from '@/enums';
-import type { IInjectedComponent, IInjectProductElement, IInjectProductListParams, ILiquidCommerceElementsActions, IProcessInjectElementParams } from '@/interfaces/core.interface';
+import type { IInjectProductElement, IInjectProductListFiltersParams, IInjectProductListParams, IInjectProductListSearchParams, IInjectedComponent, ILiquidCommerceElementsActions, IProcessInjectElementParams } from '@/interfaces/core.interface';
 import { ThemeProviderService } from '@/modules/theme-provider/theme-provider.service';
 export declare abstract class ElementsBaseClient {
     protected readonly authClient: AuthClientService;
@@ -28,6 +28,7 @@ export declare abstract class ElementsBaseClient {
     protected clientPrepared: boolean;
     protected componentFactoryInitialized: boolean;
     protected cartDrawerCreated: boolean;
+    protected modalCreated: boolean;
     protected injectedComponents: Map<string, IInjectedComponent>;
     constructor(clientConfigs: IClientConfigs);
     prepare(): Promise<void>;
@@ -38,7 +39,10 @@ export declare abstract class ElementsBaseClient {
     protected processInjectElement(params: IProcessInjectElementParams): Promise<IInjectedComponent | null>;
     protected processInjectProduct(params: IInjectProductElement[]): Promise<IInjectedComponent[]>;
     injectProductList(params: IInjectProductListParams): Promise<void>;
+    injectProductListSearch(params: IInjectProductListSearchParams): Promise<void>;
+    injectProductListFilters(params: IInjectProductListFiltersParams): Promise<void>;
     protected ensureCartDrawerExists(): void;
+    protected ensureModalExists(): void;
     protected ensureAllComponentsRegistered(): void;
     protected createInjectedComponentWrapper(containerId: string, type: ComponentType, element: HTMLElement): IInjectedComponent;
     protected rerenderInjectedComponentsByType(type: ComponentType): void;

package/dist/types/enums/core.enum.d.ts

@@ -32,6 +32,7 @@ export declare const ELEMENTS_ACTIONS_EVENT: {
     readonly CART_PROMO_CODE_FAILED: "cart_promo_code_failed";
     readonly CART_PRODUCT_ADD_SUCCESS: "cart_product_add_success";
     readonly CART_PRODUCT_ADD_FAILED: "cart_product_add_failed";
+    readonly INTERNAL_CART_TO_CHECKOUT: "internal_cart_to_checkout";
     readonly CHECKOUT_LOADED: "checkout_loaded";
     readonly CHECKOUT_OPENED: "checkout_opened";
     readonly CHECKOUT_CLOSED: "checkout_closed";
@@ -67,7 +68,6 @@ export declare const ELEMENTS_FORM: {
 export declare const COMPONENT_TYPE: {
     readonly DRAWER: "drawer";
     readonly INPUT: "input";
-    readonly BIRTHDATE_INPUT: "birthdate-input";
     readonly ENGRAVING_FORM: "engraving-form";
     readonly ENGRAVING_VIEW: "engraving-view";
     readonly BUTTONS_CART_OPEN: "buttons-cart-open";
@@ -76,6 +76,7 @@ export declare const COMPONENT_TYPE: {
     readonly PURCHASE_MIN_ALERT: "purchase-min-alert";
     readonly ALERT: "alert";
     readonly PROMO_CODE_TICKER: "promo-code-ticker";
+    readonly MODAL: "modal";
     readonly ADDRESS: "address";
     readonly ADDRESS_INPUT: "address-input";
     readonly ADDRESS_DISPLAY: "address-display";
@@ -97,6 +98,7 @@ export declare const COMPONENT_TYPE: {
     readonly PRODUCT_LIST_FILTERS: "product-list-filters";
     readonly PRODUCT_LIST_SEARCH: "product-list-search";
     readonly PRODUCT_LIST_CARD_LOADING: "product-list-card-loading";
+    readonly PRODUCT_LIST_RETAILERS: "product-list-retailers";
     readonly CART: "cart";
     readonly CART_RETAILER: "cart-retailer";
     readonly CART_ITEM: "cart-item";
@@ -146,3 +148,26 @@ export declare const DEBUG_MODE: {
     readonly PANEL: "panel";
 };
 export type DebugMode = (typeof DEBUG_MODE)[keyof typeof DEBUG_MODE];
+export declare const CART_EVENT_TYPE: {
+    readonly GENERIC: "generic";
+    readonly PROMO_CODE: "promo-code";
+};
+export type CartEventType = (typeof CART_EVENT_TYPE)[keyof typeof CART_EVENT_TYPE];
+export declare const CART_EVENT_LEVEL: {
+    readonly SUCCESS: "success";
+    readonly WARNING: "warning";
+    readonly ERROR: "error";
+};
+export type CartEventLevel = (typeof CART_EVENT_LEVEL)[keyof typeof CART_EVENT_LEVEL];
+export declare const CHECKOUT_EVENT_TYPE: {
+    readonly GENERIC: "generic";
+    readonly PROMO_CODE: "promo-code";
+    readonly GIFT_CARD: "gift-card";
+};
+export type CheckoutEventType = (typeof CHECKOUT_EVENT_TYPE)[keyof typeof CHECKOUT_EVENT_TYPE];
+export declare const CHECKOUT_EVENT_LEVEL: {
+    readonly SUCCESS: "success";
+    readonly WARNING: "warning";
+    readonly ERROR: "error";
+};
+export type CheckoutEventLevel = (typeof CHECKOUT_EVENT_LEVEL)[keyof typeof CHECKOUT_EVENT_LEVEL];

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

@@ -1,2 +1 @@
-export * from './cloud.enum';
 export * from './core.enum';

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

@@ -0,0 +1,28 @@
+import type { IAddressStore } from '@/core/store/interfaces/address.interface';
+export interface IAddressAutocompleteResult {
+    id: string;
+    description: string;
+}
+export interface IAddressCoordinates {
+    latitude: number;
+    longitude: number;
+}
+export interface IAddressAddress {
+    one: string;
+    two: string;
+    city: string;
+    state: string;
+    zip: string;
+    country: string;
+}
+export interface IAddressDetailsResult {
+    formattedAddress: string;
+    address: IAddressAddress;
+    coordinates: IAddressCoordinates;
+}
+export interface ILocation {
+    address: IAddressAddress;
+    coordinates: IAddressCoordinates;
+}
+export interface IAddressData extends IAddressStore {
+}

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

@@ -0,0 +1,95 @@
+import type { CartEventLevel, CartEventType, FulfillmentType } from '@/enums';
+import type { ILocation } from '@/interfaces/api/address.interface';
+import type { IProductPresale } from '@/interfaces/api/product.interface';
+export interface ICartUpdateItem {
+    id?: string;
+    partNumber: string;
+    quantity: number;
+    fulfillmentId: string;
+    engravingLines?: string[];
+}
+export interface ICartUpdateParams {
+    id: string;
+    items: ICartUpdateItem[];
+    promoCode?: string;
+    location?: ILocation;
+}
+export interface ICartFulfillment {
+    id: string;
+    canEngrave: boolean;
+    type: FulfillmentType;
+    expectation: string;
+    engravingExpectation: string;
+    itemIds: string[];
+    subtotal: number;
+    hasUnmetMinimumPurchaseAmount: boolean;
+    minimumPurchaseAmount: number;
+}
+export interface ICartRetailer {
+    id: string;
+    name: string;
+    subtotal: number;
+    itemsQuantity: number;
+    fulfillments: Record<string, ICartFulfillment>;
+}
+export interface ICartItemAttributes {
+    engraving: ICartItemEngraving;
+    presale: IProductPresale;
+}
+export interface ICartItem {
+    id: string;
+    variantId: string;
+    liquidId: string;
+    retailerId: string;
+    partNumber: string;
+    fulfillmentId: string;
+    upc: string;
+    sku: string;
+    salsifyGrouping: string;
+    catPath: string;
+    volume: string;
+    uom: string;
+    pack: boolean;
+    packDesc: string;
+    container: string;
+    containerType: string;
+    name: string;
+    brand: string;
+    size: string;
+    price: number;
+    quantity: number;
+    maxQuantity: number;
+    unitPrice: number;
+    mainImage: string;
+    attributes: ICartItemAttributes;
+}
+export interface ICartPromoCode {
+    code: string;
+    discount: number;
+    freeDelivery: boolean;
+    freeServiceFee: boolean;
+    freeShipping: boolean;
+}
+export interface ICartEvent {
+    type: CartEventType;
+    message: string;
+    level: CartEventLevel;
+}
+export interface ICart {
+    id: string;
+    subtotal: number;
+    itemsQuantity: number;
+    items: Record<string, ICartItem>;
+    retailers: Record<string, ICartRetailer>;
+    promoCode: ICartPromoCode | null;
+    events: ICartEvent[];
+}
+export interface ICartItemEngraving {
+    isEngravable: boolean;
+    hasEngraving: boolean;
+    fee: number;
+    maxCharsPerLine: number;
+    maxLines: number;
+    location: string;
+    lines: string[];
+}

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

@@ -0,0 +1,216 @@
+import type { CheckoutEventLevel, CheckoutEventType, FulfillmentType } from '@/enums';
+import type { IAddressAddress, IAddressCoordinates, ILocation } from '@/interfaces/api/address.interface';
+import type { ICart } from '@/interfaces/api/cart.interface';
+import type { IProductPresale } from '@/interfaces/api/product.interface';
+export interface ICheckoutComplete {
+    orderNumber: string;
+}
+export interface ICheckoutPaymentSession {
+    key: string;
+    secret: string;
+}
+export interface ICheckoutPaymentConfirmParams {
+    confirmationTokenId: string;
+    setupIntentId: string;
+}
+export interface ICheckoutPaymentConfirmCard {
+    brand: string;
+    expMonth: string;
+    expYear: string;
+    last4: string;
+}
+export interface ICheckoutPaymentConfirm {
+    id: string;
+    card: ICheckoutPaymentConfirmCard;
+}
+export interface ICheckoutCustomer {
+    email: string;
+    firstName: string;
+    lastName: string;
+    company: string;
+    phone: string;
+    birthDate: string;
+}
+export interface ICheckoutBilling {
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone: string;
+    company: string;
+    one: string;
+    two: string;
+    city: string;
+    state: string;
+    zip: string;
+}
+export interface ICheckoutGiftRecipient {
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone: string;
+    message: string;
+}
+export interface ICheckoutMarketingPreferences {
+    canEmail: boolean;
+    canSms: boolean;
+}
+export interface ICheckoutDeliveryTip {
+    fulfillmentId: string;
+    tip: number;
+}
+export interface ICheckoutDeliveryInstructions {
+    fulfillmentId: string;
+    instructions: string;
+}
+export interface ICheckoutPrepareParams {
+    cartId: string;
+    customer?: ICheckoutCustomer;
+    shippingAddressTwo?: string;
+    billingAddress?: ICheckoutBilling;
+    isGift?: boolean;
+    billingSameAsShipping?: boolean;
+    giftOptions?: ICheckoutGiftRecipient;
+    marketingPreferences?: ICheckoutMarketingPreferences;
+    deliveryTips?: ICheckoutDeliveryTip[];
+    deliveryInstructions?: ICheckoutDeliveryInstructions[];
+    payment?: string;
+    promoCode?: string;
+    giftCards?: string[];
+}
+export interface ICheckoutUpdateItem {
+    id?: string;
+    partNumber: string;
+    quantity: number;
+    fulfillmentId: string;
+    engravingLines?: string[];
+}
+export interface ICheckoutItemsUpdateParams {
+    cartId: string;
+    items: ICheckoutUpdateItem[];
+    location?: ILocation;
+}
+export interface ICheckoutItemsUpdateResponse {
+    cart: ICart;
+    checkout: ICheckoutPrepare;
+}
+export interface ICheckoutAmounts {
+    subtotal: number;
+    engraving: number;
+    service: number;
+    shipping: number;
+    delivery: number;
+    platform: number;
+    discounts: number;
+    giftCards: number;
+    tax: number;
+    tip: number;
+    total: number;
+}
+export interface ICheckoutPromoCode {
+    code: string;
+    discount: number;
+    freeDelivery: boolean;
+    freeServiceFee: boolean;
+    freeShipping: boolean;
+}
+export interface ICheckoutGiftCard {
+    code: string;
+    applied: number;
+}
+export interface ICheckoutShippingAddress {
+    formattedAddress: string;
+    address: IAddressAddress;
+    coordinates: IAddressCoordinates;
+}
+export interface ICheckoutItemEngraving {
+    isEngravable: boolean;
+    hasEngraving: boolean;
+    fee: number;
+    maxCharsPerLine: number;
+    maxLines: number;
+    location: string;
+    lines: string[];
+}
+export interface ICheckoutItemAttributes {
+    engraving: ICheckoutItemEngraving;
+    presale: IProductPresale;
+}
+export interface ICheckoutItem {
+    variantId: string;
+    cartItemId: string;
+    liquidId: string;
+    retailerId: string;
+    fulfillmentId: string;
+    salsifyPid?: 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;
+    tax: number;
+    unitTax: number;
+    bottleDeposits: number;
+    attributes: ICheckoutItemAttributes;
+}
+export interface ICheckoutFulfillment {
+    id: string;
+    deliveryInstructions: string;
+    type: FulfillmentType;
+    expectation: string;
+    engravingExpectation: string;
+    itemIds: string[];
+    doesAllowPromos: boolean;
+    doesAllowGiftCards: boolean;
+    amounts: ICheckoutAmounts;
+    itemsQuantity: number;
+}
+export interface ICheckoutRetailer {
+    id: string;
+    name: string;
+    fulfillments: Record<string, ICheckoutFulfillment>;
+    amounts: ICheckoutAmounts;
+}
+export interface ICheckoutPresale {
+    isLocked: boolean;
+    expiresAt: string;
+}
+export interface ICheckoutEvent {
+    type: CheckoutEventType;
+    message: string;
+    level: CheckoutEventLevel;
+}
+export interface ICheckoutPrepare {
+    token: string;
+    cartId: string;
+    customer: ICheckoutCustomer;
+    isGift: boolean;
+    billingSameAsShipping: boolean;
+    payment?: string;
+    giftOptions: ICheckoutGiftRecipient;
+    marketingPreferences: ICheckoutMarketingPreferences;
+    shippingAddress: ICheckoutShippingAddress;
+    billingAddress: ICheckoutBilling;
+    promoCode: ICheckoutPromoCode | null;
+    amounts: ICheckoutAmounts;
+    giftCards: ICheckoutGiftCard[];
+    presale: ICheckoutPresale | null;
+    itemsQuantity: number;
+    items: Record<string, ICheckoutItem>;
+    retailers: Record<string, ICheckoutRetailer>;
+    events: ICheckoutEvent[];
+}

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

@@ -0,0 +1,38 @@
+import type { FILTER_KEYS } from 'modules/product-list/product-list.constants';
+import type { ILocation } from '@/interfaces/api/address.interface';
+import type { IProductAvailabilityResponse } from '@/interfaces/api/product.interface';
+export interface IProductSearchParams {
+    location?: ILocation;
+    search?: string;
+    pageToken?: string;
+    page?: number;
+    perPage?: number;
+    filters?: IFilterParams[];
+}
+export type IFilterParamsValue = string | string[] | {
+    min?: string | number;
+    max?: string | number;
+} | boolean;
+export interface IFilterParams {
+    key: string;
+    values: IFilterParamsValue;
+}
+export type FacetFilterKeys = typeof FILTER_KEYS.BRANDS | typeof FILTER_KEYS.CATEGORIES | typeof FILTER_KEYS.FLAVOR | typeof FILTER_KEYS.REGION | typeof FILTER_KEYS.VARIETY | typeof FILTER_KEYS.VINTAGE | typeof FILTER_KEYS.COUNTRY | typeof FILTER_KEYS.APPELLATION | typeof FILTER_KEYS.TAGS | typeof FILTER_KEYS.MATERIALS | typeof FILTER_KEYS.SIZES | typeof FILTER_KEYS.ENGRAVING | typeof FILTER_KEYS.PRESALE | typeof FILTER_KEYS.FULFILLMENT | typeof FILTER_KEYS.PRICE | typeof FILTER_KEYS.AVAILABILITY | typeof FILTER_KEYS.COLORS;
+export interface IFilterSchema {
+    type: FacetFilterKeys;
+    values: IFilterValue[];
+}
+export interface IFilterValue {
+    value: string;
+    name: string;
+    count: number;
+}
+export interface INavigationResponse {
+    currentPage: number;
+    totalPages: number;
+    totalCount: number;
+    filters: IFilterSchema[];
+}
+export interface IProductSearchResponse extends IProductAvailabilityResponse {
+    navigation: INavigationResponse;
+}

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

@@ -0,0 +1,105 @@
+import type { FulfillmentType } from '@/enums';
+import type { IAddressAddress, IAddressCoordinates, ILocation } from '@/interfaces/api/address.interface';
+export interface IProductAvailabilityParams {
+    identifiers: string[];
+    location?: ILocation;
+}
+export interface IProductAvailabilityResponse {
+    products: IProduct[];
+    retailers: Record<string, IRetailer>;
+}
+export interface IProductVariant {
+    retailerId: string;
+    shippingFulfillmentId: string;
+    onDemandFulfillmentId: string;
+    isEngravable: boolean;
+    partNumber: string;
+    price: number;
+    stock: number;
+}
+export interface IProductSize {
+    id: string;
+    upc: string;
+    size: string;
+    pack: boolean;
+    packDesc: string;
+    container: string;
+    containerType: string;
+    image: string;
+    uom: string;
+    volume: string;
+    maxQuantityPerOrder: number;
+    attributes: IProductSizeAttributes;
+    shippingVariants: Record<string, IProductVariant>;
+    onDemandVariants: Record<string, IProductVariant>;
+}
+export interface IProductFulfillmentHourStatus {
+    isOpen: boolean;
+    openTime: string;
+    isClosed: boolean;
+    closeTime: string;
+}
+export interface IProduct {
+    id: string;
+    name: string;
+    description: string;
+    htmlDescription: string;
+    images: string[];
+    brand: string;
+    region: string;
+    country: string;
+    material: string;
+    abv: string;
+    proof: string;
+    age: string;
+    color: string;
+    flavor: string;
+    variety: string;
+    appellation: string;
+    vintage: string;
+    tastingNotes: string;
+    catPath: string;
+    category: string;
+    classification: string;
+    type: string;
+    subType: string;
+    salsifyGrouping: string;
+    noAvailabilityPrice: number;
+    sizes: Record<string, IProductSize>;
+}
+export interface IFulfillment {
+    id: string;
+    type: FulfillmentType;
+    doesAllowGiftCards: boolean;
+    doesAllowPromos: boolean;
+    expectation: string;
+    engravingExpectation: string;
+    fee: number;
+    timezone: string;
+    hourStatus: IProductFulfillmentHourStatus;
+}
+export type IRetailerAddress = IAddressAddress & IAddressCoordinates;
+export interface IRetailer {
+    id: string;
+    name: string;
+    address: IRetailerAddress;
+    addressFormatted: string;
+    shippingFulfillment: IFulfillment | null;
+    onDemandFulfillment: IFulfillment | null;
+}
+export interface IProductSizeEngraving {
+    maxLines: number;
+    maxCharsPerLine: number;
+    fee: number;
+    location: string;
+}
+export interface IProductSizeAttributes {
+    presale: IProductPresale;
+    engraving: IProductSizeEngraving;
+}
+export interface IProductPresale {
+    canPurchaseOn: null | string;
+    estimatedShipBy: null | string;
+    isActive: boolean;
+    language: string;
+}

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

@@ -1,11 +1,11 @@
 export interface IElementsConfigurations {
-    googleTagManagerId: string;
-    enablePartnerGaTracking: boolean;
-    liquidCommerceGoogleTagManagerId: string;
-    enableLiquidCommerceGaTracking: boolean;
+    isElementsEnabled: boolean;
+    enablePartnerGTM: boolean;
+    partnerGTMId: string;
+    enableLiquidCommerceGTM: boolean;
+    liquidCommerceGTMId: string;
     partnerCode: string;
     supportEmail: string;
     builderBackgroundColor: string;
     partnerName: string;
-    isElementsEnabled: boolean;
 }

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

@@ -4,6 +4,7 @@ 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[];
@@ -55,6 +56,7 @@ export interface IAllConfigs {
     address: IAddressComponent;
     cart: ICartComponent;
     checkout: ICheckoutComponent;
+    productList: IProductListComponent;
 }
-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,25 @@
+import type { DeepPartial } from '@/interfaces/core.interface';
+export type ProductListCardStyle = 'card' | 'ghost';
+export type ProductListCardCornerRadius = 'rounded' | 'sharp';
+export interface IProductListTheme {
+    backgroundColor: string;
+}
+export interface IProductListLayout {
+    productCard: {
+        style: ProductListCardStyle;
+        cornerRadius: ProductListCardCornerRadius;
+        showPrice: boolean;
+        showSizeSelector: boolean;
+        showFulfillment: boolean;
+        showQuantityCounter: boolean;
+        enableShippingFulfillment: boolean;
+        enableOnDemandFulfillment: boolean;
+        showCollections: boolean;
+        enablePersonalization: boolean;
+    };
+}
+export interface IProductListComponent {
+    theme: IProductListTheme;
+    layout: IProductListLayout;
+}
+export type UpdateProductListComponent = DeepPartial<IProductListComponent>;

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

@@ -2,6 +2,7 @@ import type { DeepPartial } from '@/interfaces/core.interface';
 export type FulfillmentDisplayType = 'carousel' | 'popup';
 export interface IProductLayout {
     showImages: boolean;
+    showOnlyMainImage: boolean;
     showTitle: boolean;
     showDescription: boolean;
     showQuantityCounter: boolean;