@coveo/quantic 3.29.6 → 3.29.7-pre.0e2721db97

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.d.ts

@@ -1,6 +1,7 @@
 import type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState } from '../../../../controllers/commerce/core/pagination/headless-core-commerce-pagination.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
+import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { Pagination, PaginationProps, PaginationState, PaginationOptions, CorePaginationOptions, };
+export type PaginationDefinition = SearchAndListingControllerDefinitionWithoutProps<Pagination>;
 /**
  * Defines a `Pagination` controller instance.
  * @group Definers
@@ -8,4 +9,4 @@ export type { Pagination, PaginationProps, PaginationState, PaginationOptions, C
  * @param props - The configurable `Pagination` properties.
  * @returns The `Pagination` controller definition.
  */
-export declare function definePagination<TOptions extends ControllerDefinitionOption | undefined>(props?: PaginationProps & TOptions): SubControllerDefinitionWithoutProps<Pagination, TOptions>;
+export declare function definePagination(props?: PaginationProps): PaginationDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.d.ts

@@ -2,25 +2,15 @@ import type { ParameterManager, ParameterManagerProps, ParameterManagerState } f
 import type { Parameters } from '../../../../features/commerce/parameters/parameters-actions.js';
 import type { ProductListingParameters } from '../../../../features/commerce/product-listing-parameters/product-listing-parameters-actions.js';
 import type { CommerceSearchParameters } from '../../../../features/commerce/search-parameters/search-parameters-actions.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithProps } from '../../types/controller-definitions.js';
+import type { SearchAndListingControllerDefinitionWithProps } from '../../types/controller-definitions.js';
 export type { ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, CommerceSearchParameters, };
-export type ParameterManagerDefinition<TOptions extends ControllerDefinitionOption | undefined> = SubControllerDefinitionWithProps<ParameterManager<MappedParameterTypes<TOptions>>, TOptions, SSRParameterManagerProps<MappedParameterTypes<TOptions>>>;
+export type ParameterManagerDefinition = SearchAndListingControllerDefinitionWithProps<ParameterManager<ProductListingParameters | CommerceSearchParameters>, SSRParameterManagerProps<ProductListingParameters | CommerceSearchParameters>>;
 /**
  * Defines a `ParameterManager` controller instance.
  * @group Definers
  *
  * @returns The `ParameterManager` controller definition.
  */
-export declare function defineParameterManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): ParameterManagerDefinition<TOptions>;
+export declare function defineParameterManager(): ParameterManagerDefinition;
 export interface SSRParameterManagerProps<T extends Parameters> extends Omit<ParameterManagerProps<T>, 'excludeDefaultParameters'> {
 }
-type MappedParameterTypes<TOptions extends ControllerDefinitionOption | undefined> = TOptions extends {
-    listing: true;
-    search: true;
-} | undefined ? ProductListingParameters | CommerceSearchParameters : TOptions extends {
-    listing: true;
-    search: false;
-} ? ProductListingParameters : TOptions extends {
-    listing: false;
-    search: true;
-} ? CommerceSearchParameters : never;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/product-list/headless-product-list.ssr.d.ts

@@ -1,12 +1,13 @@
 import { type ProductListing, type ProductListingState } from '../../../../controllers/commerce/product-listing/headless-product-listing.js';
 import { type Search } from '../../../../controllers/commerce/search/headless-search.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
+import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { Search, ProductListing, ProductListingState as ProductListState };
 export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'promoteChildToParent'>;
+export type ProductListDefinition = SearchAndListingControllerDefinitionWithoutProps<ProductList>;
 /**
  * Defines a `ProductList` controller instance.
  * @group Definers
  *
  * @returns The `ProductList` controller definition.
  */
-export declare function defineProductList<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<ProductList, TOptions>;
+export declare function defineProductList(): ProductListDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/product-view/headless-product-view.ssr.d.ts

@@ -1,8 +1,7 @@
 import { type ProductView as BaseProductView } from '../../../../controllers/commerce/product-view/headless-product-view.js';
 import { type Controller } from '../../../../controllers/controller/headless-controller.js';
 import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
