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

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

@@ -1,4 +1,6 @@
+import { type ApiResult } from '@/core/api/api-result';
 import type { ElementsEnv } from '@/enums';
+import type { IAllConfigs } from '@/interfaces/configs/global.interface';
 export interface IAuthConfig {
     apiKey: string;
     env: ElementsEnv;
@@ -9,45 +11,56 @@ export interface IHttpRequestOptions {
     body?: any;
 }
 export interface IAuth {
-    token: string;
-    exp: number;
-    type: 'ACCESS_TOKEN';
-}
-export interface IResponseMetadata {
-    languages: string[];
-    timestamp: number;
-    timezone: string;
-    requestId: string;
-    path: string;
-    version: string;
-}
-export interface IApiResponseBase {
+    accessToken: string;
+    expiration: number;
+}
+export interface IApiResponse<T> {
+    message: string;
+    data: T;
+}
+export interface IApiErrorDetail {
+    field?: string;
+    message: string;
+    code?: string;
+}
+export interface IApiError {
     statusCode: number;
     message: string;
-    metadata: IResponseMetadata;
+    errors: IApiErrorDetail[];
+}
+export interface IAuthWithConfigs {
+    auth: IAuth;
+    configs: IAllConfigs;
 }
-export type IApiResponseWithData<T> = IApiResponseBase & {
-    data: T;
-};
 export declare class AuthClientService {
+    private static readonly TOKEN_EXPIRATION_BUFFER_MS;
     private readonly apiKey;
     private readonly baseUrl;
     private readonly env;
-    private accessToken;
-    private tokenExpiration;
-    private isAuthenticating;
     private readonly httpClient;
     private readonly logger;
     private readonly clientConfig;
+    private accessToken;
+    private tokenExpiration;
+    private refreshPromise;
     private constructor();
     static getInstance(config: IAuthConfig): AuthClientService;
-    authenticate(): Promise<boolean>;
-    isTokenExpired(): boolean;
+    authenticateAndGetConfigs(): Promise<{
+        success: boolean;
+        configs?: IAllConfigs;
+    }>;
+    refreshToken(): Promise<boolean>;
+    get<TData = unknown>(path: string, options?: IHttpRequestOptions): Promise<ApiResult<TData>>;
+    post<TData = unknown>(path: string, options?: IHttpRequestOptions): Promise<ApiResult<TData>>;
+    private performTokenRefresh;
     private request;
+    private handleSuccessResponse;
+    private handleAuthError;
+    private handleErrorResponse;
+    private isTokenExpired;
+    private clearToken;
     private buildUrl;
+    private buildHeaders;
     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>;
+    private isAccessTokenError;
 }

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

@@ -21,24 +21,16 @@ export interface IRequestOptions {
 export interface IHttpRequestConfig {
     url: string;
     options: IHttpClientOptions;
-    retryConfig?: {
-        maxRetries: number;
-        retryDelay: number;
-        shouldRetry?: (error: any, response?: ICustomResponse) => boolean;
-    };
 }
 export declare class HttpClientService {
     private readonly fetchImpl;
     private readonly logger;
     constructor();
     request(config: IHttpRequestConfig): Promise<ICustomResponse>;
-    private defaultShouldRetry;
     private logFailedResponse;
     private logNetworkError;
     private diagnosePossibleCauses;
     private enhanceError;
-    private sanitizeHeaders;
-    private delay;
     private getFetchImplementation;
     private fetchAdapter;
     private xhrFetch;

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

@@ -1,3 +1,4 @@
+import { AnnouncerService } from '@/core/a11y';
 import { ClientConfigService } from '@/core/client/client-config.service';
 import { LoggerFactory } from '@/core/logger/logger-factory';
 import { PubSubService } from '@/core/pubsub/pubsub.service';
@@ -7,6 +8,7 @@ import { TelemetryService } from '@/core/telemetry/telemetry.service';
 import type { ComponentType } from '@/enums';
 import type { ConfigsKeyType, ConfigsType } from '@/interfaces/configs';
 import { ThemeProviderService } from '@/modules/theme-provider/theme-provider.service';
+import { SafeHTMLElement } from '@/utils/dom-compat';
 import { CommandService } from './command/command.service';
 export interface IBaseComponentConfig {
     type: ComponentType;
@@ -25,7 +27,7 @@ export interface IOnStoreChanged {
     value: any;
     oldValue: any;
 }
-export declare abstract class BaseComponent<TParams = Record<string, any>, TConfig = ConfigsType> extends HTMLElement {
+export declare abstract class BaseComponent<TParams = Record<string, any>, TConfig = ConfigsType> extends SafeHTMLElement {
     protected readonly store: StoreService;
     protected readonly commands: CommandService;
     protected readonly themeProvider: ThemeProviderService;
@@ -33,6 +35,7 @@ export declare abstract class BaseComponent<TParams = Record<string, any>, TConf
     protected readonly logger: ReturnType<typeof LoggerFactory.get>;
     protected readonly clientConfig: ClientConfigService;
     protected readonly telemetry: TelemetryService;
+    protected readonly announcer: AnnouncerService;
     private initialized;
     private isDestroyed;
     private renderScheduled;

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

@@ -0,0 +1,22 @@
+import { ApiClientService } from '@/core/api/api-client.service';
+import { LoggerFactory } from '@/core/logger/logger-factory';
+import { PubSubService } from '@/core/pubsub/pubsub.service';
+import { StoreService } from '@/core/store/store.service';
+import type { ILocation } from '@/interfaces/api/address.interface';
+import type { IProductSizeEngraving, IProductVariant } from '@/interfaces/api/product.interface';
+import { ThemeProviderService } from '@/modules/theme-provider/theme-provider.service';
+export declare abstract class BaseActionService {
+    protected readonly pubSub: PubSubService;
+    protected readonly store: StoreService;
+    protected readonly api: ApiClientService;
+    protected readonly themeProvider: ThemeProviderService;
+    protected readonly logger: ReturnType<typeof LoggerFactory.get>;
+    constructor(loggerName: string);
+    protected getLocation(): ILocation | undefined;
+    protected sanitizeEngravingInput(rawLines: string[] | undefined, identifier: string): string[] | undefined;
+    protected clampEngravingToSizeLimits(requestedLines: string[], sizeEngraving: IProductSizeEngraving | undefined, identifier: string): string[] | undefined;
+    protected findVariantForFulfillment(variants: (IProductVariant | undefined)[], wantsEngraving: boolean): {
+        variant: IProductVariant | null;
+        engravingDropped: boolean;
+    };
+}

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

@@ -0,0 +1,18 @@
+import type { IAddressAddress, IAddressCoordinates, IAddressData } from '@/interfaces/api/address.interface';
+import { BaseActionService } from './base-action.service';
+export interface IAddressActions {
+    setAddressByPlacesId: (placesId: string) => Promise<void>;
+    setAddressManually: (address: IAddressAddress, coordinates: IAddressCoordinates) => Promise<void>;
+    clear: () => Promise<void>;
+    getDetails: () => IAddressData | null;
+}
+export declare class ClientAddressActionService extends BaseActionService {
+    private readonly command;
+    constructor();
+    static getInstance(): ClientAddressActionService;
+    get actions(): IAddressActions;
+    private setAddressByPlacesId;
+    private setAddressManually;
+    private clear;
+    private getDetails;
+}

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

@@ -0,0 +1,38 @@
+import type { IBaseCartEventData } from '@/core/pubsub/interfaces/cart.interface';
+import { type FulfillmentType } from '@/enums';
+import { BaseActionService } from './base-action.service';
+export interface IAddProductParams {
+    identifier: string;
+    fulfillmentType: FulfillmentType;
+    quantity: number;
+    engravingLines?: string[];
+}
+export interface ICartActions {
+    openCart: () => void;
+    closeCart: () => void;
+    toggleCart: () => void;
+    addProduct: (params: IAddProductParams[], openCart?: boolean) => Promise<void>;
+    applyPromoCode: (promoCode: string) => Promise<void>;
+    removePromoCode: () => Promise<void>;
+    resetCart: () => Promise<void>;
+    getDetails: () => IBaseCartEventData;
+}
+export declare class ClientCartActionService extends BaseActionService {
+    private readonly command;
+    private pendingCartParams;
+    private pendingCartOpenFlag;
+    constructor();
+    static getInstance(): ClientCartActionService;
+    get actions(): ICartActions;
+    private setupAddressUpdateListener;
+    private retryPendingCartOperation;
+    private clearPendingCartOperation;
+    private openCart;
+    private closeCart;
+    private toggleCart;
+    private addProduct;
+    private applyPromoCode;
+    private removePromoCode;
+    private resetCart;
+    private getDetails;
+}

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

@@ -0,0 +1,69 @@
+import type { ICheckoutDetailsEventData } from '@/core/pubsub/interfaces/checkout.interface';
+import type { IAnonymousCheckoutAddProductParams, IAnonymousCheckoutAddProductResponse } from '@/interfaces/api/checkout.interface';
+import type { IProductAvailabilityResponse } from '@/interfaces/api/product.interface';
+import type { BillingFieldName, CustomerFieldName, GiftFieldName } from '@/modules/checkout/constant';
+import { BaseActionService } from './base-action.service';
+import type { IAddProductParams } from './client-cart-action.service';
+export interface ISavedPaymentMethodInput {
+    id: string;
+    card: {
+        brand: string;
+        last4: string;
+        expMonth?: string | number;
+        expYear?: string | number;
+    };
+}
+export interface ICheckoutActions {
+    openCheckout: () => void;
+    closeCheckout: () => void;
+    toggleCheckout: () => void;
+    exitCheckout: () => void;
+    setSavedPaymentMethod: (params: ISavedPaymentMethodInput) => void;
+    clearSavedPaymentMethod: () => void;
+    addProduct: (params: IAddProductParams[], openCheckout?: boolean) => Promise<void>;
+    applyPromoCode: (promoCode: string) => Promise<void>;
+    removePromoCode: () => Promise<void>;
+    applyGiftCard: (code: string) => Promise<void>;
+    removeGiftCard: (code: string) => Promise<void>;
+    toggleIsGift: (active?: boolean) => Promise<void>;
+    toggleBillingSameAsShipping: (active?: boolean) => Promise<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;
+    getProductAvailabilityByState: (identifiers: string[], state?: string) => Promise<IProductAvailabilityResponse>;
+    addAnonymousProduct: (params: IAnonymousCheckoutAddProductParams) => Promise<IAnonymousCheckoutAddProductResponse>;
+}
+export declare class ClientCheckoutActionService extends BaseActionService {
+    private readonly command;
+    private readonly allowedCustomerFields;
+    private readonly allowedBillingFields;
+    private readonly allowedGiftFields;
+    private cartActionsAddProduct;
+    constructor();
+    static getInstance(): ClientCheckoutActionService;
+    setCartActionsAddProduct(addProductFn: (params: IAddProductParams[]) => Promise<void>): void;
+    get actions(): ICheckoutActions;
+    private normalizeCheckoutFieldValue;
+    private openCheckout;
+    private closeCheckout;
+    private toggleCheckout;
+    private exitCheckout;
+    private setSavedPaymentMethod;
+    private clearSavedPaymentMethod;
+    private addProduct;
+    private applyPromoCode;
+    private removePromoCode;
+    private applyGiftCard;
+    private removeGiftCard;
+    private toggleIsGift;
+    private toggleBillingSameAsShipping;
+    private toggleMarketingPreferences;
+    private updateCustomerInfo;
+    private updateBillingInfo;
+    private updateGiftInfo;
+    private getDetails;
+    private addAnonymousProduct;
+    private getProductAvailabilityByState;
+}

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

@@ -0,0 +1,15 @@
+import type { IBaseProductEventData } from '@/core/pubsub/interfaces/product.interface';
+import type { IProductAvailabilityResponse } from '@/interfaces/api/product.interface';
+import { BaseActionService } from './base-action.service';
+export interface IProductActions {
+    getDetails: (identifier: string) => IBaseProductEventData;
+    getProductAvailabilityByState: (identifiers: string[], state?: string) => Promise<IProductAvailabilityResponse>;
+}
+export declare class ClientProductActionService extends BaseActionService {
+    private readonly command;
+    constructor();
+    static getInstance(): ClientProductActionService;
+    get actions(): IProductActions;
+    private getDetails;
+    private getProductAvailabilityByState;
+}

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

@@ -1,71 +1,10 @@
-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;
-}
-export interface IAddressActions {
-    setAddressByPlacesId: (placesId: string) => Promise<void>;
-    setAddressManually: (address: Omit<IAddress, 'id'>, coordinates: ICoords) => Promise<void>;
-    clear: () => Promise<void>;
-    getDetails: () => IAddressData | null;
-}
-export interface IAddProductParams {
-    identifier: string;
-    fulfillmentType: FulfillmentType;
-    quantity: number;
-}
-export interface ICartActions {
-    openCart: () => void;
-    closeCart: () => void;
-    toggleCart: () => void;
-    addProduct: (params: IAddProductParams[], openCart?: boolean) => Promise<void>;
-    applyPromoCode: (promoCode: string) => Promise<void>;
-    removePromoCode: () => Promise<void>;
-    resetCart: () => Promise<void>;
-    getDetails: () => IBaseCartEventData;
-}
-export interface ICheckoutActions {
-    openCheckout: () => void;
-    closeCheckout: () => void;
-    toggleCheckout: () => void;
-    addProduct: (params: IAddProductParams[], openCheckout?: boolean) => Promise<void>;
-    addPresaleProduct: (params: IAddProductParams) => Promise<void>;
-    applyPromoCode: (promoCode: string) => Promise<void>;
-    removePromoCode: () => Promise<void>;
-    applyGiftCard: (code: string) => Promise<void>;
-    removeGiftCard: (code: string) => Promise<void>;
-    toggleIsGift: (active?: boolean) => Promise<void>;
-    toggleBillingSameAsShipping: (active?: boolean) => Promise<void>;
-    toggleMarketingPreferences: (field: 'canEmail' | 'canSms', active: boolean) => void;
-    getDetails: () => ICheckoutDetailsEventData;
-}
+import type { ILiquidCommerceElementsActions } from '@/interfaces/client.interface';
 export declare class ClientActionService {
-    private readonly pubSub;
-    private readonly command;
-    private readonly store;
-    private readonly api;
-    private readonly themeProvider;
-    private readonly logger;
-    private pendingCartParams;
-    private pendingCartOpenFlag;
+    private readonly productActionService;
+    private readonly addressActionService;
+    private readonly cartActionService;
+    private readonly checkoutActionService;
     constructor();
     static getInstance(): ClientActionService;
-    private setupAddressUpdateListener;
-    private retryPendingCartOperation;
-    private clearPendingCartOperation;
-    private getLocation;
-    private productActions;
-    private addressActions;
-    private cartActions;
-    private checkoutActions;
-    actions: {
-        product: IProductActions;
-        address: IAddressActions;
-        cart: ICartActions;
-        checkout: ICheckoutActions;
-    };
+    get actions(): ILiquidCommerceElementsActions;
 }

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

@@ -1,6 +1,6 @@
 import { type DebugMode, type ElementsEnv } from '@/enums';
+import type { IClientCustomThemeConfig, IElementsProxyConfig, ILiquidCommerceElementsCheckoutConfig } from '@/interfaces/config.interface';
 import type { IPromoTicker } from '@/interfaces/configs';
-import type { IClientCustomThemeConfig, IElementsProxyConfig } from '@/interfaces/core.interface';
 export type DeviceType = 'desktop' | 'tablet' | 'mobile';
 export interface IClientConfigs {
     apiKey: string;
@@ -19,8 +19,11 @@ export interface IClientConfigs {
     version?: string;
     clientPrepared: boolean;
     promoTicker: IPromoTicker[] | null;
-    paymentMethodId?: string;
     openShadowDom?: boolean;
+    hasCustomApiUrl?: boolean;
+    mockMode: boolean;
+    checkout: ILiquidCommerceElementsCheckoutConfig | null;
+    isCheckoutOnly: boolean;
 }
 export interface IClientConfigInput {
     env?: ElementsEnv;
@@ -31,9 +34,11 @@ export interface IClientConfigInput {
     promoTicker?: IPromoTicker[];
     development?: {
         customApiUrl?: string;
-        paymentMethodId?: string;
         openShadowDom?: boolean;
+        mockMode?: boolean;
     };
+    checkout?: ILiquidCommerceElementsCheckoutConfig;
+    isCheckoutOnly?: boolean;
 }
 export declare class ClientConfigService {
     private config;
@@ -42,16 +47,15 @@ export declare class ClientConfigService {
     getConfigs(): IClientConfigs;
     get<K extends keyof IClientConfigs>(key: K): IClientConfigs[K];
     set<K extends keyof IClientConfigs>(key: K, value: IClientConfigs[K]): void;
-    isDevelopment(): boolean;
     isStaging(): boolean;
     isProduction(): boolean;
     isBuilder(): boolean;
+    isCheckoutOnly(): boolean;
     isDebuggingEnabled(): boolean;
     isDebugPanelEnabled(): boolean;
     debuggingDisabled(): boolean;
     hasCustomTheme(): boolean;
     isMobile(): boolean;
-    isLocalStorageAvailable(): boolean;
     getProxyConfig(): IElementsProxyConfig | null;
     private validateInputs;
     private buildConfiguration;

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;
@@ -32,6 +33,7 @@ interface BaseItem {
     quantity?: number;
     item_type?: string;
     item_subtype?: string;
+    item_image?: string;
     upc?: string;
     grouping_id?: string;
     product_id?: string;
@@ -47,10 +49,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?;
@@ -60,6 +63,7 @@ export declare class GoogleTagManagerService {
     private readonly clientConfigService;
     constructor();
     static getInstance(): GoogleTagManagerService;
+    private isGTMEnabledEnvironment;
     private waitForDOMReady;
     private isGTMAlreadyLoaded;
     private isContainerLoaded;
@@ -91,7 +95,7 @@ export declare class GoogleTagManagerService {
         net_total?: number;
     }): void;
     promoCodeAttempt(code: string): void;
-    promoCodeApplied(code: string, discountAmount?: number): void;
+    promoCodeApplied(code: string, discount?: number): void;
     promoCodeFailed(code: string, reason?: string): void;
     giftCardAttempt(code: string): void;
     giftCardApplied(code: string, appliedAmount?: number): void;
@@ -108,8 +112,8 @@ export declare class GoogleTagManagerService {
             country?: string;
         };
         coordinates?: {
-            lat: number;
-            long: number;
+            latitude: number;
+            longitude: number;
         };
     }): void;
     addressFailed(errorData: {

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

@@ -13,6 +13,6 @@ export declare class LoggerService {
     debug(message: string, data?: Record<string, any>): void;
     info(message: string, data?: Record<string, any>): void;
     warn(message: string, data?: Record<string, any>): void;
-    error(message: string, error?: Error | Record<string, any>): void;
+    error(message: string, errorOrData?: Error | Record<string, any>): void;
     private sendToTelemetry;
 }

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

@@ -1,16 +1,10 @@
+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;
+}
+export interface IAddressFailedEventData extends IAddressActionEventData {
+    error: string;
 }