@liquidcommerce/elements-sdk 2.6.0-beta.7 → 2.6.0-beta.9

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

@@ -4,8 +4,10 @@ import type { IBaseProductEventData } from '@/core/pubsub/interfaces/product.int
 import { type FulfillmentType } from '@/enums';
 import type { IAddressAddress, IAddressCoordinates, IAddressData } from '@/interfaces/api/address.interface';
 import type { BillingFieldName, CustomerFieldName, GiftFieldName } from '@/modules/checkout/components/checkout.type';
-export interface IProductActions {
-    getDetails: (identifier: string) => IBaseProductEventData;
+export interface IAddProductParams {
+    identifier: string;
+    fulfillmentType: FulfillmentType;
+    quantity: number;
 }
 export interface IAddressActions {
     setAddressByPlacesId: (placesId: string) => Promise<void>;
@@ -13,11 +15,6 @@ export interface IAddressActions {
     clear: () => Promise<void>;
     getDetails: () => IAddressData | null;
 }
-export interface IAddProductParams {
-    identifier: string;
-    fulfillmentType: FulfillmentType;
-    quantity: number;
-}
 export interface ICartActions {
     openCart: () => void;
     closeCart: () => void;
@@ -46,6 +43,9 @@ export interface ICheckoutActions {
     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;
@@ -53,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();
@@ -61,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/command/common-command.service.d.ts

@@ -3,5 +3,6 @@ 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/pubsub/interfaces/cart.interface.d.ts

@@ -1,56 +1,23 @@
-import type { ICartItemAttributes } from '@/interfaces/api/cart.interface';
-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>;
-    location: {
-        placesId: string;
-        address: {
-            one: string;
-            two: string;
-            city: string;
-            state: string;
-            zip: string;
-            country: string;
-        };
-        coordinates: {
-            latitude: number;
-            longitude: number;
-        };
-    };
+    cartId: string;
+    promoCodeDiscount: number | null;
     subtotal: number;
     itemCount: number;
+    items: Record<string, ICartItem>;
+    retailers: Record<string, ICartRetailer>;
+    location: {
+        placesId: string;
+        formattedAddress: string;
+        address: IAddressAddress;
+        coordinates: IAddressCoordinates;
+    } | null;
 }
 export interface ICartLoadedEventData extends IBaseCartEventData {
 }
 export interface ICartFailedEventData {
+    cartId: string;
     message: string;
 }
 export interface ICartUpdatedEventData {
@@ -58,37 +25,45 @@ export interface ICartUpdatedEventData {
     current: IBaseCartEventData;
 }
 export interface ICartItemAddedEventData {
-    id: 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

@@ -32,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,81 +1,23 @@
 import type { FulfillmentType } from '@/enums';
-import type { IAddressAddress, IAddressCoordinates } from '@/interfaces/api/address.interface';
-export interface IBaseProductFulfillmentEventData {
-    price: number;
-    partNumber: string;
-    stock: number;
-    isEngravable: boolean;
-    fulfillmentId: string;
-    fulfillmentType: FulfillmentType;
-    retailerId: string;
+import type { IFulfillment, IProduct, IProductSize, IProductVariant, IRetailerAddress } from '@/interfaces/api/product.interface';
+export type IProductFulfillmentEventData = IFulfillment & {
     retailerName: string;
-    retailerAddress: (IAddressAddress & IAddressCoordinates) | 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;
-    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;
-    noAvailabilityPrice: number;
-    sizes: Record<string, IBaseProductSizeEventData>;
+    selectedFulfillmentId: string | null;
+    productHasAvailability: boolean;
+    fulfillmentHasAvailability: boolean;
+    sizes: Record<string, IProductSizeEventData>;
 }
 export interface IProductLoadedEventData extends IBaseProductEventData {
 }
@@ -94,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/cart.interface.d.ts

@@ -41,7 +41,7 @@ export interface ICartRetailerStore extends ICartRetailer {
     updating: boolean;
 }
 export interface ICartStore {
-    id: string | null;
+    id: string;
     subtotal: number;
     itemsQuantity: number;
     items: Record<string, ICartItemStore>;

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, IInjectProductListParams, 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;

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

@@ -73,7 +73,7 @@ export interface ICart {
     items: Record<string, ICartItem>;
     retailers: Record<string, ICartRetailer>;
     promoCode: ICartPromoCode | null;
-    events: any[];
+    events: ICartEvent[];
 }
 export interface ICartItemEngraving {
     isEngravable: boolean;

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;

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

@@ -1,5 +1,6 @@
 import { BaseComponent, type IOnStoreChanged } from '@/core/base-component.service';
-export declare class CartBodyComponent extends BaseComponent<null, null> {
+import type { ICartComponent } from '@/interfaces/configs';
+export declare class CartBodyComponent extends BaseComponent<null, ICartComponent> {
     get hostClasses(): string[];
     constructor();
     private createEmptyCartElement;

package/package.json

@@ -3,7 +3,7 @@
   "description": "LiquidCommerce Elements SDK",
   "license": "UNLICENSED",
   "author": "LiquidCommerce Team",
-  "version": "2.6.0-beta.7",
+  "version": "2.6.0-beta.9",
   "homepage": "https://docs.liquidcommerce.co/elements-sdk",
   "repository": {
     "type": "git",