@liquidcommerce/elements-sdk 2.4.0 → 2.4.1

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';
@@ -42,7 +42,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;
 }
@@ -72,13 +71,52 @@ export interface ICheckoutProductAddFailedEventData {
     identifiers: string[];
     error: string;
 }
-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/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/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/docs/ACTIONS.md

@@ -65,16 +65,19 @@ Events **never expose sensitive information** like promo codes, gift card codes,
 // Check product info before making decisions
 const product = actions.product.getDetails('product-123');
 
-if (product.price > 100) {
-  // Show premium support option
+// Use product attributes for recommendations
+if (product.variety === 'Cabernet Sauvignon' && product.region === 'Napa Valley') {
+  showSimilarNapaWines();
+}
+
+// Pricing and availability
+if (product.priceInfo && product.priceInfo.avg > 100) {
   showPremiumSupport();
 }
 
-if (product.isAvailable) {
-  // Enable add to cart
+if (product.sizes && Object.keys(product.sizes).length > 0) {
   enableAddToCart();
 } else {
-  // Show waitlist signup
   showWaitlistSignup();
 }
 ```
@@ -382,13 +385,11 @@ window.addEventListener('lce:actions.cart_product_add_failed', function(event) {
 // See what's in the cart to make smart decisions
 const cart = actions.cart.getDetails();
 
-if (cart.total > 100) {
-  // Offer free shipping
+if (cart.amounts.total > 100) {
   showFreeShippingBanner();
 }
 
-if (cart.items.length === 0) {
-  // Cart is empty - show recommendations
+if (cart.itemCount === 0) {
   showPopularProducts();
 }
 ```
@@ -499,7 +500,7 @@ actions.checkout.toggleCheckout();
 
 // Example: Open checkout automatically for high-value carts
 const cart = actions.cart.getDetails();
-if (cart.total > 500) {
+if (cart.amounts.total > 500) {
   actions.checkout.openCheckout(); // VIP checkout experience
 }
 ```
@@ -625,14 +626,6 @@ if (customer.billingAddress === customer.shippingAddress) {
 // Get safe, non-sensitive checkout information
 const checkout = actions.checkout.getDetails();
 
-// Check checkout status and totals
-console.log('Checkout total:', checkout.amounts.total);
-console.log('Items in checkout:', checkout.itemCount);
-console.log('Is gift order:', checkout.isGift);
-console.log('Has age verification:', checkout.hasAgeVerify);
-console.log('Has promo code applied:', checkout.hasPromoCode);
-console.log('Has gift cards applied:', checkout.hasGiftCards);
-
 // Make business decisions based on checkout state
 if (checkout.amounts.total > 1000) {
   // High-value order - offer white glove service
@@ -700,24 +693,28 @@ async function handleVIPCustomer(customer) {
 
 ### 🛍️ Scenario 2: Smart Bundle Sales
 ```javascript
-// Automatically add complementary products
+// Automatically add complementary products based on specific product identifiers
 window.addEventListener('lce:actions.product_add_to_cart', async function(event) {
-  const product = event.detail.data;
+  const data = event.detail.data;
+  
+  // Define cross-sell rules by identifier
+  const crossSellMap = {
+    'laptop-001': ['laptop-case-123', 'wireless-mouse-456'],
+    'camera-001': ['camera-bag-789', 'sd-card-512gb']
+  };
   
-  // If they bought a laptop, add accessories
-  if (product.category === 'laptops') {
-    const cart = actions.cart.getDetails();
-    const hasAccessories = cart.items.some(item => item.category === 'accessories');
+  // Check if this product has recommended accessories
+  if (crossSellMap[data.identifier]) {
+    const accessories = crossSellMap[data.identifier];
+    await actions.cart.addProduct(
+      accessories.map(id => ({ 
+        identifier: id, 
+        fulfillmentType: 'shipping', 
+        quantity: 1 
+      }))
+    );
     
-    if (!hasAccessories) {
-      // Add recommended accessories bundle
-      await actions.cart.addProduct([
-        { identifier: 'laptop-case-123', fulfillmentType: 'shipping', quantity: 1 },
-        { identifier: 'wireless-mouse-456', fulfillmentType: 'shipping', quantity: 1 }
-      ]);
-      
-      showMessage("We've added recommended accessories to your cart!");
-    }
+    showMessage("We've added recommended accessories to your cart!");
   }
 });
 ```
@@ -767,7 +764,7 @@ async function optimizeCheckout() {
   ];
   
   for (const strategy of discountStrategies) {
-    if (strategy.minTotal && cart.total >= strategy.minTotal) {
+    if (strategy.minTotal && cart.amounts.total >= strategy.minTotal) {
       try {
         await actions.checkout.applyPromoCode(strategy.code);
         break; // Success, stop trying
@@ -1023,15 +1020,20 @@ window.addEventListener('lce:actions.product_add_to_cart', async function(event)
   const product = event.detail.data;
   
   // Your business logic here
-  if (product.price > 100) {
+  if (product.priceInfo && product.priceInfo.avg > 100) {
     // High-value product - offer premium support
     showPremiumSupportOffer();
   }
   
-  // Maybe add complementary products
-  if (product.category === 'phones') {
+  // Maybe add complementary products based on identifier
+  const crossSellMap = {
+    'phone-001': 'phone-case-recommended',
+    'laptop-001': 'laptop-case-recommended'
+  };
+  
+  if (crossSellMap[product.identifier]) {
     await actions.cart.addProduct([{
-      identifier: 'phone-case-recommended',
+      identifier: crossSellMap[product.identifier],
       fulfillmentType: 'shipping',
       quantity: 1
     }]);
@@ -1054,7 +1056,7 @@ window.addEventListener('lce:actions.cart_opened', function() {
   const cart = actions.cart.getDetails();
   
   // If cart value is close to free shipping threshold
-  if (cart.total > 45 && cart.total < 50) {
+  if (cart.amounts.total > 45 && cart.amounts.total < 50) {
     showFreeShippingUpsell();
   }
 });
@@ -1136,16 +1138,16 @@ if (timeOnPage > 60 && pageViewCount > 3) {
 
 ### 🛍️ **Pattern 2: Cross-Sell Automation**
 ```javascript
-// Automatic product recommendations
+// Automatic product recommendations based on identifier
 const crossSellRules = {
-  'laptop': ['laptop-case', 'wireless-mouse', 'usb-hub'],
-  'phone': ['phone-case', 'screen-protector', 'wireless-charger'],
-  'camera': ['memory-card', 'camera-bag', 'tripod']
+  'laptop-001': ['laptop-case', 'wireless-mouse', 'usb-hub'],
+  'phone-001': ['phone-case', 'screen-protector', 'wireless-charger'],
+  'camera-001': ['memory-card', 'camera-bag', 'tripod']
 };
 
 window.addEventListener('lce:actions.product_add_to_cart', async function(event) {
-  const product = event.detail.data;
-  const recommendations = crossSellRules[product.category];
+  const data = event.detail.data;
+  const recommendations = crossSellRules[data.identifier];
   
   if (recommendations) {
     // Add first recommendation automatically
@@ -1155,7 +1157,7 @@ window.addEventListener('lce:actions.product_add_to_cart', async function(event)
       quantity: 1
     }]);
     
-    showMessage(`We've added ${recommendations[0]} - customers who bought ${product.name} love this combo!`);
+    showMessage(`We've added ${recommendations[0]} - customers love this combo!`);
   }
 });
 ```
@@ -1174,7 +1176,7 @@ async function optimizePricing() {
   }
   
   // Volume discounts
-  else if (cart.total > 200) {
+  else if (cart.amounts.total > 200) {
     await actions.cart.applyPromoCode('BULK20');
   }