@coveo/quantic 3.10.0-pre.faaf12d7a7 → 3.10.0

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

@@ -18,10 +18,10 @@ export declare const buildRequest: (req: CommerceAPIRequest, path: CommerceApiMe
         sort: import("./sort.js").SortOption | undefined;
     };
     url: string;
-    origin: import("../../preprocess-request.js").PlatformClientOrigin;
     accessToken: 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: BaseParam, path: CommerceApiMethod) => Pick<PlatformClientCallOptions, 'accessToken' | 'method' | 'contentType' | 'url' | 'origin' | 'requestMetadata'>;

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

@@ -15,9 +15,9 @@ export declare const buildRecommendationsRequest: (req: CommerceRecommendationsR
         perPage: number | undefined;
     };
     url: string;
-    origin: import("../../preprocess-request.js").PlatformClientOrigin;
     accessToken: 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

@@ -12,9 +12,9 @@ export declare const buildQuerySuggestRequest: (req: QuerySuggestRequest) => {
         currency: string;
     };
     url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     accessToken: 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/stream-answer-api.d.ts

@@ -70,7 +70,7 @@ export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI,
     } | 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/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | 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;
     pipeline?: string | undefined;
     searchHub?: string | undefined;
     q: string | undefined;

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

@@ -8,8 +8,8 @@ export declare const buildGetCaseClassificationsRequest: (req: GetCaseClassifica
         fields: import("../case-assist-params.js").CaseFields;
     };
     url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     accessToken: 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

@@ -9,8 +9,8 @@ export declare const buildGetDocumentSuggestionsRequest: (req: GetDocumentSugges
         context: Record<string, string | string[]> | undefined;
     };
     url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     accessToken: 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

