@coveo/headless 3.29.3-pre.8a67bd16aa → 3.29.3-pre.8b47cb07e6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/dist/cjs/case-assist/headless.cjs +1 -1
  2. package/dist/cjs/commerce/headless.cjs +1 -1
  3. package/dist/cjs/headless.cjs +2 -2
  4. package/dist/cjs/insight/headless.cjs +1 -1
  5. package/dist/cjs/node.cjs.stats.json +1 -1
  6. package/dist/cjs/recommendation/headless.cjs +1 -1
  7. package/dist/cjs/ssr/headless.cjs +2 -2
  8. package/dist/cjs/ssr/node.cjs.stats.json +1 -1
  9. package/dist/cjs/ssr-commerce/headless.cjs +1 -1
  10. package/dist/cjs/ssr-commerce-next/headless.cjs +1 -1
  11. package/dist/cjs/ssr-next/headless.cjs +2 -2
  12. package/dist/cjs/ssr-next/node.cjs.stats.json +1 -1
  13. package/dist/definitions/ssr/commerce/types/controller-definitions.d.ts +0 -3
  14. package/dist/definitions/ssr-commerce-next.index.d.ts +8 -8
  15. package/dist/definitions/ssr-next/commerce/controller-utils.d.ts +2 -1
  16. package/dist/definitions/ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.d.ts +2 -3
  17. package/dist/definitions/ssr-next/commerce/controllers/cart/headless-cart.ssr.d.ts +2 -1
  18. package/dist/definitions/ssr-next/commerce/controllers/context/headless-context.ssr.d.ts +3 -2
  19. package/dist/definitions/ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.d.ts +1 -2
  20. package/dist/definitions/ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.d.ts +2 -1
  21. package/dist/definitions/ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.d.ts +2 -3
  22. package/dist/definitions/ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.d.ts +2 -1
  23. package/dist/definitions/ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.d.ts +2 -3
  24. package/dist/definitions/ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.d.ts +13 -3
  25. package/dist/definitions/ssr-next/commerce/controllers/product-list/headless-product-list.ssr.d.ts +2 -3
  26. package/dist/definitions/ssr-next/commerce/controllers/product-view/headless-product-view.ssr.d.ts +3 -1
  27. package/dist/definitions/ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.d.ts +2 -1
  28. package/dist/definitions/ssr-next/commerce/controllers/search-box/headless-search-box.ssr.d.ts +2 -1
  29. package/dist/definitions/ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.d.ts +2 -3
  30. package/dist/definitions/ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.d.ts +2 -1
  31. package/dist/definitions/ssr-next/commerce/controllers/summary/headless-core-summary.ssr.d.ts +2 -3
  32. package/dist/definitions/ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.d.ts +2 -1
  33. package/dist/definitions/ssr-next/commerce/controllers/triggers/headless-query-trigger.ssr.d.ts +2 -1
  34. package/dist/definitions/ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.d.ts +2 -1
  35. package/dist/definitions/ssr-next/commerce/types/controller-definitions.d.ts +48 -3
  36. package/dist/definitions/ssr-next/commerce/types/controller-scopes.d.ts +6 -0
  37. package/dist/definitions/ssr-next/common/errors.d.ts +3 -0
  38. package/dist/esm/controllers/relevance-inspector/headless-relevance-inspector.js +1 -1
  39. package/dist/esm/ssr-next/commerce/controller-utils.js +6 -0
  40. package/dist/esm/ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js +4 -1
  41. package/dist/esm/ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js +4 -1
  42. package/dist/esm/ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js +2 -0
  43. package/dist/esm/ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.js +4 -1
  44. package/dist/esm/ssr-next/commerce/controllers/product-list/headless-product-list.ssr.js +4 -1
  45. package/dist/esm/ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js +2 -0
  46. package/dist/esm/ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js +4 -1
  47. package/dist/esm/ssr-next/common/errors.js +10 -0
  48. package/dist/esm/utils/version.js +1 -1
  49. package/dist/quantic/browser.cjs.stats.json +1 -1
  50. package/dist/quantic/case-assist/headless.js +1 -1
  51. package/dist/quantic/commerce/headless.js +1 -1
  52. package/dist/quantic/headless.js +2 -2
  53. package/dist/quantic/headless.js.map +1 -1
  54. package/dist/quantic/insight/headless.js +1 -1
  55. package/dist/quantic/recommendation/headless.js +1 -1
  56. package/package.json +1 -1
@@ -170,9 +170,6 @@ type DefaultControllerProps<TControllers extends ControllerDefinitionsMap<Contro
170
170
  [I in keyof TControllersPropsMap as I extends K ? I : never]: TControllersPropsMap[I];
171
171
  };
172
172
  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>;
