@coveo/quantic 3.29.4-pre.fe2dbcea63 → 3.29.4

package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/search-analytics.d.ts

@@ -90,13 +90,15 @@ export declare class SearchAnalyticsProvider extends BaseAnalyticsProvider<State
     protected get responseTime(): number;
     protected get numberOfResults(): number;
 }
-interface LegacyConfigureAnalyticsOptions {
+interface LegacyConfigureAnalyticsOptions<State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider> {
     logger: Logger;
     analyticsClientMiddleware?: AnalyticsClientSendEventHook;
     preprocessRequest?: PreprocessRequest;
     provider?: SearchPageClientProvider;
-    getState(): StateNeededBySearchAnalyticsProvider;
+    getState(): State;
 }
-export declare const configureLegacyAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: LegacyConfigureAnalyticsOptions) => CoveoSearchPageClient;
+export declare const configureLegacyAnalytics: <State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider>({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: LegacyConfigureAnalyticsOptions<State> & {
+    provider: SearchPageClientProvider;
+}) => CoveoSearchPageClient;
 export declare const getPageID: () => string;
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/generated-answer-stream.d.ts

@@ -0,0 +1,15 @@
+import type { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
+import type { GeneratedAnswerCitation } from '../generated-answer/generated-answer-event-payload.js';
+export interface GeneratedAnswerStream {
+    answerId?: string;
+    contentFormat?: GeneratedContentFormat;
+    answer?: string;
+    citations?: GeneratedAnswerCitation[];
+    generated?: boolean;
+    isStreaming: boolean;
+    isLoading: boolean;
+    error?: {
+        message: string;
+        code: number;
+    };
+}

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-actions.d.ts

@@ -1,7 +1,7 @@
 import type { NavigatorContext } from '../../app/navigator-context-provider.js';
-import { type StateNeededByAnswerAPI } from './stream-answer-api.js';
+import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
 export declare const triggerSearchRequest: import("@reduxjs/toolkit").AsyncThunk<void, {
-    state: StateNeededByAnswerAPI;
+    state: StreamAnswerAPIState;
     navigatorContext: NavigatorContext;
 }, {
     state?: unknown;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api-state.d.ts

@@ -0,0 +1,6 @@
+import type { SearchAppState } from '../../state/search-app-state.js';
+import type { ConfigurationSection, GeneratedAnswerSection, GetAnswerQuerySection, InsightConfigurationSection, TabSection } from '../../state/state-sections.js';
+export type StreamAnswerAPIState = {
+    searchHub: string;
+    pipeline: string;
+} & GetAnswerQuerySection & ConfigurationSection & Partial<SearchAppState> & Partial<InsightConfigurationSection> & GeneratedAnswerSection & Partial<TabSection>;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts

@@ -1,30 +1,10 @@
 import { type ThunkDispatch, type UnknownAction } from '@reduxjs/toolkit';
 import { type NavigatorContext } from '../../app/navigator-context-provider.js';
-import type { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
-import type { SearchAppState } from '../../state/search-app-state.js';
-import type { ConfigurationSection, GeneratedAnswerSection, InsightConfigurationSection, TabSection } from '../../state/state-sections.js';
 import type { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
-import type { GeneratedAnswerCitation } from '../generated-answer/generated-answer-event-payload.js';
 import type { SearchRequest } from '../search/search/search-request.js';
-export type StateNeededByAnswerAPI = {
-    searchHub: string;
-    pipeline: string;
-    answer: ReturnType<typeof answerApi.reducer>;
-} & ConfigurationSection & Partial<SearchAppState> & Partial<InsightConfigurationSection> & GeneratedAnswerSection & Partial<TabSection>;
-export interface GeneratedAnswerStream {
-    answerId?: string;
-    contentFormat?: GeneratedContentFormat;
-    answer?: string;
-    citations?: GeneratedAnswerCitation[];
-    generated?: boolean;
-    isStreaming: boolean;
-    isLoading: boolean;
-    error?: {
-        message: string;
-        code: number;
-    };
-}
-export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StateNeededByAnswerAPI, unknown, UnknownAction>) => void;
+import type { GeneratedAnswerStream } from './generated-answer-stream.js';
+import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
+export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StreamAnswerAPIState, unknown, UnknownAction>) => void;
 export declare const answerApi: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {
     getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">;
 }, "answer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
@@ -73,7 +53,7 @@ export declare const selectAnswerTriggerParams: ((state: any, ...params: any[])
     argsMemoize: typeof import("reselect").weakMapMemoize;
     memoize: typeof import("reselect").weakMapMemoize;
 };
-export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI, usage: "fetch" | "select", navigatorContext: NavigatorContext) => {
+export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, usage: "fetch" | "select", navigatorContext: NavigatorContext) => {
     analytics?: {
         actionCause?: string;
         customData?: object;
@@ -100,12 +80,12 @@ export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI,
     } | undefined;
     enableDidYouMean?: boolean | undefined;
     fieldsToInclude?: string[] | undefined;
-    facets?: (import("../../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
+    facets?: (import("../../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
     pipeline?: string | undefined;
     searchHub?: string | undefined;
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
-            responseFormat: import("../../features/generated-answer/generated-response-format.js").GeneratedResponseFormat;
+            responseFormat: import("../../index.js").GeneratedResponseFormat;
             citationsFieldToInclude: string[];
         };
     };
@@ -117,8 +97,8 @@ export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI,
     aq?: string | undefined;
     q: string | undefined;
 };
-export declare const fetchAnswer: (state: StateNeededByAnswerAPI, navigatorContext: NavigatorContext) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">>, any, any, UnknownAction>;
-export declare const selectAnswer: (state: StateNeededByAnswerAPI, navigatorContext?: NavigatorContext) => ({
+export declare const fetchAnswer: (state: StreamAnswerAPIState, navigatorContext: NavigatorContext) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">>, any, any, UnknownAction>;
+export declare const selectAnswer: (state: StreamAnswerAPIState, navigatorContext?: NavigatorContext) => ({
     status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
     originalArgs?: undefined | undefined;
     data?: undefined | undefined;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/tests/stream-answer-api-state-mock.d.ts

@@ -1,12 +1,12 @@
 /** biome-ignore-all lint/suspicious/noExplicitAny: <mock> */
-import type { StateNeededByAnswerAPI } from '../stream-answer-api.js';
-export declare const streamAnswerAPIStateMock: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithoutAnyTab: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithStaticFiltersSelected: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithNonValidFilters: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithoutAnyFilters: StateNeededByAnswerAPI;
-export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpression: StateNeededByAnswerAPI;
+import type { StreamAnswerAPIState } from '../stream-answer-api-state.js';
+export declare const streamAnswerAPIStateMock: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithoutAnyTab: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithStaticFiltersSelected: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithNonValidFilters: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithoutAnyFilters: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpression: StreamAnswerAPIState;
 export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWithEmptyCQ: {
     advancedSearchQueries: {
         cq: string;
@@ -26,9 +26,9 @@ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWi
     };
     searchHub: string;
     pipeline: string;
-    answer: ReturnType<import("redux").Reducer<import("@reduxjs/toolkit/query").CombinedState<{
-        getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<import("../../search/search/search-request.js").SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, import("../stream-answer-api.js").GeneratedAnswerStream, "answer">;
-    }, never, "answer">, import("redux").UnknownAction>>;
+    answer: import("@reduxjs/toolkit/query").CombinedState<{
+        getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<import("../../search/search/search-request.js").SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, import("../generated-answer-stream.js").GeneratedAnswerStream, "answer">;
+    }, never, "answer">;
     configuration: import("../../../features/configuration/configuration-state.js").ConfigurationState;
     facetSet?: import("../../../features/facets/facet-set/facet-set-state.js").FacetSetState | undefined;
     dateFacetSet?: import("../../../features/facets/range-facets/date-facet-set/date-facet-set-state.js").DateFacetSetState | undefined;
@@ -66,7 +66,7 @@ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWi
     instantResults?: import("../../../features/instant-results/instant-results-state.js").InstantResultsState | undefined;
     insightConfiguration?: import("../../../features/insight-configuration/insight-configuration-state.js").InsightConfigurationState | undefined;
 };
-export declare const streamAnswerAPIStateMockWithoutSearchAction: StateNeededByAnswerAPI;
+export declare const streamAnswerAPIStateMockWithoutSearchAction: StreamAnswerAPIState;
 export declare const expectedStreamAnswerAPIParam: {
     q: string;
     aq: string;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/sort/headless-core-sort.d.ts

@@ -32,6 +32,18 @@ export interface Sort extends Controller {
      * Verifies whether the specified sort criterion is the currently active one.
      *
      * @param criterion - The sort criterion to evaluate.
+     * Can be a single criterion or an array of criteria.
+     * The criteria in an array will be applied sequentially. For example, if there's a tie on the 1st criterion, the API uses the 2nd criterion to break the tie. However, this only works when combining:
+     * `SortByRelevancy` followed by one or more `SortByField` or `SortByDate` criteria.
+     * `SortByQRE` followed by one or more `SortByField` or `SortByDate` criteria.
+     * Two or more `SortByField` criteria.
+     * A single `SortByDate` criterion and one or more `SortByField` criteria in any order.
+     *
+     * Examples:
+     * * `SortByRelevancy`, `SortByField`
+     * * `SortByQRE`, `SortByField`
+     * * `SortByDate`, `SortByField`, `SortByField`
+     *
      * @returns `true` if the specified sort criterion is the currently active one; `false` otherwise.
      */
     isSortedBy(criterion: SortCriterion | SortCriterion[]): boolean;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-selectors.d.ts

@@ -1,10 +1,7 @@
 import type { GeneratedAnswerCitation } from '../../controllers/generated-answer/headless-generated-answer.js';
 import type { SearchAppState } from '../../state/search-app-state.js';
 import type { GeneratedAnswerSection } from '../../state/state-sections.js';
-export declare const generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => {
-    answerAPIEnabled: boolean;
-    id: string | undefined;
-};
+export declare const generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => string | undefined;
 export declare const selectFieldsToIncludeInCitation: (state: Partial<GeneratedAnswerSection>) => string[] | undefined;
 export declare const citationSourceSelector: ((state: Partial<GeneratedAnswerSection>, citationId: string) => GeneratedAnswerCitation | undefined) & {
     clearCache: () => void;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts

@@ -24,7 +24,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eve
     facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
     numberOfResults?: number;
     firstResult?: number;
-    facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
+    facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
     cq?: string;
     queryCorrection?: {
         enabled?: boolean;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts

@@ -25,7 +25,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, nav
     facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
     numberOfResults?: number;
     firstResult?: number;
-    facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
+    facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
     cq?: string;
     queryCorrection?: {
         enabled?: boolean;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/engine/commerce-engine.ssr.d.ts

@@ -18,34 +18,9 @@ import type { CommerceEngineDefinition } from '../types/engine.js';
  *
  * @example
  * ```ts
- * const { listingEngineDefinition } = defineCommerceEngine(engineConfig);
- *
- * // Pass navigator context directly to fetchStaticState
- * const staticState = await listingEngineDefinition.fetchStaticState({
- *   navigatorContext: {
- *     forwardedFor: req.ip,
- *     referrer: req.headers.referer || null,
- *     userAgent: req.headers['user-agent'] || null,
- *     clientId: 'unique-session-id'
- *   }
- * });
- *
- * // Framework examples:
- * // Express.js
- * app.get('/api/listing', async (req, res) => {
- *   const state = await listingEngineDefinition.fetchStaticState({
- *     navigatorContext: {
- *       forwardedFor: req.ip,
- *       referrer: req.headers.referer || null,
- *       userAgent: req.headers['user-agent'] || null,
- *       clientId: req.sessionID
- *     }
- *   });
- *   res.json(state);
- * });
- *
- * type SearchStaticState = InferStaticState<typeof listingEngineDefinition>;
- * type SearchHydratedState = InferHydratedState<typeof listingEngineDefinition>;
+ * const engineDefinition = defineCommerceEngine(engineConfig);
+ * type SearchStaticState = InferStaticState<typeof engineDefinition>;
+ * type SearchHydratedState = InferHydratedState<typeof engineDefinition>;
  * ```
  *
  * @group Engine

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/engine.d.ts

@@ -1,6 +1,7 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
 import type { EngineConfiguration } from '../../../app/engine-configuration.js';
+import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { ControllerStaticStateMap } from '../../common/types/controllers.js';
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
@@ -32,6 +33,13 @@ export interface CommerceEngineDefinition<TControllers extends ControllerDefinit
      * Fetches the hydrated state on the client side using your engine definition and the static state.
      */
     hydrateStaticState: HydrateStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
+    /**
+     * Sets the navigator context provider.
+     * This provider is essential for retrieving navigation-related data such as referrer, userAgent, location, and clientId, which are crucial for handling both server-side and client-side API requests effectively.
+     *
+     * Note: The implementation specifics of the navigator context provider depend on the Node.js framework being utilized. It is the developer's responsibility to appropriately define and implement the navigator context provider to ensure accurate navigation context is available throughout the application. If the user fails to provide a navigator context provider, a warning will be logged either on the server or the browser console.
+     */
+    setNavigatorContextProvider: (navigatorContextProvider: NavigatorContextProvider) => void;
     /**
      * Returns the access token.
      */

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/fetch-static-state.d.ts

@@ -1,31 +1,10 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
-import type { NavigatorContext } from '../../../app/navigator-context-provider.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { ControllerStaticStateMap, ControllersPropsMap } from '../../common/types/controllers.js';
 import type { SolutionType } from './controller-constants.js';
 import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
 import type { EngineStaticState } from './engine.js';
-export interface FetchStaticStateOptions {
-    /**
-     * The navigator context for this request.
-     *
-     * Used to pass required client information when making server-side requests.
-     *
-     * @example
-     * ```ts
-     * // In your server route handler
-     * const staticState = await listingEngineDefinition.fetchStaticState({
-     *   navigatorContext: {
-     *     forwardedFor: req.ip,
-     *     referrer: req.headers.referer || null,
-     *     userAgent: req.headers['user-agent'] || null,
-     *     clientId: req.sessionID || 'anonymous'
-     *   }
-     * });
-     * ```
-     */
-    navigatorContext?: NavigatorContext;
-}
+export type FetchStaticStateOptions = {};
 /**
  * Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
  *

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/types/engine.d.ts

@@ -1,6 +1,7 @@
 import type { AnyAction, UnknownAction } from '@reduxjs/toolkit';
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
 import type { EngineConfiguration } from '../../../app/engine-configuration.js';
+import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { Build } from './build.js';
 import type { ControllerDefinitionsMap, ControllerStaticStateMap, ControllersMap, ControllersPropsMap } from './controllers.js';
@@ -26,6 +27,13 @@ export interface EngineDefinition<TEngine extends CoreEngine | CoreEngineNext, T
      * Fetches the hydrated state on the client side using your engine definition and the static state.
      */
     hydrateStaticState: HydrateStaticState<TEngine, InferControllersMapFromDefinition<TControllers>, AnyAction, InferControllerPropsMapFromDefinitions<TControllers>>;
+    /**
+     * Sets the navigator context provider.
+     * This provider is essential for retrieving navigation-related data such as referrer, userAgent, location, and clientId, which are crucial for handling both server-side and client-side API requests effectively.
+     *
+     * Note: The implementation specifics of the navigator context provider depend on the Node.js framework being utilized. It is the developer's responsibility to appropriately define and implement the navigator context provider to ensure accurate navigation context is available throughout the application. If the user fails to provide a navigator context provider, a warning will be logged either on the server or the browser console.
+     */
+    setNavigatorContextProvider: (navigatorContextProvider: NavigatorContextProvider) => void;
 }
 export interface EngineDefinitionBuildResult<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> {
     engine: TEngine;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/types/fetch-static-state.d.ts

@@ -1,11 +1,8 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
-import type { NavigatorContext } from '../../../app/navigator-context-provider.js';
 import type { ControllerStaticStateMap, ControllersPropsMap } from './controllers.js';
 import type { EngineDefinitionControllersPropsOption, EngineStaticState } from './engine.js';
 import type { OptionsTuple } from './utilities.js';
-type FetchStaticStateOptions = {
-    navigatorContext?: NavigatorContext;
-};
+type FetchStaticStateOptions = {};
 /**
  * Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
  *

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/engine/search-engine.ssr.d.ts

@@ -1,38 +1,40 @@
+import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 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';
+import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitions } from '../../common/types/inference.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 type SearchEngineDefinition<TControllers extends ControllerDefinitionsMap<SSRSearchEngine, Controller>> = EngineDefinition<SSRSearchEngine, TControllers>;
 /**
- * Initializes a Search engine definition in SSR with per-call navigator context support.
+ * Initializes a Search engine definition in SSR with given controllers definitions and search engine config.
  *
  * @param options - The search engine definition
- * @returns Engine definition with support for per-call navigator context.
- *
- * @example
- * ```ts
- * const searchEngine = defineSearchEngine(config);
- *
- * // Pass navigator context directly to fetchStaticState
- * const staticState = await searchEngine.fetchStaticState({
- *   navigatorContext: {
- *     forwardedFor: req.ip,
- *     referrer: req.headers.referer || null,
- *     userAgent: req.headers['user-agent'] || null,
- *     clientId: 'abc123'
- *   }
- * });
- * ```
+ * @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>): EngineDefinition<SSRSearchEngine, TControllerDefinitions>;
+export declare function defineSearchEngine<TControllerDefinitions extends ControllerDefinitionsMap<SearchEngine, Controller>>(options: SearchEngineDefinitionOptions<TControllerDefinitions>): {
+    fetchStaticState: import("../../common/types/fetch-static-state.js").FetchStaticState<import("redux").AnyAction, InferControllerStaticStateMapFromDefinitions<TControllerDefinitions>, InferControllerPropsMapFromDefinitions<TControllerDefinitions>>;
+    hydrateStaticState: import("../../common/types/hydrate-static-state.js").HydrateStaticState<SSRSearchEngine, import("../../common/types/inference.js").InferControllersMapFromDefinition<TControllerDefinitions>, import("redux").AnyAction, InferControllerPropsMapFromDefinitions<TControllerDefinitions>>;
+    setNavigatorContextProvider: (navigatorContextProvider: NavigatorContextProvider) => void;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/state/state-sections.d.ts

@@ -1,3 +1,6 @@
+import type { BaseQueryFn, CombinedState, FetchArgs, FetchBaseQueryError, QueryDefinition, RetryOptions } from '@reduxjs/toolkit/query';
+import type { GeneratedAnswerStream } from '../api/knowledge/generated-answer-stream.js';
+import type { SearchRequest } from '../api/search/search/search-request.js';
 import type { StateWithHistory } from '../app/undoable.js';
 import type { AdvancedSearchQueriesState } from '../features/advanced-search-queries/advanced-search-queries-state.js';
 import type { AttachedResultsState } from '../features/attached-results/attached-results-state.js';
@@ -438,3 +441,8 @@ export interface InsightUserActionsSection {
 export interface ManualRangeSection {
     manualNumericFacetSet: ManualNumericFacetSetState;
 }
+export interface GetAnswerQuerySection {
+    answer: CombinedState<{
+        getAnswer: QueryDefinition<Partial<SearchRequest>, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {} & RetryOptions, {}>, never, GeneratedAnswerStream, 'answer'>;
+    }, never, 'answer'>;
+}

package/force-app/main/default/staticresources/coveoheadless/definitions/utils/facet-utils.d.ts

@@ -9,5 +9,5 @@ export declare function sortFacets<T extends {
     facetId: string;
 }>(facets: T[], sortOrder: string[]): T[];
 export declare const sortCriteriaMap: Record<string, SortCriteria>;
-export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[];
+export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[];
 export {};