@@ -4,8 +4,8 @@ export type GetInsightInterfaceConfigRequest = BaseParam & InsightIdParam;
 export declare const buildGetInsightInterfaceConfigRequest: (req: GetInsightInterfaceConfigRequest) => {
     requestParams: {};
     url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     accessToken: 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

@@ -9,17 +9,17 @@ interface CaseContextParam {
 export declare const buildInsightQueryRequest: (req: InsightQueryRequest) => {
     requestParams: {};
     url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     accessToken: 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: {};
     url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     accessToken: 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/api/service/insight/user-actions/user-actions-request.d.ts

@@ -11,9 +11,9 @@ export declare const buildInsightUserActionsRequest: (req: InsightUserActionsReq
         objectId: string;
     };
     url: string;
-    origin: import("../../../preprocess-request.js").PlatformClientOrigin;
     accessToken: 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/app/commerce-engine/commerce-engine.ssr.d.ts

@@ -1,21 +1,11 @@
 /**
  * Utility functions to be used for Commerce Server Side Rendering.
  */
-import { Action } from '@reduxjs/toolkit';
 import type { Controller } from '../../controllers/controller/headless-controller.js';
+import { CommerceEngineDefinitionOptions } from '../commerce-ssr-engine/factories/build-factory.js';
 import { ControllerDefinitionsMap, SolutionType } from '../commerce-ssr-engine/types/common.js';
-import { EngineDefinition, EngineDefinitionOptions } from '../commerce-ssr-engine/types/core-engine.js';
-import { CommerceEngine, CommerceEngineOptions } from './commerce-engine.js';
-/**
- * The SSR commerce engine.
- */
-export interface SSRCommerceEngine extends CommerceEngine {
-    /**
-     * Waits for the search to be completed and returns a promise that resolves to a `SearchCompletedAction`.
-     */
-    waitForRequestCompletedAction(): Promise<Action>;
-}
-export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<CommerceEngineOptions, TControllers>;
+import { EngineDefinition } from '../commerce-ssr-engine/types/core-engine.js';
+import { CommerceEngineOptions } from './commerce-engine.js';
 export interface CommerceEngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> extends EngineDefinition<TControllers, CommerceEngineOptions, TSolutionType> {
 }
 /**
@@ -28,4 +18,5 @@ export declare function defineCommerceEngine<TControllerDefinitions extends Cont
     listingEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, SolutionType.listing>;
     searchEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, SolutionType.search>;
     standaloneEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, SolutionType.standalone>;
+    recommendationEngineDefinition: CommerceEngineDefinition<TControllerDefinitions, SolutionType.recommendation>;
 };

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

@@ -1,7 +1,12 @@
+import { UnknownAction } from '@reduxjs/toolkit';
 import { Controller } from '../../controllers/controller/headless-controller.js';
-import { SSRCommerceEngine } from '../commerce-engine/commerce-engine.ssr.js';
-import { InferControllerPropsMapFromDefinitions } from '../ssr-engine/types/common.js';
-import { ControllerDefinitionOption, ControllerDefinitionsMap, InferControllersMapFromDefinition, SolutionType } from './types/common.js';
+import { ControllersMap, InferControllerStaticStateMapFromControllers } from '../ssr-engine/types/common.js';
+import { SSRCommerceEngine } from './factories/build-factory.js';
+import { ControllerDefinitionOption, ControllerDefinitionsMap, EngineStaticState, InferControllerPropsMapFromDefinitions, InferControllersMapFromDefinition, SolutionType } from './types/common.js';
+export declare function createStaticState<TSearchAction extends UnknownAction>({ searchActions, controllers, }: {
+    searchActions: TSearchAction[];
+    controllers: ControllersMap;
+}): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromControllers<ControllersMap>>;
 export declare function buildControllerDefinitions<TControllerDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>({ definitionsMap, engine, solutionType, propsMap, }: {
     definitionsMap: TControllerDefinitionsMap;
     engine: SSRCommerceEngine;

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

@@ -0,0 +1,19 @@
+import { Action } from '@reduxjs/toolkit';
+import { Controller } from '../../../controllers/controller/headless-controller.js';
+import { CommerceEngine, CommerceEngineOptions } from '../../commerce-engine/commerce-engine.js';
+import { ControllerDefinitionsMap, SolutionType } from '../types/common.js';
+import { BuildParameters, CommerceControllerDefinitionsMap, EngineDefinitionOptions } from '../types/core-engine.js';
+/**
+ * The SSR commerce engine.
+ */
+export interface SSRCommerceEngine extends CommerceEngine {
+    /**
+     * Waits for the request to be completed and returns a promise that resolves to an `Action`.
+     */
+    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<{
+    engine: SSRCommerceEngine;
+    controllers: import("../types/common.js").InferControllersMapFromDefinition<TControllerDefinitions, T>;
+}>;

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

@@ -0,0 +1,4 @@
+import { SolutionType } from '../types/common.js';
+import { HydrateStaticStateFunction, CommerceControllerDefinitionsMap } from '../types/core-engine.js';
+import { CommerceEngineDefinitionOptions } from './build-factory.js';
+export declare const hydratedStaticStateFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;

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

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

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

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

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

@@ -0,0 +1,4 @@
+import { SolutionType } from '../types/common.js';
+import { FetchStaticStateFunction, CommerceControllerDefinitionsMap } from '../types/core-engine.js';
+import { CommerceEngineDefinitionOptions } from './build-factory.js';
+export declare const fetchStaticStateFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;

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

@@ -0,0 +1,17 @@
+import type { ControllersMap, ControllersPropsMap, EngineDefinitionBuildResult, OptionsExtender, OptionsTuple } from '../../ssr-engine/types/common.js';
+import { SSRCommerceEngine } from '../factories/build-factory.js';
+import { EngineDefinitionControllersPropsOption, SolutionType } from './common.js';
+export interface BuildOptions<TEngineOptions> {
+    extend?: OptionsExtender<TEngineOptions>;
+}
+export type Build<TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TSolutionType extends SolutionType> = TSolutionType extends SolutionType.recommendation ? {
+    /**
+     * Initializes an engine and controllers from the definition.
+     */
+    (controllers: (keyof TControllersMap)[]): Promise<EngineDefinitionBuildResult<SSRCommerceEngine, TControllersMap>>;
+} : {
+    /**
+     * Initializes an engine and controllers from the definition.
+     */
+    (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersProps>>): Promise<EngineDefinitionBuildResult<SSRCommerceEngine, TControllersMap>>;
+};

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

@@ -1,12 +1,14 @@
+import { UnknownAction } from '@reduxjs/toolkit';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { InvalidControllerDefinition } from '../../../utils/errors.js';
-import { SSRCommerceEngine } from '../../commerce-engine/commerce-engine.ssr.js';
-import type { HasKey, InferControllerStaticStateMapFromControllers, InferControllerStaticStateFromController, InferControllerPropsMapFromDefinitions } from '../../ssr-engine/types/common.js';
-export type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, InferControllerPropsMapFromDefinitions, };
+import type { HasKey, InferControllerStaticStateMapFromControllers, InferControllerStaticStateFromController, InferControllerPropsMapFromDefinitions, ControllerStaticStateMap, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, OptionsTuple } from '../../ssr-engine/types/common.js';
+import { SSRCommerceEngine } from '../factories/build-factory.js';
+export type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, InferControllerPropsMapFromDefinitions, };
 export declare enum SolutionType {
     search = "search",
     listing = "listing",
-    standalone = "standalone"
+    standalone = "standalone",
+    recommendation = "recommendation"
 }
 export interface ControllerDefinitionWithoutProps<TController extends Controller> {
     /**
@@ -29,6 +31,10 @@ export interface ControllerDefinitionWithProps<TController extends Controller, T
      */
     buildWithProps(engine: SSRCommerceEngine, props: TProps, solutionType?: SolutionType): TController;
 }
+export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
+    searchActions: TSearchAction[];
+    controllers: TControllers;
+}
 export type ControllerDefinition<TController extends Controller> = ControllerDefinitionWithoutProps<TController> | ControllerDefinitionWithProps<TController, unknown>;
 export interface ControllerDefinitionsMap<TController extends Controller> {
     [customName: string]: ControllerDefinition<TController>;
@@ -79,6 +85,12 @@ interface ListingOnlyController {
      */
     [SolutionType.listing]: true;
 }
+interface RecommendationOnlyController {
+    /**
+     * @internal
+     */
+    [SolutionType.recommendation]: true;
+}
 interface SearchAndListingController {
     /**
      * @internal
@@ -93,8 +105,10 @@ export type SearchOnlyControllerDefinitionWithoutProps<TController extends Contr
 export type SearchOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchOnlyController;
 export type ListingOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingOnlyController;
 export type ListingOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & ListingOnlyController;
-export type UniversalControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & UniversalController;
-export type UniversalControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & UniversalController;
+export type RecommendationOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & RecommendationOnlyController;
+export type RecommendationOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & RecommendationOnlyController;
+export type NonRecommendationControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & UniversalController;
+export type NonRecommendationControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & UniversalController;
 export type SearchAndListingControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchAndListingController;
 export type SearchAndListingControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchAndListingController;
 export type SubControllerDefinitionWithoutProps<TController extends Controller, TDefinition extends ControllerDefinitionOption | undefined> = TDefinition extends {

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

@@ -1,14 +1,16 @@
 import { UnknownAction } from '@reduxjs/toolkit';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import { SSRCommerceEngine } from '../../commerce-engine/commerce-engine.ssr.js';
+import { CommerceEngineDefinition } from '../../commerce-engine/commerce-engine.ssr.js';
 import { EngineConfiguration } from '../../engine-configuration.js';
 import { NavigatorContextProvider } from '../../navigatorContextProvider.js';
-import { Build } from '../../ssr-engine/types/build.js';
-import { InferControllerPropsMapFromDefinitions } from '../../ssr-engine/types/common.js';
-import { FetchStaticState } from '../../ssr-engine/types/fetch-static-state.js';
-import { HydrateStaticState } from '../../ssr-engine/types/hydrate-static-state.js';
-import { ControllerDefinitionsMap, InferControllersMapFromDefinition, SolutionType, InferControllerStaticStateMapFromDefinitionsWithSolutionType } from './common.js';
-export type { HydrateStaticState, FetchStaticState };
+import type { FromBuildResultOptions } from '../../ssr-engine/types/from-build-result.js';
+import { SSRCommerceEngine } from '../factories/build-factory.js';
+import { Build, BuildOptions } from './build.js';
+import { ControllerDefinitionsMap, InferControllersMapFromDefinition, SolutionType, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllerPropsMapFromDefinitions } from './common.js';
+import { FetchStaticState, FetchStaticStateOptions } from './fetch-static-state.js';
+import { FromBuildResult } from './from-build-result.js';
+import { HydrateStaticState, HydrateStaticStateOptions } from './hydrate-static-state.js';
+export type { FromBuildResult, FromBuildResultOptions, HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, FetchStaticStateOptions, Build, BuildOptions, };
 export type EngineDefinitionOptions<TOptions extends {
     configuration: EngineConfiguration;
 }, TControllers extends ControllerDefinitionsMap<Controller>> = TOptions & {
@@ -21,15 +23,15 @@ export interface EngineDefinition<TControllers extends ControllerDefinitionsMap<
     /**
      * Fetches the static state on the server side using your engine definition.
      */
-    fetchStaticState: FetchStaticState<SSRCommerceEngine, InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>>;
+    fetchStaticState: FetchStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TSolutionType>;
     /**
      * Fetches the hydrated state on the client side using your engine definition and the static state.
      */
-    hydrateStaticState: HydrateStaticState<SSRCommerceEngine, InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerPropsMapFromDefinitions<TControllers>>;
+    hydrateStaticState: HydrateStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerPropsMapFromDefinitions<TControllers>, TSolutionType>;
     /**
      * Builds an engine and its controllers from an engine definition.
      */
-    build: Build<SSRCommerceEngine, TEngineOptions, InferControllersMapFromDefinition<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>>;
+    build: Build<TEngineOptions, InferControllersMapFromDefinition<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TSolutionType>;
     /**
      * Sets the navigator context provider.
      * This provider is essential for retrieving navigation-related data such as referrer, userAgent, location, and clientId, which are crucial for handling both server-side and client-side API requests effectively.
@@ -47,3 +49,20 @@ export type InferHydratedState<T extends {
 export type InferBuildResult<T extends {
     build(...args: unknown[]): Promise<unknown>;
 }> = Awaited<ReturnType<T['build']>>;
+export type CommerceControllerDefinitionsMap = ControllerDefinitionsMap<Controller>;
+type Definition<TControllerDefinitions extends CommerceControllerDefinitionsMap> = CommerceEngineDefinition<TControllerDefinitions, SolutionType>;
+export type BuildFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['build'];
+export type FetchStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['fetchStaticState'];
+export type HydrateStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['hydrateStaticState'];
+export type FetchStaticStateFromBuildResultFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = FetchStaticStateFunction<TControllerDefinitions>['fromBuildResult'];
+export type HydrateStaticStateFromBuildResultFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = HydrateStaticStateFunction<TControllerDefinitions>['fromBuildResult'];
+export type BuildParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<BuildFunction<TControllerDefinitions>>;
+export type FetchStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<FetchStaticStateFunction<TControllerDefinitions>>;
+export type HydrateStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<HydrateStaticStateFunction<TControllerDefinitions>>;
+export type FetchStaticStateFromBuildResultParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<FetchStaticStateFromBuildResultFunction<TControllerDefinitions>>;
+export type HydrateStaticStateFromBuildResultParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<HydrateStaticStateFromBuildResultFunction<TControllerDefinitions>>;
+export type Controllers<TControllerDefinitions extends CommerceControllerDefinitionsMap> = InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>;
+export type BuildResult<TControllerDefinitions extends CommerceControllerDefinitionsMap> = {
+    engine: SSRCommerceEngine;
+    controllers: Controllers<TControllerDefinitions>;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/fetch-static-state.d.ts

@@ -0,0 +1,23 @@
+import type { UnknownAction } from '@reduxjs/toolkit';
+import { SolutionType } from '../../commerce-ssr-engine/types/common.js';
+import type { EngineDefinitionControllersPropsOption, EngineStaticState } from '../../commerce-ssr-engine/types/common.js';
+import type { ControllersMap, ControllersPropsMap, ControllerStaticStateMap, OptionsTuple } from '../../ssr-engine/types/common.js';
+import { FromBuildResult } from './from-build-result.js';
+export type FetchStaticStateOptions = {};
+export type FetchStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TSolutionType extends SolutionType> = TSolutionType extends SolutionType.recommendation ? {
+    /**
+     * Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
+     *
+     * Useful for static generation and server-side rendering.
+     */
+    (controllers: Array<keyof TControllers>): Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
+    fromBuildResult: FromBuildResult<TControllers, FetchStaticStateOptions, EngineStaticState<TSearchAction, TControllersStaticState>>;
+} : {
+    /**
+     * Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
+     *
+     * Useful for static generation and server-side rendering.
+     */
+    (...params: OptionsTuple<FetchStaticStateOptions & EngineDefinitionControllersPropsOption<TControllersProps>>): Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
+    fromBuildResult: FromBuildResult<TControllers, FetchStaticStateOptions, EngineStaticState<TSearchAction, TControllersStaticState>>;
+};

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

@@ -0,0 +1,20 @@
+import { ControllersMap } from '../../ssr-engine/types/common.js';
+import { SSRCommerceEngine } from '../factories/build-factory.js';
+import { EngineDefinitionBuildResult } from './common.js';
+export interface FromBuildResultOptions<TControllers extends ControllersMap> {
+    /**
+     * The build result of the engine
+     */
+    buildResult: EngineDefinitionBuildResult<SSRCommerceEngine, TControllers>;
+    /**
+     * An optional array of keys representing the recommendation controllers to refresh.
+     * If a recommendation key defined in your engine definition is present in this list, the associate recommendation controller
+     * will query the API.
+     *
+     * This is applicable only if the engine is a recommendation engine.
+     */
+    allowedRecommendationKeys?: (keyof TControllers)[];
+}
+export interface FromBuildResult<TControllers extends ControllersMap, TOptions, TReturn> {
+    (options: FromBuildResultOptions<TControllers> & TOptions): Promise<TReturn>;
+}

package/force-app/main/default/staticresources/coveoheadless/definitions/app/commerce-ssr-engine/types/hydrate-static-state.d.ts

@@ -0,0 +1,25 @@
+import type { UnknownAction } from '@reduxjs/toolkit';
+import type { ControllersMap, ControllersPropsMap, HydratedState, OptionsTuple } from '../../ssr-engine/types/common.js';
+import { SSRCommerceEngine } from '../factories/build-factory.js';
+import { EngineDefinitionControllersPropsOption, SolutionType } from './common.js';
+import { FromBuildResult } from './from-build-result.js';
+export interface HydrateStaticStateOptions<TSearchAction> {
+    searchActions: TSearchAction[];
+}
+export type HydrateStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap, TSolutionType extends SolutionType> = TSolutionType extends SolutionType.recommendation ? {
+    /**
+     * Creates a new engine from the snapshot of the engine created in SSR with fetchStaticState.
+     *
+     * Useful when hydrating a server-side-rendered engine.
+     */
+    (...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction>>): Promise<HydratedState<SSRCommerceEngine, TControllers>>;
+    fromBuildResult: FromBuildResult<TControllers, HydrateStaticStateOptions<TSearchAction>, HydratedState<SSRCommerceEngine, TControllers>>;
+} : {
+    /**
+     * Creates a new engine from the snapshot of the engine created in SSR with fetchStaticState.
+     *
+     * Useful when hydrating a server-side-rendered engine.
+     */
+    (...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction> & EngineDefinitionControllersPropsOption<TControllersProps>>): Promise<HydratedState<SSRCommerceEngine, TControllers>>;
+    fromBuildResult: FromBuildResult<TControllers, HydrateStaticStateOptions<TSearchAction>, HydratedState<SSRCommerceEngine, TControllers>>;
+};

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

@@ -11,4 +11,4 @@ export interface LoggerOptions {
      */
     logFormatter?: (object: {}) => {};
 }
-export declare function buildLogger(options: LoggerOptions | undefined): import("pino").Logger<never>;
+export declare function buildLogger(options: LoggerOptions | undefined): import("pino").Logger<never, boolean>;

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

@@ -1,7 +1,24 @@
+/**
+ * The `NavigatorContext` interface represents the context of the browser client.
+ */
 export interface NavigatorContext {
+    /**
+     * The URL of the page that referred the user to the current page.
+     * See [Referer](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer)
+     */
     referrer: string | null;
+    /**
+     * The user agent string of the browser that made the request.
+     * See [User-Agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent)
+     */
     userAgent: string | null;
+    /**
+     * The URL of the current page.
+     */
     location: string | null;
+    /** The unique identifier of the browser client in a Coveo-powered page.
+     * See [clientId](https://docs.coveo.com/en/masb0234).
+     */
     clientId: string;
 }
 export type NavigatorContextProvider = () => NavigatorContext;

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

@@ -2,6 +2,7 @@ import { CoreEngine, CoreEngineNext } from '../../engine.js';
 import { ControllersMap, EngineDefinitionBuildResult } from './common.js';
 export interface FromBuildResultOptions<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> {
     buildResult: EngineDefinitionBuildResult<TEngine, TControllers>;
+    allowedRecommendationKeys?: (keyof TControllers)[];
 }
 export interface FromBuildResult<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap, TOptions, TReturn> {
     (options: FromBuildResultOptions<TEngine, TControllers> & TOptions): Promise<TReturn>;

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

@@ -1,11 +1,11 @@
-import { UniversalControllerDefinitionWithProps } from '../../../../app/commerce-ssr-engine/types/common.js';
+import { NonRecommendationControllerDefinitionWithProps } from '../../../../app/commerce-ssr-engine/types/common.js';
 import { Cart, CartInitialState } from './headless-cart.js';
 export type { CartState, CartItem, CartProps } from './headless-cart.js';
 export type { Cart, CartInitialState };
 export interface CartBuildProps {
     initialState: CartInitialState;
 }
-export interface CartDefinition extends UniversalControllerDefinitionWithProps<Cart, CartBuildProps> {
+export interface CartDefinition extends NonRecommendationControllerDefinitionWithProps<Cart, CartBuildProps> {
 }
 /**
  * Defines a `Cart` controller instance.

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

@@ -1,8 +1,8 @@
-import { UniversalControllerDefinitionWithProps } from '../../../app/commerce-ssr-engine/types/common.js';
+import { NonRecommendationControllerDefinitionWithProps } from '../../../app/commerce-ssr-engine/types/common.js';
 import { Context, ContextOptions, View, UserLocation } from './headless-context.js';
 export type { ContextState, Context, ContextProps } from './headless-context.js';
 export type { View, UserLocation, ContextOptions };
-export interface ContextDefinition extends UniversalControllerDefinitionWithProps<Context, ContextOptions> {
+export interface ContextDefinition extends NonRecommendationControllerDefinitionWithProps<Context, ContextOptions> {
 }
 /**
  * Defines a `Context` controller instance.

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

@@ -1,11 +1,11 @@
-import { UniversalControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
+import { NonRecommendationControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
 import { FieldSuggestionsGenerator } from './headless-field-suggestions-generator.js';
 export type { FieldSuggestions, FieldSuggestionsState, } from '../field-suggestions/headless-field-suggestions.js';
 export type { CategoryFieldSuggestions, CategoryFieldSuggestionsState, } from '../field-suggestions/headless-category-field-suggestions.js';
 export type { FieldSuggestionsFacet } from '../../../features/commerce/facets/field-suggestions-order/field-suggestions-order-state.js';
 export type { GeneratedFieldSuggestionsControllers } from './headless-field-suggestions-generator.js';
 export type { FieldSuggestionsGenerator };
-export interface FieldSuggestionsGeneratorDefinition extends UniversalControllerDefinitionWithoutProps<FieldSuggestionsGenerator> {
+export interface FieldSuggestionsGeneratorDefinition extends NonRecommendationControllerDefinitionWithoutProps<FieldSuggestionsGenerator> {
 }
 /**
  * Defines the `FieldSuggestionsGenerator` controller for the purpose of server-side rendering.

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

@@ -1,8 +1,8 @@
-import { SearchAndListingControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
+import { NonRecommendationControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
 import { InstantProducts, InstantProductsProps } from './headless-instant-products.js';
 export type { InstantProductsOptions, InstantProductsState, } from './headless-instant-products.js';
 export type { InstantProducts, InstantProductsProps };
-export interface InstantProductsDefinition extends SearchAndListingControllerDefinitionWithoutProps<InstantProducts> {
+export interface InstantProductsDefinition extends NonRecommendationControllerDefinitionWithoutProps<InstantProducts> {
 }
 /**
  * Defines the `InstantProducts` controller for the purpose of server-side rendering.
@@ -12,4 +12,4 @@ export interface InstantProductsDefinition extends SearchAndListingControllerDef
  *
  * @internal
  */
-export declare function defineInstantProducts(props: InstantProductsProps): InstantProductsDefinition;
+export declare function defineInstantProducts(props?: InstantProductsProps): InstantProductsDefinition;

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

@@ -1,7 +1,7 @@
-import { UniversalControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
+import { NonRecommendationControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
 import { Controller } from '../../controller/headless-controller.js';
 import { ProductView as BaseProductView } from './headless-product-view.js';
-export interface ProductViewDefinition extends UniversalControllerDefinitionWithoutProps<ProductView> {
+export interface ProductViewDefinition extends NonRecommendationControllerDefinitionWithoutProps<ProductView> {
 }
 /**
  * Defines a `ProductView` controller instance.

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

@@ -1,8 +1,8 @@
-import { SearchAndListingControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
+import { NonRecommendationControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
 import { RecentQueriesList, RecentQueriesListProps } from './headless-recent-queries-list.js';
 export type { RecentQueriesState, RecentQueriesListInitialState, RecentQueriesListOptions, } from './headless-recent-queries-list.js';
 export type { RecentQueriesList, RecentQueriesListProps };
-export interface RecentQueriesListDefinition extends SearchAndListingControllerDefinitionWithoutProps<RecentQueriesList> {
+export interface RecentQueriesListDefinition extends NonRecommendationControllerDefinitionWithoutProps<RecentQueriesList> {
 }
 /**
  * Defines the `RecentQueriesList` controller for the purpose of server-side rendering.

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

@@ -1,8 +1,14 @@
-import { UniversalControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
+import { RecommendationOnlyControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
 import { RecommendationsState } from '../recommendations/headless-recommendations.js';
 import { RecommendationsProps, Recommendations } from './headless-recommendations.js';
 export type { Recommendations, RecommendationsState };
-export interface RecommendationsDefinition extends UniversalControllerDefinitionWithoutProps<Recommendations> {
+/**
+ * @internal
+ * */
+export type RecommendationsDefinitionMeta = {
+    options: {} & RecommendationsProps['options'];
+};
+export interface RecommendationsDefinition extends RecommendationOnlyControllerDefinitionWithoutProps<Recommendations> {
 }
 /**
  * @internal
@@ -12,4 +18,4 @@ export interface RecommendationsDefinition extends UniversalControllerDefinition
  * @param props - The configurable `Recommendations` properties.
  * @returns The `Recommendations` controller definition.
  * */
-export declare function defineRecommendations(props: RecommendationsProps): RecommendationsDefinition;
+export declare function defineRecommendations(props: RecommendationsProps): RecommendationsDefinition & RecommendationsDefinitionMeta;

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

@@ -1,10 +1,10 @@
-import { UniversalControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
+import { NonRecommendationControllerDefinitionWithoutProps } from '../../../app/commerce-ssr-engine/types/common.js';
 import { StandaloneSearchBoxProps } from '../../standalone-search-box/headless-standalone-search-box.js';
 import { StandaloneSearchBox } from './headless-standalone-search-box.js';
 export type { StandaloneSearchBoxOptions } from './headless-standalone-search-box-options.js';
 export type { StandaloneSearchBoxState } from './headless-standalone-search-box.js';
 export type { StandaloneSearchBox, StandaloneSearchBoxProps };
-export interface StandaloneSearchBoxDefinition extends UniversalControllerDefinitionWithoutProps<StandaloneSearchBox> {
+export interface StandaloneSearchBoxDefinition extends NonRecommendationControllerDefinitionWithoutProps<StandaloneSearchBox> {
 }
 /**
  * Defines the `StandaloneSearchBox` controller for the purpose of server-side rendering.