173
- /**
174
- * @deprecated This interface is no longer used and will be removed in next major version.
175
- */
176
173
  export interface ControllerDefinitionOption {
177
174
  /**
178
175
  * Whether the controller will be used in a product listing context.
@@ -76,27 +76,27 @@ export type { LoggerOptions, LogLevel } from './app/logger.js';
76
76
  export type { BrowserNavigatorContextProvider, NavigatorContext, NavigatorContextProvider, } from './app/navigator-context-provider.js';
77
77
  export type { InteractiveProduct, InteractiveProductOptions, InteractiveProductProps, } from './controllers/commerce/core/interactive-product/headless-core-interactive-product.js';
78
78
  export type { Controller, Subscribable, } from './controllers/controller/headless-controller.js';
79
- export type { BreadcrumbManager, BreadcrumbManagerDefinition, BreadcrumbManagerState, } from './ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
79
+ export type { BreadcrumbManager, BreadcrumbManagerState, } from './ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
80
80
  export { defineBreadcrumbManager } from './ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
81
81
  export type { Cart, CartBuildProps, CartDefinition, CartInitialState, CartItem, CartProps, CartState, } from './ssr-next/commerce/controllers/cart/headless-cart.ssr.js';
82
82
  export { defineCart } from './ssr-next/commerce/controllers/cart/headless-cart.ssr.js';
83
83
  export type { Context, ContextDefinition, ContextOptions, ContextProps, ContextState, UserLocation, View, } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
84
84
  export { defineContext } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
85
- export type { DidYouMean, DidYouMeanDefinition, DidYouMeanState, } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
85
+ export type { DidYouMean, DidYouMeanState, } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
86
86
  export { defineDidYouMean } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
87
87
  export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, FieldSuggestionsFacet, FilterSuggestions, FilterSuggestionsGenerator, FilterSuggestionsGeneratorDefinition, FilterSuggestionsState, GeneratedFilterSuggestionsControllers, } from './ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
88
88
  export { defineFilterSuggestionsGenerator } from './ssr-next/commerce/controllers/filter-suggestions/headless-filter-suggestions-generator.ssr.js';
89
- export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetSearchResult, CategoryFacetState, CategoryFacetValue, CoreCommerceFacet, DateFacet, DateFacetState, DateFacetValue, FacetGenerator, FacetGeneratorDefinition, FacetGeneratorState, FacetType, LocationFacet, LocationFacetState, LocationFacetValue, MappedFacetState, MappedFacetStates, MappedGeneratedFacetController, NumericFacet, NumericFacetState, NumericFacetValue, RegularFacet, RegularFacetState, RegularFacetValue, } from './ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js';
89
+ export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetSearchResult, CategoryFacetState, CategoryFacetValue, CoreCommerceFacet, DateFacet, DateFacetState, DateFacetValue, FacetGenerator, FacetGeneratorState, FacetType, LocationFacet, LocationFacetState, LocationFacetValue, MappedFacetState, MappedFacetStates, MappedGeneratedFacetController, NumericFacet, NumericFacetState, NumericFacetValue, RegularFacet, RegularFacetState, RegularFacetValue, } from './ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js';
90
90
  export { defineFacetGenerator } from './ssr-next/commerce/controllers/generator/headless-commerce-facet-generator.ssr.js';
91
91
  export type { InstantProducts, InstantProductsDefinition, InstantProductsOptions, InstantProductsProps, InstantProductsState, } from './ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.js';
92
92
  export { defineInstantProducts } from './ssr-next/commerce/controllers/instant-products/headless-instant-products.ssr.js';
93
- export type { CorePaginationOptions, Pagination, PaginationDefinition, PaginationOptions, PaginationProps, PaginationState, } from './ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js';
93
+ export type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState, } from './ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js';
94
94
  export { definePagination } from './ssr-next/commerce/controllers/pagination/headless-core-commerce-pagination.ssr.js';
95
95
  export type { CommerceSearchParameters, ParameterManager, ParameterManagerDefinition, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, SSRParameterManagerProps, } from './ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
96
96
  export { defineParameterManager } from './ssr-next/commerce/controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
97
- export type { ProductList, ProductListDefinition, ProductListing, ProductListState, Search, } from './ssr-next/commerce/controllers/product-list/headless-product-list.ssr.js';
97
+ export type { ProductList, ProductListing, ProductListState, Search, } from './ssr-next/commerce/controllers/product-list/headless-product-list.ssr.js';
98
98
  export { defineProductList } from './ssr-next/commerce/controllers/product-list/headless-product-list.ssr.js';
99
- export type { ProductView, ProductViewDefinition, } from './ssr-next/commerce/controllers/product-view/headless-product-view.ssr.js';
99
+ export type { ProductView } from './ssr-next/commerce/controllers/product-view/headless-product-view.ssr.js';
100
100
  export { defineProductView } from './ssr-next/commerce/controllers/product-view/headless-product-view.ssr.js';
101
101
  export type { RecentQueriesList, RecentQueriesListDefinition, RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesListProps, RecentQueriesState, } from './ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.js';
102
102
  export { defineRecentQueriesList } from './ssr-next/commerce/controllers/recent-queries-list/headless-recent-queries-list.ssr.js';
@@ -104,11 +104,11 @@ export type { Recommendations, RecommendationsDefinition, RecommendationsState,
104
104
  export { defineRecommendations } from './ssr-next/commerce/controllers/recommendations/headless-recommendations.ssr.js';
105
105
  export type { CoreSearchBox, SearchBox, SearchBoxDefinition, SearchBoxOptions, SearchBoxProps, SearchBoxState, Suggestion, } from './ssr-next/commerce/controllers/search-box/headless-search-box.ssr.js';
106
106
  export { defineSearchBox } from './ssr-next/commerce/controllers/search-box/headless-search-box.ssr.js';
107
- export type { Sort, SortDefinition, SortProps, SortState, } from './ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js';
107
+ export type { Sort, SortProps, SortState, } from './ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js';
108
108
  export { defineSort } from './ssr-next/commerce/controllers/sort/headless-core-commerce-sort.ssr.js';
109
109
  export type { StandaloneSearchBox, StandaloneSearchBoxDefinition, StandaloneSearchBoxProps, StandaloneSearchBoxState, } from './ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.js';
110
110
  export { defineStandaloneSearchBox } from './ssr-next/commerce/controllers/standalone-search-box/headless-standalone-search-box.ssr.js';
111
- export type { ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, Summary, SummaryDefinition, SummaryState, } from './ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js';
111
+ export type { ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, Summary, SummaryState, } from './ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js';
112
112
  export { defineSummary } from './ssr-next/commerce/controllers/summary/headless-core-summary.ssr.js';
113
113
  export type { NotifyTrigger, NotifyTriggerDefinition, NotifyTriggerState, } from './ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.js';
114
114
  export { defineNotifyTrigger } from './ssr-next/commerce/controllers/triggers/headless-notify-trigger.ssr.js';
@@ -2,7 +2,7 @@ import type { UnknownAction } from '@reduxjs/toolkit';
2
2
  import type { Controller } from '../../controllers/controller/headless-controller.js';
3
3
  import type { SSRCommerceEngine } from './factories/build-factory.js';
4
4
  import type { SolutionType } from './types/controller-constants.js';
5
- import type { ControllerDefinitionsMap, FilteredBakedInControllers } from './types/controller-definitions.js';
5
+ import type { ControllerDefinitionOption, ControllerDefinitionsMap, FilteredBakedInControllers } from './types/controller-definitions.js';
6
6
  import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './types/controller-inference.js';
7
7
  export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>({ searchActions, controllers, }: {
8
8
  searchActions: TSearchAction[];
@@ -17,3 +17,4 @@ export declare function buildControllerDefinitions<TControllerDefinitionsMap ext
17
17
  solutionType: TSolutionType;
18
18
  propsMap?: InferControllerPropsMapFromDefinitions<TControllerDefinitionsMap>;
19
19
  }): InferControllersMapFromDefinition<TControllerDefinitionsMap, TSolutionType>;
20
+ export declare function ensureAtLeastOneSolutionType(options?: ControllerDefinitionOption): void;
@@ -1,11 +1,10 @@
1
1
  import type { BreadcrumbManager, BreadcrumbManagerState } from '../../../../controllers/commerce/core/breadcrumb-manager/headless-core-breadcrumb-manager.js';
2
- import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
2
+ import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
3
  export type { BreadcrumbManager, BreadcrumbManagerState };
4
- export type BreadcrumbManagerDefinition = SearchAndListingControllerDefinitionWithoutProps<BreadcrumbManager>;
5
4
  /**
6
5
  * Defines a `BreadcrumbManager` controller instance.
7
6
  * @group Definers
8
7
  *
9
8
  * @returns The `BreadcrumbManager` controller definition.
10
9
  */
11
- export declare function defineBreadcrumbManager(): BreadcrumbManagerDefinition;
10
+ export declare function defineBreadcrumbManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<BreadcrumbManager, TOptions>;
@@ -4,7 +4,8 @@ export type { Cart, CartInitialState, CartItem, CartProps, CartState };
4
4
  export interface CartBuildProps {
5
5
  initialState: CartInitialState;
6
6
  }
7
- export type CartDefinition = UniversalControllerDefinitionWithProps<Cart, CartBuildProps>;
7
+ export interface CartDefinition extends UniversalControllerDefinitionWithProps<Cart, CartBuildProps> {
8
+ }
8
9
  /**
9
10
  * Defines a `Cart` controller instance.
10
11
  * @group Definers
@@ -1,9 +1,10 @@
1
1
  import { type Context, type ContextOptions, type ContextProps, type ContextState, type UserLocation, type View } from '../../../../controllers/commerce/context/headless-context.js';
2
2
  import type { UniversalControllerDefinitionWithProps } from '../../types/controller-definitions.js';
3
3
  export type { Context, ContextProps, ContextState, View, UserLocation, ContextOptions, };
4
- export type ContextDefinition = UniversalControllerDefinitionWithProps<Context, {
4
+ export interface ContextDefinition extends UniversalControllerDefinitionWithProps<Context, {
5
5
  initialState: ContextOptions;
6
- }>;
6
+ }> {
7
+ }
7
8
  /**
8
9
  * Defines a `Context` controller instance.
9
10
  * @group Definers
@@ -1,11 +1,10 @@
1
1
  import type { DidYouMean, DidYouMeanState } from '../../../../controllers/commerce/search/did-you-mean/headless-did-you-mean.js';
2
2
  import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
3
  export type { DidYouMean, DidYouMeanState };
4
- export type DidYouMeanDefinition = SearchOnlyControllerDefinitionWithoutProps<DidYouMean>;
5
4
  /**
6
5
  * Defines a `DidYouMean` controller instance.
7
6
  * @group Definers
8
7
  *
9
8
  * @returns The `DidYouMean` controller definition.
10
9
  */
11
- export declare function defineDidYouMean(): DidYouMeanDefinition;
10
+ export declare function defineDidYouMean(): SearchOnlyControllerDefinitionWithoutProps<DidYouMean>;
@@ -4,7 +4,8 @@ import type { FilterSuggestions, FilterSuggestionsState } from '../../../../cont
4
4
  import { type FilterSuggestionsGenerator, type GeneratedFilterSuggestionsControllers } from '../../../../controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
5
5
  import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
6
6
  export type { FilterSuggestionsGenerator, GeneratedFilterSuggestionsControllers, FieldSuggestionsFacet, CategoryFilterSuggestions, CategoryFilterSuggestionsState, FilterSuggestions, FilterSuggestionsState, };
7
- export type FilterSuggestionsGeneratorDefinition = NonRecommendationControllerDefinitionWithoutProps<FilterSuggestionsGenerator>;
7
+ export interface FilterSuggestionsGeneratorDefinition extends NonRecommendationControllerDefinitionWithoutProps<FilterSuggestionsGenerator> {
8
+ }
8
9
  /**
9
10
  * Defines the `FilterSuggestionsGenerator` controller for the purpose of server-side rendering.
10
11
  * @group Definers
@@ -10,7 +10,7 @@ import type { NumericFacet, NumericFacetState, NumericFacetValue } from '../../.
10
10
  import type { RegularFacet, RegularFacetState } from '../../../../controllers/commerce/core/facets/regular/headless-commerce-regular-facet.js';
11
11
  import type { LocationFacetValue, RegularFacetValue } from '../../../../features/commerce/facets/facet-set/interfaces/response.js';
12
12
  import { SolutionType } from '../../types/controller-constants.js';
13
- import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
13
+ import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
14
14
  export type { BaseFacetSearchResult, CategoryFacet, CategoryFacetState, CategoryFacetValue, CategoryFacetSearchResult, CoreCommerceFacet, DateFacet, DateFacetValue, DateFacetState, NumericFacet, NumericFacetValue, NumericFacetState, RegularFacet, RegularFacetState, RegularFacetValue, LocationFacet, LocationFacetState, LocationFacetValue, MappedGeneratedFacetController, };
15
15
  export type FacetGeneratorState = MappedFacetStates;
16
16
  export type MappedFacetStates = Array<MappedFacetState[FacetType]>;
@@ -18,11 +18,10 @@ export type { FacetType };
18
18
  export type MappedFacetState = {
19
19
  [T in FacetType]: T extends 'numericalRange' ? NumericFacetState : T extends 'regular' ? RegularFacetState : T extends 'dateRange' ? DateFacetState : T extends 'hierarchical' ? CategoryFacetState : T extends 'location' ? LocationFacetState : never;
20
20
  };
21
- export type FacetGeneratorDefinition = SearchAndListingControllerDefinitionWithoutProps<FacetGenerator>;
22
21
  /**
23
22
  * @group Definers
24
23
  */
25
- export declare function defineFacetGenerator(): FacetGeneratorDefinition;
24
+ export declare function defineFacetGenerator<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<FacetGenerator, TOptions>;
26
25
  /**
27
26
  * The `FacetGenerator` headless sub-controller creates commerce facet sub-controllers from the Commerce API search or
28
27
  * product listing response.
@@ -1,7 +1,8 @@
1
1
  import { type InstantProducts, type InstantProductsOptions, type InstantProductsProps, type InstantProductsState } from '../../../../controllers/commerce/instant-products/headless-instant-products.js';
2
2
  import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
3
  export type { InstantProductsOptions, InstantProductsState, InstantProducts, InstantProductsProps, };
4
- export type InstantProductsDefinition = NonRecommendationControllerDefinitionWithoutProps<InstantProducts>;
4
+ export interface InstantProductsDefinition extends NonRecommendationControllerDefinitionWithoutProps<InstantProducts> {
5
+ }
5
6
  /**
6
7
  * Defines the `InstantProducts` controller for the purpose of server-side rendering.
7
8
  * @group Definers
@@ -1,7 +1,6 @@
1
1
  import type { CorePaginationOptions, Pagination, PaginationOptions, PaginationProps, PaginationState } from '../../../../controllers/commerce/core/pagination/headless-core-commerce-pagination.js';
2
- import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
2
+ import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
3
  export type { Pagination, PaginationProps, PaginationState, PaginationOptions, CorePaginationOptions, };
4
- export type PaginationDefinition = SearchAndListingControllerDefinitionWithoutProps<Pagination>;
5
4
  /**
6
5
  * Defines a `Pagination` controller instance.
7
6
  * @group Definers
@@ -9,4 +8,4 @@ export type PaginationDefinition = SearchAndListingControllerDefinitionWithoutPr
9
8
  * @param props - The configurable `Pagination` properties.
10
9
  * @returns The `Pagination` controller definition.
11
10
  */
12
- export declare function definePagination(props?: PaginationProps): PaginationDefinition;
11
+ export declare function definePagination<TOptions extends ControllerDefinitionOption | undefined>(props?: PaginationProps & TOptions): SubControllerDefinitionWithoutProps<Pagination, TOptions>;
@@ -2,15 +2,25 @@ import type { ParameterManager, ParameterManagerProps, ParameterManagerState } f
2
2
  import type { Parameters } from '../../../../features/commerce/parameters/parameters-actions.js';
3
3
  import type { ProductListingParameters } from '../../../../features/commerce/product-listing-parameters/product-listing-parameters-actions.js';
4
4
  import type { CommerceSearchParameters } from '../../../../features/commerce/search-parameters/search-parameters-actions.js';
5
- import type { SearchAndListingControllerDefinitionWithProps } from '../../types/controller-definitions.js';
5
+ import type { ControllerDefinitionOption, SubControllerDefinitionWithProps } from '../../types/controller-definitions.js';
6
6
  export type { ParameterManager, ParameterManagerProps, ParameterManagerState, Parameters, ProductListingParameters, CommerceSearchParameters, };
7
- export type ParameterManagerDefinition = SearchAndListingControllerDefinitionWithProps<ParameterManager<ProductListingParameters | CommerceSearchParameters>, SSRParameterManagerProps<ProductListingParameters | CommerceSearchParameters>>;
7
+ export type ParameterManagerDefinition<TOptions extends ControllerDefinitionOption | undefined> = SubControllerDefinitionWithProps<ParameterManager<MappedParameterTypes<TOptions>>, TOptions, SSRParameterManagerProps<MappedParameterTypes<TOptions>>>;
8
8
  /**
9
9
  * Defines a `ParameterManager` controller instance.
10
10
  * @group Definers
11
11
  *
12
12
  * @returns The `ParameterManager` controller definition.
13
13
  */
14
- export declare function defineParameterManager(): ParameterManagerDefinition;
14
+ export declare function defineParameterManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): ParameterManagerDefinition<TOptions>;
15
15
  export interface SSRParameterManagerProps<T extends Parameters> extends Omit<ParameterManagerProps<T>, 'excludeDefaultParameters'> {
16
16
  }
