@coveo/headless 3.27.8-pre.5f8a67af1e → 3.27.8-pre.63fc406dfa

package/dist/definitions/ssr-next/commerce/factories/hydrated-state-factory.d.ts

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

package/dist/definitions/ssr-next/commerce/factories/recommendation-hydrated-state-factory.d.ts

@@ -1,3 +0,0 @@
-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>;

package/dist/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts

@@ -1,3 +0,0 @@
-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>;

package/dist/definitions/ssr-next/commerce/factories/static-state-factory.d.ts

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

package/dist/definitions/ssr-next/commerce/types/build.d.ts

@@ -1,10 +0,0 @@
-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 { SolutionType } from './controller-constants.js';
-import type { ControllerDefinitionsMap, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './controller-definitions.js';
-export interface BuildOptions<TEngineOptions> {
-    extend?: OptionsExtender<TEngineOptions>;
-}
-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>>;

package/dist/definitions/ssr-next/commerce/types/controller-constants.d.ts

@@ -1,7 +0,0 @@
-export declare enum SolutionType {
-    search = "search",
-    listing = "listing",
-    standalone = "standalone",
-    recommendation = "recommendation"
-}
-export declare const recommendationInternalOptionKey: unique symbol;

package/dist/definitions/ssr-next/commerce/types/controller-definitions.d.ts

@@ -1,220 +0,0 @@
-import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { InvalidControllerDefinition } from '../../common/errors.js';
-import type { ControllersPropsMap } from '../../common/types/controllers.js';
-import type { EngineDefinitionBuildResult } from '../../common/types/engine.js';
-import type { HydratedState } from '../../common/types/hydrate-static-state.js';
-import type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers } from '../../common/types/inference.js';
-import type { HasKey, HasOptionalKeys, HasRequiredKeys, OptionsTuple } from '../../common/types/utilities.js';
-import type { SSRCommerceEngine } from '../factories/build-factory.js';
-import { type recommendationInternalOptionKey, SolutionType } from './controller-constants.js';
-import type { ListingAndStandaloneController, ListingOnlyController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
-import type { Kind } from './kind.js';
-export type { EngineDefinitionBuildResult, HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
-export type RecommendationControllerSettings = {
-    /**
-     * Toggle to enable or disable the recommendation controller.
-     * When set to `true`, the controller will perform a recommendation request server-side.
-     *
-     * @default false
-     */
-    enabled?: boolean;
-};
-export interface ControllerDefinitionWithoutProps<TController extends Controller> {
-    /**
-     * Creates an instance of the given controller.
-     *
-     * @param engine - The search engine.
-     * @param solutionType - The type of solution for which the controller should be built (e.g. search or listing). This option only applies to sub-controllers.
-     * @returns The created controller instance.
-     */
-    build(engine: SSRCommerceEngine, solutionType?: SolutionType): TController;
-}
-export interface ControllerWithKind extends Controller {
-    _kind: Kind;
-}
-export interface ControllerDefinitionWithProps<TController extends Controller, TProps> {
-    /**
-     * Creates an instance of the given controller.
-     *
-     * @param engine - The search engine.
-     * @param props - The controller properties.
-     * @param solutionType - The type of solution for which the controller should be built (e.g. search or listing). This option only applies to sub-controllers.
-     * @returns The created controller instance.
-     */
-    buildWithProps(engine: SSRCommerceEngine, props?: TProps, solutionType?: SolutionType): TController & ControllerWithKind;
-}
-interface SolutionTypeAvailability {
-    [SolutionType.search]?: boolean;
-    [SolutionType.listing]?: boolean;
-    [SolutionType.standalone]?: boolean;
-    [SolutionType.recommendation]?: boolean;
-}
-export type ControllerDefinition<TController extends Controller> = SolutionTypeAvailability & (ControllerDefinitionWithoutProps<TController> | ControllerDefinitionWithProps<TController, unknown>);
-export interface ControllerDefinitionsMap<TController extends Controller> {
-    [customName: string]: ControllerDefinition<TController>;
-}
-/**
- * This type defines the required and optional controller props for the engine definition.
- */
-export type EngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = OptionalEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType> & RequiredEngineDefinitionControllersPropsOption<TControllers, TControllersPropsMap, TSolutionType>;
-/**
- * Represents an optional engine definition for controller properties.
- *
- * This type is used to define a map of optional controller properties based on the provided
- * controller definitions, controller properties map, and solution type.
- *
- * @template TControllers - A map of controller definitions.
- * @template TControllersPropsMap - A map of controller properties.
- * @template TSolutionType - The type of solution.
- *
- * The type iterates over the controller keys (defined in the engine definition) and includes only those keys where:
- * 1. The controller can be used for a specific solution type (HasKey<TControllers[K], TSolutionType> is not 'never').
- * 2. The controller properties have optional options (HasOptionalKeys<ConditionalControllerProps<...>> is true).
- *
- * @example
- * Given the following controller definitions:
- * ```
- * const {recommendationEngineDefinition} = defineCommerceEngine({
- *  controllers: {
- *    popularViewed: defineRecommendations({
- *      options: {slotId: 'slot-id'}
- *    })
- *  }
- * });
- * ```
- *
- * The following code will not throw an error since the 'popularViewed' controller props are optional
- * ```
- * recommendationEngineDefinition.fetchStaticState({
- *  controllers: {
- *    popularViewed: {enabled: true, productId: 'some-product-id'} // This is optional
- *  }
- * })
- * ```
- *
- * The following code (with no arguments) is also valid because the 'popularViewed' controller props are optional, and there are no other required controller props in the engine definition.
- * ```
- * recommendationEngineDefinition.fetchStaticState()
- * ```
- */
-type OptionalEngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = {
-    [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : HasOptionalKeys<ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>> extends false ? never : 'controllers']?: ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>;
-};
-/**
- * Represents a type that defines the required controller properties for engine definition controllers.
- *
- * @template TControllers - A map of controller definitions.
- * @template TControllersPropsMap - A map of controller properties.
- * @template TSolutionType - The type of solution being used.
- *
- * The type iterates over the controller keys (defined in the engine definition) and includes only those keys where:
- * 1. The controller can be used for a specific solution type (HasKey<TControllers[K], TSolutionType> is not 'never').
- * 2. The controller properties have required options (HasRequiredKeys<ConditionalControllerProps<...>> is true).
- *
- * The resulting type maps the valid keys to their corresponding conditional controller properties.
- *
- * @example
- * Given the following controller definitions:
- * ```
- * const {standaloneEngineDefinition} = defineCommerceEngine({
- *  controllers: {cart: defineCart()},
- * });
- * ```
- *
- * The following code will not throw an error since the 'cart' controller props are required for the standalone engine definition:
- * ```
- * standaloneEngineDefinition.fetchStaticState({
- *   controllers: {
- *     cart: {initialState: {items: []}},
- *   },
- * })
- * ```
- *
- */
-type RequiredEngineDefinitionControllersPropsOption<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType> = {
-    [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : HasRequiredKeys<ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>> extends false ? never : 'controllers']: ConditionalControllerProps<TControllers, TControllersPropsMap, TSolutionType, K>;
-};
-type IsRecommendationController<TController extends ControllerDefinition<Controller>> = HasKey<TController, typeof recommendationInternalOptionKey>;
-/**
- * This type ensures that recommendation controller props are optional, while other controller props remain required.
- *
- * It works by checking if the controller definition includes the `recommendationInternalOptionKey`.
- *
- * - If the key is present, the controller props are made optional.
- * - If the key is absent, the controller props are required.
- *
- * Example:
- *
- * ```typescript
- * type ControllerProps = InferControllerPropsFromDefinition<{
- *   recommendation: defineRecommendation({}),
- *   cart: defineCart(),
- * }>;
- *
- * // In this example:
- * // - The `recommendation` controller props are optional.
- * // - The `cart` controller props are required.
- *
- * const props: ControllerProps = {
- *   cart: {initialState: {items: []}},
- *   // recommendation props can be omitted
- * };
- * ```
- */
-type RecommendationControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, K extends keyof TControllers> = {
-    [I in keyof TControllersPropsMap as I extends K ? IsRecommendationController<TControllers[I]> extends never ? never : I : never]?: TControllersPropsMap[I];
-} & {
-    [I in keyof TControllersPropsMap as I extends K ? IsRecommendationController<TControllers[I]> extends never ? I : never : never]: TControllersPropsMap[I];
-};
-type DefaultControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, K extends keyof TControllers> = {
-    [I in keyof TControllersPropsMap as I extends K ? I : never]: TControllersPropsMap[I];
-};
-type ConditionalControllerProps<TControllers extends ControllerDefinitionsMap<Controller>, TControllersPropsMap extends ControllersPropsMap, TSolutionType extends SolutionType, K extends keyof TControllers> = TSolutionType extends SolutionType.recommendation ? RecommendationControllerProps<TControllers, TControllersPropsMap, K> : DefaultControllerProps<TControllers, TControllersPropsMap, K>;
-export interface ControllerDefinitionOption {
-    /**
-     * Whether the controller will be used in a product listing context.
-     * @defaultValue true
-     */
-    listing?: boolean;
-    /**
-     * Whether the controller will be used in a search page context.
-     * @defaultValue true
-     */
-    search?: boolean;
-}
-export type SearchOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchOnlyController;
-type SearchOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchOnlyController;
-export type ListingAndStandaloneControllerWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingAndStandaloneController;
-type ListingOnlyControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & ListingOnlyController;
-type ListingOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & ListingOnlyController;
-export type RecommendationOnlyControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & RecommendationOnlyController;
-export type NonRecommendationControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & NonRecommendationController;
-export type UniversalControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & UniversalController;
-export type SearchAndListingControllerDefinitionWithoutProps<TController extends Controller> = ControllerDefinitionWithoutProps<TController> & SearchAndListingController;
-type SearchAndListingControllerDefinitionWithProps<TController extends Controller, TProps> = ControllerDefinitionWithProps<TController, TProps> & SearchAndListingController;
-export type SubControllerDefinitionWithoutProps<TController extends Controller, TDefinition extends ControllerDefinitionOption | undefined> = TDefinition extends {
-    listing?: true;
-    search?: true;
-} | undefined ? SearchAndListingControllerDefinitionWithoutProps<TController> : TDefinition extends {
-    listing?: true;
-    search?: false;
-} ? ListingOnlyControllerDefinitionWithoutProps<TController> : TDefinition extends {
-    listing?: false;
-    search?: true;
-} ? SearchOnlyControllerDefinitionWithoutProps<TController> : TDefinition extends {
-    listing: false;
-    search: false;
-} ? InvalidControllerDefinition : never;
-export type SubControllerDefinitionWithProps<TController extends Controller, TDefinition extends ControllerDefinitionOption | undefined, TProps> = TDefinition extends {
-    listing?: true;
-    search?: true;
-} | undefined ? SearchAndListingControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
-    listing?: true;
-    search?: false;
-} ? ListingOnlyControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
-    listing?: false;
-    search?: true;
-} ? SearchOnlyControllerDefinitionWithProps<TController, TProps> : TDefinition extends {
-    listing: false;
-    search: false;
-} ? InvalidControllerDefinition : never;

