@coveo/quantic 3.14.3 → 3.15.1

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/commerce-api-client.d.ts

@@ -5,7 +5,7 @@ import { PlatformEnvironment } from '../../utils/url-utils.js';
 import { PreprocessRequest } from '../preprocess-request.js';
 import { SpecificFacetSearchResponse } from '../search/facet-search/specific-facet-search/specific-facet-search-response.js';
 import { CommerceAPIErrorResponse, CommerceAPIErrorStatusResponse } from './commerce-api-error-response.js';
-import { CommerceAPIRequest } from './common/request.js';
+import { FilterableCommerceAPIRequest } from './common/request.js';
 import { CommerceSuccessResponse } from './common/response.js';
 import { CommerceFacetSearchRequest, FacetSearchType } from './facet-search/facet-search-request.js';
 import { CommerceRecommendationsRequest } from './recommendations/recommendations-request.js';
@@ -34,7 +34,7 @@ export declare const isErrorResponse: <T>(r: CommerceAPIResponse<T>) => r is Com
 export declare class CommerceAPIClient implements CommerceFacetSearchAPIClient {
     private options;
     constructor(options: CommerceAPIClientOptions);
-    getProductListing(req: CommerceAPIRequest): Promise<CommerceAPIResponse<CommerceSuccessResponse>>;
+    getProductListing(req: FilterableCommerceAPIRequest): Promise<CommerceAPIResponse<CommerceSuccessResponse>>;
     search(req: CommerceSearchRequest): Promise<CommerceAPIResponse<SearchCommerceSuccessResponse>>;
     getRecommendations(req: CommerceRecommendationsRequest): Promise<CommerceAPIResponse<RecommendationsCommerceSuccessResponse>>;
     productSuggestions(req: CommerceSearchRequest): Promise<CommerceAPIResponse<SearchCommerceSuccessResponse>>;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts

@@ -2,9 +2,10 @@ import { PlatformClientCallOptions } from '../../platform-client.js';
 import { BaseParam } from '../../platform-service-params.js';
 import { TrackingIdParam, LanguageParam, CountryParam, CurrencyParam, ClientIdParam, ContextParam, FacetsParam, PageParam, SortParam, PerPageParam } from '../commerce-api-params.js';
 import { CommerceApiMethod } from '../commerce-metadata.js';
-export type BaseCommerceAPIRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam & PageParam & PerPageParam;
-export type CommerceAPIRequest = BaseCommerceAPIRequest & FacetsParam & SortParam;
-export declare const buildRequest: (req: CommerceAPIRequest, path: CommerceApiMethod) => {
+export type BaseCommerceAPIRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam;
+export type PaginatedCommerceAPIRequest = BaseCommerceAPIRequest & PageParam & PerPageParam;
+export type FilterableCommerceAPIRequest = PaginatedCommerceAPIRequest & FacetsParam & SortParam;
+export declare const getRequestOptions: (req: FilterableCommerceAPIRequest, path: CommerceApiMethod) => {
     requestParams: {
         trackingId: string;
         clientId: string | undefined;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts

@@ -1,7 +1,7 @@
 import { SlotIdParam } from '../commerce-api-params.js';
 import { CommerceApiMethod } from '../commerce-metadata.js';
-import { BaseCommerceAPIRequest } from '../common/request.js';
-export type CommerceRecommendationsRequest = BaseCommerceAPIRequest & SlotIdParam;
+import { PaginatedCommerceAPIRequest } from '../common/request.js';
+export type CommerceRecommendationsRequest = PaginatedCommerceAPIRequest & SlotIdParam;
 export declare const buildRecommendationsRequest: (req: CommerceRecommendationsRequest, path: CommerceApiMethod) => {
     requestParams: {
         slotId: string;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts

@@ -1,7 +1,7 @@
 import { BaseParam } from '../../../platform-service-params.js';
 import { ClientIdParam, CurrencyParam, LanguageParam, QueryParam, TrackingIdParam, ContextParam, CountryParam } from '../../commerce-api-params.js';
 export type QuerySuggestRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam & QueryParam;
-export declare const buildQuerySuggestRequest: (req: QuerySuggestRequest) => {
+export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) => {
     requestParams: {
         trackingId: string;
         query: string | undefined;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/request.d.ts

@@ -1,3 +1,3 @@
 import { QueryParam } from '../commerce-api-params.js';
-import { CommerceAPIRequest } from '../common/request.js';
-export type CommerceSearchRequest = CommerceAPIRequest & QueryParam;
+import { FilterableCommerceAPIRequest } from '../common/request.js';
+export type CommerceSearchRequest = FilterableCommerceAPIRequest & QueryParam;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts

@@ -1,12 +1,28 @@
 import { BaseParam, ClientIDParam, ContextParam, DebugParam, LocaleParam, NumberOfResultsParam } from '../../../platform-service-params.js';
+import { AnalyticsParam } from '../../../search/search-api-params.js';
 import { CaseAssistIdParam, FieldsParam } from '../case-assist-params.js';
-export type GetDocumentSuggestionsRequest = BaseParam & CaseAssistIdParam & ClientIDParam & LocaleParam & FieldsParam & ContextParam & NumberOfResultsParam & DebugParam;
+export type GetDocumentSuggestionsRequest = BaseParam & CaseAssistIdParam & ClientIDParam & LocaleParam & FieldsParam & ContextParam & NumberOfResultsParam & DebugParam & AnalyticsParam;
 export declare const buildGetDocumentSuggestionsRequest: (req: GetDocumentSuggestionsRequest) => {
     requestParams: {
         clientId: string | undefined;
         locale: string | undefined;
         fields: import("../case-assist-params.js").CaseFields;
         context: Record<string, string | string[]> | undefined;
+        analytics: {
+            actionCause?: string;
+            customData?: object;
+            clientId: string;
+            deviceId?: string;
+            pageId?: string;
+            clientTimestamp: string;
+            documentReferrer: string | null;
+            originContext: string;
+            userDisplayName?: string;
+            documentLocation?: string | null;
+            trackingId?: string;
+            capture?: boolean;
+            source?: string[];
+        } | undefined;
     };
     url: string;
     accessToken: string;

package/force-app/main/default/staticresources/coveoheadless/definitions/app/navigatorContextProvider.d.ts

@@ -20,6 +20,12 @@ export interface NavigatorContext {
      * See [clientId](https://docs.coveo.com/en/masb0234).
      */
     clientId: string;
+    /**
+     * Whether to capture analytics events.
+     *
+     * Must be left undefined or set to `false` if the `clientId` is an empty string, otherwise requests will fail.
+     */
+    capture?: boolean;
 }
 export type NavigatorContextProvider = () => NavigatorContext;
 export type BrowserNavigatorContextProvider = (clientId: string) => NavigatorContext;

package/force-app/main/default/staticresources/coveoheadless/definitions/commerce.index.d.ts

@@ -119,11 +119,16 @@ export type { RedirectionTrigger, RedirectionTriggerState, } from './controllers
 export { buildRedirectionTrigger } from './controllers/commerce/triggers/headless-redirection-trigger.js';
 export type { QueryTrigger, QueryTriggerState, } from './controllers/core/triggers/headless-core-query-trigger.js';
 export { buildQueryTrigger } from './controllers/commerce/triggers/headless-query-trigger.js';
-export type { FieldSuggestions, FieldSuggestionsState, } from './controllers/commerce/field-suggestions/headless-field-suggestions.js';
 export type { CategoryFieldSuggestions, CategoryFieldSuggestionsState, } from './controllers/commerce/field-suggestions/headless-category-field-suggestions.js';
 export type { FieldSuggestionsGenerator, GeneratedFieldSuggestionsControllers, } from './controllers/commerce/field-suggestions/headless-field-suggestions-generator.js';
 export type { FieldSuggestionsFacet } from './features/commerce/facets/field-suggestions-order/field-suggestions-order-state.ts';
 export { buildFieldSuggestionsGenerator } from './controllers/commerce/field-suggestions/headless-field-suggestions-generator.js';
+export type { FilterSuggestionsGenerator, GeneratedFilterSuggestionsControllers, } from './controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
+export { buildFilterSuggestionsGenerator } from './controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
+export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, } from './controllers/commerce/filter-suggestions/headless-category-filter-suggestions.js';
+export { buildCategoryFilterSuggestions } from './controllers/commerce/filter-suggestions/headless-category-filter-suggestions.js';
+export type { FilterSuggestions, FilterSuggestionsState, } from './controllers/commerce/filter-suggestions/headless-filter-suggestions.js';
+export { buildFilterSuggestions } from './controllers/commerce/filter-suggestions/headless-filter-suggestions.js';
 export type { ParameterManager, ParameterManagerState, ParameterManagerProps, ParameterManagerInitialState, } from './controllers/commerce/core/parameter-manager/headless-core-parameter-manager.js';
 export type { Parameters } from './features/commerce/parameters/parameters-actions.js';
 export type { SearchParameters } from './features/search-parameters/search-parameter-actions.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/field-suggestions/headless-category-field-suggestions.d.ts

@@ -1,5 +1,5 @@
-import { FieldSuggestionsFacet } from '../../../api/commerce/search/query-suggest/query-suggest-response.js';
 import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
+import { FieldSuggestionsFacet } from '../../../features/commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
 import { Controller } from '../../controller/headless-controller.js';
 import { CategoryFieldSuggestionsState as CoreCategoryFieldSuggestionsState, CategoryFieldSuggestionsValue } from '../../field-suggestions/category-facet/headless-category-field-suggestions.js';
 import { CategoryFacetOptions } from '../core/facets/category/headless-commerce-category-facet.js';
@@ -10,6 +10,8 @@ export type { CategoryFieldSuggestionsValue };
  *
  * @group Buildable controllers
  * @category CategoryFieldSuggestions
+ * @alpha
+ * @deprecated
  */
 export type CategoryFieldSuggestionsState = CoreCategoryFieldSuggestionsState & Pick<FieldSuggestionsFacet, 'facetId' | 'displayName' | 'field'>;
 /**
@@ -21,6 +23,8 @@ export type CategoryFieldSuggestionsState = CoreCategoryFieldSuggestionsState &
  *
  * @group Buildable controllers
  * @category CategoryFieldSuggestions
+ * @alpha
+ * @deprecated
  */
 export interface CategoryFieldSuggestions extends Controller, FacetControllerType<'hierarchical'> {
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/field-suggestions/headless-field-suggestions-generator.d.ts

@@ -2,13 +2,18 @@ import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js'
 import { FieldSuggestionsFacet } from '../../../features/commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
 import { Controller } from '../../controller/headless-controller.js';
 import { CategoryFieldSuggestions } from './headless-category-field-suggestions.js';
-import { FieldSuggestions } from './headless-field-suggestions.js';
-export type GeneratedFieldSuggestionsControllers = Array<FieldSuggestions | CategoryFieldSuggestions>;
+/**
+ * @alpha
+ * @deprecated
+ */
+export type GeneratedFieldSuggestionsControllers = Array<CategoryFieldSuggestions>;
 /**
  * The `FieldSuggestionsGenerator` controller is responsible for generating field suggestions controllers for a given commerce engine.
  *
  * @group Buildable controllers
  * @category FieldSuggestionsGenerator
+ * @alpha
+ * @deprecated
  */
 export interface FieldSuggestionsGenerator extends Controller {
     /**
@@ -27,5 +32,7 @@ export interface FieldSuggestionsGenerator extends Controller {
  *
  * @group Buildable controllers
  * @category FieldSuggestionsGenerator
+ * @alpha
+ * @deprecated
  */
 export declare function buildFieldSuggestionsGenerator(engine: CommerceEngine): FieldSuggestionsGenerator;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-category-filter-suggestions.d.ts

@@ -0,0 +1,87 @@
+import { FieldSuggestionsFacet } from '../../../api/commerce/search/query-suggest/query-suggest-response.js';
+import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
+import { Controller } from '../../controller/headless-controller.js';
+import { CategoryFieldSuggestionsState as CoreCategoryFieldSuggestionsState, CategoryFieldSuggestionsValue } from '../../field-suggestions/category-facet/headless-category-field-suggestions.js';
+import { CategoryFacetOptions } from '../core/facets/category/headless-commerce-category-facet.js';
+import { FacetControllerType } from '../core/facets/headless-core-commerce-facet.js';
+export type { CategoryFieldSuggestionsValue };
+/**
+ * The state of the `CategoryFilterSuggestions` controller.
+ *
+ * @group Buildable controllers
+ * @category CategoryFilterSuggestions
+ */
+export type CategoryFilterSuggestionsState = CoreCategoryFieldSuggestionsState & Pick<FieldSuggestionsFacet, 'facetId' | 'displayName' | 'field'>;
+/**
+ * The `CategoryFilterSuggestions` controller provides methods to request and interact with category facet suggestions
+ * based on a specific field for a given search query.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to
+ * use this feature in an implementation, please contact your Coveo representative.
+ *
+ * @group Buildable controllers
+ * @category CategoryFilterSuggestions
+ */
+export interface CategoryFilterSuggestions extends Controller, FacetControllerType<'hierarchical'> {
+    /**
+     * Resets the query in the controller state and clears the category filter suggestions.
+     */
+    clear(): void;
+    /**
+     * Returns the serialized search parameters for the current search query and specified category filter suggestion.
+     *
+     * For example, `q=jeans&cf-ec-category=Clothes,Pants`.
+     *
+     * In a typical scenario, this method should called when the user selects a category filter suggestion from a
+     * standalone search box. The returned string is then used to pass the correct URL query parameters or fragment when
+     * redirecting the browser to the search page.
+     *
+     * When the user selects a category filter suggestion from the main search box on the search page, use the `select`
+     * method instead.
+     *
+     * @param value - The category filter suggestion to serialize.
+     * @returns The serialized search parameters for the current search query and specified category filter suggestion.
+     */
+    getSearchParameters(value: CategoryFieldSuggestionsValue): string;
+    /**
+     * Clears all facet values, selects the specified category filter suggestion, updates the query, and executes a new
+     * search request.
+     *
+     * In a typical scenario, this method should be called when the user selects a category filter suggestion from the
+     * main search box on the search page.
+     *
+     * When the user selects a category filter suggestion from a standalone search box, use the `getSearchParameters`
+     * method instead.
+     *
+     * @param value - The category filter suggestion to select.
+     */
+    select(value: CategoryFieldSuggestionsValue): void;
+    /**
+     * Sets the query in the controller state to the specified value and requests category filter suggestions based on the
+     * updated query.
+     *
+     * For example, if this method is called with `jeans` as an argument, it will request values from the controller's
+     * field (e.g., `ec_category`) that would return results if selected when the search query is `jeans` (such as
+     * `Clothing`, `Clothing;Pants`, and `Clothing;Shorts`).
+     *
+     * @param query - The search query to use as context to request the category filter suggestions. In a typical
+     * scenario, this should set to the current value of the search box input.
+     */
+    updateQuery(query: string): void;
+    state: CategoryFilterSuggestionsState;
+}
+/**
+ * The `CategoryFilterSuggestions` controller provides methods to request and interact with category facet suggestions
+ * based on a specific field for a given search query.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to
+ * use this feature in an implementation, please contact your Coveo representative.
+ *
+ * @param engine - The headless commerce engine.
+ * @param options - The options for the `CategoryFilterSuggestions` controller.
+ * @returns A `CategoryFilterSuggestions` controller instance.
+ *
+ * @group Buildable controllers
+ * @category CategoryFilterSuggestions
+ */
+export declare function buildCategoryFilterSuggestions(engine: CommerceEngine, options: CategoryFacetOptions): CategoryFilterSuggestions;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.d.ts

@@ -0,0 +1,38 @@
+import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
+import { FieldSuggestionsFacet } from '../../../features/commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
+import { Controller } from '../../controller/headless-controller.js';
+import { CategoryFilterSuggestions } from './headless-category-filter-suggestions.js';
+import { FilterSuggestions } from './headless-filter-suggestions.js';
+export type GeneratedFilterSuggestionsControllers = Array<FilterSuggestions | CategoryFilterSuggestions>;
+/**
+ * The `FilterSuggestionsGenerator` controller is responsible for generating filter suggestions controllers for a given
+ * commerce engine.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to use this
+ * feature in an implementation, please contact your Coveo representative.
+ *
+ * @group Buildable controllers
+ * @category FilterSuggestionsGenerator
+ */
+export interface FilterSuggestionsGenerator extends Controller {
+    /**
+     * The filter suggestions controllers created by the filter suggestions generator.
+     */
+    filterSuggestions: GeneratedFilterSuggestionsControllers;
+    /**
+     * The state of the filter suggestions generator.
+     */
+    state: FieldSuggestionsFacet[];
+}
+/**
+ * Builds a filter suggestions generator controller for a given commerce engine.
+ * @param engine - The commerce engine.
+ * @returns The filter suggestions generator controller.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to
+ * use this feature in an implementation, please contact your Coveo representative.
+ *
+ * @group Buildable controllers
+ * @category FilterSuggestionsGenerator
+ */
+export declare function buildFilterSuggestionsGenerator(engine: CommerceEngine): FilterSuggestionsGenerator;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.ssr.d.ts

@@ -0,0 +1,16 @@
+import { NonRecommendationControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
+import { FilterSuggestionsGenerator } from './headless-filter-suggestions-generator.js';
+export type { FilterSuggestions, FilterSuggestionsState, } from './headless-filter-suggestions.js';
+export type { CategoryFilterSuggestions, CategoryFilterSuggestionsState, } from './headless-category-filter-suggestions.js';
+export type { FieldSuggestionsFacet } from '../../../features/commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
+export type { GeneratedFilterSuggestionsControllers as GeneratedFilterSuggestionsControllers } from './headless-filter-suggestions-generator.js';
+export type { FilterSuggestionsGenerator as FilterSuggestionsGenerator };
+export interface FilterSuggestionsGeneratorDefinition extends NonRecommendationControllerDefinitionWithoutProps<FilterSuggestionsGenerator> {
+}
+/**
+ * Defines the `FilterSuggestionsGenerator` controller for the purpose of server-side rendering.
+ * @group Definers
+ *
+ * @returns The `FilterSuggestionsGenerator` controller definition.
+ */
+export declare function defineFilterSuggestionsGenerator(): FilterSuggestionsGeneratorDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/filter-suggestions/headless-filter-suggestions.d.ts

@@ -0,0 +1,88 @@
+import { FieldSuggestionsFacet } from '../../../api/commerce/search/query-suggest/query-suggest-response.js';
+import { SpecificFacetSearchResult } from '../../../api/search/facet-search/specific-facet-search/specific-facet-search-response.js';
+import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
+import { Controller } from '../../controller/headless-controller.js';
+import { FacetControllerType } from '../core/facets/headless-core-commerce-facet.js';
+import { RegularFacetSearchState } from '../core/facets/regular/headless-commerce-regular-facet-search.js';
+import { RegularFacetOptions } from '../core/facets/regular/headless-commerce-regular-facet.js';
+export type { SpecificFacetSearchResult };
+/**
+ * The state of the `FilterSuggestions` controller.
+ *
+ * @group Buildable controllers
+ * @category FilterSuggestions
+ */
+export type FilterSuggestionsState = RegularFacetSearchState & Pick<FieldSuggestionsFacet, 'facetId' | 'displayName' | 'field'>;
+/**
+ * The `FilterSuggestions` controller provides methods to request and interact with facet suggestions based on a
+ * specific field for a given search query.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to
+ * use this feature in an implementation, please contact your Coveo representative.
+ *
+ * @group Buildable controllers
+ * @category FilterSuggestions
+ */
+export interface FilterSuggestions extends Controller, FacetControllerType<'regular'> {
+    /**
+     * Resets the query in the controller state and clears the filter suggestions.
+     */
+    clear(): void;
+    /**
+     * Returns the serialized search parameters for the current search query and specified filter suggestion.
+     *
+     * For example, `q=jeans&f-cat_color=Blue`.
+     *
+     * In a typical scenario, this method should be called when the user selects a filter suggestion from a standalone
+     * search box. The returned string is then used to pass the correct URL query parametes or fragment when redirecting
+     * the browser to the search page.
+     *
+     * When the user selects a filter suggestion from the main search box on the search page, use the `select` method
+     * instead.
+     *
+     * @param value - The filter suggestion to serialize.
+     * @returns The serialized search parameters for the current search query and specified filter suggestion.
+     */
+    getSearchParameters(value: SpecificFacetSearchResult): string;
+    /**
+     * Clears all facet values, selects the specified filter suggestion, updates the query, and executes a new search
+     * request.
+     *
+     * In a typical scenario, this method should be called when the user selects a filter suggestion from the main search
+     * box on the search page.
+     *
+     * When the user selects a filter suggestion from a standalone search box, use the `getSearchParameters` method
+     * instead.
+     *
+     * @param value - The filter suggestion to select.
+     */
+    select(value: SpecificFacetSearchResult): void;
+    /**
+     * Sets the query in the controller state to the specified value and requests filter suggestions based on the updated
+     * query.
+     *
+     * For example, if this method is called with `jeans` as an argument, it will request values from the controller's
+     * field (e.g., `ec_brand`) that would return results if selected when the search query is `jeans` (such as
+     * `Calvin Klein`, `Columbia`, and `Nautica`).
+     *
+     * @param query - The search query to use as context to request the category filter suggestions. In a typical
+     * scenario, this should set to the current value of the search box input.
+     */
+    updateQuery(query: string): void;
+    state: FilterSuggestionsState;
+}
+/**
+ * The `FilterSuggestions` controller provides methods to request and interact with facet suggestions based on a
+ * specific field for a given search query.
+ *
+ * @alpha  This controller relies on a Commerce API functionality that is not yet generally available. If you wish to use this
+ * feature in an implementation, please contact your Coveo representative.
+ *
+ * @param engine - The headless commerce engine.
+ * @param options - The options for the `FilterSuggestions` controller.
+ * @returns A `FilterSuggestions` controller instance.
+ *
+ * @group Buildable controllers
+ * @category FilterSuggestions
+ */
+export declare function buildFilterSuggestions(engine: CommerceEngine, options: RegularFacetOptions): FilterSuggestions;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/search-action-cause.d.ts

@@ -87,6 +87,10 @@ export declare enum SearchPageEvents {
      * Identifies the search event that gets logged when the sort criteria on a facet is updated.
      */
     facetUpdateSort = "facetUpdateSort",
+    /**
+     * Identifies the search event that gets logged when the document suggestions are fetched.
+     */
+    documentSuggestion = "documentSuggestion",
     /**
      * The custom event that gets logged when an end-user expands a facet to see additional values.
      */

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/common/base-commerce-api-request-builder.d.ts

@@ -0,0 +1,5 @@
+import { BaseCommerceAPIRequest } from '../../../api/commerce/common/request.js';
+import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
+import { CartSection, CommerceConfigurationSection, CommerceContextSection, VersionSection } from '../../../state/state-sections.js';
+export type StateNeededForBaseCommerceAPIRequest = CommerceConfigurationSection & CommerceContextSection & CartSection & Partial<VersionSection>;
+export declare const buildBaseCommerceAPIRequest: (state: StateNeededForBaseCommerceAPIRequest, navigatorContext: NavigatorContext) => BaseCommerceAPIRequest;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/common/filterable-commerce-api-request-builder.d.ts

@@ -0,0 +1,6 @@
+import { FilterableCommerceAPIRequest } from '../../../api/commerce/common/request.js';
+import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
+import { CommerceFacetSetSection, CommerceSortSection, FacetOrderSection, ManualRangeSection } from '../../../state/state-sections.js';
+import { StateNeededForPaginatedCommerceAPIRequest } from './paginated-commerce-api-request-builder.js';
+export type StateNeededForFilterableCommerceAPIRequest = StateNeededForPaginatedCommerceAPIRequest & Partial<CommerceSortSection & CommerceFacetSetSection & FacetOrderSection & ManualRangeSection>;
+export declare const buildFilterableCommerceAPIRequest: (state: StateNeededForFilterableCommerceAPIRequest, navigatorContext: NavigatorContext) => FilterableCommerceAPIRequest;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/common/paginated-commerce-api-request-builder.d.ts

@@ -0,0 +1,6 @@
+import { PaginatedCommerceAPIRequest } from '../../../api/commerce/common/request.js';
+import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
+import { CommercePaginationSection } from '../../../state/state-sections.js';
+import { StateNeededForBaseCommerceAPIRequest } from './base-commerce-api-request-builder.js';
+export type StateNeededForPaginatedCommerceAPIRequest = StateNeededForBaseCommerceAPIRequest & Partial<CommercePaginationSection>;
+export declare const buildPaginatedCommerceAPIRequest: (state: StateNeededForPaginatedCommerceAPIRequest, navigatorContext: NavigatorContext, slotId?: string) => PaginatedCommerceAPIRequest;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/facets/facet-search-set/commerce-facet-search-state.d.ts

@@ -1,6 +1,6 @@
 import { CommerceFacetSetSection, CommerceQuerySection } from '../../../../state/state-sections.js';
-import { StateNeededByQueryCommerceAPI } from '../../common/actions.js';
+import { StateNeededForPaginatedCommerceAPIRequest } from '../../common/paginated-commerce-api-request-builder.js';
 import { StateNeededForCategoryFacetSearch } from './category/commerce-category-facet-search-state.js';
 import { StateNeededForRegularFacetSearch } from './regular/commerce-regular-facet-search-state.js';
-export type CoreStateNeededForFacetSearch = StateNeededByQueryCommerceAPI & CommerceFacetSetSection & Partial<CommerceQuerySection>;
+export type CoreStateNeededForFacetSearch = StateNeededForPaginatedCommerceAPIRequest & CommerceFacetSetSection & Partial<CommerceQuerySection>;
 export type StateNeededForAnyFacetSearch = StateNeededForRegularFacetSearch | StateNeededForCategoryFacetSearch;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-listing/product-listing-actions-loader.d.ts

@@ -1,8 +1,7 @@
 import { AsyncThunkAction, PayloadAction } from '@reduxjs/toolkit';
 import { AsyncThunkCommerceOptions } from '../../../api/commerce/commerce-api-client.js';
 import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
-import { QueryCommerceAPIThunkReturn } from '../common/actions.js';
-import { PromoteChildToParentPayload, StateNeededByFetchProductListing } from './product-listing-actions.js';
+import { PromoteChildToParentPayload, QueryCommerceAPIThunkReturn, StateNeededByFetchProductListing } from './product-listing-actions.js';
 /**
  * The product listing action creators.
  *

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/product-listing/product-listing-actions.d.ts

@@ -1,8 +1,13 @@
 import { RecordValue } from '@coveo/bueno';
 import { ChildProduct } from '../../../api/commerce/common/product.js';
+import { CommerceSuccessResponse } from '../../../api/commerce/common/response.js';
 import { ProductListingSection } from '../../../state/state-sections.js';
-import { QueryCommerceAPIThunkReturn, ListingAndSearchStateNeededByQueryCommerceAPI } from '../common/actions.js';
-export type StateNeededByFetchProductListing = ListingAndSearchStateNeededByQueryCommerceAPI & ProductListingSection;
+import { StateNeededForFilterableCommerceAPIRequest } from '../common/filterable-commerce-api-request-builder.js';
+export interface QueryCommerceAPIThunkReturn {
+    /** The successful response. */
+    response: CommerceSuccessResponse;
+}
+export type StateNeededByFetchProductListing = StateNeededForFilterableCommerceAPIRequest & ProductListingSection;
 export declare const fetchProductListing: import("@reduxjs/toolkit").AsyncThunk<QueryCommerceAPIThunkReturn, void, {
     state: StateNeededByFetchProductListing;
     rejectValue: import("../../../api/commerce/commerce-api-error-response.js").CommerceAPIErrorStatusResponse;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/query-suggest/query-suggest-actions.d.ts

@@ -1,6 +1,4 @@
-import { QuerySuggestRequest } from '../../../api/commerce/search/query-suggest/query-suggest-request.js';
 import { QuerySuggestSuccessResponse } from '../../../api/commerce/search/query-suggest/query-suggest-response.js';
-import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
 import { CartSection, CommerceContextSection, CommerceQuerySection, CommerceConfigurationSection, QuerySetSection, VersionSection } from '../../../state/state-sections.js';
 import { ClearQuerySuggestActionCreatorPayload, FetchQuerySuggestionsActionCreatorPayload, RegisterQuerySuggestActionCreatorPayload, SelectQuerySuggestionActionCreatorPayload } from '../../query-suggest/query-suggest-actions.js';
 export type ClearQuerySuggestPayload = ClearQuerySuggestActionCreatorPayload;
@@ -27,4 +25,3 @@ export type RegisterQuerySuggestPayload = RegisterQuerySuggestActionCreatorPaylo
 export declare const registerQuerySuggest: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: RegisterQuerySuggestActionCreatorPayload], RegisterQuerySuggestActionCreatorPayload, "commerce/querySuggest/register", never, never>;
 export type SelectQuerySuggestionPayload = SelectQuerySuggestionActionCreatorPayload;
 export declare const selectQuerySuggestion: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SelectQuerySuggestionActionCreatorPayload], SelectQuerySuggestionActionCreatorPayload, "commerce/querySuggest/selectSuggestion", never, never>;
-export declare const buildQuerySuggestRequest: (id: string, state: StateNeededByQuerySuggest, navigatorContext: NavigatorContext) => QuerySuggestRequest;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/query-suggest/query-suggest-request-builder.d.ts

@@ -0,0 +1,4 @@
+import { QuerySuggestRequest } from '../../../api/commerce/search/query-suggest/query-suggest-request.js';
+import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
+import { StateNeededByQuerySuggest } from './query-suggest-actions.js';
+export declare const buildQuerySuggestRequest: (id: string, state: StateNeededByQuerySuggest, navigatorContext: NavigatorContext) => QuerySuggestRequest;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/recommendations/recommendations-actions.d.ts

@@ -2,12 +2,12 @@ import { RecordValue, StringValue } from '@coveo/bueno';
 import { ChildProduct } from '../../../api/commerce/common/product.js';
 import { RecommendationsCommerceSuccessResponse } from '../../../api/commerce/recommendations/recommendations-response.js';
 import { RecommendationsSection } from '../../../state/state-sections.js';
-import { StateNeededByQueryCommerceAPI } from '../common/actions.js';
+import { StateNeededForPaginatedCommerceAPIRequest } from '../common/paginated-commerce-api-request-builder.js';
 export interface QueryRecommendationsCommerceAPIThunkReturn {
     /** The successful recommendations response. */
     response: RecommendationsCommerceSuccessResponse;
 }
-export type StateNeededByFetchRecommendations = StateNeededByQueryCommerceAPI & RecommendationsSection;
+export type StateNeededByFetchRecommendations = StateNeededForPaginatedCommerceAPIRequest & RecommendationsSection;
 export interface FetchRecommendationsPayload {
     /**
      * The unique identifier of the recommendations slot (e.g., `b953ab2e-022b-4de4-903f-68b2c0682942`).

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/search/search-actions-thunk-processor.d.ts

@@ -2,20 +2,20 @@ import { UnknownAction } from '@reduxjs/toolkit';
 import { ThunkDispatch } from 'redux-thunk';
 import { CommerceAPIClient, CommerceAPIResponse } from '../../../api/commerce/commerce-api-client.js';
 import { CommerceAPIErrorStatusResponse } from '../../../api/commerce/commerce-api-error-response.js';
-import { CommerceAPIRequest } from '../../../api/commerce/common/request.js';
+import { FilterableCommerceAPIRequest } from '../../../api/commerce/common/request.js';
 import { CommerceSearchRequest } from '../../../api/commerce/search/request.js';
 import { SearchCommerceSuccessResponse } from '../../../api/commerce/search/response.js';
 import { ClientThunkExtraArguments } from '../../../app/thunk-extra-arguments.js';
 import { CommerceSearchSection, CommerceQuerySection, CommerceDidYouMeanSection, TriggerSection } from '../../../state/state-sections.js';
-import { ListingAndSearchStateNeededByQueryCommerceAPI } from '../common/actions.js';
+import { StateNeededForFilterableCommerceAPIRequest } from '../common/filterable-commerce-api-request-builder.js';
 import { QuerySearchCommerceAPIThunkReturn } from './search-actions.js';
 interface FetchedResponse {
     response: CommerceAPIResponse<SearchCommerceSuccessResponse>;
     duration: number;
     queryExecuted: string;
-    requestExecuted: CommerceAPIRequest;
+    requestExecuted: FilterableCommerceAPIRequest;
 }
-export type StateNeededByExecuteSearch = ListingAndSearchStateNeededByQueryCommerceAPI & CommerceSearchSection & CommerceQuerySection & CommerceDidYouMeanSection & TriggerSection;
+export type StateNeededByExecuteSearch = StateNeededForFilterableCommerceAPIRequest & CommerceSearchSection & CommerceQuerySection & CommerceDidYouMeanSection & TriggerSection;
 export interface AsyncThunkConfig {
     getState: () => StateNeededByExecuteSearch;
     dispatch: ThunkDispatch<StateNeededByExecuteSearch, ClientThunkExtraArguments<CommerceAPIClient> & {
@@ -29,11 +29,11 @@ export declare class AsyncSearchThunkProcessor<RejectionType> {
     private config;
     constructor(config: AsyncThunkConfig);
     process(fetched: FetchedResponse): Promise<ValidReturnTypeFromProcessingStep<RejectionType>>;
-    fetchFromAPI(request: CommerceAPIRequest | CommerceSearchRequest): Promise<{
+    fetchFromAPI(request: FilterableCommerceAPIRequest | CommerceSearchRequest): Promise<{
         response: CommerceAPIResponse<SearchCommerceSuccessResponse>;
         duration: number;
         queryExecuted: string;
-        requestExecuted: CommerceAPIRequest | CommerceSearchRequest;
+        requestExecuted: FilterableCommerceAPIRequest | CommerceSearchRequest;
     }>;
     private processSuccessResponse;
     private processQueryErrorOrContinue;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/plan-request-builder.d.ts

@@ -0,0 +1,8 @@
+import { PageParam, PerPageParam, QueryParam } from '../../../api/commerce/commerce-api-params.js';
+import { BaseCommerceAPIRequest } from '../../../api/commerce/common/request.js';
+import { NavigatorContext } from '../../../app/navigatorContextProvider.js';
+import { CommerceQuerySection } from '../../../state/state-sections.js';
+import { StateNeededForBaseCommerceAPIRequest } from '../common/base-commerce-api-request-builder.js';
+export type StateNeededForPlanCommerceAPIRequest = StateNeededForBaseCommerceAPIRequest & CommerceQuerySection;
+export type CommercePlanRequest = BaseCommerceAPIRequest & QueryParam & PageParam & PerPageParam;
+export declare const buildPlanRequest: (state: StateNeededForPlanCommerceAPIRequest, navigatorContext: NavigatorContext) => CommercePlanRequest;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/standalone-search-box-set-actions-loader.d.ts

@@ -1,7 +1,8 @@
 import { AsyncThunkAction, PayloadAction } from '@reduxjs/toolkit';
 import { AsyncThunkCommerceOptions } from '../../../api/commerce/commerce-api-client.js';
 import { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
-import { FetchRedirectUrlPayload, RegisterStandaloneSearchBoxPayload, ResetStandaloneSearchBoxPayload, StateNeededForRedirect } from './standalone-search-box-set-actions.js';
+import { StateNeededForPlanCommerceAPIRequest } from './plan-request-builder.js';
+import { FetchRedirectUrlPayload, RegisterStandaloneSearchBoxPayload, ResetStandaloneSearchBoxPayload } from './standalone-search-box-set-actions.js';
 export type { FetchRedirectUrlPayload, RegisterStandaloneSearchBoxPayload, ResetStandaloneSearchBoxPayload, };
 /**
  * The commerce standalone search box set action creators.
@@ -16,7 +17,7 @@ export interface StandaloneSearchBoxSetActionCreators {
      * @param payload - The action creator payload.
      * @returns A dispatchable action.
      */
-    fetchRedirectUrl(payload: FetchRedirectUrlPayload): AsyncThunkAction<string, FetchRedirectUrlPayload, AsyncThunkCommerceOptions<StateNeededForRedirect>>;
+    fetchRedirectUrl(payload: FetchRedirectUrlPayload): AsyncThunkAction<string, FetchRedirectUrlPayload, AsyncThunkCommerceOptions<StateNeededForPlanCommerceAPIRequest>>;
     /**
      * Registers a standalone search box.
      *