@coveo/headless 3.29.1 → 3.29.2-pre.027eeece31

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/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, 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/types/build.d.ts

@@ -1,45 +1,89 @@
-import type { CurrencyCodeISO4217 } from '@coveo/relay-event-types';
 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 { OptionsTuple } from '../../common/types/utilities.js';
+import type { HasKey, OptionsTuple } from '../../common/types/utilities.js';
 import type { CartInitialState } from '../controllers/cart/headless-cart.ssr.js';
-import type { UserLocation } from '../controllers/context/headless-context.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, EngineDefinitionControllersPropsOption } from './controller-definitions.js';
+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'];
 }
-export interface RecommendationBuildConfig extends CommonBuildConfig {
-    recommendations?: [];
-}
 export interface ListingBuildConfig extends CommonBuildConfig {
 }
 export interface StandaloneBuildConfig extends CommonBuildConfig {
 }
 export interface CommonBuildConfig {
-    context: {
-        url: string;
-        language: string;
-        country: string;
-        currency: CurrencyCodeISO4217;
-        location?: UserLocation;
-    };
+    context: ContextOptions;
     searchParams?: ParameterManagerState<Parameters>['parameters'];
     cart?: CartInitialState;
 }
-export type BuildConfig<TSolutionType extends SolutionType> = TSolutionType extends SolutionType.search ? SearchBuildConfig : TSolutionType extends SolutionType.listing ? ListingBuildConfig : TSolutionType extends SolutionType.recommendation ? RecommendationBuildConfig : 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'>;
 };
+/**
+ * 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;
 /**
  * @internal
  */
-export type Build<TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildConfig<TSolutionType> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<CommerceEngineDefinitionBuildResult<TControllersMap>>;
+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

@@ -3,7 +3,7 @@ import type { InvalidControllerDefinition } from '../../common/errors.js';
 import type { ControllersPropsMap } from '../../common/types/controllers.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';
