@empathyco/x-components/types/x-installer/api/api.types.d.ts

Empathy X Components

import type { RequiredProperties } from '@empathyco/x-utils';
import type { DocumentDirection } from '../../plugins/x-plugin.types';
import type { XEvent, XEventPayload, XEventsTypes } from '../../wiring/events.types';
import type { WireMetadata } from '../../wiring/wiring.types';
import type { XBus } from '../../x-bus';
import type { QueryPreviewInfo } from '../../x-modules/queries-preview/index';
/**
 * Interface with the API functions exposes as X
 * {@link https://developer.mozilla.org/en-US/docs/Web/API/Window | window} property.
 *
 * @public
 */
export interface XAPI {
    /**
     * To track that a product was added to the cart from PDP.
     *
     * @param productId - The id of the product added to cart.
     *
     * @remarks if no productId is provided, then the current page url will be used as id for
     * getting the previously stored result information.
     */
    addProductToCart: (productId?: string) => void;
    /**
     * To get the snippet config object.
     *
     * @returns The {@link NormalisedSnippetConfig | snippetConfig} object.
     *
     * @public
     */
    getSnippetConfig: () => SnippetConfig;
    /**
     * To set the XBus to the API. This bus will be used to emit the necessary events.
     *
     * @internal
     */
    setBus: (bus: XBus<XEventsTypes, WireMetadata>) => void;
    /**
     * To set the callback to call after the call to method init. This is used from {@link XInstaller}
     * because the logic of initialization is there.
     *
     * @param initCallback - The callback to call passing in the {@link SnippetConfig}.
     *
     * @internal
     */
    setInitCallback: (initCallback: (config: SnippetConfig) => void) => void;
    /**
     * To set or update any property of the {@link SnippetConfig}.
     *
     * @param config - The properties to be changed.
     *
     * @public
     */
    setSnippetConfig: (config: Partial<SnippetConfig>) => void;
    /**
     * To set or update any property of the snippet config getter.
     *
     * @param snippetConfigGetter - A function that returns the snippet config object.
     *
     * @internal
     */
    setSnippetConfigGetter: (snippetConfigGetter: () => NormalisedSnippetConfig) => void;
    /**
     * To set the snippet config callback.
     *
     * @param callback - Function to be called.
     *
     * @internal
     */
    setSnippetConfigCallback: (callback: (config: Partial<SnippetConfig>) => void) => void;
    /**
     * Dispatch a search with the query parameter.
     *
     * @param query - Query to be searched.
     *
     * @public
     */
    search: (query?: string) => void;
    /**
     * Method to initialize the XComponents app.
     *
     * @param config - {@link SnippetConfig} To receive the customer parameters.
     *
     * @public
     */
    init: (config: SnippetConfig) => Promise<void>;
}
/**
 * Map type of every {@link XEvent} and a callback with the payload and metadata for that event.
 *
 * @public
 */
export type XEventListeners = Partial<{
    [Event in XEvent]: (payload: XEventPayload<Event>, metadata: WireMetadata) => unknown;
}>;
/**
 * Interface with the possible parameters to receive through the snippet integration.
 *
 * @public
 */
export interface SnippetConfig {
    /** Customer instance. */
    instance: string;
    /** Backend services environment. */
    env?: 'staging';
    /** Execution scope (desktop, mobile, app, ...). */
    scope: string;
    /** Language for the API request, and default value for {@link SnippetConfig.uiLang}. */
    lang: string;
    /** Language to use for the messages. Defaults to {@link SnippetConfig.lang}. */
    uiLang?: string;
    /** User GDPR consent. */
    consent?: boolean;
    /** Document direction. */
    documentDirection?: DocumentDirection;
    /** The currency name. There should be a currency format associated to this name in the app. */
    currency?: string;
    /** Callbacks to be triggered when an XEvent is emitted. */
    callbacks?: XEventListeners;
    /** Flag determining if the page is a single page application or not. */
    isSpa?: boolean;
    /** The id for the current product when product page is loaded. */
    productId?: string;
    /** The filters to be applied on the first request. */
    filters?: string[];
    /** List of queries to preview. */
    queriesPreview?: QueryPreviewInfo[];
    /** Any extra param to send in all backend calls. */
    [extra: string]: unknown;
}
/**
 * A normalised version of the snippet config.
 *
 * @public
 */
export type NormalisedSnippetConfig = RequiredProperties<SnippetConfig, 'uiLang'>;
//# sourceMappingURL=api.types.d.ts.map