@coveo/quantic 3.36.1 → 3.36.3

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

@@ -3,5 +3,5 @@ import type { BaseParam } from './platform-service-params.js';
 import type { AllSearchAPIResponse } from './search/search-api-client.js';
 import type { SearchAPIErrorWithStatusCode } from './search/search-api-error-response.js';
 import type { AuthenticationParam } from './search/search-api-params.js';
-export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "accessToken" | "organizationId" | "url" | "authentication">;
+export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "url" | "accessToken" | "organizationId" | "authentication">;
 export declare const unwrapError: (payload: PlatformResponse<AllSearchAPIResponse>) => SearchAPIErrorWithStatusCode;

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

@@ -19,7 +19,7 @@ export interface ContextParam {
     context: ContextParams;
 }
 export interface EnableResultsParam {
-    enableResults: boolean;
+    enableResults?: boolean;
 }
 type ProductParam = {
     productId: string;

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

@@ -4,3 +4,7 @@ export interface Pagination {
     totalEntries: number;
     totalPages: number;
 }
+export interface PaginationWithResultTypeCounts extends Pagination {
+    totalProducts: number;
+    totalSpotlights: number;
+}

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

@@ -29,10 +29,10 @@ export declare const getRequestOptions: (req: FilterableCommerceAPIRequest, path
         facets: import("../../../features/commerce/facets/facet-set/interfaces/request.js").AnyFacetRequest[] | undefined;
         sort: import("./sort.js").SortOption | undefined;
     };
-    accessToken: string;
     url: string;
-    method: import("../../platform-client.js").HttpMethods;
     origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../platform-client.js").HttpMethods;
     contentType: import("../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };

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

@@ -1,6 +1,5 @@
 import type { AnyFacetResponse } from '../../../features/commerce/facets/facet-set/interfaces/response.js';
 import type { Trigger } from '../../common/trigger.js';
-import type { SearchAPIErrorWithExceptionInBody, SearchAPIErrorWithStatusCode } from '../../search/search-api-error-response.js';
 import type { Pagination } from './pagination.js';
 import type { BaseProduct } from './product.js';
 import type { Sort } from './sort.js';
@@ -14,4 +13,3 @@ export interface CommerceSuccessResponse extends BaseCommerceSuccessResponse {
     facets: AnyFacetResponse[];
     sort: Sort;
 }
-export type CommerceResponse = CommerceSuccessResponse | SearchAPIErrorWithExceptionInBody | SearchAPIErrorWithStatusCode;

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

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

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

@@ -21,10 +21,10 @@ export declare const buildProductEnrichmentBadgesRequest: (req: ProductEnrichmen
             custom?: Record<string, unknown>;
         };
     };
-    accessToken: string;
     url: string;
-    method: import("../../platform-client.js").HttpMethods;
     origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../platform-client.js").HttpMethods;
     contentType: import("../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };

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

@@ -25,10 +25,10 @@ export declare const buildRecommendationsRequest: (req: CommerceRecommendationsR
         page: number | undefined;
         perPage: number | undefined;
     };
-    accessToken: string;
     url: string;
-    method: import("../../platform-client.js").HttpMethods;
     origin: import("../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../platform-client.js").HttpMethods;
     contentType: import("../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };

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

@@ -22,10 +22,10 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
         country: string;
         currency: string;
     };
-    accessToken: string;
     url: string;
-    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
     requestMetadata?: import("../../../preprocess-request.js").RequestMetadata | undefined;
 };

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

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

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

@@ -1,7 +1,11 @@
 import type { QueryCorrection } from '../../search/search/query-corrections.js';
+import type { PaginationWithResultTypeCounts } from '../common/pagination.js';
 import type { CommerceSuccessResponse } from '../common/response.js';
+import type { BaseResult } from '../common/result.js';
 export interface SearchCommerceSuccessResponse extends CommerceSuccessResponse {
     queryCorrection?: SearchCommerceQueryCorrectionResponse;
+    results: BaseResult[];
+    pagination: PaginationWithResultTypeCounts;
 }
 interface SearchCommerceQueryCorrectionResponse {
     correctedQuery: string | null;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/answer/answer-endpoint.d.ts

@@ -4,7 +4,7 @@ import { type GeneratedAnswerServerState } from '../../answer-generation-api-sta
 /**
  * Parameters for answer generation requests.
  */
-type AnswerParams = {
+export type AnswerParams = {
     q: string;
     facets?: AnyFacetRequest[];
     searchHub?: string;
@@ -28,4 +28,3 @@ export declare const answerEndpoint: import("@reduxjs/toolkit/query").Api<import
  * Initiates an answer generation query with the specified strategy and parameters.
  */
 export declare const initiateAnswerEndpoint: (args: AnswerEndpointArgs) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<AnswerEndpointArgs, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerServerState, "answerGenerationApi">>, any, any, import("@reduxjs/toolkit").UnknownAction>;
-export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/follow-up/follow-up-endpoint.d.ts

@@ -0,0 +1,25 @@
+import { type GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
+/**
+ * Parameters for follow-up answer generation requests.
+ */
+type FollowUpAnswerParams = {
+    q: string;
+    conversationId: string;
+};
+/**
+ * Arguments for the follow-up answer endpoint including streaming strategy and request parameters.
+ */
+export type FollowUpEndpointArgs = {
+    strategyKey: 'follow-up-answer';
+} & FollowUpAnswerParams;
+/**
+ * RTK Query endpoint for streaming follow-up answer generation.
+ */
+export declare const followUpEndpoint: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {
+    generateFollowUpAnswer: import("@reduxjs/toolkit/query").QueryDefinition<FollowUpEndpointArgs, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerServerState, "answerGenerationApi">;
+}, "answerGenerationApi", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
+/**
+ * Initiates a follow up answer generation query with the specified strategy and parameters.
+ */
+export declare const initiateFollowUpEndpoint: (args: FollowUpEndpointArgs) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<FollowUpEndpointArgs, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerServerState, "answerGenerationApi">>, any, any, import("@reduxjs/toolkit").UnknownAction>;
+export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/follow-up/url-builders/endpoint-url-builder.d.ts

@@ -0,0 +1,5 @@
+import type { AnswerGenerationApiState } from '../../../answer-generation-api-state.js';
+/**
+ * Builds the complete URL for the follow up endpoint.
+ */
+export declare const buildFollowUpEndpointUrl: (state: AnswerGenerationApiState) => string;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/strategies/streaming-strategy-creators.d.ts

@@ -0,0 +1,4 @@
+export declare const streamingStrategyCreators: {
+    'head-answer': () => import("../types.js").StreamingStrategy<import("../../answer-generation-api-state.js").AnswerGenerationApiState>;
+    'follow-up-answer': () => import("../types.js").StreamingStrategy<import("../../answer-generation-api-state.js").AnswerGenerationApiState>;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts

@@ -27,9 +27,9 @@ export declare const selectAnswer: (state: StreamAnswerAPIState) => ({
 }) | ({
     status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
     error: undefined;
-    endpointName: string;
-    originalArgs: AnswerApiQueryParams;
     requestId: string;
+    originalArgs: AnswerApiQueryParams;
+    endpointName: string;
     startedTimeStamp: number;
     data: GeneratedAnswerStream;
     fulfilledTimeStamp: number;
@@ -56,11 +56,11 @@ export declare const selectAnswer: (state: StreamAnswerAPIState) => ({
     isError: false;
 }) | ({
     status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
+    requestId: string;
     data?: GeneratedAnswerStream | undefined;
-    endpointName: string;
     fulfilledTimeStamp?: number | undefined;
     originalArgs: AnswerApiQueryParams;
-    requestId: string;
+    endpointName: string;
     startedTimeStamp: number;
     error: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/query").FetchBaseQueryError;
 } & {

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

@@ -11,9 +11,9 @@ export declare const buildGetCaseClassificationsRequest: (req: GetCaseClassifica
             };
         };
     };
-    accessToken: string;
     url: string;
-    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };

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

@@ -28,9 +28,9 @@ export declare const buildGetDocumentSuggestionsRequest: (req: GetDocumentSugges
             source?: string[];
         } | undefined;
     };
-    accessToken: string;
     url: string;
-    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts

@@ -3,9 +3,9 @@ import { type InsightIdParam } from '../insight-params.js';
 export type GetInsightInterfaceConfigRequest = BaseParam & InsightIdParam;
 export declare const buildGetInsightInterfaceConfigRequest: (req: GetInsightInterfaceConfigRequest) => {
     requestParams: {};
-    accessToken: string;
     url: string;
-    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/query/query-request.d.ts

@@ -8,17 +8,17 @@ export interface CaseContextParam {
 }
 export declare const buildInsightQueryRequest: (req: InsightQueryRequest) => {
     requestParams: {};
-    accessToken: string;
     url: string;
-    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };
 export declare const buildInsightQuerySuggestRequest: (req: InsightQuerySuggestRequest) => {
     requestParams: {};
-    accessToken: string;
     url: string;
-    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/user-actions/user-actions-request.d.ts

@@ -10,10 +10,10 @@ export declare const buildInsightUserActionsRequest: (req: InsightUserActionsReq
     requestParams: {
         objectId: string;
     };
-    accessToken: string;
     url: string;
-    method: import("../../../platform-client.js").HttpMethods;
     origin: import("../../../preprocess-request.js").PlatformClientOrigin;
+    accessToken: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
 };
 export {};

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

@@ -114,7 +114,7 @@ export type { Recommendations, RecommendationsOptions, RecommendationsProps, Rec
 export { buildRecommendations } from './controllers/commerce/recommendations/headless-recommendations.js';
 export type { RecommendationsSummaryState } from './controllers/commerce/recommendations/summary/headless-recommendations-summary.js';
 export type { DidYouMean, DidYouMeanState, QueryCorrection, WordCorrection, } from './controllers/commerce/search/did-you-mean/headless-did-you-mean.js';
-export type { Search, SearchState, } from './controllers/commerce/search/headless-search.js';
+export type { Search, SearchOptions, SearchState, } from './controllers/commerce/search/headless-search.js';
 export { buildSearch } from './controllers/commerce/search/headless-search.js';
 export type { SearchSummaryState } from './controllers/commerce/search/summary/headless-search-summary.js';
 export type { SearchBox, SearchBoxOptions, SearchBoxProps, SearchBoxState, Suggestion, } from './controllers/commerce/search-box/headless-search-box.js';
@@ -122,6 +122,7 @@ export { buildSearchBox } from './controllers/commerce/search-box/headless-searc
 export type { StandaloneSearchBox, StandaloneSearchBoxState, } from './controllers/commerce/standalone-search-box/headless-standalone-search-box.js';
 export { buildStandaloneSearchBox } from './controllers/commerce/standalone-search-box/headless-standalone-search-box.js';
 export { buildNotifyTrigger } from './controllers/commerce/triggers/headless-notify-trigger.js';
+export type { QueryTriggerOptions } from './controllers/commerce/triggers/headless-query-trigger.js';
 export { buildQueryTrigger } from './controllers/commerce/triggers/headless-query-trigger.js';
 export { buildRedirectionTrigger } from './controllers/commerce/triggers/headless-redirection-trigger.js';
 export type { Controller, Subscribable, } from './controllers/controller/headless-controller.js';

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

@@ -70,6 +70,12 @@ export interface SearchAndListingSubControllers<P extends Parameters, S extends
      * @returns A `ParameterManager` sub-controller.
      */
     parameterManager(props?: ParameterManagerProps<P>): ParameterManager<P>;
+    /**
+     * 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;
 }
 export interface SearchSubControllers extends SearchAndListingSubControllers<CommerceSearchParameters, SearchSummaryState> {
     /**
@@ -78,14 +84,6 @@ 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;
@@ -124,7 +122,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'>): ProductListingSubControllers;
+export declare function buildProductListingSubControllers(engine: CommerceEngine, subControllerProps: Omit<SearchAndListingSubControllerProps<ProductListingParameters, ProductListingSummaryState>, 'facetSearchType'>): SearchAndListingSubControllers<Parameters, ProductListingSummaryState>;
 /**
  * Builds the sub-controllers for the commerce search and product listing use cases.
  *

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

@@ -2,9 +2,11 @@ import type { CommerceAPIErrorStatusResponse } from '../../../api/commerce/comme
 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 ProductListingSubControllers } from '../core/sub-controller/headless-sub-controller.js';
+import type { SearchAndListingSubControllers } from '../core/sub-controller/headless-sub-controller.js';
+import type { ProductListingSummaryState } from './summary/headless-product-listing-summary.js';
 /**
  * The `ProductListing` controller exposes a method for retrieving product listing content in a commerce interface.
  *
@@ -13,7 +15,7 @@ import { type ProductListingSubControllers } from '../core/sub-controller/headle
  * @group Buildable controllers
  * @category ProductListing
  */
-export interface ProductListing extends Controller, ProductListingSubControllers {
+export interface ProductListing extends Controller, SearchAndListingSubControllers<Parameters, ProductListingSummaryState> {
     /**
      * Fetches the product listing.
      */

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

@@ -1,5 +1,6 @@
 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 Controller } from '../../controller/headless-controller.js';
 import { type SearchSubControllers } from '../core/sub-controller/headless-sub-controller.js';
@@ -43,16 +44,31 @@ export interface Search extends Controller, SearchSubControllers {
  */
 export interface SearchState {
     products: Product[];
+    results: Result[];
     error: CommerceAPIErrorStatusResponse | null;
     isLoading: boolean;
     responseId: string;
 }
+/**
+ * Options for configuring the `Search` controller.
+ * @group Buildable controllers
+ * @category Search
+ */
+export interface SearchOptions {
+    /**
+     * 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;
+}
 /**
  * Builds a `Search` controller for the given commerce engine.
  * @param engine - The commerce engine.
+ * @param options - The configurable `Search` controller options.
  * @returns A `Search` controller.
  *
  * @group Buildable controllers
  * @category Search
  */
-export declare function buildSearch(engine: CommerceEngine): Search;
+export declare function buildSearch(engine: CommerceEngine, { enableResults }?: SearchOptions): Search;

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

@@ -1,12 +1,20 @@
-import { Schema } from '@coveo/bueno';
+import { BooleanValue, Schema } from '@coveo/bueno';
 import { type SearchBoxOptions as CoreSearchBoxOptions } from '../../core/search-box/headless-core-search-box-options.js';
-export type SearchBoxOptions = Pick<CoreSearchBoxOptions, 'id' | 'highlightOptions' | 'clearFilters'>;
-type DefaultSearchBoxOptions = Pick<SearchBoxOptions, 'clearFilters'>;
+export type SearchBoxOptions = Pick<CoreSearchBoxOptions, 'id' | 'highlightOptions' | 'clearFilters'> & {
+    /**
+     * 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;
+};
+type DefaultSearchBoxOptions = Pick<SearchBoxOptions, 'clearFilters' | 'enableResults'>;
 export declare const defaultSearchBoxOptions: Required<DefaultSearchBoxOptions>;
 export declare const searchBoxOptionDefinitions: {
     id: import("@coveo/bueno").StringValue<string>;
     highlightOptions: import("@coveo/bueno").RecordValue;
-    clearFilters: import("@coveo/bueno").BooleanValue;
+    clearFilters: BooleanValue;
+    enableResults: BooleanValue;
 };
 export declare const searchBoxOptionsSchema: Schema<Required<SearchBoxOptions>>;
 export {};

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

@@ -1,12 +1,26 @@
 import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
 import type { QueryTrigger } from '../../core/triggers/headless-core-query-trigger.js';
+/**
+ * Options for configuring the `QueryTrigger` controller.
+ * @group Buildable controllers
+ * @category QueryTrigger
+ */
+export interface QueryTriggerOptions {
+    /**
+     * 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;
+}
 /**
  * Creates a `QueryTrigger` controller instance.
  *
  * @param engine - The headless commerce engine.
+ * @param options - The configurable `QueryTrigger` controller options.
  * @returns A `QueryTrigger` controller instance.
  *
  * @group Buildable controllers
  * @category QueryTrigger
  * */
-export declare function buildQueryTrigger(engine: CommerceEngine): QueryTrigger;
+export declare function buildQueryTrigger(engine: CommerceEngine, { enableResults }?: QueryTriggerOptions): QueryTrigger;

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

@@ -1,9 +1,9 @@
 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 PrepareForSearchWithQueryPayload, type PromoteChildToParentPayload, type QuerySearchCommerceAPIThunkReturn } from './search-actions.js';
+import { type FetchSearchPayload, type PrepareForSearchWithQueryPayload, type PromoteChildToParentPayload, type QuerySearchCommerceAPIThunkReturn } from './search-actions.js';
 import type { StateNeededByExecuteSearch } from './search-actions-thunk-processor.js';
-export type { PrepareForSearchWithQueryPayload };
+export type { PrepareForSearchWithQueryPayload, FetchSearchPayload };
 /**
  * The search action creators.
  *
@@ -14,15 +14,17 @@ export interface SearchActionCreators {
     /**
      * Executes a search query.
      *
+     * @param payload - The action creator payload.
      * @returns A dispatchable action.
      */
-    executeSearch(): AsyncThunkAction<QuerySearchCommerceAPIThunkReturn, void, AsyncThunkCommerceOptions<StateNeededByExecuteSearch>>;
+    executeSearch(payload?: FetchSearchPayload): AsyncThunkAction<QuerySearchCommerceAPIThunkReturn, FetchSearchPayload | undefined, AsyncThunkCommerceOptions<StateNeededByExecuteSearch>>;
     /**
      * Fetches and additional page of products and appends it to the current list.
      *
+     * @param payload - The action creator payload.
      * @returns A dispatchable action.
      */
-    fetchMoreProducts(): AsyncThunkAction<QuerySearchCommerceAPIThunkReturn | null, void, AsyncThunkCommerceOptions<StateNeededByExecuteSearch>>;
+    fetchMoreProducts(payload?: FetchSearchPayload): AsyncThunkAction<QuerySearchCommerceAPIThunkReturn | null, FetchSearchPayload | undefined, AsyncThunkCommerceOptions<StateNeededByExecuteSearch>>;
     /**
      * Updates the query, resets the pagination, and optionally clears all facets in preparation for a new search query.
      *

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

@@ -14,6 +14,7 @@ interface FetchedResponse {
     duration: number;
     queryExecuted: string;
     requestExecuted: FilterableCommerceAPIRequest;
+    enableResults?: boolean;
 }
 export type StateNeededByExecuteSearch = StateNeededForFilterableCommerceAPIRequest & CommerceSearchSection & CommerceQuerySection & CommerceDidYouMeanSection & TriggerSection;
 export interface AsyncThunkConfig {
@@ -34,6 +35,7 @@ export declare class AsyncSearchThunkProcessor<RejectionType> {
         duration: number;
         queryExecuted: string;
         requestExecuted: FilterableCommerceAPIRequest | CommerceSearchRequest;
+        enableResults: boolean;
     }>;
     private processSuccessResponse;
     private processQueryErrorOrContinue;

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

@@ -10,6 +10,14 @@ export interface QuerySearchCommerceAPIThunkReturn {
     /** The original query expression that was received and automatically corrected. */
     originalQuery: string;
 }
+export interface FetchSearchPayload {
+    /**
+     * 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 interface PrepareForSearchWithQueryOptions {
     /**
      * Whether to clear all active query filters when the end user submits a new query from the search box.
@@ -35,7 +43,7 @@ interface FetchInstantProductsThunkReturn {
     /** The successful response. */
     response: SearchCommerceSuccessResponse;
 }
-export declare const executeSearch: import("@reduxjs/toolkit").AsyncThunk<QuerySearchCommerceAPIThunkReturn, void, {
+export declare const executeSearch: import("@reduxjs/toolkit").AsyncThunk<QuerySearchCommerceAPIThunkReturn, FetchSearchPayload | undefined, {
     state: StateNeededByExecuteSearch;
     rejectValue: import("../../../api/commerce/commerce-api-error-response.js").CommerceAPIErrorStatusResponse;
     extra: import("../../../app/commerce-thunk-extra-arguments.js").CommerceThunkExtraArguments;
@@ -45,7 +53,7 @@ export declare const executeSearch: import("@reduxjs/toolkit").AsyncThunk<QueryS
     fulfilledMeta?: unknown;
     rejectedMeta?: unknown;
 }>;
-export declare const fetchMoreProducts: import("@reduxjs/toolkit").AsyncThunk<QuerySearchCommerceAPIThunkReturn | null, void, {
+export declare const fetchMoreProducts: import("@reduxjs/toolkit").AsyncThunk<QuerySearchCommerceAPIThunkReturn | null, FetchSearchPayload | undefined, {
     state: StateNeededByExecuteSearch;
     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/search/search-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 CommerceSearchState {
     error: CommerceAPIErrorStatusResponse | null;
@@ -7,6 +8,7 @@ export interface CommerceSearchState {
     requestId: string;
     responseId: string;
     products: Product[];
+    results: Result[];
     facets: AnyFacetResponse[];
     queryExecuted: string;
 }

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

@@ -140,3 +140,4 @@ export interface SetOriginLevel3ActionCreatorPayload {
     originLevel3: string;
 }
 export declare const setOriginLevel3: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetOriginLevel3ActionCreatorPayload], SetOriginLevel3ActionCreatorPayload, "configuration/analytics/originlevel3", never, never>;
+export declare const setAgentId: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "knowledge/setAgentId", never, never>;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-selectors.d.ts

@@ -5,3 +5,10 @@ export declare const selectLocale: (state: {
 export declare const selectTimezone: (state: {
     configuration: ConfigurationState;
 }) => string;
+/**
+ * Selects the agent ID from the knowledge configuration.
+ * Used for agent-based answer generation via the Agent API.
+ */
+export declare const selectAgentId: (state: {
+    configuration: ConfigurationState;
+}) => string | undefined;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/configuration/configuration-state.d.ts

@@ -151,6 +151,7 @@ export interface CoreAnalyticsState {
 }
 interface KnowledgeState {
     answerConfigurationId: string;
+    agentId?: string;
 }
 export declare const getConfigurationInitialState: () => ConfigurationState;
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answer-strategy.d.ts

@@ -0,0 +1,3 @@
+import type { AnswerGenerationApiState } from '../../api/knowledge/answer-generation/answer-generation-api-state.js';
+import type { StreamingStrategy } from '../../api/knowledge/answer-generation/streaming/types.js';
+export declare const createFollowUpAnswerStrategy: () => StreamingStrategy<AnswerGenerationApiState>;