17
+ type MappedParameterTypes<TOptions extends ControllerDefinitionOption | undefined> = TOptions extends {
18
+ listing: true;
19
+ search: true;
20
+ } | undefined ? ProductListingParameters | CommerceSearchParameters : TOptions extends {
21
+ listing: true;
22
+ search: false;
23
+ } ? ProductListingParameters : TOptions extends {
24
+ listing: false;
25
+ search: true;
26
+ } ? CommerceSearchParameters : never;
@@ -1,13 +1,12 @@
1
1
  import { type ProductListing, type ProductListingState } from '../../../../controllers/commerce/product-listing/headless-product-listing.js';
2
2
  import { type Search } from '../../../../controllers/commerce/search/headless-search.js';
3
- import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
+ import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
4
4
  export type { Search, ProductListing, ProductListingState as ProductListState };
5
5
  export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'promoteChildToParent'>;
6
- export type ProductListDefinition = SearchAndListingControllerDefinitionWithoutProps<ProductList>;
7
6
  /**
8
7
  * Defines a `ProductList` controller instance.
9
8
  * @group Definers
10
9
  *
11
10
  * @returns The `ProductList` controller definition.
12
11
  */
13
- export declare function defineProductList(): ProductListDefinition;
12
+ export declare function defineProductList<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<ProductList, TOptions>;
@@ -1,7 +1,8 @@
1
1
  import { type ProductView as BaseProductView } from '../../../../controllers/commerce/product-view/headless-product-view.js';
