@liquidcommerce/cloud-sdk 1.6.0 → 1.8.0

package/dist/types/core/payment-session-helper.service.d.ts

@@ -0,0 +1,12 @@
+import type { IUserSession } from '../interfaces';
+export declare class PaymentSessionHelperService {
+    private static readonly F;
+    rcd(d: any, env: any): IUserSession;
+    private v;
+    private a;
+    private b;
+    ocd(ct: string, si: string): string;
+    gsi(s: string): string;
+    gdk(t: string): string;
+    dd<T>(d: any, t: string): T;
+}

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

@@ -1,6 +1,6 @@
-import type { ILiquidCommerceClientConstructor } from '../interfaces';
-import { AddressService, CatalogService, CheckoutService, PaymentService, UserService } from '../services';
-import { CartService } from '../services/cart.service';
+import type { LIQUID_COMMERCE_ENV } from '../enums';
+import type { ILiquidCommerceClientConstructor, ILiquidCommercePaymentElement, IPaymentElementConfig, PaymentElementImplConstructor } from '../interfaces';
+import { AddressService, CartService, CatalogService, CheckoutService, PaymentService, UserService, WebhookService } from '../services';
 import type { ILiquidCommerceConfig } from '../types';
 import { AuthenticatedService } from './authenticated.service';
 import { CartHelperService } from './cart-helper.service';
@@ -8,6 +8,7 @@ import { CatalogHelperService } from './catalog-helper.service';
 import { CheckoutHelperService } from './checkout-helper.service';
 import { LocationHelperService } from './location-helper.service';
 import { PaymentProviderService } from './payment-provider.service';
+import { PaymentSessionHelperService } from './payment-session-helper.service';
 /**
  * The SingletonManager class is responsible for managing singleton instances of various services.
  * It provides methods for retrieving or creating instances of these services based on unique keys.
@@ -16,6 +17,7 @@ export declare class SingletonManager {
     private static instance;
     private services;
     private liquidCommerceClientConstructor;
+    private paymentElementConstructor;
     static getInstance(): SingletonManager;
     /**
      * Sets the constructor for the Liquid Commerce Client.
@@ -25,6 +27,7 @@ export declare class SingletonManager {
      * @return {void}
      */
     setLiquidCommerceClientConstructor(constructor: ILiquidCommerceClientConstructor): void;
+    setPaymentElementConstructor(constructor: PaymentElementImplConstructor): void;
     /**
      * Retrieves or creates an instance of the LiquidCommerceClient.
      *
@@ -34,6 +37,14 @@ export declare class SingletonManager {
      * @throws {Error} - If the LiquidCommerceClient constructor is not set.
      */
     getClient<T>(apiKey: string, config: ILiquidCommerceConfig): Promise<T>;
+    /**
+     * Retrieves or creates an instance of the LiquidCommercePaymentElement.
+     *
+     * @param {IPaymentElementConfig} options - The configuration options for the payment element.
+     * @returns {ILiquidCommercePaymentElement} - An instance of ILiquidCommercePaymentElement.
+     * @throws {Error} - If the PaymentElement constructor is not set.
+     */
+    getPaymentElement(options: IPaymentElementConfig): ILiquidCommercePaymentElement;
     /**
      * Returns an instance of a service based on the given key and ServiceClass.
      * If the service does not exist, it creates a new instance using the ServiceClass and optional arguments.
@@ -56,6 +67,7 @@ export declare class SingletonManager {
     getAuthenticatedClient(config: {
         apiKey: string;
         baseURL: string;
+        env: LIQUID_COMMERCE_ENV;
     }): AuthenticatedService;
     /**
      * Retrieves the instance of the LocationHelperService.
@@ -91,6 +103,7 @@ export declare class SingletonManager {
      * @return {CartHelperService} The CartHelperService instance.
      */
     getCartHelperService(): CartHelperService;
+    getPaymentSessionHelperService(): PaymentSessionHelperService;
     /**
      * Retrieves the CartService instance associated with the given authenticated client.
      *
@@ -134,4 +147,11 @@ export declare class SingletonManager {
      * @return The CheckoutService instance.
      */
     getCheckoutService(authenticatedClient: AuthenticatedService): CheckoutService;
