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

package/dist/definitions/ssr-next/search/controllers/smart-snippet/headless-smart-snippet.ssr.d.ts

@@ -1,14 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import { type SmartSnippet, type SmartSnippetProps } from '../../../../controllers/smart-snippet/headless-smart-snippet.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export * from '../../../../controllers/smart-snippet/headless-smart-snippet.js';
-export interface SmartSnippetDefinition extends ControllerDefinitionWithoutProps<SearchEngine, SmartSnippet> {
-}
-/**
- * Defines a `SmartSnippet` controller instance.
- * @group Definers
- *
- * @param props - The configurable `SmartSnippet` properties.
- * @returns The `SmartSnippet` controller definition.
- * */
-export declare function defineSmartSnippet(props?: SmartSnippetProps): SmartSnippetDefinition;

package/dist/definitions/ssr-next/search/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.ssr.d.ts

@@ -1,15 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import type { SmartSnippetQuestionsListProps } from '../../../../controllers/core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.js';
-import { type SmartSnippetQuestionsList } from '../../../../controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export * from '../../../../controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.js';
-export interface SmartSnippetQuestionsListDefinition extends ControllerDefinitionWithoutProps<SearchEngine, SmartSnippetQuestionsList> {
-}
-/**
- * Defines a `SmartSnippetQuestionsList` controller instance.
- * @group Definers
- *
- * @param props - The configurable `SmartSnippetQuestionsList` properties.
- * @returns The `SmartSnippetQuestionsList` controller definition.
- * */
-export declare function defineSmartSnippetQuestionsList(props?: SmartSnippetQuestionsListProps): SmartSnippetQuestionsListDefinition;

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

@@ -1,14 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import { type Sort, type SortProps } from '../../../../controllers/sort/headless-sort.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export * from '../../../../controllers/sort/headless-sort.js';
-export interface SortDefinition extends ControllerDefinitionWithoutProps<SearchEngine, Sort> {
-}
-/**
- * Defines a `Sort` controller instance.
- * @group Definers
- *
- * @param props - The configurable `Sort` properties.
- * @returns The `Sort` controller definition.
- * */
-export declare function defineSort(props?: SortProps): SortDefinition;

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

@@ -1,14 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import { type StandaloneSearchBox, type StandaloneSearchBoxProps } from '../../../../controllers/standalone-search-box/headless-standalone-search-box.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export * from '../../../../controllers/standalone-search-box/headless-standalone-search-box.js';
-export interface StandaloneSearchBoxDefinition extends ControllerDefinitionWithoutProps<SearchEngine, StandaloneSearchBox> {
-}
-/**
- * Defines a `StandaloneSearchBox` controller instance.
- * @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/search/controllers/static-filter/headless-static-filter.ssr.d.ts

@@ -1,15 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import { type StaticFilter, type StaticFilterProps } from '../../../../controllers/static-filter/headless-static-filter.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export * from '../../../../controllers/static-filter/headless-static-filter.js';
-export { buildStaticFilterValue } from '../../../../controllers/static-filter/headless-static-filter.js';
-export interface StaticFilterDefinition extends ControllerDefinitionWithoutProps<SearchEngine, StaticFilter> {
-}
-/**
- * Defines a `StaticFilter` controller instance.
- * @group Definers
- *
- * @param props - The configurable `StaticFilter` properties.
- * @returns The `StaticFilter` controller definition.
- * */
-export declare function defineStaticFilter(props: StaticFilterProps): StaticFilterDefinition;

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

@@ -1,14 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import { type Tab, type TabProps } from '../../../../controllers/tab/headless-tab.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export * from '../../../../controllers/tab/headless-tab.js';
-export interface TabDefinition extends ControllerDefinitionWithoutProps<SearchEngine, Tab> {
-}
-/**
- * Defines a `Tab` controller instance.
- * @group Definers
- *
- * @param props - The configurable `Tab` properties.
- * @returns The `Tab` controller definition.
- * */
-export declare function defineTab(props: TabProps): TabDefinition;

package/dist/definitions/ssr-next/search/controllers/tab-manager/headless-tab-manager.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import { type TabManager } from '../../../../controllers/tab-manager/headless-tab-manager.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export * from '../../../../controllers/tab-manager/headless-tab-manager.js';
-interface TabManagerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, TabManager> {
-}
-/**
- * Defines a `TabManager` controller instance.
- * @group Definers
- *
- * @returns The `TabManager` controller definition.
- * */
-export declare function defineTabManager(): TabManagerDefinition;

