@coveo/quantic 3.29.4 → 3.29.5-pre.0c3c5381c7

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.
Files changed (36) hide show
  1. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +10 -8
  2. package/force-app/main/default/staticresources/coveoheadless/definitions/api/analytics/search-analytics.d.ts +3 -5
  3. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-actions.d.ts +2 -2
  4. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +28 -8
  5. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/tests/stream-answer-api-state-mock.d.ts +12 -12
  6. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/sort/headless-core-sort.d.ts +0 -12
  7. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-selectors.d.ts +4 -1
  8. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts +1 -1
  9. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +1 -1
  10. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/fetch-static-state.d.ts +4 -0
  11. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/build.d.ts +3 -0
  12. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/engine.d.ts +3 -0
  13. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce-next.index.d.ts +3 -3
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/build-factory.d.ts +4 -3
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/hydrated-state-factory.d.ts +2 -1
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-hydrated-state-factory.d.ts +1 -1
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts +2 -1
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/static-state-factory.d.ts +2 -1
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/build.d.ts +34 -7
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/controller-definitions.d.ts +40 -2
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/engine.d.ts +15 -8
  22. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/fetch-static-state.d.ts +3 -3
  23. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/hydrate-static-state.d.ts +2 -1
  24. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/utilities.d.ts +6 -0
  25. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/utils/controller-wiring.d.ts +43 -0
  26. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/utils/engine-wiring.d.ts +5 -0
  27. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/validation/controller-validation.d.ts +1 -0
  28. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/types/fetch-static-state.d.ts +1 -3
  29. package/force-app/main/default/staticresources/coveoheadless/definitions/state/state-sections.d.ts +0 -8
  30. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/facet-utils.d.ts +1 -1
  31. package/force-app/main/default/staticresources/coveoheadless/headless.js +12 -10
  32. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +11 -9
  33. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +9 -7
  34. package/package.json +2 -2
  35. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/generated-answer-stream.d.ts +0 -15
  36. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api-state.d.ts +0 -6
@@ -90,15 +90,13 @@ export declare class SearchAnalyticsProvider extends BaseAnalyticsProvider<State
90
90
  protected get responseTime(): number;
91
91
  protected get numberOfResults(): number;
92
92
  }
