@coveo/headless 3.27.8-pre.5f8a67af1e → 3.27.8-pre.63fc406dfa

package/dist/definitions/ssr-commerce-next.index.d.ts

@@ -1,170 +0,0 @@
-/**
- * The Coveo Headless SSR Commerce sub-package exposes exposes the engine, definers, controllers, actions, and utility functions to build a server side rendered commerce experience.
- *
- * @example
- * ```typescript
- * 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
- * >;
- *
- * ```
- * @module SSR Commerce
- */
-export type { Relay } from '@coveo/relay';
-export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
-export type { CommerceEngineOptions } from './app/commerce-engine/commerce-engine.js';
-export type { CommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
-export { getSampleCommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
-export type { CoreEngineNext, ExternalEngineOptions } from './app/engine.js';
-export type { AnalyticsConfiguration, AnalyticsRuntimeEnvironment, EngineConfiguration, } from './app/engine-configuration.js';
-export type { LoggerOptions, LogLevel } from './app/logger.js';
-export type { BrowserNavigatorContextProvider, NavigatorContext, NavigatorContextProvider, } from './app/navigator-context-provider.js';
-export type { InteractiveProduct, InteractiveProductOptions, InteractiveProductProps, } from './controllers/commerce/core/interactive-product/headless-core-interactive-product.js';
-export type { Controller, Subscribable, } from './controllers/controller/headless-controller.js';
-export type { BreadcrumbManager, BreadcrumbManagerState, } from './ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
-export { defineBreadcrumbManager } from './ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
-export type { Cart, CartBuildProps, CartDefinition, CartInitialState, CartItem, CartProps, CartState, } from './ssr-next/commerce/controllers/cart/headless-cart.ssr.js';
-export { defineCart } from './ssr-next/commerce/controllers/cart/headless-cart.ssr.js';
-export type { Context, ContextDefinition, ContextOptions, ContextProps, ContextState, UserLocation, View, } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
-export { defineContext } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
-export type { DidYouMean, DidYouMeanState, } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
-export { defineDidYouMean } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
-export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, FieldSuggestionsFacet, FilterSuggestions, FilterSuggestionsGenerator, FilterSuggestionsGeneratorDefinition, FilterSuggestionsState, GeneratedFilterSuggestionsControllers, } from './ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
-export { defineFilterSuggestionsGenerator } from './ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
-export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetSearchResult, CategoryFacetState, CategoryFacetValue, CoreCommerceFacet, DateFacet, DateFacetState, DateFacetValue, FacetGenerator, FacetGeneratorState, FacetType, LocationFacet, LocationFacetState, LocationFacetValue, MappedFacetState, MappedFacetStates, MappedGeneratedFacetController, NumericFacet, NumericFacetState, NumericFacetValue, RegularFacet, RegularFacetState, RegularFacetValue, } from './ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js';
-export { defineFacetGenerator } from './ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js';
-export type { InstantProducts, InstantProductsDefinition, InstantProductsOptions, InstantProductsProps, InstantProductsState, } from './ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.js';
-export { defineInstantProducts } from './ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.js';
-export type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState, } from './ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js';
-export { definePagination } from './ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js';
-export type { CommerceSearchParameters, ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, SSRParameterManagerProps, } from './ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
-export { defineParameterManager } from './ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
-export type { ProductList, ProductListing, ProductListState, Search, } from './ssr-next/commerce/controllers/product-list/headless-product-list.ssr.js';
-export { defineProductList } from './ssr-next/commerce/controllers/product-list/headless-product-list.ssr.js';
-export type { ProductView } from './ssr-next/commerce/controllers/product-view/headless-product-view.ssr.js';
-export { defineProductView } from './ssr-next/commerce/controllers/product-view/headless-product-view.ssr.js';
-export type { RecentQueriesList, RecentQueriesListDefinition, RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesListProps, RecentQueriesState, } from './ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.js';
-export { defineRecentQueriesList } from './ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.js';
-export type { Recommendations, RecommendationsDefinition, RecommendationsState, } from './ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.js';
-export { defineRecommendations } from './ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.js';
-export type { CoreSearchBox, SearchBox, SearchBoxDefinition, SearchBoxOptions, SearchBoxProps, SearchBoxState, Suggestion, } from './ssr-next/commerce/controllers/search-box/headless-search-box.ssr.js';
-export { defineSearchBox } from './ssr-next/commerce/controllers/search-box/headless-search-box.ssr.js';
-export type { Sort, SortProps, SortState, } from './ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js';
-export { defineSort } from './ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js';
-export type { StandaloneSearchBox, StandaloneSearchBoxDefinition, StandaloneSearchBoxProps, StandaloneSearchBoxState, } from './ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.js';
-export { defineStandaloneSearchBox } from './ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.js';
-export type { ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, Summary, SummaryState, } from './ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js';
-export { defineSummary } from './ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js';
-export type { NotifyTrigger, NotifyTriggerDefinition, NotifyTriggerState, } from './ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.js';
-export { defineNotifyTrigger } from './ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.js';
-export type { QueryTrigger, QueryTriggerDefinition, QueryTriggerState, } from './ssr-next/commerce/controllers/triggers/headless-query-trigger.ssr.js';
-export { defineQueryTrigger } from './ssr-next/commerce/controllers/triggers/headless-query-trigger.ssr.js';
-export type { RedirectionTrigger, RedirectionTriggerDefinition, RedirectionTriggerState, } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
-export { defineRedirectionTrigger } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
-export type { CommerceEngineDefinition } from './ssr-next/commerce/engine/commerce-engine.ssr.js';
-export { defineCommerceEngine } from './ssr-next/commerce/engine/commerce-engine.ssr.js';
-export type { CommerceEngineDefinitionOptions, SSRCommerceEngine as CommerceEngine, } from './ssr-next/commerce/factories/build-factory.js';
-export { SolutionType } from './ssr-next/commerce/types/controller-constants.js';
-export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
-export type { InferBuildResult, InferControllerFromDefinition, InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition, InferHydratedState, InferStaticState, } from './ssr-next/commerce/types/controller-inference.js';
-export type { Build, BuildOptions, EngineDefinition, EngineStaticState, FetchStaticState, FetchStaticStateOptions, FromBuildResult, FromBuildResultOptions, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
-export { Kind } from './ssr-next/commerce/types/kind.js';
-export type { CommerceAppState, CommerceProductListingParametersState, CommerceSearchParametersState, } from './state/commerce-app-state.js';
-export * from './features/commerce/configuration/configuration-actions-loader.js';
-export * from './features/commerce/context/cart/cart-actions-loader.js';
-export * from './features/commerce/context/context-actions-loader.js';
-export * from './features/commerce/facets/category-facet/category-facet-actions-loader.js';
-export * from './features/commerce/facets/core-facet/core-facet-actions-loader.js';
-export * from './features/commerce/facets/date-facet/date-facet-actions-loader.js';
-export * from './features/commerce/facets/numeric-facet/numeric-facet-actions-loader.js';
-export * from './features/commerce/facets/regular-facet/regular-facet-actions-loader.js';
-export * from './features/commerce/instant-products/instant-products-actions-loader.js';
-export * from './features/commerce/pagination/pagination-actions-loader.js';
-export * from './features/commerce/product/product-actions-loaders.js';
-export * from './features/commerce/product-listing/product-listing-actions-loader.js';
-export * from './features/commerce/product-listing-parameters/product-listing-parameters-actions-loader.js';
-export * from './features/commerce/query/query-actions-loader.js';
-export * from './features/commerce/query-set/query-set-actions-loader.js';
-export * from './features/commerce/query-suggest/query-suggest-actions-loader.js';
-export * from './features/commerce/recent-queries/recent-queries-actions-loader.js';
-export * from './features/commerce/recommendations/recommendations-actions-loader.js';
-export * from './features/commerce/search/search-actions-loader.js';
-export * from './features/commerce/search-parameters/search-parameters-actions-loader.js';
-export * from './features/commerce/sort/sort-actions-loader.js';
-export * from './features/commerce/standalone-search-box-set/standalone-search-box-set-actions-loader.js';
-export * from './features/commerce/triggers/triggers-actions-loader.js';
-export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
-export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
-export type { BaseProduct, ChildProduct, Product, } from './api/commerce/common/product.js';
-export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
-export type { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
-export { deserializeRelativeDate, validateRelativeDate, } from './api/search/date/relative-date.js';
-export { buildParameterSerializer } from './features/commerce/parameters/parameters-serializer.ssr.js';
-export { ProductTemplatesHelpers } from './features/commerce/product-templates/product-templates-helpers.js';
-export type { ProductTemplate, ProductTemplateCondition, ProductTemplatesManager, } from './features/commerce/product-templates/product-templates-manager.js';
-export type { SortCriterion } from './features/commerce/sort/sort.js';
-export { SortBy } from './features/commerce/sort/sort.js';
-export type { SortByDate, SortByField, SortByNoSort, SortByQRE, SortByRelevancy, } from './features/sort-criteria/criteria.js';
-export { buildCriterionExpression, buildDateSortCriterion, buildFieldSortCriterion, buildNoSortCriterion, buildQueryRankingExpressionSortCriterion, buildRelevanceSortCriterion, SortOrder, } from './features/sort-criteria/criteria.js';
-export { parseCriterionExpression } from './features/sort-criteria/criteria-parser.js';
-export type { Template } from './features/templates/templates-manager.js';
-export type { HighlightKeyword } from './utils/highlight.js';
-export * from './utils/query-expression/query-expression.js';
-export type { PlatformEnvironment } from './utils/url-utils.js';
-export { VERSION } from './utils/version.js';

package/dist/definitions/ssr-next/commerce/controller-utils.d.ts

@@ -1,19 +0,0 @@
-import type { UnknownAction } from '@reduxjs/toolkit';
-import type { Controller } from '../../controllers/controller/headless-controller.js';
-import type { ControllersMap } from '../common/types/controllers.js';
-import type { SSRCommerceEngine } from './factories/build-factory.js';
-import type { SolutionType } from './types/controller-constants.js';
-import type { ControllerDefinitionOption, ControllerDefinitionsMap, InferControllerStaticStateMapFromControllers } from './types/controller-definitions.js';
-import type { InferControllerPropsMapFromDefinitions, InferControllersMapFromDefinition } from './types/controller-inference.js';
-import type { EngineStaticState } from './types/engine.js';
-export declare function createStaticState<TSearchAction extends UnknownAction>({ searchActions, controllers, }: {
-    searchActions: TSearchAction[];
-    controllers: ControllersMap;
-}): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromControllers<ControllersMap>>;
-export declare function buildControllerDefinitions<TControllerDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>({ definitionsMap, engine, solutionType, propsMap, }: {
-    definitionsMap: TControllerDefinitionsMap;
-    engine: SSRCommerceEngine;
-    solutionType: TSolutionType;
-    propsMap: InferControllerPropsMapFromDefinitions<TControllerDefinitionsMap>;
-}): InferControllersMapFromDefinition<TControllerDefinitionsMap, TSolutionType>;
-export declare function ensureAtLeastOneSolutionType(options?: ControllerDefinitionOption): void;

package/dist/definitions/ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.d.ts

@@ -1,10 +0,0 @@
-import type { BreadcrumbManager, BreadcrumbManagerState } from '../../../../controllers/commerce/core/breadcrumb-manager/headless-core-breadcrumb-manager.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { BreadcrumbManager, BreadcrumbManagerState };
-/**
- * Defines a `BreadcrumbManager` controller instance.
- * @group Definers
- *
- * @returns The `BreadcrumbManager` controller definition.
- */
-export declare function defineBreadcrumbManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<BreadcrumbManager, TOptions>;

package/dist/definitions/ssr-next/commerce/controllers/cart/headless-cart.ssr.d.ts

@@ -1,15 +0,0 @@
-import { type Cart, type CartInitialState, type CartItem, type CartProps, type CartState } from '../../../../controllers/commerce/context/cart/headless-cart.js';
-import type { UniversalControllerDefinitionWithProps } from '../../types/controller-definitions.js';
-export type { Cart, CartInitialState, CartItem, CartProps, CartState };
-export interface CartBuildProps {
-    initialState: CartInitialState;
-}
-export interface CartDefinition extends UniversalControllerDefinitionWithProps<Cart, CartBuildProps> {
-}
-/**
- * Defines a `Cart` controller instance.
- * @group Definers
- *
- * @returns The `Cart` controller definition.
- */
-export declare function defineCart(): CartDefinition;

package/dist/definitions/ssr-next/commerce/controllers/context/headless-context.ssr.d.ts

@@ -1,12 +0,0 @@
-import { type Context, type ContextOptions, type ContextProps, type ContextState, type UserLocation, type View } from '../../../../controllers/commerce/context/headless-context.js';
-import type { UniversalControllerDefinitionWithProps } from '../../types/controller-definitions.js';
-export type { Context, ContextProps, ContextState, View, UserLocation, ContextOptions, };
-export interface ContextDefinition extends UniversalControllerDefinitionWithProps<Context, ContextOptions> {
-}
-/**
- * Defines a `Context` controller instance.
- * @group Definers
- *
- * @returns The `Context` controller definition.
- */
-export declare function defineContext(): ContextDefinition;

package/dist/definitions/ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.d.ts

@@ -1,10 +0,0 @@
-import type { DidYouMean, DidYouMeanState } from '../../../../controllers/commerce/search/did-you-mean/headless-did-you-mean.js';
-import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { DidYouMean, DidYouMeanState };
-/**
- * Defines a `DidYouMean` controller instance.
- * @group Definers
- *
- * @returns The `DidYouMean` controller definition.
- */
-export declare function defineDidYouMean(): SearchOnlyControllerDefinitionWithoutProps<DidYouMean>;

package/dist/definitions/ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.d.ts

@@ -1,15 +0,0 @@
-import type { FieldSuggestionsFacet } from '../../../../api/commerce/search/query-suggest/query-suggest-response.js';
-import type { CategoryFilterSuggestions, CategoryFilterSuggestionsState } from '../../../../controllers/commerce/filter-suggestions/headless-category-filter-suggestions.js';
-import type { FilterSuggestions, FilterSuggestionsState } from '../../../../controllers/commerce/filter-suggestions/headless-filter-suggestions.js';
-import { type FilterSuggestionsGenerator, type GeneratedFilterSuggestionsControllers } from '../../../../controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
-import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { FilterSuggestionsGenerator, GeneratedFilterSuggestionsControllers, FieldSuggestionsFacet, CategoryFilterSuggestions, CategoryFilterSuggestionsState, FilterSuggestions, FilterSuggestionsState, };
-export interface FilterSuggestionsGeneratorDefinition extends NonRecommendationControllerDefinitionWithoutProps<FilterSuggestionsGenerator> {
-}
-/**
- * Defines the `FilterSuggestionsGenerator` controller for the purpose of server-side rendering.
- * @group Definers
- *
- * @returns The `FilterSuggestionsGenerator` controller definition.
- */
-export declare function defineFilterSuggestionsGenerator(): FilterSuggestionsGeneratorDefinition;

package/dist/definitions/ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.d.ts

@@ -1,66 +0,0 @@
-import type { BaseFacetSearchResult } from '../../../../api/search/facet-search/base/base-facet-search-response.js';
-import type { CategoryFacetSearchResult } from '../../../../api/search/facet-search/category-facet-search/category-facet-search-response.js';
-import type { CommerceEngine } from '../../../../app/commerce-engine/commerce-engine.js';
-import type { CategoryFacet, CategoryFacetState } from '../../../../controllers/commerce/core/facets/category/headless-commerce-category-facet.js';
-import type { DateFacet, DateFacetState, DateFacetValue } from '../../../../controllers/commerce/core/facets/date/headless-commerce-date-facet.js';
-import type { FacetGenerator as CSRFacetGenerator, MappedGeneratedFacetController } from '../../../../controllers/commerce/core/facets/generator/headless-commerce-facet-generator.js';
-import type { CategoryFacetValue, CoreCommerceFacet, FacetType } from '../../../../controllers/commerce/core/facets/headless-core-commerce-facet.js';
-import type { LocationFacet, LocationFacetState } from '../../../../controllers/commerce/core/facets/location/headless-commerce-location-facet.js';
-import type { NumericFacet, NumericFacetState, NumericFacetValue } from '../../../../controllers/commerce/core/facets/numeric/headless-commerce-numeric-facet.js';
-import type { RegularFacet, RegularFacetState } from '../../../../controllers/commerce/core/facets/regular/headless-commerce-regular-facet.js';
-import type { LocationFacetValue, RegularFacetValue } from '../../../../features/commerce/facets/facet-set/interfaces/response.js';
-import { SolutionType } from '../../types/controller-constants.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetState, CategoryFacetValue, CategoryFacetSearchResult, CoreCommerceFacet, DateFacet, DateFacetValue, DateFacetState, NumericFacet, NumericFacetValue, NumericFacetState, RegularFacet, RegularFacetState, RegularFacetValue, LocationFacet, LocationFacetState, LocationFacetValue, MappedGeneratedFacetController, };
-export type FacetGeneratorState = MappedFacetStates;
-export type MappedFacetStates = Array<MappedFacetState[FacetType]>;
-export type { FacetType };
-export type MappedFacetState = {
-    [T in FacetType]: T extends 'numericalRange' ? NumericFacetState : T extends 'regular' ? RegularFacetState : T extends 'dateRange' ? DateFacetState : T extends 'hierarchical' ? CategoryFacetState : T extends 'location' ? LocationFacetState : never;
-};
-/**
- * @group Definers
- */
-export declare function defineFacetGenerator<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<FacetGenerator, TOptions>;
-/**
- * The `FacetGenerator` headless sub-controller creates commerce facet sub-controllers from the Commerce API search or
- * product listing response.
- *
- * Commerce facets are not requested by the implementer, but rather pre-configured through the Coveo Merchandising Hub
- * (CMH). The implementer is only responsible for leveraging the facet controllers created by this sub-controller to
- * properly render facets in their application.
- */
-export interface FacetGenerator extends Omit<CSRFacetGenerator, 'state' | 'facets'> {
-    /**
-     * The state of each every facet returned by the Commerce API.
-     *
-     * In a server-side rendering (SSR) scenario, use this state to render the facet UI components before the
-     * facet controller is hydrated on the client side.
-     *
-     * Once the facet generator controller has been hydrated, use the `getFacetController` method to retrieve
-     * the individual facet controllers and subscribe to their respective states.
-     */
-    state: FacetGeneratorState;
-    /**
-     * Builds a facet controller for the specified facet ID.
-     *
-     * @param facetId The unique identifier of the facet.
-     * @param facetType The type of facet to build.
-     * @returns A facet controller of the specified type, or `undefined` if the facet does not exist in the state.
-     */
-    getFacetController: <T extends FacetType>(facetId: string, facetType: T) => MappedGeneratedFacetController[T] | undefined;
-}
-export interface FacetGeneratorOptions {
-    props: FacetGeneratorProps;
-}
-interface FacetGeneratorProps {
-    solutionType: SolutionType;
-}
-/**
- * Creates a `FacetGenerator` sub-controller for server-side rendering purposes (SSR).
- *
- * @param engine - The SSR commerce engine.
- * @param options - The facet generator options used internally.
- * @returns A `FacetGenerator` sub-controller.
- */
-export declare function buildFacetGenerator(engine: CommerceEngine, options: FacetGeneratorOptions): FacetGenerator;

package/dist/definitions/ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.d.ts

@@ -1,12 +0,0 @@
-import { type InstantProducts, type InstantProductsOptions, type InstantProductsProps, type InstantProductsState } from '../../../../controllers/commerce/instant-products/headless-instant-products.js';
-import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { InstantProductsOptions, InstantProductsState, InstantProducts, InstantProductsProps, };
-export interface InstantProductsDefinition extends NonRecommendationControllerDefinitionWithoutProps<InstantProducts> {
-}
-/**
- * Defines the `InstantProducts` controller for the purpose of server-side rendering.
- * @group Definers
- *
- * @returns The `InstantProducts` controller definition.
- */
-export declare function defineInstantProducts(props?: InstantProductsProps): InstantProductsDefinition;

package/dist/definitions/ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.d.ts

@@ -1,11 +0,0 @@
-import type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState } from '../../../../controllers/commerce/core/pagination/headless-core-commerce-pagination.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { Pagination, PaginationProps, PaginationState, PaginationOptions, CorePaginationOptions, };
-/**
- * Defines a `Pagination` controller instance.
- * @group Definers
- *
- * @param props - The configurable `Pagination` properties.
- * @returns The `Pagination` controller definition.
- */
-export declare function definePagination<TOptions extends ControllerDefinitionOption | undefined>(props?: PaginationProps & TOptions): SubControllerDefinitionWithoutProps<Pagination, TOptions>;

package/dist/definitions/ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.d.ts

@@ -1,25 +0,0 @@
-import type { ParameterManager, ParameterManagerProps, ParameterManagerState } from '../../../../controllers/commerce/core/parameter-manager/headless-core-parameter-manager.js';
-import type { Parameters } from '../../../../features/commerce/parameters/parameters-actions.js';
-import type { ProductListingParameters } from '../../../../features/commerce/product-listing-parameters/product-listing-parameters-actions.js';
-import type { CommerceSearchParameters } from '../../../../features/commerce/search-parameters/search-parameters-actions.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithProps } from '../../types/controller-definitions.js';
-export type { ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, CommerceSearchParameters, };
-/**
- * Defines a `ParameterManager` controller instance.
- * @group Definers
- *
- * @returns The `ParameterManager` controller definition.
- */
-export declare function defineParameterManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithProps<ParameterManager<MappedParameterTypes<TOptions>>, TOptions, SSRParameterManagerProps<MappedParameterTypes<TOptions>>>;
-export interface SSRParameterManagerProps<T extends Parameters> extends Omit<ParameterManagerProps<T>, 'excludeDefaultParameters'> {
-}
-type MappedParameterTypes<TOptions extends ControllerDefinitionOption | undefined> = TOptions extends {
-    listing: true;
-    search: true;
-} | undefined ? ProductListingParameters | CommerceSearchParameters : TOptions extends {
-    listing: true;
-    search: false;
-} ? ProductListingParameters : TOptions extends {
-    listing: false;
-    search: true;
-} ? CommerceSearchParameters : never;

package/dist/definitions/ssr-next/commerce/controllers/product-list/headless-product-list.ssr.d.ts

@@ -1,12 +0,0 @@
-import { type ProductListing, type ProductListingState } from '../../../../controllers/commerce/product-listing/headless-product-listing.js';
-import { type Search } from '../../../../controllers/commerce/search/headless-search.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { Search, ProductListing, ProductListingState as ProductListState };
-export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'promoteChildToParent'>;
-/**
- * Defines a `ProductList` controller instance.
- * @group Definers
- *
- * @returns The `ProductList` controller definition.
- */
-export declare function defineProductList<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<ProductList, TOptions>;

package/dist/definitions/ssr-next/commerce/controllers/product-view/headless-product-view.ssr.d.ts

@@ -1,20 +0,0 @@
-import { type ProductView as BaseProductView } from '../../../../controllers/commerce/product-view/headless-product-view.js';
-import { type Controller } from '../../../../controllers/controller/headless-controller.js';
-import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-interface ProductViewDefinition extends NonRecommendationControllerDefinitionWithoutProps<ProductView> {
-}
-/**
- * Defines a `ProductView` controller instance.
- *
- * This controller is stateless and does not implement a `subscribe` method,
- * making it simpler but different from other controllers in the system.
- * Its sole purpose is to log an `ec.productView` event.
- *
- * @returns The `ProductView` controller definition.
- *
- * @group Definers
- */
-export declare function defineProductView(): ProductViewDefinition;
-export interface ProductView extends BaseProductView, Controller {
-}
-export {};

package/dist/definitions/ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.d.ts

@@ -1,13 +0,0 @@
-import { type RecentQueriesList, type RecentQueriesListInitialState, type RecentQueriesListOptions, type RecentQueriesListProps, type RecentQueriesState } from '../../../../controllers/commerce/recent-queries-list/headless-recent-queries-list.js';
-import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesState, RecentQueriesList, RecentQueriesListProps, };
-export interface RecentQueriesListDefinition extends NonRecommendationControllerDefinitionWithoutProps<RecentQueriesList> {
-}
-/**
- * Defines the `RecentQueriesList` controller for the purpose of server-side rendering.
- * @group Definers
- *
- * @param props - The configuration `RecentQueriesList` properties.
- * @returns The `RecentQueriesList` controller definition.
- */
-export declare function defineRecentQueriesList(props?: RecentQueriesListProps): RecentQueriesListDefinition;