package/dist/definitions/ssr-next/search/controllers/triggers/headless-execute-trigger.ssr.d.ts

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import { type ExecuteTrigger } from '../../../../controllers/triggers/headless-execute-trigger.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export * from '../../../../controllers/triggers/headless-execute-trigger.js';
-export interface ExecuteTriggerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, ExecuteTrigger> {
-}
-/**
- * Defines an `ExecuteTrigger` controller instance.
- * @group Definers
- *
- * @returns The `ExecuteTrigger` controller definition.
- * */
-export declare function defineExecuteTrigger(): ExecuteTriggerDefinition;

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

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import type { NotifyTrigger } from '../../../../controllers/core/triggers/headless-core-notify-trigger.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export type { NotifyTrigger, NotifyTriggerState, } from '../../../../controllers/core/triggers/headless-core-notify-trigger.js';
-export interface NotifyTriggerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, NotifyTrigger> {
-}
-/**
- * Defines a `NotifyTrigger` controller instance.
- * @group Definers
- *
- * @returns The `NotifyTrigger` controller definition.
- * */
-export declare function defineNotifyTrigger(): NotifyTriggerDefinition;

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

@@ -1,14 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import type { QueryTrigger } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export type { QueryTrigger, QueryTriggerState, } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
-export * from '../../../../controllers/triggers/headless-query-trigger.js';
-export interface QueryTriggerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, QueryTrigger> {
-}
-/**
- * Defines a `QueryTrigger` controller instance.
- * @group Definers
- *
- * @returns The `QueryTrigger` controller definition.
- * */
-export declare function defineQueryTrigger(): QueryTriggerDefinition;

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

@@ -1,13 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import type { RedirectionTrigger } from '../../../../controllers/core/triggers/headless-core-redirection-trigger.js';
-import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
-export type { RedirectionTrigger, RedirectionTriggerState, } from '../../../../controllers/core/triggers/headless-core-redirection-trigger.js';
-export interface RedirectionTriggerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, RedirectionTrigger> {
-}
-/**
- * Defines a `RedirectionTrigger` controller instance.
- * @group Definers
- *
- * @returns The `RedirectionTrigger` controller definition.
- * */
-export declare function defineRedirectionTrigger(): RedirectionTriggerDefinition;

package/dist/definitions/ssr-next/search/controllers/url-manager/headless-url-manager.ssr.d.ts

@@ -1,16 +0,0 @@
-import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
-import { type UrlManager, type UrlManagerInitialState } from '../../../../controllers/url-manager/headless-url-manager.js';
-import type { ControllerDefinitionWithProps } from '../../../common/types/controllers.js';
-export * from '../../../../controllers/url-manager/headless-url-manager.js';
-/**
- * @internal
- */
-export interface UrlManagerBuildProps {
-    initialState: UrlManagerInitialState;
-}
-/**
- * @internal
- * @group Definers
- *
- */
-export declare const defineUrlManager: () => ControllerDefinitionWithProps<SearchEngine, UrlManager, UrlManagerBuildProps>;

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