93
- interface LegacyConfigureAnalyticsOptions<State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider> {
93
+ interface LegacyConfigureAnalyticsOptions {
94
94
  logger: Logger;
95
95
  analyticsClientMiddleware?: AnalyticsClientSendEventHook;
96
96
  preprocessRequest?: PreprocessRequest;
97
97
  provider?: SearchPageClientProvider;
98
- getState(): State;
98
+ getState(): StateNeededBySearchAnalyticsProvider;
99
99
  }
100
- export declare const configureLegacyAnalytics: <State extends ConfigurationSection = StateNeededBySearchAnalyticsProvider>({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: LegacyConfigureAnalyticsOptions<State> & {
101
- provider: SearchPageClientProvider;
102
- }) => CoveoSearchPageClient;
100
+ export declare const configureLegacyAnalytics: ({ logger, getState, analyticsClientMiddleware, preprocessRequest, provider, }: LegacyConfigureAnalyticsOptions) => CoveoSearchPageClient;
103
101
  export declare const getPageID: () => string;
104
102
  export {};
@@ -1,7 +1,7 @@
1
1
  import type { NavigatorContext } from '../../app/navigator-context-provider.js';
2
- import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
2
+ import { type StateNeededByAnswerAPI } from './stream-answer-api.js';
3
3
  export declare const triggerSearchRequest: import("@reduxjs/toolkit").AsyncThunk<void, {
4
- state: StreamAnswerAPIState;
4
+ state: StateNeededByAnswerAPI;
5
5
  navigatorContext: NavigatorContext;
6
6
  }, {
7
7
  state?: unknown;
@@ -1,10 +1,30 @@
1
1
  import { type ThunkDispatch, type UnknownAction } from '@reduxjs/toolkit';
2
2
  import { type NavigatorContext } from '../../app/navigator-context-provider.js';
3
+ import type { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
4
+ import type { SearchAppState } from '../../state/search-app-state.js';
5
+ import type { ConfigurationSection, GeneratedAnswerSection, InsightConfigurationSection, TabSection } from '../../state/state-sections.js';
3
6
  import type { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
7
+ import type { GeneratedAnswerCitation } from '../generated-answer/generated-answer-event-payload.js';
4
8
  import type { SearchRequest } from '../search/search/search-request.js';
5
- import type { GeneratedAnswerStream } from './generated-answer-stream.js';
6
- import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
7
- export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StreamAnswerAPIState, unknown, UnknownAction>) => void;
9
+ export type StateNeededByAnswerAPI = {
10
+ searchHub: string;
11
+ pipeline: string;
12
+ answer: ReturnType<typeof answerApi.reducer>;
13
+ } & ConfigurationSection & Partial<SearchAppState> & Partial<InsightConfigurationSection> & GeneratedAnswerSection & Partial<TabSection>;
14
+ export interface GeneratedAnswerStream {
15
+ answerId?: string;
16
+ contentFormat?: GeneratedContentFormat;
17
+ answer?: string;
18
+ citations?: GeneratedAnswerCitation[];
19
+ generated?: boolean;
20
+ isStreaming: boolean;
21
+ isLoading: boolean;
22
+ error?: {
23
+ message: string;
24
+ code: number;
25
+ };
26
+ }
27
+ export declare const updateCacheWithEvent: (event: EventSourceMessage, draft: GeneratedAnswerStream, dispatch: ThunkDispatch<StateNeededByAnswerAPI, unknown, UnknownAction>) => void;
8
28
  export declare const answerApi: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {
9
29
  getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">;
10
30
  }, "answer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
@@ -53,7 +73,7 @@ export declare const selectAnswerTriggerParams: ((state: any, ...params: any[])
53
73
  argsMemoize: typeof import("reselect").weakMapMemoize;
54
74
  memoize: typeof import("reselect").weakMapMemoize;
55
75
  };
56
- export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, usage: "fetch" | "select", navigatorContext: NavigatorContext) => {
76
+ export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI, usage: "fetch" | "select", navigatorContext: NavigatorContext) => {
57
77
  analytics?: {
58
78
  actionCause?: string;
59
79
  customData?: object;
@@ -80,12 +100,12 @@ export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, u
80
100
  } | undefined;
81
101
  enableDidYouMean?: boolean | undefined;
82
102
  fieldsToInclude?: string[] | undefined;
83
- facets?: (import("../../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
103
+ facets?: (import("../../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
84
104
  pipeline?: string | undefined;
85
105
  searchHub?: string | undefined;
86
106
  pipelineRuleParameters: {
87
107
  mlGenerativeQuestionAnswering: {
88
- responseFormat: import("../../index.js").GeneratedResponseFormat;
108
+ responseFormat: import("../../features/generated-answer/generated-response-format.js").GeneratedResponseFormat;
89
109
  citationsFieldToInclude: string[];
90
110
  };
91
111
  };
@@ -97,8 +117,8 @@ export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, u
97
117
  aq?: string | undefined;
98
118
  q: string | undefined;
99
119
  };
100
- export declare const fetchAnswer: (state: StreamAnswerAPIState, navigatorContext: NavigatorContext) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">>, any, any, UnknownAction>;
101
- export declare const selectAnswer: (state: StreamAnswerAPIState, navigatorContext?: NavigatorContext) => ({
120
+ export declare const fetchAnswer: (state: StateNeededByAnswerAPI, navigatorContext: NavigatorContext) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">>, any, any, UnknownAction>;
121
+ export declare const selectAnswer: (state: StateNeededByAnswerAPI, navigatorContext?: NavigatorContext) => ({
102
122
  status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
103
123
  originalArgs?: undefined | undefined;
104
124
  data?: undefined | undefined;
@@ -1,12 +1,12 @@
1
1
  /** biome-ignore-all lint/suspicious/noExplicitAny: <mock> */
2
- import type { StreamAnswerAPIState } from '../stream-answer-api-state.js';
3
- export declare const streamAnswerAPIStateMock: StreamAnswerAPIState;
4
- export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StreamAnswerAPIState;
5
- export declare const streamAnswerAPIStateMockWithoutAnyTab: StreamAnswerAPIState;
6
- export declare const streamAnswerAPIStateMockWithStaticFiltersSelected: StreamAnswerAPIState;
7
- export declare const streamAnswerAPIStateMockWithNonValidFilters: StreamAnswerAPIState;
8
- export declare const streamAnswerAPIStateMockWithoutAnyFilters: StreamAnswerAPIState;
9
- export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpression: StreamAnswerAPIState;
2
+ import type { StateNeededByAnswerAPI } from '../stream-answer-api.js';
3
+ export declare const streamAnswerAPIStateMock: StateNeededByAnswerAPI;
4
+ export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StateNeededByAnswerAPI;
5
+ export declare const streamAnswerAPIStateMockWithoutAnyTab: StateNeededByAnswerAPI;
6
+ export declare const streamAnswerAPIStateMockWithStaticFiltersSelected: StateNeededByAnswerAPI;
7
+ export declare const streamAnswerAPIStateMockWithNonValidFilters: StateNeededByAnswerAPI;
8
+ export declare const streamAnswerAPIStateMockWithoutAnyFilters: StateNeededByAnswerAPI;
9
+ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpression: StateNeededByAnswerAPI;
10
10
  export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWithEmptyCQ: {
11
11
  advancedSearchQueries: {
12
12
  cq: string;
@@ -26,9 +26,9 @@ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWi
26
26
  };
27
27
  searchHub: string;
28
28
  pipeline: string;
29
- answer: import("@reduxjs/toolkit/query").CombinedState<{
30
- getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<import("../../search/search/search-request.js").SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, import("../generated-answer-stream.js").GeneratedAnswerStream, "answer">;
31
- }, never, "answer">;
29
+ answer: ReturnType<import("redux").Reducer<import("@reduxjs/toolkit/query").CombinedState<{
30
+ getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<import("../../search/search/search-request.js").SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, import("../stream-answer-api.js").GeneratedAnswerStream, "answer">;
31
+ }, never, "answer">, import("redux").UnknownAction>>;
32
32
  configuration: import("../../../features/configuration/configuration-state.js").ConfigurationState;
33
33
  facetSet?: import("../../../features/facets/facet-set/facet-set-state.js").FacetSetState | undefined;
34
34
  dateFacetSet?: import("../../../features/facets/range-facets/date-facet-set/date-facet-set-state.js").DateFacetSetState | undefined;
@@ -66,7 +66,7 @@ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWi
66
66
  instantResults?: import("../../../features/instant-results/instant-results-state.js").InstantResultsState | undefined;
67
67
  insightConfiguration?: import("../../../features/insight-configuration/insight-configuration-state.js").InsightConfigurationState | undefined;
68
68
  };
69
- export declare const streamAnswerAPIStateMockWithoutSearchAction: StreamAnswerAPIState;
69
+ export declare const streamAnswerAPIStateMockWithoutSearchAction: StateNeededByAnswerAPI;
70
70
  export declare const expectedStreamAnswerAPIParam: {
71
71
  q: string;
72
72
  aq: string;
@@ -32,18 +32,6 @@ export interface Sort extends Controller {
32
32
  * Verifies whether the specified sort criterion is the currently active one.
33
33
  *
34
34
  * @param criterion - The sort criterion to evaluate.
35
- * Can be a single criterion or an array of criteria.
36
- * The criteria in an array will be applied sequentially. For example, if there's a tie on the 1st criterion, the API uses the 2nd criterion to break the tie. However, this only works when combining:
37
- * `SortByRelevancy` followed by one or more `SortByField` or `SortByDate` criteria.
38
- * `SortByQRE` followed by one or more `SortByField` or `SortByDate` criteria.
39
- * Two or more `SortByField` criteria.
40
- * A single `SortByDate` criterion and one or more `SortByField` criteria in any order.
41
- *
42
- * Examples:
43
- * * `SortByRelevancy`, `SortByField`
44
- * * `SortByQRE`, `SortByField`
45
- * * `SortByDate`, `SortByField`, `SortByField`
46
- *
47
35
  * @returns `true` if the specified sort criterion is the currently active one; `false` otherwise.
48
36
  */
49
37
  isSortedBy(criterion: SortCriterion | SortCriterion[]): boolean;
@@ -1,7 +1,10 @@
1
1
  import type { GeneratedAnswerCitation } from '../../controllers/generated-answer/headless-generated-answer.js';
2
2
  import type { SearchAppState } from '../../state/search-app-state.js';
3
3
  import type { GeneratedAnswerSection } from '../../state/state-sections.js';
4
- export declare const generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => string | undefined;
4
+ export declare const generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => {
5
+ answerAPIEnabled: boolean;
6
+ id: string | undefined;
7
+ };
5
8
  export declare const selectFieldsToIncludeInCitation: (state: Partial<GeneratedAnswerSection>) => string[] | undefined;
6
9
  export declare const citationSourceSelector: ((state: Partial<GeneratedAnswerSection>, citationId: string) => GeneratedAnswerCitation | undefined) & {
7
10
  clearCache: () => void;
@@ -24,7 +24,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eve
24
24
  facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
25
25
  numberOfResults?: number;
26
26
  firstResult?: number;
27
- facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
27
+ facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
28
28
  cq?: string;
29
29
  queryCorrection?: {
30
30
  enabled?: boolean;
@@ -25,7 +25,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, nav
25
25
  facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
26
26
  numberOfResults?: number;
27
27
  firstResult?: number;
28
- facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
28
+ facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
29
29
  cq?: string;
30
30
  queryCorrection?: {
31
31
  enabled?: boolean;
@@ -5,6 +5,10 @@ import type { SolutionType } from './controller-constants.js';
5
5
  import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
6
6
  import type { EngineStaticState } from './engine.js';
7
7
  import type { FromBuildResult } from './from-build-result.js';
8
+ /**
9
+ * @deprecated This interface will be remove on the next major version.
10
+ * Use BuildConfig interface instead
11
+ */
8
12
  export type FetchStaticStateOptions = {};
9
13
  export type FetchStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
10
14
  /**
@@ -3,6 +3,9 @@ import type { ControllersMap, ControllersPropsMap } from './controllers.js';
3
3
  import type { EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './engine.js';
4
4
  import type { OptionsExtender, OptionsTuple } from './utilities.js';
5
5
  interface BuildOptions<TEngineOptions> {
6
+ /**
7
+ * @deprecated This option will be removed in the next major version.
8
+ */
6
9
  extend?: OptionsExtender<TEngineOptions>;
7
10
  }
8
11
  export type Build<TEngine extends CoreEngine | CoreEngineNext, TEngineOptions, TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap> = (...params: OptionsTuple<BuildOptions<TEngineOptions> & EngineDefinitionControllersPropsOption<TControllersProps>>) => Promise<EngineDefinitionBuildResult<TEngine, TControllersMap>>;
@@ -38,6 +38,9 @@ export interface EngineDefinition<TEngine extends CoreEngine | CoreEngineNext, T
38
38
  */
39
39
  build: Build<TEngine, TEngineOptions, InferControllersMapFromDefinition<TControllers>, InferControllerPropsMapFromDefinitions<TControllers>>;
40
40
  }
41
+ /**
42
+ * @deprecated Use SearchEngineDefinitionBuildResult or CommerceEngineDefinitionBuildResult instead
43
+ */
41
44
  export interface EngineDefinitionBuildResult<TEngine extends CoreEngine | CoreEngineNext, TControllers extends ControllersMap> {
42
45
  engine: TEngine;
43
46
  controllers: TControllers;
@@ -68,7 +68,6 @@
68
68
  */
69
69
  export type { Relay } from '@coveo/relay';
70
70
  export type { Middleware, Unsubscribe } from '@reduxjs/toolkit';
71
- export type { CommerceEngineOptions } from './app/commerce-engine/commerce-engine.js';
72
71
  export type { CommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
73
72
  export { getSampleCommerceEngineConfiguration } from './app/commerce-engine/commerce-engine-configuration.js';
74
73
  export type { CoreEngineNext, ExternalEngineOptions } from './app/engine.js';
@@ -119,10 +118,11 @@ export type { RedirectionTrigger, RedirectionTriggerDefinition, RedirectionTrigg
119
118
  export { defineRedirectionTrigger } from './ssr-next/commerce/controllers/triggers/headless-redirection-trigger.ssr.js';
120
119
  export { defineCommerceEngine } from './ssr-next/commerce/engine/commerce-engine.ssr.js';
121
120
  export type { CommerceEngineDefinitionOptions, SSRCommerceEngine as CommerceEngine, } from './ssr-next/commerce/factories/build-factory.js';
121
+ export type { BuildConfig, SSRCommerceEngineOptions, } from './ssr-next/commerce/types/build.js';
122
122
  export { SolutionType } from './ssr-next/commerce/types/controller-constants.js';
123
- export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
123
+ export type { ControllerDefinition, ControllerDefinitionsMap, ControllerWithKind, EngineDefinitionControllersPropsOption, HydratedState, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, OptionsTuple, } from './ssr-next/commerce/types/controller-definitions.js';
124
124
  export type { InferControllerFromDefinition, InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition, InferHydratedState, InferStaticState, } from './ssr-next/commerce/types/controller-inference.js';
125
- export type { CommerceEngineDefinition, EngineStaticState, FetchStaticState, FetchStaticStateOptions, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
125
+ export type { CommerceEngineDefinition, CommerceEngineDefinitionBuildResult, EngineStaticState, FetchStaticState, HydrateStaticState, HydrateStaticStateOptions, } from './ssr-next/commerce/types/engine.js';
126
126
  export { Kind } from './ssr-next/commerce/types/kind.js';
127
127
  export type { CommerceAppState, CommerceProductListingParametersState, CommerceSearchParametersState, } from './state/commerce-app-state.js';
128
128
  export * from './features/commerce/configuration/configuration-actions-loader.js';
@@ -1,6 +1,7 @@
1
1
  import type { Action } from '@reduxjs/toolkit';
2
- import { type CommerceEngine, type CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
2
+ import { type CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
3
3
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
4
+ import type { SSRCommerceEngineOptions } from '../types/build.js';
4
5
  import { SolutionType } from '../types/controller-constants.js';
5
6
  import type { ControllerDefinitionsMap } from '../types/controller-definitions.js';
6
7
  import type { BuildParameters, CommerceControllerDefinitionsMap, EngineDefinitionOptions } from '../types/engine.js';
@@ -15,8 +16,8 @@ export interface SSRCommerceEngine extends CommerceEngine {
15
16
  */
16
17
  waitForRequestCompletedAction(): Promise<Action>[];
17
18
  }
18
- export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<CommerceEngineOptions, TControllers>;
19
- export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <T extends SolutionType>(solutionType: T) => (...[buildOptions]: BuildParameters<TControllerDefinitions>) => Promise<{
19
+ export type CommerceEngineDefinitionOptions<TControllers extends ControllerDefinitionsMap<Controller> = ControllerDefinitionsMap<Controller>> = EngineDefinitionOptions<SSRCommerceEngineOptions, TControllers>;
20
+ export declare const buildFactory: <TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>) => <T extends SolutionType>(solutionType: T) => (...[buildOptions]: BuildParameters<TControllerDefinitions>) => Promise<{
20
21
  engine: SSRCommerceEngine;
21
22
  controllers: import("../types/controller-inference.js").InferControllersMapFromDefinition<TControllerDefinitions, T>;
22
23
  }>;
@@ -1,4 +1,5 @@
1
1
  import type { SolutionType } from '../types/controller-constants.js';
2
+ import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
2
3
  import type { CommerceControllerDefinitionsMap, HydrateStaticStateFunction } from '../types/engine.js';
3
4
  import { type CommerceEngineDefinitionOptions } from './build-factory.js';
4
- export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;
5
+ export declare function hydratedStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => HydrateStaticStateFunction<TControllerDefinitions>;
@@ -1,3 +1,3 @@
1
1
  import type { CommerceControllerDefinitionsMap, HydrateStaticStateFunction } from '../types/engine.js';
2
2
  import { type CommerceEngineDefinitionOptions } from './build-factory.js';
3
- export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): HydrateStaticStateFunction<TControllerDefinitions>;
3
+ export declare function hydratedRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): HydrateStaticStateFunction<TControllerDefinitions>;
@@ -1,3 +1,4 @@
1
+ import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
1
2
  import type { CommerceControllerDefinitionsMap, FetchStaticStateFunction } from '../types/engine.js';
2
3
  import { type CommerceEngineDefinitionOptions } from './build-factory.js';
3
- export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): FetchStaticStateFunction<TControllerDefinitions>;
4
+ export declare function fetchRecommendationStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): FetchStaticStateFunction<TControllerDefinitions>;
@@ -1,4 +1,5 @@
1
1
  import { SolutionType } from '../types/controller-constants.js';
2
+ import type { AugmentedControllerDefinition } from '../types/controller-definitions.js';
2
3
  import type { CommerceControllerDefinitionsMap, FetchStaticStateFunction } from '../types/engine.js';
3
4
  import { type CommerceEngineDefinitionOptions } from './build-factory.js';
4
- export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: TControllerDefinitions | undefined, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;
5
+ export declare function fetchStaticStateFactory<TControllerDefinitions extends CommerceControllerDefinitionsMap>(controllerDefinitions: AugmentedControllerDefinition<TControllerDefinitions>, options: CommerceEngineDefinitionOptions<TControllerDefinitions>): (solutionType: SolutionType) => FetchStaticStateFunction<TControllerDefinitions>;
@@ -1,14 +1,41 @@
1
+ import type { CurrencyCodeISO4217 } from '@coveo/relay-event-types';
2
+ import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
1
3
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
2
4
  import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
3
- import type { OptionsExtender, OptionsTuple } from '../../common/types/utilities.js';
4
- import type { SSRCommerceEngine } from '../factories/build-factory.js';
5
+ import type { OptionsTuple } from '../../common/types/utilities.js';
6
+ import type { CartInitialState } from '../controllers/cart/headless-cart.ssr.js';
7
+ import type { UserLocation } from '../controllers/context/headless-context.ssr.js';
8
+ import type { ParameterManagerState, Parameters } from '../controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
5
9
  import type { SolutionType } from './controller-constants.js';
6
- import type { ControllerDefinitionsMap, EngineDefinitionBuildResult, EngineDefinitionControllersPropsOption } from './controller-definitions.js';
7
- interface BuildOptions<TEngineOptions> {
8
- extend?: OptionsExtender<TEngineOptions>;
10
+ import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption } from './controller-definitions.js';
11
+ import type { CommerceEngineDefinitionBuildResult } from './engine.js';
12
+ export interface SearchBuildConfig extends CommonBuildConfig {
13
+ query: string;
9
14
  }
15
+ export interface RecommendationBuildConfig extends CommonBuildConfig {
16
+ recommendations?: [];
17
+ }
18
+ export interface ListingBuildConfig extends CommonBuildConfig {
19
+ }
20
+ export interface StandaloneBuildConfig extends CommonBuildConfig {
21
+ }
22
+ export interface CommonBuildConfig {
23
+ url: string;
24
+ language: string;
25
+ country: string;
26
+ currency: CurrencyCodeISO4217;
27
+ location?: UserLocation;
28
+ cart?: CartInitialState;
29
+ searchParams?: Omit<ParameterManagerState<Parameters>['parameters'], 'q'>;
30
+ }
31
+ export type BuildConfig<TSolutionType extends SolutionType> = TSolutionType extends SolutionType.search ? SearchBuildConfig : TSolutionType extends SolutionType.listing ? ListingBuildConfig : TSolutionType extends SolutionType.recommendation ? RecommendationBuildConfig : TSolutionType extends SolutionType.standalone ? CommonBuildConfig : never;
32
+ /**
33
+ * Commerce engine options for SSR scenarios where context is defined when fetching static state.
34
+ */
35
+ export type SSRCommerceEngineOptions = Omit<CommerceEngineOptions, 'configuration'> & {
36
+ configuration: Omit<CommerceEngineOptions['configuration'], 'context'>;
37
+ };
10
38
  /**
11
39
  * @internal
12
40
  */
13
- 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>>;
14
- export {};
41
+ export type Build<TControllersMap extends ControllersMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildConfig<TSolutionType> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<CommerceEngineDefinitionBuildResult<TControllersMap>>;
@@ -1,15 +1,18 @@
1
1
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
2
2
  import type { InvalidControllerDefinition } from '../../common/errors.js';
3
3
  import type { ControllersPropsMap } from '../../common/types/controllers.js';
4
- import type { EngineDefinitionBuildResult } from '../../common/types/engine.js';
5
4
  import type { HydratedState } from '../../common/types/hydrate-static-state.js';
6
5
  import type { InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers } from '../../common/types/inference.js';
7
6
  import type { HasKey, HasOptionalKeys, HasRequiredKeys, OptionsTuple } from '../../common/types/utilities.js';
7
+ import type { CartDefinition } from '../controllers/cart/headless-cart.ssr.js';
8
+ import type { ContextDefinition } from '../controllers/context/headless-context.ssr.js';
9
+ import type { ParameterManagerDefinition } from '../controllers/parameter-manager/headless-core-parameter-manager.ssr.js';
8
10
  import type { SSRCommerceEngine } from '../factories/build-factory.js';
9
11
  import { type recommendationInternalOptionKey, SolutionType } from './controller-constants.js';
10
12
  import type { ListingAndStandaloneController, ListingOnlyController, NonRecommendationController, RecommendationOnlyController, SearchAndListingController, SearchOnlyController, UniversalController } from './controller-scopes.js';
11
13
  import type { Kind } from './kind.js';
12
- export type { EngineDefinitionBuildResult, HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
14
+ import type { HasSolutionType } from './utilities.js';
15
+ export type { HydratedState, OptionsTuple, InferControllerStaticStateFromController, InferControllerStaticStateMapFromControllers, };
13
16
  export type RecommendationControllerSettings = {
14
17
  /**
15
18
  * Toggle to enable or disable the recommendation controller.
@@ -53,6 +56,41 @@ export type ControllerDefinition<TController extends Controller> = SolutionTypeA
53
56
  export interface ControllerDefinitionsMap<TController extends Controller> {
54
57
  [customName: string]: ControllerDefinition<TController>;
55
58
  }
59
+ type BakedInControllerDefinitions = {
60
+ parameterManager: ParameterManagerDefinition<{
61
+ listing: true;
62
+ search: true;
63
+ }>;
64
+ context: ContextDefinition;
65
+ cart: CartDefinition;
66
+ };
67
+ /**
68
+ * Map of baked-in controllers
69
+ */
70
+ export type BakedInControllers = {
71
+ [K in keyof BakedInControllerDefinitions]: BakedInControllerDefinitions[K]['buildWithProps'];
72
+ };
73
+ /**
74
+ * A dynamically filtered map of baked-in controller definitions based on solution type compatibility.
75
+ *
76
+ * This type automatically includes only the baked-in controllers that are available for the specified
77
+ * solution type by checking each controller's `SolutionTypeAvailability` configuration. Controllers
78
+ * that don't support the given solution type are excluded from the resulting type.
79
+ *
80
+ * @template TSolutionType - The target solution type to filter controllers for
81
+ */
82
+ export type FilteredBakedInControllers<TSolutionType extends SolutionType> = {
83
+ [K in keyof BakedInControllers as HasSolutionType<BakedInControllerDefinitions[K], TSolutionType> extends true ? K : never]: BakedInControllers[K];
84
+ };
85
+ /**
86
+ * Map of controller definitions available to the commerce engine definition.
87
+ *
88
+ * This type combines user-defined controllers with the system's baked-in controllers
89
+ * (parameterManager, context, and cart).
90
+ *
91
+ * @template TControllerDefinitions - The controller definitions map
92
+ */
93
+ export type AugmentedControllerDefinition<TControllerDefinitions extends ControllerDefinitionsMap<Controller>> = TControllerDefinitions & BakedInControllerDefinitions;
56
94
  /**
57
95
  * This type defines the required and optional controller props for the engine definition.
58
96
  */
@@ -1,28 +1,31 @@
1
1
  import type { UnknownAction } from '@reduxjs/toolkit';
2
- import type { CommerceEngineOptions } from '../../../app/commerce-engine/commerce-engine.js';
3
2
  import type { EngineConfiguration } from '../../../app/engine-configuration.js';
4
3
  import type { NavigatorContextProvider } from '../../../app/navigator-context-provider.js';
5
4
  import type { Controller } from '../../../controllers/controller/headless-controller.js';
6
- import type { ControllerStaticStateMap } from '../../common/types/controllers.js';
5
+ import type { ControllerStaticStateMap, ControllersMap } from '../../common/types/controllers.js';
7
6
  import type { SSRCommerceEngine } from '../factories/build-factory.js';
8
7
  import type { Build } from './build.js';
9
8
  import type { SolutionType } from './controller-constants.js';
10
- import type { ControllerDefinitionsMap } from './controller-definitions.js';
9
+ import type { BakedInControllers, ControllerDefinitionsMap } from './controller-definitions.js';
11
10
  import type { InferControllerPropsMapFromDefinitions, InferControllerStaticStateMapFromDefinitionsWithSolutionType, InferControllersMapFromDefinition } from './controller-inference.js';
12
- import type { FetchStaticState, FetchStaticStateOptions } from './fetch-static-state.js';
11
+ import type { FetchStaticState } from './fetch-static-state.js';
13
12
  import type { HydrateStaticState, HydrateStaticStateOptions } from './hydrate-static-state.js';
14
- export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState, FetchStaticStateOptions, };
13
+ export type { HydrateStaticState, HydrateStaticStateOptions, FetchStaticState };
15
14
  export interface EngineStaticState<TSearchAction extends UnknownAction, TControllers extends ControllerStaticStateMap> {
16
15
  searchActions: TSearchAction[];
17
16
  controllers: TControllers;
18
17
  }
18
+ type ReservedControllerNames = 'context' | 'parameterManager' | 'cart';
19
+ type ValidateControllerNames<T extends ControllerDefinitionsMap<Controller>> = {
20
+ [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];
21
+ };
19
22
  export type EngineDefinitionOptions<TOptions extends {
20
23
  configuration: EngineConfiguration;
21
24
  }, TControllers extends ControllerDefinitionsMap<Controller>> = TOptions & {
22
25
  /**
23
26
  * The controllers to initialize with the commerce engine.
24
27
  */
25
- controllers?: TControllers;
28
+ controllers?: ValidateControllerNames<TControllers>;
26
29
  };
27
30
  export interface CommerceEngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> {
28
31
  /**
@@ -50,15 +53,19 @@ export interface CommerceEngineDefinition<TControllers extends ControllerDefinit
50
53
  */
51
54
  setAccessToken: (accessToken: string) => void;
52
55
  }
56
+ export interface CommerceEngineDefinitionBuildResult<TControllers extends ControllersMap> {
57
+ engine: SSRCommerceEngine;
58
+ controllers: TControllers & BakedInControllers;
59
+ }
53
60
  export type CommerceControllerDefinitionsMap = ControllerDefinitionsMap<Controller>;
54
61
  type Definition<TControllerDefinitions extends CommerceControllerDefinitionsMap> = CommerceEngineDefinition<TControllerDefinitions, SolutionType>;
55
62
  export type FetchStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['fetchStaticState'];
56
63
  export type HydrateStaticStateFunction<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Definition<TControllerDefinitions>['hydrateStaticState'];
57
- export type BuildParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<Build<CommerceEngineOptions, InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>, InferControllerPropsMapFromDefinitions<TControllerDefinitions>, TControllerDefinitions, SolutionType>>;
64
+ export type BuildParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<Build<InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>, InferControllerPropsMapFromDefinitions<TControllerDefinitions>, TControllerDefinitions, SolutionType>>;
58
65
  export type FetchStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<FetchStaticStateFunction<TControllerDefinitions>>;
59
66
  export type HydrateStaticStateParameters<TControllerDefinitions extends CommerceControllerDefinitionsMap> = Parameters<HydrateStaticStateFunction<TControllerDefinitions>>;
60
67
  type Controllers<TControllerDefinitions extends CommerceControllerDefinitionsMap> = InferControllersMapFromDefinition<TControllerDefinitions, SolutionType>;
61
68
  export type BuildResult<TControllerDefinitions extends CommerceControllerDefinitionsMap> = {
62
69
  engine: SSRCommerceEngine;
63
- controllers: Controllers<TControllerDefinitions>;
70
+ controllers: Controllers<TControllerDefinitions> & BakedInControllers;
64
71
  };
@@ -1,13 +1,13 @@
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 { BuildConfig } from './build.js';
4
5
  import type { SolutionType } from './controller-constants.js';
5
- import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
6
+ import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, FilteredBakedInControllers, OptionsTuple } from './controller-definitions.js';
6
7
  import type { EngineStaticState } from './engine.js';
7
- export type FetchStaticStateOptions = {};
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
  *
11
11
  * Useful for static generation and server-side rendering.
12
12
  */
13
- export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<FetchStaticStateOptions & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState>>;
13
+ export type FetchStaticState<TSearchAction extends UnknownAction, TControllersStaticState extends ControllerStaticStateMap, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<BuildConfig<TSolutionType> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<EngineStaticState<TSearchAction, TControllersStaticState & FilteredBakedInControllers<TSolutionType>> & BuildConfig<TSolutionType>>;
@@ -3,6 +3,7 @@ import type { Controller } from '../../../controllers/controller/headless-contro
3
3
  import type { ControllersMap, ControllersPropsMap } from '../../common/types/controllers.js';
4
4
  import type { HydratedState } from '../../common/types/hydrate-static-state.js';
5
5
  import type { SSRCommerceEngine } from '../factories/build-factory.js';
6
+ import type { BuildConfig } from './build.js';
6
7
  import type { SolutionType } from './controller-constants.js';
7
8
  import type { ControllerDefinitionsMap, EngineDefinitionControllersPropsOption, OptionsTuple } from './controller-definitions.js';
8
9
  export interface HydrateStaticStateOptions<TSearchAction> {
@@ -13,4 +14,4 @@ export interface HydrateStaticStateOptions<TSearchAction> {
13
14
  *
14
15
  * Useful when hydrating a server-side-rendered engine.
15
16
  */
16
- export type HydrateStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<HydratedState<SSRCommerceEngine, TControllers>>;
17
+ export type HydrateStaticState<TControllers extends ControllersMap, TSearchAction extends UnknownAction, TControllersProps extends ControllersPropsMap, TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = (...params: OptionsTuple<HydrateStaticStateOptions<TSearchAction> & BuildConfig<TSolutionType> & EngineDefinitionControllersPropsOption<TControllersDefinitionsMap, TControllersProps, TSolutionType>>) => Promise<HydratedState<SSRCommerceEngine, TControllers>>;
@@ -0,0 +1,6 @@
1
+ import type { SolutionType } from './controller-constants.js';
2
+ export type HasSolutionType<TDefinition, TSolutionType extends SolutionType> = TDefinition extends {
3
+ [K in TSolutionType]: true;
4
+ } ? true : TDefinition extends {
5
+ [K in TSolutionType]: false;
6
+ } ? false : false;
@@ -0,0 +1,43 @@
1
+ /**
2
+ * Controller Wiring Utilities
3
+ *
4
+ * Transforms simple user configuration into complex internal controller structures.
5
+ */
6
+ import { Schema } from '@coveo/bueno';
7
+ import type { ControllersPropsMap } from '../../common/types/controllers.js';
8
+ import type { BuildConfig } from '../types/build.js';
9
+ import { SolutionType } from '../types/controller-constants.js';
10
+ import type { InferControllerPropsMapFromDefinitions } from '../types/controller-inference.js';
11
+ import type { CommerceControllerDefinitionsMap } from '../types/engine.js';
12
+ export declare const listingDefinitionSchema: Schema<{
13
+ language: string;
14
+ country: string;
15
+ currency: import("@coveo/relay-event-types").CurrencyCodeISO4217;
16
+ url: string;
17
+ }>;
18
+ export declare const searchDefinitionSchema: Schema<{
19
+ query: string;
20
+ language: string;
21
+ country: string;
22
+ currency: import("@coveo/relay-event-types").CurrencyCodeISO4217;
23
+ url: string;
24
+ }>;
25
+ export declare const recommendationsDefinitionSchema: Schema<{
26
+ language: string;
27
+ country: string;
28
+ currency: import("@coveo/relay-event-types").CurrencyCodeISO4217;
29
+ url: string;
30
+ }>;
31
+ /**
32
+ * Converts simple user configuration (URL, language, currency, query) into the
33
+ * nested structure required by the internal {@link Build} method. Automatically generates
34
+ * appropriate controllers (context, cart, parameterManager) transparently.
35
+ *
36
+ * @param solutionType - The type of solution (search, listing, recommendation, standalone)
37
+ * @param controllerDefinitions - Map of controller definitions to be initialized
38
+ * @param buildConfig - Simple configuration object with simplified controller properties
39
+ * @returns Formatted and validated controller properties map defined for the controller in the definition
40
+ */
41
+ export declare function wireControllerParams<TControllerDefinitions extends CommerceControllerDefinitionsMap>(solutionType: SolutionType, controllerDefinitions: TControllerDefinitions, buildConfig: BuildConfig<SolutionType> & {
42
+ controllers?: ControllersPropsMap;
43
+ }): InferControllerPropsMapFromDefinitions<TControllerDefinitions>;
@@ -0,0 +1,5 @@
1
+ import type { CommerceEngineConfiguration } from '../../../app/commerce-engine/commerce-engine.js';
2
+ import type { CommerceEngineDefinitionOptions } from '../factories/build-factory.js';
3
+ import type { CommonBuildConfig } from '../types/build.js';
4
+ import type { CommerceControllerDefinitionsMap } from '../types/engine.js';
5
+ export declare function extendEngineConfiguration<TControllerDefinitions extends CommerceControllerDefinitionsMap>(configuration: CommerceEngineDefinitionOptions<TControllerDefinitions>['configuration'], commonBuildOptions: CommonBuildConfig): CommerceEngineConfiguration;
@@ -0,0 +1 @@
1
+ export declare const validateControllerNames: (controllers: Record<string, unknown>) => void;