@coveo/quantic 3.29.4 → 3.29.5-pre.0a9e457670

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

@@ -90,15 +90,13 @@ export declare class SearchAnalyticsProvider extends BaseAnalyticsProvider<State
     protected get responseTime(): number;
     protected get numberOfResults(): number;
 }
-interface LegacyConfigureAnalyticsOptions<State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider> {
+interface LegacyConfigureAnalyticsOptions {
     logger: Logger;
     analyticsClientMiddleware?: AnalyticsClientSendEventHook;
     preprocessRequest?: PreprocessRequest;
     provider?: SearchPageClientProvider;
-    getState(): State;
+    getState(): StateNeededBySearchAnalyticsProvider;
 }
-export declare const configureLegacyAnalytics: <State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider>({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: LegacyConfigureAnalyticsOptions<State> & {
-    provider: SearchPageClientProvider;
-}) => CoveoSearchPageClient;
+export declare const configureLegacyAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: LegacyConfigureAnalyticsOptions) => CoveoSearchPageClient;
 export declare const getPageID: () => string;
 export {};

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

@@ -1,7 +1,7 @@
 import type { NavigatorContext } from '../../app/navigator-context-provider.js';
-import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
+import { type StateNeededByAnswerAPI } from './stream-answer-api.js';
 export declare const triggerSearchRequest: import("@reduxjs/toolkit").AsyncThunk<void, {
-    state: StreamAnswerAPIState;
+    state: StateNeededByAnswerAPI;
     navigatorContext: NavigatorContext;
 }, {
     state?: unknown;

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

@@ -1,10 +1,30 @@
 import { type ThunkDispatch, type UnknownAction } from '@reduxjs/toolkit';
 import { type NavigatorContext } from '../../app/navigator-context-provider.js';
+import type { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
+import type { SearchAppState } from '../../state/search-app-state.js';
+import type { ConfigurationSection, GeneratedAnswerSection, InsightConfigurationSection, TabSection } from '../../state/state-sections.js';
 import type { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
+import type { GeneratedAnswerCitation } from '../generated-answer/generated-answer-event-payload.js';
 import type { SearchRequest } from '../search/search/search-request.js';
-import type { GeneratedAnswerStream } from './generated-answer-stream.js';
-import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
-export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StreamAnswerAPIState, unknown, UnknownAction>) => void;
+export type StateNeededByAnswerAPI = {
+    searchHub: string;
+    pipeline: string;
+    answer: ReturnType<typeof answerApi.reducer>;
+} & ConfigurationSection & Partial<SearchAppState> & Partial<InsightConfigurationSection> & GeneratedAnswerSection & Partial<TabSection>;
+export interface GeneratedAnswerStream {
+    answerId?: string;
+    contentFormat?: GeneratedContentFormat;
+    answer?: string;
+    citations?: GeneratedAnswerCitation[];
+    generated?: boolean;
+    isStreaming: boolean;
+    isLoading: boolean;
+    error?: {
+        message: string;
+        code: number;
+    };
+}
+export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StateNeededByAnswerAPI, unknown, UnknownAction>) => void;
 export declare const answerApi: 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, {}>, {
     getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">;
 }, "answer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
@@ -53,7 +73,7 @@ export declare const selectAnswerTriggerParams: ((state: any, ...params: any[])
     argsMemoize: typeof import("reselect").weakMapMemoize;
     memoize: typeof import("reselect").weakMapMemoize;
 };
-export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, usage: "fetch" | "select", navigatorContext: NavigatorContext) => {
+export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI, usage: "fetch" | "select", navigatorContext: NavigatorContext) => {
     analytics?: {
         actionCause?: string;
         customData?: object;
@@ -80,12 +100,12 @@ export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, u
     } | undefined;
     enableDidYouMean?: boolean | undefined;
     fieldsToInclude?: string[] | undefined;
-    facets?: (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)[] | undefined;
+    facets?: (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)[] | undefined;
     pipeline?: string | undefined;
     searchHub?: string | undefined;
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
-            responseFormat: import("../../index.js").GeneratedResponseFormat;
+            responseFormat: import("../../features/generated-answer/generated-response-format.js").GeneratedResponseFormat;
             citationsFieldToInclude: string[];
         };
     };
