@coveo/headless 3.31.0 → 3.31.1-pre.0dc56cfa7e

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

@@ -43,6 +43,8 @@ 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,6 +27,8 @@ 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/common/types/utilities.d.ts

@@ -9,6 +9,9 @@ export type HasOptionalKeys<TObject> = TObject extends {} ? {
 type ExtractRequiredOptions<TOptions> = {
     [TKey in keyof TOptions as Pick<TOptions, TKey> extends Required<Pick<TOptions, TKey>> ? TKey : never]: TOptions[TKey];
 };
+/**
+ * @deprecated This type will be removed in the next major version.
+ */
 export type OptionsTuple<TOptions> = HasKeys<TOptions> extends false ? [] : HasKeys<ExtractRequiredOptions<TOptions>> extends false ? [options?: TOptions] : [options: TOptions];
 export type OptionsExtender<TOptions> = (options: TOptions) => TOptions | Promise<TOptions>;
 export {};

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

@@ -125,7 +125,7 @@ export { defineCommerceEngine } from './ssr-next/commerce/engine/commerce-engine
 export type { SSRCommerceEngine as CommerceEngine } from './ssr-next/commerce/factories/build-factory.js';
 export type { BuildConfig, SSRCommerceEngineOptions as CommerceEngineOptions, } from './ssr-next/commerce/types/build.js';
 export { SolutionType } from './ssr-next/commerce/types/controller-constants.js';
-export type { AugmentedControllerDefinition, CommerceEngineDefinitionControllersPropsOption as EngineDefinitionControllersPropsOption, ControllerDefinition, ControllerDefinitionsMap, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
+export type { AugmentedControllerDefinition, CommerceEngineDefinitionControllersPropsOption as EngineDefinitionControllersPropsOption, ControllerDefinition, ControllerDefinitionsMap, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, } from './ssr-next/commerce/types/controller-definitions.js';
 export type { InferControllerFromDefinition, InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition, InferHydratedState, InferStaticState, } from './ssr-next/commerce/types/controller-inference.js';
 export type { CommerceEngineDefinition, CommerceEngineDefinitionBuildResult, CommerceEngineDefinitionOptions, EngineStaticState, FetchStaticState, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
 export type { CommerceAppState, CommerceProductListingParametersState, CommerceSearchParametersState, } from './state/commerce-app-state.js';

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({
- *   navigatorContextProvider: () => {/*...* /},
+ *   navigatorContext: {/*...* /},
  *   context: {/*...* /},
  * });
  *

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

@@ -15,7 +15,7 @@ export interface SSRCommerceEngine extends CommerceEngine {
      */
     waitForRequestCompletedAction(): Promise<Action>[];
 }
-export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (...[buildOptions]: FetchStaticStateParameters<TControllerDefinitions, TSolutionType> | HydrateStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<{
+export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (buildOptions: FetchStaticStateParameters<TControllerDefinitions, TSolutionType> | HydrateStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<{
     engine: SSRCommerceEngine;
     controllers: InferControllersMapFromDefinition<TControllerDefinitions, TSolutionType> & BakedInControllers;
 }>;

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

@@ -1,7 +1,7 @@
 import type { SolutionType } from '../types/controller-constants.js';
 import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
 import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, HydrateStaticStateParameters } from '../types/engine.js';
-export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (...params: HydrateStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<{
+export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (params: HydrateStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<{
     engine: import("./build-factory.js").SSRCommerceEngine;
     controllers: import("../types/controller-inference.js").InferControllersMapFromDefinition<TControllerDefinitions, TSolutionType> & import("../types/controller-definitions.js").BakedInControllers;
 }>;

package/dist/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts

@@ -2,13 +2,10 @@ import type { UnknownAction } from '@reduxjs/toolkit';
 import { SolutionType } from '../types/controller-constants.js';
 import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
 import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, FetchStaticStateParameters } from '../types/engine.js';
-export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (...params: FetchStaticStateParameters<TControllerDefinitions, SolutionType.recommendation>) => Promise<{
-    controllers: import("../types/controller-inference.js").InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, SolutionType.recommendation> & import("../types/controller-definitions.js").FilteredBakedInControllers<SolutionType.recommendation>;
-    searchActions: UnknownAction[];
-    navigatorContextProvider: import("../../../ssr.index.js").NavigatorContextProvider;
-    context: import("../../../commerce.index.js").ContextOptions;
-    searchParams?: import("../../../commerce.index.js").ParameterManagerState<import("../../../commerce.index.js").Parameters>["parameters"];
-    cart?: import("../../../commerce.index.js").CartInitialState;
+export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (params: FetchStaticStateParameters<TControllerDefinitions, SolutionType.recommendation>) => Promise<import("../types/build.js").CommonBuildConfig & {
     productId?: string;
     recommendations: Extract<keyof TControllerDefinitions, { [K in keyof TControllerDefinitions]: import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], SolutionType.recommendation> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? never : K; }[keyof TControllerDefinitions]>[];
+} & { [K_1 in keyof TControllerDefinitions as import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K_1], SolutionType.recommendation> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K_1], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? import("../../common/types/utilities.js").HasRequiredKeys<import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T as I extends K_1 ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never> extends false ? never : "controllers" : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T_1 extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T_1 as I extends K_1 ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never; } & {
+    controllers: import("../types/controller-inference.js").InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, SolutionType.recommendation> & import("../types/controller-definitions.js").FilteredBakedInControllers<SolutionType.recommendation>;
+    searchActions: UnknownAction[];
 }>;

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

@@ -1,9 +1,8 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
-import type { BuildConfig } from '../types/build.js';
 import { SolutionType } from '../types/controller-constants.js';
 import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
 import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, FetchStaticStateParameters } from '../types/engine.js';
-export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (...params: FetchStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<BuildConfig<TControllerDefinitions, TSolutionType> & {
+export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (params: FetchStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<import("../types/build.js").BuildConfig<TControllerDefinitions, TSolutionType> & { [K in keyof TControllerDefinitions as import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], TSolutionType> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? import("../../common/types/utilities.js").HasRequiredKeys<import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T as I extends K ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never> extends false ? never : "controllers" : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T_1 extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T_1 as I extends K ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never; } & {
     controllers: import("../types/controller-inference.js").InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, TSolutionType> & import("../types/controller-definitions.js").FilteredBakedInControllers<TSolutionType>;
     searchActions: UnknownAction[];
 }>;

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 { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
+import type { NavigatorContext } 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 {
-    navigatorContextProvider: NavigatorContextProvider;
+    navigatorContext: NavigatorContext;
     context: ContextOptions;
     searchParams?: ParameterManagerState<Parameters>['parameters'];
     cart?: CartInitialState;

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

@@ -1,7 +1,7 @@
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers } from '../../common/types/controller-inference.js';
 import type { ControllersPropsMap } from '../../common/types/controllers.js';
-import type { HasKey, HasRequiredKeys, OptionsTuple } from '../../common/types/utilities.js';
+import type { HasKey, HasRequiredKeys } from '../../common/types/utilities.js';
 import type { CartDefinition } from '../controllers/cart/headless-cart.ssr.js';
 import type { ContextDefinition } from '../controllers/context/headless-context.ssr.js';
 import type { ParameterManagerDefinition } from '../controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
@@ -10,7 +10,7 @@ import { type recommendationInternalOptionKey, SolutionType } from './controller
 import type { ListingAndStandaloneController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
 import type { HydratedState } from './hydrate-static-state.js';
 import type { HasSolutionType } from './utilities.js';
-export type { HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
+export type { HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
 export interface ControllerDefinitionWithoutProps<TController extends Controller> {
     /**
      * Creates an instance of the given controller.

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

@@ -52,5 +52,5 @@ export type CommerceControllerDefinitionsMap = ControllerDefinitionsMap<Controll
 type Definition<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = CommerceEngineDefinition<TControllerDefinitions, TSolutionType>;
 type FetchStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = Definition<TControllerDefinitions, TSolutionType>['fetchStaticState'];
 export type HydrateStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = Definition<TControllerDefinitions, TSolutionType>['hydrateStaticState'];
-export type FetchStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = Parameters<FetchStaticStateFunction<TControllerDefinitions, TSolutionType>>;
-export type HydrateStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = Parameters<HydrateStaticStateFunction<TControllerDefinitions, TSolutionType>>;
+export type FetchStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = Parameters<FetchStaticStateFunction<TControllerDefinitions, TSolutionType>>[0];
+export type HydrateStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap, TSolutionType extends SolutionType> = Parameters<HydrateStaticStateFunction<TControllerDefinitions, TSolutionType>>[0];

package/dist/definitions/ssr-next/commerce/types/fetch-static-state.d.ts

@@ -4,10 +4,10 @@ import type { ControllerStaticStateMap, ControllersPropsMap } from '../../common
 import type { EngineStaticState } from '../../common/types/engine.js';
 import type { BuildConfig } from './build.js';
 import type { SolutionType } from './controller-constants.js';
-import type { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap, FilteredBakedInControllers, OptionsTuple } from './controller-definitions.js';
+import type { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap, FilteredBakedInControllers } from './controller-definitions.js';
 /**
  * Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
  *
  * Useful for static generation and server-side rendering.
  */
-export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildConfig<TControllersDefinitionsMap, TSolutionType> & CommerceEngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState & FilteredBakedInControllers<TSolutionType>> & BuildConfig<TControllersDefinitionsMap, TSolutionType>>;
+export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (params: BuildConfig<TControllersDefinitionsMap, TSolutionType> & CommerceEngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState & FilteredBakedInControllers<TSolutionType>> & BuildConfig<TControllersDefinitionsMap, TSolutionType>>;

package/dist/definitions/ssr-next/commerce/types/hydrate-static-state.d.ts

@@ -3,7 +3,7 @@ import type { Controller } from '../../../controllers/controller/headless-contro
 import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
 import type { BuildConfig } from './build.js';
 import type { SolutionType } from './controller-constants.js';
-import type { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap, OptionsTuple } from './controller-definitions.js';
+import type { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap } from './controller-definitions.js';
 import type { CommerceEngineDefinitionBuildResult } from './engine.js';
 export type HydratedState<TControllers extends ControllersMap> = CommerceEngineDefinitionBuildResult<TControllers>;
 export interface HydrateStaticStateOptions<TSearchAction> {
@@ -14,4 +14,4 @@ export interface HydrateStaticStateOptions<TSearchAction> {
  *
  * Useful when hydrating a server-side-rendered engine.
  */
-export type HydrateStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction> & BuildConfig<TControllersDefinitionsMap, TSolutionType> & CommerceEngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<HydratedState<TControllers>>;
+export type HydrateStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (params: HydrateStaticStateOptions<TSearchAction> & BuildConfig<TControllersDefinitionsMap, TSolutionType> & CommerceEngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>) => Promise<HydratedState<TControllers>>;

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 { NavigatorContextProvider } from '../../app/navigator-context-provider.js';
+import type { NavigatorContext } 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/common/types/utilities.d.ts

@@ -3,8 +3,3 @@ export type HasKeys<TObject> = TObject extends {} ? keyof TObject extends never
 export type HasRequiredKeys<TObject> = TObject extends {} ? {
     [K in keyof TObject]-?: {} extends Pick<TObject, K> ? never : K;
 }[keyof TObject] extends never ? false : true : boolean;
-type ExtractRequiredOptions<TOptions> = {
-    [TKey in keyof TOptions as Pick<TOptions, TKey> extends Required<Pick<TOptions, TKey>> ? TKey : never]: TOptions[TKey];
-};
-export type OptionsTuple<TOptions> = HasKeys<TOptions> extends false ? [] : HasKeys<ExtractRequiredOptions<TOptions>> extends false ? [options?: TOptions] : [options: TOptions];
-export {};

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

@@ -1,12 +1,11 @@
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
-import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
+import type { NavigatorContext } from '../../../app/navigator-context-provider.js';
 import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
-import type { OptionsTuple } from '../../common/types/utilities.js';
 import type { SearchEngineDefinitionBuildResult, SearchEngineDefinitionControllersPropsOption } from './engine.js';
 export type BuildConfig = {
-    navigatorContextProvider: NavigatorContextProvider;
+    navigatorContext: NavigatorContext;
 };
 /**
  * @internal
  */
-export type Build<TEngine extends CoreEngine | CoreEngineNext, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<SearchEngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<SearchEngineDefinitionBuildResult<TEngine, TControllersMap>>;
+export type Build<TEngine extends CoreEngine | CoreEngineNext, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap> = (props: SearchEngineDefinitionControllersPropsOption<TControllersProps>) => Promise<SearchEngineDefinitionBuildResult<TEngine, TControllersMap>>;

package/dist/definitions/ssr-next/search/types/fetch-static-state.d.ts

@@ -1,7 +1,6 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { ControllerStaticStateMap, ControllersPropsMap } from '../../common/types/controllers.js';
 import type { EngineStaticState } from '../../common/types/engine.js';
-import type { OptionsTuple } from '../../common/types/utilities.js';
 import type { BuildConfig } from './build.js';
 import type { SearchEngineDefinitionControllersPropsOption } from './engine.js';
 /**
@@ -9,4 +8,4 @@ import type { SearchEngineDefinitionControllersPropsOption } from './engine.js';
  *
  * Useful for static generation and server-side rendering.
  */
-export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<BuildConfig & SearchEngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState> & BuildConfig>;
+export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap> = (params: BuildConfig & SearchEngineDefinitionControllersPropsOption<TControllersProps>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState> & BuildConfig>;

package/dist/definitions/ssr-next/search/types/hydrate-static-state.d.ts

@@ -1,7 +1,6 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
 import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
-import type { OptionsTuple } from '../../common/types/utilities.js';
 import type { BuildConfig } from './build.js';
 import type { SearchEngineDefinitionBuildResult, SearchEngineDefinitionControllersPropsOption } from './engine.js';
 export type HydratedState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> = SearchEngineDefinitionBuildResult<TEngine, TControllers>;
@@ -13,5 +12,5 @@ interface HydrateStaticStateOptions<TSearchAction> {
  *
  * Useful when hydrating a server-side-rendered engine.
  */
-export type HydrateStaticState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<BuildConfig & HydrateStaticStateOptions<TSearchAction> & SearchEngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<HydratedState<TEngine, TControllers>>;
+export type HydrateStaticState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap> = (params: BuildConfig & HydrateStaticStateOptions<TSearchAction> & SearchEngineDefinitionControllersPropsOption<TControllersProps>) => Promise<HydratedState<TEngine, TControllers>>;
 export {};

package/dist/definitions/test/mock-navigator-context.d.ts

@@ -0,0 +1,2 @@
+import type { NavigatorContext } from '../app/navigator-context-provider.js';
+export declare const buildMockNavigatorContext: (context?: Partial<NavigatorContext>) => NavigatorContext;

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({
- *   navigatorContextProvider: () => {/*...* /},
+ *   navigatorContext: {/*...* /},
  *   context: {/*...* /},
  * });
  *

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

@@ -56,13 +56,13 @@ function buildSSRCommerceEngine(solutionType, options, recommendationCount) {
         },
     };
 }
-export const buildFactory = (controllerDefinitions, options) => (solutionType) => async (...[buildOptions]) => {
-    const controllerProps = wireControllerParams(solutionType, controllerDefinitions, buildOptions); // TODO: KIT-4754: remove non-null assertion operator
-    const enabledRecommendationControllers = buildOptions && 'recommendations' in buildOptions // TODO: KIT-4754: remove non-null assertion
+export const buildFactory = (controllerDefinitions, options) => (solutionType) => async (buildOptions) => {
+    const controllerProps = wireControllerParams(solutionType, controllerDefinitions, buildOptions);
+    const enabledRecommendationControllers = buildOptions && 'recommendations' in buildOptions
         ? buildOptions
             ?.recommendations.length
         : 0;
-    const engineOptions = augmentCommerceEngineOptions(options, buildOptions); // TODO: KIT-4754: remove non-null assertion operator
+    const engineOptions = augmentCommerceEngineOptions(options, buildOptions);
     const engine = buildSSRCommerceEngine(solutionType, engineOptions, enabledRecommendationControllers);
     const controllers = buildControllerDefinitions({
         definitionsMap: controllerDefinitions ?? {},

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

@@ -1,8 +1,8 @@
 import { buildFactory } from './build-factory.js';
 export function hydratedStaticStateFactory(controllerDefinitions, options) {
-    return (solutionType) => async (...params) => {
+    return (solutionType) => async (params) => {
         const solutionTypeBuild = await buildFactory(controllerDefinitions, options)(solutionType);
-        const { engine, controllers } = await solutionTypeBuild(...params);
+        const { engine, controllers } = await solutionTypeBuild(params);
         await engine.waitForRequestCompletedAction();
         return { engine, controllers };
     };

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

@@ -1,9 +1,9 @@
 import { SolutionType } from '../types/controller-constants.js';
 import { buildFactory } from './build-factory.js';
 export function hydratedRecommendationStaticStateFactory(controllerDefinitions, options) {
-    return async (...params) => {
+    return async (params) => {
         const solutionTypeBuild = await buildFactory(controllerDefinitions, options)(SolutionType.recommendation);
-        const { engine, controllers } = await solutionTypeBuild(...params);
+        const { engine, controllers } = await solutionTypeBuild(params);
         await engine.waitForRequestCompletedAction();
         return { engine, controllers };
     };

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

@@ -3,11 +3,10 @@ import { SolutionType } from '../types/controller-constants.js';
 import { filterRecommendationControllers } from '../utils/recommendation-filter.js';
 import { buildFactory } from './build-factory.js';
 export function fetchRecommendationStaticStateFactory(controllerDefinitions, options) {
-    return async (...params) => {
-        const [props] = params;
-        const allowedRecommendationKeys = props?.recommendations;
+    return async (params) => {
+        const allowedRecommendationKeys = params.recommendations;
         const solutionTypeBuild = await buildFactory(controllerDefinitions, options)(SolutionType.recommendation);
-        const { engine, controllers } = await solutionTypeBuild(...params);
+        const { engine, controllers } = await solutionTypeBuild(params);
         filterRecommendationControllers(controllers, controllerDefinitions ?? {}).refresh(allowedRecommendationKeys);
         const searchActions = await Promise.all(engine.waitForRequestCompletedAction());
         const staticState = createStaticState({
@@ -15,7 +14,7 @@ export function fetchRecommendationStaticStateFactory(controllerDefinitions, opt
             controllers,
         });
         return {
-            ...params[0], // TODO: KIT-4754: remove index access after no longer relying on OptionTuple type
+            ...params,
             ...staticState,
         };
     };

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

@@ -4,9 +4,9 @@ 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) => {
+    return (solutionType) => async (params) => {
         const solutionTypeBuild = await buildFactory(controllerDefinitions, options)(solutionType);
-        const { engine, controllers } = await solutionTypeBuild(...params);
+        const { engine, controllers } = await solutionTypeBuild(params);
         switch (solutionType) {
             case SolutionType.listing:
                 buildProductListing(engine).executeFirstRequest();
@@ -21,7 +21,7 @@ export function fetchStaticStateFactory(controllerDefinitions, options) {
             controllers,
         });
         return {
-            ...params[0], // TODO: KIT-4754: remove index access after no longer relying on OptionTuple type
+            ...params,
             ...staticState,
         };
     };

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 ensureNavigatorContextProvider = (buildConfig, loggerOptions) => {
-    if (!buildConfig.navigatorContextProvider) {
+const ensurenavigatorContext = (buildConfig, loggerOptions) => {
+    if (!buildConfig.navigatorContext) {
         const logger = buildLogger(loggerOptions);
-        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.');
+        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.');
     }
 };
 export function augmentCommerceEngineOptions(engineOptions, buildConfig) {
     const { cart, context } = buildConfig;
-    ensureNavigatorContextProvider(buildConfig, engineOptions.loggerOptions);
+    ensurenavigatorContext(buildConfig, engineOptions.loggerOptions);
     return {
         ...engineOptions,
-        navigatorContextProvider: buildConfig.navigatorContextProvider,
+        navigatorContextProvider: () => buildConfig.navigatorContext,
         configuration: {
             ...engineOptions.configuration,
             preprocessRequest: augmentPreprocessRequestWithForwardedFor({
                 preprocessRequest: engineOptions.configuration.preprocessRequest,
-                navigatorContextProvider: buildConfig.navigatorContextProvider,
+                navigatorContext: buildConfig.navigatorContext,
                 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.navigatorContextProvider?.()?.forwardedFor;
+            const forwardedFor = options.navigatorContext.forwardedFor;
             if (forwardedFor) {
                 headers.set('x-forwarded-for', forwardedFor);
             }

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

@@ -41,17 +41,16 @@ function buildSSRSearchEngine(options) {
  */
 export function defineSearchEngine(options) {
     const { controllers: controllerDefinitions, ...engineOptions } = options;
-    const build = async (...[buildOptions]) => {
-        if (!engineOptions.navigatorContextProvider) {
+    const build = async (buildOptions) => {
+        if (!buildOptions.navigatorContext) {
             const logger = buildLogger(options.loggerOptions);
-            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.');
+            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.');
         }
-        engineOptions.navigatorContextProvider = buildOptions.navigatorContextProvider;
+        engineOptions.navigatorContextProvider = () => buildOptions.navigatorContext;
         engineOptions.configuration.preprocessRequest =
             augmentPreprocessRequestWithForwardedFor({
                 preprocessRequest: engineOptions.configuration.preprocessRequest,
-                navigatorContextProvider: buildOptions
-                    .navigatorContextProvider,
+                navigatorContext: buildOptions.navigatorContext,
                 loggerOptions: engineOptions.loggerOptions,
             });
         const engine = buildSSRSearchEngine(engineOptions);
@@ -67,21 +66,21 @@ export function defineSearchEngine(options) {
             controllers,
         };
     };
-    const fetchStaticState = async (...params) => {
-        const { engine, controllers } = await build(...params);
+    const fetchStaticState = async (params) => {
+        const { engine, controllers } = await build(params);
         engine.executeFirstSearch();
         const staticState = createStaticState({
             searchActions: [await engine.waitForSearchCompletedAction()],
             controllers: controllers,
         });
         return {
-            ...params[0], // TODO: KIT-4754: remove index access after no longer relying on OptionTuple type
+            ...params,
             ...staticState,
         };
     };
-    const hydrateStaticState = async (...params) => {
-        const { engine, controllers } = await build(...params);
-        params[0].searchActions.forEach((action) => {
+    const hydrateStaticState = async (params) => {
+        const { engine, controllers } = await build(params);
+        params.searchActions.forEach((action) => {
             engine.dispatch(action);
         });
         await engine.waitForSearchCompletedAction();

package/dist/esm/test/mock-navigator-context.js

@@ -0,0 +1,9 @@
+export const buildMockNavigatorContext = (context) => {
+    return {
+        referrer: 'some-test-referrer',
+        userAgent: '',
+        location: '',
+        clientId: '',
+        ...context,
+    };
+};

package/dist/esm/utils/version.js

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