@coveo/headless 3.29.0-pre.032a5300a8 → 3.29.0-pre.075377ce6d

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.29.0-pre.032a5300a8";
+var VERSION = "3.29.0-pre.075377ce6d";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/api/analytics/analytics-selectors.ts

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

@@ -5,6 +5,10 @@ import type { SolutionType } from './controller-constants.js';
 import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
 import type { EngineStaticState } from './engine.js';
 import type { FromBuildResult } from './from-build-result.js';
+/**
+ * @deprecated This interface will be remove on the next major version.
+ * Use BuildConfig interface instead
+ */
 export type FetchStaticStateOptions = {};
 export type FetchStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
     /**

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

@@ -3,6 +3,9 @@ import type { ControllersMap, ControllersPropsMap } from './controllers.js';
 import type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './engine.js';
 import type { OptionsExtender, OptionsTuple } from './utilities.js';
 interface BuildOptions<TEngineOptions> {
+    /**
+     * @deprecated This option will be removed in the next major version.
+     */
     extend?: OptionsExtender<TEngineOptions>;
 }
 export type Build<TEngine extends CoreEngine | CoreEngineNext, TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<EngineDefinitionBuildResult<TEngine, TControllersMap>>;

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

@@ -38,6 +38,9 @@ export interface EngineDefinition<TEngine extends CoreEngine | CoreEngineNext, T
      */
     build: Build<TEngine, TEngineOptions, InferControllersMapFromDefinition<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>;
 }
