@empathyco/x-components/types/plugins/x-plugin.types.d.ts

Empathy X Components

import type { Facet, Filter, HistoryQuery, NextQuery, PartialResult, Redirection, RelatedTag, Result, SemanticQuery, Suggestion, XComponentsAdapter } from '@empathyco/x-types';
import type { DeepPartial } from '@empathyco/x-utils';
import type { Store } from 'vuex';
import type { ActionsTree } from '../store/actions.types';
import type { GettersTree } from '../store/getters.types';
import type { MutationsTree } from '../store/mutations.types';
import type { AnyXStoreModule, XStoreModule } from '../store/store.types';
import type { RequestStatus } from '../store/utils/status-store.utils';
import type { StoreEmitters } from '../store/utils/store-emitters.utils';
import type { PropsWithType } from '../utils';
import type { XEvent, XEventPayload, XEventsTypes } from '../wiring/events.types';
import type { WireMetadata, Wiring } from '../wiring/wiring.types';
import type { XBus } from '../x-bus';
import type { ScrollComponentState } from '../x-modules/scroll/index';
import type { InputStatus } from '../x-modules/search-box/store/types';
import type { AnyXModule, ExtractState, XModuleName, XModulesTree } from '../x-modules/x-modules.types';
/**
 * {@link XPlugin} Installation options.
 *
 * @public
 */
export interface XPluginOptions {
    /** The adapter transforms the request for the the search and tagging APIs and its responses. */
    adapter: XComponentsAdapter;
    /**
     * A Vuex store to install the X module. If not passed a new one will be created and injected
     * into every component.
     */
    store?: Store<any>;
    /**
     * A {@link XModule | XModules} to be registered during the {@link XPlugin} installation.
     */
    initialXModules?: AnyXModule[];
    /**
     * Override the {@link XModule | XModules} config state and its wiring.
     */
    xModules?: XModulesOptions;
    /**
     * Override the {@link XModule | XModules} store module and store emitters. It must be used
     * only in exceptional cases.
     */
    __PRIVATE__xModules?: PrivateXModulesOptions;
}
/**
 * The HTML document direction orientation. Possible values: ltr (left to right) or rtl (right
 * to left).
 *
 * @public
 */
export type DocumentDirection = 'ltr' | 'rtl';
/**
 * The XComponentAPI exposes access to the XBus, and store aliases to the
 * components.
 *
 * @public
 */
export interface XComponentAPI extends XComponentBusAPI, XComponentAliasAPI {
}
/**
 * API for emitting and subscribing to events of the XBus.
 *
 * @public
 */
export interface XComponentBusAPI {
    /** {@inheritDoc XBus.(on:1)} */
    on: XBus<XEventsTypes, WireMetadata>['on'];
    /** {@inheritDoc XBus.(emit:1)} */
    emit: ((event: PropsWithType<XEventsTypes, void>) => void) & (<Event extends XEvent>(event: Event, payload: XEventPayload<Event>, metadata?: Omit<WireMetadata, 'moduleName' | 'origin' | 'location'>) => void);
}
/**
 * Alias to facilitate retrieving values from the store.
 *
 * @public
 */
export interface XComponentAliasAPI {
    /** The {@link DeviceXModule} detected device. */
    readonly device: string | null;
    /** The {@link FacetsXModule} facets. */
    readonly facets: Record<Facet['id'], Facet>;
    /** The {@link HistoryQueriesXModule} history queries matching the query. */
    readonly historyQueries: ReadonlyArray<HistoryQuery>;
    /** The {@link HistoryQueriesXModule} history queries with 1 or more results. */
    readonly historyQueriesWithResults: ReadonlyArray<HistoryQuery>;
    /** The {@link HistoryQueriesXModule} history queries. */
    readonly fullHistoryQueries: ReadonlyArray<HistoryQuery>;
    /** The {@link HistoryQueriesXModule} history queries enabled flag. */
    readonly isHistoryQueriesEnabled: Readonly<boolean>;
    /** The {@link SearchXModule} no results with filters flag. */
    readonly fromNoResultsWithFilters: Readonly<boolean>;
    /** The {@link IdentifierResultsXModule} results. */
    readonly identifierResults: ReadonlyArray<Result>;
    /** The {@link SearchBoxXModule } input status. */
    readonly searchBoxStatus: InputStatus | undefined;
    /** The {@link Empathize} is open state. */
    readonly isEmpathizeOpen: boolean;
    /** The {@link NextQueriesXModule} next queries. */
    readonly nextQueries: ReadonlyArray<NextQuery>;
    /** The {@link SearchXModule} no results situation. */
    readonly noResults: boolean;
    /** The {@link SearchXModule} partial results. */
    readonly partialResults: ReadonlyArray<PartialResult>;
    /** The {@link PopularSearchesXModule} popular searches. */
    readonly popularSearches: ReadonlyArray<Suggestion>;
    /** The query value of the different modules. */
    readonly query: XComponentAliasQueryAPI;
    /** The {@link QuerySuggestionsXModule} query suggestions that should be displayed. */
    readonly querySuggestions: ReadonlyArray<Suggestion>;
    /** The {@link QuerySuggestionsXModule} query suggestions. */
    readonly fullQuerySuggestions: ReadonlyArray<Suggestion>;
    /** The {@link RecommendationsXModule} recommendations. */
    readonly recommendations: ReadonlyArray<Result>;
    /** The {@link SearchXModule} redirections. */
    readonly redirections: ReadonlyArray<Redirection>;
    /** The {@link RelatedTagsXModule} related tags (Both selected and deselected). */
    readonly relatedTags: ReadonlyArray<RelatedTag>;
    /** The {@link SearchXModule} search results. */
    readonly results: ReadonlyArray<Result>;
    /** The {@link ScrollXModule} data state. */
    readonly scroll: Record<string, ScrollComponentState>;
    /** The {@link FacetsXModule} selected filters. */
    readonly selectedFilters: Filter[];
    /** The {@link RelatedTagsXModule} selected related tags. */
    readonly selectedRelatedTags: ReadonlyArray<RelatedTag>;
    /** The {@link SemanticQueriesXModule} queries. */
    readonly semanticQueries: ReadonlyArray<SemanticQuery>;
    /** The {@link SearchXModule} spellchecked query. */
    readonly spellcheckedQuery: string | null;
    /** The status value of the different modules. */
    readonly status: XComponentAliasStatusAPI;
    /** The {@link SearchXModule} total results. */
    readonly totalResults: number;
    /** The {@link SearchXModule} selected sort. */
    readonly selectedSort: string;
}
/**
 * Alias to facilitate retrieving the modules with query.
 *
 * @public
 */