2
2
  import { type Controller } from '../../../../controllers/controller/headless-controller.js';
3
3
  import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
4
- export type ProductViewDefinition = NonRecommendationControllerDefinitionWithoutProps<ProductView>;
4
+ interface ProductViewDefinition extends NonRecommendationControllerDefinitionWithoutProps<ProductView> {
5
+ }
5
6
  /**
6
7
  * Defines a `ProductView` controller instance.
7
8
  *
@@ -16,3 +17,4 @@ export type ProductViewDefinition = NonRecommendationControllerDefinitionWithout
16
17
  export declare function defineProductView(): ProductViewDefinition;
17
18
  export interface ProductView extends BaseProductView, Controller {
18
19
  }
20
+ export {};
@@ -1,7 +1,8 @@
1
1
  import { type RecentQueriesList, type RecentQueriesListInitialState, type RecentQueriesListOptions, type RecentQueriesListProps, type RecentQueriesState } from '../../../../controllers/commerce/recent-queries-list/headless-recent-queries-list.js';
2
2
  import type { NonRecommendationControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
3
  export type { RecentQueriesListInitialState, RecentQueriesListOptions, RecentQueriesState, RecentQueriesList, RecentQueriesListProps, };
4
- export type RecentQueriesListDefinition = NonRecommendationControllerDefinitionWithoutProps<RecentQueriesList>;
4
+ export interface RecentQueriesListDefinition extends NonRecommendationControllerDefinitionWithoutProps<RecentQueriesList> {
5
+ }
5
6
  /**
6
7
  * Defines the `RecentQueriesList` controller for the purpose of server-side rendering.
7
8
  * @group Definers
@@ -1,7 +1,8 @@
1
1
  import { type CoreSearchBox, type SearchBox, type SearchBoxOptions, type SearchBoxProps, type SearchBoxState, type Suggestion } from '../../../../controllers/commerce/search-box/headless-search-box.js';
2
2
  import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
3
  export type { CoreSearchBox, SearchBox, SearchBoxProps, SearchBoxState, SearchBoxOptions, Suggestion, };
4
- export type SearchBoxDefinition = SearchOnlyControllerDefinitionWithoutProps<SearchBox>;
4
+ export interface SearchBoxDefinition extends SearchOnlyControllerDefinitionWithoutProps<SearchBox> {
5
+ }
5
6
  /**
6
7
  * Defines a `SearchBox` controller instance.
7
8
  * @group Definers
@@ -1,7 +1,6 @@
1
1
  import type { Sort, SortProps, SortState } from '../../../../controllers/commerce/core/sort/headless-core-commerce-sort.js';
2
- import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
2
+ import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
3
  export type { Sort, SortProps, SortState };
4
- export type SortDefinition = SearchAndListingControllerDefinitionWithoutProps<Sort>;
5
4
  /**
6
5
  * Defines a `Sort` controller instance.
7
6
  * @group Definers
@@ -9,4 +8,4 @@ export type SortDefinition = SearchAndListingControllerDefinitionWithoutProps<So
9
8
  * @param props - The configurable `Sort` properties.
10
9
  * @returns The `Sort` controller definition.
11
10
  */
