@coveo/headless
    Preparing search index...

    Module SSR Commerce

    The Coveo Headless SSR Commerce sub-package exposes the engine, definers, controllers, actions, and utility functions to build a server side rendered commerce experience.

    import {
    Controller,
    ControllerDefinitionsMap,
    CommerceEngineDefinitionOptions,
    CommerceEngine,
    defineCommerceEngine,
    InferStaticState,
    InferHydratedState,
    defineProductList,
    getSampleCommerceEngineConfiguration,
    } from '@coveo/headless/ssr-commerce';

    type CommerceEngineConfig = CommerceEngineDefinitionOptions<
    ControllerDefinitionsMap<CommerceEngine, Controller>
    >;

    const config = {
    configuration: {
    ...getSampleCommerceEngineConfiguration(),
    context: {
    language: 'en',
    country: 'US',
    currency: 'USD',
    view: {
    url: '...',
    },
    },
    },
    controllers: {
    productList: defineProductList(),
    },
    } satisfies CommerceEngineConfig;

    const engineDefinition = defineCommerceEngine(engineConfig);

    export const {
    listingEngineDefinition,
    searchEngineDefinition,
    standaloneEngineDefinition,
    } = engineDefinition;

    export type ListingStaticState = InferStaticState<
    typeof listingEngineDefinition
    >;
    export type ListingHydratedState = InferHydratedState<
    typeof listingEngineDefinition
    >;

    export type SearchStaticState = InferStaticState<typeof searchEngineDefinition>;
    export type SearchHydratedState = InferHydratedState<
    typeof searchEngineDefinition
    >;

    export type StandaloneStaticState = InferStaticState<
    typeof standaloneEngineDefinition
    >;
    export type StandaloneHydratedState = InferHydratedState<
    typeof standaloneEngineDefinition
    >;
    CartActionCreators
    loadCartActions
    CategoryFacetSetActionCreators
    CoreFacetActionsCreators
    loadCategoryFacetSetActions
    loadCoreFacetActions
    ConfigurationActionCreators
    loadConfigurationActions
    ContextActionCreators
    loadContextActions
    DateFacetActionCreators
    loadDateFacetActions
    InstantProductsActionCreators
    loadInstantProductsActions
    NumericFacetActionCreators
    loadNumericFacetActions
    PaginationActionCreators
    loadPaginationActions
    ProductActionCreators
    loadProductActions
    ProductEnrichmentActionCreators
    loadProductEnrichmentActions
    ProductListingActionCreators
    loadProductListingActions
    ProductListingParametersActionCreators
    loadProductListingParametersActions
    QueryActionCreators
    loadQueryActions
    QuerySetActionCreators
    loadQuerySetActions
    QuerySuggestActionCreators
    loadQuerySuggestActions
    RecentQueriesActionCreators
    loadRecentQueriesActions
    RecommendationsActionCreator
    loadRecommendationsActions
    RegularFacetActionCreators
    loadRegularFacetActions
    SearchActionCreators
    loadSearchActions
    SearchParametersActionCreators
    loadSearchParametersActions
    SortActionCreators
    loadSortActions
    StandaloneSearchBoxSetActionCreators
    loadStandaloneSearchBoxSetActions
    TriggersActionCreators
    loadTriggersActions
    Cart
    CartState
    CategoryFilterSuggestions
    CategoryFilterSuggestionsState
    Context
    ContextState
    FilterSuggestions
    FilterSuggestionsState
    FilterSuggestionsGenerator
    InstantProducts
    InstantProductsState
    ProductListing
    ProductListState
    RecentQueriesList
    RecentQueriesState
    Recommendations
    StandaloneSearchBox
    StandaloneSearchBoxState
    DidYouMeanState
    NotifyTrigger
    NotifyTriggerState
    QueryTrigger
    QueryTriggerState
    RedirectionTrigger
    RedirectionTriggerState
    SearchBoxState
    defineBreadcrumbManager
    defineCart
    defineContext
    defineDidYouMean
    defineFacetGenerator
    defineFilterSuggestionsGenerator
    defineInstantProducts
    defineNotifyTrigger
    definePagination
    defineParameterManager
    defineProductEnrichment
    defineProductList
    defineProductView
    defineQueryTrigger
    defineRecentQueriesList
    defineRecommendations
    defineRedirectionTrigger
    defineSearchBox
    defineSort
    defineStandaloneSearchBox
    defineSummary
    CommerceEngine
    defineCommerceEngine
    Kind
    ResultType
    SolutionType
    SortBy
    SortOrder
    buildCriterionExpression
    buildDateSortCriterion
    buildFieldSortCriterion
    buildNoSortCriterion
    buildParameterSerializer
    buildQueryExpression
    buildQueryRankingExpressionSortCriterion
    buildRelevanceSortCriterion
    buildResultTemplatesManager
    deserializeRelativeDate
    getAnalyticsNextApiBaseUrl
    getCommerceApiBaseUrl
    getOrganizationEndpoint
    getSampleCommerceEngineConfiguration
    parseCriterionExpression
    validateRelativeDate
    AnalyticsConfiguration
    ApplyQueryTriggerModificationPayload
    BaseFacetSearchResult
    BaseProduct
    BuildOptions
    CartBuildProps
    CartDefinition
    CartInitialState
    CartItem
    CartProps
    CategoryFacetSearchResult
    CategoryFacetValue
    CommerceEngineConfiguration
    CommerceEngineDefinition
    CommerceSearchParameters
    ContextDefinition
    ContextOptions
    ContextProps
    Controller
    ControllerDefinitionsMap
    ControllerWithKind
    CoreInstantProductPayload
    CorePaginationOptions
    CoreSearchBox
    CustomContext
    DateFieldExpression
    DateRangeFieldExpression
    DidYouMeanOptions
    EngineConfiguration
    EngineDefinition
    EngineStaticState
    ExactMatchExpression
    ExternalEngineOptions
    FacetGenerator
    FetchBadgesPayload
    FetchRecommendationsPayload
    FetchRedirectUrlPayload
    FetchSearchPayload
    FieldExistsExpression
    FieldSuggestionsFacet
    FilterSuggestionsGeneratorDefinition
    FromBuildResultOptions
    HighlightKeyword
    HydratedState
    HydrateStaticStateOptions
    InstantProductsDefinition
    InstantProductsOptions
    InstantProductsProps
    InteractiveProduct
    InteractiveProductOptions
    KeywordExpression
    LocationFacetValue
    LoggerOptions
    Middleware
    NearExpression
    Negatable
    NotifyTriggerDefinition
    NumericFieldExpression
    NumericRangeFieldExpression
    OtherTerm
    PaginationProps
    ParameterManagerProps
    Parameters
    Product
    ProductEnrichment
    ProductEnrichmentDefinition
    ProductEnrichmentProps
    ProductEnrichmentState
    ProductListingSummaryState
    ProductTemplatesManager
    ProductView
    PromoteChildToParentPayload
    QueryExpression
    QueryExtensionExpression
    QueryTriggerDefinition
    RecentQueriesListDefinition
    RecentQueriesListInitialState
    RecentQueriesListProps
    RecommendationsDefinition
    RecommendationsState
    RecommendationsSummaryState
    RedirectionTriggerDefinition
    RegisterProductEnrichmentOptionsPayload
    RegisterRecentQueriesCreatorPayload
    RegisterStandaloneSearchBoxPayload
    RegularFacetValue
    RelativeDate
    Relay
    ResetStandaloneSearchBoxPayload
    SearchBoxDefinition
    SearchBoxProps
    SearchSummaryState
    SetContextPayload
    SortProps
    SpotlightContent
    SSRParameterManagerProps
    StandaloneSearchBoxDefinition
    StandaloneSearchBoxProps
    StringFacetFieldExpression
    StringFieldExpression
    Subscribable
    Suggestion
    Summary
    SummaryState
    Template
    ToggleSelectNumericFacetValuePayload
    Unsubscribe
    UpdateInstantProductQueryPayload
    UpdateNumericFacetValuesPayload
    UpdateQueryPayload
    UserLocation
    View
    CategoryFacet
    CategoryFacetState
    DateFacet
    DateFacetState
    DidYouMean
    LocationFacet
    LocationFacetState
    NumericFacet
    NumericFacetState
    Pagination
    PaginationState
    ParameterManager
    ParameterManagerState
    RegularFacet
    RegularFacetState
    Sort
    SortState
    AnalyticsRuntimeEnvironment
    ApplySortPayload
    BrowserNavigatorContextProvider
    Build
    CartActionPayload
    ChildProduct
    ClearExpiredInstantProductsPayload
    ClearQuerySuggestPayload
    CommerceAppState
    CommerceEngineDefinitionOptions
    CommerceEngineOptions
    CommerceProductListingParametersState
    CommerceSearchParametersState
    ControllerDefinition
    CoreCommerceFacet
    CoreEngineNext
    DateFacetValue
    DeselectAllValuesInCoreFacetPayload
    EngineDefinitionControllersPropsOption
    FacetGeneratorState
    FacetType
    FetchMoreRecommendationsPayload
    FetchQuerySuggestionsPayload
    FetchStaticState
    FetchStaticStateOptions
    FromBuildResult
    GeneratedFilterSuggestionsControllers
    HydrateStaticState
    InferBuildResult
    InferControllerFromDefinition
    InferControllerPropsMapFromDefinitions
    InferControllersMapFromDefinition
    InferControllerStaticStateFromController
    InferControllerStaticStateMapFromControllers
    InferControllerStaticStateMapFromDefinitionsWithSolutionType
    InferHydratedState
    InferStaticState
    InteractiveProductProps
    LogLevel
    MappedFacetState
    MappedFacetStates
    MappedGeneratedFacetController
    NextPagePayload
    NumericFacetValue
    OptionsTuple
    PaginationOptions
    PlatformEnvironment
    PrepareForSearchWithQueryPayload
    PreviousPagePayload
    ProductClickPayload
    ProductList
    ProductListingParameters
    ProductTemplate
    ProductTemplateCondition
    ProductViewPayload
    PurchasePayload
    RecentQueriesListOptions
    RegisterInstantProductPayload
    RegisterQuerySetQueryPayload
    RegisterQuerySuggestPayload
    RegisterRecommendationsSlotPaginationPayload
    RegisterRecommendationsSlotPayload
    RelativeDatePeriod
    RelativeDateUnit
    RestoreProductListingParametersPayload
    RestoreSearchParametersPayload
    Result
    SearchBoxOptions
    SelectPagePayload
    SelectQuerySuggestionPayload
    SetCustomPayload
    SetItemsPayload
    SetLocationPayload
    SetPageSizePayload
    SetViewPayload
    SortByDate
    SortByField
    SortByNoSort
    SortByQRE
    SortByRelevancy
    SortCriterion
    SSRCommerceEngineOptions
    ToggleExcludeDateFacetValuePayload
    ToggleExcludeFacetValuePayload
    ToggleExcludeNumericFacetValuePayload
    ToggleSelectCategoryFacetValuePayload
    ToggleSelectDateFacetValuePayload
    ToggleSelectFacetValuePayload
    UpdateAnalyticsConfigurationPayload
    UpdateAutoSelectionForAllCoreFacetsPayload
    UpdateBasicConfigurationPayload
    UpdateCategoryFacetNumberOfValuesPayload
    UpdateCoreFacetFreezeCurrentValuesPayload
    UpdateCoreFacetIsFieldExpandedPayload
    UpdateCoreFacetNumberOfValuesPayload
    UpdateDateFacetValuesPayload
    updateIgnoreQueryTrigger
    UpdateIgnoreQueryTriggerPayload
    UpdateItemQuantityPayload
    UpdateQuerySetQueryPayload
    ProductTemplatesHelpers
    VERSION