export interface XComponentAliasQueryAPI {
    /** The {@link FacetsXModule} query. */
    readonly facets: string;
    /** The {@link SearchBoxXModule} query. */
    readonly searchBox: string;
    /** The {@link NextQueriesXModule} query. */
    readonly nextQueries: string;
    /** The {@link QuerySuggestionsXModule} query. */
    readonly querySuggestions: string;
    /** The {@link RelatedTagsXModule} query. */
    readonly relatedTags: string;
    /** The {@link SearchXModule} query. */
    readonly search: string;
}
/**
 * Alias to facilitate retrieving the modules with status.
 *
 * @public
 */
export interface XComponentAliasStatusAPI {
    /** The {@link IdentifierResultsXModule} status. */
    readonly identifierResults: RequestStatus | undefined;
    /** The {@link NextQueriesXModule} status. */
    readonly nextQueries: RequestStatus | undefined;
    /** The {@link PopularSearchesXModule} status. */
    readonly popularSearches: RequestStatus | undefined;
    /** The {@link QuerySuggestionsXModule} status. */
    readonly querySuggestions: RequestStatus | undefined;
    /** The {@link RecommendationsXModule} status. */
    readonly recommendations: RequestStatus | undefined;
    /** The {@link RelatedTagsXModule} status. */
    readonly relatedTags: RequestStatus | undefined;
    /** The {@link SearchXModule} status. */
    readonly search: RequestStatus | undefined;
}
/**
 * Options for overriding the default config state and wiring for each {@link XModule | XModule}.
 *
 * @public
 */
export type XModulesOptions = {
    [ModuleName in XModuleName]?: XModuleOptions<ModuleName>;
};
/**
 * Options for overriding the default config state and wiring for a {@link XModule | XModule}.
 *
 * @param ModuleName - The {@link XModuleName} to extract the config.
 * @public
 */
export interface XModuleOptions<ModuleName extends XModuleName> {
    /**
     * The options to override the default config state for the module.
     */
    config?: DeepPartial<ExtractState<ModuleName> extends {
        config: infer Config;
    } ? Config : never>;
    /**
     * The options to override the default wiring configuration for the module.
     */
    wiring?: Partial<Wiring>;
}
/**
 * Options for overriding the default store module and store emitters for each
 * {@link XModule | XModule}.
 *
 * @public
 */
export type PrivateXModulesOptions = {
    [ModuleName in XModuleName]?: PrivateXModuleOptions<XModulesTree[ModuleName]>;
};
/**
 * Options for overriding the default store module and store emitters for a
 * {@link XModule | XModule}.
 *
 * @param Module - The {@link XModule | XModule} to modify its default configuration.
 * @public
 */
export interface PrivateXModuleOptions<Module extends AnyXModule> {
    /**
     * The options to override events that will be emitted when the getters value or the state
     * of the store changes.
     */
    storeEmitters?: Partial<StoreEmitters<Module['storeModule']>>;
    /**
     * The options to override the default store module configuration.
     */
    storeModule?: XStoreModuleOptions<Module['storeModule']>;
}
/**
 * Options for overriding a default {@link XStoreModule}.
 *
 * @public
 */
export type XStoreModuleOptions<StoreModule extends AnyXStoreModule> = StoreModule extends XStoreModule<infer State, infer Getters, infer Mutations, infer Actions> ? {
    state?: DeepPartial<State>;
    actions?: DeepPartial<ActionsTree<State, Getters, Mutations, Actions>>;
    getters?: DeepPartial<GettersTree<State, Getters>>;
    mutations?: DeepPartial<MutationsTree<State, Mutations>>;
} : never;
/**
 * Alias for any store module option. Use only when you don't care about the module concrete type.
 *
 * @public
 */
export type AnyXStoreModuleOption = XStoreModuleOptions<AnyXStoreModule>;
//# sourceMappingURL=x-plugin.types.d.ts.map