-interface ProductViewDefinition extends NonRecommendationControllerDefinitionWithoutProps<ProductView> {
-}
+export type ProductViewDefinition = NonRecommendationControllerDefinitionWithoutProps<ProductView>;
 /**
  * Defines a `ProductView` controller instance.
  *
@@ -17,4 +16,3 @@ interface ProductViewDefinition extends NonRecommendationControllerDefinitionWit
 export declare function defineProductView(): ProductViewDefinition;
 export interface ProductView extends BaseProductView, Controller {
 }
-export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.d.ts

@@ -1,8 +1,7 @@
 import { type RecentQueriesList, type RecentQueriesListInitialState, type RecentQueriesListOptions, type RecentQueriesListProps, type RecentQueriesState } from '../../../../controllers/commerce/recent-queries-list/headless-recent-queries-list.js';
 import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesState, RecentQueriesList, RecentQueriesListProps, };
-export interface RecentQueriesListDefinition extends NonRecommendationControllerDefinitionWithoutProps<RecentQueriesList> {
-}
+export type RecentQueriesListDefinition = NonRecommendationControllerDefinitionWithoutProps<RecentQueriesList>;
 /**
  * Defines the `RecentQueriesList` controller for the purpose of server-side rendering.
  * @group Definers

package/force-app/main/default/staticresources/coveoheadless/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/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/search-box/headless-search-box.ssr.d.ts

@@ -1,8 +1,7 @@
 import { type CoreSearchBox, type SearchBox, type SearchBoxOptions, type SearchBoxProps, type SearchBoxState, type Suggestion } from '../../../../controllers/commerce/search-box/headless-search-box.js';
 import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { CoreSearchBox, SearchBox, SearchBoxProps, SearchBoxState, SearchBoxOptions, Suggestion, };
-export interface SearchBoxDefinition extends SearchOnlyControllerDefinitionWithoutProps<SearchBox> {
-}
+export type SearchBoxDefinition = SearchOnlyControllerDefinitionWithoutProps<SearchBox>;
 /**
  * Defines a `SearchBox` controller instance.
  * @group Definers

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.d.ts

@@ -1,6 +1,7 @@
 import type { Sort, SortProps, SortState } from '../../../../controllers/commerce/core/sort/headless-core-commerce-sort.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
+import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { Sort, SortProps, SortState };
+export type SortDefinition = SearchAndListingControllerDefinitionWithoutProps<Sort>;
 /**
  * Defines a `Sort` controller instance.
  * @group Definers
@@ -8,4 +9,4 @@ export type { Sort, SortProps, SortState };
  * @param props - The configurable `Sort` properties.
  * @returns The `Sort` controller definition.
  */
-export declare function defineSort<TOptions extends ControllerDefinitionOption | undefined>(props?: SortProps & TOptions): SubControllerDefinitionWithoutProps<Sort, TOptions>;
+export declare function defineSort(props?: SortProps): SortDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.d.ts

@@ -2,8 +2,7 @@ import { type StandaloneSearchBox, type StandaloneSearchBoxState } from '../../.
 import type { StandaloneSearchBoxProps } from '../../../../controllers/standalone-search-box/headless-standalone-search-box.js';
 import type { ListingAndStandaloneControllerWithoutProps } from '../../types/controller-definitions.js';
 export type { StandaloneSearchBoxState, StandaloneSearchBox, StandaloneSearchBoxProps, };
-export interface StandaloneSearchBoxDefinition extends ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox> {
-}
+export type StandaloneSearchBoxDefinition = ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox>;
 /**
  * Defines the `StandaloneSearchBox` controller for the purpose of server-side rendering.
  * @group Definers

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/summary/headless-core-summary.ssr.d.ts

@@ -2,12 +2,13 @@ import type { Summary, SummaryState } from '../../../../controllers/commerce/cor
 import type { ProductListingSummaryState } from '../../../../controllers/commerce/product-listing/summary/headless-product-listing-summary.js';
 import type { RecommendationsSummaryState } from '../../../../controllers/commerce/recommendations/summary/headless-recommendations-summary.js';
 import type { SearchSummaryState } from '../../../../controllers/commerce/search/summary/headless-search-summary.js';
-import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
+import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { Summary, ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, SummaryState, };
+export type SummaryDefinition = SearchAndListingControllerDefinitionWithoutProps<Summary<ProductListingSummaryState | SearchSummaryState | RecommendationsSummaryState>>;
 /**
  * Defines a `Summary` controller instance.
  * @group Definers
  *
  * @returns The `Summary` controller definition.
  */
-export declare function defineSummary<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<Summary<ProductListingSummaryState | SearchSummaryState | RecommendationsSummaryState>, TOptions>;
+export declare function defineSummary(): SummaryDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.d.ts

@@ -1,8 +1,7 @@
 import type { NotifyTrigger, NotifyTriggerState } from '../../../../controllers/core/triggers/headless-core-notify-trigger.js';
 import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { NotifyTrigger, NotifyTriggerState };
-export interface NotifyTriggerDefinition extends SearchAndListingControllerDefinitionWithoutProps<NotifyTrigger> {
-}
+export type NotifyTriggerDefinition = SearchAndListingControllerDefinitionWithoutProps<NotifyTrigger>;
 /**
  * Defines the `NotifyTrigger` controller for the purpose of server-side rendering.
  * @group Definers

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/triggers/headless-query-trigger.ssr.d.ts

@@ -2,8 +2,7 @@ import type { QueryTrigger } from '../../../../controllers/core/triggers/headles
 import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { QueryTriggerState } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
 export type { QueryTrigger };
-export interface QueryTriggerDefinition extends SearchOnlyControllerDefinitionWithoutProps<QueryTrigger> {
-}
+export type QueryTriggerDefinition = SearchOnlyControllerDefinitionWithoutProps<QueryTrigger>;
 /**
  * Defines the `QueryTrigger` controller for the purpose of server-side rendering.
  * @group Definers

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.d.ts

@@ -1,8 +1,7 @@
 import type { RedirectionTrigger, RedirectionTriggerState } from '../../../../controllers/core/triggers/headless-core-redirection-trigger.js';
 import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { RedirectionTrigger, RedirectionTriggerState };
-export interface RedirectionTriggerDefinition extends SearchOnlyControllerDefinitionWithoutProps<RedirectionTrigger> {
-}
+export type RedirectionTriggerDefinition = SearchOnlyControllerDefinitionWithoutProps<RedirectionTrigger>;
 /**
  * Defines the `RedirectionTrigger` controller for the purpose of server-side rendering.
  * @group Definers

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/engine/commerce-engine.ssr.d.ts

@@ -2,10 +2,9 @@
  * Utility functions to be used for Commerce Server Side Rendering.
  */
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { CommerceEngineDefinitionOptions } from '../factories/build-factory.js';
 import { SolutionType } from '../types/controller-constants.js';
 import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