package/dist/definitions/ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.d.ts

@@ -1,17 +0,0 @@
-import { type Recommendations, type RecommendationsOptions, type RecommendationsProps, type RecommendationsState } from '../../../../controllers/commerce/recommendations/headless-recommendations.js';
-import { recommendationInternalOptionKey } from '../../types/controller-constants.js';
-import type { RecommendationOnlyControllerDefinitionWithProps } from '../../types/controller-definitions.js';
-export type { Recommendations, RecommendationsState };
-export type RecommendationsDefinitionMeta = {
-    [recommendationInternalOptionKey]: {} & RecommendationsProps['options'];
-};
-export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithProps<Recommendations, Partial<RecommendationsOptions>> {
-}
-/**
- * Defines a `Recommendations` controller instance.
- * @group Definers
- *
- * @param props - The configurable `Recommendations` properties.
- * @returns The `Recommendations` controller definition.
- * */
-export declare function defineRecommendations(props: RecommendationsProps): RecommendationsDefinition & RecommendationsDefinitionMeta;

package/dist/definitions/ssr-next/commerce/controllers/search-box/headless-search-box.ssr.d.ts

@@ -1,12 +0,0 @@
-import { type CoreSearchBox, type SearchBox, type SearchBoxOptions, type SearchBoxProps, type SearchBoxState, type Suggestion } from '../../../../controllers/commerce/search-box/headless-search-box.js';
-import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { CoreSearchBox, SearchBox, SearchBoxProps, SearchBoxState, SearchBoxOptions, Suggestion, };
-export interface SearchBoxDefinition extends SearchOnlyControllerDefinitionWithoutProps<SearchBox> {
-}
-/**
- * Defines a `SearchBox` controller instance.
- * @group Definers
- *
- * @returns The `SearchBox` controller definition.
- */
-export declare function defineSearchBox(props?: SearchBoxProps): SearchBoxDefinition;

