@coveo/headless 3.28.4-pre.e9817a9757 → 3.28.4-pre.ea13b3b94e

package/dist/cjs/case-assist/headless.cjs

@@ -800,7 +800,7 @@ var import_bueno5 = require("@coveo/bueno");
 var import_toolkit7 = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.28.4-pre.e9817a9757";
+var VERSION = "3.28.4-pre.ea13b3b94e";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/features/configuration/configuration-actions.ts

package/dist/cjs/commerce/headless.cjs

@@ -1148,7 +1148,7 @@ var import_bueno6 = require("@coveo/bueno");
 var import_toolkit4 = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.28.4-pre.e9817a9757";
+var VERSION = "3.28.4-pre.ea13b3b94e";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/features/configuration/configuration-actions.ts

package/dist/cjs/headless.cjs

@@ -1374,7 +1374,7 @@ var import_toolkit2 = require("@reduxjs/toolkit");
 var import_toolkit = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.28.4-pre.e9817a9757";
+var VERSION = "3.28.4-pre.ea13b3b94e";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/api/analytics/analytics-selectors.ts

package/dist/cjs/insight/headless.cjs

@@ -1278,7 +1278,7 @@ var import_toolkit2 = require("@reduxjs/toolkit");
 var import_toolkit = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.28.4-pre.e9817a9757";
+var VERSION = "3.28.4-pre.ea13b3b94e";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/api/analytics/analytics-selectors.ts

package/dist/cjs/recommendation/headless.cjs

@@ -881,7 +881,7 @@ var validateObject = (engine, schema, obj, validationMessage, errorMessage) => {
 };
 
 // src/utils/version.ts
-var VERSION = "3.28.4-pre.e9817a9757";
+var VERSION = "3.28.4-pre.ea13b3b94e";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/features/configuration/configuration-actions.ts

package/dist/cjs/ssr/headless.cjs

@@ -1306,7 +1306,7 @@ var import_toolkit2 = require("@reduxjs/toolkit");
 var import_toolkit = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.28.4-pre.e9817a9757";
+var VERSION = "3.28.4-pre.ea13b3b94e";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/api/analytics/analytics-selectors.ts

package/dist/cjs/ssr-commerce/headless.cjs

@@ -468,7 +468,7 @@ var import_bueno8 = require("@coveo/bueno");
 var import_toolkit3 = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.28.4-pre.e9817a9757";
+var VERSION = "3.28.4-pre.ea13b3b94e";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/features/configuration/configuration-actions.ts

package/dist/cjs/ssr-commerce-next/headless.cjs

@@ -468,7 +468,7 @@ var import_bueno8 = require("@coveo/bueno");
 var import_toolkit3 = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.28.4-pre.e9817a9757";
+var VERSION = "3.28.4-pre.ea13b3b94e";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/features/configuration/configuration-actions.ts

package/dist/cjs/ssr-next/headless.cjs

@@ -1306,7 +1306,7 @@ var import_toolkit2 = require("@reduxjs/toolkit");
 var import_toolkit = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.28.4-pre.e9817a9757";
+var VERSION = "3.28.4-pre.ea13b3b94e";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/api/analytics/analytics-selectors.ts

package/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/definitions/ssr-next.index.d.ts

@@ -36,17 +36,11 @@
  * export type SearchStaticState = InferStaticState<typeof engineDefinition>;
  * export type SearchHydratedState = InferHydratedState<typeof engineDefinition>;
  *