-import type { CommerceEngineDefinition } from '../types/engine.js';
+import type { CommerceEngineDefinition, CommerceEngineDefinitionOptions } from '../types/engine.js';
 /**
  * Initializes a Commerce engine definition in SSR with given controllers definitions and commerce engine config.
  * @param options - The commerce engine definition

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/build-factory.d.ts

@@ -1,10 +1,7 @@
 import type { Action } from '@reduxjs/toolkit';
 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';
+import type { BuildParameters, CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions } from '../types/engine.js';
 /**
  * The SSR commerce engine.
  *
@@ -16,7 +13,6 @@ export interface SSRCommerceEngine extends CommerceEngine {
      */
     waitForRequestCompletedAction(): Promise<Action>[];
 }
-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/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/hydrated-state-factory.d.ts

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

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-hydrated-state-factory.d.ts

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

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts

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

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/static-state-factory.d.ts

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

package/force-app/main/default/staticresources/coveoheadless/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 { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap, 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> & CommerceEngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<CommerceEngineDefinitionBuildResult<TControllersMap>>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/controller-definitions.d.ts

@@ -1,27 +1,17 @@
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { InvalidControllerDefinition } from '../../common/errors.js';
+import type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers } from '../../common/types/controller-inference.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';
 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 { ListingAndStandaloneController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
+import type { HydratedState } from './hydrate-static-state.js';
 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.
@@ -57,10 +47,7 @@ export interface ControllerDefinitionsMap<TController extends Controller> {
     [customName: string]: ControllerDefinition<TController>;
 }
 type BakedInControllerDefinitions = {
-    parameterManager: ParameterManagerDefinition<{
-        listing: true;
-        search: true;
-    }>;
+    parameterManager: ParameterManagerDefinition;
     context: ContextDefinition;
     cart: CartDefinition;
 };
@@ -92,167 +79,20 @@ export type FilteredBakedInControllers<TSolutionType extends SolutionType> = {
  */
 export type AugmentedControllerDefinition<TControllerDefinitions extends ControllerDefinitionsMap<Controller>> = TControllerDefinitions & BakedInControllerDefinitions;
 /**
- * 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: []}},
- *   },
- * })
- * ```
- *
+ * This type defines the required and optional controller props for the commerce engine definition.
  */
+export type CommerceEngineDefinitionControllersPropsOption<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.
-     * @defaultValue true
-     */
-    listing?: boolean;
-    /**
-     * Whether the controller will be used in a search page context.
-     * @defaultValue true
-     */
-    search?: boolean;
-}
 export type SearchOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchOnlyController;
-type SearchOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchOnlyController;
 export type ListingAndStandaloneControllerWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingAndStandaloneController;
-type ListingOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingOnlyController;
-type ListingOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & ListingOnlyController;
 export type RecommendationOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & RecommendationOnlyController;
 export type NonRecommendationControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & NonRecommendationController;
 export type UniversalControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & UniversalController;
 export type SearchAndListingControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchAndListingController;
-type SearchAndListingControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchAndListingController;
-export type SubControllerDefinitionWithoutProps<TController extends Controller, TDefinition extends ControllerDefinitionOption | undefined> = TDefinition extends {
-    listing?: true;
-    search?: true;
-} | undefined ? SearchAndListingControllerDefinitionWithoutProps<TController> : TDefinition extends {
-    listing?: true;
-    search?: false;
-} ? ListingOnlyControllerDefinitionWithoutProps<TController> : TDefinition extends {
-    listing?: false;
-    search?: true;
-} ? SearchOnlyControllerDefinitionWithoutProps<TController> : TDefinition extends {
-    listing: false;
-    search: false;
-} ? InvalidControllerDefinition : never;
-export type SubControllerDefinitionWithProps<TController extends Controller, TDefinition extends ControllerDefinitionOption | undefined, TProps> = TDefinition extends {
-    listing?: true;
-    search?: true;
-} | undefined ? SearchAndListingControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
-    listing?: true;
-    search?: false;
-} ? ListingOnlyControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
-    listing?: false;
-    search?: true;
-} ? SearchOnlyControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
-    listing: false;
-    search: false;
-} ? InvalidControllerDefinition : never;
+export type SearchAndListingControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchAndListingController;