@coveo/quantic 3.33.6 → 3.34.1

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

@@ -5,9 +5,12 @@ import type { PlatformEnvironment } from '../../utils/url-utils.js';
 import type { PreprocessRequest } from '../preprocess-request.js';
 import type { SpecificFacetSearchResponse } from '../search/facet-search/specific-facet-search/specific-facet-search-response.js';
 import type { CommerceAPIErrorResponse, CommerceAPIErrorStatusResponse } from './commerce-api-error-response.js';
-import { type FilterableCommerceAPIRequest } from './common/request.js';
 import type { CommerceSuccessResponse } from './common/response.js';
 import type { CommerceFacetSearchRequest, FacetSearchType } from './facet-search/facet-search-request.js';
+import type { CommerceListingRequest } from './listing/request.js';
+import type { ListingCommerceSuccessResponse } from './listing/response.js';
+import { type ProductEnrichmentBadgesRequest } from './product-enrichment/product-enrichment-request.js';
+import type { ProductEnrichmentSuccessBadgesResponse } from './product-enrichment/product-enrichment-response.js';
 import { type CommerceRecommendationsRequest } from './recommendations/recommendations-request.js';
 import type { RecommendationsCommerceSuccessResponse } from './recommendations/recommendations-response.js';
 import { type QuerySuggestRequest } from './search/query-suggest/query-suggest-request.js';
@@ -34,12 +37,13 @@ export declare const isErrorResponse: <T>(r: CommerceAPIResponse<T>) => r is Com
 export declare class CommerceAPIClient implements CommerceFacetSearchAPIClient {
     private options;
     constructor(options: CommerceAPIClientOptions);
-    getProductListing(req: FilterableCommerceAPIRequest): Promise<CommerceAPIResponse<CommerceSuccessResponse>>;
+    getProductListing(req: CommerceListingRequest): Promise<CommerceAPIResponse<ListingCommerceSuccessResponse>>;
     search(req: CommerceSearchRequest): Promise<CommerceAPIResponse<SearchCommerceSuccessResponse>>;
     getRecommendations(req: CommerceRecommendationsRequest): Promise<CommerceAPIResponse<RecommendationsCommerceSuccessResponse>>;
     productSuggestions(req: CommerceSearchRequest): Promise<CommerceAPIResponse<SearchCommerceSuccessResponse>>;
     querySuggest(req: QuerySuggestRequest): Promise<CommerceAPIResponse<QuerySuggestSuccessResponse>>;
     facetSearch(req: CommerceFacetSearchRequest, type: FacetSearchType): Promise<CommerceAPIResponse<SpecificFacetSearchResponse>>;
+    getBadges(req: ProductEnrichmentBadgesRequest): Promise<CommerceAPIResponse<ProductEnrichmentSuccessBadgesResponse>>;
     plan(req: CommerceSearchRequest): Promise<CommerceAPIResponse<CommerceSuccessResponse>>;
     private query;
 }

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

@@ -18,6 +18,9 @@ export interface ClientIdParam {
 export interface ContextParam {
     context: ContextParams;
 }
+export interface EnableResultsParam {
+    enableResults: boolean;
+}
 type ProductParam = {
     productId: string;
 };
@@ -79,4 +82,7 @@ export interface IgnorePathsParam {
 export interface SlotIdParam {
     slotId: string;
 }
+export interface PlacementIdsParam {
+    placementIds?: string[];
+}
 export {};

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

@@ -1 +1,7 @@
-export type CommerceApiMethod = 'listing' | 'search' | 'recommendations' | 'search/productSuggest' | 'search/querySuggest' | 'querySuggest' | 'facet';
+export type CommerceApiMethod = 'listing' | 'search' | 'recommendations' | 'search/productSuggest' | 'search/querySuggest' | 'querySuggest' | 'facet' | 'badges';
+/**
+ * API methods that require the tracking ID to be included in the URL path.
+ * These endpoints use the pattern: /tracking-ids/{trackingId}/{method}
+ * All other endpoints use: /{method}
+ */
+export declare const TRACKING_ID_IN_PATH_METHODS: readonly CommerceApiMethod[];

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

@@ -1,4 +1,5 @@
 import type { HighlightKeyword } from '../../../utils/highlight.js';
+import type { ResultPosition, ResultType } from './result.js';
 export type ChildProduct = Omit<BaseProduct, 'children' | 'totalNumberOfChildren'>;
 export interface BaseProduct {
     /**
@@ -134,12 +135,10 @@ export interface BaseProduct {
      * The ID of the response that returned the product.
      */
     responseId?: string;
-}
-export interface Product extends BaseProduct {
     /**
-     * The 1-based product's position across the non-paginated result set.
-     *
-     * For example, if the product is the third one on the second page, and there are 10 products per page, its position is 13 (not 3).
+     * The result type of the product.
      */
-    position: number;
+    resultType: ResultType.PRODUCT | ResultType.CHILD_PRODUCT;
+}
+export interface Product extends ResultPosition, BaseProduct {
 }

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

@@ -1,7 +1,7 @@
 import type { PlatformClientCallOptions } from '../../platform-client.js';
 import type { BaseParam } from '../../platform-service-params.js';
 import type { ClientIdParam, ContextParam, CountryParam, CurrencyParam, FacetsParam, LanguageParam, PageParam, PerPageParam, SortParam, TrackingIdParam } from '../commerce-api-params.js';
-import type { CommerceApiMethod } from '../commerce-metadata.js';
+import { type CommerceApiMethod } from '../commerce-metadata.js';
 export type BaseCommerceAPIRequest = BaseParam & TrackingIdParam & LanguageParam & CountryParam & CurrencyParam & ClientIdParam & ContextParam;
 export type PaginatedCommerceAPIRequest = BaseCommerceAPIRequest & PageParam & PerPageParam;
 export type FilterableCommerceAPIRequest = PaginatedCommerceAPIRequest & FacetsParam & SortParam;
@@ -35,4 +35,4 @@ export declare const getRequestOptions: (req: FilterableCommerceAPIRequest, path
     contentType: import("../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };
-export declare const baseRequest: (req: BaseParam, path: CommerceApiMethod) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin" | "requestMetadata">;
+export declare const baseRequest: (req: BaseCommerceAPIRequest, path: CommerceApiMethod) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin" | "requestMetadata">;

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

@@ -0,0 +1,52 @@
+import type { BaseProduct, Product } from './product.js';
+export declare enum ResultType {
+    CHILD_PRODUCT = "childProduct",
+    PRODUCT = "product",
+    SPOTLIGHT = "spotlight"
+}
+export interface BaseSpotlightContent {
+    /**
+     * The unique identifier of the spotlight content.
+     */
+    id: string;
+    /**
+     * The URI to navigate to when the spotlight content is clicked.
+     */
+    clickUri: string;
+    /**
+     * The image URL for desktop display.
+     */
+    desktopImage: string;
+    /**
+     * The image URL for mobile display.
+     */
+    mobileImage?: string;
+    /**
+     * The name of the spotlight content.
+     */
+    name?: string;
+    /**
+     * The description of the spotlight content.
+     */
+    description?: string;
+    /**
+     * The ID of the response that returned the spotlight content.
+     */
+    responseId?: string;
+    /**
+     * The result type identifier, always SPOTLIGHT for spotlight content.
+     */
+    resultType: ResultType.SPOTLIGHT;
+}
+export interface ResultPosition {
+    /**
+     * The 1-based result's position across the non-paginated result set.
+     *
+     * For example, if the result is the third one on the second page, and there are 10 results per page, its position is 13 (not 3).
+     */
+    position: number;
+}
+export interface SpotlightContent extends ResultPosition, BaseSpotlightContent {
+}
+export type BaseResult = BaseProduct | BaseSpotlightContent;
+export type Result = Product | SpotlightContent;

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

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

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

@@ -0,0 +1,5 @@
+import type { CommerceSuccessResponse } from '../common/response.js';
+import type { BaseResult } from '../common/result.js';
+export interface ListingCommerceSuccessResponse extends CommerceSuccessResponse {
+    results: BaseResult[];
+}

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

@@ -0,0 +1,29 @@
+import type { PlacementIdsParam } from '../commerce-api-params.js';
+import { type BaseCommerceAPIRequest } from '../common/request.js';
+export type ProductEnrichmentBadgesRequest = BaseCommerceAPIRequest & PlacementIdsParam;
+export declare const buildProductEnrichmentBadgesRequest: (req: ProductEnrichmentBadgesRequest) => {
+    requestParams: {
+        clientId?: string | undefined;
+        language: string;
+        country: string;
+        currency: string;
+        placementIds: string[] | undefined;
+        context: {
+            view: import("../commerce-api-params.js").ViewParams;
+            user?: import("../commerce-api-params.js").UserParams;
+            product?: {
+                productId: string;
+            };
+            cart?: import("../commerce-api-params.js").CartItemParam[];
+            purchased?: import("../commerce-api-params.js").CartItemParam[];
+            capture: boolean;
+            source: string[];
+        };
+    };
+    accessToken: string;
+    url: string;
+    method: import("../../platform-client.js").HttpMethods;
+    origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    contentType: import("../../platform-client.js").HTTPContentType;
+    requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/product-enrichment/product-enrichment-response.d.ts

@@ -0,0 +1,17 @@
+export interface Badge {
+    text: string;
+    backgroundColor: string;
+    textColor: string;
+    iconUrl: string | null;
+}
+export interface BadgePlacement {
+    placementId: string;
+    badges: Badge[];
+}
+export interface BadgesProduct {
+    productId: string;
+    badgePlacements: BadgePlacement[];
+}
+export interface ProductEnrichmentSuccessBadgesResponse {
+    products: BadgesProduct[];
+}

package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/date/date-format.d.ts

@@ -1,4 +1,4 @@
-import dayjs, { type ConfigType } from 'dayjs/esm/index.js';
+import dayjs, { type ConfigType } from 'dayjs';
 /**
  * The date format supported by the Search API.
  */

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

@@ -22,6 +22,8 @@ export type { Relay } from '@coveo/relay';
 export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
 export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
 export type { BaseProduct, ChildProduct, Product, } from './api/commerce/common/product.js';
+export type { BaseResult, Result, SpotlightContent, } from './api/commerce/common/result.js';
+export { ResultType } from './api/commerce/common/result.js';
 export { getAnalyticsNextApiBaseUrl, getOrganizationEndpoint, } from './api/platform-client.js';
 export type { CommerceEngine, CommerceEngineConfiguration, CommerceEngineOptions, } from './app/commerce-engine/commerce-engine.js';
 export { buildCommerceEngine } from './app/commerce-engine/commerce-engine.js';
@@ -42,6 +44,7 @@ export * from './features/commerce/facets/regular-facet/regular-facet-actions-lo
 export * from './features/commerce/instant-products/instant-products-actions-loader.js';
 export * from './features/commerce/pagination/pagination-actions-loader.js';
 export * from './features/commerce/product/product-actions-loaders.js';
+export * from './features/commerce/product-enrichment/product-enrichment-actions-loader.js';
 export * from './features/commerce/product-listing/product-listing-actions-loader.js';
 export * from './features/commerce/product-listing-parameters/product-listing-parameters-actions-loader.js';
 export * from './features/commerce/query/query-actions-loader.js';
@@ -52,12 +55,14 @@ export * from './features/commerce/recommendations/recommendations-actions-loade
 export * from './features/commerce/search/search-actions-loader.js';
 export * from './features/commerce/search-parameters/search-parameters-actions-loader.js';
 export * from './features/commerce/sort/sort-actions-loader.js';
+export * from './features/commerce/spotlight-content/spotlight-content-actions-loaders.js';
 export * from './features/commerce/standalone-search-box-set/standalone-search-box-set-actions-loader.js';
 export * from './features/commerce/triggers/triggers-actions-loader.js';
 export type { HighlightKeyword } from './utils/highlight.js';
 export type { PlatformEnvironment } from './utils/url-utils.js';
 export { Selectors };
 export type { CartItemParam } from './api/commerce/commerce-api-params.js';
+export type { Badge, BadgePlacement, BadgesProduct, } from './api/commerce/product-enrichment/product-enrichment-response.js';
 export type { CategoryFacetSearchResult } from './api/search/facet-search/category-facet-search/category-facet-search-response.js';
 export type { SpecificFacetSearchResult as RegularFacetSearchResult } from './api/search/facet-search/specific-facet-search/specific-facet-search-response.js';
 export type { Cart, CartInitialState, CartItem, CartProps, CartState, } from './controllers/commerce/context/cart/headless-cart.js';
@@ -76,6 +81,7 @@ export type { NumericFacet, NumericFacetState, } from './controllers/commerce/co
 export type { RegularFacet, RegularFacetState, } from './controllers/commerce/core/facets/regular/headless-commerce-regular-facet.js';
 export type { RegularFacetSearch, RegularFacetSearchState, } from './controllers/commerce/core/facets/regular/headless-commerce-regular-facet-search.js';
 export type { InteractiveProduct, InteractiveProductOptions, InteractiveProductProps, } from './controllers/commerce/core/interactive-product/headless-core-interactive-product.js';
+export type { InteractiveSpotlightContent, InteractiveSpotlightContentOptions, InteractiveSpotlightContentProps, } from './controllers/commerce/core/interactive-spotlight-content/headless-core-interactive-spotlight-content.js';
 export type { Pagination, PaginationOptions, PaginationProps, PaginationState, } from './controllers/commerce/core/pagination/headless-core-commerce-pagination.js';
 export type { ParameterManager, ParameterManagerInitialState, ParameterManagerProps, ParameterManagerState, } from './controllers/commerce/core/parameter-manager/headless-core-parameter-manager.js';
 export type { Sort, SortByFields, SortByFieldsFields, SortByRelevance, SortCriterion, SortInitialState, SortProps, SortState, } from './controllers/commerce/core/sort/headless-core-commerce-sort.js';
@@ -94,7 +100,9 @@ export type { FilterSuggestionsGenerator, GeneratedFilterSuggestionsControllers,
 export { buildFilterSuggestionsGenerator } from './controllers/commerce/filter-suggestions/headless-filter-suggestions-generator.js';
 export type { InstantProducts, InstantProductsOptions, InstantProductsProps, InstantProductsState, } from './controllers/commerce/instant-products/headless-instant-products.js';
 export { buildInstantProducts } from './controllers/commerce/instant-products/headless-instant-products.js';
-export type { ProductListing, ProductListingState, } from './controllers/commerce/product-listing/headless-product-listing.js';
+export type { ProductEnrichment, ProductEnrichmentOptions, ProductEnrichmentProps, ProductEnrichmentState, } from './controllers/commerce/product-enrichment/headless-product-enrichment.js';
+export { buildProductEnrichment } from './controllers/commerce/product-enrichment/headless-product-enrichment.js';
+export type { ProductListing, ProductListingOptions, ProductListingState, } from './controllers/commerce/product-listing/headless-product-listing.js';
 export { buildProductListing } from './controllers/commerce/product-listing/headless-product-listing.js';
 export type { ProductListingSummaryState } from './controllers/commerce/product-listing/summary/headless-product-listing-summary.js';
 export type { ProductView } from './controllers/commerce/product-view/headless-product-view.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/interactive-spotlight-content/headless-core-interactive-spotlight-content.d.ts

@@ -0,0 +1,38 @@
+import type { SpotlightContent } from '../../../../api/commerce/common/result.js';
+import type { CommerceEngine, CommerceEngineState } from '../../../../app/commerce-engine/commerce-engine.js';
+import type { InteractiveResultCore, InteractiveResultCoreProps as InteractiveResultHeadlessCoreProps, InteractiveResultCoreOptions as InteractiveSpotlightContentCoreOptions } from '../../../core/interactive-result/headless-core-interactive-result.js';
+export interface InteractiveSpotlightContentOptions extends InteractiveSpotlightContentCoreOptions {
+    /**
+     * The spotlight content to log analytics for.
+     */
+    spotlightContent: SpotlightContent;
+}
+export interface InteractiveSpotlightContentCoreProps extends InteractiveResultHeadlessCoreProps {
+    /**
+     * The options for the `InteractiveSpotlightContent` sub-controller.
+     */
+    options: InteractiveSpotlightContentOptions;
+    /**
+     * The selector to fetch the response ID from the state.
+     */
+    responseIdSelector: (state: CommerceEngineState) => string;
+}
+export type InteractiveSpotlightContentProps = Omit<InteractiveSpotlightContentCoreProps, 'responseIdSelector'>;
+/**
+ * The `InteractiveSpotlightContent` sub-controller provides an interface for handling long presses, multiple clicks, etc. to ensure
+ * analytics events are logged properly when a user selects a spotlight content item.
+ */
+export interface InteractiveSpotlightContent extends InteractiveResultCore {
+    warningMessage?: string;
+}
+/**
+ * Creates an `InteractiveSpotlightContent` sub-controller instance.
+ *
+ * @param engine - The headless commerce engine.
+ * @param props - The configurable `InteractiveSpotlightContent` properties.
+ * @returns An `InteractiveSpotlightContent` sub-controller instance.
+ *
+ * @group Buildable controllers
+ * @category CoreInteractiveSpotlightContent
+ */
+export declare function buildCoreInteractiveSpotlightContent(engine: CommerceEngine, props: InteractiveSpotlightContentCoreProps): InteractiveSpotlightContent;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/core/sub-controller/headless-sub-controller.d.ts

@@ -16,6 +16,7 @@ import { type BreadcrumbManager } from '../breadcrumb-manager/headless-core-brea
 import type { FetchProductsActionCreator } from '../common.js';
 import { type FacetGenerator } from '../facets/generator/headless-commerce-facet-generator.js';
 import { type InteractiveProduct, type InteractiveProductProps } from '../interactive-product/headless-core-interactive-product.js';
+import { type InteractiveSpotlightContent, type InteractiveSpotlightContentProps } from '../interactive-spotlight-content/headless-core-interactive-spotlight-content.js';
 import { type Pagination, type PaginationProps } from '../pagination/headless-core-commerce-pagination.js';
 import { type ParameterManager, type ParameterManagerProps } from '../parameter-manager/headless-core-parameter-manager.js';
 import { type Sort, type SortProps } from '../sort/headless-core-commerce-sort.js';
@@ -77,6 +78,14 @@ export interface SearchSubControllers extends SearchAndListingSubControllers<Com
      */
     didYouMean(): DidYouMean;
 }
+export interface ProductListingSubControllers extends SearchAndListingSubControllers<ProductListingParameters, ProductListingSummaryState> {
+    /**
+     * Creates an `InteractiveSpotlightContent` sub-controller, for use when `enableResults` is set on the controller.
+     * @param props - The properties for the `InteractiveSpotlightContent` sub-controller.
+     * @returns An `InteractiveSpotlightContent` sub-controller.
+     */
+    interactiveSpotlightContent(props: InteractiveSpotlightContentProps): InteractiveSpotlightContent;
+}
 interface BaseSubControllerProps<S extends SummaryState> {
     responseIdSelector: (state: CommerceEngineState) => string;
     isLoadingSelector: (state: CommerceEngineState) => boolean;
@@ -115,7 +124,7 @@ export declare function buildSearchSubControllers(engine: CommerceEngine, subCon
  * @param subControllerProps - The properties for the listing sub-controllers.
  * @returns The product listing sub-controllers.
  */
-export declare function buildProductListingSubControllers(engine: CommerceEngine, subControllerProps: Omit<SearchAndListingSubControllerProps<ProductListingParameters, ProductListingSummaryState>, 'facetSearchType'>): SearchAndListingSubControllers<ProductListingParameters, ProductListingSummaryState>;
+export declare function buildProductListingSubControllers(engine: CommerceEngine, subControllerProps: Omit<SearchAndListingSubControllerProps<ProductListingParameters, ProductListingSummaryState>, 'facetSearchType'>): ProductListingSubControllers;
 /**
  * Builds the sub-controllers for the commerce search and product listing use cases.
  *

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

@@ -0,0 +1,56 @@
+import type { SerializedError } from '@reduxjs/toolkit';
+import type { CommerceAPIErrorResponse } from '../../../api/commerce/commerce-api-error-response.js';
+import type { BadgesProduct } from '../../../api/commerce/product-enrichment/product-enrichment-response.js';
+import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
+import { type FetchBadgesPayload } from '../../../features/commerce/product-enrichment/product-enrichment-actions.js';
+import { type Controller } from '../../controller/headless-controller.js';
+export interface ProductEnrichmentOptions extends FetchBadgesPayload {
+}
+export interface ProductEnrichmentProps {
+    /**
+     * The options for the `ProductEnrichment` controller.
+     */
+    options?: ProductEnrichmentOptions;
+}
+export interface ProductEnrichment extends Controller {
+    /**
+     * The state of the ProductEnrichment controller.
+     * */
+    state: ProductEnrichmentState;
+    /**
+     * Fetches badges for the configured product and placement IDs.
+     *
+     * The results are accessible through the controller's `state.products` property.
+     *
+     * @remarks
+     * This method will not execute if no placement IDs were provided during controller initialization.
+     * The request will include the configured `productId` in the context if provided.
+     * */
+    getBadges(): void;
+}
+export interface ProductEnrichmentState {
+    /**
+     * An array of products with their badge placements.
+     */
+    products: BadgesProduct[];
+    /**
+     * Whether a request to fetch badges is currently being executed.
+     */
+    isLoading: boolean;
+    /**
+     * The error returned when executing a badge fetch request, if any. This is `null` otherwise.
+     */
+    error: CommerceAPIErrorResponse | SerializedError | null;
+}
+/**
+ * Creates a `ProductEnrichment` controller instance.
+ *
+ * @param engine - The headless engine.
+ * @param props - The configuration `ProductEnrichment` properties.
+ * @returns A `ProductEnrichment` controller instance.
+ *
+ * @group Buildable controllers
+ * @category ProductEnrichment
+ *
+ * */
+export declare function buildProductEnrichment(engine: CommerceEngine, props?: ProductEnrichmentProps): ProductEnrichment;

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

@@ -1,10 +1,10 @@
 import type { CommerceAPIErrorStatusResponse } from '../../../api/commerce/commerce-api-error-response.js';
 import type { ChildProduct, Product } from '../../../api/commerce/common/product.js';
+import type { Result } from '../../../api/commerce/common/result.js';
 import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
-import type { Parameters } from '../../../features/commerce/parameters/parameters-actions.js';
+import type { FetchProductListingPayload } from '../../../features/commerce/product-listing/product-listing-actions.js';
 import { type Controller } from '../../controller/headless-controller.js';
-import { type SearchAndListingSubControllers } from '../core/sub-controller/headless-sub-controller.js';
-import type { ProductListingSummaryState } from './summary/headless-product-listing-summary.js';
+import { type ProductListingSubControllers } from '../core/sub-controller/headless-sub-controller.js';
 /**
  * The `ProductListing` controller exposes a method for retrieving product listing content in a commerce interface.
  *
@@ -13,7 +13,7 @@ import type { ProductListingSummaryState } from './summary/headless-product-list
  * @group Buildable controllers
  * @category ProductListing
  */
-export interface ProductListing extends Controller, SearchAndListingSubControllers<Parameters, ProductListingSummaryState> {
+export interface ProductListing extends Controller, ProductListingSubControllers {
     /**
      * Fetches the product listing.
      */
@@ -51,17 +51,26 @@ export interface ProductListing extends Controller, SearchAndListingSubControlle
  */
 export interface ProductListingState {
     products: Product[];
+    results: Result[];
     error: CommerceAPIErrorStatusResponse | null;
     isLoading: boolean;
     responseId: string;
 }
+/**
+ * Options for configuring the `ProductListing` controller.
+ * @group Buildable controllers
+ * @category ProductListing
+ */
+export interface ProductListingOptions extends FetchProductListingPayload {
+}
 /**
  * Creates a `ProductListing` controller instance.
  *
  * @param engine - The headless commerce engine.
+ * @param options - The configurable `ProductListing` controller options.
  * @returns A `ProductListing` controller instance.
  *
  * @group Buildable controllers
  * @category ProductListing
  */
-export declare function buildProductListing(engine: CommerceEngine): ProductListing;
+export declare function buildProductListing(engine: CommerceEngine, { enableResults }?: ProductListingOptions): ProductListing;

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

@@ -0,0 +1,28 @@
+import type { AsyncThunkAction } from '@reduxjs/toolkit';
+import type { AsyncThunkCommerceOptions } from '../../../api/commerce/commerce-api-client.js';
+import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
+import { type FetchBadgesPayload, type FetchBadgesThunkReturn, type StateNeededByFetchBadges } from './product-enrichment-actions.js';
+/**
+ * The product enrichment action creators.
+ *
+ * @group Actions
+ * @category ProductEnrichment
+ */
+export interface ProductEnrichmentActionCreators {
+    /**
+     * Fetches the badges.
+     *
+     * @returns A dispatchable action.
+     */
+    fetchBadges(payload?: FetchBadgesPayload): AsyncThunkAction<FetchBadgesThunkReturn, FetchBadgesPayload, AsyncThunkCommerceOptions<StateNeededByFetchBadges>>;
+}
+/**
+ * Loads the commerce product enrichment reducer and returns the available product enrichment action creators.
+ *
+ * @param engine - The headless commerce engine.
+ * @returns An object holding the product enrichment action creators.
+ *
+ * @group Actions
+ * @category ProductEnrichment
+ */
+export declare function loadProductEnrichmentActions(engine: CommerceEngine): ProductEnrichmentActionCreators;

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

@@ -0,0 +1,27 @@
+import type { ProductEnrichmentSuccessBadgesResponse } from '../../../api/commerce/product-enrichment/product-enrichment-response.js';
+import type { ProductEnrichmentSection } from '../../../state/state-sections.js';
+import { type StateNeededForBaseCommerceAPIRequest } from '../common/base-commerce-api-request-builder.js';
+export type StateNeededByFetchBadges = StateNeededForBaseCommerceAPIRequest & ProductEnrichmentSection;
+export interface FetchBadgesPayload {
+    /**
+     * An array of placement IDs to fetch badges for.
+     */
+    placementIds?: string[];
+    /**
+     * The product ID to fetch badges for.
+     */
+    productId?: string;
+}
+export interface FetchBadgesThunkReturn {
+    response: ProductEnrichmentSuccessBadgesResponse;
+}
+export declare const fetchBadges: import("@reduxjs/toolkit").AsyncThunk<FetchBadgesThunkReturn, FetchBadgesPayload, {
+    state: StateNeededByFetchBadges;
+    rejectValue: import("../../../api/commerce/commerce-api-error-response.js").CommerceAPIErrorStatusResponse;
+    extra: import("../../../app/commerce-thunk-extra-arguments.js").CommerceThunkExtraArguments;
+    dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("@reduxjs/toolkit").UnknownAction> | undefined;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;

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

@@ -0,0 +1,4 @@
+import { type ProductEnrichmentState } from './product-enrichment-state.js';
+export declare const productEnrichmentReducer: import("@reduxjs/toolkit").Reducer<ProductEnrichmentState> & {
+    getInitialState: () => ProductEnrichmentState;
+};

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

@@ -0,0 +1,17 @@
+import type { CommerceAPIErrorStatusResponse } from '../../../api/commerce/commerce-api-error-response.js';
+import type { BadgesProduct } from '../../../api/commerce/product-enrichment/product-enrichment-response.js';
+export interface ProductEnrichmentState {
+    /**
+     * The array of products containing badge placements for each product.
+     */
+    products: BadgesProduct[];
+    /**
+     * Whether a request to fetch badges is currently being executed.
+     */
+    isLoading: boolean;
+    /**
+     * The error message if the request failed.
+     */
+    error: CommerceAPIErrorStatusResponse | null;
+}
+export declare function getProductEnrichmentInitialState(): ProductEnrichmentState;

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

@@ -0,0 +1,7 @@
+import { ArrayValue, Schema } from '@coveo/bueno';
+import type { ProductEnrichmentOptions } from '../../../controllers/commerce/product-enrichment/headless-product-enrichment.js';
+export declare const productEnrichmentDefinition: {
+    placementIds: ArrayValue<import("@coveo/bueno").PrimitivesValues>;
+    productId: import("@coveo/bueno").StringValue<string>;
+};
+export declare const productEnrichmentOptionsSchema: Schema<ProductEnrichmentOptions>;

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

@@ -1,7 +1,7 @@
 import type { AsyncThunkAction, PayloadAction } from '@reduxjs/toolkit';
 import type { AsyncThunkCommerceOptions } from '../../../api/commerce/commerce-api-client.js';
 import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
-import { type PromoteChildToParentPayload, type QueryCommerceAPIThunkReturn, type StateNeededByFetchProductListing } from './product-listing-actions.js';
+import type { FetchProductListingPayload, PromoteChildToParentPayload, QueryCommerceAPIThunkReturn, StateNeededByFetchProductListing } from './product-listing-actions.js';
 /**
  * The product listing action creators.
  *
@@ -14,13 +14,13 @@ export interface ProductListingActionCreators {
      *
      * @returns A dispatchable action.
      */
-    fetchProductListing(): AsyncThunkAction<QueryCommerceAPIThunkReturn, void, AsyncThunkCommerceOptions<StateNeededByFetchProductListing>>;
+    fetchProductListing(payload?: FetchProductListingPayload): AsyncThunkAction<QueryCommerceAPIThunkReturn, FetchProductListingPayload, AsyncThunkCommerceOptions<StateNeededByFetchProductListing>>;
     /**
      * Fetches and additional page of products and appends it to the current list.
      *
      * @returns A dispatchable action.
      */
-    fetchMoreProducts(): AsyncThunkAction<QueryCommerceAPIThunkReturn | null, void, AsyncThunkCommerceOptions<StateNeededByFetchProductListing>>;
+    fetchMoreProducts(payload?: FetchProductListingPayload): AsyncThunkAction<QueryCommerceAPIThunkReturn | null, FetchProductListingPayload, AsyncThunkCommerceOptions<StateNeededByFetchProductListing>>;
     /**
      * Promotes a child product to a parent product.
      *

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

@@ -1,13 +1,21 @@
 import type { ChildProduct } from '../../../api/commerce/common/product.js';
-import type { CommerceSuccessResponse } from '../../../api/commerce/common/response.js';
+import type { ListingCommerceSuccessResponse } from '../../../api/commerce/listing/response.js';
 import type { ProductListingSection } from '../../../state/state-sections.js';
 import { type StateNeededForFilterableCommerceAPIRequest } from '../common/filterable-commerce-api-request-builder.js';
 export interface QueryCommerceAPIThunkReturn {
     /** The successful response. */
-    response: CommerceSuccessResponse;
+    response: ListingCommerceSuccessResponse;
 }
 export type StateNeededByFetchProductListing = StateNeededForFilterableCommerceAPIRequest & ProductListingSection;
-export declare const fetchProductListing: import("@reduxjs/toolkit").AsyncThunk<QueryCommerceAPIThunkReturn, void, {
+export interface FetchProductListingPayload {
+    /**
+     * When set to true, fills the `results` field rather than the `products` field
+     * in the response. It may also include Spotlight Content in the results.
+     * @default false
+     */
+    enableResults?: boolean;
+}
+export declare const fetchProductListing: import("@reduxjs/toolkit").AsyncThunk<QueryCommerceAPIThunkReturn, FetchProductListingPayload, {
     state: StateNeededByFetchProductListing;
     rejectValue: import("../../../api/commerce/commerce-api-error-response.js").CommerceAPIErrorStatusResponse;
     extra: import("../../../app/commerce-thunk-extra-arguments.js").CommerceThunkExtraArguments;
@@ -17,7 +25,7 @@ export declare const fetchProductListing: import("@reduxjs/toolkit").AsyncThunk<
     fulfilledMeta?: unknown;
     rejectedMeta?: unknown;
 }>;
-export declare const fetchMoreProducts: import("@reduxjs/toolkit").AsyncThunk<QueryCommerceAPIThunkReturn | null, void, {
+export declare const fetchMoreProducts: import("@reduxjs/toolkit").AsyncThunk<QueryCommerceAPIThunkReturn | null, FetchProductListingPayload, {
     state: StateNeededByFetchProductListing;
     rejectValue: import("../../../api/commerce/commerce-api-error-response.js").CommerceAPIErrorStatusResponse;
     extra: import("../../../app/commerce-thunk-extra-arguments.js").CommerceThunkExtraArguments;

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

@@ -1,5 +1,6 @@
 import type { CommerceAPIErrorStatusResponse } from '../../../api/commerce/commerce-api-error-response.js';
 import type { Product } from '../../../api/commerce/common/product.js';
+import type { Result } from '../../../api/commerce/common/result.js';
 import type { AnyFacetResponse } from '../facets/facet-set/interfaces/response.js';
 export interface ProductListingState {
     error: CommerceAPIErrorStatusResponse | null;
@@ -8,5 +9,6 @@ export interface ProductListingState {
     responseId: string;
     facets: AnyFacetResponse[];
     products: Product[];
+    results: Result[];
 }
 export declare const getProductListingInitialState: () => ProductListingState;