@coveo/quantic 3.28.1 → 3.28.2-pre.04d5730f85

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

@@ -0,0 +1,75 @@
+import type { UnknownAction } from '@reduxjs/toolkit';
+import type { EngineConfiguration } from '../../../app/engine-configuration.js';
+import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
+import type { Controller } from '../../../controllers/controller/headless-controller.js';
+import type { ControllerStaticStateMap } from '../../common/types/controllers.js';
+import type { FromBuildResultOptions } from '../../common/types/from-build-result.js';
+import type { CommerceEngineDefinition } from '../engine/commerce-engine.ssr.js';
+import type { SSRCommerceEngine } from '../factories/build-factory.js';
+import type { Build, BuildOptions } from './build.js';
+import type { SolutionType } from './controller-constants.js';
+import type { ControllerDefinitionsMap } from './controller-definitions.js';
+import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './controller-inference.js';
+import type { FetchStaticState, FetchStaticStateOptions } from './fetch-static-state.js';
+import type { FromBuildResult } from './from-build-result.js';
+import type { HydrateStaticState, HydrateStaticStateOptions } from './hydrate-static-state.js';
+export type { FromBuildResult, FromBuildResultOptions, HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, FetchStaticStateOptions, Build, BuildOptions, };
+export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
+    searchActions: TSearchAction[];
+    controllers: TControllers;
+}
+export type EngineDefinitionOptions<TOptions extends {
+    configuration: EngineConfiguration;
+}, TControllers extends ControllerDefinitionsMap<Controller>> = TOptions & {
+    /**
+     * The controllers to initialize with the commerce engine.
+     */
+    controllers?: TControllers;
+};
+export interface EngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TEngineOptions, TSolutionType extends SolutionType> {
+    /**
+     * Fetches the static state on the server side using your engine definition.
+     */
+    fetchStaticState: FetchStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
+    /**
+     * Fetches the hydrated state on the client side using your engine definition and the static state.
+     */
+    hydrateStaticState: HydrateStaticState<InferControllersMapFromDefinition<TControllers, TSolutionType>, UnknownAction, InferControllerPropsMapFromDefinitions<TControllers>, TControllers, TSolutionType>;
+    /**
+     * Builds an engine and its controllers from an engine definition.
+     */
+    build: Build<TEngineOptions, InferControllersMapFromDefinition<TControllers, TSolutionType>, InferControllerPropsMapFromDefinitions<TControllers>, 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.
+     *
+     * Note: The implementation specifics of the navigator context provider depend on the Node.js framework being utilized. It is the developer's responsibility to appropriately define and implement the navigator context provider to ensure accurate navigation context is available throughout the application. If the user fails to provide a navigator context provider, a warning will be logged either on the server or the browser console.
+     */
+    setNavigatorContextProvider: (navigatorContextProvider: NavigatorContextProvider) => void;
+    /**
+     * Returns the access token.
+     */
+    getAccessToken: () => string;
+    /**
+     * Updates the access token.
+     * @param accessToken - The access token to update.
+     */
+    setAccessToken: (accessToken: string) => void;
+}
+export type CommerceControllerDefinitionsMap = ControllerDefinitionsMap<Controller>;
+type Definition<TControllerDefinitions extends CommerceControllerDefinitionsMap> = CommerceEngineDefinition<TControllerDefinitions, SolutionType>;
+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'];
+type FetchStaticStateFromBuildResultFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = FetchStaticStateFunction<TControllerDefinitions>['fromBuildResult'];
+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>>;
+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/ssr/commerce/types/fetch-static-state.d.ts

