@coveo/headless 3.29.2 → 3.29.3-pre.0951f1103d

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

@@ -2,13 +2,15 @@ import type { UnknownAction } from '@reduxjs/toolkit';
 import type { Controller } from '../../controllers/controller/headless-controller.js';
 import type { SSRCommerceEngine } from './factories/build-factory.js';
 import type { SolutionType } from './types/controller-constants.js';
-import type { ControllerDefinitionOption, ControllerDefinitionsMap } from './types/controller-definitions.js';
+import type { ControllerDefinitionOption, ControllerDefinitionsMap, FilteredBakedInControllers } from './types/controller-definitions.js';
 import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './types/controller-inference.js';
-import type { EngineStaticState } from './types/engine.js';
-export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<Controller>>({ searchActions, controllers, }: {
+export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>({ searchActions, controllers, }: {
     searchActions: TSearchAction[];
-    controllers: InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>;
-}): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, SolutionType>>;
+    controllers: Record<string, Controller>;
+}): {
+    controllers: InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, TSolutionType> & FilteredBakedInControllers<TSolutionType>;
+    searchActions: TSearchAction[];
+};
 export declare function buildControllerDefinitions<TControllerDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>({ definitionsMap, engine, solutionType, propsMap, }: {
     definitionsMap: TControllerDefinitionsMap;
     engine: SSRCommerceEngine;

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

@@ -1,7 +1,9 @@
 import type { Action } from '@reduxjs/toolkit';
 import { type CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
 import { SolutionType } from '../types/controller-constants.js';
-import type { BuildParameters, CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions } from '../types/engine.js';
+import type { AugmentedControllerDefinition, BakedInControllers } from '../types/controller-definitions.js';
+import type { InferControllersMapFromDefinition } from '../types/controller-inference.js';
+import type { CommerceControllerDefinitionsMap, FetchStaticStateParameters, HydrateStaticStateParameters, CommerceEngineDefinitionOptions } from '../types/engine.js';
 /**
  * The SSR commerce engine.
  *
@@ -13,7 +15,7 @@ export interface SSRCommerceEngine extends CommerceEngine {
      */
     waitForRequestCompletedAction(): Promise<Action>[];
 }
-export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <T extends SolutionType>(solutionType: T) => (...[buildOptions]: BuildParameters<TControllerDefinitions>) => Promise<{
+export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (...[buildOptions]: FetchStaticStateParameters<TControllerDefinitions, TSolutionType> | HydrateStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<{
     engine: SSRCommerceEngine;
-    controllers: import("../types/controller-inference.js").InferControllersMapFromDefinition<TControllerDefinitions, T>;
+    controllers: InferControllersMapFromDefinition<TControllerDefinitions, TSolutionType> & BakedInControllers;
 }>;

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

@@ -1,4 +1,7 @@
 import type { SolutionType } from '../types/controller-constants.js';
 import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
-import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, HydrateStaticStateFunction } from '../types/engine.js';
-export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;
+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<{
+    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-hydrated-state-factory.d.ts

@@ -1,2 +1,4 @@
+import { SolutionType } from '../types/controller-constants.js';
+import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
 import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, HydrateStaticStateFunction } from '../types/engine.js';
-export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): HydrateStaticStateFunction<TControllerDefinitions>;
+export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): HydrateStaticStateFunction<TControllerDefinitions, SolutionType.recommendation>;

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

@@ -1,3 +1,13 @@
+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, FetchStaticStateFunction } from '../types/engine.js';
-export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): FetchStaticStateFunction<TControllerDefinitions>;
+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[];
+    context: import("../../../commerce.index.js").ContextOptions;
+    searchParams?: import("../../../commerce.index.js").ParameterManagerState<import("../../../commerce.index.js").Parameters>["parameters"];
+    cart?: import("../../../commerce.index.js").CartInitialState;
+    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]>[];
+}>;

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