12
- export declare function defineSort(props?: SortProps): SortDefinition;
11
+ export declare function defineSort<TOptions extends ControllerDefinitionOption | undefined>(props?: SortProps & TOptions): SubControllerDefinitionWithoutProps<Sort, TOptions>;
@@ -2,7 +2,8 @@ import { type StandaloneSearchBox, type StandaloneSearchBoxState } from '../../.
2
2
  import type { StandaloneSearchBoxProps } from '../../../../controllers/standalone-search-box/headless-standalone-search-box.js';
3
3
  import type { ListingAndStandaloneControllerWithoutProps } from '../../types/controller-definitions.js';
4
4
  export type { StandaloneSearchBoxState, StandaloneSearchBox, StandaloneSearchBoxProps, };
5
- export type StandaloneSearchBoxDefinition = ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox>;
5
+ export interface StandaloneSearchBoxDefinition extends ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox> {
6
+ }
6
7
  /**
7
8
  * Defines the `StandaloneSearchBox` controller for the purpose of server-side rendering.
8
9
  * @group Definers
@@ -2,13 +2,12 @@ import type { Summary, SummaryState } from '../../../../controllers/commerce/cor
2
2
  import type { ProductListingSummaryState } from '../../../../controllers/commerce/product-listing/summary/headless-product-listing-summary.js';
3
3
  import type { RecommendationsSummaryState } from '../../../../controllers/commerce/recommendations/summary/headless-recommendations-summary.js';
4
4
  import type { SearchSummaryState } from '../../../../controllers/commerce/search/summary/headless-search-summary.js';
5
- import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
5
+ import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
6
6
  export type { Summary, ProductListingSummaryState, RecommendationsSummaryState, SearchSummaryState, SummaryState, };
7
- export type SummaryDefinition = SearchAndListingControllerDefinitionWithoutProps<Summary<ProductListingSummaryState | SearchSummaryState | RecommendationsSummaryState>>;
8
7
  /**
9
8
  * Defines a `Summary` controller instance.
10
9
  * @group Definers
11
10
  *
12
11
  * @returns The `Summary` controller definition.
13
12
  */