@@ -0,0 +1,17 @@
+import type { UnknownAction } from '@reduxjs/toolkit';
+import type { Controller } from '../../../controllers/controller/headless-controller.js';
+import type { ControllerStaticStateMap, ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
+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';
+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> = {
+    /**
+     * 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<TControllersDefinitionsMap, TControllersProps, TSolutionType>>): Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
+    fromBuildResult: FromBuildResult<TControllers, FetchStaticStateOptions, EngineStaticState<TSearchAction, TControllersStaticState>>;
+};

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

@@ -0,0 +1,19 @@
+import type { ControllersMap } from '../../common/types/controllers.js';
+import type { SSRCommerceEngine } from '../factories/build-factory.js';
+import type { EngineDefinitionBuildResult } from './controller-definitions.js';
+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?: string[];
+}
+export type FromBuildResult<TControllers extends ControllersMap, TOptions, TReturn> = (options: FromBuildResultOptions<TControllers> & TOptions) => Promise<TReturn>;
+export {};

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

@@ -0,0 +1,20 @@
+import type { UnknownAction } from '@reduxjs/toolkit';
+import type { Controller } from '../../../controllers/controller/headless-controller.js';
+import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
+import type { HydratedState } from '../../common/types/hydrate-static-state.js';
+import type { SSRCommerceEngine } from '../factories/build-factory.js';
+import type { SolutionType } from './controller-constants.js';
+import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
+import type { FromBuildResult } from './from-build-result.js';
+export interface HydrateStaticStateOptions<TSearchAction> {
+    searchActions: TSearchAction[];
+}
+export type HydrateStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
+    /**
+     * 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<TControllersDefinitionsMap, TControllersProps, TSolutionType>>): Promise<HydratedState<SSRCommerceEngine, TControllers>>;
+    fromBuildResult: FromBuildResult<TControllers, HydrateStaticStateOptions<TSearchAction>, HydratedState<SSRCommerceEngine, TControllers>>;
+};

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

@@ -0,0 +1,9 @@
+export declare enum Kind {
+    Cart = "CART",
+    Context = "CONTEXT",
+    ParameterManager = "PARAMETER_MANAGER",
+    Recommendations = "RECOMMENDATIONS"
+}
+export declare function createControllerWithKind<TController, TKind extends Kind>(controller: TController, kind: TKind): TController & {
+    _kind: TKind;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/utils/recommendation-filter.d.ts

@@ -0,0 +1,11 @@
+import type { Controller } from '../../../controllers/controller/headless-controller.js';
+import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
+export declare function filterRecommendationControllers<TControllerDefinitions extends ControllerDefinitionsMap<Controller>>(controllers: Record<string, Controller>, controllerDefinitions: TControllerDefinitions): {
+    /**
+     * Go through all the controllers passed in argument and only refresh recommendation controllers.
+     *
+     * @param controllers - A record of all controllers where the key is the controller name and the value is the controller instance.
+     * @param controllerNames - A list of all recommendation controllers to refresh
+     */
+    refresh(whitelist?: string[]): void;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/augment-preprocess-request.d.ts

@@ -0,0 +1,9 @@
+import type { PlatformClientOrigin, PlatformRequestOptions, PreprocessRequest, RequestMetadata } from '../../api/preprocess-request.js';
+import { type LoggerOptions } from '../../app/logger.js';
+import type { NavigatorContextProvider } from '../../app/navigator-context-provider.js';
+export interface AugmentPreprocessRequestOptions {
+    preprocessRequest?: PreprocessRequest;
+    navigatorContextProvider?: NavigatorContextProvider;
+    loggerOptions?: LoggerOptions;
+}
+export declare function augmentPreprocessRequestWithForwardedFor(options: AugmentPreprocessRequestOptions): (request: PlatformRequestOptions, clientOrigin: PlatformClientOrigin, metadata?: RequestMetadata) => Promise<PlatformRequestOptions>;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/controller-utils.d.ts

@@ -0,0 +1,16 @@
+import type { UnknownAction } from '@reduxjs/toolkit';
+import type { CoreEngine, CoreEngineNext } from '../../app/engine.js';
+import type { Controller } from '../../controllers/controller/headless-controller.js';
+import type { ControllerDefinitionsMap, ControllersMap } from './types/controllers.js';
+import type { EngineStaticState } from './types/engine.js';
+import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromControllers, InferControllersMapFromDefinition } from './types/inference.js';
+export declare function buildControllerDefinitions<TControllerDefinitionsMap extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>, TEngine extends CoreEngine | CoreEngineNext>({ definitionsMap, engine, propsMap, }: {
+    definitionsMap: TControllerDefinitionsMap;
+    engine: TEngine;
+    propsMap: InferControllerPropsMapFromDefinitions<TControllerDefinitionsMap>;
+}): InferControllersMapFromDefinition<TControllerDefinitionsMap>;
+export declare function createStaticState<TSearchAction extends UnknownAction>({ searchAction, controllers, }: {
+    searchAction: TSearchAction;
+    controllers: ControllersMap;
+}): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromControllers<ControllersMap>>;
+export declare function composeFunction<TParameters extends Array<unknown>, TReturn, TChildren extends {}>(parentFunction: (...params: TParameters) => TReturn, children: TChildren): TChildren & ((...params: TParameters) => TReturn);

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

@@ -0,0 +1,9 @@
+export declare class InvalidControllerDefinition extends Error {
+    constructor();
+}
+export declare class MissingControllerProps extends Error {
+    constructor(controller: string);
+}
+export declare class MultipleRecommendationError extends Error {
+    constructor(slotId: string);
+}

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

@@ -0,0 +1,9 @@
+import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { ControllersMap, ControllersPropsMap } from './controllers.js';
+import type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './engine.js';
+import type { OptionsExtender, OptionsTuple } from './utilities.js';
+interface BuildOptions<TEngineOptions> {
+    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>>;
+export {};

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

@@ -0,0 +1,37 @@
+import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { Controller } from '../../../controllers/controller/headless-controller.js';
+export interface ControllersMap {
+    [customName: string]: Controller;
+}
+export interface ControllerStaticState<TState> {
+    state: TState;
+}
+export interface ControllerStaticStateMap {
+    [customName: string]: ControllerStaticState<unknown>;
+}
+export interface ControllerDefinitionWithoutProps<TEngine extends CoreEngine | CoreEngineNext, TController extends Controller> {
+    /**
+     * Creates an instance of the given controller.
+     *
+     * @param engine - The search engine.
+     * @returns The controller.
+     */
+    build(engine: TEngine): TController;
+}
+export interface ControllerDefinitionWithProps<TEngine extends CoreEngine | CoreEngineNext, TController extends Controller, TProps> {
+    /**
+     * Creates an instance of the given controller.
+     *
+     * @param engine - The search engine.
+     * @param props - The controller properties.
+     * @returns The controller.
+     */
+    buildWithProps(engine: TEngine, props?: TProps): TController;
+}
+export type ControllerDefinition<TEngine extends CoreEngine | CoreEngineNext, TController extends Controller> = ControllerDefinitionWithoutProps<TEngine, TController> | ControllerDefinitionWithProps<TEngine, TController, unknown>;
+export interface ControllerDefinitionsMap<TEngine extends CoreEngine | CoreEngineNext, TController extends Controller> {
+    [customName: string]: ControllerDefinition<TEngine, TController>;
+}
+export interface ControllersPropsMap {
+    [customName: string]: unknown;
+}

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

@@ -0,0 +1,60 @@
+import type { AnyAction, UnknownAction } from '@reduxjs/toolkit';
+import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { EngineConfiguration } from '../../../app/engine-configuration.js';
+import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
+import type { Controller } from '../../../controllers/controller/headless-controller.js';
+import type { Build } from './build.js';
+import type { ControllerDefinitionsMap, ControllerStaticStateMap, ControllersMap, ControllersPropsMap } from './controllers.js';
+import type { FetchStaticState } from './fetch-static-state.js';
+import type { HydrateStaticState } from './hydrate-static-state.js';
+import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitions, InferControllersMapFromDefinition } from './inference.js';
+import type { HasKeys } from './utilities.js';
+export type EngineDefinitionOptions<TOptions extends {
+    configuration: EngineConfiguration;
+}, TControllers extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>> = TOptions & {
+    /**
+     * The controllers to initialize with the search engine.
+     */
+    controllers?: TControllers;
+};
+export interface EngineDefinition<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllerDefinitionsMap<TEngine, Controller>, TEngineOptions> {
+    /**
+     * Fetches the static state on the server side using your engine definition.
+     */
+    fetchStaticState: FetchStaticState<TEngine, InferControllersMapFromDefinition<TControllers>, AnyAction, InferControllerStaticStateMapFromDefinitions<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>;
+    /**
+     * Fetches the hydrated state on the client side using your engine definition and the static state.
+     */
+    hydrateStaticState: HydrateStaticState<TEngine, InferControllersMapFromDefinition<TControllers>, AnyAction, InferControllerPropsMapFromDefinitions<TControllers>>;
+    /**
+     * 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.
+     *
+     * Note: The implementation specifics of the navigator context provider depend on the Node.js framework being utilized. It is the developer's responsibility to appropriately define and implement the navigator context provider to ensure accurate navigation context is available throughout the application. If the user fails to provide a navigator context provider, a warning will be logged either on the server or the browser console.
+     */
+    setNavigatorContextProvider: (navigatorContextProvider: NavigatorContextProvider) => void;
+    /**
+     * Builds an engine and its controllers from an engine definition.
+     */
+    build: Build<TEngine, TEngineOptions, InferControllersMapFromDefinition<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>;
+}
+export interface EngineDefinitionBuildResult<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> {
+    engine: TEngine;
+    controllers: TControllers;
+}
+export type EngineDefinitionControllersPropsOption<TControllersPropsMap extends ControllersPropsMap> = HasKeys<TControllersPropsMap> extends false ? {} : {
+    controllers: TControllersPropsMap;
+};
+export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
+    searchAction: TSearchAction;
+    controllers: TControllers;
+}
+export type InferStaticState<T extends {
+    fetchStaticState(...args: unknown[]): Promise<unknown>;
+}> = Awaited<ReturnType<T['fetchStaticState']>>;
+export type InferHydratedState<T extends {
+    hydrateStaticState(...args: unknown[]): Promise<unknown>;
+}> = Awaited<ReturnType<T['hydrateStaticState']>>;
+export type InferBuildResult<T extends {
+    build(...args: unknown[]): Promise<unknown>;
+}> = Awaited<ReturnType<T['build']>>;

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

