@coveo/quantic 3.36.7 → 3.36.8

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, "organizationId" | "accessToken" | "url" | "authentication">;
+export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "accessToken" | "organizationId" | "url" | "authentication">;
 export declare const unwrapError: (payload: PlatformResponse<AllSearchAPIResponse>) => SearchAPIErrorWithStatusCode;

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

@@ -29,11 +29,11 @@ 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;
     };
-    method: import("../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../platform-client.js").HttpMethods;
     contentType: import("../../platform-client.js").HTTPContentType;
+    origin: import("../../preprocess-request.js").PlatformClientOrigin;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };
 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

@@ -25,10 +25,22 @@ export interface BaseSpotlightContent {
      * The name of the spotlight content.
      */
     name?: string;
+    /**
+     * The font color for the name text in hex format (e.g. `#ffffff`).
+     */
+    nameFontColor?: string;
     /**
      * The description of the spotlight content.
      */
     description?: string;
+    /**
+     * The font color for the description text in hex format (e.g. `#ffffff`).
+     */
+    descriptionFontColor?: string;
+    /**
+     * The accessibility text for the image.
+     */
+    altText?: string;
     /**
      * The ID of the response that returned the spotlight content.
      */

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>;
         };
     };
-    method: import("../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../platform-client.js").HttpMethods;
     contentType: import("../../platform-client.js").HTTPContentType;
+    origin: import("../../preprocess-request.js").PlatformClientOrigin;
     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;
     };
-    method: import("../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../platform-client.js").HttpMethods;
     contentType: import("../../platform-client.js").HTTPContentType;
+    origin: import("../../preprocess-request.js").PlatformClientOrigin;
     requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
 };

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

@@ -22,10 +22,10 @@ export declare const getPlanRequestOptions: (req: CommercePlanRequest) => {
         country: string;
         currency: string;
     };
-    method: import("../../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     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;
     };
-    method: import("../../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     requestMetadata?: import("../../../preprocess-request.js").RequestMetadata | undefined;
 };

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/agents/answer-agent/head-answer-strategy.d.ts

@@ -1,6 +1,6 @@
 import type { AgentSubscriber } from '@ag-ui/client';
-import type { Dispatch } from '@reduxjs/toolkit';
+import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
 /**
  * Creates an AgentSubscriber that handles answer streaming events
  */
-export declare const createHeadAnswerStrategy: (dispatch: Dispatch) => AgentSubscriber;
+export declare const createHeadAnswerStrategy: (dispatch: ThunkDispatch<unknown, unknown, UnknownAction>) => AgentSubscriber;

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

@@ -1,7 +1,2 @@
 import { type BaseQueryFn, type FetchArgs, type FetchBaseQueryError } from '@reduxjs/toolkit/query';
-/**
- * `dynamicBaseQuery` is passed to the baseQuery of the createApi,
- * but note that the baseQuery will not be used if a queryFn is provided in the createApi endpoint
- */
-export declare const dynamicBaseQuery: BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>;
 export declare const answerSlice: import("@reduxjs/toolkit/query").Api<BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {}, "answer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;

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

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

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
             };
         };
     };
-    method: import("../../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
 };

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;
     };
-    method: import("../../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
 };

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: {};
-    method: import("../../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
 };

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: {};
-    method: import("../../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
 };
 export declare const buildInsightQuerySuggestRequest: (req: InsightQuerySuggestRequest) => {
     requestParams: {};
-    method: import("../../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
 };

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;
     };
-    method: import("../../../platform-client.js").HttpMethods;
     accessToken: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     url: string;
+    method: import("../../../platform-client.js").HttpMethods;
     contentType: import("../../../platform-client.js").HTTPContentType;
+    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
 };
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-core-interactive-citation.d.ts

@@ -7,6 +7,10 @@ export interface InteractiveCitationOptions extends InteractiveResultCoreOptions
      * The generated answer citation.
      */
     citation: GeneratedAnswerCitation;