14
- export declare function defineSummary(): SummaryDefinition;
13
+ export declare function defineSummary<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<Summary<ProductListingSummaryState | SearchSummaryState | RecommendationsSummaryState>, TOptions>;
@@ -1,7 +1,8 @@
1
1
  import type { NotifyTrigger, NotifyTriggerState } from '../../../../controllers/core/triggers/headless-core-notify-trigger.js';
2
2
  import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
3
  export type { NotifyTrigger, NotifyTriggerState };
4
- export type NotifyTriggerDefinition = SearchAndListingControllerDefinitionWithoutProps<NotifyTrigger>;
4
+ export interface NotifyTriggerDefinition extends SearchAndListingControllerDefinitionWithoutProps<NotifyTrigger> {
5
+ }
5
6
  /**
6
7
  * Defines the `NotifyTrigger` controller for the purpose of server-side rendering.
7
8
  * @group Definers
@@ -2,7 +2,8 @@ import type { QueryTrigger } from '../../../../controllers/core/triggers/headles
2
2
  import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
3
  export type { QueryTriggerState } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
4
4
  export type { QueryTrigger };
5
- export type QueryTriggerDefinition = SearchOnlyControllerDefinitionWithoutProps<QueryTrigger>;
5
+ export interface QueryTriggerDefinition extends SearchOnlyControllerDefinitionWithoutProps<QueryTrigger> {
6
+ }
6
7
  /**
7
8
  * Defines the `QueryTrigger` controller for the purpose of server-side rendering.
8
9
  * @group Definers
@@ -1,7 +1,8 @@
1
1
  import type { RedirectionTrigger, RedirectionTriggerState } from '../../../../controllers/core/triggers/headless-core-redirection-trigger.js';
2
2
  import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
3
3
  export type { RedirectionTrigger, RedirectionTriggerState };
4
- export type RedirectionTriggerDefinition = SearchOnlyControllerDefinitionWithoutProps<RedirectionTrigger>;
4
+ export interface RedirectionTriggerDefinition extends SearchOnlyControllerDefinitionWithoutProps<RedirectionTrigger> {
5
+ }
5
6
  /**
6
7
  * Defines the `RedirectionTrigger` controller for the purpose of server-side rendering.
7
8
  * @group Definers
@@ -1,4 +1,5 @@
1
1
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
2
+ import type { InvalidControllerDefinition } from '../../common/errors.js';
2
3
  import type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers } from '../../common/types/controller-inference.js';
3
4
  import type { ControllersPropsMap } from '../../common/types/controllers.js';
4
5
  import type { HasKey, HasRequiredKeys, OptionsTuple } from '../../common/types/utilities.js';
@@ -7,7 +8,7 @@ import type { ContextDefinition } from '../controllers/context/headless-context.
7
8
  import type { ParameterManagerDefinition } from '../controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
8
9
  import type { SSRCommerceEngine } from '../factories/build-factory.js';
9
10
  import { type recommendationInternalOptionKey, SolutionType } from './controller-constants.js';
10
- import type { ListingAndStandaloneController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
11
+ import type { ListingAndStandaloneController, ListingOnlyController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
11
12
  import type { HydratedState } from './hydrate-static-state.js';
12
13
  import type { HasSolutionType } from './utilities.js';
13
14
  export type { HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
@@ -43,7 +44,10 @@ export interface ControllerDefinitionsMap<TController extends Controller> {
43
44
  [customName: string]: ControllerDefinition<TController>;
44
45
  }
45
46
  type BakedInControllerDefinitions = {
46
- parameterManager: ParameterManagerDefinition;
47
+ parameterManager: ParameterManagerDefinition<{
48
+ listing: true;
49
+ search: true;
50
+ }>;
47
51
  context: ContextDefinition;
48
52
  cart: CartDefinition;
49
53
  };
@@ -85,10 +89,51 @@ export type IsRecommendationController<TController extends ControllerDefinition<
85
89
  type DefaultControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, K extends keyof TControllers> = {
86
90
  [I in keyof TControllersPropsMap as I extends K ? I : never]: TControllersPropsMap[I];
87
91
  };
92
+ export interface ControllerDefinitionOption {
93
+ /**
94
+ * Whether the controller will be used in a product listing context.
95
+ * @defaultValue true
96
+ */
97
+ listing?: boolean;
98
+ /**
99
+ * Whether the controller will be used in a search page context.
100
+ * @defaultValue true
101
+ */
102
+ search?: boolean;
103
+ }
88
104
  export type SearchOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchOnlyController;