@@ -1,35 +0,0 @@
-import { type SearchEngine, type SearchEngineOptions } from '../../../app/search-engine/search-engine.js';
-import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { LegacySearchAction } from '../../../features/analytics/analytics-utils.js';
-import type { ControllerDefinitionsMap } from '../../common/types/controllers.js';
-import type { EngineDefinition, EngineDefinitionOptions } from '../../common/types/engine.js';
-/**
- * The SSR search engine.
- *
- * @group Engine
- */
-export interface SSRSearchEngine extends SearchEngine {
-    /**
-     * Waits for the search to be completed and returns a promise that resolves to a `SearchCompletedAction`.
-     */
-    waitForSearchCompletedAction(): Promise<SearchCompletedAction>;
-}
-/**
- * The options to create a search engine definition in SSR.
- *
- * @group Engine
- */
-export type SearchEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<SSRSearchEngine, Controller>> = EngineDefinitionOptions<SearchEngineOptions, TControllers>;
-export type SearchCompletedAction = ReturnType<LegacySearchAction['fulfilled' | 'rejected']>;
-export interface SearchEngineDefinition<TControllers extends ControllerDefinitionsMap<SSRSearchEngine, Controller>> extends EngineDefinition<SSRSearchEngine, TControllers, SearchEngineOptions> {
-}
-/**
- * Initializes a Search engine definition in SSR with given controllers definitions and search engine config.
- *
- * @param options - The search 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 defineSearchEngine<TControllerDefinitions extends ControllerDefinitionsMap<SearchEngine, Controller>>(options: SearchEngineDefinitionOptions<TControllerDefinitions>): SearchEngineDefinition<TControllerDefinitions>;

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

@@ -1,219 +0,0 @@
-/**
- * The Coveo Headless SSR sub-package exposes exposes the engine, definers, controllers, actions, and utility functions to build a server side rendered search experience.
- *
- * @example
- * ```typescript
- *   import {
- *     Controller,
- *     ControllerDefinitionsMap,
- *     defineSearchEngine,
- *     InferStaticState,
- *     InferHydratedState,
- *     SearchEngine,
- *     SearchEngineDefinitionOptions,
- *     getSampleSearchEngineConfiguration,
- *     defineResultList,
- *     defineSearchBox,
- *   } from '@coveo/headless/ssr';
- *
- *  const config = {
- *     configuration: {
- *       ...getSampleSearchEngineConfiguration(),
- *       analytics: {
- *         trackingId: 'sports-ui-samples',
- *       },
- *     },
- *     controllers: {
- *       searchBox: defineSearchBox(),
- *       resultList: defineResultList(),
- *     },
- *   } satisfies SearchEngineDefinitionOptions<
- *     ControllerDefinitionsMap<SearchEngine, Controller>
- *   >;
- *
- * const engineDefinition = defineSearchEngine(config);
- *
- * export type SearchStaticState = InferStaticState<typeof engineDefinition>;
- * export type SearchHydratedState = InferHydratedState<typeof engineDefinition>;
- *
- * export const {
- *   fetchStaticState,
- *   hydrateStaticState,
- *   setNavigatorContextProvider,
- * } = engineDefinition;
-
- * ```
- * @module SSR Search
- */
-export type { Relay } from '@coveo/relay';
-export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
-export type { AnalyticsClientSendEventHook } from 'coveo.analytics';
-export type { ExecuteTriggerParams } from './api/common/trigger.js';
-export type { CoreEngine, 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 { NavigatorContext, NavigatorContextProvider, } from './app/navigator-context-provider.js';
-export type { SearchConfigurationOptions, SearchEngineConfiguration, SearchEngineOptions, } from './app/search-engine/search-engine.js';
-export { getSampleSearchEngineConfiguration } from './app/search-engine/search-engine.js';
-export type { ErrorPayload } from './controllers/controller/error-payload.js';
-export type { Controller, Subscribable, } from './controllers/controller/headless-controller.js';
-export type { InlineLink } from './controllers/smart-snippet/headless-smart-snippet-interactive-inline-links.js';
-export type { Build } from './ssr-next/common/types/build.js';
-export type { ControllerDefinitionsMap, ControllerDefinitionWithoutProps, ControllerDefinitionWithProps, } from './ssr-next/common/types/controllers.js';
-export type { EngineDefinition, InferBuildResult, InferHydratedState, InferStaticState, } from './ssr-next/common/types/engine.js';
-export type { InferControllerFromDefinition, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, InferControllerStaticStateMapFromDefinitions, InferControllersMapFromDefinition, } from './ssr-next/common/types/inference.js';
-export type { AutomaticFacetBreadcrumb, Breadcrumb, BreadcrumbManager, BreadcrumbManagerDefinition, BreadcrumbManagerState, BreadcrumbValue, CategoryFacetBreadcrumb, CoreBreadcrumbManager, CoreBreadcrumbManagerState, DateFacetBreadcrumb, DeselectableValue, FacetBreadcrumb, NumericFacetBreadcrumb, StaticFilterBreadcrumb, } from './ssr-next/search/controllers/breadcrumb-manager/headless-breadcrumb-manager.ssr.js';
-export { defineBreadcrumbManager } from './ssr-next/search/controllers/breadcrumb-manager/headless-breadcrumb-manager.ssr.js';
-export type { Context, ContextDefinition, ContextInitialState, ContextPayload, ContextProps, ContextState, ContextValue, } from './ssr-next/search/controllers/context/headless-context.ssr.js';
-export { defineContext } from './ssr-next/search/controllers/context/headless-context.ssr.js';
-export type { DictionaryFieldContext, DictionaryFieldContextDefinition, DictionaryFieldContextPayload, DictionaryFieldContextState, } from './ssr-next/search/controllers/dictionary-field-context/headless-dictionary-field-context.ssr.js';
-export { defineDictionaryFieldContext } from './ssr-next/search/controllers/dictionary-field-context/headless-dictionary-field-context.ssr.js';
-export type { DidYouMean, DidYouMeanDefinition, DidYouMeanState, QueryCorrection, WordCorrection, } from './ssr-next/search/controllers/did-you-mean/headless-did-you-mean.ssr.js';
-export { defineDidYouMean } from './ssr-next/search/controllers/did-you-mean/headless-did-you-mean.ssr.js';
-export type { FacetManager, FacetManagerDefinition, FacetManagerPayload, FacetManagerState, } from './ssr-next/search/controllers/facet-manager/headless-facet-manager.ssr.js';
-export { defineFacetManager } from './ssr-next/search/controllers/facet-manager/headless-facet-manager.ssr.js';
-export type { AutomaticFacet, AutomaticFacetGenerator, AutomaticFacetGeneratorDefinition, AutomaticFacetGeneratorOptions, AutomaticFacetGeneratorProps, AutomaticFacetGeneratorState, AutomaticFacetState, } from './ssr-next/search/controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.ssr.js';
-export { defineAutomaticFacetGenerator } from './ssr-next/search/controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.ssr.js';
-export type { CategoryFacet, CategoryFacetDefinition, CategoryFacetOptions, CategoryFacetProps, CategoryFacetSearch, CategoryFacetSearchOptions, CategoryFacetSearchResult, CategoryFacetSearchState, CategoryFacetState, CoreCategoryFacet, CoreCategoryFacetState, } from './ssr-next/search/controllers/facets/category-facet/headless-category-facet.ssr.js';
-export { defineCategoryFacet } from './ssr-next/search/controllers/facets/category-facet/headless-category-facet.ssr.js';
-export type { CoreFacet, CoreFacetState, Facet, FacetDefinition, FacetOptions, FacetProps, FacetSearch, FacetSearchOptions, FacetSearchState, FacetState, FacetValue, FacetValueState, SpecificFacetSearchResult, } from './ssr-next/search/controllers/facets/facet/headless-facet.ssr.js';
-export { defineFacet } from './ssr-next/search/controllers/facets/facet/headless-facet.ssr.js';
-export type { DateFacet, DateFacetDefinition, DateFacetOptions, DateFacetProps, DateFacetState, DateRangeInput, DateRangeOptions, } from './ssr-next/search/controllers/facets/range-facet/date-facet/headless-date-facet.ssr.js';
-export { buildDateRange, defineDateFacet, } from './ssr-next/search/controllers/facets/range-facet/date-facet/headless-date-facet.ssr.js';
-export type { DateFilter, DateFilterDefinition, DateFilterInitialState, DateFilterOptions, DateFilterProps, DateFilterRange, DateFilterState, } from './ssr-next/search/controllers/facets/range-facet/date-facet/headless-date-filter.ssr.js';
-export { defineDateFilter } from './ssr-next/search/controllers/facets/range-facet/date-facet/headless-date-filter.ssr.js';
-export type { NumericFacet, NumericFacetDefinition, NumericFacetOptions, NumericFacetProps, NumericFacetState, NumericRangeOptions, } from './ssr-next/search/controllers/facets/range-facet/numeric-facet/headless-numeric-facet.ssr.js';
-export { buildNumericRange, defineNumericFacet, } from './ssr-next/search/controllers/facets/range-facet/numeric-facet/headless-numeric-facet.ssr.js';
-export type { NumericFilter, NumericFilterDefinition, NumericFilterInitialState, NumericFilterOptions, NumericFilterProps, NumericFilterRange, NumericFilterState, } from './ssr-next/search/controllers/facets/range-facet/numeric-facet/headless-numeric-filter.ssr.js';
-export { defineNumericFilter } from './ssr-next/search/controllers/facets/range-facet/numeric-facet/headless-numeric-filter.ssr.js';
-export type { CategoryFieldSuggestions, CategoryFieldSuggestionsDefinition, CategoryFieldSuggestionsOptions, CategoryFieldSuggestionsProps, CategoryFieldSuggestionsState, CategoryFieldSuggestionsValue, } from './ssr-next/search/controllers/field-suggestions/category-facet/headless-category-field-suggestions.ssr.js';
-export { defineCategoryFieldSuggestions } from './ssr-next/search/controllers/field-suggestions/category-facet/headless-category-field-suggestions.ssr.js';
-export type { FieldSuggestions, FieldSuggestionsDefinition, FieldSuggestionsOptions, FieldSuggestionsProps, FieldSuggestionsState, FieldSuggestionsValue, } from './ssr-next/search/controllers/field-suggestions/facet/headless-field-suggestions.ssr.js';
-export { defineFieldSuggestions } from './ssr-next/search/controllers/field-suggestions/facet/headless-field-suggestions.ssr.js';
-export type { FoldedCollection, FoldedResult, FoldedResultList, FoldedResultListDefinition, FoldedResultListOptions, FoldedResultListProps, FoldedResultListState, FoldingOptions, } from './ssr-next/search/controllers/folded-result-list/headless-folded-result-list.ssr.js';
-export { defineFoldedResultList } from './ssr-next/search/controllers/folded-result-list/headless-folded-result-list.ssr.js';
-export type { HistoryManager, HistoryManagerDefinition, HistoryManagerState, } from './ssr-next/search/controllers/history-manager/headless-history-manager.ssr.js';
-export { defineHistoryManager } from './ssr-next/search/controllers/history-manager/headless-history-manager.ssr.js';
-export type { InstantResultOptions, InstantResultProps, InstantResults, InstantResultsDefinition, InstantResultsState, } from './ssr-next/search/controllers/instant-results/instant-results.ssr.js';
-export { defineInstantResults } from './ssr-next/search/controllers/instant-results/instant-results.ssr.js';
-export type { Pager, PagerDefinition, PagerInitialState, PagerOptions, PagerProps, PagerState, } from './ssr-next/search/controllers/pager/headless-pager.ssr.js';
-export { definePager } from './ssr-next/search/controllers/pager/headless-pager.ssr.js';
-export type { QueryError, QueryErrorDefinition, QueryErrorState, } from './ssr-next/search/controllers/query-error/headless-query-error.ssr.js';
-export { defineQueryError } from './ssr-next/search/controllers/query-error/headless-query-error.ssr.js';
-export type { QuerySummary, QuerySummaryDefinition, QuerySummaryState, } from './ssr-next/search/controllers/query-summary/headless-query-summary.ssr.js';
-export { defineQuerySummary } from './ssr-next/search/controllers/query-summary/headless-query-summary.ssr.js';
-export type { CoreQuickview, CoreQuickviewState, Quickview, QuickviewDefinition, QuickviewOptions, QuickviewProps, QuickviewState, } from './ssr-next/search/controllers/quickview/headless-quickview.ssr.js';
-export { defineQuickview } from './ssr-next/search/controllers/quickview/headless-quickview.ssr.js';
-export type { RecentQueriesList, RecentQueriesListDefinition, RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesListProps, RecentQueriesState, } from './ssr-next/search/controllers/recent-queries-list/headless-recent-queries-list.ssr.js';
-export { defineRecentQueriesList } from './ssr-next/search/controllers/recent-queries-list/headless-recent-queries-list.ssr.js';
-export type { RecentResultsList, RecentResultsListDefinition, RecentResultsListInitialState, RecentResultsListOptions, RecentResultsListProps, RecentResultsState, } from './ssr-next/search/controllers/recent-results-list/headless-recent-results-list.ssr.js';
-export { defineRecentResultsList } from './ssr-next/search/controllers/recent-results-list/headless-recent-results-list.ssr.js';
-export type { DocumentWeights, ExecutionReport, ExecutionStep, QueryExpressions, QueryRankingExpression, QueryRankingExpressionWeights, RankingInformation, RelevanceInspector, RelevanceInspectorDefinition, RelevanceInspectorInitialState, RelevanceInspectorProps, RelevanceInspectorState, ResultRankingInformation, SecurityIdentity, TermWeightReport, } from './ssr-next/search/controllers/relevance-inspector/headless-relevance-inspector.ssr.js';
-export { defineRelevanceInspector } from './ssr-next/search/controllers/relevance-inspector/headless-relevance-inspector.ssr.js';
-export type { ResultList, ResultListDefinition, ResultListOptions, ResultListProps, ResultListState, } from './ssr-next/search/controllers/result-list/headless-result-list.ssr.js';
-export { defineResultList } from './ssr-next/search/controllers/result-list/headless-result-list.ssr.js';
-export type { ResultsPerPage, ResultsPerPageDefinition, ResultsPerPageInitialState, ResultsPerPageProps, ResultsPerPageState, } from './ssr-next/search/controllers/results-per-page/headless-results-per-page.ssr.js';
-export { defineResultsPerPage } from './ssr-next/search/controllers/results-per-page/headless-results-per-page.ssr.js';
-export type { Delimiters, SearchBox, SearchBoxDefinition, SearchBoxOptions, SearchBoxProps, SearchBoxState, Suggestion, SuggestionHighlightingOptions, } from './ssr-next/search/controllers/search-box/headless-search-box.ssr.js';
-export { defineSearchBox } from './ssr-next/search/controllers/search-box/headless-search-box.ssr.js';
-export type { SearchParameterManager, SearchParameterManagerBuildProps, SearchParameterManagerDefinition, SearchParameterManagerInitialState, SearchParameterManagerState, SearchParameters, } from './ssr-next/search/controllers/search-parameter-manager/headless-search-parameter-manager.ssr.js';
-export { defineSearchParameterManager } from './ssr-next/search/controllers/search-parameter-manager/headless-search-parameter-manager.ssr.js';
-export type { SearchStatus, SearchStatusDefinition, SearchStatusState, } from './ssr-next/search/controllers/search-status/headless-search-status.ssr.js';
-export { defineSearchStatus } from './ssr-next/search/controllers/search-status/headless-search-status.ssr.js';
-export type { QuestionAnswerDocumentIdentifier, SmartSnippet, SmartSnippetCore, SmartSnippetDefinition, SmartSnippetOptions, SmartSnippetProps, SmartSnippetState, } from './ssr-next/search/controllers/smart-snippet/headless-smart-snippet.ssr.js';
-export { defineSmartSnippet } from './ssr-next/search/controllers/smart-snippet/headless-smart-snippet.ssr.js';
-export type { CoreSmartSnippetQuestionsList, CoreSmartSnippetQuestionsListState, SmartSnippetQuestionsList, SmartSnippetQuestionsListDefinition, SmartSnippetQuestionsListOptions, SmartSnippetQuestionsListProps, SmartSnippetQuestionsListState, SmartSnippetRelatedQuestion, } from './ssr-next/search/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.ssr.js';
-export { defineSmartSnippetQuestionsList } from './ssr-next/search/controllers/smart-snippet-questions-list/headless-smart-snippet-questions-list.ssr.js';
-export type { Sort, SortDefinition, SortInitialState, SortProps, SortState, } from './ssr-next/search/controllers/sort/headless-sort.ssr.js';
-export { defineSort } from './ssr-next/search/controllers/sort/headless-sort.ssr.js';
-export type { StandaloneSearchBox, StandaloneSearchBoxAnalytics, StandaloneSearchBoxDefinition, StandaloneSearchBoxOptions, StandaloneSearchBoxProps, StandaloneSearchBoxState, } from './ssr-next/search/controllers/standalone-search-box/headless-standalone-search-box.ssr.js';
-export { defineStandaloneSearchBox } from './ssr-next/search/controllers/standalone-search-box/headless-standalone-search-box.ssr.js';
-export type { StaticFilter, StaticFilterDefinition, StaticFilterOptions, StaticFilterProps, StaticFilterState, StaticFilterValue, StaticFilterValueOptions, StaticFilterValueState, } from './ssr-next/search/controllers/static-filter/headless-static-filter.ssr.js';
-export { buildStaticFilterValue, defineStaticFilter, } from './ssr-next/search/controllers/static-filter/headless-static-filter.ssr.js';
-export type { Tab, TabDefinition, TabInitialState, TabOptions, TabProps, TabState, } from './ssr-next/search/controllers/tab/headless-tab.ssr.js';
-export { defineTab } from './ssr-next/search/controllers/tab/headless-tab.ssr.js';
-export type { TabManager, TabManagerState, } from './ssr-next/search/controllers/tab-manager/headless-tab-manager.ssr.js';
-export { defineTabManager } from './ssr-next/search/controllers/tab-manager/headless-tab-manager.ssr.js';
-export type { ExecuteTrigger, ExecuteTriggerDefinition, ExecuteTriggerState, } from './ssr-next/search/controllers/triggers/headless-execute-trigger.ssr.js';
-export { defineExecuteTrigger } from './ssr-next/search/controllers/triggers/headless-execute-trigger.ssr.js';
-export type { NotifyTrigger, NotifyTriggerDefinition, NotifyTriggerState, } from './ssr-next/search/controllers/triggers/headless-notify-trigger.ssr.js';
-export { defineNotifyTrigger } from './ssr-next/search/controllers/triggers/headless-notify-trigger.ssr.js';
-export type { QueryTrigger, QueryTriggerDefinition, QueryTriggerState, } from './ssr-next/search/controllers/triggers/headless-query-trigger.ssr.js';
-export { defineQueryTrigger } from './ssr-next/search/controllers/triggers/headless-query-trigger.ssr.js';
-export type { RedirectionTrigger, RedirectionTriggerDefinition, RedirectionTriggerState, } from './ssr-next/search/controllers/triggers/headless-redirection-trigger.ssr.js';
-export { defineRedirectionTrigger } from './ssr-next/search/controllers/triggers/headless-redirection-trigger.ssr.js';
-export type { UrlManager, UrlManagerBuildProps, UrlManagerInitialState, UrlManagerProps, UrlManagerState, } from './ssr-next/search/controllers/url-manager/headless-url-manager.ssr.js';
-export { defineUrlManager } from './ssr-next/search/controllers/url-manager/headless-url-manager.ssr.js';
-export type { SearchCompletedAction, SearchEngineDefinition, SearchEngineDefinitionOptions, SSRSearchEngine as SearchEngine, } from './ssr-next/search/engine/search-engine.ssr.js';
-export { defineSearchEngine } from './ssr-next/search/engine/search-engine.ssr.js';
-export type { SearchAppState, SearchParametersState, } from './state/search-app-state.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 type { FieldDescription } from './api/search/fields/fields-response.js';
-export type { Raw } from './api/search/search/raw.js';
-export type { Result } from './api/search/search/result.js';
-export type { PhrasesToHighlight, TermsToHighlight, } from './api/search/search/stemming.js';
-export * from './features/advanced-search-queries/advanced-search-queries-actions-loader.js';
-export * from './features/analytics/click-analytics-actions-loader.js';
-export * from './features/analytics/generic-analytics-actions-loader.js';
-export * from './features/analytics/search-analytics-actions-loader.js';
-export * from './features/breadcrumb/breadcrumb-actions-loader.js';
-export * from './features/configuration/configuration-actions-loader.js';
-export * from './features/configuration/search-configuration-actions-loader.js';
-export * from './features/context/context-actions-loader.js';
-export * from './features/debug/debug-actions-loader.js';
-export * from './features/dictionary-field-context/dictionary-field-context-actions-loader.js';
-export * from './features/did-you-mean/did-you-mean-actions-loader.js';
-export * from './features/excerpt-length/excerpt-length-actions-loader.js';
-export * from './features/facet-options/facet-options-actions-loader.js';
-export * from './features/facets/category-facet-set/category-facet-set-actions-loader.js';
-export type { CategoryFacetSortCriterion, CategoryFacetValueRequest, } from './features/facets/category-facet-set/interfaces/request.js';
-export type { CategoryFacetValue, CategoryFacetValueCommon, } from './features/facets/category-facet-set/interfaces/response.js';
-export type { FacetResultsMustMatch } from './features/facets/facet-api/request.js';
-export * from './features/facets/facet-set/facet-set-actions-loader.js';
-export { baseFacetResponseSelector, facetRequestSelector, facetResponseSelectedValuesSelector, facetResponseSelector, } from './features/facets/facet-set/facet-set-selectors.js';
-export type { FacetSortCriterion, FacetValueRequest, } from './features/facets/facet-set/interfaces/request.js';
-export type { AnyFacetValueRequest } from './features/facets/generic/interfaces/generic-facet-request.js';
-export * from './features/facets/range-facets/date-facet-set/date-facet-actions-loader.js';
-export type { DateRangeRequest } from './features/facets/range-facets/date-facet-set/interfaces/request.js';
-export type { DateFacetValue } from './features/facets/range-facets/date-facet-set/interfaces/response.js';
-export type { RangeFacetRangeAlgorithm, RangeFacetSortCriterion, } from './features/facets/range-facets/generic/interfaces/request.js';
-export type { NumericRangeRequest } from './features/facets/range-facets/numeric-facet-set/interfaces/request.js';
-export type { NumericFacetValue } from './features/facets/range-facets/numeric-facet-set/interfaces/response.js';
-export * from './features/facets/range-facets/numeric-facet-set/numeric-facet-actions-loader.js';
-export * from './features/fields/fields-actions-loader.js';
-export { DefaultFieldsToInclude, EcommerceDefaultFieldsToInclude, MinimumFieldsToInclude, } from './features/fields/fields-state.js';
-export * from './features/folding/folding-actions-loader.js';
-export * from './features/generated-answer/generated-answer-actions-loader.js';
-export * from './features/history/history-actions-loader.js';
-export * from './features/instant-results/instant-results-actions-loader.js';
-export * from './features/pagination/pagination-actions-loader.js';
-export { currentPageSelector, currentPagesSelector, maxPageSelector, } from './features/pagination/pagination-selectors.js';
-export * from './features/pipeline/pipeline-actions-loader.js';
-export * from './features/query/query-actions-loader.js';
-export * from './features/query-set/query-set-actions-loader.js';
-export * from './features/query-suggest/query-suggest-actions-loader.js';
-export * from './features/question-answering/question-answering-actions-loader.js';
-export * from './features/recent-queries/recent-queries-actions-loader.js';
-export * from './features/recent-results/recent-results-actions-loader.js';
-export * from './features/result-preview/result-preview-actions-loader.js';
-export { ResultTemplatesHelpers } from './features/result-templates/result-templates-helpers.js';
-export type { ResultTemplate, ResultTemplateCondition, ResultTemplatesManager, } from './features/result-templates/result-templates-manager.js';
-export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
-export * from './features/search/search-actions-loader.js';
-export * from './features/search-hub/search-hub-actions-loader.js';
-export { buildSearchParameterSerializer } from './features/search-parameters/search-parameter-serializer.js';
-export { buildSSRSearchParameterSerializer } from './features/search-parameters/search-parameter-serializer.ssr.js';
-export type { SortByDate, SortByField, SortByNoSort, SortByQRE, SortByRelevancy, SortCriterion, } from './features/sort-criteria/criteria.js';
-export { buildCriterionExpression, buildDateSortCriterion, buildFieldSortCriterion, buildNoSortCriterion, buildQueryRankingExpressionSortCriterion, buildRelevanceSortCriterion, SortBy, SortOrder, } from './features/sort-criteria/criteria.js';
-export { parseCriterionExpression } from './features/sort-criteria/criteria-parser.js';
-export * from './features/sort-criteria/sort-criteria-actions-loader.js';
-export * from './features/standalone-search-box-set/standalone-search-box-set-actions-loader.js';
-export * from './features/static-filter-set/static-filter-set-actions-loader.js';
-export * from './features/tab-set/tab-set-actions-loader.js';
-export type { FunctionExecutionTrigger } from './features/triggers/triggers-state.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/esm/ssr-commerce-next.index.js

@@ -1,130 +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 { getSampleCommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
-export { defineBreadcrumbManager } from './ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
-export { defineCart } from './ssr-next/commerce/controllers/cart/headless-cart.ssr.js';
-export { defineContext } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
-export { defineDidYouMean } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
-export { defineFilterSuggestionsGenerator } from './ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
-export { defineFacetGenerator } from './ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js';
-export { defineInstantProducts } from './ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.js';
-export { definePagination } from './ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js';
-export { defineParameterManager } from './ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
-export { defineProductList } from './ssr-next/commerce/controllers/product-list/headless-product-list.ssr.js';
-export { defineProductView } from './ssr-next/commerce/controllers/product-view/headless-product-view.ssr.js';
-export { defineRecentQueriesList } from './ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.js';
-export { defineRecommendations } from './ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.js';
-export { defineSearchBox } from './ssr-next/commerce/controllers/search-box/headless-search-box.ssr.js';
-export { defineSort } from './ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js';
-export { defineStandaloneSearchBox } from './ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.js';
-export { defineSummary } from './ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js';
-export { defineNotifyTrigger } from './ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.js';
-export { defineQueryTrigger } from './ssr-next/commerce/controllers/triggers/headless-query-trigger.ssr.js';
-export { defineRedirectionTrigger } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
-export { defineCommerceEngine } from './ssr-next/commerce/engine/commerce-engine.ssr.js';
-export { SolutionType } from './ssr-next/commerce/types/controller-constants.js';
-export { Kind } from './ssr-next/commerce/types/kind.js';
-// TODO: KIT-3391 - export other SSR commerce controllers
-//#endregion
-export * from './features/commerce/configuration/configuration-actions-loader.js';
-export * from './features/commerce/context/cart/cart-actions-loader.js';
-//#region Grouped actions
-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';
-//#endregion
-export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
-export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.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 { SortBy } from './features/commerce/sort/sort.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 * from './utils/query-expression/query-expression.js';
-export { VERSION } from './utils/version.js';