+/**
+ * @deprecated Use SearchEngineDefinitionBuildResult or CommerceEngineDefinitionBuildResult instead
+ */
 export interface EngineDefinitionBuildResult<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> {
     engine: TEngine;
     controllers: TControllers;

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

@@ -68,7 +68,6 @@
  */
 export type { Relay } from '@coveo/relay';
 export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
-export type { CommerceEngineOptions } from './app/commerce-engine/commerce-engine.js';
 export type { CommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
 export { getSampleCommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
 export type { CoreEngineNext, ExternalEngineOptions } from './app/engine.js';
@@ -119,10 +118,11 @@ export type { RedirectionTrigger, RedirectionTriggerDefinition, RedirectionTrigg
 export { defineRedirectionTrigger } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
 export { defineCommerceEngine } from './ssr-next/commerce/engine/commerce-engine.ssr.js';
 export type { CommerceEngineDefinitionOptions, SSRCommerceEngine as CommerceEngine, } from './ssr-next/commerce/factories/build-factory.js';
+export type { BuildConfig, SSRCommerceEngineOptions, } from './ssr-next/commerce/types/build.js';
 export { SolutionType } from './ssr-next/commerce/types/controller-constants.js';
-export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
+export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } 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, EngineStaticState, FetchStaticState, FetchStaticStateOptions, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
+export type { CommerceEngineDefinition, CommerceEngineDefinitionBuildResult, EngineStaticState, FetchStaticState, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
 export { Kind } from './ssr-next/commerce/types/kind.js';
 export type { CommerceAppState, CommerceProductListingParametersState, CommerceSearchParametersState, } from './state/commerce-app-state.js';
 export * from './features/commerce/configuration/configuration-actions-loader.js';

package/dist/definitions/ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.d.ts

@@ -1,11 +1,13 @@
-import { type Recommendations, type RecommendationsOptions, type RecommendationsProps, type RecommendationsState } from '../../../../controllers/commerce/recommendations/headless-recommendations.js';
+import { type Recommendations, type RecommendationsOptions, type RecommendationsState } from '../../../../controllers/commerce/recommendations/headless-recommendations.js';
 import { recommendationInternalOptionKey } from '../../types/controller-constants.js';
 import type { RecommendationOnlyControllerDefinitionWithProps } from '../../types/controller-definitions.js';
 export type { Recommendations, RecommendationsState };
 export type RecommendationsDefinitionMeta = {
-    [recommendationInternalOptionKey]: {} & RecommendationsProps['options'];
+    [recommendationInternalOptionKey]: {} & RecommendationsOptions;
 };
-export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithProps<Recommendations, Partial<RecommendationsOptions>> {
+export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithProps<Recommendations, {
+    initialState: Partial<RecommendationsOptions>;
+}> {
 }
 /**
  * Defines a `Recommendations` controller instance.
@@ -14,4 +16,6 @@ export interface RecommendationsDefinition extends RecommendationOnlyControllerD
  * @param props - The configurable `Recommendations` properties.
  * @returns The `Recommendations` controller definition.
  * */
-export declare function defineRecommendations(props: RecommendationsProps): RecommendationsDefinition & RecommendationsDefinitionMeta;
+export declare function defineRecommendations(props: {
+    options: Omit<RecommendationsOptions, 'productId'>;
+}): RecommendationsDefinition & RecommendationsDefinitionMeta;

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

@@ -1,6 +1,7 @@
 import type { Action } from '@reduxjs/toolkit';
-import { type CommerceEngine, type CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
+import { type CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
+import type { SSRCommerceEngineOptions } from '../types/build.js';
 import { SolutionType } from '../types/controller-constants.js';
 import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
 import type { BuildParameters, CommerceControllerDefinitionsMap, EngineDefinitionOptions } from '../types/engine.js';
@@ -15,8 +16,8 @@ export interface SSRCommerceEngine extends CommerceEngine {
      */
     waitForRequestCompletedAction(): Promise<Action>[];
 }
-export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<CommerceEngineOptions, TControllers>;
-export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <T extends SolutionType>(solutionType: T) => (...[buildOptions]: BuildParameters<TControllerDefinitions>) => Promise<{
+export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<SSRCommerceEngineOptions, TControllers>;
+export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <T extends SolutionType>(solutionType: T) => (...[buildOptions]: BuildParameters<TControllerDefinitions>) => Promise<{
     engine: SSRCommerceEngine;
     controllers: import("../types/controller-inference.js").InferControllersMapFromDefinition<TControllerDefinitions, T>;
 }>;

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

@@ -1,4 +1,5 @@
 import type { SolutionType } from '../types/controller-constants.js';
+import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
 import type { CommerceControllerDefinitionsMap, HydrateStaticStateFunction } from '../types/engine.js';
 import { type CommerceEngineDefinitionOptions } from './build-factory.js';
-export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;
+export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;

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

@@ -1,3 +1,3 @@
 import type { CommerceControllerDefinitionsMap, HydrateStaticStateFunction } from '../types/engine.js';
 import { type CommerceEngineDefinitionOptions } from './build-factory.js';
-export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): HydrateStaticStateFunction<TControllerDefinitions>;
+export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): HydrateStaticStateFunction<TControllerDefinitions>;

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

@@ -1,3 +1,4 @@
+import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
 import type { CommerceControllerDefinitionsMap, FetchStaticStateFunction } from '../types/engine.js';
 import { type CommerceEngineDefinitionOptions } from './build-factory.js';
-export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): FetchStaticStateFunction<TControllerDefinitions>;
+export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): FetchStaticStateFunction<TControllerDefinitions>;

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

@@ -1,4 +1,5 @@
 import { SolutionType } from '../types/controller-constants.js';
+import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
 import type { CommerceControllerDefinitionsMap, FetchStaticStateFunction } from '../types/engine.js';
 import { type CommerceEngineDefinitionOptions } from './build-factory.js';
-export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;
+export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;

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

@@ -1,14 +1,80 @@
+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 { OptionsExtender, OptionsTuple } from '../../common/types/utilities.js';
-import type { SSRCommerceEngine } from '../factories/build-factory.js';
+import type { HasKey, OptionsTuple } 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 { ControllerDefinitionsMap, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './controller-definitions.js';
-interface BuildOptions<TEngineOptions> {
-    extend?: OptionsExtender<TEngineOptions>;
+import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, IsRecommendationController } from './controller-definitions.js';
+import type { CommerceEngineDefinitionBuildResult } from './engine.js';
+export interface SearchBuildConfig extends CommonBuildConfig {
+    searchParams: ParameterManagerState<Parameters & {
+        query: string;
+    }>['parameters'];
 }
+/**
+ * The `RecommendationBuildConfig` type defines the shape of the configuration object required when fetching static state for recommendations.
+ *
+ * The `recommendations` property is a string array containing the names of the recommendation controllers
+ * that were defined in your engine definition. This allows you to specify which recommendation controllers
+ * should be included in the SSR request.
+ *
+ * For example, on a storefront homepage, it might make sense to display a carousel of popular products.
+ * However, showing recommendations based on items frequently bought together may not be relevant in that context and should not be retrieved unnecessarily.
+ *
+ * @example
+ * Given the following engine definition:
+ *
+ * ```ts
+ * const {recommendationEngineDefinition} = defineCommerceEngine({
+ *   controllers: {
+ *     popularProducts: defineRecommendations({options: {slotId: '...'}}),
+ *     frequentlyBought: defineRecommendations({options: {slotId: '...'}}),
+ *     // ...other controllers
+ *   },
+ * });
+ *
+ * // When fetching static state for recommendations:
+ * const staticState = await recommendationEngineDefinition.fetchStaticState({
+ *   recommendations: ['popularProducts'],
+ *   // ...other config
+ * });
+ * ```
+ *
+ * In this example, only the `popularProducts` recommendation controller will be included in the SSR request.
+ */
+export type RecommendationBuildConfig<TControllers extends ControllerDefinitionsMap<Controller>> = CommonBuildConfig & {
+    /**
+     * The unique identifier of the product to use for seeded recommendations.
+     */
+    productId?: string;
+    /**
+     * An array of recommendation controller names from your engine definition to include in the SSR request.
+     * Each name corresponds to a key used when defining recommendation controllers in your engine definition.
+     * If not specified, no recommendation requests will be executed.
+     */
+    recommendations: Array<Extract<keyof TControllers, {
+        [K in keyof TControllers]: HasKey<TControllers[K], SolutionType.recommendation> extends never ? never : IsRecommendationController<TControllers[K]> extends never ? never : K;
+    }[keyof TControllers]>>;
+};
+export interface ListingBuildConfig extends CommonBuildConfig {
+}
+export interface StandaloneBuildConfig extends CommonBuildConfig {
+}
+export interface CommonBuildConfig {
+    context: ContextOptions;
+    searchParams?: ParameterManagerState<Parameters>['parameters'];
+    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;
+/**
+ * Commerce engine options for SSR scenarios where context is defined when fetching static state.
+ */
+export type SSRCommerceEngineOptions = Omit<CommerceEngineOptions, 'configuration'> & {
+    configuration: Omit<CommerceEngineOptions['configuration'], 'context'>;
+};
 /**
  * @internal
  */
-export type Build<TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineDefinitionBuildResult<SSRCommerceEngine, TControllersMap>>;
-export {};
+export type Build<TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildConfig<TControllersDefinitionsMap, TSolutionType> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<CommerceEngineDefinitionBuildResult<TControllersMap>>;

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

@@ -1,24 +1,18 @@
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { InvalidControllerDefinition } from '../../common/errors.js';
 import type { ControllersPropsMap } from '../../common/types/controllers.js';
-import type { EngineDefinitionBuildResult } from '../../common/types/engine.js';
 import type { HydratedState } from '../../common/types/hydrate-static-state.js';
 import type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers } from '../../common/types/inference.js';
-import type { HasKey, HasOptionalKeys, HasRequiredKeys, OptionsTuple } from '../../common/types/utilities.js';
+import type { HasKey, HasRequiredKeys, OptionsTuple } 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';
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
 import { type recommendationInternalOptionKey, SolutionType } from './controller-constants.js';
 import type { ListingAndStandaloneController, ListingOnlyController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
 import type { Kind } from './kind.js';
-export type { EngineDefinitionBuildResult, HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
-export type RecommendationControllerSettings = {
-    /**
-     * Toggle to enable or disable the recommendation controller.
-     * When set to `true`, the controller will perform a recommendation request server-side.
-     *
-     * @default false
-     */
-    enabled?: boolean;
-};
+import type { HasSolutionType } from './utilities.js';
+export type { HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
 export interface ControllerDefinitionWithoutProps<TController extends Controller> {
     /**
      * Creates an instance of the given controller.
@@ -53,123 +47,52 @@ export type ControllerDefinition<TController extends Controller> = SolutionTypeA
 export interface ControllerDefinitionsMap<TController extends Controller> {
     [customName: string]: ControllerDefinition<TController>;
 }
+type BakedInControllerDefinitions = {
+    parameterManager: ParameterManagerDefinition<{
+        listing: true;
+        search: true;
+    }>;
+    context: ContextDefinition;
+    cart: CartDefinition;
+};
 /**
- * This type defines the required and optional controller props for the engine definition.
+ * Map of baked-in controllers
  */
-export type EngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = OptionalEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType> & RequiredEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType>;
+export type BakedInControllers = {
+    [K in keyof BakedInControllerDefinitions]: BakedInControllerDefinitions[K]['buildWithProps'];
+};
 /**
- * Represents an optional engine definition for controller properties.
+ * A dynamically filtered map of baked-in controller definitions based on solution type compatibility.
  *
- * This type is used to define a map of optional controller properties based on the provided
- * controller definitions, controller properties map, and solution type.
+ * This type automatically includes only the baked-in controllers that are available for the specified
+ * solution type by checking each controller's `SolutionTypeAvailability` configuration. Controllers
+ * that don't support the given solution type are excluded from the resulting type.
  *
- * @template TControllers - A map of controller definitions.
- * @template TControllersPropsMap - A map of controller properties.
- * @template TSolutionType - The type of solution.
- *
- * The type iterates over the controller keys (defined in the engine definition) and includes only those keys where:
- * 1. The controller can be used for a specific solution type (HasKey<TControllers[K], TSolutionType> is not 'never').
- * 2. The controller properties have optional options (HasOptionalKeys<ConditionalControllerProps<...>> is true).
- *
- * @example
- * Given the following controller definitions:
- * ```
- * const {recommendationEngineDefinition} = defineCommerceEngine({
- *  controllers: {
- *    popularViewed: defineRecommendations({
- *      options: {slotId: 'slot-id'}
- *    })
- *  }
- * });
- * ```
- *
- * The following code will not throw an error since the 'popularViewed' controller props are optional
- * ```
- * recommendationEngineDefinition.fetchStaticState({
- *  controllers: {
- *    popularViewed: {enabled: true, productId: 'some-product-id'} // This is optional
- *  }
- * })
- * ```
- *
- * The following code (with no arguments) is also valid because the 'popularViewed' controller props are optional, and there are no other required controller props in the engine definition.
- * ```
- * recommendationEngineDefinition.fetchStaticState()
- * ```
+ * @template TSolutionType - The target solution type to filter controllers for
  */
-type OptionalEngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = {
-    [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : HasOptionalKeys<ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>> extends false ? never : 'controllers']?: ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>;
+export type FilteredBakedInControllers<TSolutionType extends SolutionType> = {
+    [K in keyof BakedInControllers as HasSolutionType<BakedInControllerDefinitions[K], TSolutionType> extends true ? K : never]: BakedInControllers[K];
 };
 /**
- * Represents a type that defines the required controller properties for engine definition controllers.
- *
- * @template TControllers - A map of controller definitions.
- * @template TControllersPropsMap - A map of controller properties.
- * @template TSolutionType - The type of solution being used.
- *
- * The type iterates over the controller keys (defined in the engine definition) and includes only those keys where:
- * 1. The controller can be used for a specific solution type (HasKey<TControllers[K], TSolutionType> is not 'never').
- * 2. The controller properties have required options (HasRequiredKeys<ConditionalControllerProps<...>> is true).
+ * Map of controller definitions available to the commerce engine definition.
  *
- * The resulting type maps the valid keys to their corresponding conditional controller properties.
- *
- * @example
- * Given the following controller definitions:
- * ```
- * const {standaloneEngineDefinition} = defineCommerceEngine({
- *  controllers: {cart: defineCart()},
- * });
- * ```
- *
- * The following code will not throw an error since the 'cart' controller props are required for the standalone engine definition:
- * ```
- * standaloneEngineDefinition.fetchStaticState({
- *   controllers: {
- *     cart: {initialState: {items: []}},
- *   },
- * })
- * ```
+ * This type combines user-defined controllers with the system's baked-in controllers
+ * (parameterManager, context, and cart).
  *
+ * @template TControllerDefinitions - The controller definitions map
  */
-type RequiredEngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = {
-    [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : HasRequiredKeys<ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>> extends false ? never : 'controllers']: ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>;
-};
-type IsRecommendationController<TController extends ControllerDefinition<Controller>> = HasKey<TController, typeof recommendationInternalOptionKey>;
+export type AugmentedControllerDefinition<TControllerDefinitions extends ControllerDefinitionsMap<Controller>> = TControllerDefinitions & BakedInControllerDefinitions;
 /**
- * This type ensures that recommendation controller props are optional, while other controller props remain required.
- *
- * It works by checking if the controller definition includes the `recommendationInternalOptionKey`.
- *
- * - If the key is present, the controller props are made optional.
- * - If the key is absent, the controller props are required.
- *
- * Example:
- *
- * ```typescript
- * type ControllerProps = InferControllerPropsFromDefinition<{
- *   recommendation: defineRecommendation({}),
- *   cart: defineCart(),
- * }>;
- *
- * // In this example:
- * // - The `recommendation` controller props are optional.
- * // - The `cart` controller props are required.
- *
- * const props: ControllerProps = {
- *   cart: {initialState: {items: []}},
- *   // recommendation props can be omitted
- * };
- * ```
+ * This type defines the required and optional controller props for the engine definition.
  */
-type RecommendationControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, K extends keyof TControllers> = {
-    [I in keyof TControllersPropsMap as I extends K ? IsRecommendationController<TControllers[I]> extends never ? never : I : never]?: TControllersPropsMap[I];
-} & {
-    [I in keyof TControllersPropsMap as I extends K ? IsRecommendationController<TControllers[I]> extends never ? I : never : never]: TControllersPropsMap[I];
+export type EngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = RequiredEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType>;
+type RequiredEngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = {
+    [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : IsRecommendationController<TControllers[K]> extends never ? HasRequiredKeys<DefaultControllerProps<TControllers, TControllersPropsMap, K>> extends false ? never : 'controllers' : never]: DefaultControllerProps<TControllers, TControllersPropsMap, K>;
 };
+export type IsRecommendationController<TController extends ControllerDefinition<Controller>> = HasKey<TController, typeof recommendationInternalOptionKey>;
 type DefaultControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, K extends keyof TControllers> = {
     [I in keyof TControllersPropsMap as I extends K ? I : never]: TControllersPropsMap[I];
 };
-type ConditionalControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType, K extends keyof TControllers> = TSolutionType extends SolutionType.recommendation ? RecommendationControllerProps<TControllers, TControllersPropsMap, K> : DefaultControllerProps<TControllers, TControllersPropsMap, K>;
 export interface ControllerDefinitionOption {
     /**
      * Whether the controller will be used in a product listing context.

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

@@ -1,14 +1,14 @@
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { HasKey, HasKeys } from '../../common/types/utilities.js';
-import type { recommendationInternalOptionKey, SolutionType } from './controller-constants.js';
-import type { ControllerDefinition, ControllerDefinitionsMap, ControllerDefinitionWithoutProps, ControllerDefinitionWithProps, InferControllerStaticStateFromController, RecommendationControllerSettings } from './controller-definitions.js';
+import type { SolutionType } from './controller-constants.js';
+import type { ControllerDefinition, ControllerDefinitionsMap, ControllerDefinitionWithoutProps, ControllerDefinitionWithProps, InferControllerStaticStateFromController } from './controller-definitions.js';
 export type InferStaticState<T extends {
     fetchStaticState(...args: unknown[]): Promise<unknown>;
 }> = Awaited<ReturnType<T['fetchStaticState']>>;
 export type InferHydratedState<T extends {
     hydrateStaticState(...args: unknown[]): Promise<unknown>;
 }> = Awaited<ReturnType<T['hydrateStaticState']>>;
-type InferControllerPropsFromDefinition<TController extends ControllerDefinition<Controller>> = TController extends ControllerDefinitionWithProps<Controller, infer Props> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? Props : Props & RecommendationControllerSettings : TController extends ControllerDefinitionWithoutProps<Controller> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? {} : RecommendationControllerSettings : unknown;
+type InferControllerPropsFromDefinition<TController extends ControllerDefinition<Controller>> = TController extends ControllerDefinitionWithProps<Controller, infer Props> ? Props : TController extends ControllerDefinitionWithoutProps<Controller> ? {} : unknown;
 export type InferControllerPropsMapFromDefinitions<TControllers extends ControllerDefinitionsMap<Controller>> = {
     [K in keyof TControllers as HasKeys<InferControllerPropsFromDefinition<TControllers[K]>> extends false ? never : K]: InferControllerPropsFromDefinition<TControllers[K]>;
 };

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

@@ -1,28 +1,31 @@
 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 { ControllerStaticStateMap, ControllersMap } from '../../common/types/controllers.js';
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
 import type { Build } from './build.js';
 import type { SolutionType } from './controller-constants.js';
-import type { ControllerDefinitionsMap } from './controller-definitions.js';
+import type { BakedInControllers, ControllerDefinitionsMap } from './controller-definitions.js';
 import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './controller-inference.js';
-import type { FetchStaticState, FetchStaticStateOptions } from './fetch-static-state.js';
+import type { FetchStaticState } from './fetch-static-state.js';
 import type { HydrateStaticState, HydrateStaticStateOptions } from './hydrate-static-state.js';
-export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, FetchStaticStateOptions, };
+export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState };
 export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
     searchActions: TSearchAction[];
     controllers: TControllers;
 }
+type ReservedControllerNames = 'context' | 'parameterManager' | 'cart';
+type ValidateControllerNames<T extends ControllerDefinitionsMap<Controller>> = {
+    [K in keyof T]: K extends ReservedControllerNames ? `ERROR: Controller name "${K & string}" is reserved and cannot be used. Reserved names are: context, parameterManager, cart. Please choose a different controller name.` : T[K];
+};
 export type EngineDefinitionOptions<TOptions extends {
     configuration: EngineConfiguration;
 }, TControllers extends ControllerDefinitionsMap<Controller>> = TOptions & {
     /**
      * The controllers to initialize with the commerce engine.
      */
-    controllers?: TControllers;
+    controllers?: ValidateControllerNames<TControllers>;
 };
 export interface CommerceEngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> {
     /**
@@ -50,15 +53,19 @@ export interface CommerceEngineDefinition<TControllers extends ControllerDefinit
      */
     setAccessToken: (accessToken: string) => void;
 }
+export interface CommerceEngineDefinitionBuildResult<TControllers extends ControllersMap> {
+    engine: SSRCommerceEngine;
+    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<CommerceEngineOptions, InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>, InferControllerPropsMapFromDefinitions<TControllerDefinitions>, TControllerDefinitions, SolutionType>>;
+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>;
+    controllers: Controllers<TControllerDefinitions> & BakedInControllers;
 };

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

@@ -1,13 +1,13 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { ControllerStaticStateMap, ControllersPropsMap } from '../../common/types/controllers.js';
+import type { BuildConfig } from './build.js';
 import type { SolutionType } from './controller-constants.js';
-import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
+import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, FilteredBakedInControllers, OptionsTuple } from './controller-definitions.js';
 import type { EngineStaticState } from './engine.js';
-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.
  *
  * 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<FetchStaticStateOptions & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
+export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildConfig<TControllersDefinitionsMap, TSolutionType> & EngineDefinitionControllersPropsOption<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,6 +3,7 @@ import type { Controller } from '../../../controllers/controller/headless-contro
 import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
 import type { HydratedState } from '../../common/types/hydrate-static-state.js';
 import type { SSRCommerceEngine } from '../factories/build-factory.js';
+import type { BuildConfig } from './build.js';
 import type { SolutionType } from './controller-constants.js';
 import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
 export interface HydrateStaticStateOptions<TSearchAction> {
@@ -13,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> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<HydratedState<SSRCommerceEngine, TControllers>>;
+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> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<HydratedState<SSRCommerceEngine, TControllers>>;

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

@@ -0,0 +1,6 @@
+import type { SolutionType } from './controller-constants.js';
+export type HasSolutionType<TDefinition, TSolutionType extends SolutionType> = TDefinition extends {
+    [K in TSolutionType]: true;
+} ? true : TDefinition extends {
+    [K in TSolutionType]: false;
+} ? false : false;

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

@@ -0,0 +1,35 @@
+import { Schema } from '@coveo/bueno';
+import type { ControllersPropsMap } from '../../common/types/controllers.js';
+import type { BuildConfig } from '../types/build.js';
+import { SolutionType } from '../types/controller-constants.js';
+import type { InferControllerPropsMapFromDefinitions } from '../types/controller-inference.js';
+import type { CommerceControllerDefinitionsMap } from '../types/engine.js';
+export declare const listingDefinitionSchema: Schema<{
+    searchParams: unknown;
+    context: unknown;
+}>;
+export declare const searchDefinitionSchema: Schema<{
+    searchParams: unknown;
+    context: unknown;
+}>;
+export declare const standaloneDefinitionSchema: Schema<{
+    context: unknown;
+}>;
+export declare const recommendationsDefinitionSchema: (recommendationName: string[]) => Schema<{
+    recommendations: import("@coveo/bueno").PrimitivesValues[] | null | undefined;
+    productId: string;
+    context: unknown;
+}>;
+/**
+ * Converts simple user configuration (URL, language, currency, query) into the
+ * nested structure required by the internal {@link Build} method. Automatically generates
+ * appropriate controllers (context, cart, parameterManager) transparently.
+ *
+ * @param solutionType - The type of solution (search, listing, recommendation, standalone)
+ * @param controllerDefinitions - Map of controller definitions to be initialized
+ * @param buildConfig - Simple configuration object with simplified controller properties
+ * @returns Formatted and validated controller properties map defined for the controller in the definition
+ */
+export declare function wireControllerParams<TControllerDefinitions extends CommerceControllerDefinitionsMap>(solutionType: SolutionType, controllerDefinitions: TControllerDefinitions, buildConfig: BuildConfig<TControllerDefinitions, SolutionType> & {
+    controllers?: ControllersPropsMap;
+}): InferControllerPropsMapFromDefinitions<TControllerDefinitions>;

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

@@ -0,0 +1,5 @@
+import type { CommerceEngineConfiguration } from '../../../app/commerce-engine/commerce-engine.js';
+import type { CommerceEngineDefinitionOptions } from '../factories/build-factory.js';
+import type { CommonBuildConfig } from '../types/build.js';
+import type { CommerceControllerDefinitionsMap } from '../types/engine.js';
+export declare function extendEngineConfiguration<TControllerDefinitions extends CommerceControllerDefinitionsMap>(configuration: CommerceEngineDefinitionOptions<TControllerDefinitions>['configuration'], commonBuildOptions: CommonBuildConfig): CommerceEngineConfiguration;