package/dist/definitions/ssr-next/commerce/types/controller-inference.d.ts

@@ -1,24 +0,0 @@
-import type { Controller } from '../../../controllers/controller/headless-controller.js';
-import type { HasKey, HasKeys } from '../../common/types/utilities.js';
-import type { recommendationInternalOptionKey, SolutionType } from './controller-constants.js';
-import type { ControllerDefinition, ControllerDefinitionsMap, ControllerDefinitionWithoutProps, ControllerDefinitionWithProps, InferControllerStaticStateFromController, RecommendationControllerSettings } from './controller-definitions.js';
-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']>>;
-export type InferControllerPropsFromDefinition<TController extends ControllerDefinition<Controller>> = TController extends ControllerDefinitionWithProps<Controller, infer Props> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? Props : Props & RecommendationControllerSettings : TController extends ControllerDefinitionWithoutProps<Controller> ? HasKey<TController, typeof recommendationInternalOptionKey> extends never ? {} : RecommendationControllerSettings : unknown;
-export type InferControllerPropsMapFromDefinitions<TControllers extends ControllerDefinitionsMap<Controller>> = {
-    [K in keyof TControllers as HasKeys<InferControllerPropsFromDefinition<TControllers[K]>> extends false ? never : K]: InferControllerPropsFromDefinition<TControllers[K]>;
-};
-export type InferControllerFromDefinition<TDefinition extends ControllerDefinition<Controller>> = TDefinition extends ControllerDefinition<infer TController> ? TController : never;
-export type InferControllersMapFromDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
-    [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : K]: InferControllerFromDefinition<TControllers[K]>;
-};
-export type InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
-    [K in keyof TControllers as HasKey<TControllers[K], TSolutionType> extends never ? never : K]: InferControllerStaticStateFromController<InferControllerFromDefinition<TControllers[K]>>;
-};

