@coveo/quantic 3.29.7-pre.ee24f8bd85 → 3.29.7-pre.f230cfebef

package/force-app/main/default/staticresources/coveoheadless/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/force-app/main/default/staticresources/coveoheadless/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/force-app/main/default/staticresources/coveoheadless/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>> & BuildConfig<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/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/hydrate-static-state.d.ts

@@ -14,4 +14,4 @@ export interface HydrateStaticStateOptions<TSearchAction> {
  *
  * Useful when hydrating a server-side-rendered engine.
  */
-export type HydrateStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction> & BuildConfig<TSolutionType> & 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/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/utils/controller-wiring.d.ts

@@ -1,8 +1,3 @@
-/**
- * Controller Wiring Utilities
- *
- * Transforms simple user configuration into complex internal controller structures.
- */
 import { Schema } from '@coveo/bueno';
 import type { ControllersPropsMap } from '../../common/types/controllers.js';
 import type { BuildConfig } from '../types/build.js';
@@ -20,7 +15,9 @@ export declare const searchDefinitionSchema: Schema<{
 export declare const standaloneDefinitionSchema: Schema<{
     context: unknown;
 }>;
-export declare const recommendationsDefinitionSchema: Schema<{
+export declare const recommendationsDefinitionSchema: (recommendationName: string[]) => Schema<{
+    recommendations: import("@coveo/bueno").PrimitivesValues[] | null | undefined;
+    productId: string;
     context: unknown;
 }>;
 /**
@@ -33,6 +30,6 @@ export declare const recommendationsDefinitionSchema: Schema<{
  * @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<SolutionType> & {
+export declare function wireControllerParams<TControllerDefinitions extends CommerceControllerDefinitionsMap>(solutionType: SolutionType, controllerDefinitions: TControllerDefinitions, buildConfig: BuildConfig<TControllerDefinitions, SolutionType> & {
     controllers?: ControllersPropsMap;
 }): InferControllerPropsMapFromDefinitions<TControllerDefinitions>;

package/force-app/main/default/staticresources/coveoheadless/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/force-app/main/default/staticresources/coveoheadless/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/force-app/main/default/staticresources/coveoheadless/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 {};