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

package/dist/types/constants/core.constant.d.ts

@@ -10,6 +10,17 @@ export declare const PRODUCT_LIST_FILTER_TYPES: {
     PERSONALIZATION: string;
     PRE_ORDER: string;
     DELIVERY_OPTIONS: string;
+    PRICE: string;
+    BRANDS: string;
+    CATEGORIES: string;
+    FLAVOR: string;
+    REGION: string;
+    VARIETY: string;
+    VINTAGE: string;
+    COUNTRY: string;
+    APPELLATION: string;
+    MATERIALS: string;
+    SIZES: string;
 };
 export declare const Z_INDEX: {
     readonly DRAWER_WRAPPER: 2147483640;

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

@@ -1,6 +1,10 @@
 import type { AuthClientService } from '@/core/api/auth-client.service';
 import type { IPersistedStore } from '@/core/store/interfaces/core.interface';
-import type { IAddressAutocompleteResult, IAddressDetailsResult, ICart, ICartUpdateParams, ICatalog, ICatalogParams, ICheckoutCompleteParams, ICheckoutCompleteResponse, ICheckoutPrepareParams, ICheckoutPrepareResponse, ILiquidPaymentToken, ILoc, IProductData } from '@/interfaces/cloud';
+import type { IAddressAutocompleteResult, IAddressDetailsResult, ILocation } from '@/interfaces/api/address.interface';
+import type { ICart, ICartUpdateParams } from '@/interfaces/api/cart.interface';
+import type { IProductAvailabilityResponse } from '@/interfaces/api/product.interface';
+import type { IProductSearchParams, IProductSearchResponse } from '@/interfaces/api/product-list.interface';
+import type { ICheckoutCompleteParams, ICheckoutCompleteResponse, ICheckoutPrepareParams, ICheckoutPrepareResponse, ILiquidPaymentToken } from '@/interfaces/cloud';
 import type { IUserPaymentSession, IUserSession } from '@/interfaces/cloud/user.interface';
 import type { IAllConfigs } from '@/interfaces/configs';
 export declare class ApiClientService {
@@ -13,18 +17,14 @@ export declare class ApiClientService {
     setPersistedStore(userDeviceId: string, data: IPersistedStore): Promise<void>;
     getPersistedStore(userDeviceId: string): Promise<IPersistedStore | null>;
     deletePersistedStore(userDeviceId: string): Promise<void>;
-    getProductsData(identifier: string[], location?: ILoc): Promise<IProductData | null>;
-    getCartData(id: string | null): Promise<ICart>;
-    updateCart(params: ICartUpdateParams & {
-        loc?: ILoc;
-    }): Promise<ICart>;
-    getAddressSuggestions(query: string): Promise<IAddressAutocompleteResult[]>;
+    getAddressSuggestions(input: string): Promise<IAddressAutocompleteResult[]>;
     getAddressDetails(id: string): Promise<IAddressDetailsResult>;
+    getProductsData(identifier: string[], location?: ILocation): Promise<IProductAvailabilityResponse | null>;
+    catalogSearch(params: IProductSearchParams): Promise<IProductSearchResponse>;
+    getCartData(id: string | null): Promise<ICart>;
+    updateCart(params: ICartUpdateParams): Promise<ICart>;
     prepareCheckout(params: ICheckoutPrepareParams): Promise<ICheckoutPrepareResponse>;
     getPaymentSession(params: IUserPaymentSession): Promise<IUserSession>;
     confirmPaymentSession(confirmationTokenId: string, setupIntentId: string): Promise<ILiquidPaymentToken>;
-    checkoutComplete(params: Partial<ICheckoutCompleteParams>): Promise<ICheckoutCompleteResponse['order']>;
-    catalogSearch(params: ICatalogParams): Promise<ICatalog>;
-    private validResponseData;
-    private ensureClientInitialized;
+    checkoutComplete(params: Partial<ICheckoutCompleteParams>): Promise<ICheckoutCompleteResponse>;
 }

package/dist/types/core/api/auth-client.service.d.ts

@@ -13,22 +13,13 @@ export interface IAuth {
     exp: number;
     type: 'ACCESS_TOKEN';
 }
-export interface IResponseMetadata {
-    languages: string[];
-    timestamp: number;
-    timezone: string;
-    requestId: string;
-    path: string;
-    version: string;
-}
 export interface IApiResponseBase {
-    statusCode: number;
     message: string;
-    metadata: IResponseMetadata;
 }
-export type IApiResponseWithData<T> = IApiResponseBase & {
+export interface IApiResponse<T> {
+    message: string;
     data: T;
-};
+}
 export declare class AuthClientService {
     private readonly apiKey;
     private readonly baseUrl;
@@ -48,6 +39,4 @@ export declare class AuthClientService {
     private getProxyHeaders;
     get<T = any>(path: string, options?: IHttpRequestOptions): Promise<T>;
     post<T = any>(path: string, options?: IHttpRequestOptions): Promise<T>;
-    put<T = any>(path: string, options?: IHttpRequestOptions): Promise<T>;
-    delete<T = any>(path: string, options?: IHttpRequestOptions): Promise<T>;
 }

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

@@ -2,22 +2,19 @@ import type { IBaseCartEventData } from '@/core/pubsub/interfaces/cart.interface
 import type { ICheckoutDetailsEventData } from '@/core/pubsub/interfaces/checkout.interface';
 import type { IBaseProductEventData } from '@/core/pubsub/interfaces/product.interface';
 import { type FulfillmentType } from '@/enums';
-import type { IAddress, ICoords } from '@/interfaces/cloud';
-import type { IAddressData } from '@/modules/address/address.interface';
-export interface IProductActions {
-    getDetails: (identifier: string) => IBaseProductEventData;
+import type { IAddressAddress, IAddressCoordinates, IAddressData } from '@/interfaces/api/address.interface';
+import type { BillingFieldName, CustomerFieldName, GiftFieldName } from '@/modules/checkout/components/checkout.type';
+export interface IAddProductParams {
+    identifier: string;
+    fulfillmentType: FulfillmentType;
+    quantity: number;
 }
 export interface IAddressActions {
     setAddressByPlacesId: (placesId: string) => Promise<void>;
-    setAddressManually: (address: Omit<IAddress, 'id'>, coordinates: ICoords) => Promise<void>;
+    setAddressManually: (address: IAddressAddress, coordinates: IAddressCoordinates) => Promise<void>;
     clear: () => Promise<void>;
     getDetails: () => IAddressData | null;
 }
-export interface IAddProductParams {
-    identifier: string;
-    fulfillmentType: FulfillmentType;
-    quantity: number;
-}
 export interface ICartActions {
     openCart: () => void;
     closeCart: () => void;
@@ -40,9 +37,15 @@ export interface ICheckoutActions {
     removeGiftCard: (code: string) => Promise<void>;
     toggleIsGift: (active?: boolean) => Promise<void>;
     toggleBillingSameAsShipping: (active?: boolean) => Promise<void>;
-    toggleMarketingPreferences: (field: 'canEmail' | 'canSms', active: boolean) => void;
+    toggleMarketingPreferences: (field: 'canEmail' | 'canSms', active: boolean) => Promise<void>;
+    updateCustomerInfo: (params: Record<CustomerFieldName, string>) => void;
+    updateBillingInfo: (params: Record<BillingFieldName, string>) => void;
+    updateGiftInfo: (params: Record<GiftFieldName, string>) => void;
     getDetails: () => ICheckoutDetailsEventData;
 }
+export interface IProductActions {
+    getDetails: (identifier: string) => IBaseProductEventData;
+}
 export declare class ClientActionService {
     private readonly pubSub;
     private readonly command;
@@ -50,6 +53,9 @@ export declare class ClientActionService {
     private readonly api;
     private readonly themeProvider;
     private readonly logger;
+    private readonly allowedCustomerFields;
+    private readonly allowedBillingFields;
+    private readonly allowedGiftFields;
     private pendingCartParams;
     private pendingCartOpenFlag;
     constructor();
@@ -58,6 +64,7 @@ export declare class ClientActionService {
     private retryPendingCartOperation;
     private clearPendingCartOperation;
     private getLocation;
+    private normalizeCheckoutFieldValue;
     private productActions;
     private addressActions;
     private cartActions;

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

@@ -21,6 +21,7 @@ export interface IClientConfigs {
     promoTicker: IPromoTicker[] | null;
     paymentMethodId?: string;
     openShadowDom?: boolean;
+    hasCustomApiUrl?: boolean;
 }
 export interface IClientConfigInput {
     env?: ElementsEnv;

package/dist/types/core/command/base-command.service.d.ts

@@ -4,7 +4,7 @@ import { GoogleTagManagerService } from '@/core/google-tag-manager.service';
 import { LoggerFactory } from '@/core/logger/logger-factory';
 import { PubSubService } from '@/core/pubsub/pubsub.service';
 import { StoreService } from '@/core/store/store.service';
-import type { ILoc } from '@/interfaces/cloud';
+import type { ILocation } from '@/interfaces/api/address.interface';
 import { ThemeProviderService } from '@/modules/theme-provider/theme-provider.service';
 export declare abstract class BaseCommand {
     protected store: StoreService;
@@ -15,5 +15,5 @@ export declare abstract class BaseCommand {
     protected clientConfig: ClientConfigService;
     protected themeProvider: ThemeProviderService;
     constructor();
-    protected getLocation(): ILoc | undefined;
+    protected getLocation(): ILocation | undefined;
 }

package/dist/types/core/command/common-command.service.d.ts

@@ -1,7 +1,8 @@
-import type { ICart } from '@/interfaces/cloud';
+import type { ICart } from '@/interfaces/api/cart.interface';
 import { BaseCommand } from './base-command.service';
 export declare class CommonCommands extends BaseCommand {
     static getInstance(): CommonCommands;
     syncCartFromResponse(cartApi: ICart, publishEvent?: boolean): void;
+    private buildCartLoadedEventData;
     loadCart(): Promise<void>;
 }

package/dist/types/core/google-tag-manager.service.d.ts

@@ -6,10 +6,11 @@ declare global {
 }
 interface GTMConfig {
     partnerName: string;
-    partnerGtmId?: string;
-    partnerEnableGaTracking: boolean;
-    liquidCommerceEnableGaTracking: boolean;
-    liquidCommerceGtmId: string;
+    partnerCode: string;
+    partnerGTMId?: string;
+    enablePartnerGTM: boolean;
+    enableLiquidCommerceGTM: boolean;
+    liquidCommerceGTMId: string;
 }
 interface BaseItem {
     item_id?: string;
@@ -47,10 +48,11 @@ interface PurchaseData {
 }
 export declare class GoogleTagManagerService {
     private partnerName?;
-    private partnerGtmId?;
-    private liquidCommerceGtmId?;
-    private partnerEnableGaTracking;
-    private liquidCommerceEnableGaTracking;
+    private partnerCode?;
+    private partnerGTMId?;
+    private liquidCommerceGTMId?;
+    private enablePartnerGTM;
+    private enableLiquidCommerceGTM;
     private isInitialized;
     private isInitializing;
     private initializationPromise?;
@@ -108,8 +110,8 @@ export declare class GoogleTagManagerService {
             country?: string;
         };
         coordinates?: {
-            lat: number;
-            long: number;
+            latitude: number;
+            longitude: number;
         };
     }): void;
     addressFailed(errorData: {

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

@@ -1,16 +1,7 @@
+import type { IAddressAddress, IAddressCoordinates } from '@/interfaces/api/address.interface';
 export interface IAddressActionEventData {
     googlePlacesId: string;
     formattedAddress: string;
-    address: {
-        one: string;
-        two: string;
-        city: string;
-        state: string;
-        zip: string;
-        country: string;
-    };
-    coordinates: {
-        lat: number;
-        long: number;
-    };
+    address: IAddressAddress;
+    coordinates: IAddressCoordinates;
 }

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

@@ -1,67 +1,23 @@
-import type { ICartItemAttributes } from '@/interfaces/cloud';
-export interface ICartItemEventData {
-    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;
-}
+import type { IAddressAddress, IAddressCoordinates } from '@/interfaces/api/address.interface';
+import type { ICartItem, ICartRetailer } from '@/interfaces/api/cart.interface';
 export interface IBaseCartEventData {
-    id: string | null;
-    promoCode: string;
-    items: Record<string, ICartItemEventData>;
+    cartId: string;
+    promoCodeDiscount: number | null;
+    subtotal: number;
+    itemCount: number;
+    items: Record<string, ICartItem>;
+    retailers: Record<string, ICartRetailer>;
     location: {
         placesId: string;
-        address: {
-            one: string;
-            two: string;
-            city: string;
-            state: string;
-            zip: string;
-            country: string;
-        };
-        coordinates: {
-            latitude: number;
-            longitude: number;
-        };
-    };
-    amounts: {
-        deliveryFee: number;
-        discounts: number;
-        engravingFee: number;
-        giftCardTotal: number;
-        platformFee: number;
-        shippingFee: number;
-        subtotal: number;
-        total: number;
-    };
-    itemCount: number;
-    updatedAt: string;
-    createdAt: string;
+        formattedAddress: string;
+        address: IAddressAddress;
+        coordinates: IAddressCoordinates;
+    } | null;
 }
 export interface ICartLoadedEventData extends IBaseCartEventData {
 }
 export interface ICartFailedEventData {
+    cartId: string;
     message: string;
 }
 export interface ICartUpdatedEventData {
@@ -69,38 +25,45 @@ export interface ICartUpdatedEventData {
     current: IBaseCartEventData;
 }
 export interface ICartItemAddedEventData {
-    id: string;
-    upc: string;
+    cartId: string;
+    itemId: string;
     fulfillmentId: string;
     partNumber: string;
     quantity: number;
     engravingLines?: string[];
 }
 export interface ICartItemRemovedEventData {
-    id: string;
+    cartId: string;
+    itemId: string;
 }
 export interface ICartItemQuantityChangedEventData {
-    id: string;
+    cartId: string;
+    itemId: string;
     quantity: number;
     previousQuantity: number;
 }
 export interface ICartItemEngravingUpdatedEventData {
-    id: string;
+    cartId: string;
+    itemId: string;
     engravingLines: string[];
     previousEngravingLines: string[];
 }
 export interface ICartPromoCodeEventData {
+    cartId: string;
     discountAmount?: number;
-    newTotal?: number;
+    newSubtotal?: number;
 }
 export interface ICartPromoCodeFailedEventData {
+    cartId: string;
     error: string;
 }
 export interface ICartProductAddEventData {
+    cartId: string;
     itemsAdded: number;
     identifiers: string[];
 }
 export interface ICartProductAddFailedEventData {
+    cartId: string;
     identifiers: string[];
     error: string;
 }

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

@@ -1,4 +1,5 @@
-import type { ICartItemAttributes, ICheckoutTotalAmounts } from '@/interfaces/cloud';
+import type { ICartItemAttributes } from '@/interfaces/api/cart.interface';
+import type { ICheckoutTotalAmounts } from '@/interfaces/cloud';
 export interface IBaseCheckoutEventData {
     cartId: string;
 }
@@ -31,37 +32,46 @@ export interface ICheckoutSubmitFailedEventData {
     message: string;
 }
 export interface ICheckoutItemQuantityChangedEventData {
+    cartId: string;
     cartItemId: string;
     quantity: number;
     previousQuantity: number;
 }
 export interface ICheckoutItemRemovedEventData {
+    cartId: string;
     cartItemId: string;
 }
 export interface ICheckoutItemEngravingUpdatedEventData {
+    cartId: string;
     cartItemId: string;
     engravingLines: string[];
     previousEngravingLines: string[];
 }
 export interface ICheckoutPromoCodeEventData {
+    cartId: string;
     discountAmount?: number;
     newTotal?: number;
 }
 export interface ICheckoutPromoCodeFailedEventData {
+    cartId: string;
     error: string;
 }
 export interface ICheckoutGiftCardEventData {
+    cartId: string;
     newTotal?: number;
 }
 export interface ICheckoutGiftCardFailedEventData {
+    cartId: string;
     error: string;
 }
 export interface ICheckoutProductAddEventData {
+    cartId: string;
     itemsAdded: number;
     identifiers: string[];
     isPresale?: boolean;
 }
 export interface ICheckoutProductAddFailedEventData {
+    cartId: string;
     identifiers: string[];
     error: string;
     isPresale?: boolean;

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

@@ -1,87 +1,23 @@
 import type { FulfillmentType } from '@/enums';
-import type { IAddress, ICoords } from '@/interfaces/cloud';
-export interface IBaseProductFulfillmentEventData {
-    price: number;
-    partNumber: string;
-    stock: number;
-    isEngravable: boolean;
-    fulfillmentId: string;
-    fulfillmentType: FulfillmentType;
-    modalities: FulfillmentType[];
-    retailerId: string;
+import type { IFulfillment, IProduct, IProductSize, IProductVariant, IRetailerAddress } from '@/interfaces/api/product.interface';
+export type IProductFulfillmentEventData = IFulfillment & {
     retailerName: string;
-    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;
-    size: string;
-    pack: boolean;
-    packDesc: string;
-    container: string;
-    containerType: string;
-    maxQuantityPerOrder: number;
-    image: string;
-    uom: string;
-    volume: string;
-    attributes: IBaseProductSizeAttributesEventData;
-    shippingFulfillments: Record<string, IBaseProductFulfillmentEventData>;
-    onDemandFulfillments: Record<string, IBaseProductFulfillmentEventData>;
-}
-export interface IBaseProductEventData {
+    retailerAddress: IRetailerAddress;
+    retailerAddressFormatted: string;
+    variant: IProductVariant;
+};
+export interface IProductSizeEventData extends Omit<IProductSize, 'shippingVariants' | 'onDemandVariants'> {
+    onDemandFulfillments: Record<string, IProductFulfillmentEventData>;
+    shippingFulfillments: Record<string, IProductFulfillmentEventData>;
+}
+export interface IBaseProductEventData extends Omit<IProduct, 'sizes'> {
     identifier: string;
     selectedSizeId: string | null;
-    selectedFulfillmentId: string | null;
     selectedFulfillmentType: FulfillmentType;
-    id: string;
-    name: string;
-    brand: 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;
-        avg: number;
-    } | null;
-    sizes: Record<string, IBaseProductSizeEventData>;
+    selectedFulfillmentId: string | null;
+    productHasAvailability: boolean;
+    fulfillmentHasAvailability: boolean;
+    sizes: Record<string, IProductSizeEventData>;
 }
 export interface IProductLoadedEventData extends IBaseProductEventData {
 }
@@ -92,7 +28,6 @@ export interface IProductQuantityChangedEventData {
 }
 export interface IProductAddToCartEventData {
     identifier: string;
-    upc: string;
     fulfillmentId: string;
     partNumber: string;
     quantity: number;
@@ -101,7 +36,7 @@ export interface IProductAddToCartEventData {
 export interface IProductSizeChangedEventData {
     identifier: string;
     selectedSizeId: string;
-    size: string;
+    selectedSize: string;
     previousSizeId: string;
     previousSize: string;
 }

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

@@ -1,16 +1,7 @@
+import type { IAddressAddress, IAddressCoordinates } from '@/interfaces/api/address.interface';
 export interface IAddressStore {
     id: string;
     formattedAddress: string;
-    address: {
-        one: string;
-        two: string;
-        city: string;
-        state: string;
-        zip: string;
-        country: string;
-    };
-    coordinates: {
-        lat: number;
-        long: number;
-    };
+    address: IAddressAddress;
+    coordinates: IAddressCoordinates;
 }

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

@@ -1,6 +1,5 @@
 import type { IElementsCartEvent } from 'utils/helper';
-import type { FulfillmentType } from '@/enums';
-import type { IAddress, ICartItemAttributes, IRetailerExpectation, IRetailerFees } from '@/interfaces/cloud';
+import type { ICartFulfillment, ICartItemAttributes, ICartPromoCode, ICartRetailer } from '@/interfaces/api/cart.interface';
 export interface ICartItemStore {
     id: string;
     variantId: string;
@@ -31,64 +30,27 @@ export interface ICartItemStore {
     updating: boolean;
     error: string | null;
 }
-export interface ICartTotalsStore {
-    subtotal: number;
-    total: number;
-    shippingFee: number;
-    platformFee: number;
-    giftCardTotal: number;
-    engravingFee: number;
-    deliveryFee: number;
-    discounts: number;
-    quantity: number;
+export interface ICartFulfillmentStore extends ICartFulfillment {
+    loading: boolean;
+    error: string | null;
+    updating: boolean;
 }
-export interface IRetailerFulfillmentStore {
-    id: string;
-    canEngrave: boolean;
-    type: FulfillmentType;
-    fees: IRetailerFees;
-    expectation: IRetailerExpectation;
-    shippingFee: number;
-    subtotal: number;
-    items: string[];
-    engravingFee: number;
-    deliveryFee: number;
-    retailerId: string;
-    loading?: boolean;
-    error?: string | null;
-    updating?: boolean;
+export interface ICartRetailerStore extends ICartRetailer {
+    loading: boolean;
+    error: string | null;
+    updating: boolean;
 }
-export interface IRetailerStore {
+export interface ICartStore {
     id: string;
-    name: string;
-    platformFee: number;
-    shippingFee: number;
     subtotal: number;
-    address?: IAddress;
-    deliveryFee: number;
-    engravingFee: number;
-    total: number;
-    fulfillments: string[];
-    loading?: boolean;
-    error?: string | null;
-    updating?: boolean;
-}
-export interface ICartPromoCodeStore {
-    code: string;
-    discountAmount: number;
-}
-export interface ICartStore {
-    id: string | null;
+    itemsQuantity: number;
+    items: Record<string, ICartItemStore>;
+    fulfillments: Record<string, ICartFulfillmentStore>;
+    retailers: Record<string, ICartRetailerStore>;
+    promoCode: ICartPromoCode | null;
+    events: IElementsCartEvent[];
     loading: boolean;
     error: string | null;
-    items: Record<string, ICartItemStore>;
-    totals: ICartTotalsStore;
-    retailers: Record<string, IRetailerStore>;
-    promoCode: ICartPromoCodeStore | null;
-    fulfillments: Record<string, IRetailerFulfillmentStore>;
     rerender: boolean;
     shouldReset: boolean;
-    updatedAt: string;
-    createdAt: string;
-    events: IElementsCartEvent[];
 }