@@ -97,8 +117,8 @@ export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, u
     aq?: string | undefined;
     q: string | undefined;
 };
-export declare const fetchAnswer: (state: StreamAnswerAPIState, navigatorContext: NavigatorContext) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">>, any, any, UnknownAction>;
-export declare const selectAnswer: (state: StreamAnswerAPIState, navigatorContext?: NavigatorContext) => ({
+export declare const fetchAnswer: (state: StateNeededByAnswerAPI, navigatorContext: NavigatorContext) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">>, any, any, UnknownAction>;
+export declare const selectAnswer: (state: StateNeededByAnswerAPI, navigatorContext?: NavigatorContext) => ({
     status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
     originalArgs?: undefined | undefined;
     data?: undefined | undefined;

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

@@ -1,12 +1,12 @@
 /** biome-ignore-all lint/suspicious/noExplicitAny: <mock> */
-import type { StreamAnswerAPIState } from '../stream-answer-api-state.js';
-export declare const streamAnswerAPIStateMock: StreamAnswerAPIState;
-export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StreamAnswerAPIState;
-export declare const streamAnswerAPIStateMockWithoutAnyTab: StreamAnswerAPIState;
-export declare const streamAnswerAPIStateMockWithStaticFiltersSelected: StreamAnswerAPIState;
-export declare const streamAnswerAPIStateMockWithNonValidFilters: StreamAnswerAPIState;
-export declare const streamAnswerAPIStateMockWithoutAnyFilters: StreamAnswerAPIState;
-export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpression: StreamAnswerAPIState;
+import type { StateNeededByAnswerAPI } from '../stream-answer-api.js';
+export declare const streamAnswerAPIStateMock: StateNeededByAnswerAPI;
+export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StateNeededByAnswerAPI;
+export declare const streamAnswerAPIStateMockWithoutAnyTab: StateNeededByAnswerAPI;
+export declare const streamAnswerAPIStateMockWithStaticFiltersSelected: StateNeededByAnswerAPI;
+export declare const streamAnswerAPIStateMockWithNonValidFilters: StateNeededByAnswerAPI;
+export declare const streamAnswerAPIStateMockWithoutAnyFilters: StateNeededByAnswerAPI;
+export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpression: StateNeededByAnswerAPI;
 export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWithEmptyCQ: {
     advancedSearchQueries: {
         cq: string;
@@ -26,9 +26,9 @@ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWi
     };
     searchHub: string;
     pipeline: string;
-    answer: import("@reduxjs/toolkit/query").CombinedState<{
-        getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<import("../../search/search/search-request.js").SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, import("../generated-answer-stream.js").GeneratedAnswerStream, "answer">;
-    }, never, "answer">;
+    answer: ReturnType<import("redux").Reducer<import("@reduxjs/toolkit/query").CombinedState<{
+        getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<import("../../search/search/search-request.js").SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, import("../stream-answer-api.js").GeneratedAnswerStream, "answer">;
+    }, never, "answer">, import("redux").UnknownAction>>;
     configuration: import("../../../features/configuration/configuration-state.js").ConfigurationState;
     facetSet?: import("../../../features/facets/facet-set/facet-set-state.js").FacetSetState | undefined;
     dateFacetSet?: import("../../../features/facets/range-facets/date-facet-set/date-facet-set-state.js").DateFacetSetState | undefined;
@@ -66,7 +66,7 @@ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWi
     instantResults?: import("../../../features/instant-results/instant-results-state.js").InstantResultsState | undefined;
     insightConfiguration?: import("../../../features/insight-configuration/insight-configuration-state.js").InsightConfigurationState | undefined;
 };
-export declare const streamAnswerAPIStateMockWithoutSearchAction: StreamAnswerAPIState;
+export declare const streamAnswerAPIStateMockWithoutSearchAction: StateNeededByAnswerAPI;
 export declare const expectedStreamAnswerAPIParam: {
     q: string;
     aq: string;

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

@@ -32,18 +32,6 @@ export interface Sort extends Controller {
      * Verifies whether the specified sort criterion is the currently active one.
      *
      * @param criterion - The sort criterion to evaluate.
-     * Can be a single criterion or an array of criteria.
-     * The criteria in an array will be applied sequentially. For example, if there's a tie on the 1st criterion, the API uses the 2nd criterion to break the tie. However, this only works when combining:
-     * `SortByRelevancy` followed by one or more `SortByField` or `SortByDate` criteria.
-     * `SortByQRE` followed by one or more `SortByField` or `SortByDate` criteria.
-     * Two or more `SortByField` criteria.
-     * A single `SortByDate` criterion and one or more `SortByField` criteria in any order.
-     *
-     * Examples:
-     * * `SortByRelevancy`, `SortByField`
-     * * `SortByQRE`, `SortByField`
-     * * `SortByDate`, `SortByField`, `SortByField`
-     *
      * @returns `true` if the specified sort criterion is the currently active one; `false` otherwise.
      */
     isSortedBy(criterion: SortCriterion | SortCriterion[]): boolean;

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

@@ -1,7 +1,10 @@
 import type { GeneratedAnswerCitation } from '../../controllers/generated-answer/headless-generated-answer.js';
 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 generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => {
+    answerAPIEnabled: boolean;
+    id: string | undefined;
+};
 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

@@ -24,7 +24,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

@@ -25,7 +25,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/types/fetch-static-state.d.ts

@@ -5,6 +5,10 @@ import type { SolutionType } from './controller-constants.js';
 import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
 import type { EngineStaticState } from './engine.js';
 import type { FromBuildResult } from './from-build-result.js';
+/**
+ * @deprecated This interface will be remove on the next major version.
+ * Use BuildConfig interface instead
+ */
 export type FetchStaticStateOptions = {};
 export type FetchStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/build.d.ts

@@ -3,6 +3,9 @@ import type { ControllersMap, ControllersPropsMap } from './controllers.js';
 import type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './engine.js';
 import type { OptionsExtender, OptionsTuple } from './utilities.js';
 interface BuildOptions<TEngineOptions> {
+    /**
+     * @deprecated This option will be removed in the next major version.
+     */
     extend?: OptionsExtender<TEngineOptions>;
 }
 export type Build<TEngine extends CoreEngine | CoreEngineNext, TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<EngineDefinitionBuildResult<TEngine, TControllersMap>>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/engine.d.ts

@@ -38,6 +38,9 @@ export interface EngineDefinition<TEngine extends CoreEngine | CoreEngineNext, T
      */
     build: Build<TEngine, TEngineOptions, InferControllersMapFromDefinition<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>;
 }
+/**
+ * @deprecated Use SearchEngineDefinitionBuildResult or CommerceEngineDefinitionBuildResult instead
+ */
 export interface EngineDefinitionBuildResult<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> {
     engine: TEngine;
     controllers: TControllers;

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

@@ -68,7 +68,6 @@
  */
 export type { Relay } from '@coveo/relay';
 export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
-export type { CommerceEngineOptions } from './app/commerce-engine/commerce-engine.js';
 export type { CommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
 export { getSampleCommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
 export type { CoreEngineNext, ExternalEngineOptions } from './app/engine.js';
@@ -119,10 +118,11 @@ export type { RedirectionTrigger, RedirectionTriggerDefinition, RedirectionTrigg
 export { defineRedirectionTrigger } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
 export { defineCommerceEngine } from './ssr-next/commerce/engine/commerce-engine.ssr.js';
 export type { CommerceEngineDefinitionOptions, SSRCommerceEngine as CommerceEngine, } from './ssr-next/commerce/factories/build-factory.js';
+export type { BuildConfig, SSRCommerceEngineOptions, } from './ssr-next/commerce/types/build.js';
 export { SolutionType } from './ssr-next/commerce/types/controller-constants.js';
-export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
+export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
 export type { InferControllerFromDefinition, InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition, InferHydratedState, InferStaticState, } from './ssr-next/commerce/types/controller-inference.js';
-export type { CommerceEngineDefinition, EngineStaticState, FetchStaticState, FetchStaticStateOptions, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
+export type { CommerceEngineDefinition, CommerceEngineDefinitionBuildResult, EngineStaticState, FetchStaticState, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
 export { Kind } from './ssr-next/commerce/types/kind.js';
 export type { CommerceAppState, CommerceProductListingParametersState, CommerceSearchParametersState, } from './state/commerce-app-state.js';
 export * from './features/commerce/configuration/configuration-actions-loader.js';

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

@@ -1,11 +1,13 @@
-import { type Recommendations, type RecommendationsOptions, type RecommendationsProps, type RecommendationsState } from '../../../../controllers/commerce/recommendations/headless-recommendations.js';
+import { type Recommendations, type RecommendationsOptions, type RecommendationsState } from '../../../../controllers/commerce/recommendations/headless-recommendations.js';
 import { recommendationInternalOptionKey } from '../../types/controller-constants.js';
 import type { RecommendationOnlyControllerDefinitionWithProps } from '../../types/controller-definitions.js';
 export type { Recommendations, RecommendationsState };
 export type RecommendationsDefinitionMeta = {
-    [recommendationInternalOptionKey]: {} & RecommendationsProps['options'];
+    [recommendationInternalOptionKey]: {} & RecommendationsOptions;
 };
-export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithProps<Recommendations, Partial<RecommendationsOptions>> {
+export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithProps<Recommendations, {
+    initialState: Partial<RecommendationsOptions>;
+}> {
 }
 /**
  * Defines a `Recommendations` controller instance.
@@ -14,4 +16,6 @@ export interface RecommendationsDefinition extends RecommendationOnlyControllerD
  * @param props - The configurable `Recommendations` properties.
  * @returns The `Recommendations` controller definition.
  * */
-export declare function defineRecommendations(props: RecommendationsProps): RecommendationsDefinition & RecommendationsDefinitionMeta;
+export declare function defineRecommendations(props: {
+    options: Omit<RecommendationsOptions, 'productId'>;
+}): RecommendationsDefinition & RecommendationsDefinitionMeta;

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

@@ -1,6 +1,7 @@
 import type { Action } from '@reduxjs/toolkit';
-import { type CommerceEngine, type CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
+import { type CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
+import type { SSRCommerceEngineOptions } from '../types/build.js';
 import { SolutionType } from '../types/controller-constants.js';
 import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
 import type { BuildParameters, CommerceControllerDefinitionsMap, EngineDefinitionOptions } from '../types/engine.js';
@@ -15,8 +16,8 @@ export interface SSRCommerceEngine extends CommerceEngine {
      */
     waitForRequestCompletedAction(): Promise<Action>[];
 }
-export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<CommerceEngineOptions, TControllers>;
-export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <T extends SolutionType>(solutionType: T) => (...[buildOptions]: BuildParameters<TControllerDefinitions>) => Promise<{
+export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<SSRCommerceEngineOptions, TControllers>;
+export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <T extends SolutionType>(solutionType: T) => (...[buildOptions]: BuildParameters<TControllerDefinitions>) => Promise<{
     engine: SSRCommerceEngine;
     controllers: import("../types/controller-inference.js").InferControllersMapFromDefinition<TControllerDefinitions, T>;
 }>;

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

@@ -1,4 +1,5 @@
 import type { SolutionType } from '../types/controller-constants.js';
+import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
 import type { CommerceControllerDefinitionsMap, HydrateStaticStateFunction } from '../types/engine.js';
 import { type CommerceEngineDefinitionOptions } from './build-factory.js';
-export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;
+export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;

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

@@ -1,3 +1,3 @@
 import type { CommerceControllerDefinitionsMap, HydrateStaticStateFunction } from '../types/engine.js';
 import { type CommerceEngineDefinitionOptions } from './build-factory.js';
-export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): HydrateStaticStateFunction<TControllerDefinitions>;
+export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): HydrateStaticStateFunction<TControllerDefinitions>;

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

@@ -1,3 +1,4 @@
+import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
 import type { CommerceControllerDefinitionsMap, FetchStaticStateFunction } from '../types/engine.js';
 import { type CommerceEngineDefinitionOptions } from './build-factory.js';
-export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): FetchStaticStateFunction<TControllerDefinitions>;
+export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): FetchStaticStateFunction<TControllerDefinitions>;

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

@@ -1,4 +1,5 @@
 import { SolutionType } from '../types/controller-constants.js';
+import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
 import type { CommerceControllerDefinitionsMap, FetchStaticStateFunction } from '../types/engine.js';
 import { type CommerceEngineDefinitionOptions } from './build-factory.js';
-export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;
+export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;

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

@@ -1,14 +1,80 @@
+import type { CurrencyCodeISO4217 } from '@coveo/relay-event-types';
+import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
-import type { OptionsExtender, OptionsTuple } from '../../common/types/utilities.js';
-import type { SSRCommerceEngine } from '../factories/build-factory.js';
+import type { HasKey, OptionsTuple } from '../../common/types/utilities.js';
+import type { CartInitialState } from '../controllers/cart/headless-cart.ssr.js';
+import type { UserLocation } from '../controllers/context/headless-context.ssr.js';
+import type { ParameterManagerState, Parameters } from '../controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
 import type { SolutionType } from './controller-constants.js';
-import type { ControllerDefinitionsMap, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './controller-definitions.js';
-interface BuildOptions<TEngineOptions> {
-    extend?: OptionsExtender<TEngineOptions>;
+import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, IsRecommendationController } from './controller-definitions.js';
+import type { CommerceEngineDefinitionBuildResult } from './engine.js';
+export interface SearchBuildConfig extends CommonBuildConfig {
+    query: string;
 }
+/**
+ * RecommendationBuildConfig defines the shape of the config object required when fetching static state for recommendations.
+ *
+ * The `recommendations` property is a string array containing the names of the recommendation controllers
+ * that were defined in your engine definition. This allows you to specify which recommendation controllers
+ * should be included in the SSR request.
+ *
+ * For example, given the following engine definition:
+ *
+ * ```ts
+ * const {recommendationEngineDefinition} = defineCommerceEngine({
+ *   controllers: {
+ *     popularViewed: defineRecommendations({options: {slotId: '...'}}),
+ *     popularBought: defineRecommendations({options: {slotId: '...'}}),
+ *     viewedTogether: defineRecommendations({options: {slotId: '...'}}),
+ *     // ...other controllers
+ *   },
+ * });
+ *
+ * // When fetching static state for recommendations:
+ * const staticState = await recommendationEngineDefinition.fetchStaticState({
+ *   recommendations: ['popularBought', 'viewedTogether'],
+ *   // ...other config
+ * });
+ * ```
+ *
+ * In this example, only the `popularBought` and `viewedTogether` recommendation controllers will be included in the SSR request.
+ */
+export type RecommendationBuildConfig<TControllers extends ControllerDefinitionsMap<Controller>> = CommonBuildConfig & {
+    /**
+     * The unique identifier of the product to use for seeded recommendations.
+     */
+    productId?: string;
+    /**
+     * An array of recommendation controller names from your engine definition to include in the SSR request.
+     * Each name corresponds to the key used when defining recommendation controllers in your engine definition.
+     * If not specified, no recommendation requests will be executed.
+     */
+    recommendations: Array<Extract<keyof TControllers, {
+        [K in keyof TControllers]: HasKey<TControllers[K], SolutionType.recommendation> extends never ? never : IsRecommendationController<TControllers[K]> extends never ? never : K;
+    }[keyof TControllers]>>;
+};
+export interface ListingBuildConfig extends CommonBuildConfig {
+}
+export interface StandaloneBuildConfig extends CommonBuildConfig {
+}
+export interface CommonBuildConfig {
+    url: string;
+    language: string;
+    country: string;
+    currency: CurrencyCodeISO4217;
+    location?: UserLocation;
+    cart?: CartInitialState;
+    searchParams?: Omit<ParameterManagerState<Parameters>['parameters'], 'q'>;
+}
+export type BuildConfig<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = TSolutionType extends SolutionType.search ? SearchBuildConfig : TSolutionType extends SolutionType.listing ? ListingBuildConfig : TSolutionType extends SolutionType.recommendation ? RecommendationBuildConfig<TControllers> : TSolutionType extends SolutionType.standalone ? CommonBuildConfig : never;
+/**
+ * Commerce engine options for SSR scenarios where context is defined when fetching static state.
+ */
+export type SSRCommerceEngineOptions = Omit<CommerceEngineOptions, 'configuration'> & {
+    configuration: Omit<CommerceEngineOptions['configuration'], 'context'>;
+};
 /**
  * @internal
  */
-export type Build<TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineDefinitionBuildResult<SSRCommerceEngine, TControllersMap>>;
-export {};
+export type Build<TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildConfig<TControllersDefinitionsMap, TSolutionType> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<CommerceEngineDefinitionBuildResult<TControllersMap>>;