@coveo/headless 3.31.1-pre.2a4e86e414 → 3.31.1-pre.2be2e02d64

package/dist/definitions/ssr/commerce/types/engine.d.ts

@@ -43,8 +43,6 @@ export interface EngineDefinition<TControllers extends ControllerDefinitionsMap<
      */
     build: Build<TEngineOptions, InferControllersMapFromDefinition<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
     /**
-     * @deprecated This method will be removed in a future major version. Navigator context should be provided directly when fetching the static state.
-     *
      * 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.
      *

package/dist/definitions/ssr/common/types/engine.d.ts

@@ -27,8 +27,6 @@ export interface EngineDefinition<TEngine extends CoreEngine | CoreEngineNext, T
      */
     hydrateStaticState: HydrateStaticState<TEngine, InferControllersMapFromDefinition<TControllers>, AnyAction, InferControllerPropsMapFromDefinitions<TControllers>>;
     /**
-     * @deprecated This method will be removed in a future major version. Navigator context should be provided directly when fetching the static state
-     *
      * 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.
      *

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

@@ -20,7 +20,7 @@ import type { CommerceEngineDefinition, CommerceEngineDefinitionOptions } from '
  * const { listingEngineDefinition } = defineCommerceEngine(engineConfig);
  *
  * const staticState = await listingEngineDefinition.fetchStaticState({
- *   navigatorContext: {/*...* /},
+ *   navigatorContextProvider: () => {/*...* /},
  *   context: {/*...* /},
  * });
  *

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

@@ -1,5 +1,5 @@
 import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
-import type { NavigatorContext } from '../../../app/navigator-context-provider.js';
+import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { HasKey } from '../../common/types/utilities.js';
 import type { CartInitialState } from '../controllers/cart/headless-cart.ssr.js';
@@ -72,7 +72,7 @@ export interface ListingBuildConfig extends CommonBuildConfig {
 export interface StandaloneBuildConfig extends CommonBuildConfig {
 }
 export interface CommonBuildConfig {
-    navigatorContext: NavigatorContext;
+    navigatorContextProvider: NavigatorContextProvider;
     context: ContextOptions;
     searchParams?: ParameterManagerState<Parameters>['parameters'];
     cart?: CartInitialState;

package/dist/definitions/ssr-next/common/augment-preprocess-request.d.ts

@@ -1,9 +1,9 @@
 import type { PlatformClientOrigin, PlatformRequestOptions, PreprocessRequest, RequestMetadata } from '../../api/preprocess-request.js';
 import { type LoggerOptions } from '../../app/logger.js';
-import type { NavigatorContext } from '../../app/navigator-context-provider.js';
+import type { NavigatorContextProvider } from '../../app/navigator-context-provider.js';
 export interface AugmentPreprocessRequestOptions {
-    navigatorContext: NavigatorContext;
     preprocessRequest?: PreprocessRequest;
+    navigatorContextProvider?: NavigatorContextProvider;
     loggerOptions?: LoggerOptions;
 }
 export declare function augmentPreprocessRequestWithForwardedFor(options: AugmentPreprocessRequestOptions): (request: PlatformRequestOptions, clientOrigin: PlatformClientOrigin, metadata?: RequestMetadata) => Promise<PlatformRequestOptions>;

package/dist/definitions/ssr-next/search/types/build.d.ts

@@ -1,9 +1,9 @@
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
-import type { NavigatorContext } from '../../../app/navigator-context-provider.js';
+import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
 import type { SearchEngineDefinitionBuildResult, SearchEngineDefinitionControllersPropsOption } from './engine.js';
 export type BuildConfig = {
-    navigatorContext: NavigatorContext;
+    navigatorContextProvider: NavigatorContextProvider;
 };
 /**
  * @internal

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

@@ -25,7 +25,7 @@ import { validateControllerNames } from '../validation/controller-validation.js'
  * const { listingEngineDefinition } = defineCommerceEngine(engineConfig);
  *
  * const staticState = await listingEngineDefinition.fetchStaticState({
- *   navigatorContext: {/*...* /},
+ *   navigatorContextProvider: () => {/*...* /},
  *   context: {/*...* /},
  * });
  *

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

@@ -1,22 +1,22 @@
 import { buildLogger } from '../../../app/logger.js';
 import { augmentPreprocessRequestWithForwardedFor } from '../../common/augment-preprocess-request.js';
-const ensurenavigatorContext = (buildConfig, loggerOptions) => {
-    if (!buildConfig.navigatorContext) {
+const ensureNavigatorContextProvider = (buildConfig, loggerOptions) => {
+    if (!buildConfig.navigatorContextProvider) {
         const logger = buildLogger(loggerOptions);
-        logger.error('No navigatorContext was provided. This may impact analytics accuracy, personalization, and session tracking. Refer to the Coveo documentation on server-side navigation context for implementation guidance.');
+        logger.error('No navigatorContextProvider was provided. This may impact analytics accuracy, personalization, and session tracking. Refer to the Coveo documentation on server-side navigation context for implementation guidance.');
     }
 };
 export function augmentCommerceEngineOptions(engineOptions, buildConfig) {
     const { cart, context } = buildConfig;
-    ensurenavigatorContext(buildConfig, engineOptions.loggerOptions);
+    ensureNavigatorContextProvider(buildConfig, engineOptions.loggerOptions);
     return {
         ...engineOptions,
-        navigatorContextProvider: () => buildConfig.navigatorContext,
+        navigatorContextProvider: buildConfig.navigatorContextProvider,
         configuration: {
             ...engineOptions.configuration,
             preprocessRequest: augmentPreprocessRequestWithForwardedFor({
                 preprocessRequest: engineOptions.configuration.preprocessRequest,
-                navigatorContext: buildConfig.navigatorContext,
+                navigatorContextProvider: buildConfig.navigatorContextProvider,
                 loggerOptions: engineOptions.loggerOptions,
             }),
             context: {

package/dist/esm/ssr-next/common/augment-preprocess-request.js

@@ -5,7 +5,7 @@ export function augmentPreprocessRequestWithForwardedFor(options) {
     return async (request, clientOrigin, metadata) => {
         if (!isBrowser()) {
             const headers = new Headers(request.headers);
-            const forwardedFor = options.navigatorContext.forwardedFor;
+            const forwardedFor = options.navigatorContextProvider?.()?.forwardedFor;
             if (forwardedFor) {
                 headers.set('x-forwarded-for', forwardedFor);
             }

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

@@ -42,15 +42,16 @@ function buildSSRSearchEngine(options) {
 export function defineSearchEngine(options) {
     const { controllers: controllerDefinitions, ...engineOptions } = options;
     const build = async (buildOptions) => {
-        if (!buildOptions.navigatorContext) {
+        if (!engineOptions.navigatorContextProvider) {
             const logger = buildLogger(options.loggerOptions);
-            logger.error('No navigatorContext was provided. This may impact analytics accuracy, personalization, and session tracking. Refer to the Coveo documentation on server-side navigation context for implementation guidance.');
+            logger.error('No navigatorContextProvider was provided. This may impact analytics accuracy, personalization, and session tracking. Refer to the Coveo documentation on server-side navigation context for implementation guidance.');
         }
-        engineOptions.navigatorContextProvider = () => buildOptions.navigatorContext;
+        engineOptions.navigatorContextProvider = buildOptions.navigatorContextProvider;
         engineOptions.configuration.preprocessRequest =
             augmentPreprocessRequestWithForwardedFor({
                 preprocessRequest: engineOptions.configuration.preprocessRequest,
-                navigatorContext: buildOptions.navigatorContext,
+                navigatorContextProvider: buildOptions
+                    .navigatorContextProvider,
                 loggerOptions: engineOptions.loggerOptions,
             });
         const engine = buildSSRSearchEngine(engineOptions);

package/dist/esm/utils/version.js

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