+    /**
+     * Retrieves the WebhookService instance for the provided authenticated client.
+     *
+     * @param authenticatedClient - The authenticated client object.
+     * @return The WebhookService instance.
+     */
+    getWebhookService(authenticatedClient: AuthenticatedService): WebhookService;
 }

package/dist/types/core/utils.d.ts

@@ -0,0 +1,48 @@
+export type FetchFunction = typeof fetch;
+export interface IHttpClientOptions {
+    method: string;
+    headers: Record<string, string>;
+    body?: string;
+}
+export type HttpClient = (url: string, options: IHttpClientOptions) => Promise<ICustomResponse>;
+export interface IRequestOptions {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    headers?: Record<string, string>;
+    body?: any;
+}
+export interface ICustomResponse {
+    ok: boolean;
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+    json: () => Promise<any>;
+    text: () => Promise<string>;
+}
+/**
+ * Returns a HttpClient function that wraps the provided fetch function.
+ *
+ * @param {FetchFunction} fetchFunc - The fetch function to be wrapped.
+ *
+ * @return {HttpClient} - The HttpClient function that makes network requests using the provided fetch function.
+ */
+export declare function fetchAdapter(fetchFunc: FetchFunction): HttpClient;
+/**
+ * Sends an HTTP request using XMLHttpRequest and returns a Promise that resolves to a custom response object.
+ *
+ * @param {string} url - The URL to send the request to.
+ * @param {IHttpClientOptions} options - The options for the HTTP request.
+ * @returns {Promise<ICustomResponse>} - A Promise that resolves to a custom response object.
+ * @throws {TypeError} - If the network request fails.
+ */
+export declare const xhrFetch: HttpClient;
+/**
+ * Returns the appropriate implementation of the `HttpClient` interface for making HTTP requests.
+ *
+ * If the `fetch` function is available, it will be used to create a new `HttpClient` instance by calling the `fetchAdapter` method.
+ * If the `fetch` function is not available but the `global.fetch` function is defined, the `global.fetch` function will be used.
+ * If neither the `fetch` function nor the `global.fetch` function is available, but the `window.fetch` function is defined, the `window.fetch` function will be used.
+ * If none of the above conditions are met, the `xhrFetch` property will be returned.
+ *
+ * @return The appropriate implementation of the `HttpClient` interface.
+ */
+export declare function getFetchImplementation(): HttpClient;

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