@@ -0,0 +1,17 @@
+import type { UnknownAction } from '@reduxjs/toolkit';
+import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { ControllerStaticStateMap, ControllersMap, ControllersPropsMap } from './controllers.js';
+import type { EngineDefinitionControllersPropsOption, EngineStaticState } from './engine.js';
+import type { FromBuildResult } from './from-build-result.js';
+import type { OptionsTuple } from './utilities.js';
+type FetchStaticStateOptions = {};
+export type FetchStaticState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap> = {
+    /**
+     * 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<TEngine, TControllers, FetchStaticStateOptions, EngineStaticState<TSearchAction, TControllersStaticState>>;
+};
+export {};

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

@@ -0,0 +1,8 @@
+import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { ControllersMap } from './controllers.js';
+import type { EngineDefinitionBuildResult } from './engine.js';
+export interface FromBuildResultOptions<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> {
+    buildResult: EngineDefinitionBuildResult<TEngine, TControllers>;
+    allowedRecommendationKeys?: (keyof TControllers)[];
+}
+export type 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/ssr/common/types/hydrate-static-state.d.ts

@@ -0,0 +1,21 @@
+import type { UnknownAction } from '@reduxjs/toolkit';
+import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { ControllersMap, ControllersPropsMap } from './controllers.js';
+import type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './engine.js';
+import type { FromBuildResult } from './from-build-result.js';
+import type { OptionsTuple } from './utilities.js';
+interface HydrateStaticStateOptions<TSearchAction> {
+    searchAction: TSearchAction;
+}
+export interface HydratedState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> extends EngineDefinitionBuildResult<TEngine, TControllers> {
+}
+export type HydrateStaticState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap> = {
+    /**
+     * 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<TEngine, TControllers>>;
+    fromBuildResult: FromBuildResult<TEngine, TControllers, HydrateStaticStateOptions<TSearchAction>, HydratedState<TEngine, TControllers>>;
+};
+export {};

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

@@ -0,0 +1,19 @@
+import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { Controller } from '../../../controllers/controller/headless-controller.js';
+import type { ControllerDefinition, ControllerDefinitionsMap, ControllerDefinitionWithoutProps, ControllerDefinitionWithProps, ControllerStaticState, ControllersMap } from './controllers.js';
+import type { HasKeys } from './utilities.js';
+export type InferControllerPropsFromDefinition<TController extends ControllerDefinition<CoreEngine | CoreEngineNext, Controller>> = TController extends ControllerDefinitionWithProps<CoreEngine | CoreEngineNext, Controller, infer Props> ? Props : TController extends ControllerDefinitionWithoutProps<CoreEngine | CoreEngineNext, Controller> ? {} : unknown;
+export type InferControllerPropsMapFromDefinitions<TControllers extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>> = {
+    [K in keyof TControllers as HasKeys<InferControllerPropsFromDefinition<TControllers[K]>> extends false ? never : K]: InferControllerPropsFromDefinition<TControllers[K]>;
+};
+export type InferControllerFromDefinition<TDefinition extends ControllerDefinition<CoreEngine | CoreEngineNext, Controller>> = TDefinition extends ControllerDefinition<infer _, infer TController> ? TController : never;
+export type InferControllersMapFromDefinition<TControllers extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>> = {
+    [K in keyof TControllers]: InferControllerFromDefinition<TControllers[K]>;
+};
+export type InferControllerStaticStateFromController<TController extends Controller> = ControllerStaticState<TController['state']>;
+export type InferControllerStaticStateMapFromDefinitions<TControllers extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>> = {
+    [K in keyof TControllers]: InferControllerStaticStateFromController<InferControllerFromDefinition<TControllers[K]>>;
+};
+export type InferControllerStaticStateMapFromControllers<TControllers extends ControllersMap> = {
+    [K in keyof TControllers]: InferControllerStaticStateFromController<TControllers[K]>;
+};

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

@@ -0,0 +1,14 @@
+export type HasKey<T, K extends PropertyKey> = T extends unknown ? K extends keyof T ? T[K] extends never ? never : true : never : never;
+export type HasKeys<TObject> = TObject extends {} ? keyof TObject extends never ? false : true : boolean;
+export type HasRequiredKeys<TObject> = TObject extends {} ? {
+    [K in keyof TObject]-?: {} extends Pick<TObject, K> ? never : K;
+}[keyof TObject] extends never ? false : true : boolean;
+export type HasOptionalKeys<TObject> = TObject extends {} ? {
+    [K in keyof TObject]-?: {} extends Pick<TObject, K> ? K : never;
+}[keyof TObject] extends never ? false : true : boolean;
+type ExtractRequiredOptions<TOptions> = {
+    [TKey in keyof TOptions as Pick<TOptions, TKey> extends Required<Pick<TOptions, TKey>> ? TKey : never]: TOptions[TKey];
+};
+export type OptionsTuple<TOptions> = HasKeys<TOptions> extends false ? [] : HasKeys<ExtractRequiredOptions<TOptions>> extends false ? [options?: TOptions] : [options: TOptions];
+export type OptionsExtender<TOptions> = (options: TOptions) => TOptions | Promise<TOptions>;
+export {};

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

@@ -0,0 +1,13 @@
+import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
+import { type BreadcrumbManager } from '../../../../controllers/breadcrumb-manager/headless-breadcrumb-manager.js';
+import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
+export * from '../../../../controllers/breadcrumb-manager/headless-breadcrumb-manager.js';
+export interface BreadcrumbManagerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, BreadcrumbManager> {
+}
+/**
+ * Defines a `BreadcrumbManager` controller instance.
+ * @group Definers
+ *
+ * @returns The `BreadcrumbManager` controller definition.
+ * */
+export declare function defineBreadcrumbManager(): BreadcrumbManagerDefinition;

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

@@ -0,0 +1,14 @@
+import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
+import { type Context } from '../../../../controllers/context/headless-context.js';
+import type { ContextProps } from '../../../../controllers/core/context/headless-core-context.js';
+import type { ControllerDefinitionWithProps } from '../../../common/types/controllers.js';
+export * from '../../../../controllers/context/headless-context.js';
+export interface ContextDefinition extends ControllerDefinitionWithProps<SearchEngine, Context, ContextProps> {
+}
+/**
+ * Defines a `Context` controller instance.
+ * @group Definers
+ *
+ * @returns The `Context` controller definition.
+ * */
+export declare function defineContext(): ContextDefinition;

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

@@ -0,0 +1,13 @@
+import type { CoreEngine } from '../../../../app/engine.js';
+import { type DictionaryFieldContext } from '../../../../controllers/dictionary-field-context/headless-dictionary-field-context.js';
+import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
+export * from '../../../../controllers/dictionary-field-context/headless-dictionary-field-context.js';
+export interface DictionaryFieldContextDefinition extends ControllerDefinitionWithoutProps<CoreEngine, DictionaryFieldContext> {
+}
+/**
+ * Defines a `DictionaryFieldContext` controller instance.
+ * @group Definers
+ *
+ * @returns The `DictionaryFieldContext` controller definition.
+ * */
+export declare function defineDictionaryFieldContext(): DictionaryFieldContextDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/did-you-mean/headless-did-you-mean.ssr.d.ts

@@ -0,0 +1,13 @@
+import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
+import { type DidYouMean } from '../../../../controllers/did-you-mean/headless-did-you-mean.js';
+import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
+export * from '../../../../controllers/did-you-mean/headless-did-you-mean.js';
+export interface DidYouMeanDefinition extends ControllerDefinitionWithoutProps<SearchEngine, DidYouMean> {
+}
+/**
+ * Defines a `DidYouMean` controller instance.
+ * @group Definers
+ *
+ * @returns The `DidYouMean` controller definition.
+ * */
+export declare function defineDidYouMean(): DidYouMeanDefinition;

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

@@ -0,0 +1,13 @@
+import type { SearchEngine } from '../../../../app/search-engine/search-engine.js';
+import { type FacetManager } from '../../../../controllers/facet-manager/headless-facet-manager.js';
+import type { ControllerDefinitionWithoutProps } from '../../../common/types/controllers.js';
+export * from '../../../../controllers/facet-manager/headless-facet-manager.js';
+export interface FacetManagerDefinition extends ControllerDefinitionWithoutProps<SearchEngine, FacetManager> {
+}
+/**
+ * Defines a `FacetManager` controller instance.
+ * @group Definers
+ *
+ * @returns The `FacetManager` controller definition.
+ * */
+export declare function defineFacetManager(): FacetManagerDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.ssr.d.ts

@@ -0,0 +1,14 @@
+import type { SearchEngine } from '../../../../../app/search-engine/search-engine.js';
+import { type AutomaticFacetGenerator, type AutomaticFacetGeneratorProps } from '../../../../../controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.js';
+import type { ControllerDefinitionWithoutProps } from '../../../../common/types/controllers.js';
+export * from '../../../../../controllers/facets/automatic-facet-generator/headless-automatic-facet-generator.js';
+export interface AutomaticFacetGeneratorDefinition extends ControllerDefinitionWithoutProps<SearchEngine, AutomaticFacetGenerator> {
+}
+/**
+ * Defines an `AutomaticFacetGenerator` controller instance.
+ * @group Definers
+ *
+ * @param props - The configurable `AutomaticFacetGenerator` properties.
+ * @returns The `AutomaticFacetGenerator` controller definition.
+ * */
+export declare function defineAutomaticFacetGenerator(props: AutomaticFacetGeneratorProps): AutomaticFacetGeneratorDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/facets/category-facet/headless-category-facet.ssr.d.ts

@@ -0,0 +1,14 @@
+import type { SearchEngine } from '../../../../../app/search-engine/search-engine.js';
+import { type CategoryFacet, type CategoryFacetProps } from '../../../../../controllers/facets/category-facet/headless-category-facet.js';
+import type { ControllerDefinitionWithoutProps } from '../../../../common/types/controllers.js';
+export * from '../../../../../controllers/facets/category-facet/headless-category-facet.js';
+export interface CategoryFacetDefinition extends ControllerDefinitionWithoutProps<SearchEngine, CategoryFacet> {
+}
+/**
+ * Defines a `CategoryFacet` controller instance.
+ * @group Definers
+ *
+ * @param props - The configurable `CategoryFacet` properties.
+ * @returns The `CategoryFacet` controller definition.
+ * */
+export declare function defineCategoryFacet(props: CategoryFacetProps): CategoryFacetDefinition;

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

@@ -0,0 +1,14 @@
+import type { SearchEngine } from '../../../../../app/search-engine/search-engine.js';
+import { type Facet, type FacetProps } from '../../../../../controllers/facets/facet/headless-facet.js';
+import type { ControllerDefinitionWithoutProps } from '../../../../common/types/controllers.js';
+export * from '../../../../../controllers/facets/facet/headless-facet.js';
+export interface FacetDefinition extends ControllerDefinitionWithoutProps<SearchEngine, Facet> {
+}
+/**
+ * Defines a `Facet` controller instance.
+ * @group Definers
+ *
+ * @param props - The configurable `Facet` properties.
+ * @returns The `Facet` controller definition.
+ * */
+export declare function defineFacet(props: FacetProps): FacetDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/facets/range-facet/date-facet/headless-date-facet.ssr.d.ts

@@ -0,0 +1,15 @@
+import type { SearchEngine } from '../../../../../../app/search-engine/search-engine.js';
+import { type DateFacet, type DateFacetProps } from '../../../../../../controllers/facets/range-facet/date-facet/headless-date-facet.js';
+import type { ControllerDefinitionWithoutProps } from '../../../../../common/types/controllers.js';
+export * from '../../../../../../controllers/facets/range-facet/date-facet/headless-date-facet.js';
+export { buildDateRange } from '../../../../../../controllers/facets/range-facet/date-facet/headless-date-facet.js';
+export interface DateFacetDefinition extends ControllerDefinitionWithoutProps<SearchEngine, DateFacet> {
+}
+/**
+ * Defines a `DateFacet` controller instance.
+ * @group Definers
+ *
+ * @param props - The configurable `DateFacet` properties.
+ * @returns The `DateFacet` controller definition.
+ * */
+export declare function defineDateFacet(props: DateFacetProps): DateFacetDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/facets/range-facet/date-facet/headless-date-filter.ssr.d.ts

@@ -0,0 +1,14 @@
+import type { SearchEngine } from '../../../../../../app/search-engine/search-engine.js';
+import { type DateFilter, type DateFilterProps } from '../../../../../../controllers/facets/range-facet/date-facet/headless-date-filter.js';
+import type { ControllerDefinitionWithoutProps } from '../../../../../common/types/controllers.js';
+export * from '../../../../../../controllers/facets/range-facet/date-facet/headless-date-filter.js';
+export interface DateFilterDefinition extends ControllerDefinitionWithoutProps<SearchEngine, DateFilter> {
+}
+/**
+ * Defines a `DateFilter` controller instance.
+ * @group Definers
+ *
+ * @param props - The configurable `DateFilter` properties.
+ * @returns The `DateFilter` controller definition.
+ * */
+export declare function defineDateFilter(props: DateFilterProps): DateFilterDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/facets/range-facet/numeric-facet/headless-numeric-facet.ssr.d.ts

@@ -0,0 +1,15 @@
+import type { SearchEngine } from '../../../../../../app/search-engine/search-engine.js';
+import { type NumericFacet, type NumericFacetProps } from '../../../../../../controllers/facets/range-facet/numeric-facet/headless-numeric-facet.js';
+import type { ControllerDefinitionWithoutProps } from '../../../../../common/types/controllers.js';
+export * from '../../../../../../controllers/facets/range-facet/numeric-facet/headless-numeric-facet.js';
+export { buildNumericRange } from '../../../../../../controllers/facets/range-facet/numeric-facet/headless-numeric-facet.js';
+export interface NumericFacetDefinition extends ControllerDefinitionWithoutProps<SearchEngine, NumericFacet> {
+}
+/**
+ * Defines a `NumericFacet` controller instance.
+ * @group Definers
+ *
+ * @param props - The configurable `NumericFacet` properties.
+ * @returns The `NumericFacet` controller definition.
+ * */
+export declare function defineNumericFacet(props: NumericFacetProps): NumericFacetDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/facets/range-facet/numeric-facet/headless-numeric-filter.ssr.d.ts

@@ -0,0 +1,14 @@
+import type { SearchEngine } from '../../../../../../app/search-engine/search-engine.js';
+import { type NumericFilter, type NumericFilterProps } from '../../../../../../controllers/facets/range-facet/numeric-facet/headless-numeric-filter.js';
+import type { ControllerDefinitionWithoutProps } from '../../../../../common/types/controllers.js';
+export * from '../../../../../../controllers/facets/range-facet/numeric-facet/headless-numeric-filter.js';
+export interface NumericFilterDefinition extends ControllerDefinitionWithoutProps<SearchEngine, NumericFilter> {
+}
+/**
+ * Defines a `NumericFilter` controller instance.
+ * @group Definers
+ *
+ * @param props - The configurable `NumericFilter` properties.
+ * @returns The `NumericFilter` controller definition.
+ * */
+export declare function defineNumericFilter(props: NumericFilterProps): NumericFilterDefinition;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/search/controllers/field-suggestions/category-facet/headless-category-field-suggestions.ssr.d.ts

@@ -0,0 +1,14 @@
+import type { SearchEngine } from '../../../../../app/search-engine/search-engine.js';
+import { type CategoryFieldSuggestions, type CategoryFieldSuggestionsProps } from '../../../../../controllers/field-suggestions/category-facet/headless-category-field-suggestions.js';
+import type { ControllerDefinitionWithoutProps } from '../../../../common/types/controllers.js';
+export * from '../../../../../controllers/field-suggestions/category-facet/headless-category-field-suggestions.js';
+export interface CategoryFieldSuggestionsDefinition extends ControllerDefinitionWithoutProps<SearchEngine, CategoryFieldSuggestions> {
+}
+/**
+ * Defines a `CategoryFieldSuggestions` controller instance.
+ * @group Definers
+ *
+ * @param props - The configurable `CategoryFieldSuggestions` properties.
+ * @returns The `CategoryFieldSuggestions` controller definition.
+ * */
+export declare function defineCategoryFieldSuggestions(props: CategoryFieldSuggestionsProps): CategoryFieldSuggestionsDefinition;