@coveo/quantic 3.45.4 → 3.45.5

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

@@ -5,6 +5,8 @@ export type { BreadcrumbManager, BreadcrumbManagerState };
  * Defines a `BreadcrumbManager` controller instance.
  * @group Definers
  *
+ * @param options - Deprecated `listing` and `search` options, which will be removed in the next
+ * major version: omit them to build the controller for both search and product listing pages.
  * @returns The `BreadcrumbManager` controller definition.
  */
 export declare function defineBreadcrumbManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<BreadcrumbManager, TOptions>;

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

@@ -7,7 +7,7 @@ export interface CartBuildProps {
 export interface CartDefinition extends UniversalControllerDefinitionWithProps<Cart, CartBuildProps> {
 }
 /**
- * @deprecated In the future, the context controller will be included by default in the engine definition. You will no longer need to define it manually
+ * @deprecated In the future, the cart controller will be included by default in the engine definition. You will no longer need to define it manually
  * Defines a `Cart` controller instance.
  * @group Definers
  *

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

@@ -20,6 +20,9 @@ export type MappedFacetState = {
 };
 /**
  * @group Definers
+ *
+ * @param options - Deprecated `listing` and `search` options, which will be removed in the next
+ * major version: omit them to build the controller for both search and product listing pages.
  */
 export declare function defineFacetGenerator<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<FacetGenerator, TOptions>;
 /**

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

@@ -5,7 +5,9 @@ export type { CorePaginationOptions, Pagination, PaginationOptions, PaginationPr
  * Defines a `Pagination` controller instance.
  * @group Definers
  *
- * @param props - The configurable `Pagination` properties.
+ * @param props - The configurable `Pagination` properties. The `listing` and `search` options are
+ * deprecated and will be removed in the next major version: omit them to build the controller for
+ * both search and product listing pages.
  * @returns The `Pagination` controller definition.
  */
 export declare function definePagination<TOptions extends ControllerDefinitionOption | undefined>(props?: PaginationProps & TOptions): SubControllerDefinitionWithoutProps<Pagination, TOptions>;

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

@@ -9,6 +9,8 @@ export type { CommerceSearchParameters, ParameterManager, ParameterManagerProps,
  * Defines a `ParameterManager` controller instance.
  * @group Definers
  *
+ * @param options - Deprecated `listing` and `search` options, which will be removed in the next
+ * major version: omit them to build the controller for both search and product listing pages.
  * @returns The `ParameterManager` controller definition.
  */
 export declare function defineParameterManager<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithProps<ParameterManager<MappedParameterTypes<TOptions>>, TOptions, SSRParameterManagerProps<MappedParameterTypes<TOptions>>>;

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

@@ -18,7 +18,9 @@ interface ProductListOptions {
  * Defines a `ProductList` controller instance.
  * @group Definers
  *
- * @param options - The configurable `ProductList` controller options.
+ * @param options - The configurable `ProductList` controller options. The `listing` and `search`
+ * options are deprecated and will be removed in the next major version: omit them to build the
+ * controller for both search and product listing pages.
  * @returns The `ProductList` controller definition.
  */
 export declare function defineProductList<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions & ProductListOptions): SubControllerDefinitionWithoutProps<ProductList, TOptions>;

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

@@ -5,7 +5,9 @@ export type { Sort, SortProps, SortState };
  * Defines a `Sort` controller instance.
  * @group Definers
  *
- * @param props - The configurable `Sort` properties.
+ * @param props - The configurable `Sort` properties. The `listing` and `search` options are
+ * deprecated and will be removed in the next major version: omit them to build the controller for
+ * both search and product listing pages.
  * @returns The `Sort` controller definition.
  */
 export declare function defineSort<TOptions extends ControllerDefinitionOption | undefined>(props?: SortProps & TOptions): SubControllerDefinitionWithoutProps<Sort, TOptions>;

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

@@ -8,6 +8,8 @@ export type { ProductListingSummaryState, RecommendationsSummaryState, SearchSum
  * Defines a `Summary` controller instance.
  * @group Definers
  *
+ * @param options - Deprecated `listing` and `search` options, which will be removed in the next
+ * major version: omit them to build the controller for both search and product listing pages.
  * @returns The `Summary` controller definition.
  */
 export declare function defineSummary<TOptions extends ControllerDefinitionOption | undefined>(options?: TOptions): SubControllerDefinitionWithoutProps<Summary<ProductListingSummaryState | SearchSummaryState | RecommendationsSummaryState>, TOptions>;

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

@@ -180,7 +180,8 @@ type DefaultControllerProps<TControllers extends ControllerDefinitionsMap<Contro
 };
 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>;
 /**
- * @deprecated This interface is no longer used and will be removed in next major version.
+ * @deprecated The `listing` and `search` options will be removed in the next major version. Omit
+ * them to build the controller for both search and product listing pages.
  */
 export interface ControllerDefinitionOption {
     /**

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

@@ -7,8 +7,8 @@ import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption,
 import type { EngineStaticState } from './engine.js';
 import type { FromBuildResult } from './from-build-result.js';
 /**
- * @deprecated This interface will be remove on the next major version.
- * Use BuildConfig interface instead
+ * @deprecated This type will be removed in the next major version. The `accessToken` and
+ * `navigatorContext` options of `fetchStaticState()` aren't affected.
  */
 export type FetchStaticStateOptions = {
     /**

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

@@ -1,4 +1,5 @@
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { NavigatorContext } from '../../../app/navigator-context-provider.js';
 import type { ControllersMap, ControllersPropsMap } from './controllers.js';
 import type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './engine.js';
 import type { OptionsExtender, OptionsTuple } from './utilities.js';
@@ -10,6 +11,10 @@ interface BuildOptions<TEngineOptions> {
      * @deprecated This option will be removed in the next major version.
      */
     extend?: OptionsExtender<TEngineOptions>;
+    /**
+     * A per-request navigator context applied to this call only, without mutating the shared definition.
+     */
+    navigatorContext?: NavigatorContext;
 }
 /**
  * This type should not be used directly.

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

@@ -29,8 +29,8 @@ export interface EngineDefinition<TEngine extends CoreEngine | CoreEngineNext, T
     /**
      * @deprecated This method will be removed in a future major version. It mutates the shared engine
      * definition, so on a server handling concurrent requests one request can overwrite another
-     * request's navigator context. Provide the navigator context directly when fetching the static
-     * state (`fetchStaticState({navigatorContext})`) so it applies to that request only.
+     * request's navigator context. Pass a per-request `navigatorContext` to `fetchStaticState()` and
+     * `hydrateStaticState()` instead, or a `navigatorContextProvider` to `defineSearchEngine()`.
      *
      * 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.
@@ -45,10 +45,17 @@ export interface EngineDefinition<TEngine extends CoreEngine | CoreEngineNext, T
      */
     build: Build<TEngine, TEngineOptions, InferControllersMapFromDefinition<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>;
     /**
+     * @deprecated This method will be removed in the next major version. Use the access token from
+     * your engine configuration instead.
+     *
      * Returns the access token.
      */
     getAccessToken: () => string;
     /**
+     * @deprecated This method will be removed in the next major version. To renew an expiring token,
+     * configure `renewAccessToken`; to change the token of an engine you already have, dispatch
+     * `loadConfigurationActions(engine).updateBasicConfiguration({accessToken})` on it.
+     *
      * Updates the access token.
      * @param accessToken - The access token to update.
      */

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

@@ -1,10 +1,20 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { NavigatorContext } from '../../../app/navigator-context-provider.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 = {};
+type FetchStaticStateOptions = {
+    /**
+     * The navigator context to use for this request only.
+     *
+     * When provided, it is applied to this request's engine without mutating the shared definition,
+     * so concurrent requests do not read each other's client ID, user agent, or forwarded-for values.
+     * When omitted, the provider set with `setNavigatorContextProvider` is used.
+     */
+    navigatorContext?: NavigatorContext;
+};
 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.
@@ -15,6 +25,6 @@ export type FetchStaticState<TEngine extends CoreEngine | CoreEngineNext, TContr
     /**
      * @deprecated Use the fetchStaticState() method instead
      */
-    fromBuildResult: FromBuildResult<TEngine, TControllers, FetchStaticStateOptions, EngineStaticState<TSearchAction, TControllersStaticState>>;
+    fromBuildResult: FromBuildResult<TEngine, TControllers, Omit<FetchStaticStateOptions, 'navigatorContext'>, EngineStaticState<TSearchAction, TControllersStaticState>>;
 };
 export {};

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

@@ -1,5 +1,6 @@
 import type { UnknownAction } from '@reduxjs/toolkit';
 import type { CoreEngine, CoreEngineNext } from '../../../app/engine.js';
+import type { NavigatorContext } from '../../../app/navigator-context-provider.js';
 import type { ControllersMap, ControllersPropsMap } from './controllers.js';
 import type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './engine.js';
 import type { FromBuildResult } from './from-build-result.js';
@@ -10,6 +11,15 @@ interface HydrateStaticStateOptions<TSearchAction> {
      * The new property will accept an array of actions instead of a single action to support multiple search operations (e.g. search and recommendation).
      */
     searchAction: TSearchAction;
+    /**
+     * The navigator context to use for this `hydrateStaticState()` call only.
+     *
+     * When provided, it is applied to this call's engine without mutating the shared definition.
+     * Pass the same navigator context that was used to fetch the static state so the hydrated engine
+     * reports the same client ID and keeps the analytics session continuous. When omitted, the provider
+     * set with `setNavigatorContextProvider` is used.
+     */
+    navigatorContext?: NavigatorContext;
 }
 export interface HydratedState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> extends EngineDefinitionBuildResult<TEngine, TControllers> {
 }
@@ -23,6 +33,6 @@ export type HydrateStaticState<TEngine extends CoreEngine | CoreEngineNext, TCon
     /**
      * @deprecated Use the hydrateStaticState() method instead
      */
-    fromBuildResult: FromBuildResult<TEngine, TControllers, HydrateStaticStateOptions<TSearchAction>, HydratedState<TEngine, TControllers>>;
+    fromBuildResult: FromBuildResult<TEngine, TControllers, Omit<HydrateStaticStateOptions<TSearchAction>, 'navigatorContext'>, HydratedState<TEngine, TControllers>>;
 };
 export {};