package/dist/definitions/ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.d.ts

@@ -1,11 +0,0 @@
-import type { Sort, SortProps, SortState } from '../../../../controllers/commerce/core/sort/headless-core-commerce-sort.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { Sort, SortProps, SortState };
-/**
- * Defines a `Sort` controller instance.
- * @group Definers
- *
- * @param props - The configurable `Sort` properties.
- * @returns The `Sort` controller definition.
- */
-export declare function defineSort<TOptions extends ControllerDefinitionOption | undefined>(props?: SortProps & TOptions): SubControllerDefinitionWithoutProps<Sort, TOptions>;

package/dist/definitions/ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.d.ts

@@ -1,14 +0,0 @@
-import { type StandaloneSearchBox, type StandaloneSearchBoxState } from '../../../../controllers/commerce/standalone-search-box/headless-standalone-search-box.js';
-import type { StandaloneSearchBoxProps } from '../../../../controllers/standalone-search-box/headless-standalone-search-box.js';
-import type { ListingAndStandaloneControllerWithoutProps } from '../../types/controller-definitions.js';
-export type { StandaloneSearchBoxState, StandaloneSearchBox, StandaloneSearchBoxProps, };
-export interface StandaloneSearchBoxDefinition extends ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox> {
-}
-/**
- * Defines the `StandaloneSearchBox` controller for the purpose of server-side rendering.
- * @group Definers
- *
- * @param props - The configurable `StandaloneSearchBox` properties.
- * @returns The `StandaloneSearchBox` controller definition.
- */
-export declare function defineStandaloneSearchBox(props: StandaloneSearchBoxProps): StandaloneSearchBoxDefinition;