@@ -13,15 +13,6 @@ import type { ListingAndStandaloneController, ListingOnlyController, NonRecommen
 import type { Kind } from './kind.js';
 import type { HasSolutionType } from './utilities.js';
 export type { 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;
-};
 export interface ControllerDefinitionWithoutProps<TController extends Controller> {
     /**
      * Creates an instance of the given controller.
@@ -94,120 +85,14 @@ export type AugmentedControllerDefinition<TControllerDefinitions extends Control
 /**
  * This type defines the required and optional controller props for the engine definition.
  */
-export type EngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = OptionalEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType> & RequiredEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType>;
-/**
- * Represents an optional engine definition for controller properties.
- *
- * This type is used to define a map of optional controller properties based on the provided
- * controller definitions, controller properties map, and solution 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()
- * ```
- */
-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>;
-};
-/**
- * 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).
- *
- * 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: []}},
- *   },
- * })
- * ```
- *
- */
+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 : 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>;
-/**
- * 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
- * };
- * ```
- */
-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];
+    [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/fetch-static-state.d.ts

@@ -10,4 +10,4 @@ import type { EngineStaticState } from './engine.js';
  *
  * 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<TSolutionType> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState & FilteredBakedInControllers<TSolutionType>>>;
+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/utils/controller-wiring.d.ts

@@ -1,8 +1,35 @@
+import { Schema } from '@coveo/bueno';
 import type { ControllersPropsMap } from '../../common/types/controllers.js';
 import type { BuildConfig } from '../types/build.js';
-import type { SolutionType } from '../types/controller-constants.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 function wireControllerParams<TControllerDefinitions extends CommerceControllerDefinitionsMap>(_solutionType: SolutionType, _controllerDefinitions: TControllerDefinitions, _paramsObject: BuildConfig<SolutionType> & {
+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

@@ -2,4 +2,4 @@ import type { CommerceEngineConfiguration } from '../../../app/commerce-engine/c
 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;
+export declare function extendEngineConfiguration<TControllerDefinitions extends CommerceControllerDefinitionsMap>(configuration: CommerceEngineDefinitionOptions<TControllerDefinitions>['configuration'], commonBuildOptions: CommonBuildConfig): CommerceEngineConfiguration;

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

@@ -1,5 +1,18 @@
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
+import type { RecommendationsDefinitionMeta } from '../controllers/recommendations/headless-recommendations.ssr.js';
+import type { ControllerDefinition, ControllerDefinitionsMap } from '../types/controller-definitions.js';
+/**
+ * Type guard to check if a controller definition is a recommendation controller.
+ * A recommendation controller must have both the recommendation flag and a slotId.
+ */
+export declare function isRecommendationDefinition<C extends ControllerDefinition<Controller>>(controllerDefinition: C): controllerDefinition is C & RecommendationsDefinitionMeta;
+/**
+ * Extracts recommendation controller definitions from a controller definitions map.
+ *
+ * @param controllerDefinitions - Map of controller definitions
+ * @returns Object containing only the recommendation controller definitions
+ */
+export declare function getRecommendationDefinitions(controllerDefinitions: ControllerDefinitionsMap<Controller>): Record<string, ControllerDefinition<Controller> & RecommendationsDefinitionMeta>;
 export declare function filterRecommendationControllers<TControllerDefinitions extends ControllerDefinitionsMap<Controller>>(controllers: Record<string, Controller>, controllerDefinitions: TControllerDefinitions): {
     /**
      * Go through all the controllers passed in argument and only refresh recommendation controllers.

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

@@ -3,9 +3,6 @@ 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;
-export type HasOptionalKeys<TObject> = TObject extends {} ? {
-    [K in keyof TObject]-?: {} extends Pick<TObject, K> ? K : never;
-}[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];
 };

package/dist/definitions/test/mock-ssr-controller-definitions.d.ts

@@ -1,6 +1,7 @@
 import type { SearchEngine } from '../app/search-engine/search-engine.js';
 import type { Controller } from '../controllers/controller/headless-controller.js';
 import type { Kind } from '../ssr/commerce/types/kind.js';
+import { recommendationInternalOptionKey } from '../ssr-next/commerce/types/controller-constants.js';
 import type { ControllerDefinitionWithoutProps, ControllerDefinitionWithProps } from '../ssr-next/common/types/controllers.js';
 interface MockController {
     initialState?: Record<string, unknown>;
@@ -35,4 +36,15 @@ export declare function defineMockCommerceControllerWithProps(options?: Solution
     standalone: boolean;
     recommendation: boolean;
 };
+export declare function defineMockRecommendationDefinition(slotId: string): {
+    recommendation: boolean;
+    [recommendationInternalOptionKey]: {
+        slotId: string;
+    };
+    buildWithProps: import("vitest").Mock<(engine: any, props: any) => {
+        state: {};
+        subscribe(listener: () => void): import("redux").Unsubscribe;
+        _kind: Kind;
+    }>;
+};
 export {};

package/dist/esm/ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.js

@@ -17,7 +17,7 @@ export function defineRecommendations(props) {
         buildWithProps: (engine, options) => {
             const staticOptions = props.options;
             const controller = buildRecommendations(engine, {
-                options: { ...staticOptions, ...options },
+                options: { ...staticOptions, ...options.initialState },
             });
             return createControllerWithKind(controller, Kind.Recommendations);
         },

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

@@ -57,21 +57,16 @@ function buildSSRCommerceEngine(solutionType, options, recommendationCount) {
         },
     };
 }
-function fetchActiveRecommendationControllers(controllerProps, solutionType) {
-    return solutionType === SolutionType.recommendation
-        ? Object.values(controllerProps).filter((controller) => controller &&
-            typeof controller === 'object' &&
-            'enabled' in controller &&
-            controller.enabled).length
-        : 0;
-}
 export const buildFactory = (controllerDefinitions, options) => (solutionType) => async (...[buildOptions]) => {
     const controllerProps = wireControllerParams(solutionType, controllerDefinitions, buildOptions); // TODO: KIT-4754: remove non-null assertion operator
     const logger = buildLogger(options.loggerOptions);
     if (!options.navigatorContextProvider) {
         logger.warn('[WARNING] Missing navigator context in server-side code. Make sure to set it with `setNavigatorContextProvider` before calling fetchStaticState()');
     }
-    const enabledRecommendationControllers = fetchActiveRecommendationControllers(controllerProps, solutionType);
+    const enabledRecommendationControllers = buildOptions && 'recommendations' in buildOptions // TODO: KIT-4754: remove non-null assertion
+        ? buildOptions
+            ?.recommendations.length
+        : 0;
     const engineOptions = {
         ...options,
         configuration: extendEngineConfiguration(options.configuration, buildOptions), // TODO: KIT-4754: remove non-null assertion operator

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

@@ -2,9 +2,7 @@ import { buildFactory, } from './build-factory.js';
 export function hydratedStaticStateFactory(controllerDefinitions, options) {
     return (solutionType) => async (...params) => {
         const solutionTypeBuild = await buildFactory(controllerDefinitions, options)(solutionType);
-        const { engine, controllers } = await solutionTypeBuild(
-        // @ts-expect-error: TODO: KIT-4742: the wiring will fix also the type inconsistencies
-        ...params);
+        const { engine, controllers } = await solutionTypeBuild(...params);
         params[0].searchActions.forEach((action) => {
             engine.dispatch(action);
         });

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

@@ -3,9 +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(
-        // @ts-expect-error: TODO: KIT-4742: the wiring will fix also the type inconsistencies
-        ...params));
+        const { engine, controllers } = (await solutionTypeBuild(...params));
         params[0].searchActions.forEach((action) => {
             engine.dispatch(action);
         });

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

@@ -1,26 +1,22 @@
-import { filterObject } from '../../../utils/utils.js';
 import { createStaticState } from '../controller-utils.js';
 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) {
-    const getAllowedRecommendationKeys = (props) => {
-        if (props && 'controllers' in props) {
-            const enabledRecommendationControllers = filterObject(props.controllers, (value) => Boolean(value.enabled));
-            return Object.keys(enabledRecommendationControllers);
-        }
-        return [];
-    };
     return async (...params) => {
         const [props] = params;
-        const allowedRecommendationKeys = getAllowedRecommendationKeys(props);
+        const allowedRecommendationKeys = props.recommendations;
         const solutionTypeBuild = await buildFactory(controllerDefinitions, options)(SolutionType.recommendation);
         const { engine, controllers } = (await solutionTypeBuild(...params));
         filterRecommendationControllers(controllers, controllerDefinitions ?? {}).refresh(allowedRecommendationKeys);
         const searchActions = await Promise.all(engine.waitForRequestCompletedAction());
-        return createStaticState({
+        const staticState = createStaticState({
             searchActions,
             controllers,
         });
+        return {
+            ...params[0], // TODO: KIT-4754: remove index access after no longer relying on OptionTuple type
+            ...staticState,
+        };
     };
 }

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

@@ -27,6 +27,9 @@ export function fetchStaticStateFactory(controllerDefinitions, options) {
             searchActions,
             controllers,
         });
-        return staticState;
+        return {
+            ...params[0], // TODO: KIT-4754: remove index access after no longer relying on OptionTuple type
+            ...staticState,
+        };
     };
 }