105
+ type SearchOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchOnlyController;
89
106
  export type ListingAndStandaloneControllerWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingAndStandaloneController;
107
+ type ListingOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingOnlyController;
108
+ type ListingOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & ListingOnlyController;
90
109
  export type RecommendationOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & RecommendationOnlyController;
91
110
  export type NonRecommendationControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & NonRecommendationController;
92
111
  export type UniversalControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & UniversalController;
93
112
  export type SearchAndListingControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchAndListingController;
94
- export type SearchAndListingControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchAndListingController;
113
+ type SearchAndListingControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchAndListingController;
114
+ export type SubControllerDefinitionWithoutProps<TController extends Controller, TDefinition extends ControllerDefinitionOption | undefined> = TDefinition extends {
115
+ listing?: true;
116
+ search?: true;
117
+ } | undefined ? SearchAndListingControllerDefinitionWithoutProps<TController> : TDefinition extends {
118
+ listing?: true;
119
+ search?: false;
120
+ } ? ListingOnlyControllerDefinitionWithoutProps<TController> : TDefinition extends {
121
+ listing?: false;
122
+ search?: true;
123
+ } ? SearchOnlyControllerDefinitionWithoutProps<TController> : TDefinition extends {
124
+ listing: false;
125
+ search: false;
126
+ } ? InvalidControllerDefinition : never;
127
+ export type SubControllerDefinitionWithProps<TController extends Controller, TDefinition extends ControllerDefinitionOption | undefined, TProps> = TDefinition extends {
128
+ listing?: true;
129
+ search?: true;
130
+ } | undefined ? SearchAndListingControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
131
+ listing?: true;
132
+ search?: false;
133
+ } ? ListingOnlyControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
134
+ listing?: false;
135
+ search?: true;
136
+ } ? SearchOnlyControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
137
+ listing: false;
138
+ search: false;
139
+ } ? InvalidControllerDefinition : never;
@@ -37,6 +37,12 @@ export interface SearchOnlyController {
37
37
  */
38
38
  [SolutionType.search]: true;
39
39
  }
