@coveo/quantic 3.30.0-pre.ea0fa3a1da → 3.30.0-pre.ea7f949ddf

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,6 +5,10 @@ import type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOptio
5
5
  import type { FromBuildResult } from './from-build-result.js';
6
6
  import type { OptionsTuple } from './utilities.js';
7
7
  interface HydrateStaticStateOptions<TSearchAction> {
8
+ /**
9
+ * @deprecated The `searchAction` property will be replaced with `searchActions` in the next major release.
10
+ * The new property will accept an array of actions instead of a single action to support multiple search operations (e.g. search and recommendation).
11
+ */
8
12
  searchAction: TSearchAction;
9
13
  }
10
14
  export interface HydratedState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> extends EngineDefinitionBuildResult<TEngine, TControllers> {
@@ -1,7 +1,8 @@
1
1
  import type { UnknownAction } from '@reduxjs/toolkit';
2
2
  import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
3
3
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
4
- import type { ControllerStaticStateMap, ControllersMap } from '../../common/types/controllers.js';
4
+ import type { ControllersMap } from '../../common/types/controllers.js';
5
+ import type { EngineStaticState } from '../../common/types/engine.js';
5
6
  import type { SSRCommerceEngine } from '../factories/build-factory.js';
6
7
  import type { SSRCommerceEngineOptions } from './build.js';
7
8
  import type { SolutionType } from './controller-constants.js';
@@ -9,11 +10,7 @@ import type { BakedInControllers, ControllerDefinitionsMap } from './controller-
9
10
  import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './controller-inference.js';
10
11
  import type { FetchStaticState } from './fetch-static-state.js';
11
12
  import type { HydrateStaticState, HydrateStaticStateOptions } from './hydrate-static-state.js';
12
- export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState };
13
- export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
14
- searchActions: TSearchAction[];
15
- controllers: TControllers;
16
- }
13
+ export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, EngineStaticState, };
17
14
  type ReservedControllerNames = 'context' | 'parameterManager' | 'cart';
18
15
  type ValidateControllerNames<T extends ControllerDefinitionsMap<Controller>> = {
19
16
  [K in keyof T]: K extends ReservedControllerNames ? `ERROR: Controller name "${K & string}" is reserved and cannot be used. Reserved names are: context, parameterManager, cart. Please choose a different controller name.` : T[K];
@@ -1,10 +1,10 @@
1
1
  import type { UnknownAction } from '@reduxjs/toolkit';
2
2
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
3
3
  import type { ControllerStaticStateMap, ControllersPropsMap } from '../../common/types/controllers.js';
4
+ import type { EngineStaticState } from '../../common/types/engine.js';
4
5
  import type { BuildConfig } from './build.js';
5
6
  import type { SolutionType } from './controller-constants.js';
6
7
  import type { CommerceEngineDefinitionControllersPropsOption, ControllerDefinitionsMap, FilteredBakedInControllers, OptionsTuple } from './controller-definitions.js';
7
- import type { EngineStaticState } from './engine.js';
8
8
  /**
9
9
  * Executes only the initial search for a given configuration, then returns a resumable snapshot of engine state along with the state of the controllers.
10
10
  *
@@ -1,7 +1,7 @@
1
1
  import type { UnknownAction } from '@reduxjs/toolkit';
2
2
  import type { ControllerStaticStateMap } from './controllers.js';
3
3
  export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
4
- searchAction: TSearchAction;
4
+ searchActions: TSearchAction[];
5
5
  controllers: TControllers;
6
6
  }
7
7
  export type InferStaticState<T extends {
@@ -9,7 +9,7 @@ export declare function buildControllerDefinitions<TControllerDefinitionsMap ext
9
9
  engine: TEngine;
10
10
  propsMap?: InferControllerPropsMapFromDefinitions<TControllerDefinitionsMap>;
11
11
  }): InferControllersMapFromDefinition<TControllerDefinitionsMap>;
12
- export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>>({ searchAction, controllers, }: {
13
- searchAction: TSearchAction;
12
+ export declare function createStaticState<TSearchAction extends UnknownAction, TControllerDefinitions extends ControllerDefinitionsMap<CoreEngine | CoreEngineNext, Controller>>({ searchActions, controllers, }: {
13
+ searchActions: TSearchAction[];
14
14
  controllers: InferControllersMapFromDefinition<TControllerDefinitions>;
15
15
  }): EngineStaticState<TSearchAction, InferControllerStaticStateMapFromDefinitions<TControllerDefinitions>>;
@@ -5,7 +5,7 @@ import type { OptionsTuple } from '../../common/types/utilities.js';
5
5
  import type { SearchEngineDefinitionBuildResult, SearchEngineDefinitionControllersPropsOption } from './engine.js';
6
6
  export type HydratedState<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> = SearchEngineDefinitionBuildResult<TEngine, TControllers>;
7
7
  interface HydrateStaticStateOptions<TSearchAction> {
8
- searchAction: TSearchAction;
8
+ searchActions: TSearchAction[];
9
9
  }
10
10
  /**
11
11
  * Creates a new engine from the snapshot of the engine created in SSR with fetchStaticState.