@coveo/quantic 3.30.3-pre.b400a05b95 → 3.30.3-pre.b407bdfc38

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

@@ -44,6 +44,11 @@
  *   standaloneEngineDefinition,
  * } = engineDefinition;
  *
+ * await listingEngineDefinition.fetchStaticState({
+ *   navigatorContextProvider: () => {/*...* /},
+ *   context: {/*...* /},
+ * });
+ *
  * export type ListingStaticState = InferStaticState<
  *   typeof listingEngineDefinition
  * >;
@@ -118,9 +123,9 @@ export type { RedirectionTrigger, RedirectionTriggerDefinition, RedirectionTrigg
 export { defineRedirectionTrigger } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
 export { defineCommerceEngine } from './ssr-next/commerce/engine/commerce-engine.ssr.js';
 export type { SSRCommerceEngine as CommerceEngine } from './ssr-next/commerce/factories/build-factory.js';
-export type { BuildConfig, SSRCommerceEngineOptions as CommerceEngineOptions, } from './ssr-next/commerce/types/build.js';
+export type { BuildConfig, SSRCommerceEngineOptions, } from './ssr-next/commerce/types/build.js';
 export { SolutionType } from './ssr-next/commerce/types/controller-constants.js';
-export type { AugmentedControllerDefinition, CommerceEngineDefinitionControllersPropsOption as EngineDefinitionControllersPropsOption, ControllerDefinition, ControllerDefinitionsMap, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
+export type { CommerceEngineDefinitionControllersPropsOption as EngineDefinitionControllersPropsOption, ControllerDefinition, ControllerDefinitionsMap, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
 export type { InferControllerFromDefinition, InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition, InferHydratedState, InferStaticState, } from './ssr-next/commerce/types/controller-inference.js';
 export type { CommerceEngineDefinition, CommerceEngineDefinitionBuildResult, CommerceEngineDefinitionOptions, EngineStaticState, FetchStaticState, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
 export type { CommerceAppState, CommerceProductListingParametersState, CommerceSearchParametersState, } from './state/commerce-app-state.js';

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

@@ -17,9 +17,15 @@ import type { CommerceEngineDefinition, CommerceEngineDefinitionOptions } from '
  *
  * @example
  * ```ts
- * const engineDefinition = defineCommerceEngine(engineConfig);
- * type SearchStaticState = InferStaticState<typeof engineDefinition>;
- * type SearchHydratedState = InferHydratedState<typeof engineDefinition>;
+ * const { listingEngineDefinition } = defineCommerceEngine(engineConfig);
+ *
+ * const staticState = await listingEngineDefinition.fetchStaticState({
+ *   navigatorContextProvider: () => {/*...* /},
+ *   context: {/*...* /},
+ * });
+ *
+ * type SearchStaticState = InferStaticState<typeof listingEngineDefinition>;
+ * type SearchHydratedState = InferHydratedState<typeof listingEngineDefinition>;
  * ```
  *
  * @group Engine

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

@@ -1,7 +1,7 @@
 import type { Action } from '@reduxjs/toolkit';
 import { type CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
 import { SolutionType } from '../types/controller-constants.js';
-import type { AugmentedControllerDefinition, BakedInControllers } from '../types/controller-definitions.js';
+import type { BakedInControllers } from '../types/controller-definitions.js';
 import type { InferControllersMapFromDefinition } from '../types/controller-inference.js';
 import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions, FetchStaticStateParameters, HydrateStaticStateParameters } from '../types/engine.js';
 /**
@@ -15,7 +15,7 @@ export interface SSRCommerceEngine extends CommerceEngine {
      */
     waitForRequestCompletedAction(): Promise<Action>[];
 }
-export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (...[buildOptions]: FetchStaticStateParameters<TControllerDefinitions, TSolutionType> | HydrateStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<{
+export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <TSolutionType extends SolutionType>(solutionType: TSolutionType) => (...[buildOptions]: FetchStaticStateParameters<TControllerDefinitions, TSolutionType> | HydrateStaticStateParameters<TControllerDefinitions, TSolutionType>) => Promise<{
     engine: SSRCommerceEngine;
     controllers: InferControllersMapFromDefinition<TControllerDefinitions, TSolutionType> & BakedInControllers;
 }>;

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

@@ -5,6 +5,7 @@ import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions,
 export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (...params: FetchStaticStateParameters<TControllerDefinitions, SolutionType.recommendation>) => Promise<{
     controllers: import("../types/controller-inference.js").InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllerDefinitions, SolutionType.recommendation> & import("../types/controller-definitions.js").FilteredBakedInControllers<SolutionType.recommendation>;
     searchActions: UnknownAction[];
+    navigatorContextProvider: import("../../../ssr.index.js").NavigatorContextProvider;
     context: import("../../../commerce.index.js").ContextOptions;
     searchParams?: import("../../../commerce.index.js").ParameterManagerState<import("../../../commerce.index.js").Parameters>["parameters"];
     cart?: import("../../../commerce.index.js").CartInitialState;

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

@@ -1,4 +1,5 @@
 import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
+import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { HasKey } from '../../common/types/utilities.js';
 import type { CartInitialState } from '../controllers/cart/headless-cart.ssr.js';
@@ -15,11 +16,6 @@ export interface ListingBuildConfig extends CommonBuildConfig {
 }
 export interface StandaloneBuildConfig extends CommonBuildConfig {
 }
-export interface CommonBuildConfig {
-    context: ContextOptions;
-    searchParams?: ParameterManagerState<Parameters>['parameters'];
-    cart?: CartInitialState;
-}
 /**
  * Commerce engine options for SSR scenarios where context is defined when fetching static state.
  */
@@ -76,6 +72,7 @@ export interface ListingBuildConfig extends CommonBuildConfig {
 export interface StandaloneBuildConfig extends CommonBuildConfig {
 }
 export interface CommonBuildConfig {
+    navigatorContextProvider: NavigatorContextProvider;
     context: ContextOptions;
     searchParams?: ParameterManagerState<Parameters>['parameters'];
     cart?: CartInitialState;

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

@@ -1,5 +1,4 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
-import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { ControllersMap } from '../../common/types/controllers.js';
 import type { EngineStaticState } from '../../common/types/engine.js';
@@ -35,13 +34,6 @@ export interface CommerceEngineDefinition<TControllers extends ControllerDefinit
      * 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>;
-    /**
-     * 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.
      */

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

@@ -1,4 +1,4 @@
-import type { CommerceEngineConfiguration } from '../../../app/commerce-engine/commerce-engine.js';
+import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
 import type { CommonBuildConfig } from '../types/build.js';
 import type { CommerceControllerDefinitionsMap, CommerceEngineDefinitionOptions } from '../types/engine.js';
-export declare function extendEngineConfiguration<TControllerDefinitions extends CommerceControllerDefinitionsMap>(configuration: CommerceEngineDefinitionOptions<TControllerDefinitions>['configuration'], commonBuildOptions: CommonBuildConfig): CommerceEngineConfiguration;
+export declare function augmentCommerceEngineOptions<TControllerDefinitions extends CommerceControllerDefinitionsMap>(engineOptions: CommerceEngineDefinitionOptions<TControllerDefinitions>, buildConfig: CommonBuildConfig): CommerceEngineOptions;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/search/engine/search-engine.ssr.d.ts

@@ -1,4 +1,3 @@
-import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import { type SearchEngine } from '../../../app/search-engine/search-engine.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { LegacySearchAction } from '../../../features/analytics/analytics-utils.js';
@@ -21,13 +20,20 @@ export type SearchCompletedAction = ReturnType<LegacySearchAction['fulfilled' |
  * Initializes a Search engine definition in SSR with given controllers definitions and search engine config.
  *
  * @param options - The search engine definition
- * @returns Three utility functions to fetch the initial state of the engine in SSR, hydrate the state in CSR,
- *  and a build function that can be used for edge cases requiring more control.
+ * @returns Two utility functions to fetch the initial state of the engine in SSR and hydrate the state in CSR.
+ *
+ * @example
+ * ```ts
+ * const searchEngine = defineSearchEngine(config);
+ *
+ * const staticState = await searchEngine.fetchStaticState({
+ *   navigatorContextProvider: () => {/*...* /},
+ * });
+ * ```
  *
  * @group Engine
  */
 export declare function defineSearchEngine<TControllerDefinitions extends ControllerDefinitionsMap<SearchEngine, Controller>>(options: SearchEngineDefinitionOptions<TControllerDefinitions>): {
     fetchStaticState: import("../types/fetch-static-state.js").FetchStaticState<import("redux").AnyAction, InferControllerStaticStateMapFromDefinitions<TControllerDefinitions>, InferControllerPropsMapFromDefinitions<TControllerDefinitions>>;
     hydrateStaticState: import("../types/hydrate-static-state.js").HydrateStaticState<SSRSearchEngine, import("../types/controller-inference.js").InferControllersMapFromDefinition<TControllerDefinitions>, import("redux").AnyAction, InferControllerPropsMapFromDefinitions<TControllerDefinitions>>;
-    setNavigatorContextProvider: (navigatorContextProvider: NavigatorContextProvider) => void;
 };

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

@@ -1,7 +1,11 @@
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
 import type { OptionsTuple } from '../../common/types/utilities.js';
 import type { SearchEngineDefinitionBuildResult, SearchEngineDefinitionControllersPropsOption } from './engine.js';
+export type BuildConfig = {
+    navigatorContextProvider: NavigatorContextProvider;
+};
 /**
  * @internal
  */

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

@@ -1,6 +1,5 @@
 import type { AnyAction } from '@reduxjs/toolkit';
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
-import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
 import type { SearchEngineOptions } from '../../../app/search-engine/search-engine.js';
 import type { Controller } from '../../../controllers/controller/headless-controller.js';
 import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
@@ -32,13 +31,6 @@ export interface SearchEngineDefinition<TEngine extends CoreEngine | CoreEngineN
      * 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;
 }
 /**
  * This type defines the required and optional controller props for the search engine definition.

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

@@ -2,10 +2,11 @@ import type { UnknownAction } from '@reduxjs/toolkit';
 import type { ControllerStaticStateMap, ControllersPropsMap } from '../../common/types/controllers.js';
 import type { EngineStaticState } from '../../common/types/engine.js';
 import type { OptionsTuple } from '../../common/types/utilities.js';
+import type { BuildConfig } from './build.js';
 import type { SearchEngineDefinitionControllersPropsOption } from './engine.js';
 /**
  * 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.
  */
-export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<SearchEngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
+export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<BuildConfig & SearchEngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState> & BuildConfig>;

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

@@ -2,6 +2,7 @@ import type { UnknownAction } from '@reduxjs/toolkit';
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
 import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
 import type { OptionsTuple } from '../../common/types/utilities.js';
+import type { BuildConfig } from './build.js';
 import type { SearchEngineDefinitionBuildResult, SearchEngineDefinitionControllersPropsOption } from './engine.js';
 export type HydratedState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> = SearchEngineDefinitionBuildResult<TEngine, TControllers>;
 interface HydrateStaticStateOptions<TSearchAction> {
@@ -12,5 +13,5 @@ interface HydrateStaticStateOptions<TSearchAction> {
  *
  * Useful when hydrating a server-side-rendered engine.
  */
-export type HydrateStaticState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction> & SearchEngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<HydratedState<TEngine, TControllers>>;
+export type HydrateStaticState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<BuildConfig & HydrateStaticStateOptions<TSearchAction> & SearchEngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<HydratedState<TEngine, TControllers>>;
 export {};

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

@@ -36,11 +36,12 @@
  * export type SearchStaticState = InferStaticState<typeof engineDefinition>;
  * export type SearchHydratedState = InferHydratedState<typeof engineDefinition>;
  *
- * export const {
- *   fetchStaticState,
- *   hydrateStaticState,
- *   setNavigatorContextProvider,
- * } = engineDefinition;
+ * export const {fetchStaticState, hydrateStaticState} = engineDefinition;
+ *
+ * await fetchStaticState({
+ *   navigatorContextProvider: () => {/*...* /},
+ *   context: {/*...* /},
+ * });
 
  * ```
  * @module SSR Search

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

@@ -0,0 +1,2 @@
+import type { ContextOptions } from '../controllers/commerce/context/headless-context.js';
+export declare function buildMockCommerceContext(context?: Partial<ContextOptions>): ContextOptions;