package/dist/definitions/ssr-next/commerce/types/controller-scopes.d.ts

@@ -1,71 +0,0 @@
-import { SolutionType } from './controller-constants.js';
-export interface NonRecommendationController {
-    /**
-     * @internal
-     */
-    [SolutionType.search]: true;
-    /**
-     * @internal
-     */
-    [SolutionType.listing]: true;
-    /**
-     * @internal
-     */
-    [SolutionType.standalone]: true;
-}
-export interface UniversalController {
-    /**
-     * @internal
-     */
-    [SolutionType.search]: true;
-    /**
-     * @internal
-     */
-    [SolutionType.listing]: true;
-    /**
-     * @internal
-     */
-    [SolutionType.standalone]: true;
-    /**
-     * @internal
-     */
-    [SolutionType.recommendation]: true;
-}
-export interface SearchOnlyController {
-    /**
-     * @internal
-     */
-    [SolutionType.search]: true;
-}
-export interface ListingOnlyController {
-    /**
-     * @internal
-     */
-    [SolutionType.listing]: true;
-}
-export interface RecommendationOnlyController {
-    /**
-     * @internal
-     */
-    [SolutionType.recommendation]: true;
-}
-export interface SearchAndListingController {
-    /**
-     * @internal
-     */
-    [SolutionType.search]: true;
-    /**
-     * @internal
-     */
-    [SolutionType.listing]: true;
-}
-export interface ListingAndStandaloneController {
-    /**
-     * @internal
-     */
-    [SolutionType.listing]: true;
-    /**
-     * @internal
-     */
-    [SolutionType.standalone]: true;
-}