package/dist/definitions/ssr-next/commerce/controllers/summary/headless-core-summary.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { Summary, SummaryState } from '../../../../controllers/commerce/core/summary/headless-core-summary.js';
-import type { ProductListingSummaryState } from '../../../../controllers/commerce/product-listing/summary/headless-product-listing-summary.js';
-import type { RecommendationsSummaryState } from '../../../../controllers/commerce/recommendations/summary/headless-recommendations-summary.js';
-import type { SearchSummaryState } from '../../../../controllers/commerce/search/summary/headless-search-summary.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { Summary, ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, SummaryState, };
-/**
- * Defines a `Summary` controller instance.
- * @group Definers
- *
- * @returns The `Summary` controller definition.
- */
-export declare function defineSummary<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<Summary<ProductListingSummaryState | SearchSummaryState | RecommendationsSummaryState>, TOptions>;

package/dist/definitions/ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.d.ts

@@ -1,12 +0,0 @@
-import type { NotifyTrigger, NotifyTriggerState } from '../../../../controllers/core/triggers/headless-core-notify-trigger.js';
-import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { NotifyTrigger, NotifyTriggerState };
-export interface NotifyTriggerDefinition extends SearchAndListingControllerDefinitionWithoutProps<NotifyTrigger> {
-}
-/**
- * Defines the `NotifyTrigger` controller for the purpose of server-side rendering.
- * @group Definers
- *
- * @returns The `NotifyTrigger` controller definition.
- */
-export declare function defineNotifyTrigger(): NotifyTriggerDefinition;