+    /**
+     * The unique identifier of the generated answer associated with the citation.
+     */
+    answerId?: string;
 }
 export interface InteractiveCitationProps extends InteractiveResultCoreProps {
     /**
@@ -23,7 +27,7 @@ export interface InteractiveCitationProps extends InteractiveResultCoreProps {
 export interface InteractiveCitation extends InteractiveResultCore {
 }
 interface InteractiveCitationAnalyticsClient {
-    logOpenGeneratedAnswerSource(citationId: string): CustomAction;
+    logOpenGeneratedAnswerSource(citationId: string, answerId?: string): CustomAction;
 }
 /**
  * Creates a core `InteractiveCitation` controller instance.

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

@@ -1,8 +1,6 @@
 import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
-import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
 import { type GenerationStepName } from '../generated-answer/generated-answer-state.js';
 import type { GeneratedContentFormat } from '../generated-answer/generated-response-format.js';
-import { type StateNeededForFollowUpAnswerParams } from './follow-up-answer-request.js';
 export declare const setIsEnabled: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "followUpAnswers/setIsEnabled", never, never>;
 export declare const setFollowUpAnswersConversationId: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "followUpAnswers/setFollowUpAnswersConversationId", never, never>;
 export declare const createFollowUpAnswer: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
@@ -101,13 +99,3 @@ export declare const followUpStepFinished: import("@reduxjs/toolkit").ActionCrea
     name: GenerationStepName;
     finishedAt: number;
 }, "followUpAnswers/stepFinished", never, never>;
-export declare const generateFollowUpAnswer: import("@reduxjs/toolkit").AsyncThunk<void, string, {
-    state: StateNeededForFollowUpAnswerParams;
-    extra: SearchThunkExtraArguments;
-    dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("@reduxjs/toolkit").UnknownAction> | undefined;
-    rejectValue?: unknown;
-    serializedErrorType?: unknown;
-    pendingMeta?: unknown;
-    fulfilledMeta?: unknown;
-    rejectedMeta?: unknown;
-}>;

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

@@ -2,7 +2,7 @@ import { StringValue } from '@coveo/bueno';
 import type { GeneratedAnswerCitationsPayload, GeneratedAnswerMessagePayload } from '../../api/generated-answer/generated-answer-event-payload.js';
 import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
 import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
-import type { AnswerApiQueryParams, StateNeededForHeadAnswerParams } from '../../features/generated-answer/generated-answer-request.js';
+import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.js';
 import type { ConfigurationSection, DebugSection, GeneratedAnswerSection, SearchSection } from '../../state/state-sections.js';
 import { type GenerationStepName } from './generated-answer-state.js';
 import { type GeneratedResponseFormat } from './generated-response-format.js';
@@ -98,22 +98,4 @@ export declare const generateAnswer: import("@reduxjs/toolkit").AsyncThunk<void,
     fulfilledMeta?: unknown;
     rejectedMeta?: unknown;
 }>;
-/**
- * Thunk to generate the head answer as part of the generated answer with follow-ups feature.
- *
- * This action initiates the generation of the main answer when using the Answer Generation API
- * with an agent configuration. It requires an **agent ID** to be present in the engine configuration.
- *
- * @internal
- */
-export declare const generateHeadAnswer: import("@reduxjs/toolkit").AsyncThunk<void, void, {
-    state: StateNeededForHeadAnswerParams;
-    extra: SearchThunkExtraArguments;
-    dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("@reduxjs/toolkit").UnknownAction> | undefined;
-    rejectValue?: unknown;
-    serializedErrorType?: unknown;
-    pendingMeta?: unknown;
-    fulfilledMeta?: unknown;
-    rejectedMeta?: unknown;
-}>;
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-request.d.ts

@@ -1,18 +1,29 @@
 import type { GeneratedAnswerStreamRequest } from '../../api/generated-answer/generated-answer-request.js';
-import type { AnswerParams } from '../../api/knowledge/answer-generation/endpoints/answer/answer-endpoint.js';
 import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
 import type { BaseParam } from '../../api/platform-service-params.js';
 import type { SearchRequest } from '../../api/search/search/search-request.js';
-import type { AuthenticationParam, AutomaticFacetsParams } from '../../api/search/search-api-params.js';
+import type { AnalyticsParam, AuthenticationParam, AutomaticFacetsParams, PipelineRuleParameters } from '../../api/search/search-api-params.js';
 import type { CaseContextParam } from '../../api/service/insight/query/query-request.js';
 import type { NavigatorContext } from '../../app/navigator-context-provider.js';
 import type { SearchAppState } from '../../state/search-app-state.js';
 import type { ConfigurationSection, GeneratedAnswerSection, SearchSection, TabSection } from '../../state/state-sections.js';
+import type { AnyFacetRequest } from '../facets/generic/interfaces/generic-facet-request.js';
 type StateNeededByGeneratedAnswerStream = ConfigurationSection & SearchSection & GeneratedAnswerSection;
 export interface AnswerApiQueryParams extends Omit<SearchRequest, keyof (BaseParam & AuthenticationParam & AutomaticFacetsParams)>, CaseContextParam {
 }
 export declare const buildStreamingRequest: (state: StateNeededByGeneratedAnswerStream) => Promise<GeneratedAnswerStreamRequest>;
 export declare const constructAnswerAPIQueryParams: (state: StreamAnswerAPIState, navigatorContext: NavigatorContext) => AnswerApiQueryParams;
 export type StateNeededForHeadAnswerParams = ConfigurationSection & Partial<SearchAppState> & GeneratedAnswerSection & Partial<TabSection>;
+/**
+ * Parameters for answer generation requests.
+ */
+type AnswerParams = {
+    q: string;
+    facets?: AnyFacetRequest[];
+    searchHub?: string;
+    pipeline?: string;
+    pipelineRuleParameters: PipelineRuleParameters;
+    locale: string;
+} & AnalyticsParam;
 export declare const constructGenerateHeadAnswerParams: (state: StateNeededForHeadAnswerParams, navigatorContext: NavigatorContext) => AnswerParams;
 export {};

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

@@ -3,7 +3,7 @@ import type { GeneratedAnswerCitation } from '../../controllers/generated-answer
 import type { SearchAppState } from '../../state/search-app-state.js';
 import type { GeneratedAnswerSection } from '../../state/state-sections.js';
 export declare const generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => string | undefined;
-export declare const isGeneratedAnswerFeatureEnabledWithAnswerGenerationAPI: (state: Partial<SearchAppState>) => state is StreamAnswerAPIState;
+export declare const isGeneratedAnswerFeatureEnabledWithAgentAPI: (state: Partial<SearchAppState>) => state is StreamAnswerAPIState;
 export declare const selectFieldsToIncludeInCitation: (state: Partial<GeneratedAnswerSection>) => string[] | undefined;
 export declare const citationSourceSelector: ((state: Partial<GeneratedAnswerSection>, citationId: string) => GeneratedAnswerCitation | undefined) & {
     clearCache: () => void;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts

@@ -17,7 +17,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eve
     facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
     numberOfResults?: number;
     firstResult?: number;
-    facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
+    facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
     cq?: string;
     queryCorrection?: {
         enabled?: boolean;

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

@@ -18,7 +18,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, nav
     facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
     numberOfResults?: number;
     firstResult?: number;
-    facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
+    facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
     cq?: string;
     queryCorrection?: {
         enabled?: boolean;

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

@@ -2,11 +2,23 @@ import { type ProductListing, type ProductListingState } from '../../../../contr
 import { type Search } from '../../../../controllers/commerce/search/headless-search.js';
 import type { ControllerDefinitionOption, SubControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { Search, ProductListing, ProductListingState as ProductListState };
-export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'promoteChildToParent'>;
+export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'interactiveSpotlightContent' | 'promoteChildToParent'>;
+/**
+ * Options for configuring the `ProductList` controller.
+ */
+interface ProductListOptions {
+    /**
+     * 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;
+}
 /**
  * Defines a `ProductList` controller instance.
  * @group Definers
  *
+ * @param options - The configurable `ProductList` controller options.
  * @returns The `ProductList` controller definition.
  */
-export declare function defineProductList<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<ProductList, TOptions>;
+export declare function defineProductList<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions & ProductListOptions): SubControllerDefinitionWithoutProps<ProductList, TOptions>;

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

@@ -158,6 +158,8 @@ export * from './features/commerce/triggers/triggers-actions-loader.js';
 export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
 export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
 export type { BaseProduct, ChildProduct, Product, } from './api/commerce/common/product.js';
+export type { 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 { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';
 export { deserializeRelativeDate, validateRelativeDate, } from './api/search/date/relative-date.js';

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

@@ -154,6 +154,7 @@ export * from './features/commerce/triggers/triggers-actions-loader.js';
 export { buildResultTemplatesManager } from './features/result-templates/result-templates-manager.js';
 export { getCommerceApiBaseUrl } from './api/commerce/commerce-api-client.js';
 export type { BaseProduct, ChildProduct, Product, } from './api/commerce/common/product.js';
+export type { 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 { RelativeDate, RelativeDatePeriod, RelativeDateUnit, } from './api/search/date/relative-date.js';

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

@@ -2,12 +2,24 @@ import { type ProductListing, type ProductListingState } from '../../../../contr
 import { type Search } from '../../../../controllers/commerce/search/headless-search.js';
 import type { SearchAndListingControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { Search, ProductListing, ProductListingState as ProductListState };
-export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'promoteChildToParent'>;
+export type ProductList = Pick<ProductListing | Search, 'state' | 'subscribe' | 'interactiveProduct' | 'interactiveSpotlightContent' | 'promoteChildToParent'>;
 export type ProductListDefinition = SearchAndListingControllerDefinitionWithoutProps<ProductList>;
+/**
+ * Options for configuring the `ProductList` controller.
+ */
+interface ProductListOptions {
+    /**
+     * 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;
+}
 /**
  * Defines a `ProductList` controller instance.
  * @group Definers
  *
+ * @param options - The configurable `ProductList` controller options.
  * @returns The `ProductList` controller definition.
  */
-export declare function defineProductList(): ProductListDefinition;
+export declare function defineProductList(options?: ProductListOptions): ProductListDefinition;

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

@@ -1,3 +1,4 @@
+import { type QueryTriggerOptions } from '../../../../controllers/commerce/triggers/headless-query-trigger.js';
 import type { QueryTrigger } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
 import type { SearchOnlyControllerDefinitionWithoutProps } from '../../types/controller-definitions.js';
 export type { QueryTriggerState } from '../../../../controllers/core/triggers/headless-core-query-trigger.js';
@@ -6,7 +7,7 @@ export type QueryTriggerDefinition = SearchOnlyControllerDefinitionWithoutProps<
 /**
  * Defines the `QueryTrigger` controller for the purpose of server-side rendering.
  * @group Definers
- *
+ * @param options - The configurable `QueryTrigger` controller options.
  * @returns The `QueryTrigger` controller definition.
  */
-export declare function defineQueryTrigger(): QueryTriggerDefinition;
+export declare function defineQueryTrigger(options?: QueryTriggerOptions): QueryTriggerDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts

@@ -5,7 +5,7 @@ import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions,
 export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (params: FetchStaticStateParameters<TControllerDefinitions, SolutionType.recommendation>) => Promise<import("../types/build.js").CommonBuildConfig & {
     productId?: string;
     recommendations: Extract<keyof TControllerDefinitions, { [K in keyof TControllerDefinitions]: import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], SolutionType.recommendation> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? never : K; }[keyof TControllerDefinitions]>[];
-} & { [K_1 in keyof TControllerDefinitions as import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K_1], SolutionType.recommendation> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K_1], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? import("../../common/types/utilities.js").HasRequiredKeys<import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T as I extends K_1 ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never> extends false ? never : "controllers" : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T_1 extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T_1 as I extends K_1 ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never; } & {
+} & { [K_1 in keyof TControllerDefinitions as import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K_1], SolutionType.recommendation> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K_1], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? import("../../common/types/utilities.js").HasRequiredKeys<import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T as I extends K_1 ? I : never]: T[I]; } : never> extends false ? never : "controllers" : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T_1 extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T_1 as I extends K_1 ? I : never]: T_1[I]; } : never; } & {
     controllers: import("../types/controller-inference.js").InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, SolutionType.recommendation> & import("../types/controller-definitions.js").FilteredBakedInControllers<SolutionType.recommendation>;
     searchActions: UnknownAction[];
 }>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/static-state-factory.d.ts

@@ -4,7 +4,7 @@ import type { AugmentedControllerDefinition } from '../types/controller-definiti
 import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, FetchStaticStateParameters } from '../types/engine.js';
 export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (params: FetchStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<Omit<{
     controllers?: Record<string, unknown>;
-} & import("../types/build.js").BuildConfig<TControllerDefinitions, TSolutionType> & { [K in keyof TControllerDefinitions as import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], TSolutionType> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? import("../../common/types/utilities.js").HasRequiredKeys<import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T as I extends K ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never> extends false ? never : "controllers" : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T_1 extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T_1 as I extends K ? I : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions>[I]; } : never; }, "controllers"> & {
+} & import("../types/build.js").BuildConfig<TControllerDefinitions, TSolutionType> & { [K in keyof TControllerDefinitions as import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], TSolutionType> extends never ? never : import("../../common/types/utilities.js").HasKey<TControllerDefinitions[K], typeof import("../types/controller-constants.js").recommendationInternalOptionKey> extends never ? import("../../common/types/utilities.js").HasRequiredKeys<import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T as I extends K ? I : never]: T[I]; } : never> extends false ? never : "controllers" : never]: import("../types/controller-inference.js").InferControllerPropsMapFromDefinitions<TControllerDefinitions> extends infer T_1 extends import("../../common/types/controllers.js").ControllersPropsMap ? { [I in keyof T_1 as I extends K ? I : never]: T_1[I]; } : never; }, "controllers"> & {
     controllerProps?: Record<string, unknown> | undefined;
     controllers: import("../types/controller-inference.js").InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, TSolutionType> & import("../types/controller-definitions.js").FilteredBakedInControllers<TSolutionType>;
     searchActions: UnknownAction[];

package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-controller.d.ts

@@ -1,9 +1,10 @@
 import type { CoreEngine, CoreEngineNext } from '../app/engine.js';
 import type { Controller } from '../controllers/controller/headless-controller.js';
 import type { SSRCommerceEngine } from '../ssr/commerce/factories/build-factory.js';
+export { buildMockProductListingController } from './mock-product-listing-controller.js';
+export { buildMockSearchController } from './mock-search-controller.js';
 interface MockController {
     initialState?: Record<string, unknown>;
 }
 export declare function buildMockController(): Controller;
 export declare function buildMockControllerWithInitialState(_engine: CoreEngine | CoreEngineNext | SSRCommerceEngine, props: MockController): Controller;
-export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-product-listing-controller.d.ts

@@ -0,0 +1,2 @@
+import type { ProductListing } from '../controllers/commerce/product-listing/headless-product-listing.js';
+export declare function buildMockProductListingController(): ProductListing;

package/force-app/main/default/staticresources/coveoheadless/definitions/test/mock-search-controller.d.ts

@@ -0,0 +1,2 @@
+import type { Search } from '../controllers/commerce/search/headless-search.js';
+export declare function buildMockSearchController(): Search;

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

@@ -8,5 +8,5 @@ export declare function sortFacets<T extends {
     facetId: string;
 }>(facets: T[], sortOrder: string[]): T[];
 export declare const sortCriteriaMap: Record<string, SortCriteria>;
-export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[];
+export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[];
 export {};