- * export const {fetchStaticState, hydrateStaticState} = engineDefinition;
-
- * // Pass navigator context directly per call (server-side)
- * await fetchStaticState({
- *   navigatorContext: {
- *     forwardedFor: req.ip,
- *     referrer: req.headers.referer || null,
- *     userAgent: req.headers['user-agent'] || null,
- *     clientId: req.sessionID || 'anonymous',
- *   },
- * });
+ * export const {
+ *   fetchStaticState,
+ *   hydrateStaticState,
+ *   setNavigatorContextProvider,
+ * } = engineDefinition;
 
  * ```
  * @module SSR Search

package/dist/esm/ssr-next/commerce/engine/commerce-engine.ssr.js

@@ -18,49 +18,29 @@ import { SolutionType } from '../types/controller-constants.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
  */
 export function defineCommerceEngine(options) {
     const { controllers: controllerDefinitions, ...engineOptions } = options;
+    const getOptions = () => engineOptions;
+    const setNavigatorContextProvider = (navigatorContextProvider) => {
+        engineOptions.navigatorContextProvider = navigatorContextProvider;
+    };
     const getAccessToken = () => engineOptions.configuration.accessToken;
     const setAccessToken = (accessToken) => {
         engineOptions.configuration.accessToken = accessToken;
     };
-    const fetchStaticState = fetchStaticStateFactory(controllerDefinitions, engineOptions);
-    const hydrateStaticState = hydratedStaticStateFactory(controllerDefinitions, engineOptions);
-    const fetchRecommendationStaticState = fetchRecommendationStaticStateFactory(controllerDefinitions, engineOptions);
-    const hydrateRecommendationStaticState = hydratedRecommendationStaticStateFactory(controllerDefinitions, engineOptions);
+    const fetchStaticState = fetchStaticStateFactory(controllerDefinitions, getOptions());
+    const hydrateStaticState = hydratedStaticStateFactory(controllerDefinitions, getOptions());
+    const fetchRecommendationStaticState = fetchRecommendationStaticStateFactory(controllerDefinitions, getOptions());
+    const hydrateRecommendationStaticState = hydratedRecommendationStaticStateFactory(controllerDefinitions, getOptions());
     const commonMethods = {
+        setNavigatorContextProvider,
         getAccessToken,
         setAccessToken,
     };

package/dist/esm/ssr-next/commerce/factories/build-factory.js

@@ -66,7 +66,7 @@ function fetchActiveRecommendationControllers(controllerProps, solutionType) {
 export const buildFactory = (controllerDefinitions, options) => (solutionType) => async (...[buildOptions]) => {
     const logger = buildLogger(options.loggerOptions);
     if (!options.navigatorContextProvider) {
-        logger.warn('[WARNING] Missing navigator context in server-side code. Pass it directly to fetchStaticState({ navigatorContext }) to forward headers such as X-Forwarded-For.');
+        logger.warn('[WARNING] Missing navigator context in server-side code. Make sure to set it with `setNavigatorContextProvider` before calling fetchStaticState()');
     }
     const controllerProps = buildOptions && 'controllers' in buildOptions
         ? buildOptions.controllers

package/dist/esm/ssr-next/commerce/factories/static-state-factory.js

@@ -1,14 +1,21 @@
 import { buildProductListing } from '../../../controllers/commerce/product-listing/headless-product-listing.js';
 import { buildSearch } from '../../../controllers/commerce/search/headless-search.js';
-import { processNavigatorContext } from '../../common/navigator-context-utils.js';
+import { augmentPreprocessRequestWithForwardedFor } from '../../common/augment-preprocess-request.js';
 import { createStaticState } from '../controller-utils.js';
 import { SolutionType } from '../types/controller-constants.js';
 import { buildFactory, } from './build-factory.js';
 export function fetchStaticStateFactory(controllerDefinitions, options) {
     return (solutionType) => async (...params) => {
-        const { engineOptions } = processNavigatorContext(params, options);
-        const solutionTypeBuild = await buildFactory(controllerDefinitions, engineOptions)(solutionType);
+        const solutionTypeBuild = await buildFactory(controllerDefinitions, {
+            ...options,
+        })(solutionType);
         const { engine, controllers } = await solutionTypeBuild(...params);
+        options.configuration.preprocessRequest =
+            augmentPreprocessRequestWithForwardedFor({
+                preprocessRequest: options.configuration.preprocessRequest,
+                navigatorContextProvider: options.navigatorContextProvider,
+                loggerOptions: options.loggerOptions,
+            });
         switch (solutionType) {
             case SolutionType.listing:
                 buildProductListing(engine).executeFirstRequest();

package/dist/esm/ssr-next/search/engine/search-engine.ssr.js

@@ -1,7 +1,8 @@
+import { buildLogger } from '../../../app/logger.js';
 import { buildSearchEngine, } from '../../../app/search-engine/search-engine.js';
 import { createWaitForActionMiddleware } from '../../../utils/utils.js';
+import { augmentPreprocessRequestWithForwardedFor } from '../../common/augment-preprocess-request.js';
 import { buildControllerDefinitions, createStaticState, } from '../../common/controller-utils.js';
-import { processNavigatorContext } from '../../common/navigator-context-utils.js';
 function isSearchCompletedAction(action) {
     return /^search\/executeSearch\/(fulfilled|rejected)$/.test(action.type);
 }
@@ -22,52 +23,50 @@ function buildSSRSearchEngine(options) {
     };
 }
 /**
- * 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 function defineSearchEngine(options) {
     const { controllers: controllerDefinitions, ...engineOptions } = options;
-    const hydrateStaticState = async (...params) => {
-        const engine = buildSSRSearchEngine(engineOptions);
-        const controllers = buildControllerDefinitions({
-            definitionsMap: (controllerDefinitions ?? {}),
-            engine,
-            propsMap: {},
-        });
-        const [staticState] = params;
-        engine.dispatch(staticState.searchAction);
-        await engine.waitForSearchCompletedAction();
-        return { engine, controllers };
+    const getOptions = () => {
+        return engineOptions;
     };
-    const fetchStaticState = async (...params) => {
-        const { engineOptions, callOptions } = processNavigatorContext(params, options);
-        const engine = buildSSRSearchEngine(engineOptions);
+    const setNavigatorContextProvider = (navigatorContextProvider) => {
+        engineOptions.navigatorContextProvider = navigatorContextProvider;
+    };
+    const build = async (...[buildOptions]) => {
+        const logger = buildLogger(options.loggerOptions);
+        if (!getOptions().navigatorContextProvider) {
+            logger.warn('[WARNING] Missing navigator context in server-side code. Make sure to set it with `setNavigatorContextProvider` before calling fetchStaticState()');
+        }
+        const engine = buildSSRSearchEngine(buildOptions?.extend
+            ? await buildOptions.extend(getOptions())
+            : getOptions());
         const controllers = buildControllerDefinitions({
             definitionsMap: (controllerDefinitions ?? {}),
             engine,
-            propsMap: (callOptions && 'controllers' in callOptions
-                ? callOptions.controllers
+            propsMap: (buildOptions && 'controllers' in buildOptions
+                ? buildOptions.controllers
                 : {}),
         });
+        return {
+            engine,
+            controllers,
+        };
+    };
+    const fetchStaticState = async (...params) => {
+        const { engine, controllers } = await build(...params);
+        options.configuration.preprocessRequest =
+            augmentPreprocessRequestWithForwardedFor({
+                preprocessRequest: options.configuration.preprocessRequest,
+                navigatorContextProvider: options.navigatorContextProvider,
+                loggerOptions: options.loggerOptions,
+            });
         engine.executeFirstSearch();
         const staticState = createStaticState({
             searchAction: await engine.waitForSearchCompletedAction(),
@@ -75,8 +74,15 @@ export function defineSearchEngine(options) {
         });
         return staticState;
     };
+    const hydrateStaticState = async (...params) => {
+        const { engine, controllers } = await build(...params);
+        engine.dispatch(params[0].searchAction);
+        await engine.waitForSearchCompletedAction();
+        return { engine, controllers };
+    };
     return {
         fetchStaticState,
         hydrateStaticState,
+        setNavigatorContextProvider,
     };
 }

package/dist/esm/ssr-next.index.js

@@ -36,17 +36,11 @@
  * export type SearchStaticState = InferStaticState<typeof engineDefinition>;
  * export type SearchHydratedState = InferHydratedState<typeof engineDefinition>;
  *
- * export const {fetchStaticState, hydrateStaticState} = engineDefinition;
-
- * // Pass navigator context directly per call (server-side)
- * await fetchStaticState({
- *   navigatorContext: {
- *     forwardedFor: req.ip,
- *     referrer: req.headers.referer || null,
- *     userAgent: req.headers['user-agent'] || null,
- *     clientId: req.sessionID || 'anonymous',
- *   },
- * });
+ * export const {
+ *   fetchStaticState,
+ *   hydrateStaticState,
+ *   setNavigatorContextProvider,
+ * } = engineDefinition;
 
  * ```
  * @module SSR Search

package/dist/esm/utils/version.js

@@ -1,2 +1,2 @@
-export const VERSION = "3.28.4-pre.e9817a9757" || 'Test version';
+export const VERSION = "3.28.4-pre.ea13b3b94e" || 'Test version';
 export const COVEO_FRAMEWORK = ['@coveo/atomic', '@coveo/quantic'];