@coveo/quantic 3.30.0-pre.8a67bd16aa → 3.30.0-pre.8b47cb07e6

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

@@ -1,13 +1,12 @@
 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 { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
+import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } 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(): ProductListDefinition;
+export declare function defineProductList<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<ProductList, TOptions>;

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

@@ -1,7 +1,8 @@
 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';
-export type ProductViewDefinition = NonRecommendationControllerDefinitionWithoutProps<ProductView>;
+interface ProductViewDefinition extends NonRecommendationControllerDefinitionWithoutProps<ProductView> {
+}
 /**
  * Defines a `ProductView` controller instance.
  *
@@ -16,3 +17,4 @@ export type ProductViewDefinition = NonRecommendationControllerDefinitionWithout
 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,7 +1,8 @@
 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 type RecentQueriesListDefinition = NonRecommendationControllerDefinitionWithoutProps<RecentQueriesList>;
+export interface RecentQueriesListDefinition extends 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/search-box/headless-search-box.ssr.d.ts

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

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

@@ -2,7 +2,8 @@ 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 type StandaloneSearchBoxDefinition = ListingAndStandaloneControllerWithoutProps<StandaloneSearchBox>;
+export interface StandaloneSearchBoxDefinition extends 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,13 +2,12 @@ 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 { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
+import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } 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(): SummaryDefinition;
+export declare function defineSummary<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<Summary<ProductListingSummaryState | SearchSummaryState | RecommendationsSummaryState>, TOptions>;

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

@@ -1,7 +1,8 @@
 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 type NotifyTriggerDefinition = SearchAndListingControllerDefinitionWithoutProps<NotifyTrigger>;
+export interface NotifyTriggerDefinition extends 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,7 +2,8 @@ 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 type QueryTriggerDefinition = SearchOnlyControllerDefinitionWithoutProps<QueryTrigger>;
+export interface QueryTriggerDefinition extends 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,7 +1,8 @@
 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 type RedirectionTriggerDefinition = SearchOnlyControllerDefinitionWithoutProps<RedirectionTrigger>;
+export interface RedirectionTriggerDefinition extends 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/types/controller-definitions.d.ts

@@ -1,4 +1,5 @@
 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 { HasKey, HasRequiredKeys, OptionsTuple } from '../../common/types/utilities.js';
@@ -7,7 +8,7 @@ import type { ContextDefinition } from '../controllers/context/headless-context.
 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, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
+import type { ListingAndStandaloneController, ListingOnlyController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
 import type { HydratedState } from './hydrate-static-state.js';
 import type { HasSolutionType } from './utilities.js';
 export type { HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
@@ -43,7 +44,10 @@ export interface ControllerDefinitionsMap<TController extends Controller> {
     [customName: string]: ControllerDefinition<TController>;
 }
 type BakedInControllerDefinitions = {
-    parameterManager: ParameterManagerDefinition;
+    parameterManager: ParameterManagerDefinition<{
+        listing: true;
+        search: true;
+    }>;
     context: ContextDefinition;
     cart: CartDefinition;
 };
@@ -85,10 +89,51 @@ export type IsRecommendationController<TController extends ControllerDefinition<
 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];
 };
+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;
-export type SearchAndListingControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & 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;

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

@@ -37,6 +37,12 @@ export interface SearchOnlyController {
      */
     [SolutionType.search]: true;
 }
+export interface ListingOnlyController {
+    /**
+     * @internal
+     */
+    [SolutionType.listing]: true;
+}
 export interface RecommendationOnlyController {
     /**
      * @internal

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/errors.d.ts

@@ -1,3 +1,6 @@
+export declare class InvalidControllerDefinition extends Error {
+    constructor();
+}
 export declare class MissingControllerProps extends Error {
     constructor(controller: string);
 }