@@ -1,4 +1,9 @@
+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, FetchStaticStateFunction } from '../types/engine.js';
-export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;
+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> & {
+    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,13 +1,11 @@
 import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
-import type { HasKey, OptionsTuple } from '../../common/types/utilities.js';
+import type { HasKey } from '../../common/types/utilities.js';
 import type { CartInitialState } from '../controllers/cart/headless-cart.ssr.js';
 import type { ContextOptions } from '../controllers/context/headless-context.ssr.js';
 import type { ParameterManagerState, Parameters } from '../controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
 import type { SolutionType } from './controller-constants.js';
-import type { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap, IsRecommendationController } from './controller-definitions.js';
-import type { CommerceEngineDefinitionBuildResult } from './engine.js';
+import type { ControllerDefinitionsMap, IsRecommendationController } from './controller-definitions.js';
 export interface SearchBuildConfig extends CommonBuildConfig {
     searchParams: ParameterManagerState<Parameters & {
         query: string;
@@ -83,7 +81,3 @@ export interface CommonBuildConfig {
     cart?: CartInitialState;
 }
 export type BuildConfig<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = TSolutionType extends SolutionType.search ? SearchBuildConfig : TSolutionType extends SolutionType.listing ? ListingBuildConfig : TSolutionType extends SolutionType.recommendation ? RecommendationBuildConfig<TControllers> : TSolutionType extends SolutionType.standalone ? CommonBuildConfig : never;
-/**
- * @internal
- */
-export type Build<TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildConfig<TControllersDefinitionsMap, TSolutionType> & CommerceEngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<CommerceEngineDefinitionBuildResult<TControllersMap>>;

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

@@ -3,12 +3,12 @@ import type { NavigatorContextProvider } from '../../../app/navigator-context-pr
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { ControllerStaticStateMap, ControllersMap } from '../../common/types/controllers.js';
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
-import type { Build, SSRCommerceEngineOptions } from './build.js';
 import type { SolutionType } from './controller-constants.js';
 import type { BakedInControllers, ControllerDefinitionsMap } from './controller-definitions.js';
 import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './controller-inference.js';
 import type { FetchStaticState } from './fetch-static-state.js';
 import type { HydrateStaticState, HydrateStaticStateOptions } from './hydrate-static-state.js';
+import type { SSRCommerceEngineOptions } from './build.js';
 export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState };
 export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
     searchActions: TSearchAction[];
@@ -60,14 +60,8 @@ export interface CommerceEngineDefinitionBuildResult<TControllers extends Contro
     controllers: TControllers & BakedInControllers;
 }
 export type CommerceControllerDefinitionsMap = ControllerDefinitionsMap<Controller>;
-type Definition<TControllerDefinitions extends CommerceControllerDefinitionsMap> = CommerceEngineDefinition<TControllerDefinitions, SolutionType>;
-export type FetchStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['fetchStaticState'];
-export type HydrateStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['hydrateStaticState'];
-export type BuildParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<Build<InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>, InferControllerPropsMapFromDefinitions<TControllerDefinitions>, TControllerDefinitions, SolutionType>>;
-export type FetchStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<FetchStaticStateFunction<TControllerDefinitions>>;
-export type HydrateStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<HydrateStaticStateFunction<TControllerDefinitions>>;
-type Controllers<TControllerDefinitions extends CommerceControllerDefinitionsMap> = InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>;
-export type BuildResult<TControllerDefinitions extends CommerceControllerDefinitionsMap> = {
-    engine: SSRCommerceEngine;
-    controllers: Controllers<TControllerDefinitions> & BakedInControllers;
-};
+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>>;

package/dist/definitions/ssr-next/commerce/utils/recommendation-filter.d.ts

@@ -20,5 +20,5 @@ export declare function filterRecommendationControllers<TControllerDefinitions e
      * @param controllers - A record of all controllers where the key is the controller name and the value is the controller instance.
      * @param controllerNames - A list of all recommendation controllers to refresh
      */
-    refresh(whitelist?: string[]): void;
+    refresh(whitelist?: Array<keyof TControllerDefinitions>): void;
 };

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

@@ -73,13 +73,18 @@ export const buildFactory = (controllerDefinitions, options) => (solutionType) =
     };
     const engine = buildSSRCommerceEngine(solutionType, engineOptions, enabledRecommendationControllers);
     const controllers = buildControllerDefinitions({
-        definitionsMap: (controllerDefinitions ?? {}),
+        definitionsMap: controllerDefinitions ?? {},
         engine,
         solutionType,
         propsMap: controllerProps,
     });
+    if (buildOptions && 'searchActions' in buildOptions) {
+        buildOptions.searchActions.forEach((action) => {
+            engine.dispatch(action);
+        });
+    }
     return {
         engine,
-        controllers,
+        controllers: controllers,
     };
 };

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

@@ -3,9 +3,6 @@ export function hydratedStaticStateFactory(controllerDefinitions, options) {
     return (solutionType) => async (...params) => {
         const solutionTypeBuild = await buildFactory(controllerDefinitions, options)(solutionType);
         const { engine, controllers } = await solutionTypeBuild(...params);
-        params[0].searchActions.forEach((action) => {
-            engine.dispatch(action);
-        });
         await engine.waitForRequestCompletedAction();
         return { engine, controllers };
     };

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

@@ -3,10 +3,7 @@ import { buildFactory } from './build-factory.js';
 export function hydratedRecommendationStaticStateFactory(controllerDefinitions, options) {
     return async (...params) => {
         const solutionTypeBuild = await buildFactory(controllerDefinitions, options)(SolutionType.recommendation);
-        const { engine, controllers } = (await solutionTypeBuild(...params));
-        params[0].searchActions.forEach((action) => {
-            engine.dispatch(action);
-        });
+        const { engine, controllers } = await solutionTypeBuild(...params);
         await engine.waitForRequestCompletedAction();
         return { engine, controllers };
     };

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

@@ -5,9 +5,9 @@ import { buildFactory } from './build-factory.js';
 export function fetchRecommendationStaticStateFactory(controllerDefinitions, options) {
     return async (...params) => {
         const [props] = params;
-        const allowedRecommendationKeys = props.recommendations;
+        const allowedRecommendationKeys = props?.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({

package/dist/esm/utils/version.js

@@ -1,2 +1,2 @@
-export const VERSION = "3.29.2" || 'Test version';
+export const VERSION = "3.29.3-pre.0951f1103d" || 'Test version';
 export const COVEO_FRAMEWORK = ['@coveo/atomic', '@coveo/quantic'];