package/dist/definitions/ssr-next/commerce/controllers/triggers/headless-query-trigger.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { QueryTrigger } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
-import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { QueryTriggerState } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
-export type { QueryTrigger };
-export interface QueryTriggerDefinition extends SearchOnlyControllerDefinitionWithoutProps<QueryTrigger> {
-}
-/**
- * Defines the `QueryTrigger` controller for the purpose of server-side rendering.
- * @group Definers
- *
- * @returns The `QueryTrigger` controller definition.
- */
-export declare function defineQueryTrigger(): QueryTriggerDefinition;

package/dist/definitions/ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.d.ts

@@ -1,12 +0,0 @@
-import type { RedirectionTrigger, RedirectionTriggerState } from '../../../../controllers/core/triggers/headless-core-redirection-trigger.js';
-import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-export type { RedirectionTrigger, RedirectionTriggerState };
-export interface RedirectionTriggerDefinition extends SearchOnlyControllerDefinitionWithoutProps<RedirectionTrigger> {
-}
-/**
- * Defines the `RedirectionTrigger` controller for the purpose of server-side rendering.
- * @group Definers
- *
- * @returns The `RedirectionTrigger` controller definition.
- */
-export declare function defineRedirectionTrigger(): RedirectionTriggerDefinition;

package/dist/definitions/ssr-next/commerce/engine/commerce-engine.ssr.d.ts