@@ -21,6 +21,7 @@ export declare enum STATES_CODE {
     AL = "AL",
     AK = "AK",
     AR = "AR",
+    AZ = "AZ",
     CA = "CA",
     CO = "CO",
     CT = "CT",
@@ -73,6 +74,7 @@ export declare enum STATES_NAME {
     ALABAMA = "AL",
     ALASKA = "AK",
     ARKANSAS = "AR",
+    ARIZONA = "AZ",
     CALIFORNIA = "CA",
     COLORADO = "CO",
     CONNECTICUT = "CT",
@@ -125,6 +127,10 @@ export declare enum ENUM_ENGRAVING {
     YES = "YES",
     NO = "NO"
 }
+export declare enum ENUM_BINARY_FILTER {
+    YES = "YES",
+    NO = "NO"
+}
 export declare enum ENUM_FILTER_KEYS {
     BRANDS = "brands",
     FLAVOR = "flavor",
@@ -134,6 +140,7 @@ export declare enum ENUM_FILTER_KEYS {
     VARIETY = "variety",
     ENGRAVING = "engraving",
     PRICE = "price",
+    PRESALE = "presale",
     AVAILABILITY = "availability",
     CATEGORIES = "categories",
     SIZES = "sizes",
@@ -182,7 +189,31 @@ export declare enum CART_EVENT_ENUM {
     DEFAULT = "CartError",
     ITEM_QTY_CHANGE = "ItemQuantityChange",
     ITEM_ID_NOT_FOUND = "ItemIdNotFound",
-    ITEMS_REMOVED = "ItemsRemoved"
+    ITEMS_REMOVED = "ItemsRemoved",
+    RETAILER_FULFILLMENT_INVALID = "RetailerFulfillmentInvalid",
+    COUPON_PROCESSING_ERROR = "CouponProcessingError",
+    COUPON_NOT_FOUND = "CouponNotFound",
+    COUPON_EXPIRED = "CouponExpired",
+    NO_APPLICABLE_DISCOUNT = "NoApplicableDiscount",
+    COUPON_NOT_STARTED = "CouponNotStarted",
+    MINIMUM_ORDER_VALUE_NOT_MET = "MinimumOrderValueNotMet",
+    MINIMUM_ORDER_UNITS_NOT_MET = "MinimumOrderUnitsNotMet",
+    MINIMUM_DISTINCT_ITEMS_NOT_MET = "MinimumDistinctItemsNotMet",
+    QUOTA_EXCEEDED = "QuotaExceeded",
+    USER_LIMIT_EXCEEDED = "UserLimitExceeded",
+    NOT_FIRST_PURCHASE = "NotFirstPurchase",
+    INVALID_COUPON = "InvalidCoupon",
+    INVALID_MEMBERSHIP = "InvalidMembership",
+    INVALID_DOMAIN = "InvalidDomain",
+    INVALID_REQUIREMENTS = "InvalidRequirements",
+    INVALID_ORGANIZATION = "InvalidOrganization",
+    PRODUCT_NOT_ELIGIBLE = "ProductNotEligible",
+    NOT_ENOUGH_PREVIOUS_ORDERS = "NotEnoughPreviousOrders",
+    PRESALE_ITEMS_NOT_ALLOWED = "PresaleItemsNotAllowed",
+    PRESALE_LIMIT_EXCEEDED = "PresaleLimitExceeded",
+    PRESALE_NOT_STARTED = "PresaleNotStarted",
+    PRESALE_EXPIRED = "PresaleExpired",
+    PRESALE_MIXED_CART = "PresaleMixedCart"
 }
 export declare enum ENUM_ADDRESS_TYPE {
     SHIPPING = "shipping",
@@ -238,3 +269,41 @@ export declare enum ENUM_CHECKOUT_STATUS_CODE_MESSAGE {
     REQUEST_ADDRESS_DEFAULT_ERROR = "There's been an error with your address configurations in cart and/or billing address, check and try again.",
     REQUEST_TIPS_ERROR = "There's been an error applying your tips to the checkout."
 }
+export declare enum CHECKOUT_EVENT_ENUM {
+    ERROR_PROCESSING_GIFT_CARDS = "ErrorProcessingGiftCards",
+    INVALID_GIFT_CARD_CODE = "InvalidGiftCardCodes",
+    INVALID_GIFT_CARD_PARTNER = "InvalidGiftCardPartner",
+    INACTIVE_GIFT_CARD = "InactiveGiftCard",
+    GIFT_CARD_ALREADY_IN_USE = "GiftCardAlreadyInUse",
+    GIFT_CARD_EXPIRED = "GiftCardExpired",
+    GIFT_CARD_BALANCE_DEPLETED = "GiftCardBalanceDepleted"
+}
+export declare enum ENUM_ORDER_STATUS {
+    CREATED = "created",
+    PROCESSING = "processing",
+    CANCELED = "canceled",
+    DELIVERED = "delivered",
+    TEST = "test"
+}
+export declare enum ENUM_ORDER_SYSTEM {
+    LIQUIDCOMMERCE = "LiquidCommerce OMS",
+    RESERVEBAR = "ReserveBar OMS"
+}
+export declare enum ENUM_ORDER_PACKAGE_STATUS {
+    PENDING = "pending",
+    SHIPPED = "shipped",
+    DELIVERED = "delivered",
+    CANCELED = "canceled",
+    RETURNED = "returned"
+}
+export declare enum ENUM_ORDER_FULFILLMENT_TYPE {
+    SHIPPING = "shipping",
+    ON_DEMAND = "onDemand",
+    DIGITAL = "digital",
+    BOPIS = "bopis"
+}
+export declare enum ENUM_CUSTOMER_PLACEMENT {
+    STANDARD = "standard",
+    PRE_SALE = "pre_sale",
+    BACK_ORDER = "back_order"
+}

package/dist/types/index.d.ts

@@ -1,4 +1,6 @@
 export * from './enums';
 export * from './interfaces';
 export * from './liquid-commerce-client';
+export * from './liquid-commerce-order-client';
+export * from './liquid-commerce-payment-element';
 export * from './types';

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

@@ -1,2 +1,2 @@
-import { LIQUID_COMMERCE_ENV, LiquidCommerce } from './index';
-export { LIQUID_COMMERCE_ENV, LiquidCommerce };
+import { LIQUID_COMMERCE_ENV, LiquidCommerce, LiquidCommerceOrders, LiquidCommercePaymentElement } from './index';
+export { LIQUID_COMMERCE_ENV, LiquidCommerce, LiquidCommerceOrders, LiquidCommercePaymentElement };

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

@@ -99,8 +99,10 @@ export interface IAddressDetailsParams extends ICoreParams {
  *
  * @property {string} formattedAddress - The formatted address as a string.
  * @property {ICoords} coords - The coordinates associated with the address.
+ * @property {Omit<IAddress, 'id'>} address - The address object containing all address fields except the id property.
  */
 export interface IAddressDetailsResult {
     formattedAddress: string;
     coords: ICoords;
+    address: Omit<IAddress, 'id'>;
 }

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

@@ -1,6 +1,6 @@
 import type { CART_EVENT_ENUM } from '../enums';
 import type { ILoc, ILocBase } from './address.interface';
-import type { IProduct } from './catalog.interface';
+import type { IProduct, IProductPresale } from './catalog.interface';
 import type { IRetailer } from './retailer.interface';
 /**
  * Represents the engraving information for a cart item.
@@ -44,6 +44,7 @@ export interface ICartItemGiftCart {
  */
 export interface ICartItemAttributes {
     engraving: ICartItemEngraving;
+    presale: IProductPresale;
     giftCard: ICartItemGiftCart;
 }
 /**
@@ -60,6 +61,7 @@ export interface ICartItem extends Partial<Omit<IProduct, 'attributes'>> {
     salsifyPid?: string;
     partNumber: string;
     upc: string;
+    sku: string;
     name: string;
     brand: string;
     size: string;
@@ -92,18 +94,6 @@ export interface ICartAttributesPromoCode {
     freeServiceFee: boolean;
     freeShipping: boolean;
 }
-/**
- * Represents the attributes of a gift card in a cart.
- *
- * @interface ICartAttributesGiftCard
- *
- * @property {string} code - The code of the gift card.
- * @property {number} value - The value of the gift card in the cart.
- */
-export interface ICartAttributesGiftCard {
-    code: string;
-    value: number;
-}
 /**
  * Represents the attributes, amounts, and fees associated with a cart.
  */
@@ -135,7 +125,6 @@ export interface ICartAttributesAmounts {
  */
 export interface ICartAttributes {
     promoCode: ICartAttributesPromoCode;
-    giftCards: ICartAttributesGiftCard[];
     amounts: ICartAttributesAmounts;
 }
 /**
@@ -174,6 +163,8 @@ export interface ICart {
     giftCardTotal: number;
     subtotal: number;
     total: number;
+    isPresaleLocked: boolean;
+    presaleExpiresAt: string | null;
     createdAt: string | Date;
     updatedAt: string | Date;
     items: ICartItem[];
@@ -202,5 +193,4 @@ export interface ICartUpdateParams extends ILocBase {
     id: string;
     items: ICartUpdateItem[];
     promoCode?: string;
-    giftCards?: string[];
 }

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

@@ -1,4 +1,4 @@
-import type { ENUM_AVAILABILITY_VALUE, ENUM_ENGRAVING, ENUM_FILTER_KEYS, ENUM_MODALITIES, ENUM_NAVIGATION_ORDER_DIRECTION_TYPE, ENUM_ORDER_BY } from '../enums';
+import type { ENUM_AVAILABILITY_VALUE, ENUM_BINARY_FILTER, ENUM_ENGRAVING, ENUM_FILTER_KEYS, ENUM_MODALITIES, ENUM_NAVIGATION_ORDER_DIRECTION_TYPE, ENUM_ORDER_BY } from '../enums';
 import type { LiquidTaxonomy } from '../types';
 import type { ILocBase } from './address.interface';
 import type { IRetailer } from './retailer.interface';
@@ -52,7 +52,18 @@ export interface IFulfillmentFilter {
  */
 export interface IEngravingFilter {
     key: ENUM_FILTER_KEYS.ENGRAVING | 'engraving';
-    values: ENUM_ENGRAVING | keyof typeof ENUM_ENGRAVING;
+    values: ENUM_BINARY_FILTER | keyof typeof ENUM_BINARY_FILTER | ENUM_ENGRAVING | keyof typeof ENUM_ENGRAVING;
+}
+/**
+ * The IPresaleFilter interface defines the structure for filtering presale items in a given context.
+ * It includes properties for specifying the filter key and the filter values.
+ *
+ * @property {ENUM_FILTER_KEYS.PRESALE | 'presale'} key - The key indicating the type of filter, specific to presale.
+ * @property {ENUM_BINARY_FILTER | keyof typeof ENUM_BINARY_FILTER} values - The values associated with the presale filter, which can be enumerable binary filter values.
+ */
+export interface IPresaleFilter {
+    key: ENUM_FILTER_KEYS.PRESALE | 'presale';
+    values: ENUM_BINARY_FILTER | keyof typeof ENUM_BINARY_FILTER;
 }
 /**
  * Represents a filter interface for defining key-value pairs used in filtering operations.
@@ -73,9 +84,10 @@ export interface ICatalogParams extends ILocBase {
     page?: number;
     perPage?: number;
     visitorId?: string;
+    retailers?: string[];
     orderBy?: ENUM_ORDER_BY;
     orderDirection?: ENUM_NAVIGATION_ORDER_DIRECTION_TYPE;
-    filters?: Array<ICategoryFilter | IPriceFilter | IAvailabilityFilter | IFulfillmentFilter | IEngravingFilter | IFilter>;
+    filters?: Array<ICategoryFilter | IPriceFilter | IAvailabilityFilter | IFulfillmentFilter | IEngravingFilter | IPresaleFilter | IFilter>;
 }
 /**
  * ICatalog interface represents a structured collection of retailers, products, and navigation schema.
@@ -91,7 +103,7 @@ export interface ICatalog {
  * It is designed to hold a specific value and its associated count.
  */
 export interface IFilterValue {
-    value: LiquidTaxonomy | ENUM_AVAILABILITY_VALUE | string;
+    value: LiquidTaxonomy | ENUM_AVAILABILITY_VALUE | ENUM_BINARY_FILTER | string;
     count: number;
 }
 /**
@@ -100,7 +112,7 @@ export interface IFilterValue {
  * flavor, region, price, availability, and more.
  * Each key corresponds to an enumerated value in ENUM_FILTER_KEYS.
  */
-export type FacetFilterKeys = ENUM_FILTER_KEYS.BRANDS | ENUM_FILTER_KEYS.FLAVOR | ENUM_FILTER_KEYS.REGION | ENUM_FILTER_KEYS.VARIETY | ENUM_FILTER_KEYS.ENGRAVING | ENUM_FILTER_KEYS.PRICE | ENUM_FILTER_KEYS.AVAILABILITY | ENUM_FILTER_KEYS.CATEGORIES | ENUM_FILTER_KEYS.SIZES | ENUM_FILTER_KEYS.COLORS | ENUM_FILTER_KEYS.APPELLATION | ENUM_FILTER_KEYS.COUNTRY | ENUM_FILTER_KEYS.VINTAGE | ENUM_FILTER_KEYS.MATERIALS | ENUM_FILTER_KEYS.TAGS;
+export type FacetFilterKeys = ENUM_FILTER_KEYS.BRANDS | ENUM_FILTER_KEYS.FLAVOR | ENUM_FILTER_KEYS.REGION | ENUM_FILTER_KEYS.VARIETY | ENUM_FILTER_KEYS.ENGRAVING | ENUM_FILTER_KEYS.PRESALE | ENUM_FILTER_KEYS.PRICE | ENUM_FILTER_KEYS.AVAILABILITY | ENUM_FILTER_KEYS.CATEGORIES | ENUM_FILTER_KEYS.SIZES | ENUM_FILTER_KEYS.COLORS | ENUM_FILTER_KEYS.APPELLATION | ENUM_FILTER_KEYS.COUNTRY | ENUM_FILTER_KEYS.VINTAGE | ENUM_FILTER_KEYS.MATERIALS | ENUM_FILTER_KEYS.TAGS;
 /**
  * IFilterSchema represents the structure for filtering datasets based on specific criteria.
  */
@@ -267,13 +279,37 @@ export interface IProductSizeEngraving {
     fee: number;
     location: string;
 }
+/**
+ * Interface representing a product presale.
+ *
+ * @interface IProductPresale
+ *
+ * @property {null | string} canPurchaseOn - The date when the product can be added to the cart.
+ *                                      If null, the canPurchaseOn date is not set.
+ *
+ * @property {null | string} estimatedShipBy - The date when the product is expected to ship.
+ *                                      If null, the estimatedShipBy date is not set.
+ *
+ * @property {boolean} isActive - Indicates whether the presale is currently active.
+ *
+ * @property {string} language - The language associated with the product presale.
+ */
+export interface IProductPresale {
+    canPurchaseOn: null | string;
+    estimatedShipBy: null | string;
+    isActive: boolean;
+    language: string;
+}
 /**
  * Interface representing attributes related to the size of a product.
  *
  * @property {IProductSizeEngraving} [engraving] - Optional engraving details for the product size.
  */
 export interface IProductSizeAttributes {
-    engraving?: IProductSizeEngraving;
+    salsifyPid?: string;
+    salsifyGrouping?: string;
+    presale: IProductPresale;
+    engraving: IProductSizeEngraving;
 }
 /**
  * Represents the size details of a product in an inventory system.
@@ -296,6 +332,17 @@ export interface IProductSize {
     modalities?: ENUM_MODALITIES;
     variants: IProductVariant[];
 }
+/**
+ * Represents product price information.
+ *
+ * @interface IProductPriceInfo
+ */
+export interface IProductPriceInfo {
+    currency: string;
+    minimum: number;
+    average: number;
+    maximum: number;
+}
 /**
  * Represents a product with various attributes and details.
  */
@@ -326,4 +373,5 @@ export interface IProduct {
     images: string[] | Array<Record<string, any>>;
     sizes: IProductSize[];
     attributes?: Partial<IAttributes>;
+    priceInfo: IProductPriceInfo | null;
 }

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

@@ -1,45 +1,8 @@
+import type { CHECKOUT_EVENT_ENUM } from '../enums';
 import type { ICoreParams } from '../types';
 import type { IAddress } from './address.interface';
 import type { ICartItemAttributes } from './cart.interface';
 import type { IRetailerExpectation } from './retailer.interface';
-/**
- * Represents a recipient of a checkout process.
- *
- * Contains recipient's information such as name, contact details, and
- * an optional flag for age verification.
- *
- * @interface
- * @public
- * @deprecated Use ICheckoutCustomer interface instead.
- * ICheckoutRecipient will be removed in a future version.
- */
-export interface ICheckoutRecipient {
-    firstName?: string;
-    lastName?: string;
-    email?: string;
-    phone?: string;
-    birthDate?: string;
-    hasAgeVerify?: boolean;
-}
-/**
- * Represents a traditional billing address structure.
- *
- * @interface
- * @public
- * @deprecated Use ICheckoutBillingAddress instead for better integration with customer data.
- */
-export interface IBillingAddress {
-    firstName?: string;
-    lastName?: string;
-    email?: string;
-    phone?: string;
-    one?: string;
-    two?: string;
-    city?: string;
-    state?: string;
-    zip?: string;
-    country?: string;
-}
 /**
  * Represents a customer in a checkout process.
  *
@@ -58,11 +21,6 @@ export interface ICheckoutCustomer {
     phone?: string;
     profileImage?: string;
     birthDate?: string;
-    /**
-     * @deprecated - Moved to ICheckoutPrepareParams
-     * @type {ICheckoutPrepareParams}
-     */
-    hasAgeVerify?: boolean;
     createdAt?: Date;
     updatedAt?: Date;
 }
@@ -117,7 +75,7 @@ export interface ICheckoutMarketingPreferences {
     canSms?: boolean;
 }
 /**
- * Represents the delivery tip for a checkout.
+ * Represents the delivery tip for a checkout's specific fulfillment method.
  *
  * @interface
  */
@@ -125,6 +83,15 @@ export interface ICheckoutDeliveryTip {
     fulfillmentId: string;
     tip: number;
 }
+/**
+ * Represents the delivery instructions for a checkout's specific fulfillment method.
+ *
+ * @interface
+ */
+export interface ICheckoutDeliveryInstructions {
+    fulfillmentId: string;
+    instructions: string;
+}
 /**
  * Defines the parameters required for preparing a checkout.
  *
@@ -135,26 +102,24 @@ export interface ICheckoutDeliveryTip {
 export interface ICheckoutPrepareParams extends ICoreParams {
     cartId: string;
     customer?: ICheckoutCustomer | string;
-    /**
-     * @deprecated Use customer property instead. Recipient will be removed in a future version.
-     */
-    recipient?: ICheckoutRecipient;
     hasAgeVerify?: boolean;
     shippingAddressTwo?: string;
     /**
      * Billing address information supporting both new and legacy formats.
-     * Recommended to use ICheckoutBillingAddress format for new implementations.
      */
-    billingAddress?: ICheckoutBillingAddress | IBillingAddress;
+    billingAddress?: ICheckoutBillingAddress;
     hasSubstitutionPolicy?: boolean;
     isGift?: boolean;
     billingSameAsShipping?: boolean;
     giftOptions?: ICheckoutGiftOptions;
     marketingPreferences?: ICheckoutMarketingPreferences;
     deliveryTips?: ICheckoutDeliveryTip[];
+    deliveryInstructions?: ICheckoutDeliveryInstructions[];
     acceptedAccountCreation?: boolean;
     scheduledDelivery?: string;
     payment?: string;
+    promoCode?: string;
+    giftCards?: string[];
 }
 /**
  * Represents total amounts and discounts for a checkout process.
@@ -218,6 +183,7 @@ export interface ICheckoutTotalAmounts {
  */
 export interface ICheckoutFulfillment extends ICheckoutTotalAmounts {
     id: string;
+    deliveryInstructions: string;
     scheduledFor?: string | Date;
     type: 'shipping' | 'onDemand';
     expectation: IRetailerExpectation;
@@ -264,13 +230,10 @@ export interface ICheckoutItem {
     pack: boolean;
     packDesc: string;
     mainImage: string;
-    /**
-     * @deprecated - use mainImage
-     */
-    image: string;
     brand: string;
     partNumber: string;
     upc: string;
+    sku: string;
     price: number;
     unitPrice: number;
     quantity: number;
@@ -279,6 +242,36 @@ export interface ICheckoutItem {
     bottleDeposits: number;
     attributes: ICartItemAttributes;
 }
+/**
+ * Interface representing a gift card utilized during checkout.
+ *
+ * This interface defines the structure for a gift card,
+ * including its code, the amount applied during the transaction,
+ * and any remaining balance on the card.
+ *
+ * Properties:
+ * - `code`: The unique code of the gift card used for identification.
+ * - `applied`: The amount deducted from the gift card during the current transaction.
+ * - `balance`: The remaining balance on the gift card after the applied amount is deducted.
+ */
+export interface ICheckoutGiftCard {
+    code: string;
+    applied: number;
+    balance: number;
+}
+/**
+ * Interface representing events related to the checkout process.
+ * This interface defines the structure for any event emitted or handled
+ * during the checkout workflow, including the type of event and its corresponding message.
+ *
+ * @interface ICheckoutEvents
+ * @property {CHECKOUT_EVENT_ENUM} type - The type of the checkout event.
+ * @property {string} message - A message providing additional context or details about the event.
+ */
+export interface ICheckoutEvents {
+    type: CHECKOUT_EVENT_ENUM;
+    message: string;
+}
 /**
  * Represents a response object for preparing a checkout process.
  *
@@ -300,13 +293,15 @@ export interface ICheckoutPrepareResponse {
     shippingAddress: IAddress;
     /**
      * Billing address information supporting both new and legacy formats.
-     * Recommended to use ICheckoutBillingAddress format for new implementations.
      */
-    billingAddress: ICheckoutBillingAddress | IBillingAddress;
+    billingAddress: ICheckoutBillingAddress;
     amounts: ICheckoutTotalAmounts;
     items: ICheckoutItem[];
     retailers: ICheckoutRetailer[];
     payment?: string;
+    giftCards: ICheckoutGiftCard[];
+    events: ICheckoutEvents[];
+    promoCode: string;
 }
 /**
  * Represents the parameters required for completing a checkout process.
@@ -326,7 +321,7 @@ export interface ICheckoutCompleteParams extends ICoreParams {
  */
 export interface ICheckoutCompleteResponse {
     order: {
-        number: string;
+        legacyOrderNumber: string;
         referenceId: string;
     };
 }

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

@@ -3,6 +3,9 @@ export * from './cart.interface';
 export * from './catalog.interface';
 export * from './checkout.interface';
 export * from './liquid-commerce-client.interface';
+export * from './liquid-commerce-order-client.interface';
+export * from './order.interface';
 export * from './payment.interface';
+export * from './payment-element.interface';
 export * from './retailer.interface';
 export * from './user.interface';