40
+ export interface ListingOnlyController {
41
+ /**
42
+ * @internal
43
+ */
44
+ [SolutionType.listing]: true;
45
+ }
40
46
  export interface RecommendationOnlyController {
41
47
  /**
42
48
  * @internal
@@ -1,3 +1,6 @@
1
+ export declare class InvalidControllerDefinition extends Error {
2
+ constructor();
3
+ }
1
4
  export declare class MissingControllerProps extends Error {
2
5
  constructor(controller: string);
3
6
  }
@@ -82,7 +82,7 @@ export function buildRelevanceInspector(engine, props = {}) {
82
82
  warnProductionEnvironment('fieldsDescription');
83
83
  engine.logger.warn(`For production environment, please specify the necessary fields either when instantiating a ResultList controller, or by dispatching a registerFieldsToInclude action.
84
84
 
85
- https://docs.coveo.com/en/headless/latest/reference/interfaces/Search.ResultListOptions.html
85
+ hhttps://docs.coveo.com/en/headless/latest/reference/interfaces/Search.ResultListOptions.html
86
86
  https://docs.coveo.com/en/headless/latest/reference/interfaces/Search.FieldActionCreators.html#registerfieldstoinclude`);
87
87
  },
88
88
  };
@@ -1,6 +1,7 @@
1
1
  import { clone, filterObject, mapObject } from '../../utils/utils.js';
2
2
  import { ControllerBuilder } from '../common/builders/controller-builder.js';
3
3
  import { createStaticControllerBuilder } from '../common/builders/static-controller-builder.js';
4
+ import { InvalidControllerDefinition } from '../common/errors.js';
4
5
  export function createStaticState({ searchActions, controllers, }) {
5
6
  return {
6
7
  controllers: mapObject(controllers, (controller) => createStaticControllerBuilder(controller).build()),
@@ -22,3 +23,8 @@ export function buildControllerDefinitions({ definitionsMap, engine, solutionTyp
22
23
  });
23
24
  return filterObject(controllerMap, (value) => value !== null);
24
25
  }
26
+ export function ensureAtLeastOneSolutionType(options) {
27
+ if (options?.listing === false && options?.search === false) {
28
+ throw new InvalidControllerDefinition();
29
+ }
30
+ }
@@ -1,5 +1,6 @@
1
1
  import { buildProductListing } from '../../../../controllers/commerce/product-listing/headless-product-listing.js';
2
2
  import { buildSearch } from '../../../../controllers/commerce/search/headless-search.js';
3
+ import { ensureAtLeastOneSolutionType } from '../../controller-utils.js';
3
4
  import { SolutionType } from '../../types/controller-constants.js';
4
5
  /**
5
6
  * Defines a `BreadcrumbManager` controller instance.
@@ -7,10 +8,12 @@ import { SolutionType } from '../../types/controller-constants.js';
7
8
  *
8
9
  * @returns The `BreadcrumbManager` controller definition.
9
10
  */
10
- export function defineBreadcrumbManager() {
11
+ export function defineBreadcrumbManager(options) {
12
+ ensureAtLeastOneSolutionType(options);
11
13
  return {
12
14
  listing: true,
13
15
  search: true,
16
+ ...options,
14
17
  build: (engine, solutionType) => solutionType === SolutionType.listing
15
18
  ? buildProductListing(engine).breadcrumbManager()
16
19
  : buildSearch(engine).breadcrumbManager(),
@@ -15,14 +15,17 @@ import { manualNumericFacetReducer as manualNumericFacetSet } from '../../../../
15
15
  import { categoryFacetSearchStateSelector } from '../../../../features/facets/facet-search-set/category/category-facet-search-state-selector.js';
16
16
  import { specificFacetSearchStateSelector } from '../../../../features/facets/facet-search-set/specific/specific-facet-search-state-selector.js';
17
17
  import { loadReducerError } from '../../../../utils/errors.js';
18
+ import { ensureAtLeastOneSolutionType } from '../../controller-utils.js';
18
19
  import { SolutionType } from '../../types/controller-constants.js';
19
20
  /**
20
21
  * @group Definers
21
22
  */
22
- export function defineFacetGenerator() {
23
+ export function defineFacetGenerator(options) {
24
+ ensureAtLeastOneSolutionType(options);
23
25
  return {
24
26
  listing: true,
25
27
  search: true,
28
+ ...options,
26
29
  build: (engine, solutionType) => buildFacetGenerator(engine, { props: { solutionType: solutionType } }),
27
30
  };
28
31
  }
@@ -1,5 +1,6 @@
1
1
  import { buildProductListing } from '../../../../controllers/commerce/product-listing/headless-product-listing.js';
2
2
  import { buildSearch } from '../../../../controllers/commerce/search/headless-search.js';
3
+ import { ensureAtLeastOneSolutionType } from '../../controller-utils.js';
3
4
  import { SolutionType } from '../../types/controller-constants.js';
4
5
  /**
5
6
  * Defines a `Pagination` controller instance.
@@ -9,6 +10,7 @@ import { SolutionType } from '../../types/controller-constants.js';
9
10
  * @returns The `Pagination` controller definition.
10
11
  */
11
12
  export function definePagination(props) {
13
+ ensureAtLeastOneSolutionType(props);
12
14
  return {
13
15
  listing: true,
14
16
  search: true,
@@ -9,6 +9,7 @@ import { sortReducer as commerceSort } from '../../../../features/commerce/sort/
9
9
  import { facetOrderReducer as facetOrder } from '../../../../features/facets/facet-order/facet-order-slice.js';
10
10
  import { querySetReducer as querySet } from '../../../../features/query-set/query-set-slice.js';
11
11
  import { loadReducerError } from '../../../../utils/errors.js';
12
+ import { ensureAtLeastOneSolutionType } from '../../controller-utils.js';
12
13
  import { SolutionType } from '../../types/controller-constants.js';
13
14
  /**
14
15
  * Defines a `ParameterManager` controller instance.
@@ -16,10 +17,12 @@ import { SolutionType } from '../../types/controller-constants.js';
16
17
  *
17
18
  * @returns The `ParameterManager` controller definition.
18
19
  */
19
- export function defineParameterManager() {
20
+ export function defineParameterManager(options) {
21
+ ensureAtLeastOneSolutionType(options);
20
22
  return {
21
23
  listing: true,
22
24
  search: true,
25
+ ...options,
23
26
  buildWithProps: (engine, props, solutionType) => {
24
27
  if (solutionType === SolutionType.listing) {
25
28
  if (!loadCommerceProductListingParameterReducers(engine)) {
@@ -1,5 +1,6 @@
1
1
  import { buildProductListing, } from '../../../../controllers/commerce/product-listing/headless-product-listing.js';
2
2
  import { buildSearch, } from '../../../../controllers/commerce/search/headless-search.js';
3
+ import { ensureAtLeastOneSolutionType } from '../../controller-utils.js';
3
4
  import { SolutionType } from '../../types/controller-constants.js';
4
5
  /**
5
6
  * Defines a `ProductList` controller instance.
@@ -7,10 +8,12 @@ import { SolutionType } from '../../types/controller-constants.js';
7
8
  *
8
9
  * @returns The `ProductList` controller definition.
9
10
  */
10
- export function defineProductList() {
11
+ export function defineProductList(options) {
12
+ ensureAtLeastOneSolutionType(options);
11
13
  return {
12
14
  listing: true,
13
15
  search: true,
16
+ ...options,
14
17
  build: (engine, solutionType) => solutionType === SolutionType.listing
15
18
  ? buildProductListing(engine)
16
19
  : buildSearch(engine),