@coveo/headless 3.29.2-pre.326946f8df → 3.29.2-pre.34abdcbabf

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,34 +57,35 @@ 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
     };
     const engine = buildSSRCommerceEngine(solutionType, engineOptions, enabledRecommendationControllers);
     const controllers = buildControllerDefinitions({
-        definitionsMap: (controllerDefinitions ?? {}),
+        definitionsMap: controllerDefinitions ?? {},
         engine,
         solutionType,
         propsMap: controllerProps,
     });
+    // If searchActions are provided (hydrate scenario), dispatch them
+    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

@@ -1,22 +1,13 @@
-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) {
-    // TODO: KIT-4619: no longer the right way to get the allowed recommendation keys
-    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));
+        const { engine, controllers } = await solutionTypeBuild(...params);
         filterRecommendationControllers(controllers, controllerDefinitions ?? {}).refresh(allowedRecommendationKeys);
         const searchActions = await Promise.all(engine.waitForRequestCompletedAction());
         const staticState = createStaticState({

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

@@ -1,13 +1,9 @@
-/**
- * Controller Wiring Utilities
- *
- * Transforms simple user configuration into complex internal controller structures.
- */
-import { RecordValue, Schema } from '@coveo/bueno';
+import { ArrayValue, RecordValue, Schema, StringValue } from '@coveo/bueno';
 import { contextDefinition } from '../../../features/commerce/context/context-validation.js';
 import { parametersDefinition } from '../../../features/commerce/parameters/parameters-schema.js';
-import { requiredEmptyAllowedString } from '../../../utils/validate-payload.js';
+import { nonEmptyString, requiredEmptyAllowedString, } from '../../../utils/validate-payload.js';
 import { SolutionType } from '../types/controller-constants.js';
+import { getRecommendationDefinitions, isRecommendationDefinition, } from './recommendation-filter.js';
 const requiredDefinition = {
     context: new RecordValue({
         options: { required: true },
@@ -30,23 +26,31 @@ const searchDefinition = {
         values: { query: requiredEmptyAllowedString, ...parametersDefinition },
     }),
 };
-const recommendationsDefinition = {
+const recommendationsDefinition = (recommendationName) => ({
     ...requiredDefinition,
-    // recommendation:  // TODO: KIT-4619: support array of recommendations
-};
+    recommendations: new ArrayValue({
+        each: new StringValue({
+            required: true,
+            constrainTo: recommendationName,
+            emptyAllowed: false,
+        }),
+        required: true,
+    }),
+    productId: nonEmptyString,
+});
 export const listingDefinitionSchema = new Schema(listingDefinition);
 export const searchDefinitionSchema = new Schema(searchDefinition);
 export const standaloneDefinitionSchema = new Schema(standaloneDefinition);
-export const recommendationsDefinitionSchema = new Schema(recommendationsDefinition);
+export const recommendationsDefinitionSchema = (recommendationName) => new Schema(recommendationsDefinition(recommendationName));
 /**
  * Validates the build configuration based on the solution type.
  */
-function validateBuildConfig(solutionType, buildConfig) {
+function validateBuildConfig(solutionType, controllerDefinitions, buildConfig) {
     const validationMap = {
         [SolutionType.listing]: listingDefinitionSchema,
         [SolutionType.search]: searchDefinitionSchema,
         [SolutionType.standalone]: standaloneDefinitionSchema,
-        [SolutionType.recommendation]: recommendationsDefinitionSchema,
+        [SolutionType.recommendation]: recommendationsDefinitionSchema(Object.keys(getRecommendationDefinitions(controllerDefinitions))),
     };
     const schema = validationMap[solutionType];
     schema.validate(buildConfig);
@@ -95,7 +99,20 @@ class ControllerWirer {
         };
     }
     wireRecommendations() {
-        // TODO: KIT-4619: wire recommendations
+        if (!('recommendations' in this.buildConfig)) {
+            return;
+        }
+        for (const recController in this.controllerDefinitions) {
+            if (isRecommendationDefinition(this.controllerDefinitions[recController])) {
+                this.controllerProps[recController] = {
+                    initialState: {
+                        ...('productId' in this.buildConfig && {
+                            productId: this.buildConfig.productId,
+                        }),
+                    },
+                };
+            }
+        }
     }
     /**
      * Wires all controllers based on solution type and controller definitions.
@@ -138,7 +155,7 @@ class ControllerWirer {
  * @returns Formatted and validated controller properties map defined for the controller in the definition
  */
 export function wireControllerParams(solutionType, controllerDefinitions, buildConfig) {
-    validateBuildConfig(solutionType, buildConfig);
+    validateBuildConfig(solutionType, controllerDefinitions, buildConfig);
     const controllerProps = buildConfig.controllers ?? {};
     new ControllerWirer(buildConfig, controllerDefinitions, controllerProps).wire(solutionType);
     return controllerProps;

package/dist/esm/ssr-next/commerce/utils/recommendation-filter.js

@@ -1,15 +1,34 @@
 import { MultipleRecommendationError } from '../../common/errors.js';
 import { recommendationInternalOptionKey } from '../types/controller-constants.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 function isRecommendationDefinition(controllerDefinition) {
+    const hasRecommendationFlag = 'recommendation' in controllerDefinition &&
+        controllerDefinition.recommendation === true;
+    const hasValidSlotId = recommendationInternalOptionKey in controllerDefinition &&
+        'slotId' in
+            controllerDefinition[recommendationInternalOptionKey];
+    return hasRecommendationFlag && hasValidSlotId;
+}
+/**
+ * Extracts recommendation controller definitions from a controller definitions map.
+ *
+ * @param controllerDefinitions - Map of controller definitions
+ * @returns Object containing only the recommendation controller definitions
+ */
+export function getRecommendationDefinitions(controllerDefinitions) {
+    const recommendationMap = {};
+    for (const [name, definition] of Object.entries(controllerDefinitions)) {
+        if (isRecommendationDefinition(definition)) {
+            recommendationMap[name] = definition;
+        }
+    }
+    return recommendationMap;
+}
 export function filterRecommendationControllers(controllers, controllerDefinitions) {
     const slotIdSet = new Set();
-    const isRecommendationDefinition = (controllerDefinition) => {
-        const isControllerRecommendation = 'recommendation' in controllerDefinition &&
-            controllerDefinition.recommendation === true;
-        const hasSlotId = recommendationInternalOptionKey in controllerDefinition &&
-            'slotId' in
-                controllerDefinition[recommendationInternalOptionKey];
-        return isControllerRecommendation && hasSlotId;
-    };
     const ensureSingleRecommendationPerSlot = (slotId) => {
         throw new MultipleRecommendationError(slotId);
     };

package/dist/esm/test/mock-ssr-controller-definitions.js

@@ -1,4 +1,5 @@
 import { vi } from 'vitest';
+import { recommendationInternalOptionKey } from '../ssr-next/commerce/types/controller-constants.js';
 import { buildMockController, buildMockControllerWithInitialState, } from './mock-controller.js';
 export function defineMockController() {
     return {
@@ -41,3 +42,17 @@ export function defineMockCommerceControllerWithProps(options) {
         recommendation: options?.recommendation ?? true,
     };
 }
+export function defineMockRecommendationDefinition(slotId) {
+    return {
+        recommendation: true,
+        [recommendationInternalOptionKey]: {
+            slotId,
+        },
+        buildWithProps: vi.fn((engine, props) => ({
+            _kind: 'some-kind',
+            ...buildMockControllerWithInitialState(engine, {
+                initialState: props?.initialState,
+            }),
+        })),
+    };
+}

package/dist/esm/utils/version.js

@@ -1,2 +1,2 @@
-export const VERSION = "3.29.2-pre.326946f8df" || 'Test version';
+export const VERSION = "3.29.2-pre.34abdcbabf" || 'Test version';
 export const COVEO_FRAMEWORK = ['@coveo/atomic', '@coveo/quantic'];