@@ -1,25 +0,0 @@
-/**
- * Utility functions to be used for Commerce Server Side Rendering.
- */
-import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
-import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import { type CommerceEngineDefinitionOptions } from '../factories/build-factory.js';
-import { SolutionType } from '../types/controller-constants.js';
-import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
-import type { EngineDefinition } from '../types/engine.js';
-export interface CommerceEngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> extends EngineDefinition<TControllers, CommerceEngineOptions, TSolutionType> {
-}
-/**
- * Initializes a Commerce engine definition in SSR with given controllers definitions and commerce engine config.
- * @param options - The commerce engine definition
- * @returns Three utility functions to fetch the initial state of the engine in SSR, hydrate the state in CSR,
- *  and a build function that can be used for edge cases requiring more control.
- *
- * @group Engine
- */
-export declare function defineCommerceEngine<TControllerDefinitions extends ControllerDefinitionsMap<Controller>>(options: CommerceEngineDefinitionOptions<TControllerDefinitions>): {
-    listingEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, SolutionType.listing>;
-    searchEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, SolutionType.search>;
-    standaloneEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, SolutionType.standalone>;
-    recommendationEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, SolutionType.recommendation>;
-};

package/dist/definitions/ssr-next/commerce/factories/build-factory.d.ts

@@ -1,22 +0,0 @@
-import type { Action } from '@reduxjs/toolkit';
-import { type CommerceEngine, type CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
-import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import { SolutionType } from '../types/controller-constants.js';
-import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
-import type { BuildParameters, CommerceControllerDefinitionsMap, EngineDefinitionOptions } from '../types/engine.js';
-/**
- * The SSR commerce engine.
- *
- * @group Engine
- */
-export interface SSRCommerceEngine extends CommerceEngine {
-    /**
-     * Waits for the request to be completed and returns a promise that resolves to an `Action`.
-     */
-    waitForRequestCompletedAction(): Promise<Action>[];
-}
-export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<CommerceEngineOptions, TControllers>;
-export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <T extends SolutionType>(solutionType: T) => (...[buildOptions]: BuildParameters<TControllerDefinitions>) => Promise<{
-    engine: SSRCommerceEngine;
-    controllers: import("../types/controller-inference.js").InferControllersMapFromDefinition<TControllerDefinitions, T>;
-}>;