package/dist/definitions/ssr-next/commerce/types/engine.d.ts

@@ -1,75 +0,0 @@
-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/dist/definitions/ssr-next/commerce/types/fetch-static-state.d.ts

@@ -1,17 +0,0 @@
-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/dist/definitions/ssr-next/commerce/types/from-build-result.d.ts

@@ -1,19 +0,0 @@
-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/dist/definitions/ssr-next/commerce/types/hydrate-static-state.d.ts

@@ -1,20 +0,0 @@
-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/dist/definitions/ssr-next/commerce/types/kind.d.ts

@@ -1,9 +0,0 @@
-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/dist/definitions/ssr-next/commerce/utils/recommendation-filter.d.ts

@@ -1,11 +0,0 @@
-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/dist/definitions/ssr-next/common/augment-preprocess-request.d.ts

@@ -1,9 +0,0 @@
-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/dist/definitions/ssr-next/common/controller-utils.d.ts

@@ -1,16 +0,0 @@
-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/dist/definitions/ssr-next/common/errors.d.ts

@@ -1,9 +0,0 @@
-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/dist/definitions/ssr-next/common/types/build.d.ts

@@ -1,9 +0,0 @@
-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/dist/definitions/ssr-next/common/types/controllers.d.ts

@@ -1,37 +0,0 @@
-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;
-}